Search FHIR

Répertoire national de l’Offre et des Ressources en santé et accompagnement médico-social
0.5.0 - trial-implementation France flag

This page is part of the Répertoire national de l’Offre et des Ressources en santé et accompagnement médico-social (v0.5.0: STU1) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Consultation des données capacitaires

Construction de la requête de base

Interaction FHIR

Search[1]

Méthode http associée

GET

Ressource recherchée

Location

Construction requête de base

GET [base]/Location{?[parameters]{&_format=[mime-type]}}

 

[1] https://www.hl7.org/fhir/R4/http.html#search et https://www.hl7.org/fhir/R4/http.html#general

Construction de la réponse de base

Réponse de base – Succès

Lien vers la spécification FHIR : https://www.hl7.org/fhir/R4/bundle.html

Si la recherche est un succès, le serveur répond :

  • Un header avec un code 200 OK HTTP

  • Un body contenant une ressource Bundle dont le type = searchset. Le bundle encapsule 0 à n ressources Location corespondant aux critères de recherche plus les ressources incluses correspondant aux critères de recherche. Le service développé renvoie les 200 premiers résultats et indique le total trouvé dans une balise total. Dans le cas où il n’y a pas de résultat le service renvoie total: 0.

Remarque : la recherche est un succès à partir du moment où la requête peut être exécutée. Il peut il y avoir 0 à n correspondances.

Plus de précision sur la spécification FHIR : https://www.hl7.org/fhir/R4/http.html

Réponse de base – Echec

Lien vers la spécification FHIR : https://www.hl7.org/fhir/R4/operationoutcome.html

Si la recherche échoue, le serveur doit répondre :

  • Un header avec un un code erreur HTTP 4XX ou 5XX

  • Un body contenant une ressource OperationOutcome qui donne les détails sur la raison de l’échec

Remarque : l’échec d’une recherche est la non-possibilité d’exécuter la requête, ce qui est différent d’aucune correspondance à la recherche. Plus de précision sur la spécification FHIR : https://www.hl7.org/fhir/R4/http.html

Critères de recherche

Les critères de recherche applicables sont définis sur la page dédiée pour :

En complément, vous pouvez accéder aux Capability Statements ici

Paramètres et modificateurs de requêtes FHIR

Les paramètres et modificateurs de requêtes sont décrits ici.

Exemples de requêtes

Scénario 1 : Données capacitaires sur le périmètre national

Description du scénario : Un consommateur souhaite mettre à jour toutes les données capacitaires sur le périmètre national.

Requête :

GET [BASE]/Location?_revinclude=HealthcareService:location

Requête expliquée :

GET [BASE]/Location?_revinclude=HealthcareService:location #inclus les HealthcareService qui référencent les Location

Scénario 1bis : Données capacitaires sur une région draft

Description du scénario : Un consommateur souhaite mettre à jour toutes les données capacitaires sur une région.

Exemple : Recherche des données capacitaires sur la région Bretagne (départements 22, 29, 35, 56).

Requête :

GET [BASE]/Location?_filter=(address-postalcode eq "22" or "29" or "35" or "36")&_revinclude=HealthcareService:location

Requête expliquée :

GET [BASE]/Location?_filter=(address-postalcode eq "22" or "29" or "35" or "36") #critère de recherche sur les codes postaux commencant par les valeurs choisies
&_revinclude=HealthcareService:location #inclus les HealthcareService qui référencent les Location

Scénario 1ter : Données capacitaires sur une région source

Description du scénario : un consommateur souhaite récupérer l'ensemble des données capacitaires sur une région source afin de mettre à jour son système. Par exemple, récupération des données capacitaires pour la région source « 52 – Pays de la Loire »

Requête :

GET [BASE]/Location?_tag=52&_revinclude=HealthcareService:location

Requête expliquée :

GET [BASE]/Location?_tag=52 #critère de recherche sur la region source
&_revinclude=HealthcareService:location #inclus les HealthcareService qui référencent les Location

Scénario 2 : Données capacitaires sur un lieu de prise en charge identifié

Description du scénario : Un consommateur souhaite mettre à jour dans son système les données de capacité sur un lieu de prise en charge identifié.

Exemple : Recherche des données capacitaires associées au lieu de prise en charge dont l’identifiant fonctionnel est 52/192675.

Requête :

GET [BASE]/Location?identifier=52/192675&_revinclude=HealthcareService:location

Requête expliquée :

GET [BASE]/Location?identifier=52/192675 #critère de recherche sur l’identifiant technique du lieu de prise en charge
&_revinclude=HealthcareService:location #inclus les HealthcareService qui référencent les Location

Scénario 3 : Données capacitaires sur plusieurs lieux de prise en charge identifiés

Description du scénario : Un consommateur souhaite mettre à jour dans son système les données de capacité en lits/places de certains lieux de prise en charge (il connait les identifiants et demande à lire la liste de ces données capacitaires).

Exemple : Recherche des données capacitaires des lieux de prise en charge ayant pour identifiants techniques 140 et 141.

Requête 1 :

GET [BASE]/Location?_id=140,141&_revinclude=HealthcareService:location

Requête 1 expliquée :

GET [BASE]/Location?_id=140,141 #critère de recherche sur l’identifiant technique du lieu de prise en charge
&_revinclude=HealthcareService:location #inclus les HealthcareService qui référencent les Location

Requête 2 (_filter) :

GET [BASE]/Location?_filter=(_id eq 140 or 141)&_revinclude=HealthcareService:location

Requête 2 expliquée :

GET [BASE]/Location?_filter=(_id eq 140 or 141) #critère de recherche sur l’identifiant technique du lieu de prise en charge
&_revinclude=HealthcareService:location #inclus les HealthcareService qui référencent les Location

Scénario 4 : Données capacitaires à partir d’une date de mise à jour

Description du scénario : Un consommateur souhaite mettre à jour dans son système les données capacitaires mises à jour dans le ROR national depuis une date qu’il précise.

Exemple : Recherche de toutes les informations capacitaires liées à une offre dont la date de mise à jour est supérieure ou égale au 02/08/2023.

Requête :

GET [BASE]/Location?_lastUpdated=ge2023-08-02&_revinclude=HealthcareService:location

Requête expliquée :

GET [BASE]/Location?_lastUpdated=ge2023-08-02 #critère de recherche sur la date de mise à jour/ge=greater or equal
&_revinclude=HealthcareService:location #inclus les HealthcareService qui référencent les Location

Scénario 5 : Données capacitaires d’une offre opérationnelle

Description du scénario : Un consommateur, ayant recherché au préalable une offre de santé correspondant à ses critères, souhaite connaitre la situation des capacités pour ces offres. Le service de recherche lui ayant renvoyé les identifiants de ces offres, il les passe en paramètre de la recherche.

Exemple : Recherche des informations capacitaires pour les lieux de réalisation de l’offre ayant un identifiant fonctionnel connu par l’instance ROR égale à 11/339772 ou 11/347254.

Requête 1 : GET [BASE]/Location?identifier=11/339772,11/347254&_revinclude=HealthcareService:location

Requête 1 expliquée :

GET [BASE]/Location?identifier=11/339772,11/347254 #critère de recherche sur l’identifiant fonctionnel de l’offre
&_revinclude=HealthcareService:location #inclus les HealthcareService qui référencent les Location

Requête 2 (_filter) :

GET [BASE]/Location?_filter=(identifier eq 11/339772 or 11/347254)&_revinclude=HealthcareService:location

Requête 2 expliquée :

GET [BASE]/Location?_filter=(identifier eq 11/339772 or 11/347254) #critère de recherche sur l’identifiant fonctionnel de l’offre
&_revinclude=HealthcareService:location #inclus les HealthcareService qui référencent les Location