Ressources

Organization


1) Description métier de la ressource

Il s’agit d’une ressource qui regroupe les données décrivant la « structure » :

  • numéros SIREN/ SIRET ou FINESS, type de structure (géographique ou juridique), activité , secteur d’activité santé, catégorie juridique, modalités de participation au service public hospitalier (SPH),
  • raison sociale, enseigne commerciale, coordonnées (adresse postale, adresses de messagerie électronique y compris MSS, téléphone, fax),
  • pour les structures géographiques, le numéros FINESS de la strcuture juridique de rattachement.


2) Caractéristiques techniques de la ressource

Endpoint

https://gateway.api.esante.gouv.fr/fhir/v1/Organization

Header

ESANTE-API-KEY

Méthodes HTTP associées

GET, POST

Paramètres de requête

_count, _include, _revinclude

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.

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.

Requêtes :

GET [base]/Organization
#récupère l'ensemble des Organizations (incluant les actives et les inactives)
GET [base]/Organization?_include=Organization:partof #inclure les entités juridiques avec les informations auxquelles sont rattachées les entités géographiques
GET [base]/Organization?_revinclude=Device:organization #inclure les Device qui référencent les Organization (Organization + Device)
GET [base]/Organization?_revinclude=HealthcareService:organization #inclure les HealthcareService qui référencent les Organization (Organization + HealthcareService)
GET [base]/Organization?_revinclude=PractitionerRole:organization #inclure les PractitionerRole qui référencent les Organization (Organization + PractitionerRole)
GET [base]/Organization?_include=* #inclure toutes les ressources qui sont référencées par les Organization


Réponse (simplifiée) : 

HTTP 200 OK
resourceType: Bundle
type: searchset
total: 7

Organizations trouvées :
1. **ID**: org-399  
   **Nom**: Weber, Weber and Weber  
   **Dernière mise à jour**: 2023-01-15T08:30:00Z  
2. **ID**: org-158  
   **Nom**: Schaefer-Schaefer  
   **Dernière mise à jour**: 2023-01-10T14:50:00Z  
3. **ID**: org-151  
   **Nom**: O'Reilly, O'Reilly and O'Reilly  
   **Dernière mise à jour**: 2023-01-08T09:20:00Z  
4. **ID**: org-393  
   **Nom**: Volkman-Volkman  
   **Dernière mise à jour**: 2023-01-02T16:40:00Z  



Exemples de code:

curl -H "ESANTE-API-KEY: XXXX-XXXX-XXXX-XXXXX" https://gateway.api.esante.gouv.fr/fhir/v1/Organization


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.

Requête :

GET [base]/Organization?_lastUpdated=ge2022-08-05

Réponse (simplifiée) : 

HTTP 200 OK
  resourceType: Bundle
  type: searchset
  Organization found: id=org-148 lastUpdate=Fri Aug 05 14:51:03 CEST 2022
  Organization found: id=org-149 lastUpdate=Fri Aug 05 14:51:03 CEST 2022
  Organization found: id=org-144 lastUpdate=Fri Aug 05 14:51:03 CEST 2022
  Organization found: id=org-386 lastUpdate=Fri Aug 05 14:51:03 CEST 2022
  Organization found: id=org-145 lastUpdate=Fri Aug 05 14:51:03 CEST 2022



Exemples de code:

curl -H "ESANTE-API-KEY: XXXX-XXXX-XXXX-XXXXX" "https://gateway.api.esante.gouv.fr/fhir/v1/Organization?_lastUpdated=ge2022-08-05T14%3A51%3A04"


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 :

GET [base]/Organization?identifier=001604103000

Réponse (simplifiée) : 

HTTP 200 OK
  resourceType: Bundle
  type: searchset
  total: 1
  Organization found: id=001604103000



Exemples de code:

curl -H "ESANTE-API-KEY: XXXX-XXXX-XXXX-XXXXX" "https://gateway.api.esante.gouv.fr/fhir/v1/Organization?identifier=001604103000%2C01603998400%2C001604252500"


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.

Requête :

GET [base]/Organization?identifier=http%3A%2F%2Ffiness.sante.gouv.fr%7C060016219

Réponse (simplifiée) : 

HTTP 200 OK
  resourceType: Bundle
  type: searchset
  total: 1
  Organization found: id=060016219



Exemples de code:

curl -H "ESANTE-API-KEY: XXXX-XXXX-XXXX-XXXXX" "https://gateway.api.esante.gouv.fr/fhir/v1/Organization?identifier=http%3A%2F%2Ffiness.sante.gouv.fr%7C010000602%2Chttp%3A%2F%2Ffiness.sante.gouv.fr%7C010000628%2Chttp%3A%2F%2Ffiness.sante.gouv.fr%7C010000735" 


4.5) Recherches par types (type)

Le champs type de la ressource Organization peut contenir différentes informations en fonction du système.

Type Description Système Lien / Options
EJ/EG Type d’organization http://interopsante.org/fhir/CodeSystem/fr-v2-3307 GEOGRAPHICAL-ENTITY ou LEGAL-ENTITY
APE JDV_J99-InseeNAFrav2Niveau5-RASS https://mos.esante.gouv.fr/NOS/TRE_R75-InseeNAFrev2Niveau5/FHIR/TRE-R75-InseeNAFrev2Niveau5 https://mos.esante.gouv.fr/NOS/TRE_R75-InseeNAFrev2Niveau5/FHIR/TRE-R75-InseeNAFrev2Niveau5
Catégorie juridique JDV_J100-FinessStatutJuridique-RASS https://mos.esante.gouv.fr/NOS/TRE_R72-FinessStatutJuridique/FHIR/TRE-R72-FinessStatutJuridique https://mos.esante.gouv.fr/NOS/TRE_R72-FinessStatutJuridique/FHIR/TRE-R72-FinessStatutJuridique
Secteur d’activité JDV_J101-SecteurActivite-RASS https://mos.esante.gouv.fr/NOS/TRE_R02-SecteurActivite/FHIR/TRE-R02-SecteurActivite https://mos.esante.gouv.fr/NOS/TRE_R02-SecteurActivite/FHIR/TRE-R02-SecteurActivite
Catégorie Etablissement JDV_J129-CategorieEtablissement-RASS https://mos.esante.gouv.fr/NOS/TRE_R66-CategorieEtablissement/FHIR/TRE-R66-CategorieEtablissement https://mos.esante.gouv.fr/NOS/TRE_R66-CategorieEtablissement/FHIR/TRE-R66-CategorieEtablissement
SPH JDV_162-ESPIC-RASS https://mos.esante.gouv.fr/NOS/TRE_R73-ESPIC/FHIR/TRE-R73-ESPIC https://mos.esante.gouv.fr/NOS/TRE_R73-ESPIC/FHIR/TRE-R73-ESPIC

Lorsque vous souhaitez rechercher sur un type particulier, utilisez la combinaison du système et du code souhaité :

Organization?type=<system>%7C<code>

Quelques exemples :

  • Organization?type=https://mos.esante.gouv.fr/NOS/TRE_R75-InseeNAFrev2Niveau5/FHIR/TRE-R75-InseeNAFrev2Niveau5%7C01.11Z Recherche par code APE 01.11Z : “Culture de céréales (sf riz) légumineuses, graines oléagineuses”
  • Organization?type=https://mos.esante.gouv.fr/NOS/TRE_R72-FinessStatutJuridique/FHIR/TRE-R72-FinessStatutJuridique%7C02 Recherche par code Statuts juridiques provenant de FINESS, code 02 : “Département”
  • Organization?type=https://mos.esante.gouv.fr/NOS/TRE_R66-CategorieEtablissement/FHIR/TRE-R66-CategorieEtablissement%7C101 Recherche par Catégorie d’établissements, code 101 “Centre Hospitalier Régional (C.H.R.)”

Ci-dessous, vous trouverez 3 exemples complets sur EJ/EG, Secteur d’activité et APE.

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.

Remarque :

Les deux types possibles sont :

  • GEOGRAPHICAL-ENTITY
  • LEGAL-ENTITY


Requête :

GET [base]/Organization?type=http%3A%2F%2Finteropsante.org%2Ffhir%2FCodeSystem%2Ffr-v2-3307%7CGEOGRAPHICAL-ENTITY

Réponse (simplifiée) : 

HTTP 200 OK
  resourceType: Bundle
  type: searchset
  Organization found: name=VILLAGE D'ENFANTS . ACTION ENFANCE type=GEOGRAPHICAL-ENTITY - 87.90A
  Organization found: name=LVA LABONDE LA FORESTIERE type=GEOGRAPHICAL-ENTITY - SA41 - 462
  Organization found: name=SERVICE D'ACTION EDUC EN MILIEU OUVERT type=GEOGRAPHICAL-ENTITY - SA20 
  Organization found: name=ESPACE ARTOIS SANTE - ARRAS type=GEOGRAPHICAL-ENTITY - SA04 - 698 - 9



Exemples de code:

curl -H "ESANTE-API-KEY: XXXX-XXXX-XXXX-XXXXX" "https://gateway.api.esante.gouv.fr/fhir/v1/Organization?type=http%3A%2F%2Finteropsante.org%2Ffhir%2FCodeSystem%2Ffr-v2-3307%7CGEOGRAPHICAL-ENTITY" 
curl -H "ESANTE-API-KEY: XXXX-XXXX-XXXX-XXXXX" "https://gateway.api.esante.gouv.fr/fhir/v1/Organization?type=GEOGRAPHICAL-ENTITY" 


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”

Remarque :

Les codes APE sont disponibles dans le référenciel TRE-R75-InseeNAFrev2Niveau5 des NOS que vous trouverez ici : TRE-R75-InseeNAFrev2Niveau5

Requête :

GET [base]/Organization?type=https://mos.esante.gouv.fr/NOS/TRE_R75-InseeNAFrev2Niveau5/FHIR/TRE-R75-InseeNAFrev2Niveau5%7C82.19Z

Réponse (simplifiée) : 

HTTP 200 OK
  resourceType: Bundle
  type: searchset
  Organization found: name=Skiles, Skiles and Skiles type=SA29 - 82.19Z - LEGAL-ENTITY - someorg
  Organization found: name=Terry, Terry and Terry type=SA29 - 82.19Z - LEGAL-ENTITY - someorg
  Organization found: name=Mills Inc type=SA29 - 82.19Z - LEGAL-ENTITY - someorg



Exemples de code:

curl -H "ESANTE-API-KEY: XXXX-XXXX-XXXX-XXXXX" "https://gateway.api.esante.gouv.fr/fhir/v1/Organization?type=https://mos.esante.gouv.fr/NOS/TRE_R75-InseeNAFrev2Niveau5/FHIR/TRE-R75-InseeNAFrev2Niveau5%7C82.19Z" 


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”).

Remarque :

La liste des secteurs d’activités se trouve dans le référenciel TRE_R02-SecteurActivite des NOS que vous trouverez ici : TRE_R02-SecteurActivite

Requête :

GET [base]/Organization?type=https%3A%2F%2Fmos.esante.gouv.fr%2FNOS%2FTRE_R02-SecteurActivite%2FFHIR%2FTRE-R02-SecteurActivite%7CSA29

Réponse (simplifiée) : 

HTTP 200 OK
  resourceType: Bundle
  type: searchset
  Organization found: name=Auer, Auer and Auer activity=Laboratoire d'analyses et de biologie médicale
  Organization found: name=Erdman, Erdman and Erdman activity=Laboratoire d'analyses et de biologie médicale
  Organization found: name=Stiedemann and Sons activity=Laboratoire d'analyses et de biologie médicale



Exemples de code:

curl -H "ESANTE-API-KEY: XXXX-XXXX-XXXX-XXXXX" "https://gateway.api.esante.gouv.fr/fhir/v1/Organization?type=https%3A%2F%2Fmos.esante.gouv.fr%2FNOS%2FTRE_R02-SecteurActivite%2FFHIR%2FTRE-R02-SecteurActivite%7CSA29" 


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.

Requête :

GET [base]/Organization?name%3Acontains=imagerie%2Ccentre

Réponse (simplifiée) : 

HTTP 200 OK
  resourceType: Bundle
  type: searchset
  Organization found: name=Mills Inc centre
  Organization found: name=Centre d'imagerie médicale - Selimed 63
  Organization found: name=Imagerie médicale République



Exemples de code:

curl -H "ESANTE-API-KEY: XXXX-XXXX-XXXX-XXXXX" "https://gateway.api.esante.gouv.fr/fhir/v1/Organization?name%3Acontains=imagerie%2Ccentre"


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

Requête :

GET [base]/Organization?address-postalcode%3Aexact=13290%2C13321

Réponse (simplifiée) : 

HTTP 200 OK
  resourceType: Bundle
  type: searchset
  Organization found: name=Renard et Renard | zipCode=91794
  Organization found: name=Maillard et Maillard | zipCode=10228



Exemples de code:

curl -H "ESANTE-API-KEY: XXXX-XXXX-XXXX-XXXXX" "https://gateway.api.esante.gouv.fr/fhir/v1/Organization?address-postalcode%3Aexact=13290%2C13321"


Code source des exemples

Vous retrouverez le code source de ces exemples sur notre repository git: