Appointment Types

Appointment Types allow you to configure types of bookable appointments. You can create a type for a root canal, cleaning, or surgery with each type of appointment uniquely identified in an health record system.

By default, Appointment Types are institution-wide; you can confirm this by checking that the is_appt_categories_location_specific property on the institution is "false". If this property is "true", appointment types scoped to a location. This flag is configured on installation and updates can be made on request by contacting [email protected].

Understanding Provider Type Relationships

To see which providers offer an appointment type you can add "include[]=providers" to your GET request as shown below. The list of providers returned depends on whether providers have an availability where they offer this appointment type.

curl --request GET \
     --url https://nexhealth.info/appointment_types/id?include\[\]=providers' \
     --header 'Accept: application/vnd.Nexhealth+json;version=2' \
     --header 'Authorization: YOUR_BEARER_TOKEN'

Appointment type length

If you do not specify an appointment type length, it will default to 15 minutes.

Appointment Descriptors

Practices track which procedures they serve in a given appointment with appointment descriptors. You can use the emr_appt_descriptor_ids parameter on an appointment type to write these values into the health record system attached to each instance of the appointment type.

You can read more about reading and writing these values in our guide Access Procedure Codes.

Appointment Types Response Object

{
   "code" : true,
   "count" : 2,
   "data" : [
      {
         "bookable_online" : true,
         "id" : 1733,
         "minutes" : 30,
         "name" : "Sealant",
         "parent_id" : 140,
         "parent_type" : "Institution"
      },
      {
         "bookable_online" : true,
         "id" : 1758,
         "minutes" : 30,
         "name" : "New patient cleaning",
         "parent_id" : 140,
         "parent_type" : "Institution"
      }
   ],
   "description" : null,
   "error" : null
}