Capturing Email and Mobile Phone Fields

API users with access to the athenaNet UI will find that both the email and mobile phone fields are required patient demographic fields, and each field gives patients the opportunity to opt out of providing a practice with this data.

athenaNet provides patients the ability to opt out during check-in to allow a practice to check a patient into an appointment who may not want to provide this data. It is important to note that when a patient does not provide an email address, the practice will not be able to:

  • Enroll the patient to access the practice’s patient portal (see Patient Portal Access).
  • Use the patient’s mobile phone number for an automated appointment reminder, or other practice-specific calls they may wish to receive (see General Contact Preferences).

In an effort to help drive a practice’s patient portal adoption and improve telephone outreach programs, we require that our partners (if they are working with patient-supplied information) always surface the mobile phone and email demographic fields, along with an option to opt out of providing this data, in their application’s UI. Developers working with the portal will find that both the POST and PUT /patients API calls allow for a value of “declined” to be passed into athenaNet for patients who select the opt-out option for these two fields.

Suggested Workflows

If the patient is a new patient to the practice:

  1. The partner should present the patient with a blank field for both the email and mobile phone field. Additionally, the partner will need to provide an option that allows the patient to explicitly opt out of providing one, or both, of these specific pieces of demographic data.
  2. The partner should present the patient with a blank field where the patient had previously opted out of providing data. Additionally, the partner will need to provide the option that allows the patient to, again, explicitly opt out of providing one or both of these specific pieces of demographic data.
  3. The opt-out value should not be selected by default.
  4. The patient will either need to enter in their email or mobile phone number or explicitly opt out of these fields again before being able to advance to the next step of the partner’s application.
  5. The partner should present the email address and mobile phone fields with the previously provided data.
  6. The patient should have the ability to update their email address or mobile phone number in the partner’s UI.

If the patient is an existing patient, and has opted out of providing either his/her email or mobile phone number during a previous visit:

  1. The partner should present the patient with a blank field where the patient had previously opted out of providing data. Additionally, the partner will need to provide the option that allows the patient to, again, explicitly opt out of providing one or both of these specific pieces of demographic data.
  2. The opt-out value should not be selected by default.
  3. The patient will either need to enter in their email or mobile phone number or explicitly opt out of these fields again before being able to advance to the next step of the partner’s application.

If the patient has previously provided the practice with their mobile phone or email address: 

  1. The partner should present the email address and mobile phone fields with the previously provided data.
  2. The patient should have the ability to update their email address and mobile phone number in the partner’s UI.
Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit