Guía de Implementación Core de Costa Rica
0.1.0 - ci-build Costa Rica bandera

Guía de Implementación Core de Costa Rica - Versión en desarrollo (v0.1.0): no se debe usar en producción. Es un borrador en discusión en las mesas de trabajo de la Iniciativa HL7® Costa Rica y cambia sin aviso. Vea el ciclo de vida de las guías.

Ciclo de vida de las guías

Estado de las normas de la página: Informative

Todas las guías de la Iniciativa HL7® Costa Rica están en desarrollo. Son borradores en discusión en las mesas de trabajo, cambian sin aviso y no se deben usar en producción. Sirven para revisarlas, comentarlas y hacer pruebas.

Esta página describe el ciclo completo por el que pasa cada guía de implementación de la Iniciativa HL7® Costa Rica (la core, la de terminología, la de informes de imágenes médicas y la de homologación regional), desde que se identifica un caso de uso hasta que la guía madura, se mantiene y se retira. Dice qué se hace en cada etapa, qué evidencia la cierra, cómo cambian el estado y la versión de la guía, y para qué se puede usar en cada momento.

Las etapas se inspiran en el ciclo de vida de los artefactos de conocimiento de HL7 (CRMI, Artifact Lifecycle), adaptado a cómo trabaja la Iniciativa. Los niveles de madurez son los del modelo de madurez de FHIR (FMM), sin cambios: el país puede adaptarlos más adelante si lo considera necesario.

Las etapas

Diseño (en desarrollo: no usar en producción)1. Análisiscaso de uso, actores y datos2. Modelo lógicodatos, justificación, reglas y decisiones3. Diseño FHIRperfiles, terminología, invariantes y ejemplos4. Validación técnicaSUSHI, IG Publisher sin errores, pruebas5. Publicación continuahl7.or.cr/fhir/<guía>, versión en desarrollo6. Discusiónmesas de trabajo y comentarios¿Hay cambios por resolver?síPublicaciónCada comentario recibe una resolución.Si alguno exige cambios de fondo,se vuelve al diseño (pasos 2 a 6)y se abre otra consulta.7. Consulta formalversión x.y.z-ballot congelada, plazo de comentarios8. Versión publicadax.y.z inmutable, uso de prueba (trial use)Maduración9. Implementaciónpilotos y pruebas entre sistemas10. MadurezFMM sube con la evidencia de uso11. Mantenimientoversiones nuevas; las anteriores se retiranno

El ciclo tiene tres fases. En el diseño, la guía itera entre el modelo, los perfiles y la discusión tantas veces como haga falta, y se publica de forma continua para que todos la vean. En la publicación, una versión se congela, se somete a consulta formal y se publica. En la maduración, la guía se implementa, gana evidencia de uso y se mantiene con versiones nuevas.

# Etapa Qué se hace Qué la cierra Dónde queda
1 Análisis Una mesa de trabajo describe el caso de uso: quién intercambia qué datos, con quién y para qué El caso de uso acordado por las instituciones de la mesa Documento de análisis del caso de uso
2 Modelo lógico Se definen los datos, independientes de FHIR: su tipo, su cardinalidad, sus reglas y la justificación de por qué hay que interoperarlos. Cada duda se registra como pregunta, con su decisión y su fecha Todas las preguntas del modelo resueltas o pospuestas de forma explícita Modelos lógicos y su historial de cambios
3 Diseño FHIR Los modelos se traducen a perfiles, extensiones, terminología, invariantes, servicios (CapabilityStatement) y ejemplos, en FHIR Shorthand Cada regla del modelo tiene su perfil, su invariante o su terminología, y cada caso, su ejemplo Fuentes de la guía (FSH)
4 Validación técnica Se compila con SUSHI y el IG Publisher de HL7, se validan los ejemplos contra los perfiles y se ejecutan las pruebas propias (por ejemplo, los mapas de PH4H) Compilación sin errores, y cada advertencia corregida o justificada Reporte de calidad de la compilación
5 Publicación continua La guía se publica en https://hl7.or.cr/fhir/<guía>/, marcada como versión en desarrollo Cada cambio queda en el registro de cambios El sitio y el registro de cambios
6 Discusión Las instituciones, los proveedores de sistemas y la comunidad revisan la guía publicada y la comentan; las mesas resuelven cada comentario Los comentarios resueltos y sus decisiones registradas. Si cambian el modelo o los perfiles, se vuelve a la etapa 2 Las decisiones del modelo lógico y el registro de cambios
7 Consulta formal Se congela una versión con la etiqueta -ballot (por ejemplo, 0.2.0-ballot) y se abre un plazo de comentarios. Cada comentario recibe una resolución publicada Ningún comentario sin resolver. Si alguno exige cambios de fondo, se vuelve al diseño y se abre otra consulta La versión de consulta, que se conserva en su propia dirección
8 Versión publicada Se publica la versión sin etiqueta (por ejemplo, 0.2.0), que ya no cambia, con su historial de versiones La versión publicada y anunciada https://hl7.or.cr/fhir/<guía>/<versión>/
9 Implementación Los sistemas la implementan en pilotos y pruebas de intercambio entre sistemas distintos; lo que se aprende vuelve como comentarios Evidencia de sistemas que intercambian con la guía Reportes de las pruebas
10 Madurez Con la evidencia de uso, la guía sube de nivel de madurez (FMM) y pasa de uso de prueba a estable El nivel de madurez alcanzado y su evidencia Los metadatos de la guía
11 Mantenimiento y retiro Los cambios se hacen en versiones nuevas. Una versión que se reemplaza se marca como obsoleta, y después como retirada La versión nueva publicada El historial de versiones

Estado, madurez y uso permitido

Cada etapa tiene un estado de la guía (ImplementationGuide.status), un estado como estándar (extensión standards-status) y una forma de versión. El uso permitido depende del estado como estándar. El nivel de madurez (extensión fmm) no depende de la etapa sino de la evidencia que se haya reunido, según los criterios de la sección siguiente.

Etapa Versión status standards-status FMM ¿Para qué se puede usar?
1 a 6. Diseño y publicación continua 0.x.y, en desarrollo draft draft 0, o 1 si cumple sus criterios No usar en producción. Revisar, comentar y hacer pruebas
7. Consulta formal x.y.z-ballot draft draft El que alcance la evidencia; la consulta formal es uno de los requisitos del nivel 3 No usar en producción. Revisar, comentar y hacer prototipos
8 a 10. Versión publicada, implementación y madurez x.y.z active trial-use (uso de prueba) El que alcance la evidencia, hasta 5 Implementar aceptando que la versión siguiente puede cambiar
10. Versión normativa x.y.z active normative 6 (normativo) Producción: los cambios siguen las reglas de compatibilidad entre versiones
11. Versión reemplazada x.y.z active, y luego retired deprecated Sin cambio No usarla en implementaciones nuevas; migrar a la versión vigente

Reglas que no cambian:

  • Una versión publicada (etapas 7 y 8) no se modifica: cualquier corrección sale en una versión nueva.
  • Una guía active no vuelve a draft, y una retired no vuelve a active.
  • Un artefacto con nivel 0 tiene el estado como estándar draft, como exige el modelo de madurez de FHIR.
  • El estado de cada artefacto (perfil, extensión, terminología) nunca es más avanzado que el de su guía.

Niveles de madurez

Son los del modelo de madurez de FHIR (FHIR Maturity Model, FMM), tal como los define la especificación de FHIR R5 (Versions, Maturity Levels), traducidos al español. Cada nivel incluye los requisitos del anterior.

FMM Criterio de HL7
0 (borrador) El artefacto se publicó en la compilación actual. Los artefactos de este nivel deben tener el estado como estándar draft
1 FMM 0, y el artefacto no produce advertencias durante la compilación, y el grupo de trabajo responsable indicó que lo considera sustancialmente completo y listo para implementar
2 FMM 1, y el artefacto se probó y soporta con éxito la interoperabilidad entre al menos tres sistemas desarrollados de forma independiente, aprovechando la mayor parte de su alcance (por ejemplo, al menos el 80 % de los datos principales), con datos y escenarios semirrealistas basados en al menos uno de los alcances declarados
3 FMM 2, y el grupo de trabajo verificó que el artefacto cumple las guías de calidad de los recursos de conformidad (Conformance Resource Quality Guidelines); pasó por una ronda de votación formal; y tiene al menos 10 comentarios distintos de implementadores, registrados en el sistema de seguimiento, de al menos 3 organizaciones, que produjeron al menos un cambio de fondo
4 FMM 3, y el artefacto se probó en todo su alcance, se publicó en una publicación formal (por ejemplo, de uso de prueba, STU) y se implementó en varios proyectos prototipo
5 FMM 4, y el artefacto se publicó en dos ciclos de publicación formal como STU y se implementó en al menos 5 sistemas de producción independientes en más de un país
6 (normativo) FMM 5, y el grupo de trabajo responsable y el grupo de gestión de FHIR (FHIR Management Group) acuerdan que el material está listo para fijarse según las reglas de cambio entre versiones

Mientras el país no defina sus equivalentes, las guías de la Iniciativa aplican estos criterios así:

  • El grupo de trabajo responsable es la mesa de trabajo de la guía.
  • La votación formal es la consulta formal de la etapa 7.
  • El sistema de seguimiento de comentarios, la verificación de las guías de calidad y el papel del grupo de gestión de FHIR están pendientes de definir. Hasta entonces, ninguna guía puede pasar del nivel 2.

Versiones

Las guías usan versiones semánticas, mayor.menor.parche:

  • Mayor: cambios que rompen la compatibilidad, como un elemento que pasa a ser obligatorio o un código que deja de ser válido.
  • Menor: agregados compatibles, como un perfil, un elemento opcional o un código nuevo.
  • Parche: correcciones que no cambian el significado, como una errata o una descripción.

Mientras la versión mayor sea 0 (todas las guías hoy), cualquier versión menor puede romper la compatibilidad: es la señal de que la guía está en desarrollo. La etiqueta -ballot marca una versión de consulta formal.

La URL canónica de cada guía y de cada artefacto (por ejemplo, https://hl7.or.cr/fhir/core/StructureDefinition/cr-patient) no cambia entre versiones. Para fijar una versión concreta se agrega después de una barra vertical: https://hl7.or.cr/fhir/core/StructureDefinition/cr-patient|0.2.0. Un sistema en producción debe referirse siempre a una versión publicada, nunca a la versión en desarrollo.

Dónde está cada guía

Guía Versión Etapa FMM Uso permitido
Core 0.1.0, en desarrollo Diseño FHIR, publicación continua y discusión (etapas 3 a 6) 0 No usar en producción
Terminología 0.1.0, en desarrollo Diseño FHIR, publicación continua y discusión (etapas 3 a 6). Se conserva una versión de consulta anterior, 0.0.1-ballot, como histórica, en su historial de versiones 0 No usar en producción
Informes de imágenes médicas 0.1.0, en preparación Análisis (etapa 1): todavía no tiene perfiles 0 No usar en producción
Homologación regional (PH4H) 0.1.0, en desarrollo Diseño FHIR, validación técnica y discusión (etapas 3 a 6) 0 No usar en producción

Ninguna guía ha pasado todavía por una consulta formal de su versión actual.

Cómo participar

Las guías se publican en desarrollo justamente para que se comenten. Para participar en una mesa de trabajo, proponer un cambio o reportar un error, escriba a info@hl7.or.cr o use el repositorio de la Iniciativa en GitHub. Cada comentario se resuelve en la mesa que corresponda, y la decisión queda en el modelo lógico o en el registro de cambios.