Create

Beta
POST
/appointments/v1

Adds an appointment. VersionConflictError is returned when the placer_appointment_id is already in use.

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
Allowed values: PENDINGNOT_READYREADYCHECKED_IN

Defaults to PENDING. If status is NOT_READY, work_queue must be set. If status is READY or CHECKED_IN, work_queue must be null. If status is CHECKED_IN, checked_in_timestamp must be set. If checked_in_timestamp is set, status must be CHECKED_IN.

placer_appointment_idstringOptional

ID for the appointment/order for the event.

attending_doctorobjectOptional

Attending physician information. The attending physician will be stored as the Current MD for the patient.

estimated_copay_centsintegerOptional
estimated_patient_responsibility_centsintegerOptional
patient_deposit_centsintegerOptional
checked_in_timestampdatetimeOptional

The timestamp when the patient checked in for their appointment. If status is CHECKED_IN, checked_in_timestamp must be set. If checked_in_timestamp is set, status must be CHECKED_IN.

notesstringOptional
location_resource_idstringOptional

Contains the coded identification of the location being scheduled. Components: <Identifier (ST)>^<Text (ST)>

automated_eligibility_check_completebooleanOptional

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
Allowed values: EMERGENT_ISSUENEW_PATIENTRETURNING_PATIENTMANUAL_ESCALATION

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 or CHECKED_IN, work_queue must be null.

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.

attending_doctorobjectOptional

Attending physician information. The attending physician will be stored as the Current MD for the patient.

automated_eligibility_check_completebooleanOptional

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.

checked_in_timestampdatetimeOptional

The timestamp when the patient checked in for their appointment. If status is CHECKED_IN, checked_in_timestamp must be set. If checked_in_timestamp is set, status must be CHECKED_IN.

estimated_copay_centsintegerOptional
estimated_patient_responsibility_centsintegerOptional
location_resource_idstringOptional

Contains the coded identification of the location being scheduled. Components: <Identifier (ST)>^<Text (ST)>

notesstringOptional
patient_deposit_centsintegerOptional
placer_appointment_idstringOptional

ID for the appointment/order for the event.

statusenumOptional
Allowed values: PENDINGNOT_READYREADYCHECKED_IN

Defaults to PENDING. If status is NOT_READY, work_queue must be set. If status is READY or CHECKED_IN, work_queue must be null. If status is CHECKED_IN, checked_in_timestamp must be set. If checked_in_timestamp is set, status must be CHECKED_IN.

work_queueenumOptional
Allowed values: EMERGENT_ISSUENEW_PATIENTRETURNING_PATIENTMANUAL_ESCALATION

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 or CHECKED_IN, work_queue must be null.

Errors

Built with