Schema: ServiceInput

All schemas · API reference · Data mapping guide

Fields

Field	Required	Type / allowed values
category	Yes	ServiceCategory
name	Yes	string
description	No	string or null
payload	Yes	RipsServiceTemplate
inputProvenance	No	object

JSON definition

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

{
  "type": "object",
  "properties": {
    "category": {
      "$ref": "#/components/schemas/ServiceCategory"
    },
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 1000
    },
    "payload": {
      "$ref": "#/components/schemas/RipsServiceTemplate"
    },
    "inputProvenance": {
      "type": "object",
      "additionalProperties": {},
      "description": "Procedencia de prellenados y ediciones explícitas. Se verifica contra la configuración del espacio."
    }
  },
  "required": [
    "category",
    "name",
    "payload"
  ],
  "additionalProperties": false,
  "description": "Plantilla de servicio. Sustituya los datos sintéticos de prestador, profesional y códigos antes de usarla en un RIPS.",
  "example": {
    "category": 1,
    "name": "Consulta de ejemplo",
    "payload": {
      "codPrestador": "110010000101",
      "fechaInicioAtencion": "2026-09-01 10:00",
      "numAutorizacion": null,
      "codConsulta": "890201",
      "modalidadGrupoServicioTecSal": "01",
      "grupoServicios": "01",
      "codServicio": 325,
      "finalidadTecnologiaSalud": "44",
      "causaMotivoAtencion": "38",
      "codDiagnosticoPrincipal": "Z000",
      "codDiagnosticoRelacionado1": null,
      "codDiagnosticoRelacionado2": null,
      "codDiagnosticoRelacionado3": null,
      "tipoDiagnosticoPrincipal": "01",
      "tipoDocumentoIdentificacion": "CC",
      "numDocumentoIdentificacion": "1000000001",
      "vrServicio": 100000,
      "conceptoRecaudo": "05",
      "valorPagoModerador": 0,
      "numFEVPagoModerador": null,
      "consecutivo": 1
    }
  }
}