...
Koppeltaal maakt gebruik van een FHIR resource service. Deze service kan middels de FHIR RESTful API specificaties benaderd worden. Applicaties in een domein (applicatie-instanties) kunnen na authenticatie [TODO: LINK] communiceren met de FHIR resource service. [TODO: LINK] Geautoriseerde applicatie-instanties kunnen vervolgens deze informatie ophalen en waar nodig (en mogelijk) bijwerken. De resources dienen op een eenduidige manier aangemaakt en uitgewisseld te worden. Zo kunnen applicaties in het domein eenduidig goed samenwerken. Ook moeten er uitbreidingen op de standaard gemaakt worden om bijvoorbeeld geautomatiseerd te voldoen aan wetgeving.
...
Om te waarborgen dat iedereen dezelfde taal spreekt, en alle benodigde informatie voor iedereen aanwezig is, vereist Koppeltaal het gebruik van profielen. Elk toegestane resource heeft een eigen profiel. Een profiel gebruikt een StructureDefinition resource als datastructuur. Deze resource beschrijft welke eigenschappen een Resource resource heeft, en bijvoorbeeld ook wat de kardinaliteit van elk veld is. De officiële Koppeltaal profielen zijn hier te vinden: https://simplifier.net/Koppeltaalv2.0/~resources?category=Profile&fhirVersion=R4.
...
Deze URI moet meegegeven worden aan de Resource.meta.profile array. Aangezien de StructureDefinition aangeeft waar een Resource aan moet voldoen, wordt dit gebruikt om de Resources te valideren. Zie TOP-KT-010 voor meer informatie over de validatie.
FHIR RESTful API
De FHIR RESTful API biedt een groot scala aan functionaliteiten. Vaak bevat deze ook optionele implementaties. Binnen Koppeltaal is gekozen wat wel en niet ondersteund wordt:
| Instance Level Interactions |
|---|
| Ondersteund | Remark | ||
|---|---|---|---|
| read | Read the current state of the resource | ✓ | |
| conditional read | Read the current state of the resource if modified since of matches ETag | ✓ | |
| vread | Read the state of a specific version of the resource | ✓ | |
| update | Update an existing resource by its id (or create it if it is new) | ⚠ | If-Match header verplicht |
| conditional update | Allows a client to update an existing resource based on some identification criteria | ⚠ | Trial use fase |
| patch | Update an existing resource by posting a set of changes to it | ✓ | |
| conditional patch | Allows a client to patch an existing resource based on some identification criteria | ⚠ | Trial use fase |
| delete | Delete a resource | ⚠ | Gebruik maken van status |
| conditional delete | Allows a client to delete an existing resource based on some selection criteria | ⚠ | Trial use fase |
| history | Retrieve the change history for a particular resource | ✓ | |
| Type Level Interactions | |||
| create | Create a new resource with a server assigned id | ✓ | |
| conditional create | Allows a client to create a new resource only if some equivalent resource does not already exist on the server. | ⚠ | Trial use fase |
| search | Search the resource type based on some filter criteria | ⚠ | Geen _include, _revinclude, _contained en _containedType search result parameters |
| search paging | Support paging for the results of a search or history interaction | ✓ | |
| history | Retrieve the change history for a particular resource type | ✓ | |
| Whole System Interactions | |||
| capabilities | Get a capability statement for the system | ✓ | |
| batch/transaction | Update, create or delete a set of resources in a single interaction | ✗ | |
| history | Retrieve the change history for all resources | ✗ | |
| search | Search across all resource types based on some filter criteria | ✗ |
Mime-Type
Ook is er een keuze gemaakt welke MIME-types worden ondersteund:
| MIME-type | Geïmplementeerd | Remark |
|---|---|---|
| application/fhir+json | ✓ | Heeft de voorkeur |
| application/fhir+xml | ✓ | |
| application/fhir+turtle | ✗ |
De voorkeur voor application/fhir+json heeft te maken met de xsd schema’s voor de xml validatie. Deze dwingt een specifieke volgorde af. Dit is voor FHIR libraries die de data serializeren naar xml geen probleem. Echter, voor het zelf samenstellen van de payload is dit een lastigheid.
...
Deze functionaliteiten zijn in de “trial use” fase. Dit houdt in dat het beproefd wordt. De implementatie wordt geëvalueerd en in een toekomstige versie pas gereviewed. Er is dus een grote kans dat deze functionaliteiten in de toekomst anders zullen gaan werken. Wel zijn deze functionaliteiten geïmplementeerd. Maak enkel gebruik van deze functionaliteiten indien er bereidheid is hier later aanpassingen in door te voeren.
Eisen
| Eis | Applicatie-instantie | FHIR Resource service |
|---|---|---|
| Alle FHIR resource service interacties zijn gebaseerd op FHIR RESTful API | X | X |
| Een PUT en een PATCH MOET een If-Match header bevatte | X | X |
| Een POST, PUT en PATCH MOET een Koppeltaal profiel als Resource.meta.profile gezet hebben | X | X |
| Een POST, PUT en PATCH MOET gevalideerd worden middels het Koppeltaal profiel | X | |
| Er is GEEN ondersteuning voor batch/transaction | X | |
| Er is GEEN ondersteuning voor een “whole system history“ | X | |
| Er is GEEN ondersteuning voor een “whole system search“ | X | |
Er is GEEN ondersteuning voor het application/fhir+turtle MIME-type | X | X |
| De $expunge operation MOET geïmplementeerd worden, en MOET op Resource instance-level plaatsvinden | X | |
StructureDefinition resources worden ALLEEN door Koppeltaal beheerd | X |
Links naar gerelateerde onderwerpen
| Beschrijving | Link | Opmerking |
|---|---|---|
| FHIR RESTful API documentatie | https://www.hl7.org/fhir/r4/http.html | |
| FHIR concurrency met If-Match | https://www.hl7.org/fhir/r4/http.html#concurrency | |
| If-Match enforce code voorbeeld | https://github.com/Koppeltaal/Koppeltaal-2.0-FHIR-HAPI-Server/blob/master/src/main/java/ca/uhn/fhir/jpa/starter/koppeltaal/interceptor/EnforceIfMatchHeaderInterceptor.java | Deze code filtert ook Bundles. Deze worden binnen Koppeltaal niet gebruikt. |
| Voorbeelden van alle Resources in JSON en XML | https://simplifier.net/Koppeltaalv2.0/~resources?category=Example&fhirVersion=R4 | |
| FHIR search specificatie | https://www.hl7.org/fhir/r4/search.html | |
| FHIR paginatie | https://www.hl7.org/fhir/r4/http.html#paging |