Appointment types

📘

Only in NexHealth

Appointment types exist only in NexHealth. NexHealth does not read them from or write them to health record systems.

Appointment types define the kinds of appointments a provider offers. They are useful when you configure provider schedules manually.

In NexHealth, you can set a provider's schedule manually and use it as the source of truth for booking appointments. This helps when:

• You want to offer appointment times that differ from the ones in the connected health record system.
• NexHealth does not support syncing provider availability from the health record system.

When you set provider working hours manually, you can attach appointment types to each time slot. This lets you:

• Control what kinds of appointments patients can book with providers.
• Control when patients can book certain appointment types.

For example, you may want patients to book only 'New patient' and 'Annual check up' appointments with provider A, and to offer annual check ups only from 9am to 3pm on Thursday. To do this, create working hours and appointment types manually.

Before you start

• Every request needs a bearer token from POST /authenticates. See Authentication.
• Requests take the practice's subdomain and a location_id. See Institutions, syncs, and locations.

Finding providers who offer a specific appointment type

Pass appointment_type_id to GET /available_slots without pids[]. NexHealth picks the providers mapped to that appointment type at the location and returns their open times, grouped by provider in pid. A provider without working hours for the type returns no slots.

curl --globoff --request GET \
     --url 'https://nexhealth.info/available_slots?subdomain=demo-practice&lids[]=7&appointment_type_id=123&start_date=2026-12-01&days=7' \
--header 'Nex-Api-Version: v3.0.0' \
--header 'Authorization: Bearer YOUR_BEARER_TOKEN'

See Available slots and the Scheduling configuration guide for how appointment types map to working hours.

Using appointment types when posting appointments

Use the emr_appt_descriptor_ids field to link health record system appointment descriptors, such as procedure codes, to an appointment type. When you call POST /appointments with an appointment type, NexHealth adds its descriptors to the appointment when it writes the appointment to the health record system.

📘

Institution vs. location scope

By default, an appointment type is available at every location in the institution. The parent_type field tells you whether an appointment type is scoped to one location or to the institution.

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
}