Saltar al contenido principal

Registrar un paciente

POST/patients

Crea un paciente en el tenant del service principal, registra la evidencia temporal de consentimiento y rechaza duplicados activos. La clave de idempotencia identifica el intento y no puede reutilizarse con otro payload.

curl --request POST \
  --url 'https://citamedica.magnosoft.com.co/api/external/v1/patients' \
  --header 'Authorization: Bearer ${ACCESS_TOKEN}' \
  --header 'Content-Type: application/json' \
  --header 'X-Correlation-Id: 10000000-0000-4000-8000-000000000002' \
  --header 'Idempotency-Key: patient-demo-0001' \
  --data '{
    "documentType": "CC",
    "documentNumber": "900000001",
    "fullName": "Paciente Ejemplo",
    "phone": "3000000000",
    "email": "paciente@example.invalid",
    "consentGrantedAt": "2026-07-26T14:00:00-05:00"
  }'

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

Datos minimos del paciente; no incluya historia clinica ni credenciales.

Content-Type: application/json

Campo	Tipo	Requerido	Descripcion
`consentGrantedAt`	`string (date-time)`	Si	-
`documentNumber`	`string`	Si	-
`documentType`	`string`	Si	-
`email`	`string (email)`	No	-
`fullName`	`string`	Si	-
`phone`	`string`	Si	-

Ejemplo

{
  "consentGrantedAt": "2026-07-26T14:00:00-05:00",
  "documentNumber": "900000001",
  "documentType": "CC",
  "email": "paciente@example.invalid",
  "fullName": "Paciente Ejemplo",
  "phone": "3000000000"
}

Responses

201Paciente creado o resultado original de un replay valido.

Content-Type: application/json

Campo	Tipo	Requerido	Descripcion
`documentNumber`	`string`	Si	Se retorna solo a clientes expresamente autorizados por scope.
`documentType`	`string`	Si	-
`email`	`string (email)`	No	-
`fullName`	`string`	Si	-
`id`	`string (uuid)`	Si	-
`phone`	`string`	Si	-
`status`	`string`	Si	ACTIVE, INACTIVE, DECEASED
`version`	`integer`	Si	-

Ejemplo

{
  "documentNumber": "900000001",
  "documentType": "CC",
  "email": "paciente@example.invalid",
  "fullName": "Paciente Ejemplo",
  "id": "20000000-0000-4000-8000-000000000001",
  "phone": "3000000000",
  "status": "ACTIVE",
  "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"
}

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"
}