Essais CLiniques Accessibles Interconnectés pour la Recherche ouverts à l'Ecosystème
0.3.0 - trial-use France flag

Essais CLiniques Accessibles Interconnectés pour la Recherche ouverts à l'Ecosystème - Local Development build (v0.3.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Recherche des essais cliniques sur critères

Description

Un consommateur recherche des essais cliniques à partir de critères de recherche.

Le SI répond au consommateur les essais cliniques correspondant aux critères de recherche et les ressources liées.

ConsommateurConsommateurECLAIREECLAIRERequête : Critères de rechercheRéponse : Essais cliniques + ressources liées

Caractéristiques de l’API

Endpoint

 

Header

Content-type :=Json + FHIR

Encodage

 

Version FHIR

4.0.0

Version package

 

Publication

 

Construction de la requête de base

Interaction FHIR

Search

Méthode http associée

GET

Ressource recherchée

ResearchStudy

Construction requête de base

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

Construction de la réponse de base

Réponse de base – Succès

Lien vers la spécification FHIR : http://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 ResearchStudy corespondant aux critères de recherche plus les ressources incluses correspondant aux critères de recherche. Le service développé renvoie par défaut les 20 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. Le nombre de résultats renvoyés peut être modifié en utilisant le modificateur de requête _count, avec une valeur maximale de 5000.

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 : http://hl7.org/fhir/R4/http.html

Réponse de base – Echec

Lien vers la spécification FHIR : http://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 : http://hl7.org/fhir/R4/http.html

Critères de recherche

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

status

identifier

Paramètres et modificateurs de requêtes FHIR

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

  • _include
  • _count, _sort
  • _content, _text
  • Tous les prefixes de comparaison

Exemple de requêtes

Scénario 1 : Recherche des essais cliniques selon le statut

Description du scénario : Un consommateur cherche les essais cliniques ayant pour statut = “active”.

Requête :

GET [BASE]/ResearchStudy?status=http://hl7.org/fhir/ValueSet/research-study-status|active&_include=ResearchStudy:site&_include=ResearchStudy:sponsor&_include=ResearchStudy:enrollment

Requête expliquée :

GET [BASE]/ResearchStudy?status=http://hl7.org/fhir/R4/ValueSet/research-study-status|active # Critère de recherche sur le statut
&_include=ResearchStudy:site # Inclus les Location référencées par ResearchStudy
&_include=ResearchStudy:sponsor # Inclus les Organization référencées par ResearchStudy
&_include=ResearchStudy:enrollment # Inclus les Group référencés par ResearchStudy

Scénario 2 : Recherche d’un essai clinique à partir de son identifiant

Description du scénario : Un consommateur souhaite rechercher un essai clinique à partir de son identifiant = XXX.

Requête :

GET [BASE]/ResearchStudy?identifier=XXX&_include=ResearchStudy:site&_include=ResearchStudy:sponsor&_include=ResearchStudy:enrollment

Requête expliquée :

GET [BASE]/ResearchStudy?identifier=XXX # Critère de recherche de l’identifiant de l'essai
&_include=ResearchStudy:site # Inclus les Location référencées par ResearchStudy
&_include=ResearchStudy:sponsor # Inclus les Organization référencées par ResearchStudy
&_include=ResearchStudy:enrollment # Inclus les Group référencés par ResearchStudy