Document toolboxDocument toolbox

TOP-KT-009 - Overzicht gebruikte FHIR Resources

 Versiegeschiedenis...
VersieDatumStatusWijzigingen
2.0.1definitiefToevoeging ImplementationGuide Resource
2.0.0 definitiefAanpassing instantiatesCanonical → ext:instantiates
1.0.0

 

definitiefGeen wijzigingen ten opzichte van laatste concept
0.1.0

 

concept




Beschrijving

Gegevens worden uitgewisseld tussen verschillende dienstverlenende applicaties. In Koppeltaal staat het begrip applicaties voor alle vormen van ICT-systemen en eHealth platformen die voor een zorgaanbieder relevant zijn om gegevens tussen uit te wisselen in de context van eHealth activiteiten. De dienstverlenende applicaties worden geleverd door verschillende leveranciers. Deze leveranciers kunnen hun dienstverlenende applicaties ontsluiten via Koppeltaal onder de verantwoordelijkheid van de zorgaanbieder. Alle FHIR resources van één zorgaanbieder kunnen via de Koppeltaal (FHIR Resource) Provider ontsloten worden, voor die dienstverlenende applicaties die aangesloten zijn op Koppeltaal. Daarbij maken wij gebruik van gemeenschappelijke begrippen en standaarden die gebaseerd zijn op HL7/FHIR (https://www.hl7.org/fhir/http.html).

Overwegingen

Het volgende diagram geeft een overzicht van de FHIR Resources (Koppeltaal basis set) en de onderlinge relaties tussen de resources voor Koppeltaal 2.0.

Rol owner

De owner van de taak in het diagram beneden kan drie entiteiten zijn: de Patient, de Practitioner of een CareTeam. De laatste moet in dat geval als subject de Patient hebben. In het diagram beneden lijkt het alsof alle drie de opties mogelijk zijn, in realiteit is het echter één van de drie opties.

FHIR standaard

Alle FHIR Resources en de daarbij behorende elementen in Koppeltaal 2.0 zijn gebaseerd op FHIR Release #4 (4.0.1 2019-10-30) - http://hl7.org/fhir/R4/

Formaten

Bij daadwerkelijke uitwisseling kunnen de FHIR Resources worden weergegeven in XML en/of JSON format





De Koppeltaal 2.0 FHIR profielen zijn in Simplifier.NET vastgelegd onder Koppeltaal v2.0. Deze profielen zijn leidend voor Koppeltaal v2.0

De Koppeltaal 2.0 FHIR profielen zijn (hiërarchisch) gebaseerd op:

a. hl7.fhir.r4.core (4.0.1)

b. nictiz.fhir.nl.r4.zib2020 (0.5.0-beta1)

c. nictiz.fhir.nl.r4.nl-core (0.5.0-beta1)

De URL http://koppeltaal.nl/ is als canonical claim (basis url) voor alle profielen vastgelegd.

Elk Koppeltaal 2.0 FHIR profiel begint met KT2_

Een Koppeltaal 2.0 profiel is een verklaring over de regels hoe een FHIR resource voor Koppeltaal 2.0 wordt aangemaakt.



Koppeltaal 2.0 profielen

Van onderstaande FHIR resources zijn Koppeltaal 2.0 profielen aangemaakt en gepubliceerd in https://simplifier.net/Koppeltaalv2.0.

Deze worden als basis gebruikt voor Koppeltaal 2.0. 

Daaraan zijn toegevoegd de profielen:

  • ImplementationGuide
  • CapabilityStatement
  • Bundle
  • OperationOutcome

Elke resource wordt voorzien van

  • Metadata

De ImplementationGuide, CapabilityStatement, Bundle en OperationOutcome zijn niet opgenomen in Simplifier, omdat deze resources niet in de FHIR Store worden opgenomen. Via een Metadata Reference naar de ImplementationGuide wordt een overzicht van de beschikbare resource profielen beschikbaar gesteld.



Binnen Koppeltaal wordt gebruik gemaakt van 11 functionele profielen.:


Profiel OmschrijvingUser storiesSimplifier

Patient

De (FHIR) Patient (resource) is een representatie van een persoon die in behandeling is bij de Zorgaanbieder aan wie eHealth activiteiten worden toegewezen.
  • Opvoeren van een (nieuwe) patiënt
  • Aanpassen van patiëntgegevens
  • Opvragen van patiëntgegevens
  • Zoeken van patiëntgegevens op basis van identifier
https://simplifier.net/koppeltaalv2.0/kt2_patient

Practitioner

De (FHIR) Practitioner (resource) is een representatie van een persoon die direct of indirect betrokken is bij het verlenen van gezondheidszorg.
  • Opvoeren van een (nieuwe) behandelaar
  • Toevoegen van een email adres van een behandelaar
  • Opvragen van een behandelaar
  • Zoeken naar een behandelaar
https://simplifier.net/koppeltaalv2.0/kt2_practitioner

RelatedPerson

(Out of scope)

De (FHIR) RelatedPerson (resource) is een representatie van een persoon die betrokken is bij de zorg voor een patiënt, maar niet wie in behandeling is bij de Zorgaanbieder, noch formele verantwoordelijkheid heeft in het zorgtraject.
  • Opvoeren van een (nieuwe) derde en deze koppelen aan een bestaande patiënt
  • Aanpassen van gegevens van derde
  • Opvragen van gegevens van derde
  • Zoeken van gegevens op basis van identifier
n.v.t.

Task

De (FHIR) Task (resource) beschrijft een eHealth taak, dat is, een aan een patiënt toegewezen eHealth activiteit.
  • De aanbieder van een eHealth modules registreert de module in de vorm van een FHIR ActivityDefinition resource
  • Een behandelaar selecteert de gewenste eHealth module uit deze lijst met FHIR ActivityDefinition resources.
  • Uit een FHIR ActivityDefinition wordt via een operation een FHIR Task resource aangemaakt. Deze Task resource wordt gebruikt om de onderliggende eHealth module voor deze cliënt klaar te zetten.
  • De eHealth module update de Task resource om daarmee wijzigingen in status en resultaten terug te koppelen. Zie: https://www.hl7.org/fhir/task.html#statemachine
https://simplifier.net/koppeltaalv2.0/kt2_task

ActivityDefinition

De (FHIR) ActivityDefinition beschrijft een eHealth activiteit die beschikbaar is voor toewijzing aan een patiënt. Bij toewijzing van een eHealth activiteit aan een patiënt ontstaat een eHealth Taak (Task), waarbij sub-activiteiten kunnen worden opgenomen als contained resources die verwijzen naar de hoofdtaak via Task.partOf. 
  • De eHealth module (client) moet zich authentiseren (verifiëren van de identiteit van de eHealth module op basis van een uitgegeven client_id van de autorisatie autoriteiten en een eigen aangeleverd kenmerk  aan de autorisatie server)
  • Na authenticatie registreert de module in de vorm van een FHIR ActivityDefinition resource zijn activiteit
https://simplifier.net/koppeltaalv2.0/kt2_activitydefinition

Endpoint

De (FHIR) Endpoint (resource) is een representatie van een technisch contactpunt/adres (of Uniform Resource Locator) van een applicatie instantie die één of meerdere eHealth diensten aanbiedt. 

Belangrijke informatie van de Endpoint resource is het Endpoint.address (URL) 

  • Het kunnen activeren en de-activeren van een endpoint.
https://simplifier.net/koppeltaalv2.0/kt2_endpoint

Device

De (FHIR) Device (resource) is een representatie van een gefabriceerd applicatie instantie dat wordt gebruikt bij het verlenen van gezondheidszorg, zonder dat het door die activiteit substantieel wordt gewijzigd. Het device (of applicatie instantie) kan een medische of niet-medische ondersteunende applicatie zijn.
  • Het kunnen activeren en de-activeren van het device (applicatie).
https://simplifier.net/koppeltaalv2.0/kt2device

Organization

De (FHIR) Organization (resource) beschrijft de formele eHealth aanbieder of zorginstelling. De Organization resource wordt in de context van Koppeltaal als domein en ondersteuning gebruikt voor andere resources, die naar de eHealth aanbieder verwijst. 
  • Registreren van de eHealth aanbieder in de vorm van een FHIR Organization
https://simplifier.net/koppeltaalv2.0/kt2organization

Subscription

De (FHIR) Subscription (resource) is een representatie van een abonnement nemen op bepaalde type gebeurtenissen/wijzigingen op resources.  Zodra een Subscription resource (een abonnement) bij de FHIR Resource Provider is geregistreerd, controleert de FHIR Resource Provider elke resource die is aangemaakt en/of bijgewerkt en als de resource overeenkomt met de gegeven criteria (in het abonnement), stuurt deze een bericht (notificatie), zonder payload, naar het gedefinieerde "kanaal" zodat een ander systeem/applicatie in staat is om een passende actie te ondernemen.
  • Abonnement nemen op nieuwe opgevoerde patiënten
  • Volgen of het monitoren van (afgeronde) taken
https://simplifier.net/koppeltaalv2.0/kt2subscription

CareTeam

De (FHIR) CareTeam (resource) is een representatie van het zorgteam van alle participanten die deelnemen in het zorgproces van de patiënt, waarbij de patiënt het onderwerp is van het team.
  • Opvoeren van een (nieuwe) patiënt
  • Toekennen van patiënt aan behandela(a)r(en) (registratie behandelrelatie)
https://simplifier.net/koppeltaalv2.0/kt2_careteam

AuditEvent

De (FHIR) AuditEvent (resource) is een representatie van een logrecord van een interactie tussen 2 systemen. Koppeltaal Logging moet het mogelijk maken "achteraf onweerlegbaar vast te stellen welke gebeurtenissen waar en wanneer hebben plaatsgevonden.
  • Loggen van een gebeurtenis of interactie tussen systemen
https://simplifier.net/koppeltaalv2.0/kt2_auditevent

Toepassing en restricties

In tegenstelling tot de algemene FHIR-regel "een zender zendt wat hij kan, een ontvanger leest wat hij kan" is op basis van Architectuur besluit AB.XII (https://vzvz.atlassian.net/wiki/display/KTSA/Architectuur+besluiten)  afgesproken alleen gebruik te maken van bepaalde velden. Dit om de interoperabiliteit tussen de systemen te bevorderen. Onderstaande figuur geeft aan welke velden (functioneel) verplicht zijn (rood) en welke velden optioneel gebruikt mogen worden (groen). Overige velden dienen niet gebruikt te worden. In Simplifier is dit aangegeven via de cardinaliteit. Verplicht: cardinaliteit begint met 1 (1..1 of 1,,*); niet gebruiken: cardinaliteit is 0..0; overige velden zijn optioneel.

Daarnaast worden tevens velden uit complex datatypes niet gebruikt binnen Koppeltaal 2.0. Deze velden zijn in Simplifier gekenmerkt wanneer in  de Simplifier Comments de volgende zin is opgenomen: "This element is not used in the context of Koppeltaal 2.0"


Aangezien de positie van RelatedPerson nog niet duidelijk is, is deze resource voorlopig out-of-scope geplaatst.

Eisen

PRF - Eisen aan FHIR Profielen

Voorbeelden

Zie Simplifier.

Links naar gerelateerde onderwerpen

Simplifier Koppeltaal: https://simplifier.net/Koppeltaalv2.0.

AB.XI: AB.XI - FHIR resources en extensies

AB.XII: AB.XII - Attributen en dialecten