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

Consultation d’anomalie

Cette partie de la spécification est en cours de construction.

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

Task

Construction requête de base

GET [base]/Task{?[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/http.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.

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-location applicables à ce cas d’usage sont :

_tag

 

 

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

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

_tag

identifier

type

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

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

_tag

identifier

 

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

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

_tag

 

 

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

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

_tag

 

 

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

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

_lastUpdated*

identifier*

focus*

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

Paramètres et modificateurs de requêtes FHIR

Dans ce cas d’usage, nous n’utilisons aucun paramètres et modificateurs de requêtes décrits au paragraphe dédié.

Exemple de requêtes

Scénario 1 : Consultation du statut d’une anomalie

Description du scénario : un responsable qualité où le moteur de règle souhaite consulter le statut d’une anomalie dont l’identifiant est XXX.

Requête :

GET [BASE]/Task?identifier=XXX

Requête expliquée :

GET [BASE]/Task?identifier=XXX #critère de recherche sur l’identifiant de l’anomalie

Scénario 2 : Consultation de la liste des anomalies

Description du scénario : un responsable qualité décide d’inactiver une anomalie dont l’identifiant technique = XXX (elle a été saisie par erreur par exemple) en mettant à jour son statut métier à YYY.

Requête :

GET [BASE]/Task?focus:HealthcareService:identifier=XXX

Requête expliquée :

GET [BASE]/Task?focus:HealthcareService.identifier=XXX #critère de recherche sur l’identifiant de l’élément référencé par l’anomalie

Scénario 3 : Consultation de la liste des anomalies sur un périmètre

Description du scénario : un responsable qualité souhaite consulter la liste des anomalies sur son périmètre : région = XXX.

Requête :

GET [BASE]/Task?focus:[Ressource]:_tag= https://mos.esante.gouv.fr/NOS/TRE_R30-RegionOM/FHIR/TRE-R30-RegionOM|XXX

Requête expliquée : Exemple avec HealthcareService :

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

Scénario 4 : Consommation de toutes les anomalies

Description du scénario : le BI consomme toutes les anomalies pour faire des tableaux de suivi.

Requête :

GET [BASE]/Task

Requête expliquée :

GET [BASE]/Task #recherche sans critère pour récupérer toutes les anomalies