Schema: HealthFields

All schemas · API reference · Data mapping guide

Fields

Field	Required	Type / allowed values
invoice_period_start_date	Yes	string
invoice_period_end_date	Yes	string
health_type_operation_id	Yes	string
users_info	Yes	array

JSON definition

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

{
  "type": "object",
  "properties": {
    "invoice_period_start_date": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
      "description": "Fecha AAAA-MM-DD.",
      "example": "2026-10-15"
    },
    "invoice_period_end_date": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
      "description": "Fecha AAAA-MM-DD.",
      "example": "2026-10-15"
    },
    "health_type_operation_id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 12
    },
    "users_info": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "provider_code": {
            "type": "string",
            "pattern": "^\\d{10,12}$",
            "description": "Debe ser un código de prestador o de sede verificado del espacio."
          },
          "health_coverage_id": {
            "type": "string",
            "minLength": 1,
            "maxLength": 4
          },
          "health_contracting_payment_method_id": {
            "type": "string",
            "minLength": 1,
            "maxLength": 4
          },
          "contract_number": {
            "type": "string",
            "maxLength": 60
          },
          "policy_number": {
            "type": "string",
            "maxLength": 60
          },
          "invoice_without_contract_reason": {
            "type": "string",
            "maxLength": 4
          },
          "co_payment": {
            "anyOf": [
              {
                "type": "string",
                "pattern": "^-?\\d{1,15}(?:\\.\\d{1,6})?$"
              },
              {
                "type": "number"
              }
            ],
            "description": "Valor decimal como texto (\"100.00\") o número JSON. Use punto decimal, sin separador de miles; se admiten hasta 6 decimales.",
            "example": "100000.00"
          },
          "moderating_fee": {
            "anyOf": [
              {
                "type": "string",
                "pattern": "^-?\\d{1,15}(?:\\.\\d{1,6})?$"
              },
              {
                "type": "number"
              }
            ],
            "description": "Valor decimal como texto (\"100.00\") o número JSON. Use punto decimal, sin separador de miles; se admiten hasta 6 decimales.",
            "example": "100000.00"
          },
          "recovery_fee": {
            "anyOf": [
              {
                "type": "string",
                "pattern": "^-?\\d{1,15}(?:\\.\\d{1,6})?$"
              },
              {
                "type": "number"
              }
            ],
            "description": "Valor decimal como texto (\"100.00\") o número JSON. Use punto decimal, sin separador de miles; se admiten hasta 6 decimales.",
            "example": "100000.00"
          },
          "shared_payment": {
            "anyOf": [
              {
                "type": "string",
                "pattern": "^-?\\d{1,15}(?:\\.\\d{1,6})?$"
              },
              {
                "type": "number"
              }
            ],
            "description": "Valor decimal como texto (\"100.00\") o número JSON. Use punto decimal, sin separador de miles; se admiten hasta 6 decimales.",
            "example": "100000.00"
          }
        },
        "required": [
          "provider_code",
          "health_coverage_id",
          "health_contracting_payment_method_id"
        ],
        "additionalProperties": false
      },
      "minItems": 1,
      "maxItems": 1
    }
  },
  "required": [
    "invoice_period_start_date",
    "invoice_period_end_date",
    "health_type_operation_id",
    "users_info"
  ],
  "additionalProperties": false,
  "description": "Campos del sector salud. Obligatorios en la factura de salud."
}