Appointment Reasons

The Appointment Reason Reference is a feature which allows the user to view the appointment reasons within a practice. Appointments are associated with appointment reasons. Each practice has its own set of appointment reasons. The patients can choose the reason when scheduling their own appointments. For more information, refer Appointment workflow.
 

Appointment reason, (i.e., /patientappointmentreasons) allow practices to use a short list of reasons for why a patient might come in for a visit. The list of possible reasons is global, and a practice can elect to use any subset of those reasons. Additionally, an appointment reason can be designated as being for new patients only, existing patients only, or for all patients. Appointment reasons are also used by patients of our clients via the athenaCommunicator portal for scheduling, and several attributes are set administratively at the appointment reason level, such as how long before the appointment can it be booked online, etc. The reasons are meant to be patient-facing and a description can be provided with additional details for the patient.

We encourage API users to ask if the patient is new or existing, to present a list of applicable appointment reasons to the patient to select from, and to query for slots for the specific appointment reason. We support asking for more than one appointment reason at a time. For example, one might include all the reason IDs related to new patient appointment reasons and the resulting set would have all possible slots, including the available reason IDs that could be used for a particular slot. Since it is equivalent to calling the API for each of the reasons included, one may want to consider shorter date ranges or even caching the response. Finally, as an alternate approach, the full set of appointments can be queried initially (using the special -1 reason ID) and later restricted after finding out more about the patient (new/existing and reason). Using the special -1 reason ID, while faster, does not provide the details about which reasons are available for a given slot.

In the background, an appointment reason is mapped to an underlying appointment type. Appointment types are more familiar to practices since they are used when practices book appointments in the office. However, practices often have a multitude of appointment types for very similar appointments. It is not uncommon to see one department use the appointment type of 'PHYS30' for physicals and another department to use 'PHYS45'. Practices can configure the combination of department, provider, and appointment reason to map to a specific appointment type, allowing the same reason ('Physical,' to continue this example) to result in an underlying appointment type of either 'PHYS30' or 'PHYS45' depending on the department or provider. In addition, multiple appointment reasons can be configured to map to the same underlying appointment type.

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Get list of appointment reasons
GET
/v1/{practiceid}/patientappointmentreasons

Retrieve the list of appointment reasons configured for the Practice which will allow the patient to select a reason for their appointment.

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all
Example Code
Get list of appointment reasons for new patients
GET
/v1/{practiceid}/patientappointmentreasons/newpatient

Retrieve the list of appointment reasons configured for the Practice for new patients to attend

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all
Example Code
Get list of appointment reasons for existing patients
GET
/v1/{practiceid}/patientappointmentreasons/existingpatient

Retrieve the list of appointment reasons configured for the Practice existing patients to attend

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all
Example Code