For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Adds an appointment. VersionConflictError is returned when the placer_appointment_id is already in use.
Authentication
AuthorizationBearer
OAuth authentication of the form <token>.
Request
This endpoint expects an object.
patient_idstringRequired
The Candid-defined patient identifier.
start_timestampdatetimeRequired
service_durationintegerRequired
The requested length of time allotted for the appointment. The units are in minutes.
serviceslist of objectsRequired
statusenumOptional
Defaults to PENDING. If status is NOT_READY, work_queue must be set. If status is READY, CHECKED_OUT, or NO_SHOW, work_queue must be null. checked_in_timestamp must be set if and only if status is CHECKED_IN or CHECKED_OUT, and checked_out_timestamp must be set if and only if status is CHECKED_OUT.
not_ready_reasonenumOptional
The reason the appointment is NOT_READY. Must only be set when status is NOT_READY; it is cleared otherwise. It is not recommended to change this value manually via API.
ready_sourceenumOptional
The method that set the appointment status to READY. It is not recommended to change this value manually via API. Must only be set when the status is READY, CHECKED_IN, CHECKED_OUT or NO_SHOW, it is cleared otherwise.
Allowed values:
placer_appointment_idstringOptional
ID for the appointment/order for the event.
placer_system_namestringOptional
The name of the upstream system that placed this appointment.
attending_doctorobjectOptional
Attending physician information. The attending physician will be stored as the Current MD for the patient.
True if the automated eligibility check has been completed. It is not recommended to change this value manually via API. This refers explicitly to the automated eligibility check that occurs a specific number of days before the appointment.
work_queueenumOptional
The work queue that the appointment belongs to. It is not recommended to change this value manually via API. If status is NOT_READY, work_queue must be set. If status is READY, CHECKED_OUT or NO_SHOW, work_queue must be null.
Allowed values:
cancellation_reasonstringOptional
The reason the appointment was cancelled. This value cannot be set on create or update; it is only set by the deactivate endpoint, and is cleared if the appointment is reactivated.
Response
This endpoint returns an object.
deactivatedboolean
True if the object is deactivated. Deactivated objects 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 object.
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
start_timestampdatetime
updated_atdatetime
updating_user_idstring
The user ID of the user who last updated the object.
versioninteger
The version of the object. Any update to any property of an object object will create a new version.
appointment_detailsstringOptional
appointment_reason_detailobjectOptional
The clinical context for the appointment.
attending_doctorobjectOptional
Attending physician information. The attending physician will be stored as the Current MD for the patient.
True if the automated eligibility check has been completed. It is not recommended to change this value manually via API. This refers explicitly to the automated eligibility check that occurs a specific number of days before the appointment.
cancellation_reasonstringOptional
The reason the appointment was cancelled. This value cannot be set on create or update; it is only set by the deactivate endpoint, and is cleared if the appointment is reactivated.
checked_in_timestampdatetimeOptional
The timestamp when the patient checked in for their appointment. Must be set when status is CHECKED_IN or CHECKED_OUT, and must be unset otherwise.
checked_out_timestampdatetimeOptional
The timestamp when the patient checked out of their appointment. Must be set when status is CHECKED_OUT, and must be unset otherwise.
The estimated amount the patient will be responsible for paying at the time of service. This does not include the copay.
location_resource_idstringOptional
Contains the coded identification of the location being scheduled. Components: <Identifier (ST)>^<Text (ST)>
medical_necessity_verifiedbooleanOptional
True if medical necessity for this appointment has been verified.
not_ready_reasonenumOptional
The reason the appointment is NOT_READY. Must only be set when status is NOT_READY; it is cleared otherwise. It is not recommended to change this value manually via API.
notesstringOptional
patient_deposit_centsintegerOptional
placer_appointment_idstringOptional
ID for the appointment/order for the event.
placer_system_namestringOptional
The name of the upstream system that placed this appointment.
prior_authorization_statusenumOptional
The prior authorization status for this appointment.
ready_sourceenumOptional
The method that set the appointment status to READY. It is not recommended to change this value manually via API. Must only be set when the status is READY, CHECKED_IN, CHECKED_OUT or NO_SHOW, it is cleared otherwise.
Allowed values:
statusenumOptional
Defaults to PENDING. If status is NOT_READY, work_queue must be set. If status is READY, CHECKED_OUT, or NO_SHOW, work_queue must be null. checked_in_timestamp must be set if and only if status is CHECKED_IN or CHECKED_OUT, and checked_out_timestamp must be set if and only if status is CHECKED_OUT.
work_queueenumOptional
The work queue that the appointment belongs to. It is not recommended to change this value manually via API. If status is NOT_READY, work_queue must be set. If status is READY, CHECKED_OUT or NO_SHOW, work_queue must be null.
