PreAppointmentSummaryResponse

Condensed pre-appointment returned by the HIS inbound operations. Carries the identity of the record plus counts; for the full record (provider, payer, beneficiary, doctor, specialty and charges) read it back with GET /v1/checkin/appointments/{id}.

statusstring

Current status of the pre-appointment (PENDING, CONFIRMED, COMPLETED, CANCELLED)

Possible values: [PENDING, CONFIRMED, COMPLETED, CANCELLED]

Example: PENDING

external_appointment_idstring

External appointment identifier from the HIS system

Example: HIS20260706001234

appointment_datestring<date-time>

Scheduled date and time of the appointment in ISO 8601 format

Example: 2026-07-15T14:30:00-05:00

service_codestring

Payer/HIS service code associated with the appointment

Example: S1

agreement_namestring

Provider-payer agreement/convenio name associated with the appointment

Example: Premium Care Agreement 2024

service_namestring

Payer/HIS service name associated with the appointment

Example: Consulta Cardiologica

created_atstring<date-time>

Timestamp when the pre-appointment record was created

Example: 2026-07-06T16:45:23.123-05:00

sourcestring

Source of the pre-appointment data (HIS_INBOUND = from external HIS system, MANUAL = created manually)

Possible values: [HIS_INBOUND, MANUAL]

Example: HIS_INBOUND

documents_countinteger<int32>

Total count of documents associated with this pre-appointment

Example: 3

charges_countinteger<int32>

Total count of procedures/charges associated with this pre-appointment

Example: 2

idstring<uuid>

Unique identifier (UUID) of the pre-appointment record

Example: 550e8400-e29b-41d4-a716-446655440000

agreement_codestring

Provider-payer agreement/convenio code associated with the appointment

Example: CONV-GOLD