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

Endpoints

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

❙ required

practiceid integer practiceid
Content-Type string Content type of the payload

❙ Request Body

Expand all
duration integer The expected duration, in minutes, of the appointment type. Note, this value cannot be changed after creation, so please choose carefully.
generic boolean If set to true, this type serves as a "generic" type, that will match any type when searching. Defaults to false.
name string The name of the appointment type. Maximum length of 30 characters.
patient boolean If set to true, this type serves as a "patient" type, meaning that is is a type that can be used for booking patients. If set to false, then it this type will not be used for patient (e.g. "Lunch" or "Vacation"). Non-patient types are mostly used to reserving time for providers to not see patients.
shortname string The short name code of the appointment type. Maximum length of 4 characters. Used for making schedule templates. Note, this value cannot be changed after creation, so please choose carefully.
templatetypeonly boolean If set to true, this type serves as a "template-only" type, meaning that it can be used for building schedule templates, but cannot be used for booking appointments (i.e. another type must be chosen). Defaults to false.

Output Parameters

Expand all
appointmenttypeid integer The ID of the appointment type that was created.
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

❙ required

practiceid integer practiceid
providerids array A list of providerids which when passed will filter the appointmenttypes having said providers. This is used along with departmentids to fetch department/provider specific appointmenttypes.
hidetemplatetypeonly boolean By default, we show both "template only" and not-template only types. Setting this to true, the results will omit template only types. ("Template only" is a setting that makes the type appear in schedules, but forces users to select a non-template type upon booking.)
departmentids array A list of departmentids which when passed will filter the appointmenttypes having said departments. This is used along with providerids to fetch department/provider specific appointmenttypes.
hidenongeneric boolean By default, we show both generic and non-generic types. Setting this to true will hide non-generic types (and show only generic types).
showappointmenttypeclasses boolean If set to true, returns the appointment type class ID and name for each appointment type.
hidegeneric boolean By default, we show both generic and non-generic types. Setting this to true will hide the generic types (and show only non-generic types).
hidenonpatient boolean This defaults to true if not specified, and thus will hide non-patient facing types. Setting this to false would thus show non-patient facing types.
limit integer Number of entries to return (default 1500, max 5000)
offset integer Starting point of entries; 0-indexed

Output Parameters

Expand all
appointmenttypeclassid string ID of the class which this appointment type falls under. Only returned if SHOWAPPOINTMENTTYPECLASSES is marked true.
appointmenttypeclassname string Name of the class which this appointment type falls under. Only returned if SHOWAPPOINTMENTTYPECLASSES is marked true.
appointmenttypeid integer The appointment type ID.
block schedule integer The minimum number of hours before an appointment that a patient can schedule or cancel for a specific practice. Note that this data is valued in hours.
createencounteroncheckin string If true, then this appointments of this type will generated an encounter when checked in, with certain conditions. It's rather complex, but the rendering provider on the appointment must also have the create encounter feature set, the department must have athena Clinicals enabled, and other rarer and less visible settings.
departmentid integer ID of the department.
duration integer Expected duration of the appointment in minutes.
genericyn string If true, this type is a "generic" type able to be filled with other types of appointments.
name string The name of the appointment type.
patientdisplayname string Patient friendly appointment type name. Defaults to regular name.
patientyn string If true, this type is a patient-facing type.
providerid integer ID of the provider.
shortname string The short name code of the appointment type.
templatetypeonlyyn string If true, this type is a "template-only" type, and must be filled with a different appointment type upon booking.
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

❙ required

practiceid integer practiceid
appointmenttypeid integer appointmenttypeid
showappointmenttypeclasses boolean If set to true, returns the appointment type class ID and name for each appointment type.

Output Parameters

Expand all
appointmenttypeclassid string ID of the class which this appointment type falls under. Only returned if SHOWAPPOINTMENTTYPECLASSES is marked true.
appointmenttypeclassname string Name of the class which this appointment type falls under. Only returned if SHOWAPPOINTMENTTYPECLASSES is marked true.
appointmenttypeid integer The appointment type ID.
block schedule integer The minimum number of hours before an appointment that a patient can schedule or cancel for a specific practice. Note that this data is valued in hours.
createencounteroncheckin string If true, then this appointments of this type will generated an encounter when checked in, with certain conditions. It's rather complex, but the rendering provider on the appointment must also have the create encounter feature set, the department must have athena Clinicals enabled, and other rarer and less visible settings.
departmentid integer ID of the department.
duration integer Expected duration of the appointment in minutes.
genericyn string If true, this type is a "generic" type able to be filled with other types of appointments.
name string The name of the appointment type.
patientdisplayname string Patient friendly appointment type name. Defaults to regular name.
patientyn string If true, this type is a patient-facing type.
providerid integer ID of the provider.
shortname string The short name code of the appointment type.
templatetypeonlyyn string If true, this type is a "template-only" type, and must be filled with a different appointment type upon booking.
Example Code

Update a appointment type entry.

PUT
/v1/{practiceid}/appointmenttypes/{appointmenttypeid}
Generic success/error response
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

❙ required

practiceid integer practiceid
appointmenttypeid integer appointmenttypeid
Content-Type string Content type of the payload

❙ Request Body

Expand all
generic boolean If set to true, this type serves as a "generic" type, that will match any type when searching. Defaults to false.
name string The name of the appointment type. Maximum length of 30 characters.
patient boolean If set to true, this type serves as a "patient" type, meaning that is is a type that can be used for booking patients. If set to false, then it this type will not be used for patient (e.g. "Lunch" or "Vacation"). Non-patient types are mostly used to reserving time for providers to not see patients.
templatetypeonly boolean If set to true, this type serves as a "template-only" type, meaning that it can be used for building schedule templates, but cannot be used for booking appointments (i.e. another type must be chosen). Defaults to false.

Output Parameters

Expand all
errormessage string If the operation failed, this will contain any error messages.
success string Whether the operation was successful.
Example Code