Schema: PatientInput

All schemas · API reference · Data mapping guide

Fields

Field	Required	Type / allowed values
documentType	Yes	string
documentNumber	Yes	string
userType	No	string or null
birthDate	No	string or null
sexCode	No	string or null
countryResidenceCode	No	string or null
countryOriginCode	No	string or null
municipalityResidenceCode	No	string or null
territorialZoneCode	No	string or null
disabilityFlag	No	string or null
incapacityCertificate	No	SI, NO, null
registroSiras	No	string or null
firstName	Yes	string
middleName	No	string or null
lastName	Yes	string
secondLastName	No	string or null

JSON definition

The JSON retains the source contract descriptions. Do not translate property names or enum values.

{
  "type": "object",
  "properties": {
    "documentType": {
      "type": "string",
      "minLength": 1,
      "maxLength": 5
    },
    "documentNumber": {
      "type": "string",
      "minLength": 1,
      "maxLength": 20,
      "pattern": "^\\S+$"
    },
    "userType": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 5
    },
    "birthDate": {
      "type": [
        "string",
        "null"
      ],
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
      "description": "Fecha AAAA-MM-DD.",
      "example": "2026-10-15"
    },
    "sexCode": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 2
    },
    "countryResidenceCode": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 5
    },
    "countryOriginCode": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 5
    },
    "municipalityResidenceCode": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 8
    },
    "territorialZoneCode": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 4
    },
    "disabilityFlag": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 4
    },
    "incapacityCertificate": {
      "type": [
        "string",
        "null"
      ],
      "enum": [
        "SI",
        "NO",
        null
      ],
      "description": "Certificado de incapacidad: SI, NO o null."
    },
    "registroSiras": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 20
    },
    "firstName": {
      "type": "string",
      "minLength": 1,
      "maxLength": 60
    },
    "middleName": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 60
    },
    "lastName": {
      "type": "string",
      "minLength": 1,
      "maxLength": 60
    },
    "secondLastName": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 60
    }
  },
  "required": [
    "documentType",
    "documentNumber",
    "firstName",
    "lastName"
  ],
  "additionalProperties": false,
  "description": "Ejemplo sintético. Use los datos reales del paciente autorizado y los códigos de su catálogo.",
  "example": {
    "documentType": "CC",
    "documentNumber": "1000000002",
    "firstName": "Paciente",
    "lastName": "Ejemplo",
    "birthDate": "1990-01-01",
    "userType": "01",
    "sexCode": "F",
    "countryResidenceCode": "170",
    "countryOriginCode": "170",
    "municipalityResidenceCode": "11001",
    "territorialZoneCode": "01",
    "incapacityCertificate": "NO"
  }
}