La règle cqf est basée sur HAPI FHIR JPA Server Starter et ajoute un ensemble de plugins qui fournissent une implémentation du module de raisonnement clinique de FHIR, servent de référentiel d'artefacts de connaissances et de service d'aide à la décision clinique compatible avec les crochets cds. Le cqf-ruler fournit une API d'extensibilité pour permettre l'ajout d'opérations FHIR personnalisées sans avoir besoin de créer ou de cloner l'intégralité du projet.
Voir le wiki pour plus d'informations
Le bac à sable public n'est pas persistant, n'a aucune authentification et est régulièrement réinitialisé. Ne stockez aucune donnée sensible, PHI ou tout ce dont vous avez besoin pour être persistant sur le bac à sable :
Interface graphique
Documents sur l'API ouverte
Interface utilisateur Swagger
Le moyen le plus simple de démarrer avec la règle cqf est d'extraire et d'exécuter l'image Docker. Pour éviter d'exécuter le conteneur Docker avec l'autorisation de l'utilisateur root par défaut, le conteneur de cette image s'exécutera avec un utilisateur nommé cqfruler
docker pull alphora/cqf-ruler
docker run -p 8080:8080 alphora/cqf-ruler
Cela rendra le cqf-ruler disponible sur http://localhost:8080
D'autres options de déploiement sont répertoriées sur le wiki pour plus de documentation.
Le cqf-ruler fournit l'interface utilisateur du testeur HAPI FHIR qui autorise FHIR Resource CRUD au niveau de l'URL de base du serveur. Il s'agit de http://localhost:8080 si vous exécutez la commande Docker ci-dessus.
Le cqf-ruler fournit l'interface utilisateur Swagger pour l'API REST et l'interface de test sur http://localhost:8080/fhir/swagger-ui/.
De même, les documents Open API sont disponibles sur http://localhost:8080/fhir/api-docs.
Le wiki fournit des présentations pas à pas de plusieurs fonctionnalités de la règle cqf, telles que le traitement des mesures de qualité.
En général, vous devez charger la règle cqf avec les ressources FHIR avant de l'utiliser. Une façon de procéder consiste à démarrer un serveur cqf-ruler et à utiliser l'API FHIR REST pour charger les ressources. Voir Chargement des ressources sur le wiki pour une description de la façon de procéder.
Ce projet inclut le projet hapi-fhir-jpaserver-starter
en tant que sous-module et inclut les classes compilées sous forme de fichier jar appelé cqf-ruler-external
. Assurez-vous d'utiliser la commande suivante lors du clonage de ce référentiel pour vous assurer que les sous-modules sont correctement initialisés :
git clone --recurse-submodules https://github.com/DBCG/cqf-ruler.git
ou si vous avez déjà consulté le dépôt, utilisez
git submodule update --init --recursive
pour nettoyer tous les fichiers inutiles ou inutilisés, utilisez :
git clean -fdx
Accédez à http://www.oracle.com/technetwork/java/javase/downloads/, téléchargez le dernier JDK (version 11 ou supérieure) pour votre plate-forme et installez-le.
Ce projet utilise le wrapper Maven pour garantir que la version correcte de Maven est disponible sur votre machine. Utilisez ./mvnw
pour l'invoquer.
./mvnw package
Pour exécuter le répertoire cqf-ruler à partir de ce projet, utilisez :
java -jar server/target/cqf-ruler-server-*.war
Voir Contribuer sur le wiki pour plus d'informations sur le développement et la contribution au projet cqf-ruler.
Le cqf-ruler propose un framework de plugin de base pour permettre l'ajout d'opérations FHIR personnalisées. Voir Plugins sur le wiki pour plus d'informations.
Un exemple complet de plugin chargé dynamiquement est disponible dans le répertoire exemple.
Voir Architecture sur le wiki.
Une documentation supplémentaire est sur le wiki.
Les bogues et les demandes de fonctionnalités peuvent être déposés auprès des problèmes Github.
Les implémenteurs sont actifs sur le chat officiel FHIR Zulip pour CQL.
Les demandes d’assistance commerciale peuvent être adressées à [email protected].
HAPI FHIR : fournit l'API FHIR et le serveur sur lesquels la règle cqf est construite.
Langage de qualité clinique – Outils prenant en charge la spécification CQL, y compris le vérificateur/traducteur CQL utilisé dans ce projet.
Raisonnement clinique CQF - Fournit le support CQL et raisonnement clinique utilisé par la règle cqf.
Outils CQF : fournit plusieurs opérations que la règle cqf expose comme des services, tels que le contenu généré par $refresh.
Prise en charge CQL pour VS Code - Plugin CQL IDE avec coloration syntaxique, peluchage et évaluation CQL locale.
Plusieurs opérations qui étaient autrefois construites et exposées dans cqf-ruler ont depuis migré en amont vers Clinical-Reasoning et exposées dans les versions de Hapi-Fhir et Hapi-Fhir-JpaServer-Starter.
Ce tableau conserve une vue actuelle des opérations qui ont migré hors de ce projet et de celles qui restent.
Plugin | Type de ressource | Opération | Statut |
---|---|---|---|
CR | Mesure | $ évaluer-mesure | migré |
CR | Mesure | $submit-données | migré |
CR | Mesure | $écarts de soins | migré |
CR | Mesure | $exigences en matière de données | migré |
CR | Mesure | $collecter des données | migré |
CR | PlanDéfinition | $appliquer | migré |
CR | PlanDéfinition | $forfait | migré |
CR | ActivitéDéfinition | $appliquer | migré |
Produits de grande consommation | N / A | $cql | migré |
Produits de grande consommation | Bibliothèque | $évaluer | migré |
DDC | Questionnaire | $forfait | migré |
DDC | Questionnaire | $populaire | migré |
DDC | QuestionnaireRéponse | $extrait | migré |
DDC | Observation | $transformer | laissé tomber 1 |
RA | Mesure | $davinci-ra.evaluate-measure | laissé tomber 2 |
Rapports de cas | MesureRapport | $ extraire les données de la liste de lignes | Faire |
Rapports de cas | N / A | $process-message-bundle | Faire |
ERSD | N / A | Transformation $ersd-v2-en-v1 | Faire |
crochets pour CD | N / A | découverte et service | En cours |
1 Il s'agissait d'une opération provisoire dans la SDC Ig qui a été supprimée
2 Le RA IG a considérablement évolué et ce fonctionnement doit être réimplémenté.
Copyright 2019+ Dynamic Content Group, LLC (dba Alphora)
Sous licence Apache, version 2.0 (la « Licence » ); vous ne pouvez pas utiliser ce fichier sauf en conformité avec la licence. Vous pouvez obtenir une copie de la licence à
http://www.apache.org/licenses/LICENSE-2.0
Sauf disposition contraire de la loi applicable ou accord écrit, le logiciel distribué sous la licence est distribué « EN L'ÉTAT », SANS GARANTIE OU CONDITION D'AUCUNE SORTE, expresse ou implicite. Consultez la licence pour connaître la langue spécifique régissant les autorisations et les limitations en vertu de la licence.