Skip to content

Commit

Permalink
Merge pull request #224 from ansforge/fix_uc
Browse files Browse the repository at this point in the history
update getting started
  • Loading branch information
zilliw authored Jun 24, 2024
2 parents 15fccb8 + 3d61df9 commit 84a6c35
Show file tree
Hide file tree
Showing 9 changed files with 30 additions and 97 deletions.
4 changes: 2 additions & 2 deletions docs/index.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand All @@ -38,7 +38,7 @@ En intégrant l'API Annuaire Santé dans votre système d'information, vous pouv
#### Pour les structures de santé

<div class="wysiwyg" markdown="1">
* 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.
</div>
Expand Down
8 changes: 4 additions & 4 deletions docs/pages/changelog/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
File renamed without changes.
68 changes: 0 additions & 68 deletions docs/pages/documentation/authentication.md

This file was deleted.

32 changes: 16 additions & 16 deletions docs/pages/guide/version-1/getting-started/api-basics.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down
3 changes: 2 additions & 1 deletion docs/pages/guide/version-1/getting-started/test-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,14 +39,15 @@ Veuillez trouver ci-dessous les variables utilisées dans le projet Postman:
</p>

## <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.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.

<div class="wysiwyg" markdown="1">
* **Test 1** : lancez la commande suivante pour récupérer le CapabilityStatement FHIR (liste des fonctionnalités de l'API) :
</div>
&nbsp;

NOTE| Pour la suite de l'exercice, vous devez remplacer {{site.ans.demo_key }} par votre clé d'API.


<div class="code-sample"><div class="tab-content" data-name="bash">
Expand Down
4 changes: 2 additions & 2 deletions docs/pages/guide/version-1/resources/practitioner-role.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Il s'agit d'une ressource qui regroupe les données décrivant l' [« exercice
<div class="wysiwyg" markdown="1">
* 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é.
</div>
<br />

Expand Down Expand Up @@ -82,7 +82,7 @@ Il s'agit d'une ressource qui regroupe les données décrivant l' [« exercice
<br />


## <a id="four-header"></a>3) Recherche d'exercice et d'activité du professionnel de santé sur critères
## <a id="four-header"></a>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.

Expand Down
4 changes: 2 additions & 2 deletions docs/pages/guide/version-1/resources/practitioner.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,9 +85,9 @@ Note : Le nom et le prénom d'exercice du professionnel sont restitués au nivea
<br />


## <a id="three-header"></a>3) Recherche de professionnel de santé sur critères
## <a id="three-header"></a>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é.


#### <a id="31-header"></a>3.1) Rechercher tout (sans critère)
Expand Down
4 changes: 2 additions & 2 deletions docs/pages/use-cases/practitioner-detail/uc-practitioner.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down

0 comments on commit 84a6c35

Please sign in to comment.