Ressources

Modificateurs des résultats de recherche

Lien vers la spécification FHIR : https://hl7.org/FHIR/search.html#modifyingresults


Modificateurs des résultats de la recherche

Les modificateurs des résultats de recherche (ou Modifying Search Results) correspondent à des paramètres permettant de modifier les résultats affichés par une recherche.

Vous trouverez ci-dessous la liste des modificateurs de résultats de la recherche pris en charge dans notre contexte.

1) Paramètre _count

Il permet de contrôler le nombre maximal de ressources retournées sur une page lorsqu’une réponse de l’API est paginée. La réponse renvoie par défaut 50 éléments (ressources).

Requête:

GET [base]/Device?_count=10000
# Renvoie 10000 équipements matériels lourds

 

2) Paramètre _total

Ce paramètre indique le nombre total d’éléments qui correspondent aux critères de recherche. Ce paramètre peut prendre 3 valeurs :

  • none : le total n’est pas affiché
  • estimate : le total affiché est une estimation
  • accurate : le total affiché est précis

 

NOTE Le fait d’intégrer le paramètre _total dans la requête peut augmenter le temps de traitement de la requête.

 

Exemple de requête :

GET [base]/Device?_total=accurate
# Récupère le nombre total d'équipements matériels lourds.

 

Par défaut, l'affichage (ou non) du total dépend principalement du temps nécessaire à son calcul. Si le temps de calcul est trop important, le total ne sera pas inclus dans la réponse. Dans la majorité des cas, le total est affiché sauf dans certains cas particuliers, comme les recherches textuelles (champs de type string) sur de gros volumes de données. Par exemple, rechercher tous les PractitionerRole ayant un nom d'exercice contenant « Martin ».

3) Paramètre _include

Le paramètre _include permet d’afficher dans le résultat les ressources mères liées à la ressource fille. Les ressources mères sont récupérées à partir de la ressource fille.

Exemple de requête :

GET [base]/PractitionerRole?_include=PractitionerRole:organization
# Récupère les PractitionerRole ainsi que les organisations liées à ces PractitionerRole

 

4) Paramètre _revinclude

Le paramètre _revinclude permet d’afficher dans le résultat les ressources filles liées à la ressource mère. Les ressources filles sont récupérées à partir de la ressource mère.

Exemples:

GET [base]/Practitioner?_revinclude=PractitionerRole:practitioner
# Récupère les Practitioners et inclure également les PractitionerRole associées


GET [base]/Organization?_revinclude=Organization:partof
# Récupère les Entités géographiques (EG) et les Entités Juridiques (EJ) de rattachement

 

5) Paramètre _elements

Le paramètre _elements permet de préciser la liste d’attributs qui doit être retournée avec la ressource.

Exemples:

GET [base]/Practitioner?identifier=10001766123&_elements=name
# Récupère pour mon identifiant RPPS 10001766123 les informations liées à l'attribut name

GET [base]/PractitionerRole?_elements=telecom
# Récupère l'ensemble des PractitionerRole et n'affiche que les informations liées à l'attribut telecom (BAL MSS)

A noter que la réponse contient également une meta.tag valeur de SUBSETTED pour indiquer que tous les attributs de la ressource ne sont pas inclus.


...
                    "tag": [
                        {
                            "system": "http://terminology.hl7.org/CodeSystem/v3-ObservationValue",
                            "code": "SUBSETTED",
                            "display": "Resource encoded in summary mode"
                        }
                    ]
                },
                "identifier": [
                    {
                        "use": "official",
                        "type": {
                            "coding": [
                                {
                                    "system": "http://interopsante.org/CodeSystem/v2-0203",
                                    "code": "IDNPS"
                                }
                            ]
                        },
                        "system": "urn:oid:1.2.250.1.71.4.2.1",
                        "value": "810000001916"
                    },
                    {
                        "use": "official",
                        "type": {
                            "coding": [
                                {
                                    "system": "http://interopsante.org/CodeSystem/v2-0203",
                                    "code": "RPPS"
                                }
                            ]
                        },
                        "system": "http://rpps.fr",
                        "value": "10000001916"
                    }
                ],
                "active": true
...