App Guidelines
Below are some of the high level use cases we expect the patient app to support, along with suggestions on API endpoints that are likely to be useful, known limitations, and potential tips.
While we support some patient permissioned API actions with specially scoped API tokens, this is not widely enough supported to cover the workflows described below. We anticipate that we will support all of these workflows with patient scoped tokens before the conclusion of the contest, so it would be wise to account for this when designing your authentication flow. For now, given that there is no PHI in your team’s EMR, utilize a token that is not restricted to any particular patient.
Sign up for an account and provide basic info
Guidance
Patient can complete self-registration including entering personal info, insurance coverage, completing necessary consents and questionnaires prior to their initial visit, and a basic medical history.
Suggested Endpoints
Limitations
Canvas cannot store pictures of insurance cards.
Questionnaires can only be completed and submitted once by the patient and do not allow for changes.
Tips
3rd party services support card scanning to extract relevant coverage information to reduce potential for manual entry error.
View your medical history
Guidance
Patient can see their basic medical history information, inclusive of completed forms (consents, questionnaires), appointment history, conditions, medications, immunizations, allergies, imaging & lab results
Suggested Endpoints
Limitations
The ability to retrieve Visual Exam findings is coming soon.We will update the contest page when this is available.
Message with your care team
Guidance
Patient can do basic text messaging with their care team
Suggested Endpoints
Limitations
Attachments are not yet supported.
Tips
Canvas messaging does not support threaded messages, but you can retrieve all of a patient’s messages by making two search requests: one where the patient is the sender and another where the patient is the recipient.
Create a “catch all” staff member for messages from the patient to be routed to.
See charges and pay bills
Guidance
Patient can view their bills and submit a payment for services.
Suggested Endpoints
Limitations
There is no computable field representing the patient's total balance at present. Patient invoices are available via discrete PDFs in DocumentReference.
Tips
Find patient invoices with GET /DocumentReference?category=invoicefull
Search and book appointments
Guidance
Patient can schedule appointments with their known care team or an otherwise available clinician and join virtual visits directly from the app
Suggested Endpoints
What else can you think of?
Apply your domain expertise and design thinking to round out the set of features and functionality you want patients to have.
Explore all of our 35 resources at https://docs.canvasmedical.com/
Ask questions during office hours or in our Q&A submission form (both accessible upon Registration)
