cqf-ruler se basa en HAPI FHIR JPA Server Starter y agrega un conjunto de complementos que brindan una implementación del módulo de razonamiento clínico de FHIR, sirven como un repositorio de artefactos de conocimiento y un servicio de soporte de decisiones clínicas compatible con cds-hooks. cqf-ruler proporciona una API de extensibilidad para permitir agregar operaciones FHIR personalizadas sin la necesidad de bifurcar o clonar todo el proyecto.
Consulte la wiki para obtener más información.
La zona de pruebas pública no es persistente, no tiene autenticación y se restablece periódicamente. No almacene ningún dato confidencial, PHI ni nada que necesite para ser persistente en el sandbox:
GUI
Abrir documentos API
Interfaz de usuario arrogante
La forma más sencilla de comenzar con cqf-ruler es extraer y ejecutar la imagen de la ventana acoplable. Para evitar ejecutar el contenedor Docker con el permiso predeterminado del usuario root, el contenedor de esta imagen se ejecutará con un usuario llamado cqfruler
docker pull alphora/cqf-ruler
docker run -p 8080:8080 alphora/cqf-ruler
Esto hará que la regla cqf esté disponible en http://localhost:8080
Otras opciones de implementación se enumeran en la wiki para obtener más documentación.
cqf-ruler proporciona la interfaz de usuario del probador HAPI FHIR que permite CRUD de recursos FHIR en la URL base del servidor. Eso es http://localhost:8080 si está ejecutando el comando Docker anterior.
cqf-ruler proporciona la interfaz de usuario Swagger para la API REST y la interfaz de prueba en http://localhost:8080/fhir/swagger-ui/.
De manera similar, los documentos de Open API están disponibles en http://localhost:8080/fhir/api-docs.
La wiki proporciona tutoriales de varias de las características de cqf-ruler, como el procesamiento de medidas de calidad.
En general, es necesario cargar cqf-ruler con recursos FHIR antes de usarlo. Una forma de hacerlo es iniciar un servidor cqf-ruler y utilizar la API REST de FHIR para cargar recursos. Consulte Carga de recursos en la wiki para obtener una descripción de cómo hacerlo.
Este proyecto incluye el proyecto hapi-fhir-jpaserver-starter
como un submódulo e incluye las clases compiladas como un jar llamado cqf-ruler-external
. Asegúrese de utilizar el siguiente comando al clonar este repositorio para garantizar que los submódulos se inicialicen correctamente:
git clone --recurse-submodules https://github.com/DBCG/cqf-ruler.git
o si ya revisó el repositorio, use
git submodule update --init --recursive
Para limpiar cualquier archivo innecesario o no utilizado, utilice:
git clean -fdx
Vaya a http://www.oracle.com/technetwork/java/javase/downloads/, descargue el JDK más reciente (versión 11 o superior) para su plataforma e instálelo.
Este proyecto utiliza el contenedor Maven para garantizar que la versión correcta de Maven esté disponible en su máquina. Utilice ./mvnw
para invocarlo.
./mvnw package
Para ejecutar el directorio cqf-ruler desde este proyecto utilice:
java -jar server/target/cqf-ruler-server-*.war
Consulte Contribuir en la wiki para obtener más información sobre cómo desarrollar y contribuir al proyecto cqf-ruler.
cqf-ruler ofrece un marco de complemento básico para permitir la adición de operaciones FHIR personalizadas. Consulte Complementos en la wiki para obtener más información.
Un ejemplo completo de un complemento cargado dinámicamente está disponible en el directorio de ejemplos.
Ver Arquitectura en la wiki.
Hay documentación adicional en la wiki.
Los errores y las solicitudes de funciones se pueden presentar en Github Issues.
Los implementadores están activos en el chat oficial de FHIR Zulip para CQL.
Las consultas sobre soporte comercial pueden dirigirse a [email protected].
HAPI FHIR: proporciona la API FHIR y el servidor sobre el que se construye cqf-ruler.
Lenguaje de calidad clínica: herramientas que respaldan la especificación CQL, incluido el verificador/traductor de CQL utilizado en este proyecto.
Razonamiento clínico CQF: proporciona soporte de CQL y razonamiento clínico utilizado por la regla cqf.
Herramientas CQF: proporciona varias operaciones que cqf-ruler expone como servicios, como contenido generado por $refresh.
Compatibilidad con CQL para VS Code: complemento CQL IDE con resaltado de sintaxis, linting y evaluación CQL local.
Desde entonces, varias operaciones que alguna vez fueron construidas y expuestas en cqf-ruler han migrado a Clinical-Reasoning y se han expuesto en versiones de Hapi-Fhir y Hapi-Fhir-JpaServer-Starter.
Esta tabla mantiene una vista actual de qué operaciones han migrado de este proyecto y cuáles permanecen.
Complemento | Tipo de recurso | Operación | Estado |
---|---|---|---|
CR | Medida | $evaluar-medir | migrado |
CR | Medida | $enviar-datos | migrado |
CR | Medida | $brechas en la atención | migrado |
CR | Medida | $requisitos-de-datos | migrado |
CR | Medida | $recopilar-datos | migrado |
CR | Definición del plan | $aplicar | migrado |
CR | Definición del plan | $paquete | migrado |
CR | Definición de actividad | $aplicar | migrado |
GPC | N / A | $cql | migrado |
GPC | Biblioteca | $evaluar | migrado |
COSUDE | Cuestionario | $paquete | migrado |
COSUDE | Cuestionario | $poblar | migrado |
COSUDE | CuestionarioRespuesta | $extraer | migrado |
COSUDE | Observación | $transformar | cayó 1 |
REAL ACADEMIA DE BELLAS ARTES | Medida | $davinci-ra.evaluar-medir | cayó 2 |
Informes de casos | Informe de medida | $extraer-lista-de-líneas-datos | Hacer |
Informes de casos | N / A | $paquete-de-mensajes-de-proceso | Hacer |
ERSD | N / A | Transformación $ersd-v2-a-v1 | Hacer |
ganchos-cds | N / A | descubrimiento y servicio | En curso |
1 Esta fue una operación provisional en el SDC Ig que ha sido eliminado
2 El IG de la AR ha evolucionado significativamente y es necesario volver a implementar esta operación.
Copyright 2019+ Dynamic Content Group, LLC (dba Alphora)
Licenciado bajo la Licencia Apache, Versión 2.0 (la "Licencia"); no puede utilizar este archivo excepto de conformidad con la Licencia. Puede obtener una copia de la Licencia en
http://www.apache.org/licenses/LICENSE-2.0
A menos que lo exija la ley aplicable o se acuerde por escrito, el software distribuido bajo la Licencia se distribuye "TAL CUAL", SIN GARANTÍAS NI CONDICIONES DE NINGÚN TIPO, ya sean expresas o implícitas. Consulte la Licencia para conocer el idioma específico que rige los permisos y limitaciones de la Licencia.