Saltar al contenido principal

Reservar una cita

POST/appointments

Consume un optionToken vigente y reserva atomicamente la capacidad para el paciente. Revalida tenant, disponibilidad y elegibilidad; una opcion vencida o agotada no crea cita.

curl --request POST \
  --url '${BASE_URL}/appointments' \
  --header 'Authorization: Bearer ${ACCESS_TOKEN}' \
  --header 'Content-Type: application/json' \
  --header 'X-Correlation-Id: 10000000-0000-4000-8000-000000000008' \
  --header 'Idempotency-Key: appointment-demo-0001' \
  --data '{
    "patientId": "20000000-0000-4000-8000-000000000001",
    "serviceId": "30000000-0000-4000-8000-000000000003",
    "optionToken": "opt_preview_synthetic_not_a_real_token",
    "visitType": "FIRST_TIME"
  }'

Request

Headers y parametros

Nombre	Ubicacion	Requerido	Descripcion
`X-Correlation-Id`	header	No	UUID generado por el consumidor para trazabilidad; el servidor genera uno si se omite.
`Idempotency-Key`	header	Si	Clave unica por service principal y operacion; reutilizarla con otro payload produce 409.

Payload

Paciente, opcion opaca y contexto de cobertura de la reserva.

Content-Type: application/json

Campo	Tipo	Requerido	Descripcion
`eligibilityDecisionId`	`string (uuid)`	No	-
`optionToken`	`string`	Si	-
`patientId`	`string (uuid)`	Si	-
`serviceId`	`string (uuid)`	Si	-
`visitType`	`string`	Si	FIRST_TIME, CONTROL

Ejemplo

{
  "eligibilityDecisionId": "40000000-0000-4000-8000-000000000001",
  "optionToken": "opt_preview_synthetic_not_a_real_token",
  "patientId": "20000000-0000-4000-8000-000000000001",
  "serviceId": "30000000-0000-4000-8000-000000000003",
  "visitType": "FIRST_TIME"
}

Responses

201Cita reservada o resultado original de un replay valido.

Content-Type: application/json

Campo	Tipo	Requerido	Descripcion
`endsAt`	`string (date-time)`	Si	-
`id`	`string (uuid)`	Si	-
`patientId`	`string (uuid)`	Si	-
`serviceId`	`string (uuid)`	Si	-
`startsAt`	`string (date-time)`	Si	-
`status`	`string`	Si	PENDING, CONFIRMED, CHECKED_IN, ATTENDED, CANCELLED, NO_SHOW
`version`	`integer`	Si	-

Ejemplo

{
  "endsAt": "2026-08-03T09:30:00-05:00",
  "id": "60000000-0000-4000-8000-000000000001",
  "patientId": "20000000-0000-4000-8000-000000000001",
  "serviceId": "30000000-0000-4000-8000-000000000003",
  "startsAt": "2026-08-03T09:00:00-05:00",
  "status": "PENDING",
  "version": 1
}

400Solicitud mal formada o parametro invalido.

Content-Type: application/problem+json

Campo	Tipo	Requerido	Descripcion
`code`	`string`	Si	-
`correlationId`	`string (uuid)`	Si	-
`detail`	`string`	No	Explicacion segura sin PII ni secretos.
`errors`	`object[]`	No	-
`instance`	`string (uri-reference)`	No	-
`status`	`integer`	Si	-
`title`	`string`	Si	-
`type`	`string (uri)`	Si	URI estable que identifica la clase de problema.

Ejemplo

{
  "code": "INVALID_REQUEST",
  "correlationId": "10000000-0000-4000-8000-000000000001",
  "detail": "Revise los parametros enviados.",
  "status": 400,
  "title": "Solicitud invalida",
  "type": "https://magnosoft.com.co/problems/invalid-request"
}

401Token ausente, invalido, vencido o con audience incorrecta.

Content-Type: application/problem+json

Campo	Tipo	Requerido	Descripcion
`code`	`string`	Si	-
`correlationId`	`string (uuid)`	Si	-
`detail`	`string`	No	Explicacion segura sin PII ni secretos.
`errors`	`object[]`	No	-
`instance`	`string (uri-reference)`	No	-
`status`	`integer`	Si	-
`title`	`string`	Si	-
`type`	`string (uri)`	Si	URI estable que identifica la clase de problema.

Ejemplo

{
  "code": "INVALID_ACCESS_TOKEN",
  "correlationId": "10000000-0000-4000-8000-000000000001",
  "status": 401,
  "title": "Autenticacion requerida",
  "type": "https://magnosoft.com.co/problems/unauthorized"
}

403Service principal autenticado sin el scope requerido.

Content-Type: application/problem+json

Campo	Tipo	Requerido	Descripcion
`code`	`string`	Si	-
`correlationId`	`string (uuid)`	Si	-
`detail`	`string`	No	Explicacion segura sin PII ni secretos.
`errors`	`object[]`	No	-
`instance`	`string (uri-reference)`	No	-
`status`	`integer`	Si	-
`title`	`string`	Si	-
`type`	`string (uri)`	Si	URI estable que identifica la clase de problema.

Ejemplo

{
  "code": "INSUFFICIENT_SCOPE",
  "correlationId": "10000000-0000-4000-8000-000000000001",
  "status": 403,
  "title": "Permiso insuficiente",
  "type": "https://magnosoft.com.co/problems/forbidden"
}

409Conflicto de concurrencia, capacidad o reutilizacion de idempotencia.

Content-Type: application/problem+json

Campo	Tipo	Requerido	Descripcion
`code`	`string`	Si	-
`correlationId`	`string (uuid)`	Si	-
`detail`	`string`	No	Explicacion segura sin PII ni secretos.
`errors`	`object[]`	No	-
`instance`	`string (uri-reference)`	No	-
`status`	`integer`	Si	-
`title`	`string`	Si	-
`type`	`string (uri)`	Si	URI estable que identifica la clase de problema.

Ejemplo

{
  "code": "CONCURRENT_MODIFICATION",
  "correlationId": "10000000-0000-4000-8000-000000000001",
  "detail": "El recurso cambio; consulte su estado antes de reintentar.",
  "status": 409,
  "title": "Conflicto de estado",
  "type": "https://magnosoft.com.co/problems/conflict"
}

410Option token vencido o recurso temporal que ya no puede consumirse.

Content-Type: application/problem+json

Campo	Tipo	Requerido	Descripcion
`code`	`string`	Si	-
`correlationId`	`string (uuid)`	Si	-
`detail`	`string`	No	Explicacion segura sin PII ni secretos.
`errors`	`object[]`	No	-
`instance`	`string (uri-reference)`	No	-
`status`	`integer`	Si	-
`title`	`string`	Si	-
`type`	`string (uri)`	Si	URI estable que identifica la clase de problema.

Ejemplo

{
  "code": "OPTION_EXPIRED",
  "correlationId": "10000000-0000-4000-8000-000000000001",
  "status": 410,
  "title": "Opcion vencida",
  "type": "https://magnosoft.com.co/problems/option-expired"
}

422JSON valido que incumple una regla de validacion del contrato.

Content-Type: application/problem+json

Campo	Tipo	Requerido	Descripcion
`code`	`string`	Si	-
`correlationId`	`string (uuid)`	Si	-
`detail`	`string`	No	Explicacion segura sin PII ni secretos.
`errors`	`object[]`	No	-
`instance`	`string (uri-reference)`	No	-
`status`	`integer`	Si	-
`title`	`string`	Si	-
`type`	`string (uri)`	Si	URI estable que identifica la clase de problema.

Ejemplo

{
  "code": "VALIDATION_FAILED",
  "correlationId": "10000000-0000-4000-8000-000000000001",
  "errors": [
    {
      "code": "INVALID_DATE",
      "field": "serviceDate",
      "message": "Debe ser una fecha ISO 8601 valida."
    }
  ],
  "status": 422,
  "title": "Validacion fallida",
  "type": "https://magnosoft.com.co/problems/validation"
}

429Limite de solicitudes excedido para el service principal.

Content-Type: application/problem+json

Campo	Tipo	Requerido	Descripcion
`code`	`string`	Si	-
`correlationId`	`string (uuid)`	Si	-
`detail`	`string`	No	Explicacion segura sin PII ni secretos.
`errors`	`object[]`	No	-
`instance`	`string (uri-reference)`	No	-
`status`	`integer`	Si	-
`title`	`string`	Si	-
`type`	`string (uri)`	Si	URI estable que identifica la clase de problema.

Ejemplo

{
  "code": "RATE_LIMIT_EXCEEDED",
  "correlationId": "10000000-0000-4000-8000-000000000001",
  "status": 429,
  "title": "Demasiadas solicitudes",
  "type": "https://magnosoft.com.co/problems/rate-limit"
}