CreatePreAppointmentHisInboundRequest

Request payload for creating a pre-appointment from HIS inbound data

doctor_codestring

Provider's internal physician/doctor code

Possible values: <= 100 characters

Example: DOC12345

external_appointment_idstringrequired

Unique external appointment identifier from the HIS system. Used for deduplication: if an appointment with the same external_appointment_id already exists, the second request returns the existing appointment with status 200.

Possible values: <= 100 characters

Example: HIS20260706001234

appointment_datestring<date-time>required

Scheduled date and time of the appointment in ISO 8601 format with timezone

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

service_codestring

Service code associated with the appointment (payer/HIS service identifier)

Possible values: <= 64 characters

Example: S1

agreement_namestring

Agreement or contract name

Possible values: <= 255 characters

Example: Premium Care Agreement 2024

service_namestring

Service name associated with the appointment

Possible values: <= 255 characters

Example: Consulta Cardiologica

notesstring

Additional notes or comments about the appointment

Example: Patient has previous surgery records, bring documents

beneficiary_namestringrequired

Full name of the beneficiary

Possible values: <= 255 characters

Example: Juan Carlos Perez Gomez

beneficiary_plan_namestring

Plan name or description

Possible values: <= 255 characters

Example: Plan Plus Health

beneficiary_document_numberstringrequired

Number of the beneficiary's identification document

Possible values: <= 50 characters

Example: 1234567890

specialty_namestring

Medical specialty of the appointment (e.g., Cardiology, Orthopedics)

Possible values: <= 255 characters

Example: Cardiology

charges object[]

List of procedures or services associated with this appointment

Array [

provider_product_namestringrequired

Possible values: <= 255 characters

provider_product_codestringrequired

Possible values: <= 100 characters

quantityinteger<int32>

Possible values: >= 1

]

doctor_namestring

Name of the physician/doctor assigned to the appointment

Possible values: <= 255 characters

Example: Dr. Maria Sanchez

beneficiary_plan_codestring

Plan code under which the beneficiary is enrolled

Possible values: <= 64 characters

Example: PLAN001

beneficiary_document_typestringrequired

Type of beneficiary's identification document (e.g., 'CC' for Cedula de Ciudadania, 'CE' for Cedula de Extranjeria)

Possible values: <= 50 characters

Example: CC

specialty_codestring

Provider's internal specialty code

Possible values: <= 100 characters

Example: CARD001

payer_tax_identification_numberstringrequired

Tax identification number (NIT) of the payer/insurance company. Alphanumeric, dot and hyphen only. Used to resolve the payer record from rcm-api.

Possible values: <= 20 characters, Value must match regular expression ^[A-Za-z0-9.\-]+$

Example: 800123456

agreement_codestring

Agreement or contract code between provider and payer

Possible values: <= 64 characters

Example: AGR2024001

beneficiary_card_numberstringrequired

Beneficiary's insurance card number

Possible values: <= 100 characters

Example: 0123456789