From 679ef22c2ae9490651ed56e6ac2d9f40f6fdd78e Mon Sep 17 00:00:00 2001 From: William AZIS Date: Tue, 25 Jun 2024 12:30:09 +0200 Subject: [PATCH] update practitioner and practitionerrole --- .../version-1/getting-started/api-basics.md | 11 +--- .../version-1/getting-started/introduction.md | 16 ++--- .../version-1/resources/practitioner-role.md | 58 +++++++++++++------ .../guide/version-1/resources/practitioner.md | 8 ++- 4 files changed, 58 insertions(+), 35 deletions(-) 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 b2396e6..5b0c8b6 100644 --- a/docs/pages/guide/version-1/getting-started/api-basics.md +++ b/docs/pages/guide/version-1/getting-started/api-basics.md @@ -71,14 +71,9 @@ L'API est conforme à la norme REST. Vous pouvez utiliser les ressources avec le
-```xml --- Exemple : - - curl - -H "ESANTE-API-KEY: XXXX-XXXX-XXXX-XXXXX" \ - "[api-url]/metadata" - - -- XXXX-XXXX-XXXX-XXXXX étant l'API KEY +{% highlight curl %} + curl -H "ESANTE-API-KEY: [api-key]" "[api-url]/metadata" +{% endhighlight %} ```
diff --git a/docs/pages/guide/version-1/getting-started/introduction.md b/docs/pages/guide/version-1/getting-started/introduction.md index 0f616a2..3c6598f 100644 --- a/docs/pages/guide/version-1/getting-started/introduction.md +++ b/docs/pages/guide/version-1/getting-started/introduction.md @@ -15,13 +15,15 @@ Cette norme nous aide à être interopérable et à offrir des modèles de donn ### Ressources FHIR Il existe aujourd'hui 5 ressources disponibles sur l'API FHIR Annuaire Santé: -
-- Practitioner -- PractitionerRole -- Organization -- HealthcareService -- Device -
+ +| Ressources | Description | +| --- | --- | +| Practitioner | Décrit les données d’identification pérennes d’une personne physique, qui travaille en tant que professionnel (professionnel enregistré dans RPPS ou ADELI), personnel autorisé ou personnel d’établissement, dans les domaines sanitaire, médico-social et social. | +| PractitionerRole | Décrit l’exercice professionel et la situation d’exercice - contient les informations décrivant notamment la profession exercée, l’identité d’exercice d’un professionnel, le cadre de son exercice (civil, militaire, etc.) ainsi que les aractéristiques de l’exercice d’un professionnel pendant une période déterminée et dans une structure déterminée | +| Organization | Décrit les organismes du domaine sanitaire, médico-social et social | +| HealthcareService | Décrit les équipements sociaux et activités sanitaires rattachées aux etablisemments FINESS | +| Device | Décrit les équipements matériels lourds (‘EML’) mis en oeuvre au sein d’établissements. | +   ### Météo des services de l'Annuaire Santé diff --git a/docs/pages/guide/version-1/resources/practitioner-role.md b/docs/pages/guide/version-1/resources/practitioner-role.md index a1aa183..74ee4ae 100644 --- a/docs/pages/guide/version-1/resources/practitioner-role.md +++ b/docs/pages/guide/version-1/resources/practitioner-role.md @@ -9,14 +9,14 @@ subTitle: Ressources - [Caractéristiques techniques](#two-header) - [Critères de recherche (SearchParameter)](#three-header) - [Recherche sur critères](#four-header) - - [Rechercher tout](#31-header) - - [Rechercher par identifiant](#32-header) - - [Rechercher par rôle](#33-header) - - [Recherche par profession et par catégorie professionnelle](#331-header) - - [Recherche par spécialité](#34-header) - - [Recherche par type de carte](#35-header) - - [Recherche par professionnel](#36-header) - - [Recherche par statut](#37-header) + - [Rechercher tout](#41-header) + - [Rechercher par identifiant](#42-header) + - [Rechercher par rôle](#43-header) + - [Recherche par profession et par catégorie professionnelle](#431-header) + - [Recherche par spécialité](#44-header) + - [Recherche par type de carte](#45-header) + - [Recherche par professionnel](#46-header) + - [Recherche par statut](#47-header)
@@ -82,11 +82,35 @@ Il s'agit d'une ressource qui regroupe les données décrivant l' [« exercice
-## 3) Recherche d'exercice et d'activité du professionnel sur des critères spécifiques +## 3) Paramètres de recherche + +| Nom | Type | Description | +| --- | --- | --- | +| _id | token | ID de la ressource | +| _lastUpdated | date | Renvoie uniquement les ressources qui ont été mises à jour pour la dernère fois comme spécifié par la période donnée (eq, ne, gt, lt, ge, le, ap). Plus d'informations sur les [dates] (https://build.fhir.org/search.html#date) | +| _since | date | | +| _total | string | | +| active | token | Recherche les ressources PractitionerRole actives | +| as-sp-data-information-system | token | Recherche sur le système d'information | +| as-sp-data-registration-authority | token | Recherche sur l'autorité d'enregistrement | +| family | Recherche sur le nom d'exercice des professionnels intervenant dans le système de santé | +| given | Recherche sur le prénom d'exercice des professionnels intervenant dans le système de santé | +| identifier| token | Recherche sur l'identifiant du PractitionerRole | +| mailbox-mss| string | La Messagerie Sécurisées de Santé (MSS) du Professionnel | +| name | string | Une recherche définie par le serveur qui peut correspondre à n'importe quel champ de HumanName, ici sur le préfix correspondant à la civilité des professionnels de santé| +| number-smartcard | string | Recherche sur le numéro de carte des professionnels | +| organization | reference | Recherche les exercices professionnels et les situation d'exercice rattachés à la structure sélectionnée | +| practitioner | reference | Recherche les exercices professionnels et les situation d'exercice rattachés aux professionnels intervenant dans le système de santé | +| role | token | Recherche sur la profession/ la catégorie professionnelle/ la fonction/ le genre d'activité/ le mode d'exercice ou la section tableau des pharmacien | +| specialty | token | Recherche sur le savoir-faire ou le type de savoir-faire | +| type-smartcard | token | Recherche sur le type de carte du professionnel | + + +## 4) 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. -#### 3.1) Rechercher tout (sans critère) +#### 4.1) Rechercher tout (sans critère) **Récit utilisateur :** En tant que client de l'API, je souhaite récupérer l'ensemble des données correspondant aux situations d'exercice et exercices professionnels des PS. @@ -169,7 +193,7 @@ foreach (var be in bundle.Entry)
-#### 3.2) Recherche par identifiant (_id) +#### 4.2) Recherche par identifiant (_id) **Récit utilisateur :** En tant que client de l'API, je souhaite rechercher une ressource par son identifiant technique. @@ -233,7 +257,7 @@ Console.WriteLine($"PractitionerRole found: id={practitionerRole.IdElement.Value
-#### 3.3) Recherche par rôle (role) +#### 4.3) Recherche par rôle (role) La recherche par le paramètre "role" permet de rechercher les PractitionerRole selon différents référentiels. Voici les différents référentiels disponibles : @@ -267,7 +291,7 @@ Lorsque vous souhaitez rechercher sur un type particulier, utilisez la combinais
-##### 3.3.1) Recherche par profession et par catégorie professionnelle +##### 4.3.1) Recherche par profession et par catégorie professionnelle **Récit utilisateur :** En tant que client de l'API, je souhaite rechercher tous les chirurgiens-dentistes (code profession= "40") en formation (code catégorie = "E"). @@ -384,7 +408,7 @@ foreach (var be in bundle.Entry)
-#### 3.4) Recherche par spécialité (specialty) +#### 4.4) Recherche par spécialité (specialty) **Récit utilisateur :** En tant que client de l'API, je souhaite rechercher tous les chirurgiens-dentistes (code profession= "40") ayant une spécialité ordinale "orthopédie dento-faciale" (code spécialité = "SCD01"). @@ -519,7 +543,7 @@ foreach (var be in bundle.Entry)
-#### 3.5) Recherche par type de carte (type-smartcard) +#### 4.5) Recherche par type de carte (type-smartcard) **Récit utilisateur :** En tant que client de l'API, je souhaite rechercher toutes les cartes de type CPS. @@ -604,7 +628,7 @@ foreach (var be in bundle.Entry)
-#### 3.6) Recherche par professionnel (practitioner) +#### 4.6) Recherche par professionnel (practitioner) **Récit utilisateur :** En tant que client de l'API, je souhaite rechercher toutes les situations d'exercice et exercices professionnels d'un PS en partant de son identifiant technique ( = "003-138020" dans l'exemple ). @@ -685,7 +709,7 @@ foreach (var be in bundle.Entry)
-#### 3.7) Recherche par statut +#### 4.7) Recherche par statut **Récit utilisateur :** En tant que client de l'API, je souhaite rechercher toutes les ressources actives. diff --git a/docs/pages/guide/version-1/resources/practitioner.md b/docs/pages/guide/version-1/resources/practitioner.md index 0bd5189..23d4cd8 100644 --- a/docs/pages/guide/version-1/resources/practitioner.md +++ b/docs/pages/guide/version-1/resources/practitioner.md @@ -105,9 +105,11 @@ Voici des exemples de requêtes sur la recherche de professionnels intervenant d **Exemples de requêtes :** ```sh -GET [base]/Practitioner -GET [base]/Practitioner?_revinclude=PractitionerRole:practitioner #inclure les practitionerRole qui référencent les practitioner (Practitioner + PractitionerRole) +GET [base]/Practitioner +#récupère l'ensemble des practitioners +GET [base]/Practitioner?_revinclude=PractitionerRole:practitioner +#inclure les practitionerRole qui référencent les practitioners (Practitioner + PractitionerRole) ```
@@ -356,7 +358,7 @@ foreach (var be in bundle.Entry) #### 4.4) Rechercher par date de mise à jour (_lastUpdated) -**Récit utilisateur :** En tant que client de l'API, je souhaite rechercher tous les professionnels de santé mis à jour depuis une certaine date. +En tant que client de l'API, je souhaite rechercher tous les professionnels de santé mis à jour depuis une certaine date. | Préfix | Valeurs | | --- | --- |