From 3d61df9b3128e1090fb3b92d35bc2704261d24f9 Mon Sep 17 00:00:00 2001 From: William AZIS Date: Mon, 24 Jun 2024 15:23:49 +0200 Subject: [PATCH] update getting started --- docs/index.markdown | 4 +- docs/pages/changelog/changelog.md | 8 +-- .../changelog/releases}/1.29/RELEASE-NOTES.md | 0 docs/pages/documentation/authentication.md | 68 ------------------- .../version-1/getting-started/api-basics.md | 32 ++++----- .../version-1/getting-started/test-api.md | 3 +- .../version-1/resources/practitioner-role.md | 4 +- .../guide/version-1/resources/practitioner.md | 4 +- .../practitioner-detail/uc-practitioner.md | 4 +- 9 files changed, 30 insertions(+), 97 deletions(-) rename {releases => docs/pages/changelog/releases}/1.29/RELEASE-NOTES.md (100%) delete mode 100644 docs/pages/documentation/authentication.md diff --git a/docs/index.markdown b/docs/index.markdown index 02bdce28..0b0cb433 100644 --- a/docs/index.markdown +++ b/docs/index.markdown @@ -27,7 +27,7 @@ L’API Annuaire Santé permet au grand public d'interroger facilement et rapide ## A quoi sert l'API ? -En intégrant l'API Annuaire Santé dans votre système d'information, vous pouvez facilement de trouver un professionnel de santé ou une structure, filtrer, ordonner et paginer les résultats selon vos souhaits. +En intégrant l'API Annuaire Santé dans votre système d'information, vous pouvez facilement trouver un professionnel intervenant dans le système de santé ou une structure, filtrer, ordonner et paginer les résultats selon vos souhaits. ![](./assets/img/home-schema.png) @@ -38,7 +38,7 @@ En intégrant l'API Annuaire Santé dans votre système d'information, vous pouv #### Pour les structures de santé
-* Récupérer l'identifiant national des professionnels de santé qu'elles emploient, +* Récupérer l'identifiant national des professionnels intervenant dans le système de santé, * Vérifier l'identité (identifiant national, nom, prénom), les qualifications et la situation d’exercice d'un professionnel, * Faciliter la coordination ville-hôpital avec la mise en place d’un annuaire de correspondants.
diff --git a/docs/pages/changelog/changelog.md b/docs/pages/changelog/changelog.md index a12bb93c..059a0235 100644 --- a/docs/pages/changelog/changelog.md +++ b/docs/pages/changelog/changelog.md @@ -7,7 +7,7 @@ Le changelog documente les modifications associées à une version de l’API F **Versions disponibles de l'API FHIR Annuaire Santé** -| Version API FHIR | Version FHIR | Version IG | Date de lancement | Disponible jusqu'à | -| --- | --- | --- | --- | --- | -| 1 (Beta) | R4 | 0.1.0 - trial use | 5 septembre 2022 | TBD | -| 2 | R4 | 1.0.1 | TBD | TBD | +| Version API FHIR Annuaire Santé | Version FHIR | Version IG | Date de lancement | Disponible jusqu'à | +| --- | --- | --- | --- | --- | +| 1 (Beta) | R4 | 0.1.0 - trial use | 5 septembre 2022 | TBD | +| 2 | R4 | 1.0.X | TBD | TBD | diff --git a/releases/1.29/RELEASE-NOTES.md b/docs/pages/changelog/releases/1.29/RELEASE-NOTES.md similarity index 100% rename from releases/1.29/RELEASE-NOTES.md rename to docs/pages/changelog/releases/1.29/RELEASE-NOTES.md diff --git a/docs/pages/documentation/authentication.md b/docs/pages/documentation/authentication.md deleted file mode 100644 index 0ce69b43..00000000 --- a/docs/pages/documentation/authentication.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -layout: documentation -title: Authentification ---- - -L'authentification se fait via une API Key à positionner dans le header. - -Pour chaque requête, vous devez positionner ce header : - - - -Voir la section [Quickstart]({{ '/pages/quick-start/readme' | relative_url}}) pour obtenir l'API Key. - -
-
- -```bash -curl -H "ESANTE-API-KEY: {{site.ans.demo_key }}" ""{{site.ans.api_url}}/fhir/metadata?_pretty=true&_format=json" -``` - -
-
- -```java -// register the interceptor only one time: -var client = ctx.newRestfulGenericClient("{{site.ans.api_url}}/fhir"); -client.registerInterceptor(new IClientInterceptor() { - @Override - public void interceptRequest(IHttpRequest iHttpRequest) { - iHttpRequest.addHeader("ESANTE-API-KEY", "{{site.ans.demo_key }}"); - } - @Override - public void interceptResponse(IHttpResponse iHttpResponse) throws IOException {} -}); -// and then use the client: -var conf = client - .capabilities() - .ofType(CapabilityStatement.class) - .execute(); -``` -
-
- -```php -require_once '../vendor/autoload.php'; -use DCarbone\PHPFHIRGenerated\R4\PHPFHIRResponseParser; -use DCarbone\PHPFHIRGenerated\R4\PHPFHIRResponseParserConfig; - -$config = new PHPFHIRResponseParserConfig([ - 'registerAutoloader' => true, - 'sxeArgs' => LIBXML_COMPACT | LIBXML_NSCLEAN -]); -$parser = new PHPFHIRResponseParser($config); - -$header = ['ESANTE-API-KEY' => '{{site.ans.demo_key }}']; -$client = new GuzzleHttp\Client([ - 'base_uri' => 'http://host.docker.internal:8080', - 'timeout' => 2.0,]); - -// Make requests: - -$response = $client->request('GET', '/fhir/v1/metadata'); -/** @var $object \DCarbone\PHPFHIRGenerated\R4\FHIRResource\FHIRDomainResource\FHIRCapabilityStatement*/ -$object = $parser->parse((string) $response->getBody()); -``` - -
-
diff --git a/docs/pages/guide/version-1/getting-started/api-basics.md b/docs/pages/guide/version-1/getting-started/api-basics.md index 90f836a9..85475fb4 100644 --- a/docs/pages/guide/version-1/getting-started/api-basics.md +++ b/docs/pages/guide/version-1/getting-started/api-basics.md @@ -11,33 +11,33 @@ Tous les accès se font via HTTPS. #### Environnement Production -| VARIABLES | VALEUR | +| Variables | Valeurs | | --- | --- | -| [api-url] | https://gateway.api.esante.gouv.fr/fhir/v1 | -| [ihm-url] | https://portail.openfhir.annuaire.sante.fr | -| [gravitee-url] | https://portal.api.esante.gouv.fr (pour obtenir une API KEY) | +| api-url | https://gateway.api.esante.gouv.fr/fhir/v1 | +| ihm-url | https://portail.openfhir.annuaire.sante.fr | +| gravitee-url | https://portal.api.esante.gouv.fr (pour obtenir une API KEY) | #### Environnement Bac à sable (en accès restreint) -| VARIABLES | VALEUR | +| Variables | Valeurs | | --- | --- | -| [api-url] | https://gateway.preprod.api.esante.gouv.fr/fhir/v1 | -| [ihm-url] | https://demo.portail.openfhir.annuaire.asipsante.fr | -| [gravitee-url] | https://portal.preprod.api.esante.gouv.fr | +| api-url | https://gateway.preprod.api.esante.gouv.fr/fhir/v1 | +| ihm-url | https://demo.portail.openfhir.annuaire.asipsante.fr | +| gravitee-url | https://portal.preprod.api.esante.gouv.fr | ### Points de terminaison (endpoints) -| VARIABLES | Description | +| Variables | Valeurs | | --- | --- | -| [api-url]/Practitioner | Pour les professionnels de santé | -| [api-url]/PractitionerRole | Pour les exercices pro et les situations d'exercice | -| [api-url]/Organization | Pour les structures | -| [api-url]/HealthcareService | Pour les activités de soins et les équipements sociaux | -| [api-url]/Device | Pour les équipements matériels lourds | -| [api-url]/metadata | Pour le capability statement -| [api-url]/health | Pour le heathcare du service, accessible sans authentification | +| {{api-url}}/metadata | Pour le capability statement | +| {{api-url}}/Practitioner | Pour les professionnels de santé | +| {{api-url}}/PractitionerRole | Pour les exercices professionnels et les situations d'exercice | +| {{api-url}}/Organization | Pour les structures | +| {{api-url}}/HealthcareService | Pour les activités de soins et les équipements sociaux | +| {{api-url}}/Device | Pour les équipements matériels lourds (EML) | +| {{api-url}}/health | Pour le heathcare du service, accessible sans authentification | ### Codes d’état HTTP (HTTP status codes) diff --git a/docs/pages/guide/version-1/getting-started/test-api.md b/docs/pages/guide/version-1/getting-started/test-api.md index 982a23b6..68393a89 100644 --- a/docs/pages/guide/version-1/getting-started/test-api.md +++ b/docs/pages/guide/version-1/getting-started/test-api.md @@ -39,6 +39,8 @@ Veuillez trouver ci-dessous les variables utilisées dans le projet Postman:

## 2) Démarrer les tests API avec cURL +NOTE| Pour la suite de l'exercice, vous devez remplacer {{site.ans.demo_key }} par votre clé d'API. + Pour ces premiers tests, nous utilisons cURL pour plus de simplicité. [cURL](https://curl.se/) étant un outil présent sur la plupart des plateformes windows 10+, macos, linux.
@@ -46,7 +48,6 @@ Pour ces premiers tests, nous utilisons cURL pour plus de simplicité. [cURL](ht
  -NOTE| Pour la suite de l'exercice, vous devez remplacer {{site.ans.demo_key }} par votre clé d'API.
diff --git a/docs/pages/guide/version-1/resources/practitioner-role.md b/docs/pages/guide/version-1/resources/practitioner-role.md index 4aa91915..a1aa1832 100644 --- a/docs/pages/guide/version-1/resources/practitioner-role.md +++ b/docs/pages/guide/version-1/resources/practitioner-role.md @@ -27,7 +27,7 @@ Il s'agit d'une ressource qui regroupe les données décrivant l' [« exercice
* Données relatives à l'exercice professionnel : nom et prénom d'exercice, profession, civilité d'exercice, catégorie d'exercice, qualifications de spécialiste et disciplines et attributions particulières. * Données sur l'activité professionnelle : fonction ou rôle du professionnel dans la structure d'activité, genre d'activité, mode d'exercice, type d'activité libérale pour les activités concernées, statut hospitalier pour les activités concernées, données de contact du professionnel pour l'activité concernée, données relatives à la structure d'activité. -* Données relatives à la carte de professionnel de santé : type de carte, numéro, période de validité. +* Données relatives à la carte d'un' professionnel intervenant dans le système de santé : type de carte, numéro, période de validité.

@@ -82,7 +82,7 @@ Il s'agit d'une ressource qui regroupe les données décrivant l' [« exercice
-## 3) Recherche d'exercice et d'activité du professionnel de santé sur critères +## 3) Recherche d'exercice et d'activité du professionnel sur des critères spécifiques Voici des exemples de requêtes sur les exercices et les activités du professionnel de sante. diff --git a/docs/pages/guide/version-1/resources/practitioner.md b/docs/pages/guide/version-1/resources/practitioner.md index 76349b30..d2c0af07 100644 --- a/docs/pages/guide/version-1/resources/practitioner.md +++ b/docs/pages/guide/version-1/resources/practitioner.md @@ -85,9 +85,9 @@ Note : Le nom et le prénom d'exercice du professionnel sont restitués au nivea
-## 3) Recherche de professionnel de santé sur critères +## 3) Recherche d'un professinonel sur des critères spécifiques -Voici des exemples de requêtes sur les professionnels de santé (PS). +Voici des exemples de requêtes sur la recherche de professionnels intervenant dans le système de santé. #### 3.1) Rechercher tout (sans critère) diff --git a/docs/pages/use-cases/practitioner-detail/uc-practitioner.md b/docs/pages/use-cases/practitioner-detail/uc-practitioner.md index ddd7a6de..dc756f67 100644 --- a/docs/pages/use-cases/practitioner-detail/uc-practitioner.md +++ b/docs/pages/use-cases/practitioner-detail/uc-practitioner.md @@ -37,9 +37,9 @@ Dans ce cas d'utilisation, nous allons aborder la récupération d'éléments à Voir la section [Démarrage/Java]({{ '/pages/guide/version-1/integration-fhir/integration-java.html' | relative_url }}) -#### Trouver un professionnel de santé avec son numéro RPPS +#### Trouver un professionnel intervenant dans le système de santé avec son numéro RPPS -Pour l'exemple, nous allons rechercher le PS ayant le numéro RPPS : 10000001111 +Prenons l'exemple d'un professionnel disposant d'un numéro RPPS : 10000001111 Effectuer une recherche FHIR sur la ressource Practitioner avec le paramètre **identifier**. Cela va retourner un Bundle qui contiendra le résultat de recherche. Comme nous cherchons par numéro RPPS, s'il y a un résultat, il sera unique.