Appointments
Check-in, arrival and appointment metadata
Get Appointment Metadata
Returns the appointment services, appointment types and available procedures configured for the practice, for use when constructing a booking request (for example with Create Appointment Booking Link).
List Sites
Returns all active sites with their identifier and name.
List Available Slots
Returns bookable appointment slots from a given date, with optional filters for appointment services, types, practitioners, and sites. Results are sorted by start time. The maximum date range between `fromDate` and `endDate` is 4 weeks; if `endDate` is omitted, slots up to 4 weeks from `fromDate` are returned.
Book Appointment
Books an appointment for a patient into a specific diary slot. Use List Available Slots to obtain the diaryId, startTime, and endTime for a bookable slot.
Cancel Appointment
Cancels an existing appointment for a patient. A cancellation reason is required. Returns 204 No Content on success.
Find Appointments for Check-in
Returns the patient's face-to-face appointments scheduled for today that are still eligible for self check-in.
Mark Patient as Arrived
Checks a patient in for the given appointment, setting its arrival status to arrived when the appointment is still pending.