PreAppointmentResponse

Full pre-appointment record, returned by the Pre-Appointments operations. Note that the HIS inbound operations return the condensed PreAppointmentSummaryResponse instead.

specialty_namestring

Medical specialty name

Example: Cardiologia

provider_idstring<uuid>

Unique identifier of the provider

Example: b7f8c2d1-3e4a-4b5c-8d9e-0f1a2b3c4d5e

payer_namestring

Payer name

Example: Seguros Bolivar

updated_atstring<date-time>

Timestamp of the last update to the record

Example: 2026-07-07T09:12:44.870-05:00

doctor_namestring

Attending doctor name

Example: Dr. Juan Perez

payer_slugstring

Payer slug

Example: seguros-bolivar

beneficiary_plan_codestring

Code of the beneficiary's health plan

Example: PLAN-GOLD

idstring<uuid>

Unique identifier (UUID) of the pre-appointment record

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

beneficiary_card_numberstring

Beneficiary card number with the payer

Example: 1234567890

appointment_datestring<date-time>

Scheduled date and time of the appointment in ISO 8601 format

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

beneficiary_namestring

Beneficiary full name

Example: Maria Fernanda Gomez

created_bystring

Identity that created the record

Example: his-integration@clinica-santa-maria

sourcestring

Where the record came from. HIS_INBOUND = pushed by the HIS, MANUAL = created from the console. Only MANUAL records can be updated or deleted through the Pre-Appointments operations.

Possible values: [HIS_INBOUND, MANUAL]

Example: HIS_INBOUND

eligibility_checkedboolean

Whether the eligibility check has run for this pre-appointment. The detailed eligibility result is not exposed by the API.

service_namestring

Payer/HIS service name associated with the appointment

Example: Consulta Cardiologica

beneficiary_document_numberstring

Beneficiary identity document number

Example: 1020304050

provider_namestring

Provider name

Example: Clinica Santa Maria

provider_country_codestring

ISO 3166-1 alpha-2 country code of the provider

Example: CO

statusstring

Current status. Allowed transitions: PENDING → CONFIRMED or CANCELLED; CONFIRMED → COMPLETED or CANCELLED. COMPLETED and CANCELLED are terminal.

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

Example: PENDING

provider_branch_idstring<uuid>

Unique identifier of the provider branch where the appointment takes place

Example: c8a9d3e2-4f5b-4c6d-9e0f-1a2b3c4d5e6f

updated_bystring

Identity that last updated the record

Example: recepcion01@clinica-santa-maria

external_appointment_idstring

External appointment identifier from the HIS system. Together with the provider it identifies the record for the HIS inbound operations.

Example: HIS20260706001234

documents_completedboolean

Whether every required support document has been received. Recalculated asynchronously after each upload, so it can still be false right after a successful upload — re-read the record.

payer_idstring<uuid>

Unique identifier of the payer

Example: d9b0e4f3-5a6c-4d7e-8f90-2b3c4d5e6f70

provider_slugstring

Provider slug — the tenant identifier resolved from your token

Example: clinica-santa-maria

beneficiary_plan_namestring

Name of the beneficiary's health plan

Example: Plan Oro Familiar

beneficiary_document_typestring

Beneficiary identity document type, as used in the provider country

Example: CC

provider_branch_timezonestring

IANA timezone of the provider branch. Interpret appointment_date against this zone when displaying it.

Example: America/Bogota

doctor_codestring

Attending doctor code in the provider catalog

Example: DOC-4471

service_codestring

Payer/HIS service code associated with the appointment

Example: S1

charges object[]

Procedures or products attached to the pre-appointment.

Array [

provider_product_namestring

The provider's name for the product or procedure

Example: Consulta Cardiologica

provider_product_codestring

The provider's code for the product or procedure

Example: PROD-00123

idstring<uuid>

Unique identifier (UUID) of the charge record

Example: 7c9e6679-7425-40de-944b-e07fc1f90ae7

quantityinteger<int32>

How many units of the product

Possible values: >= 1

Example: 1

]

notesstring

Free-text notes attached to the pre-appointment

Example: Patient requested an early slot

agreement_namestring

Provider-payer agreement/convenio name associated with the appointment

Example: Premium Care Agreement 2024

agreement_codestring

Provider-payer agreement/convenio code associated with the appointment

Example: CONV-GOLD

confirmed_atstring<date-time>

Timestamp when the pre-appointment was confirmed. Null while the record is still PENDING.

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

created_atstring<date-time>

Timestamp when the pre-appointment record was created

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

specialty_codestring

Medical specialty code in the provider catalog

Example: ESP-CARD