Saltar al contenido principal
OutputSchema es una estructura recursiva que describe cada campo. instructions indica al modelo qué extraer. Los campos codificados declaran su catálogo y sus valores de origen.
Esta página describe el formato de autoría que envías al crear una plantilla. Cuando vuelves a leer una plantilla con GET /v1/medical-record-configurations/{id}, cada esquema object devuelve sus properties como un array ordenado de entradas { "key": ..., "schema": ... }, no en la forma de mapa que se muestra aquí. El contenido es idéntico; solo cambia la serialización.

Claves

La clave de una sección y la clave de una propiedad son identificadores estables, no etiquetas. Al crear, cada clave debe cumplir ^[A-Za-z0-9_]+$: letras ASCII, dígitos y guion bajo. Una clave con espacio, punto, dos puntos o letra acentuada se rechaza con parameter_invalid (400); el mensaje indica la ruta del nodo y la clave. Pon el texto visible en schema.label.

Tipos

Estas son las únicas palabras clave que la API guarda. Cualquier otra se descarta sin aviso; consulta No soportado. Valores de format admitidos para string: date-time, date, time, duration, email, uuid, ipv4, ipv6. Un string con format date, time o date-time se devuelve como un valor ISO 8601.

Campos codificados

Un campo code o codeList debe ser una propiedad de un objeto. Sus valores de origen deben ser propiedades hermanas no codificadas de ese objeto. system identifica el catálogo. source acepta un nombre de propiedad hermana o una lista; si se omite, usa todas las propiedades hermanas no codificadas. maxOptions es al menos 1 y su valor predeterminado es 1. La API conserva estas declaraciones al crear y consultar la plantilla. GET devuelve source como lista, o null si se omite. La generación de códigos requiere un resolvedor en la configuración de generación.

Required y default

  • required (booleano, por defecto false): un campo es opcional por defecto, es decir, el modelo puede devolver null para él. Usa required: true para obligar al modelo a generar siempre un valor.
  • default (solo campos hoja): se usa como sustituto cuando el modelo no extrae nada (devuelve null). Su tipo debe coincidir con el type del campo; para un campo enum debe ser uno de los valores del enum.
Interacción: default solo tiene efecto cuando required es false (el valor por defecto). Un campo con required: true siempre se genera, así que su default nunca se aplica. Deja required en su valor por defecto y combínalo con default para garantizar un valor de respaldo cuando la atención no menciona el campo.

No soportado

Las siguientes palabras clave de JSON Schema las acepta el parser de la solicitud, pero se descartan sin aviso: nunca se guardan ni afectan la generación. No dependas de ellas.

Opciones de enum

enum (en campos string, incluidos los items de un array de selección múltiple) acepta dos formas:
  • Cadenas simples: el texto mostrado es el valor almacenado: "enum": ["Bajo", "Medio", "Alto"].
  • Objetos { label, value }: separan lo que se muestra de lo que se almacena; se muestra label y se almacena value (un código estable, como un id de catálogo, un código CIE-10 o SNOMED). La generación devuelve el value; el label es solo para mostrar, así que puedes renombrar o traducir las etiquetas sin cambiar lo que recibe tu integración.
value debe ser único dentro de un campo. Las dos formas pueden mezclarse en una misma lista (una cadena simple se trata como label == value).

Límites

La raíz de la sección tiene profundidad 0. Cada propiedad anidada o elemento de array añade un nivel para los campos generados.

Ejemplo — sección de tipo objeto

Ejemplo — campo opcional con default

Ejemplo — array de elementos estructurados