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.
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 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
Organization found: id=org-399 name=Weber, Weber and Weber
Organization found: id=org-158 name=Schaefer-Schaefer
Organization found: id=org-151 name=OReilly, OReilly and OReilly
Organization found: id=org-393 name=Volkman-Volkman
Organization found: id=org-152 name=Luettgen, Luettgen and Luettgen
Organization found: id=org-394 name=Gulgowski, Gulgowski and Gulgowski
Organization found: id=org-153 name=Wilkinson Group
Exemples de code:
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:
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.
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”
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:
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:
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:
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:
Code source des exemples
Vous retrouverez le code source de ces exemples sur notre repository git: