Merge pull request #278 from ansforge/add_page_integration

add integration fhir part
ansforge · Jan 6, 2025 · b153dab · b153dab
2 parents 772ffb6 + cf90848
commit b153dab
Show file tree

Hide file tree

Showing 8 changed files with 52 additions and 31 deletions.
diff --git a/docs/_data/menu.yml b/docs/_data/menu.yml
@@ -34,7 +34,7 @@ header:
                 url: /pages/guide/version-1/getting-started/api-basics.html
                 title: Bases de l'API 
           - page: Intégration FHIR
-            url: /pages/guide/version-1/integration-fhir/introduction.html
+            url: /pages/guide/version-1/integration-fhir/integration-java.html
             title: Intégration FHIR
             subfolderitems:
               - page: Utilisation de Java
@@ -108,22 +108,35 @@ header:
       #         - page: Bases de l'API
       #           url: /pages/guide/version-2/getting-started/api-basics.html
       #           title: Bases de l'API 
+          # - page: Intégration FHIR
+          #   url: /pages/guide/version-2/integration-fhir/integration-java.html
+          #   title: Intégration FHIR
+          #   subfolderitems:
+          #     - page: Utilisation de Java
+          #       url: /pages/guide/version-2/integration-fhir/integration-java.html
+          #       title: Utilisation de Java
+          #     - page: Utilisation de C#
+          #       url: /pages/guide/version-2/integration-fhir/integration-dotnet.html
+          #       title: Utilisation de C#
+          #     - page: Utilisation de PHP
+          #       url: /pages/guide/version-2/integration-fhir/integration-php.html
+          #       title: Utilisation de PHP
   - title: Cas d'utilisation
     subfolderitems:
       - page: Synchronisation complète
-        url: /pages/use-cases/full/uc-full.html
+        url: /pages/guide/version-2/use-cases/full/uc-full.html
         title: Synchronisation complète
       - page: Appels unitaires autour du professionnel (PP)
-        url: /pages/use-cases/practitioner-detail/uc-practitioner.html
+        url: /pages/guide/version-2/use-cases/practitioner-detail/uc-practitioner.html
         title: Appels unitaires autour du professionnel (PP)
       - page: Appels unitaires autour de la structure (PM)
-        url: /pages/use-cases/organization-detail/uc-organization.html
+        url: /pages/guide/version-2/use-cases/organization-detail/uc-organization.html
         title: Appels unitaires autour de la structure (PM)
       - page: Couloirs du Ségur du Numérique en Santé
-        url: /pages/use-cases/segur/uc-segur.html
+        url: /pages/guide/version-2/use-cases/segur/uc-segur.html
         title: Couloirs du Ségur du Numérique en Santé
       - page: BAL MSSanté
-        url: /pages/use-cases/bal-mss/uc-bal-mss.html
+        url: /pages/guide/version-2/use-cases/bal-mss/uc-bal-mss.html
         title: BAL MSSanté
   - title: Changelog
     url: /pages/changelog/changelog.html
@@ -132,7 +145,7 @@ header:
       - page: Démonstrateur API
         url: https://portail.openfhir.annuaire.sante.fr
       - page: Guide d'implémentation FHIR
-        url: https://interop.esante.gouv.fr/ig/fhir/annuaire/0.1.0
+        url: https://interop.esante.gouv.fr/ig/fhir/annuaire/
       - page: Code source de l'API
         url: https://github.com/ansforge/annuaire-sante-fhir-serveur
       - page: Météo des services de l'Annuaire Santé

diff --git a/docs/pages/guide/version-2/getting-started/api-basics.md b/docs/pages/guide/version-2/getting-started/api-basics.md
@@ -29,8 +29,6 @@ NOTE| Il n'existe pas d'environement bac à sable de l'API avec des données fic
 | [api-url]/Organization      | Récupérer les structures (entités juridiques, entités géographiques) |
 | [api-url]/HealthcareService | Récupérer les activités de soins et les équipements sociaux |
 | [api-url]/Device            | Récupérer les équipements matériels lourds (EML) |
-<!-- | [api-url]/health            | Pour le healthcare du service API FHIR, accessible sans authentification | -->
-
 ### Codes d’état HTTP (HTTP status codes)
 
 Toutes les réponses utilisent les codes HTTP Standard.

diff --git a/docs/pages/guide/version-2/getting-started/get-api-key.md b/docs/pages/guide/version-2/getting-started/get-api-key.md
@@ -62,7 +62,7 @@ NOTE| Actuellement, il n'existe aucune limitation en termes d'applications enreg
 #### Ressources internes 
 
 <div class="wysiwyg" markdown="1">
-* Démarrage par langage: [JAVA]({{ '/pages/guide/version-1/integration-fhir/integration-java.html' | relative_url }}),  [PHP]({{ '/pages/guide/version-1/integration-fhir/integration-php' | relative_url }}), [C#]({{ '/pages/guide/version-1/integration-fhir/integration-dotnet.html' | relative_url }})
+* Démarrage par langage: [JAVA]({{ '/pages/guide/version-2/integration-fhir/integration-java.html' | relative_url }}), [C#]({{ '/pages/guide/version-2/integration-fhir/integration-dotnet.html' | relative_url }})
 * [Accéder aux ressources]({{ '/pages/hub' | relative_url }})
 * [Cas d'utilisation de synchronisation]({{ '/pages/use-cases/full/uc-full' | relative_url }})
 * [Cas d'utilisation d'appels unitaires]({{ '/pages/use-cases/practitioner-detail/uc-practitioner' | relative_url }})

diff --git a/docs/pages/guide/version-2/getting-started/introduction.md b/docs/pages/guide/version-2/getting-started/introduction.md
@@ -6,30 +6,30 @@ subTitle: Démarrage rapide
 
 ### Introduction
 
-Ce site dédié à l'API FHIR Annuaire Santé est une documentation essentielle pour tous les acteurs (industriels, établissements de santé) souhaitant intégrer des fonctionnalités dans leur système d'informations telles que la recherche de professionnels et de structures de santé. Cette documentation a pour objectif de faciliter la prise en main de cette API RESTFUL.
+Ce site dédié à l'API FHIR Annuaire Santé est une documentation essentielle pour tous les acteurs (industriels, établissements de santé, etc.) souhaitant intégrer des fonctionnalités dans leur système d'informations.
 
 ### Modèle de données FHIR
 
 FHIR est un standard d'interopérabilité conçu pour l’échange de données de santé entre les différents acteurs de l’écosystème de Santé, développé par HL7 (Health Level 7).
-En pleine croissance, il est de plus en plus utilisé en France et son usage est poussé par l’union européenne.
-L’API FHIR Annuaire Santé est une API qui a pour objectif de respecter le standard d’interopérabilité FHIR afin d’exposer toutes les données en libre accès de l’Annuaire Santé
+En pleine croissance, il est de plus en plus utilisé en France et son usage est poussé par l’Union Européenne.
+L’API FHIR Annuaire Santé est une API RESTFul qui a pour objectif de respecter le standard d’interopérabilité FHIR afin d’exposer toutes les données en libre accès de l’Annuaire Santé.
 
 ### Ressources FHIR
-Une ressource est un ensemble de données qui représente un concept spécifique dans le domaine de la santé. Chaque ressource est un objet structuré qui encapsule des informations définies pour un domaine précis (par exemple, un professionnel de santé, un médecin, un diagnostic, une ordonnance).
+Une ressource est un ensemble de données qui représente un concept spécifique dans le domaine de la santé. Chaque ressource est un objet structuré qui encapsule des informations définies pour un domaine précis (Exemple: un professionnel de santé, un médecin, un diagnostic, une ordonnance).
 
 L’API FHIR contient près de 161 ressources, mais nous utilisons 5 ressources dans l’API FHIR Annuaire Santé.
 
 
 ### Ressources FHIR
 Les 5 ressources disponibles sur l'API FHIR Annuaire Santé sont les suivantes:
 
-| Ressources | Description |
-| --- | --- |
-| Practitioner | Contient les informations liées à l'exercice professionnel d'un Professionnel intervenant dans le système de Santé. Cela comprend le nom et prénom d'exercice, la catégorie professionnelle, la profession, les diplômes, le savoir-faire, etc. etc. |
-| PractitionerRole |  Contient les informations liées à la situation d’exercice / activité d'un professionnel avec le genre d'activité, la fonction, le mode d'exercice, la section Tableau Pharmacien, le Practitioner rattachée, l'Organization rattachée, etc. |
-| Organization | Décrit les organisations du domaine sanitaire, social et médico-social |
+| Ressources        | Description  |
+| ---               | ---          |
+| Practitioner      | Contient les informations liées à l'exercice professionnel d'un Professionnel intervenant dans le système de Santé. Cela comprend le nom et prénom d'exercice, la catégorie professionnelle, la profession, les diplômes, le savoir-faire, etc. etc. |
+| PractitionerRole  |  Contient les informations liées à la situation d’exercice / activité d'un professionnel avec le genre d'activité, la fonction, le mode d'exercice, la section Tableau Pharmacien, le Practitioner rattachée, l'Organization rattachée, etc. |
+| Organization      | Décrit les organisations du domaine sanitaire, social et médico-social |
 | HealthcareService | Décrit les équipements sociaux et activités de soins rattachées aux établissements FINESS |
-| Device | Décrit les Equipements Matériels Lourds (EML) mis en oeuvre au sein d’établissements. |
+| Device            | Décrit les Equipements Matériels Lourds (EML) mis en oeuvre au sein d’établissements. |
 
 &nbsp;
 

diff --git a/docs/pages/guide/version-2/getting-started/test-api.md b/docs/pages/guide/version-2/getting-started/test-api.md
@@ -49,10 +49,10 @@ Veuillez trouver ci-dessous les variables utilisées dans le projet Postman:
 |api_key|Clé d'API (Si vous n'avez pas de clé, veuillez suivre la procédure décrite [ici](/annuaire-sante-fhir-documentation/pages/guide/version-2/getting-started/test-api.html))|Saisissez votre clé|
 |api_url|L’url d’accès à l’API	|https://gateway.api.esante.gouv.fr/fhir/v2/1.x|
 
-## <a id="two-header"></a>2) Démarrer les tests API avec cURL
-
 &nbsp;
 
+## <a id="two-header"></a>2) Démarrer les tests API avec cURL
+
 NOTE| Pour la suite de l'exercice, vous devez remplacer {{site.ans.api_key }} par votre clé d'API.
 
 Pour ces premiers tests, nous utilisons [cURL](https://curl.se/) pour plus de simplicité.
@@ -63,7 +63,6 @@ Pour ces premiers tests, nous utilisons [cURL](https://curl.se/) pour plus de si
 <div class="wysiwyg" markdown="1">
 * **Test 1** : lancez la commande suivante pour récupérer le CapabilityStatement (liste des fonctionnalités de l'API) :
 </div>
-&nbsp;
 
 <div class="code-sample"><div class="tab-content" data-name="Invite de commandes">
 {% highlight bash %}
@@ -100,7 +99,6 @@ curl -H "ESANTE-API-KEY: {{site.ans.api_key }}" "{{site.ans.api_url}}/metadata"
                 ...
 
 ```
-&nbsp;
 
 NOTE| Le capability statement permet de connaitre les fonctionnalités disponibles sur le serveur FHIR (paramètres, ressources...).
 

diff --git a/docs/pages/guide/version-2/integration-fhir/integration-dotnet.md b/docs/pages/guide/version-2/integration-fhir/integration-dotnet.md
@@ -1,9 +1,13 @@
 ---
-layout: menu-version-1
+layout: menu-version-2
 title: Utilisation de C#
 subTitle: Intégration FHIR
 ---
 
+<p style="background-color: #ffcccc; border:1px solid grey; padding: 5px; max-width: 790px;">
+Cette page est en cours de construction.
+</p>
+
 Ce guide décrit comment intégrer l'API à un projet .Net Core.
 
 Si vous n'avez pas de clé d'API, veuillez suivre la procédure décrite [ici]({{ '/pages/guide/version-1/integration-fhir/integration-dotnet.html'}}).

diff --git a/docs/pages/guide/version-2/integration-fhir/integration-java.md b/docs/pages/guide/version-2/integration-fhir/integration-java.md
@@ -1,9 +1,13 @@
 ---
-layout: menu-version-1
+layout: menu-version-2
 title: Utilisation de Java
 subTitle: Intégration FHIR
 ---
 
+<p style="background-color: #ffcccc; border:1px solid grey; padding: 5px; max-width: 790px;">
+Cette page est en cours de construction.
+</p>
+
 Ce guide décrit comment intégrer l'API à un projet Java.
 
 Si vous n'avez pas de clé d'API, veuillez suivre la procédure décrite [ici]({{ '/pages/guide/version-1/integration-fhir/integration-java.html'}}).

diff --git a/...ion-2/integration-fhir/integration-php.md → ...-2/integration-fhir/integration-python.md b/...ion-2/integration-fhir/integration-php.md → ...-2/integration-fhir/integration-python.md
@@ -1,18 +1,22 @@
 ---
-layout: menu-version-1
-title: Utilisation de PHP
+layout: menu-version-2
+title: Utilisation de Python
 subTitle: Intégration FHIR
 ---
 
-Ce guide décrit comment intégrer l'API à un projet PHP.
+<p style="background-color: #ffcccc; border:1px solid grey; padding: 5px; max-width: 790px;">
+Cette page est en cours de construction.
+</p>
 
-Si vous n'avez pas de clé d'API, veuillez suivre la procédure décrite [ici]({{ '/pages/guide/version-1/integration-fhir/integration-php.html'}}).
+Ce guide décrit comment intégrer l'API à un projet Python.
+
+Si vous n'avez pas de clé d'API, veuillez suivre la procédure décrite [ici]({{ '/pages/guide/version-2/getting-started/get-api-key.html'}}).
 
 NOTE| Dans nos différents exemples, nous utilisons composer et la librairie dcarbone/php-fhir pour FHIR et Guzzle pour le REST. FHIR reste une API HTTP JSON/XML  qui pourra être appelée avec d'autres techniques.
 
 ### Dépendances composer
 
-dcarbone/php-fhir permet de parser et typer les objets FHIR. Cela pourra être utilisé par exemple pour la complétion. 
+TODO