• Definitief
    • Document toolboxDocument toolbox

    TOP-KT-002 - Basis interacties

    Owned by Peter Mulder
    Last updated: Sept 25, 2023 by Marcel SchrauwenVersion comment
    2 min read
    Version Date Comment
    Current Version (v. 4) Sept 25, 2023 10:35 Marcel Schrauwen:
    v1.0.2 - Hoofdpagina en eisen samengevoegd. Geen inhoudelijke wijzigingen.
    v. 3 Jul 11, 2023 16:57 Peter Mulder
    v. 2 Jul 05, 2023 09:28 Peter Mulder
    v. 1 Mar 29, 2023 09:33 Marcel Schrauwen

    Versie

    Datum

    Status

    Wijzigingen

    Versie

    Datum

    Status

    Wijzigingen

    1.0.2

    Jul 11, 2023

    definitief

    Deadlinks opgelost

    1.0.1

    Jul 5, 2023 

    definitief

    Bij samen voegen van eisen was een fout gemaakt. Deze is hersteld.

    1.0.0

    Mar 29, 2023 

    definitief



    Beschrijving

    Koppeltaal is een interoperabiliteit standaard. Om op een eenduidige manier gegevens uit te wisselen, dient er een duidelijke beschrijving van de interacties te zijn. De interacties bestaan uit de volgende componenten:

    1. Gegevens uitwisselen middels de FHIR resource service

    2. Resources zoeken

    3. Abonneren op veranderingen

    4. Launchen van applicaties

    FHIR resource service

    Koppeltaal maakt gebruik van een FHIR resource service. Zie TOP-KT-002a - FHIR Resource Service interacties voor meer informatie.

    Resources zoeken

    Er dient een duidelijke specificatie te zijn hoe applicaties kunnen zoeken op resources in de FHIR resource service. Zie TOP-KT-002b - Search interacties voor meer informatie.

    Abonneren op veranderingen

    Het abonneren op veranderingen werkt zoals hierboven beschreven. Het is namelijk een Subscription resource die op de FHIR resource service aangemaakt wordt. Zie TOP-KT-006 - Abonneren op en signaleren van gebeurtenissen voor meer informatie.

    Launchen

    De launch kan op twee manieren uitgevoerd worden. De standaard beschrijft hoe veilig vanuit een applicatie een andere applicatie opgestart kan worden. Zie TOP-KT-007 - Koppeltaal Launch voor meer informatie.

    BIA - Eisen (en aanbevelingen) voor Basis interacties

    #

    Eis

    Applicatie-instantie

    FHIR Resource service

    #

    Eis

    Applicatie-instantie

    FHIR Resource service

    1

    Alle FHIR resource service interacties zijn minimaal middels HTTP v1.1 en gebaseerd op de FHIR RESTful API standaard

    X

    X

    2

    Alle requests binnen een domein MOETEN een valide Bearer token bevatten, m.u.v. het  /metadata endpoint en eventuele andere publiek beschikbare endpoints. Deze kan conform TOP-KT-005c - Applicatie toegang: SMART on FHIR backend services aangevraagd worden.

    X

    X

    3

    Een PUT MOET een If-Match header bevatten

    X

    X

    4

    Indien een DELETE request een If-Match header bevat, moet deze gevalideerd worden.

     

    X

    5

    De FHIR RESTful API MOET functionaliteit implementeren conform de specificaties

     

    X

    6

    Berichtinhoud MOET voldoen aan en MOET meegegeven worden middels de Content-Type header. De waarde van de header MOET met één van de twee waarden gevuld worden:

    1. application/fhir+json

    2. application/fhir+xml

    De Content-Type header MAG uitgebreid worden met de FHIR versie en/of de encoding. De encoding MOET altijd utf-8 zijn:

    1. application/fhir+json; fhirVersion=4.0; charset=utf-8

    2. application/fhir+xml; fhirVersion=4.0; charset=utf-8

    X

    X

    7

    Wanneer de Accept  header gebruikt wordt, MOET de waarde van de header met één van de twee waarden gevuld worden:

    1. application/fhir+json

    2. application/fhir+xml

    De Accept header MAG uitgebreid worden met de FHIR versie en/of de encoding. De encoding MAG worden toegevoegd:

    1. application/fhir+json; fhirVersion=4.0; charset=utf-8

    2. application/fhir+xml; fhirVersion=4.0; charset=utf-8

    X

    X

    8

    De encoding van zowel application/fhir+json en application/fhir+xml MOET altijd utf-8  zijn voor alle resources die vanuit de FHIR resource service komen. Indien een andere encoding wordt meegegeven vanuit de client van de FHIR resource service is het aan de FHIR resource service om een fout te genereren in de 4xx serie, of de encoding te accepteren. Hoewel de FHIR resource service de resources MAG accepteren in een andere encoding dan UTF-8, is de FHIR resource service wel verplicht deze als utf-8 aan te bieden.

    X

    X

    9

    StructureDefinition resources worden ALLEEN door Koppeltaal beheerd

     

    X

    10

    Er is GEEN ondersteuning binnen Koppeltaal voor een “whole system interaction search“ (TOP-KT-002a - FHIR Resource Service interacties)

     

    X

    11

    Het Ondersteunde search parameters overzicht MOET geïmplementeerd zijn

     

    X

    12

    Paginatie MOET ondersteund zijn conform https://www.hl7.org/fhir/r4/http.html#paging  en Feed Paging and Archiving (rfc5005).

     

    X

    13

    De Koppeltaal SearchParameters MOETEN uitvoerbaar zijn

     

    X