Updates an appointment. The path must contain the most recent version to prevent race conditions. Updating historic versions is not supported.
Path parameters
idstringRequired
The unique identifier for an Appointment.
versionstringRequired
Request
This endpoint expects an object.
patient_idstringRequired
The Candid-defined patient identifier.
service_durationintegerRequired
The requested length of time allotted for the appointment. The units are in minutes.
serviceslist of objectsRequired
checked_inbooleanOptional
True if the patient has checked in. Defaults to false.
assigned_patient_locationstringOptional
Patient’s initial assigned location or the location to which the patient is being moved. This location is stored on the Patient Demographics tab and is used when creating orders.
attending_doctorobjectOptional
Attending physician information. The attending physician will be stored as the Current MD for the patient.
referring_doctorobjectOptional
Referring physician information. The referring physician will be stored as the Referring MD in the patient’s Providers list.
The work queue that the appointment belongs to. It is not recommended to change this value manually via API.
Response
This endpoint returns an object.
deactivatedboolean
True if the appointment is deactivated. Deactivated appointments are not returned in search results but are returned in all other endpoints including scan.
idstring
The unique identifier for an Appointment.
organization_idstring
The organization that owns this appointment.
patient_idstring
The Candid-defined patient identifier.
service_durationinteger
The requested length of time allotted for the appointment. The units are in minutes.
serviceslist of objects
updated_atdatetime
updating_user_idstring
The user ID of the user who last updated the appointment.
versioninteger
The version of the appointment. Any update to any property of an appointment object will create a new version.
Patient’s initial assigned location or the location to which the patient is being moved. This location is stored on the Patient Demographics tab and is used when creating orders.
attending_doctorobjectOptional
Attending physician information. The attending physician will be stored as the Current MD for the patient.
checked_inbooleanOptional
True if the patient has checked in. Defaults to false.
location_resource_idstringOptional
Contains the coded identification of the location being scheduled. Components: <Identifier (ST)>^<Text (ST)>
placer_appointment_idstringOptional
ID for the appointment/order for the event.
referring_doctorobjectOptional
Referring physician information. The referring physician will be stored as the Referring MD in the patient’s Providers list.