Servicios de salud

Appointments of a patient #

GET/v1/gateway/health-services/appointments/

• operationId listHealthAppointments
• Autenticación X-API-Key · scope appointments:read
• Idempotency-Key no aplica

Parámetros

Respuestas

Ejemplo

client.health.appointments.list()

client.health.appointments.list()

$client->health->appointments->list()

await client.Health.Appointments.ListAsync()

client.Health.Appointments.List(ctx, …)

curl "https://sandbox.dev.compense.co/gw/v1/gateway/health-services/appointments/?document=1032456789" \
  -H "X-API-Key: $COMPENSE_API_KEY"

Los métodos de cada SDK salen de su suite de paridad con el contrato. El cURL va contra el sandbox; los valores <campo> son marcadores.

Book an appointment for a patient #

POST/v1/gateway/health-services/appointments/

• operationId bookHealthAppointment
• Autenticación X-API-Key · scope appointments:write
• Idempotency-Key recomendada (el SDK la genera)

Parámetros

Cuerpo de la petición

Tipo de contenido: application/json · obligatorio

Respuestas

Ejemplo

client.health.appointments.book()

client.health.appointments.book()

$client->health->appointments->book()

await client.Health.Appointments.BookAsync()

client.Health.Appointments.Book(ctx, …)

curl -X POST "https://sandbox.dev.compense.co/gw/v1/gateway/health-services/appointments/" \
  -H "X-API-Key: $COMPENSE_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
    "document": "1032456789",
    "slot_id": "<slot_id>"
  }'

Los métodos de cada SDK salen de su suite de paridad con el contrato. El cURL va contra el sandbox; los valores <campo> son marcadores.

Appointment detail #

GET/v1/gateway/health-services/appointments/{appointment_id}/

• operationId getHealthAppointment
• Autenticación X-API-Key · scope appointments:read
• Idempotency-Key no aplica

Parámetros

Respuestas

Ejemplo

client.health.appointments.get()

client.health.appointments.get()

$client->health->appointments->get()

await client.Health.Appointments.GetAsync()

client.Health.Appointments.Get(ctx, …)

curl "https://sandbox.dev.compense.co/gw/v1/gateway/health-services/appointments/CITA-2026-000123/" \
  -H "X-API-Key: $COMPENSE_API_KEY"

Los métodos de cada SDK salen de su suite de paridad con el contrato. El cURL va contra el sandbox; los valores <campo> son marcadores.

Cancel an appointment (releases the slot) #

POST/v1/gateway/health-services/appointments/{appointment_id}/cancel/

• operationId cancelHealthAppointment
• Autenticación X-API-Key · scope appointments:write
• Idempotency-Key recomendada (el SDK la genera)

Parámetros

Cuerpo de la petición

Tipo de contenido: application/json · obligatorio

Respuestas

Ejemplo

client.health.appointments.cancel()

client.health.appointments.cancel()

$client->health->appointments->cancel()

await client.Health.Appointments.CancelAsync()

client.Health.Appointments.Cancel(ctx, …)

curl -X POST "https://sandbox.dev.compense.co/gw/v1/gateway/health-services/appointments/CITA-2026-000123/cancel/" \
  -H "X-API-Key: $COMPENSE_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
    "reason": "<reason>"
  }'

Los métodos de cada SDK salen de su suite de paridad con el contrato. El cURL va contra el sandbox; los valores <campo> son marcadores.

Reschedule to another slot #

POST/v1/gateway/health-services/appointments/{appointment_id}/reschedule/

• operationId rescheduleHealthAppointment
• Autenticación X-API-Key · scope appointments:write
• Idempotency-Key recomendada (el SDK la genera)

Parámetros

Cuerpo de la petición

Tipo de contenido: application/json · obligatorio

Respuestas

Ejemplo

client.health.appointments.reschedule()

client.health.appointments.reschedule()

$client->health->appointments->reschedule()

await client.Health.Appointments.RescheduleAsync()

client.Health.Appointments.Reschedule(ctx, …)

curl -X POST "https://sandbox.dev.compense.co/gw/v1/gateway/health-services/appointments/CITA-2026-000123/reschedule/" \
  -H "X-API-Key: $COMPENSE_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
    "new_slot_id": "<new_slot_id>"
  }'

Los métodos de cada SDK salen de su suite de paridad con el contrato. El cURL va contra el sandbox; los valores <campo> son marcadores.

Record attendance (completed / no_show) #

POST/v1/gateway/health-services/appointments/{appointment_id}/status/

• operationId setHealthAppointmentAttendance
• Autenticación X-API-Key · scope appointments:write
• Idempotency-Key recomendada (el SDK la genera)

Parámetros

Cuerpo de la petición

Tipo de contenido: application/json · obligatorio

Respuestas

Ejemplo

client.health.appointments.set_attendance()

client.health.appointments.setAttendance()

$client->health->appointments->setAttendance()

await client.Health.Appointments.SetAttendanceAsync()

client.Health.Appointments.SetAttendance(ctx, …)

curl -X POST "https://sandbox.dev.compense.co/gw/v1/gateway/health-services/appointments/CITA-2026-000123/status/" \
  -H "X-API-Key: $COMPENSE_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
    "status": "completed"
  }'

Los métodos de cada SDK salen de su suite de paridad con el contrato. El cURL va contra el sandbox; los valores <campo> son marcadores.

Free appointment slots #

GET/v1/gateway/health-services/availability/

• operationId listHealthAvailability
• Autenticación X-API-Key · scope appointments:read
• Idempotency-Key no aplica

Parámetros

Respuestas

Ejemplo

client.health.availability()

client.health.availability()

$client->health->availability()

await client.Health.AvailabilityAsync()

client.Health.Availability(ctx, …)

curl "https://sandbox.dev.compense.co/gw/v1/gateway/health-services/availability/" \
  -H "X-API-Key: $COMPENSE_API_KEY"

Los métodos de cada SDK salen de su suite de paridad con el contrato. El cURL va contra el sandbox; los valores <campo> son marcadores.

Glosas (read only) #

GET/v1/gateway/health-services/billing/glosas/

• operationId listHealthGlosas
• Autenticación X-API-Key · scope health_billing:read
• Idempotency-Key no aplica

Parámetros

Respuestas

Ejemplo

client.health.billing.list_glosas()

client.health.billing.listGlosas()

$client->health->billing->listGlosas()

await client.Health.Billing.ListGlosasAsync()

client.Health.Billing.ListGlosas(ctx, …)

curl "https://sandbox.dev.compense.co/gw/v1/gateway/health-services/billing/glosas/" \
  -H "X-API-Key: $COMPENSE_API_KEY"

Los métodos de cada SDK salen de su suite de paridad con el contrato. El cURL va contra el sandbox; los valores <campo> son marcadores.

Health invoices with DIAN / radication status #

GET/v1/gateway/health-services/billing/invoices/

• operationId listHealthInvoices
• Autenticación X-API-Key · scope health_billing:read
• Idempotency-Key no aplica

Parámetros

Respuestas

Ejemplo

client.health.billing.list_invoices()

client.health.billing.listInvoices()

$client->health->billing->listInvoices()

await client.Health.Billing.ListInvoicesAsync()

client.Health.Billing.ListInvoices(ctx, …)

curl "https://sandbox.dev.compense.co/gw/v1/gateway/health-services/billing/invoices/" \
  -H "X-API-Key: $COMPENSE_API_KEY"

Los métodos de cada SDK salen de su suite de paridad con el contrato. El cURL va contra el sandbox; los valores <campo> son marcadores.

Invoice detail (lines, payments, glosas, radications) #

GET/v1/gateway/health-services/billing/invoices/{invoice_id}/

• operationId getHealthInvoice
• Autenticación X-API-Key · scope health_billing:read
• Idempotency-Key no aplica

Parámetros

Respuestas

Ejemplo

client.health.billing.get_invoice()

client.health.billing.getInvoice()

$client->health->billing->getInvoice()

await client.Health.Billing.GetInvoiceAsync()

client.Health.Billing.GetInvoice(ctx, …)

curl "https://sandbox.dev.compense.co/gw/v1/gateway/health-services/billing/invoices/3f2b8c1e-0000-4a1b-9c2d-000000000001/" \
  -H "X-API-Key: $COMPENSE_API_KEY"

Los métodos de cada SDK salen de su suite de paridad con el contrato. El cURL va contra el sandbox; los valores <campo> son marcadores.

Register a payer (EPS) payment on an invoice #

POST/v1/gateway/health-services/billing/invoices/{invoice_id}/payments/

• operationId registerHealthInvoicePayment
• Autenticación X-API-Key · scope health_billing:collect
• Idempotency-Key recomendada (el SDK la genera)

Parámetros

Cuerpo de la petición

Tipo de contenido: application/json · obligatorio

Respuestas

Ejemplo

client.health.billing.register_payment()

client.health.billing.registerPayment()

$client->health->billing->registerPayment()

await client.Health.Billing.RegisterPaymentAsync()

client.Health.Billing.RegisterPayment(ctx, …)

curl -X POST "https://sandbox.dev.compense.co/gw/v1/gateway/health-services/billing/invoices/3f2b8c1e-0000-4a1b-9c2d-000000000001/payments/" \
  -H "X-API-Key: $COMPENSE_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": "53500.00",
    "method": "TRANSFERENCIA",
    "reference": "<reference>"
  }'

Los métodos de cada SDK salen de su suite de paridad con el contrato. El cURL va contra el sandbox; los valores <campo> son marcadores.

RIPS JSON of the invoice #

GET/v1/gateway/health-services/billing/invoices/{invoice_id}/rips/

• operationId getHealthInvoiceRips
• Autenticación X-API-Key · scope health_billing:read
• Idempotency-Key no aplica

Parámetros

Respuestas

Ejemplo

client.health.billing.get_invoice_rips()

client.health.billing.getInvoiceRips()

$client->health->billing->getInvoiceRips()

await client.Health.Billing.GetInvoiceRipsAsync()

client.Health.Billing.GetInvoiceRIPS(ctx, …)

curl "https://sandbox.dev.compense.co/gw/v1/gateway/health-services/billing/invoices/3f2b8c1e-0000-4a1b-9c2d-000000000001/rips/" \
  -H "X-API-Key: $COMPENSE_API_KEY"

Los métodos de cada SDK salen de su suite de paridad con el contrato. El cURL va contra el sandbox; los valores <campo> son marcadores.

Electronic invoice XML (wrapped in JSON) #

GET/v1/gateway/health-services/billing/invoices/{invoice_id}/xml/

• operationId getHealthInvoiceXml
• Autenticación X-API-Key · scope health_billing:read
• Idempotency-Key no aplica

Parámetros

Respuestas

Ejemplo

client.health.billing.get_invoice_xml()

client.health.billing.getInvoiceXml()

$client->health->billing->getInvoiceXml()

await client.Health.Billing.GetInvoiceXmlAsync()

client.Health.Billing.GetInvoiceXML(ctx, …)

curl "https://sandbox.dev.compense.co/gw/v1/gateway/health-services/billing/invoices/3f2b8c1e-0000-4a1b-9c2d-000000000001/xml/" \
  -H "X-API-Key: $COMPENSE_API_KEY"

Los métodos de cada SDK salen de su suite de paridad con el contrato. El cURL va contra el sandbox; los valores <campo> son marcadores.

Booking catalog (specialties, services, sites, doctors) #

GET/v1/gateway/health-services/catalog/

• operationId getHealthCatalog
• Autenticación X-API-Key · scope appointments:read
• Idempotency-Key no aplica

Respuestas

Ejemplo

client.health.catalog()

client.health.catalog()

$client->health->catalog()

await client.Health.CatalogAsync()

client.Health.Catalog(ctx, …)

curl "https://sandbox.dev.compense.co/gw/v1/gateway/health-services/catalog/" \
  -H "X-API-Key: $COMPENSE_API_KEY"

Los métodos de cada SDK salen de su suite de paridad con el contrato. El cURL va contra el sandbox; los valores <campo> son marcadores.

Patient vaccination card / schedule #

GET/v1/gateway/health-services/vaccination/card/

• operationId getVaccinationCard
• Autenticación X-API-Key · scope vaccination:read
• Idempotency-Key no aplica

Parámetros

Respuestas

Ejemplo

client.health.vaccination.card()

client.health.vaccination.card()

$client->health->vaccination->card()

await client.Health.Vaccination.CardAsync()

client.Health.Vaccination.Card(ctx, …)

curl "https://sandbox.dev.compense.co/gw/v1/gateway/health-services/vaccination/card/?document=1032456789" \
  -H "X-API-Key: $COMPENSE_API_KEY"

Los métodos de cada SDK salen de su suite de paridad con el contrato. El cURL va contra el sandbox; los valores <campo> son marcadores.