Répertoire national de l’Offre et des Ressources en santé et accompagnement médico-social
0.1.1 - STU

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

Recherche d'offre avec données capacitaires

Caractéristiques de l’API

Endpoint

 

Header

Content-type :=Json + FHIR

Encodage

 

Version FHIR

 

Version package

 

Publication

 

Construction de la requête de base

Interaction FHIR

Search[1]

Méthode http associée

GET

Ressource recherchée

HealthcareService

Construction requête de base

GET [base]/HealthcareService{?[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 HealthcareService 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, définis au paragraphe dédié, de StructureDefinition-ror-healthcareservice applicables à ce cas d’usage sont :

identifier
  • Les critères de recherche, définis au paragraphe dédié, de StructureDefinition-ror-location applicables à ce cas d’usage sont :

address-postalcode

capacity-type

type

adress-city

equipment-type

residential-type

additional-bed-type

equipment-feature

residential-number

crisis-type

gender-capacity-available

temporary-assignement

capacity-closing-type

limit-value

_lastUpdated

capacity-update-date*

temporality-capacity

 

*Critères de recherche qui seront applicables ultérieurement

Ces critères de recherche sont applicables à la ressource HealthcareService, grâce au chainage. Pour cela utiliser la syntaxe suivante : location.[NOM CRITERE]

  • Les critères de recherche, définis au paragraphe dédié, de StructureDefinition-ror-task applicables à ce cas d’usage sont :

business-status*

_id

_lastUpdated*

Identifier*

authored-on*

 

*Critères de recherche qui seront applicables ultérieurement

Ces critères de recherche sont applicables à la ressource HealthcareService, grâce au chainage inversé. Pour cela utiliser la syntaxe suivante : _has:HealthcareService:focus:[NOM CRITERE]

Paramètres et modificateurs de requêtes FHIR

Tous les paramètres et modificateurs de requêtes décrits au paragraphe dédié sont applicables à ce cas d’usage.

Exemple de requêtes

Scénario 1 : Recherche sur un critère capacitaire #1

Description du scénario : un consommateur cherche les offres proposant une activité opérationnelle = XXX et disposant d'un lit disponible = 02 (TRE-R330-StatutCapacite) et disposant d’un nombre de lits supérieur à 0.

Requête :

GET [BASE]/HealthcareService?speciality=https://mos.esante.gouv.fr/NOS/TRE_R211-ActiviteOperationnelle/FHIR/TRE-R211-ActiviteOperationnelle|XXX&location.capacity-status= https://mos.esante.gouv.fr/NOS/TRE_R330-StatutCapacite/FHIR/TRE-R330-StatutCapacite|02&location.nb-capacity=gt0&_revinclude=Location:healthcareservice

Requête expliquée :

GET [BASE]/HealthcareService?speciality=https://mos.esante.gouv.fr/NOS/TRE_R211-ActiviteOperationnelle/FHIR/TRE-R211-ActiviteOperationnelle|XXX #critère de recherche sur l’activité opérationnelle
&location.capacity-status= https://mos.esante.gouv.fr/NOS/TRE_R330-StatutCapacite/FHIR/TRE-R330-StatutCapacite|02 #critère de recherche sur la disponibilité d’un lit
&location.nb-capacity=gt0 #critère de recherche sur quantité de lits disponibles
&_include=Healthcareservice:location  #inclus les Location qui sont référencés par les HealthcareService

Scénario 2 : Recherche un critère capacitaire #2

Description du scénario : un consommateur cherche les offres proposant une activité opérationnelle = XXX et disposant d'un lit réouvrable = 01 (TRE-R333-TypeFermetureCapacite) et disposant d’un lit fermé = 05 (TRE-R330-TypeStatutCapacite) et disposant d’un nombre de lits supérieur à 0.

Requête :

GET [BASE]/HealthcareService?speciality=https://mos.esante.gouv.fr/NOS/TRE_R211-ActiviteOperationnelle/FHIR/TRE-R211-ActiviteOperationnelle|XXX&location.capacity-closing-type=https://mos.esante.gouv.fr/NOS/TRE_R333-TypeFermetureCapacite/FHIR/TRE-R333-TypeFermetureCapacite|01&location.capacity-status=https://mos.esante.gouv.fr/NOS/TRE_R330-TypeStatutCapacite/FHIR/TRE-R330-TypeStatutCapacite|05&location.nb-capacity=gt0&_ include=Healthcareservice:location

Requête expliquée :

GET [BASE]/HealthcareService?speciality=https://mos.esante.gouv.fr/NOS/TRE_R211-ActiviteOperationnelle/FHIR/TRE-R211-ActiviteOperationnelle|XXX #critère de recherche sur l’activité opérationnelle
&location.capacity-closing-type=https://mos.esante.gouv.fr/NOS/TRE_R333-TypeFermetureCapacite/FHIR/TRE-R333-TypeFermetureCapacite|01 #critère de recherche sur le lit réouvrable
&location.capacity-status=https://mos.esante.gouv.fr/NOS/TRE_R330-TypeStatutCapacite/FHIR/TRE-R330-TypeStatutCapacite|05 #critère de recherche sur le lit fermé
&location.nb-capacity=gt0 #critère de recherche sur quantité de lits disponibles
&_ include=Healthcareservice:location  #inclus les Location qui qui sont référencés par les HealthcareService

Scénario 3 : Recherche sur un critère de l’équipement

Description du scénario : un consommateur cherche une offre dont l’activité opérationnelle = chirurgie traumatologique (025 de TRE-R211-ActiviteOperationnelle) proposant un appareil de radiologie adapté à l'obésité du patient (83 de TRE-R212-Equipement).

Requête :

GET [BASE]/HealthcareService?speciality=https://mos.esante.gouv.fr/NOS/TRE_R211-ActiviteOperationnelle/FHIR/TRE-R211-ActiviteOperationnelle|025&location:equipment-type= https://mos.esante.gouv.fr/NOS/TRE_R212-Equipement/FHIR/TRE-R212-Equipement|83&_revinclude=Location:healthcareservice

Requête expliquée :

GET [BASE]/HealthcareService?speciality=https://mos.esante.gouv.fr/NOS/TRE_R211-ActiviteOperationnelle/FHIR/TRE-R211-ActiviteOperationnelle|XXX #critère de recherche sur l’activité opérationnelle
&location.capacity-closing-type=https://mos.esante.gouv.fr/NOS/TRE_R333-TypeFermetureCapacite/FHIR/TRE-R333-TypeFermetureCapacite|01 #critère de recherche sur le lit réouvrable
&location.capacity-status=https://mos.esante.gouv.fr/NOS/TRE_R330-TypeStatutCapacite/FHIR/TRE-R330-TypeStatutCapacite|05 #critère de recherche sur le lit fermé
&location.nb-capacity=gt0 #critère de recherche sur quantité de lits disponibles
&_ include=Healthcareservice:location  #inclus les Location qui qui sont référencés par les HealthcareService