Appointment Types

The Appointment Type feature allows the user to retrieve and configure the type of appointments in the practice. This API is provided for those partners with special requirements that preclude the use of patient appointment reasons.

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
Add appointment type
POST
/v1/{practiceid}/appointmenttypes

Create a new appointment type

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 types
GET
/v1/{practiceid}/appointmenttypes

Retrieves list of the type of appointment available in the practice

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

Output Parameters

Expand all
Example Code
Get list of appointment types
GET
/v1/{practiceid}/appointmenttypes/{appointmenttypeid}

Retrieves list of the type of appointment available in the practice

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

Output Parameters

Expand all
Example Code