Exemples GET

ROROrganization

Cette page présente des exemples de requêtes GET sur la ressource ROROrganization. Pour la présentation de la ressource et ses caractéristiques techniques, voir cette même page.

Voici quelques exemples de requêtes sur les organisations.

Attention : pour récupérer l'ensemble des résultats au niveau national ou au niveau d'une région, vous devez impérativement utiliser la méthode $export avec l'API `HealthcareService`. Les résultats de cette requête seront tronqués à 10 000 résultats.

1 Rechercher tout (sans critère)

Description du scénario : Un consommateur souhaite récupérer l’ensemble des organisations, actives et inactives.

Requête expliquée :

GET [BASE]/Organization

Description du scénario : Un consommateur souhaite récupérer les entités géographiques ainsi que leurs entités juridiques de rattachement.

Requête expliquée :

GET [BASE]/Organization?_include=Organization:partof #inclus les entités juridiques (partOf) rattachées à chaque entité géographique

Description du scénario : Un consommateur souhaite récupérer les organisations ainsi que les offres (HealthcareService) qu’elles portent.

Requête expliquée :

GET [BASE]/Organization?_revinclude=HealthcareService:organization #inclus les HealthcareService qui référencent l'Organization

Description du scénario : Un consommateur souhaite récupérer les organisations ainsi que les rôles professionnels (PractitionerRole) qui leur sont rattachés.

Requête expliquée :

GET [BASE]/Organization?_revinclude=PractitionerRole:organization #inclus les PractitionerRole qui référencent l'Organization

Exemples de code :

curl -H "Authorization: Bearer {{access_token}}" \
     -H "Ror-Profil-Utilisateur-Code: {{profil_code}}" \
     -H "Ror-Profil-Utilisateur-System: {{profil_system}}" \
     -H "Ror-Role-Metier-Code: {{role_code}}" \
     -H "Ror-Role-Metier-System: {{role_system}}" \
     "{{BASE}}/Organization"

// client HAPI FHIR configuré avec l'access_token et les headers Ror-* (voir la page "Consommation des API FHIR")
IGenericClient client = FhirTestUtils.createRorClient();

Bundle bundle = client.search()
        .forResource(Organization.class)
        .returnBundle(Bundle.class)
        .execute();

for (BundleEntryComponent entry : bundle.getEntry()) {
    Organization organization = (Organization) entry.getResource();
    logger.info("Organization found: id={} name={}", organization.getIdElement().getIdPart(), organization.getName());
}

import requests

base_url = "{{BASE}}/Organization"
headers = {
    "Authorization": f"Bearer {{access_token}}",
    "Ror-Profil-Utilisateur-Code": "{{profil_code}}",
    "Ror-Profil-Utilisateur-System": "{{profil_system}}",
    "Ror-Role-Metier-Code": "{{role_code}}",
    "Ror-Role-Metier-System": "{{role_system}}",
}

response = requests.get(base_url, headers=headers)
response.raise_for_status()
bundle = response.json()
for entry in bundle.get("entry", []):
    organization = entry["resource"]
    print(f"Organization found: id={organization['id']} name={organization.get('name')}")

2 Rechercher par numéro FINESS (identifier)

Description du scénario : Un consommateur souhaite récupérer une organisation à partir de son numéro FINESS.

Exemple : Recherche de l’organisation dont le numéro FINESS est 750000001.

Requête expliquée :

GET [BASE]/Organization?identifier=750000001 #critère de recherche sur le numéro FINESS

Description du scénario : Un consommateur souhaite récupérer une organisation à partir de son numéro FINESS, ainsi que son entité juridique de rattachement.

Exemple : Recherche de l’organisation dont le numéro FINESS est 1290004324, avec inclusion de l’entité juridique parente.

Requête expliquée :

GET [BASE]/Organization?identifier=1290004324 #critère de recherche sur le numéro FINESS
&_include=Organization:partof #inclus l'entité juridique (partOf) de rattachement

Exemples de code :

curl -H "Authorization: Bearer {{access_token}}" \
     -H "Ror-Profil-Utilisateur-Code: {{profil_code}}" \
     -H "Ror-Profil-Utilisateur-System: {{profil_system}}" \
     -H "Ror-Role-Metier-Code: {{role_code}}" \
     -H "Ror-Role-Metier-System: {{role_system}}" \
     "{{BASE}}/Organization?identifier=750000001"

IGenericClient client = FhirTestUtils.createRorClient();

TokenClientParam identifierParam = new TokenClientParam("identifier");

Bundle bundle = client.search()
        .forResource(Organization.class)
        .where(identifierParam.exactly().code("750000001"))
        .returnBundle(Bundle.class)
        .execute();

for (BundleEntryComponent entry : bundle.getEntry()) {
    Organization organization = (Organization) entry.getResource();
    logger.info("Organization found: id={} finess={}", organization.getIdElement().getIdPart(), organization.getIdentifierFirstRep().getValue());
}

import requests

base_url = "{{BASE}}/Organization"
headers = {
    "Authorization": f"Bearer {{access_token}}",
    "Ror-Profil-Utilisateur-Code": "{{profil_code}}",
    "Ror-Profil-Utilisateur-System": "{{profil_system}}",
    "Ror-Role-Metier-Code": "{{role_code}}",
    "Ror-Role-Metier-System": "{{role_system}}",
}
params = {"identifier": "750000001"}

response = requests.get(base_url, headers=headers, params=params)
response.raise_for_status()
bundle = response.json()
for entry in bundle.get("entry", []):
    organization = entry["resource"]
    print(f"Organization found: id={organization['id']} finess={organization['identifier'][0]['value']}")

3 Rechercher par raison sociale (name)

Description du scénario : Un consommateur souhaite rechercher les organisations dont la raison sociale contient une chaîne de caractères donnée, sans en connaître le nom exact.

Exemple : Recherche des organisations dont la raison sociale, la dénomination ou le nom d’organisation interne contient « chu » (recherche non sensible à la casse).

Requête expliquée :

GET [BASE]/Organization?name:contains=chu #critère de recherche sur une partie de la raison sociale, insensible à la casse

Description du scénario : Un consommateur souhaite récupérer une organisation à partir de sa raison sociale exacte.

Exemple : Recherche de l’organisation dont le nom correspond exactement à « Centre Hospitalier Universitaire de Nantes ».

Requête expliquée :

GET [BASE]/Organization?name=Centre Hospitalier Universitaire de Nantes #critère de recherche sur la raison sociale exacte

Exemples de code :

curl -H "Authorization: Bearer {{access_token}}" \
     -H "Ror-Profil-Utilisateur-Code: {{profil_code}}" \
     -H "Ror-Profil-Utilisateur-System: {{profil_system}}" \
     -H "Ror-Role-Metier-Code: {{role_code}}" \
     -H "Ror-Role-Metier-System: {{role_system}}" \
     "{{BASE}}/Organization?name:contains=chu"

IGenericClient client = FhirTestUtils.createRorClient();

StringClientParam nameParam = new StringClientParam("name");

Bundle bundle = client.search()
        .forResource(Organization.class)
        .where(nameParam.contains().value("chu"))
        .returnBundle(Bundle.class)
        .execute();

for (BundleEntryComponent entry : bundle.getEntry()) {
    Organization organization = (Organization) entry.getResource();
    logger.info("Organization found: id={} name={}", organization.getIdElement().getIdPart(), organization.getName());
}

import requests

base_url = "{{BASE}}/Organization"
headers = {
    "Authorization": f"Bearer {{access_token}}",
    "Ror-Profil-Utilisateur-Code": "{{profil_code}}",
    "Ror-Profil-Utilisateur-System": "{{profil_system}}",
    "Ror-Role-Metier-Code": "{{role_code}}",
    "Ror-Role-Metier-System": "{{role_system}}",
}
params = {"name:contains": "chu"}

response = requests.get(base_url, headers=headers, params=params)
response.raise_for_status()
bundle = response.json()
for entry in bundle.get("entry", []):
    organization = entry["resource"]
    print(f"Organization found: id={organization['id']} name={organization.get('name')}")

4 Rechercher par date de mise à jour (_lastUpdated)

Description du scénario : Un consommateur souhaite récupérer toutes les organisations mises à jour depuis une certaine date, afin de synchroniser son système d’information.

Exemple : Recherche des organisations mises à jour depuis le 1er juin 2026 (inclus) jusqu’à aujourd’hui.

Requête expliquée :

GET [BASE]/Organization?_lastUpdated=ge2026-06-01 #critère de recherche sur la date de mise à jour (ge = greater or equal)

Description du scénario : Un consommateur souhaite récupérer toutes les organisations mises à jour sur une période donnée.

Exemple : Recherche des organisations mises à jour entre le 1er et le 30 juin 2026.

Requête expliquée :

GET [BASE]/Organization?_lastUpdated=ge2026-06-01 #borne basse de la période (ge = greater or equal)
&_lastUpdated=le2026-06-30 #borne haute de la période (le = less or equal)

Exemples de code :

curl -H "Authorization: Bearer {{access_token}}" \
     -H "Ror-Profil-Utilisateur-Code: {{profil_code}}" \
     -H "Ror-Profil-Utilisateur-System: {{profil_system}}" \
     -H "Ror-Role-Metier-Code: {{role_code}}" \
     -H "Ror-Role-Metier-System: {{role_system}}" \
     "{{BASE}}/Organization?_lastUpdated=ge2026-06-01"

IGenericClient client = FhirTestUtils.createRorClient();

DateClientParam lastUpdatedParam = new DateClientParam("_lastUpdated");

Bundle bundle = client.search()
        .forResource(Organization.class)
        .where(lastUpdatedParam.afterOrEquals().day("2026-06-01"))
        .returnBundle(Bundle.class)
        .execute();

for (BundleEntryComponent entry : bundle.getEntry()) {
    Organization organization = (Organization) entry.getResource();
    logger.info("Organization found: id={} lastUpdated={}", organization.getIdElement().getIdPart(), organization.getMeta().getLastUpdated());
}

import requests

base_url = "{{BASE}}/Organization"
headers = {
    "Authorization": f"Bearer {{access_token}}",
    "Ror-Profil-Utilisateur-Code": "{{profil_code}}",
    "Ror-Profil-Utilisateur-System": "{{profil_system}}",
    "Ror-Role-Metier-Code": "{{role_code}}",
    "Ror-Role-Metier-System": "{{role_system}}",
}
params = {"_lastUpdated": "ge2026-06-01"}

response = requests.get(base_url, headers=headers, params=params)
response.raise_for_status()
bundle = response.json()
for entry in bundle.get("entry", []):
    organization = entry["resource"]
    print(f"Organization found: id={organization['id']} lastUpdated={organization['meta']['lastUpdated']}")

5 Rechercher par type / catégorie d’établissement (type)

Description du scénario : Un consommateur souhaite récupérer les entités géographiques appartenant à une catégorie d’établissement donnée.

Exemple : Recherche des entités géographiques dont la catégorie d’établissement est « 101 - Centre Hospitalier Régional (C.H.R.) ».

Requête expliquée :

GET [BASE]/Organization?type=https://mos.esante.gouv.fr/NOS/TRE_R66-CategorieEtablissement/FHIR/TRE-R66-CategorieEtablissement|101 #critère de recherche sur la catégorie d'établissement

Description du scénario : Un consommateur souhaite récupérer les organisations internes dont le type correspond à un mode de prise en charge donné.

Exemple : Recherche des organisations internes dont le type correspond au mode de prise en charge « 032 - Consultation ».

Requête expliquée :

GET [BASE]/Organization?type=https://mos.esante.gouv.fr/NOS/TRE_R213-ModePriseEnCharge/FHIR/TRE-R213-ModePriseEnCharge|032 #critère de recherche sur le type d'organisation interne

Exemples de code :

curl -H "Authorization: Bearer {{access_token}}" \
     -H "Ror-Profil-Utilisateur-Code: {{profil_code}}" \
     -H "Ror-Profil-Utilisateur-System: {{profil_system}}" \
     -H "Ror-Role-Metier-Code: {{role_code}}" \
     -H "Ror-Role-Metier-System: {{role_system}}" \
     "{{BASE}}/Organization?type=https://mos.esante.gouv.fr/NOS/TRE_R66-CategorieEtablissement/FHIR/TRE-R66-CategorieEtablissement%7C101"

IGenericClient client = FhirTestUtils.createRorClient();

TokenClientParam typeParam = new TokenClientParam("type");

Bundle bundle = client.search()
        .forResource(Organization.class)
        .where(typeParam.exactly().systemAndCode(
                "https://mos.esante.gouv.fr/NOS/TRE_R66-CategorieEtablissement/FHIR/TRE-R66-CategorieEtablissement",
                "101"))
        .returnBundle(Bundle.class)
        .execute();

for (BundleEntryComponent entry : bundle.getEntry()) {
    Organization organization = (Organization) entry.getResource();
    logger.info("Organization found: id={} name={}", organization.getIdElement().getIdPart(), organization.getName());
}

import requests

base_url = "{{BASE}}/Organization"
headers = {
    "Authorization": f"Bearer {{access_token}}",
    "Ror-Profil-Utilisateur-Code": "{{profil_code}}",
    "Ror-Profil-Utilisateur-System": "{{profil_system}}",
    "Ror-Role-Metier-Code": "{{role_code}}",
    "Ror-Role-Metier-System": "{{role_system}}",
}
params = {
    "type": "https://mos.esante.gouv.fr/NOS/TRE_R66-CategorieEtablissement/FHIR/TRE-R66-CategorieEtablissement|101",
}

response = requests.get(base_url, headers=headers, params=params)
response.raise_for_status()
bundle = response.json()
for entry in bundle.get("entry", []):
    organization = entry["resource"]
    print(f"Organization found: id={organization['id']} name={organization.get('name')}")

6 Rechercher par région source (_tag)

Description du scénario : Un consommateur souhaite récupérer toutes les organisations dont la donnée provient d’une région source donnée.

Exemple : Recherche des organisations dont la région source de la donnée est « 11 - Île-de-France ».

Requête expliquée :

GET [BASE]/Organization?_tag=https://mos.esante.gouv.fr/NOS/TRE_R30-RegionOM/FHIR/TRE-R30-RegionOM|11 #critère de recherche sur la région source de la donnée

Description du scénario : Un consommateur souhaite récupérer les organisations d’une catégorie d’établissement donnée, sur une région source donnée.

Exemple : Recherche des organisations de la région « 52 - Pays de la Loire » dont la catégorie d’établissement est « 101 - Centre Hospitalier Régional (C.H.R.) ».

Requête expliquée :

GET [BASE]/Organization?_tag=https://mos.esante.gouv.fr/NOS/TRE_R30-RegionOM/FHIR/TRE-R30-RegionOM|52 #critère de recherche sur la région source de la donnée
&type=https://mos.esante.gouv.fr/NOS/TRE_R66-CategorieEtablissement/FHIR/TRE-R66-CategorieEtablissement|101 #critère de recherche sur la catégorie d'établissement

Exemples de code :

curl -H "Authorization: Bearer {{access_token}}" \
     -H "Ror-Profil-Utilisateur-Code: {{profil_code}}" \
     -H "Ror-Profil-Utilisateur-System: {{profil_system}}" \
     -H "Ror-Role-Metier-Code: {{role_code}}" \
     -H "Ror-Role-Metier-System: {{role_system}}" \
     "{{BASE}}/Organization?_tag=https://mos.esante.gouv.fr/NOS/TRE_R30-RegionOM/FHIR/TRE-R30-RegionOM%7C11"

IGenericClient client = FhirTestUtils.createRorClient();

TokenClientParam tagParam = new TokenClientParam("_tag");

Bundle bundle = client.search()
        .forResource(Organization.class)
        .where(tagParam.exactly().systemAndCode(
                "https://mos.esante.gouv.fr/NOS/TRE_R30-RegionOM/FHIR/TRE-R30-RegionOM",
                "11"))
        .returnBundle(Bundle.class)
        .execute();

for (BundleEntryComponent entry : bundle.getEntry()) {
    Organization organization = (Organization) entry.getResource();
    logger.info("Organization found: id={} name={}", organization.getIdElement().getIdPart(), organization.getName());
}

import requests

base_url = "{{BASE}}/Organization"
headers = {
    "Authorization": f"Bearer {{access_token}}",
    "Ror-Profil-Utilisateur-Code": "{{profil_code}}",
    "Ror-Profil-Utilisateur-System": "{{profil_system}}",
    "Ror-Role-Metier-Code": "{{role_code}}",
    "Ror-Role-Metier-System": "{{role_system}}",
}
params = {
    "_tag": "https://mos.esante.gouv.fr/NOS/TRE_R30-RegionOM/FHIR/TRE-R30-RegionOM|11",
}

response = requests.get(base_url, headers=headers, params=params)
response.raise_for_status()
bundle = response.json()
for entry in bundle.get("entry", []):
    organization = entry["resource"]
    print(f"Organization found: id={organization['id']} name={organization.get('name')}")