diff --git a/docs/_includes/next-resource.html b/docs/_includes/next-resource.html index c4841e6..fa708ab 100644 --- a/docs/_includes/next-resource.html +++ b/docs/_includes/next-resource.html @@ -1,4 +1,4 @@ -{% for item in site.data.menu.header[2].subfolderitems %} +{% for item in site.data.menu.header[1].subfolderitems %} {% if item.subfolderitems[0] %} {% for item in item.subfolderitems %} {% if item.url == page.url and item.next-url %} diff --git a/docs/pages/guide/version-1/resources/device.md b/docs/pages/guide/version-1/resources/device.md index e697f6c..efacd5b 100644 --- a/docs/pages/guide/version-1/resources/device.md +++ b/docs/pages/guide/version-1/resources/device.md @@ -8,13 +8,14 @@ subTitle: Ressources
- [Description métier](#one-header) - [Caractéristiques techniques](#two-header) -- [Recherche sur critères](#three-header) - - [Rechercher tout](#31-header) - - [Rechercher par date de mise à jour](#32-header) - - [Rechercher par numéro ARHGOS](#33-header) - - [Recherche par type](#34-header) - - [Recherche par identifiant](#35-header) - - [Recherche par statut](#36-header) +- [Paramètres de recherche](#three-header) +- [Recherche sur critères](#four-header) + - [Rechercher tout](#41-header) + - [Rechercher par date de mise à jour](#42-header) + - [Rechercher par numéro ARHGOS](#43-header) + - [Recherche par type](#44-header) + - [Recherche par identifiant](#45-header) + - [Recherche par statut](#46-header)

@@ -59,14 +60,6 @@ Il s'agit d'une ressource qui regroupe les données complémentaires FINESS por -

Paramètres de recherche

- - -

_id, identifier, device-name, manufacturer, number-authorization-arhgos, status, type, _lastUpdated, organization, _total

- - - -

Paramètres de requête

@@ -77,11 +70,30 @@ Il s'agit d'une ressource qui regroupe les données complémentaires FINESS por
-## 3) Recherche d'équipement matériel lourd (EML) sur critères +## 3) Paramètres de recherche + +| Nom | Type | Description | +| --- | --- | --- | +| _id | token | Recherche sur l'ID de la ressource HealthCare Service | +| _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 | +| _since | date | | +| _total | string | | +| 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 | +| device-name | string | Le nom de l'équipement | +| identifier | token | Recherche sur l'identifiant de l'équipement matériel lourd | +| manufacturer | string | Recherche sur la marque des équipements matériels lourds | +| model | string | Recherche sur le modèle des équipements matériels lourds | +| number-authorization-arhgos | string | Recherche sur le numéro d'autorisation ARHGOS | +| organization | reference | Recherche les équipements matériels lourds rattachés à la structure sélectionnée | +| status | token | active, inactive, entered-in-error, unknown | +| type | token | Recherche sur le type de l'équipement matériel lourd | + +## 4) Recherche d'équipement matériel lourd (EML) sur critères Voici des exemples de requêtes sur les équipements matériels lourds. -## 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 EML. @@ -167,7 +179,7 @@ foreach (var be in bundle.Entry)
-#### 3.2) Rechercher par date de mise à jour (_lastUpdated) +#### 4.2) Rechercher par date de mise à jour (_lastUpdated) **Récit utilisateur :** En tant que client de l'API, je souhaite rechercher toutes les EML mise à jour depuis une certaine date. @@ -262,7 +274,7 @@ foreach (var be in bundle.Entry)
-#### 3.3) Rechercher un matériel par son numéro ARHGOS (number-authorization-arhgos) +#### 4.3) Rechercher un matériel par son numéro ARHGOS (number-authorization-arhgos) **Récit utilisateur :** En tant que client de l'API, je souhaite rechercher un EML à partir de son numéro ARHGOS. @@ -354,7 +366,7 @@ foreach (var be in bundle.Entry)
-#### 3.4) Rechercher par type EML (type) +#### 4.4) Rechercher par type EML (type) **Récit utilisateur :** En tant que client de l'API, je souhaite rechercher tous les EML de type "Scanographe à utilisation médicale". @@ -452,7 +464,7 @@ foreach (var be in bundle.Entry)
-#### 3.5) Rechercher par son identifiant (identifier) +#### 4.5) Rechercher par son identifiant (identifier) **Récit utilisateur :** En tant que client de l'API, je souhaite rechercher un EML à partir de son identifiant. @@ -541,7 +553,7 @@ foreach (var be in bundle.Entry)
-#### 3.6) Rechercher par statut (status) +#### 4.6) Rechercher par statut (status) **Récit utilisateur :** En tant que client de l'API, je souhaite rechercher les EML actifs. diff --git a/docs/pages/guide/version-1/resources/healthcare-service.md b/docs/pages/guide/version-1/resources/healthcare-service.md index ece2521..452f8fa 100644 --- a/docs/pages/guide/version-1/resources/healthcare-service.md +++ b/docs/pages/guide/version-1/resources/healthcare-service.md @@ -7,12 +7,13 @@ subTitle: Ressources
- [Description métier](#one-header) - [Caractéristiques techniques](#two-header) -- [Recherche sur critères](#three-header) - - [Rechercher tout](#31-header) - - [Rechercher par identifiant](#32-header) - - [Rechercher par type/forme d'activité](#33-header) - - [Recherche par statut](#34-header) - - [Recherche par date de mise à jour](#35-header) +- [Paramètres de recherche](#three-header) +- [Recherche sur critères](#four-header) + - [Rechercher tout](#41-header) + - [Rechercher par identifiant](#42-header) + - [Rechercher par type/forme d'activité](#43-header) + - [Recherche par statut](#44-header) + - [Recherche par date de mise à jour](#45-header)

@@ -58,14 +59,6 @@ Il s'agit d'une ressource divisée en deux profils pour décrire les « [activit -

Paramètres de recherche

- - -

_id, identifier, characteristic, service-category, service-type, active, _profile, organization, _lastUpdated, _total

- - - -

Paramètres de requête

@@ -76,11 +69,31 @@ Il s'agit d'une ressource divisée en deux profils pour décrire les « [activit
-## 3) Recherche d'activité de soin et d'équipement social sur critères +## 3) Paramètres de recherche + +| Nom | Type | Description | +| --- | --- | --- | +| _has | string | | +| _id | token | Recherche sur l'ID de la ressource HealthCare Service | +| _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).| +| _profile| uri | Sélectionner le profil de la ressource Healthcare Service. Pour les activités de soins http://interop.esante.gouv.fr/ig/fhir/annuaire-donnee-publique/StructureDefinition/as-healthcareservice-healthcare-activity / ; Pour les équipements sociaux http://interop.esante.gouv.fr/ig/fhir/annuaire-donnee-publique/StructureDefinition/as-healthcareservice-social-equipment" | +| _since | date | | +| _total | string | | +| active | token | Recherche les ressources Healthcare Service 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 | +| characteristic | token | Recherche sur le type d'activité des équipements sociaux ou sur la forme d'activité des activités de soins | +| identifier | token | Recherche sur l'identifiant des équipements sociaux ou des activités de soins | +| organization | reference | Recherche tous les équipements sociaux ou activités de soins rattachés à une structure| +| service-category | token | Recherche sur la modalité des activités de soins | +| service-type | token | Recherche sur la discipline des équipements sociaux ou sur l'activité sanitaire régulée des activité de soins | + + +## 4) Recherche d'activité de soin et d'équipement social sur critères Voici des exemples de requêtes sur les activités de soin et les équipements sociaux. -## 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 services de soin. @@ -164,7 +177,7 @@ foreach (var be in bundle.Entry)
-#### 3.2) Rechercher par identifiant (identifier) +#### 4.2) Rechercher par identifiant (identifier) **Récit utilisateur :** En tant que client de l'API, je souhaite rechercher un service à partir de son identifiant. @@ -249,7 +262,7 @@ foreach (var be in bundle.Entry)
-#### 3.3) Rechercher par type/forme d'activité (characteristic) +#### 4.3) Rechercher par type/forme d'activité (characteristic) **Récit utilisateur :** En tant que client de l'API, je souhaite rechercher toutes les activités de soin ayant comme forme la Chirurgie ambulatoire (code 07). @@ -356,7 +369,7 @@ foreach (var be in bundle.Entry)
-#### 3.4) Rechercher par statut (active) +#### 4.4) Rechercher par statut (active) **Récit utilisateur :** En tant que client de l'API, je souhaite rechercher tous les services de santé actifs. @@ -447,7 +460,7 @@ foreach (var be in bundle.Entry)
-#### 3.5) Rechercher par date de mise à jour (_lastUpdated) +#### 4.5) Rechercher par date de mise à jour (_lastUpdated) **Récit utilisateur** : En tant que client de l'API, je souhaite rechercher tous les services mis à jour depuis une certaine date ( >= '18/08/2022' dans l'exemple ). diff --git a/docs/pages/guide/version-1/resources/organization.md b/docs/pages/guide/version-1/resources/organization.md index 189c930..769caab 100644 --- a/docs/pages/guide/version-1/resources/organization.md +++ b/docs/pages/guide/version-1/resources/organization.md @@ -7,16 +7,17 @@ subTitle: Ressources
- [Description métier](#one-header) - [Caractéristiques techniques](#two-header) -- [Recherche de structure sur critères](#three-header) - - [Rechercher tout](#31-header) - - [Rechercher par date de mise à jour](#32-header) - - [Rechercher par identifiant](#33-header) - - [Rechercher par numéro FINESS](#34-header) - - [Rechercher par type “GEOGRAPHICAL”/”LEGAL](#351-header) - - [Rechercher sur la nomenclature d’activités française de l’Insee](#352-header) - - [Rechercher par secteur d’activité](#353-header) - - [Rechercher par nom](#36-header) - - [Rechercher par code postal](#37-header) +- [Caractéristiques techniques](#three-header) +- [Recherche de structure sur critères](#four-header) + - [Rechercher tout](#41-header) + - [Rechercher par date de mise à jour](#42-header) + - [Rechercher par identifiant](#43-header) + - [Rechercher par numéro FINESS](#44-header) + - [Rechercher par type “GEOGRAPHICAL”/”LEGAL](#451-header) + - [Rechercher sur la nomenclature d’activités française de l’Insee](#452-header) + - [Rechercher par secteur d’activité](#453-header) + - [Rechercher par nom](#46-header) + - [Rechercher par code postal](#47-header)

@@ -63,14 +64,6 @@ Il s'agit d'une ressource qui regroupe les données décrivant la [« structure -

Paramètres de recherche

- - -

_id, identifier, name, mailbox-mss, type, pharmacy-licence, partof, address, address-city, address-country, address-postalcode, _lastUpdated, active, _total

- - - -

Paramètres de requête

@@ -80,12 +73,38 @@ Il s'agit d'une ressource qui regroupe les données décrivant la [« structure - -## 3) Recherche de structure sur critères +## 3) Paramètres de recherche + +| Nom | Type | Description | +| --- | --- | --- | +| _has | string | | +| _id | token | Recherche sur l'ID de la ressource Organization | +| _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).| +| _since | date | | +| _total | string | | +| active | token | Recherche les ressources Organization actives | +| address | string | Recherche sur (une partie) de l'adresse de la structure | +| address-city | string | Recherche sur la commune spécifiée dans une adresse | +| address-country | string | Recherche sur le pays spécifiée dans une adresse | +| address-postalcode | string | Recherche sur le code postal spécifié dans une adresse | +| address-state | string | Recherche un état specifiée dans une adresse | +| address-use | string | Recherche sur un code use spécifié dans adresse | +| 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 | +| endpoint | reference | Endpoint technique fournissant des accès aux services exploités pour l'organisation | +| identifier | token | Recherche sur tous les identifiants des structures | +| identifier-type | token | Recherche sur les types d'identifiers | +| mailbox-mss | string | Recherche sur les messageries sécurisées de santé (MSS) rattachées aux Organizations | +| name | string | Recherche sur la raison sociale des structures | +| partof | reference | Recherche tous les établissements géographiques rattachés à une même entité juridique | +| pharmacy-licence | string | Recherche sur le numéro de licence des officines | +| type | token | Recherche sur le type de structure/ code APE/ catégorie juridique/ secteur d'activité/ catégorie d'établissement ou le code SPH de la structure | + +## 4) Recherche de structure sur critères Voici quelques exemples de requêtes sur les structures. -#### 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 structures. @@ -170,7 +189,7 @@ foreach (var be in bundle.Entry)
-#### 3.2) Rechercher par date de mise à jour (_lastUpdated) +#### 4.2) Rechercher par date de mise à jour (_lastUpdated) **Récit utilisateur :** En tant que client de l'API, je souhaite rechercher toutes les structures mises à jour depuis une certaine date. @@ -255,7 +274,7 @@ foreach (var be in bundle.Entry)
-#### 3.3) Rechercher par identifiant (identifier) +#### 4.3) Rechercher par identifiant (identifier) **Récit utilisateur :** En tant que client de l'API, je souhaite rechercher une structure à partir de l'un de ses identifiants. **Requête :** @@ -337,7 +356,7 @@ foreach (var be in bundle.Entry)
-#### 3.4) Rechercher par numéro FINESS (identifier) +#### 4.4) Rechercher par numéro FINESS (identifier) **Récit utilisateur :** En tant que client de l'API, je souhaite rechercher une structure à partir de son numéro FINESS. @@ -421,7 +440,7 @@ foreach (var be in bundle.Entry)
-#### 3.5) Recherches par types (type) +#### 4.5) Recherches par types (type) Le champs type de la ressource Organization peut contenir différentes informations en fonction du système. @@ -449,7 +468,7 @@ Lorsque vous souhaitez rechercher sur un type particulier, utilisez la combinais Ci-dessous, vous trouverez 3 exemples complets sur EJ/EG, Secteur d’activité et APE. -##### 3.5.1) Rechercher par type "GEOGRAPHICAL"/"LEGAL" +##### 4.5.1) Rechercher par type "GEOGRAPHICAL"/"LEGAL" **Récit utilisateur :** En tant que client de l'API, je souhaite rechercher les structures de type géographique. @@ -551,7 +570,7 @@ foreach (var be in bundle.Entry)
-##### 3.5.2) Rechercher sur la nomenclature d'activités française de l'Insee (code APE) +##### 4.5.2) Rechercher sur la nomenclature d'activités française de l'Insee (code APE) **Récit utilisateur :** En tant que client de l'API, je souhaite rechercher les structures avec un code APE "**82.19Z**" qui correspond à "Photocopie, préparation de documents et autres activités spécialisées de soutien de bureau" @@ -646,7 +665,7 @@ foreach (var be in bundle.Entry)
-#### 3.5.3) Rechercher par secteur d'activité +#### 4.5.3) Rechercher par secteur d'activité **Récit utilisateur :** En tant que client de l'API, je souhaite rechercher les structures d'un secteur d'activité (SA29 par exemple, qui correspond à "Laboratoires d'analyses et de biologie médicale"). @@ -741,7 +760,7 @@ foreach (var be in bundle.Entry)
-#### 6) Rechercher par nom (name) +#### 4.6) Rechercher par nom (name) **Récit utilisateur :** En tant que client de l'API, je souhaite trouver une structure à partir de son nom. @@ -826,7 +845,7 @@ foreach (var be in bundle.Entry)
-#### 7) Rechercher par code postal (address-postalcode) +#### 4.7) Rechercher par code postal (address-postalcode) **Récit utilisateur :** En tant que client de l'API, je souhaite rechercher les structures d'un département (code postal). diff --git a/docs/pages/guide/version-1/resources/search-params.md b/docs/pages/guide/version-1/resources/search-params.md index 2a10282..7b814fa 100644 --- a/docs/pages/guide/version-1/resources/search-params.md +++ b/docs/pages/guide/version-1/resources/search-params.md @@ -383,6 +383,8 @@ La recherche par date supporte les préfixes suivants: | eb | ends before | La valeur du paramètre dans la ressource termine avant la valeur saisie | | ap | approximately | La valeur du paramètre dans la ressource est approximativement la même que la valeur fournie. Il est à noter que la valeur recommandée pour l'approximation est de 10% de la valeur indiquée | +Plus d'informations sur les [dates] (https://build.fhir.org/search.html#date) + Plusiseurs "précisions" sont supportées : yyyy par année, yyyy-MM-dd par jour, et par date complète. **Quelques exemples :**