Patient Portal Access

The patient portal benefits patients and practices alike: helping patients get better connected to their health information and their care team for improved health outcomes; and driving practice administrative efficiencies, patient satisfaction, and increased revenue opportunities. Partners can be very helpful in driving portal adoption in three key ways: 

1. Increasing the collection of email addresses, which are required for patient portal registration and login. (Again, we recommend making the email address required and allowing the patient to decline to provide one, in which case the partner should still attempt to collect it at future visits.)

2. Surfacing language reminding patients to visit the portal after their visit. Recommended language around portal benefits:

Don’t forget to visit the portal after your visit to conveniently:

  • Exchange secure messages with our staff
  • Access lab results and health data
  • View upcoming appointment details
  • View billing statements & pay balances
  • Update your contact & insurance info

3. Taking action based on portal registration status, which can be found in the following API call: 

To determine if a patient has registered for a practice's patient portal:

Partners will want to use the GET /patients/{patientid} API call. If the REGISTERED value is "FALSE", as in the highlighted example below, then the patient has not registered with the practice's patient portal; a value of "TRUE" indicates that the patient has registered their account.

Response Body

{
  "noportal": "false",
  "status": "NOTREGISTERED",
  "blockedfailedlogins": "false",
  "familyregistered": "false",
  "familyblockedfailedlogins": "false",
  "<strong>registered</strong>": "false",
  "termsaccepted": null,
  "entitytodisplay": "PATIENT"
}

To determine if a family member has registered for a practice's patient portal:

Partners will want to use the GET /patients/{patientid} API call. If the familyregistered value is "false", as in the highlighted example below, then the patient has not registered with the practice's patient portal; a value of "true" indicates that the patient has registered their account.

  "noportal" : "false",
  "status: : "NOTREGISTERED",
  "familyregistered": "false",
  "familyblockedfailedlogins": "false",
  "registered": "false",
  "entitytodisplay": "PATIENT"
Was this information helpful? Yes | No What went wrong? Incomplete or incorrect information | Irrelevant Content | Others