JOjoincandidhealth
v1

Create

Changed on

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

post/appointments/v1

Request

  • Base URL
    https://pre-api.joincandidhealth.com
  • URL
    https://pre-api.joincandidhealth.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' | 'CHECKED_OUT' | 'NO_SHOW'
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.

ready_reason'REVIEWED_RTE' | 'CHECKED_PAYER_PORTAL' | 'CALLED_PAYER' | 'PRIOR_APPOINTMENT_READY'

The reason an appointment is READY. Only set when status is READY, CHECKED_IN, CHECKED_OUT or NO_SHOW.

service_durationinteger required

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

placer_appointment_idstring

ID for the appointment/order for the event.

placer_system_namestring

The name of the upstream system that placed this appointment.

estimated_copay_centsinteger
estimated_patient_responsibility_centsinteger

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

patient_deposit_centsinteger
appointment_detailsstring
checked_in_timestampstring date-time

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_timestampstring date-time

The timestamp when the patient checked out of their appointment. Must be set when status is CHECKED_OUT, and must be unset otherwise.

medical_necessity_verifiedboolean

True if medical necessity for this appointment has been verified.

prior_authorization_status'NOT_REQUIRED' | 'REQUIRED' | 'PENDING' | 'APPROVED' | 'PARTIALLY_APPROVED' | 'DENIED' | 'EXPIRED'

The prior authorization status for the appointment.

notesstring
location_resource_idstring

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

automated_eligibility_check_completeboolean

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'
cancellation_reasonstring

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

Response with status 200

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' | 'CHECKED_OUT' | 'NO_SHOW'
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.

ready_reason'REVIEWED_RTE' | 'CHECKED_PAYER_PORTAL' | 'CALLED_PAYER' | 'PRIOR_APPOINTMENT_READY'

The reason an appointment is READY. Only set when status is READY, CHECKED_IN, CHECKED_OUT or NO_SHOW.

service_durationinteger required

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

placer_appointment_idstring

ID for the appointment/order for the event.

placer_system_namestring

The name of the upstream system that placed this appointment.

estimated_copay_centsinteger
estimated_patient_responsibility_centsinteger

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

patient_deposit_centsinteger
appointment_detailsstring
checked_in_timestampstring date-time

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_timestampstring date-time

The timestamp when the patient checked out of their appointment. Must be set when status is CHECKED_OUT, and must be unset otherwise.

medical_necessity_verifiedboolean

True if medical necessity for this appointment has been verified.

prior_authorization_status'NOT_REQUIRED' | 'REQUIRED' | 'PENDING' | 'APPROVED' | 'PARTIALLY_APPROVED' | 'DENIED' | 'EXPIRED'

The prior authorization status for the appointment.

notesstring
location_resource_idstring

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

automated_eligibility_check_completeboolean

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'
cancellation_reasonstring

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.

idstring required

The unique identifier for an Appointment.

Changes

  • d8b0a61873e2Revision changes
    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 4074901c170fRevision changes
    • info

      added the new optional request property

    • info

      added the optional property to the response with the status