Book appointment
nexhealth_book_appointmentBOOK a new appointment. MUTATES DATA — creates an appointment in the connected EHR/PMS (optionally notifying the patient). Provide either end_time or appointment_type_id. POST /appointments.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| note | No | Free-text note on the appointment. | |
| end_time | No | Appointment end, ISO8601 datetime (or set appointment_type_id). | |
| subdomain | No | Institution subdomain. Defaults to NEXHEALTH_SUBDOMAIN if unset. | |
| patient_id | Yes | Patient the appointment is for. | |
| start_time | Yes | Appointment start, ISO8601 datetime. | |
| location_id | Yes | Location id for the appointment (REQUIRED). | |
| provider_id | Yes | Provider seeing the patient. | |
| operatory_id | No | Operatory (chair/room) id. | |
| notify_patient | No | Notify the patient (sent as notify_patient query param). | |
| appointment_type_id | No | Appointment type id (determines duration if end_time omitted). |