AP-HP - FormBuilder

// TODO

Pour plus d'information :

• Si vous êtes nouveau dans la communauté et l'écosystème FHIR, ce tutoriel explique FHIR, le profilage, et les guides d'implementation

Construction de l'IG

"Construction de l'IG" signifie générer une représentation web, lisible par un humain, des informations structurées et de la documentation d'accompagnement définies dans ce référentiel. Cela se fait via le FHIR Implementation Guide Publisher ("IG Publisher"), un programme Java fourni par l'équipe FHIR pour la construction de guides d'implementation dans une présentation standardisée.

Si vous souhaitez le générer localement, ouvrez une fenêtre de commande et naviguer où le référentiel a été cloné. Exécutez ensuite cette commande :

• Linux/macOS: ./gradlew buildIG
• Windows: .\gradlew.bat buildIG

Ce script fera automatiquement deux choses pour vous :

1. Exécuter SUSHI. L'IG AP-HP - SDC est développé en FHIR Shorthand (FSH), un langage spécifique de domaine (DSL) permettant de définir le contenu des FHIR IG. SUSHI transpile les fichiers FSH en fichiers JSON attendus par IG Publisher
2. Exécuter IG Publisher

Vous aurez besoin d'une connexion Internet active pour construire l'IG. Cela prend jusqu'à 30 minutes pour construire pour la première fois ; les versions suivantes devraient être plus rapides (5 à 7 minutes) sur un ordinateur portable moderne.

Lorsque la construction est terminée, vous pouvez ouvrir output/index.html dans votre navigateur pour voir l'IG construit localement.

Dépendances pour la construction de l'IG

1. Vous avez besoin d'installer java
2. Vous avez besoin d'installer jekyll

Exécution de SUSHI indépendamment de l'IG Publisher

Si vous souhaitez exécuter SUSHI sans créer l'intégralité de l'IG, vous pouvez exécuter la tâche gradle runSushi.

Obtenir une version propre

Bien que cela ne soit normalement pas nécessaire, vous pouvez supprimer les dossiers suivants pour obtenir une version propre :

• fsh-generated/ (sortie SUSHI - contient notamment les fichiers json généré à partir des fichiers en FSH)
• output/ (sortie IG Publisher - contient notamment le site web construit par 'buildIG')
• input-cache/ (cache local de l'IG Publisher ; notez que sa suppression augmentera considérablement le temps de génération de la prochaine version)

Répertoires et fichiers clés dans l'IG

• Les fichiers FHIR Shorthand (.fsh) définissant les ressources dans cet IG se trouvent dans input/fsh/.

  • Il existe une extension de coloration syntaxique FSH pour VSCode.

• Les pages principales de l'IG construit sont générées à partir de Markdown trouvé dans input/pagecontent/. Ces pages doivent également être incluses dans sushi-config.yaml pour être compilées en HTML par l'IG Publisher.

• Il existe un certain nombre d'autres options de configuration importantes dans sushi-config.yaml, y compris le contenu du menu de l'IG construit.

• La source des diagrammes UML dans l'IG se trouve dans input/images-source/ et DOIT avoir une extension .plantuml. Ceux-ci sont automatiquement convertis en SVG par l'éditeur IG et insérés en ligne dans les fichiers Markdown à l'aide de {%include some-diagram.svg%} (qui correspond à input/images-source/some-diagram.plantuml).

Mise en ligne du guide d'implémentation

Les utilisateurs du FormBuilder AP-HP doivent pouvoir accéder à la documentation contenue dans le présent guide d'implémentation. Le processus d'intégration continue exécute le build du FHIR IG sur le main et le met en ligne automatiquement ici

Acronymes

• IG : Implementation Guide
• FHIR : Fast Healthcare Interoperability Resources
• FIG : FHIR Implementation Guide
• HL7 : Health Level Seven
• AP-HP : Assistance Publique - Hôpitaux de Paris
• EDS : Entrepôt de Données de Santé

Dépendances du guide d'implémentation

Vous trouverez la liste des dépendances dans sushi-config.yaml dans la section dependencies du fichier.

Dépannage

Structure Definition is Missing Snapshot Error

Some non-HL7 FHIR packages are distributed without snapshot elements in their profiles. If your IG uses one of these profiles, SUSHI will report an error like the following: Certains packages FHIR non HL7 sont distribués sans snapshot dans leurs profils. Si votre IG utilise l'un de ces profils, SUSHI signalera une erreur comme la suivante :

Structure Definition http://interopsante.org/fhir/StructureDefinition/FrPatient is missing snapshot. Snapshot is required for import.

Since SUSHI does not implement its own snapshot generator, you must update the package in your FHIR cache so that its profiles include snapshot elements. Fortunately, the Firely Terminal provides a way to do this. Étant donné que SUSHI n'implémente pas son propre générateur de snapshot, vous devez mettre à jour le package dans votre cache FHIR afin que ses profils incluent les snapshots. Heureusement, le Firely Terminal fournit un moyen de le faire.

Tout d'abord, vous devez installer Firely Terminal. Utilisez ensuite Firely Terminal pour remplir les éléments du snapshot dans le package des dépendances.

1. Lancer la commande : fhir install (), remplacer par l'ID du package dépendant. Par exemple, fhir install hl7.fhir.fr.core 1.1.0
2. Lancer sushi une nouvelle fois. L'erreur à propos des snapshot manquant ne devrait plus être affiché.