PreEncounterAppointmentsV1

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

post/appointments/v1

Request

  • Base URL: https://api.taigabilling.com
  • URL: https://api.taigabilling.com/appointments/v1
  • Auth: HTTP bearer

Request body

patient_idstring required

The unique identifier for a Patient

start_timestampstring date-time required
status'PENDING' | 'NOT_READY' | 'READY' | 'CHECKED_IN'
not_ready_reason'INACTIVE_PRIMARY' | 'INACTIVE_SECONDARY' | 'MEDICARE_ADVANTAGE_CONVERSION' | 'MEDICAID_MANAGED_CONVERSION' | 'UNAVAILABLE_PRIMARY' | 'UNAVAILABLE_SECONDARY' | 'PENDING_PRIMARY' | 'PENDING_SECONDARY' | 'ELIGIBILITY_CHECK_FAILED_PRIMARY' | 'ELIGIBILITY_CHECK_FAILED_SECONDARY' | 'NEW_COMBO' | 'NEW_INSURANCE' | 'PRIOR_APPOINTMENT_NOT_READY' | 'NO_COVERAGE' | 'ERROR' | 'MANUAL'

The reason an appointment is NOT_READY. Only set when status is NOT_READY. All values except MANUAL are set by the automated eligibility check; MANUAL is set by staff via the API.

ready_source'MANUAL' | 'MACHINE'

Indicates how this appointment's status was marked as READY - MANUAL or MACHINE.

service_durationinteger required

The requested length of time allotted for the appointment. The units are in minutes.

placer_appointment_idstring nullable

ID for the appointment/order for the event.

placer_system_namestring nullable

The name of the upstream system that placed this appointment.

estimated_copay_centsinteger nullable
estimated_patient_responsibility_centsinteger nullable

The estimated amount the patient will be responsible for paying at the time of service. This does not include the copay.

patient_deposit_centsinteger nullable
appointment_detailsstring nullable
checked_in_timestampstring date-time nullable

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.

notesstring nullable
location_resource_idstring nullable

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

automated_eligibility_check_completeboolean nullable

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_queue'EMERGENT_ISSUE' | 'NEW_PATIENT' | 'RETURNING_PATIENT' | 'MANUAL_ESCALATION'

Response

idstring required

The unique identifier for an Appointment.

organization_idstring required

The unique identifier for an Organization in the database

deactivatedboolean required

True if the object is deactivated. Deactivated objects are not returned in search results but are returned in all other endpoints including scan.

versioninteger required

The version of the object. Any update to any property of an object object will create a new version.

updated_atstring date-time required
updating_user_idstring required

The unique identifier for a User in the database

patient_idstring required

The unique identifier for a Patient

start_timestampstring date-time required
status'PENDING' | 'NOT_READY' | 'READY' | 'CHECKED_IN'
not_ready_reason'INACTIVE_PRIMARY' | 'INACTIVE_SECONDARY' | 'MEDICARE_ADVANTAGE_CONVERSION' | 'MEDICAID_MANAGED_CONVERSION' | 'UNAVAILABLE_PRIMARY' | 'UNAVAILABLE_SECONDARY' | 'PENDING_PRIMARY' | 'PENDING_SECONDARY' | 'ELIGIBILITY_CHECK_FAILED_PRIMARY' | 'ELIGIBILITY_CHECK_FAILED_SECONDARY' | 'NEW_COMBO' | 'NEW_INSURANCE' | 'PRIOR_APPOINTMENT_NOT_READY' | 'NO_COVERAGE' | 'ERROR' | 'MANUAL'

The reason an appointment is NOT_READY. Only set when status is NOT_READY. All values except MANUAL are set by the automated eligibility check; MANUAL is set by staff via the API.

ready_source'MANUAL' | 'MACHINE'

Indicates how this appointment's status was marked as READY - MANUAL or MACHINE.

service_durationinteger required

The requested length of time allotted for the appointment. The units are in minutes.

placer_appointment_idstring nullable

ID for the appointment/order for the event.

placer_system_namestring nullable

The name of the upstream system that placed this appointment.

estimated_copay_centsinteger nullable
estimated_patient_responsibility_centsinteger nullable

The estimated amount the patient will be responsible for paying at the time of service. This does not include the copay.

patient_deposit_centsinteger nullable
appointment_detailsstring nullable
checked_in_timestampstring date-time nullable

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.

notesstring nullable
location_resource_idstring nullable

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

automated_eligibility_check_completeboolean nullable

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_queue'EMERGENT_ISSUE' | 'NEW_PATIENT' | 'RETURNING_PATIENT' | 'MANUAL_ESCALATION'

Changes

No recorded changes to this operation across all 1 revision of this API.