Beschrijving
Zoekbewerkingen doorlopen bestaande resources die gefilterd worden op parameters die met een zoekbewerking meegeleverd kunnen worden. De volgende FHIR zoekkaders zijn van belang voor de verschillende Koppeltaal portalen om gegeven op een ordelijke en duidelijke manier aan de gebruikers te kunnen presenteren.
Naast de veelgebruikte FHIR zoekkaders op deze pagina, kan men ook meer complexe zoekbewerkingen uitvoeren. Zie verschillende FHIR voorbeelden op https://www.hl7.org/fhir/search.html.
Overwegingen
FHIR biedt een duidelijke beschrijving van de search API. Koppeltaal gebruikt deze specificaties met enkele aanpassingen in:
- wat er ondersteund wordt,
- wat er binnen Koppeltaal verplicht is,
- toevoegingen op de standaard.
Toepassing en restricties
Ondersteunde search parameters overzicht
| Parameters for all resources | Search result parameters | Search result parameters NIET ondersteund | Custom search result parameters |
|---|---|---|---|
_id | _sort | _include | _offset |
_lastUpdated | _count | _revinclude | |
_tag | _summary | _contained | |
_profile | _total | _containedType | |
_security | _elements | ||
_text | |||
_content | |||
_list | |||
_has | |||
_type |
...
| Info |
|---|
Let op: Een aantal van de bovenstaande search result parameters worden NIET ondersteund. Dit vanwege extra complexiteit i.c.m. het autorisatiemodel. |
Paging
De FHIR Resource Provider MOET paging ondersteunen voor de resultaten van een zoek- of geschiedenis interactie en voldoen aan de methode (gespecificeerd in RFC 5005 - Feed Paging and Archiving) voor het verzenden van vervolg-links naar de applicatie-instantie bij het retourneren van een Bundle resource (bijv. geschiedenis en zoeken). Als de server dit niet doet, is er geen manier om door te gaan met oproepen.
...
Je kan vervolgens met gebruik van de aangeboden URL's in de Bundle van first, previous, next en last door de verschillende Task resource instanties heen navigeren.
_summary
Er worden GEEN Koppeltaal-specifieke velden toegevoegd aan de _summary search resultaten. Dit houdt dus in dat _summary enkel een summary geeft van de velden die als zodanig gemarkeerd zijn door FHIR zelf.
Veelgebruikte functionaliteit uit de standaard
Sorteren
FHIR ondersteunt sorteren volgens een specifieke set regels.
...
https://koppeltaal.nl/Patient?_sort=given
Limiting
FHIR ondersteunt Page Count. Het aantal te retourneren zoekresultaten kan worden doorgegeven.
...
https://koppeltaal.nl/Patient?_count=10
Functionaliteit toegevoegd op de standaard
Custom _offset search result parameter.
Koppeltaal ondersteunt paging m.b.v. een _offset zoekparameter. Deze annotatie maakt geen deel uit van de FHIR-standaard.
...
https://koppeltaal.nl/Patient?identifier=urn:foo|123&_count=10&_offset=10
Search Narrowing
Search Narrowing wordt automatisch toegepast door de FHIR resource service en zorgt er voor dat applicatie-instanties enkel resources verkrijgen waartoe deze geautoriseerd is. Zie Rollen en rechten voor applicatie-instanties voor meer informatie
Custom SearchParameters
Een SearchParameter is een FHIR resource zoals andere FHIR resources. Deze resource zorgt er voor dat extra velden in de database geïndexeerd worden, zodat hier op gezocht kan worden. De SearchParameter geeft in een simplistische uitleg aan waar in de Resource(s) op gezocht kan worden en middels welke query parameter dit aangeroepen kan worden. Standaard biedt FHIR een hoop SeachParameters aan die te gebruiken zijn in de FHIR resource provider. In het geval van Koppeltaal, MOETEN de volgende SearchParameters worden toegevoegd door de aanbieder van de FHIR resource provider:
...
https://koppeltaal.nl/Patient?resource-origin=Device/4507fa63-7cfd-4d1e-8389-7598b8e24de0
Links naar gerelateerde onderwerpen
| Beschrijving | Link |
|---|---|
| FHIR search specificatie | https://www.hl7.org/fhir/r4/search.html |
| FHIR paginatie | https://www.hl7.org/fhir/r4/http.html#paging |
FHIR SearchParameter | https://www.hl7.org/fhir/r4/searchparameter.html |
...