...
...
...
...
...
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.
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/.
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.
Binnen Koppeltaal wordt gebruik gemaakt van 11 functionele profielen (zie Architectuur Besluit AB.XI AB.XI - FHIR resources en extensies):
- Task
- Subscription
- Practitioner
- ActivityDefinition
- AuditEvent
- CareTeam
- Device
- Endpoint
- Organization
- Patient
- RelatedPerson
Daaraan zijn toegevoegd de profielen:
- CapabilityStatement
- Bundle
- OperationOutcome
Elke resource wordt voorzien van
- Metadata
De CapabilityStatement, Bundle en OperationOutcome zijn niet opgenomen in de Simplifier, omdat deze resources niet in de FHIR Store worden opgenomen.
Koppeltaal 2.0 profielen
| Info | ||
|---|---|---|
| ||
Van bovenstaande 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. |
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 (AB.XII - Attributen en dialecten) 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.
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 onderliggende pagina's
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
Oude tekst
In onderstaande tabel zijn de verplichte velden van de FHIR resources R4 opgenomen, aangevuld met de functioneel verplichte velden binnen Koppeltaal 2.0 en optionele velden binnen Koppeltaal 2.0.
Deze lijst is samengesteld op basis van Architectuur besluit AB.XII (AB.XII - Attributen en dialecten) en betreft de resources voorzien van oranje header. Binnen Koppeltaal is afgesproken alleen van deze velden gebruik te maken.
De CapabilityStatement, Bundle en OperationOutcome zijn niet opgenomen in de tabel, omdat deze resource niet in de FHIR Store worden opgenomen.
Koppeltaal 2.0 profielen
Van bovenstaande 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.
...
FHIR R4 Resource
...
Element
...
Verplicht in KT 2.0 (profile)
...
Patient
...
identifier
...
X..*
...
active
...
X
...
name
...
name.nameInformation.use
...
name.nameInformation
.family
...
name.nameInformation.given
...
telecom
...
gender
...
birthDate
...
Practitioner
...
identifier
...
X..*
...
active
...
X
...
name
...
telecom
...
gender
...
birthDate
...
RelatedPerson
...
(Voorlopig out of scope)
...
identifier
...
X..*
...
active
...
X
...
patient
...
name
...
gender
...
Task
...
instantiatesCanonical
...
X
...
status
...
X
...
intent
...
X
...
requester
...
owner
...
X
...
restriction.recipient
...
for
...
ActivityDefinition
...
ext: publisherIdentifier
...
X
...
ext: endpoint
...
X..*
...
url
...
X
...
identifier
...
name
...
title
...
X
...
status
...
X
...
description
...
Endpoint
...
identifier
...
status
...
X
...
name
...
address
...
X
...
connectionType
...
X
...
payloadType
...
X
...
Subscription
...
status
...
X
...
criteria
...
X
...
reason
...
X
...
channel
...
X
...
channel.type
...
X
...
channel.endpoint
...
X?
...
channel.header
...
X?
...
Reference
(Practitioner|RelatedPerson)
...
Soort gebeurtenis. Zie "system": http://terminology.hl7.org/CodeSystem/audit-event-type. Standaard "code": "rest"
Bij het lanceren van applicaties wordt het:
"system":"http://dicom.nema.org/resources/ontology/DCM",
"code":"110100",
"display":"Application Activity"
...
Gedetailleerde beschrijving van FHIR gebeurtenis. Zie system: http://hl7.org/fhir/restful-interaction
Bij het lanceren van applicaties gebruiken we:
"system":"http://dicom.nema.org/resources/ontology/DCM",
"code":"110120",
"display":"Application Start"
...
Zie: system: http://dicom.nema.org/resources/ontology/DCM
- code: 110150 display: "Application" - Audit participant role ID of software application
- code: 110151 display: "Application Launcher" - Audit participant role ID of software application launcher, i.e., the entity that started or stopped an application
- code: 110152 display: "Destination Role ID" Audit participant role ID of the receiver of data
- code: 110153 display: "Source Role ID" Audit participant role ID of the sender of data
...
? = in Simplifier 0..1
Beschrijving
In de doelstelling van stichting Koppeltaal is middels het woord ‘interne’ een beperking voor de gegevensuitwisseling opgenomen. Met deze beperking wordt bedoeld dat gegevensuitwisseling altijd plaatsvindt onder de verantwoordelijkheid van één zorgaanbieder.
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).
Het volgende diagram geeft een overzicht van de FHIR Resources (Koppeltaal basis set) en de onderlinge relaties tussen de resources voor Koppeltaal 2.0.
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/.
Bij daadwerkelijke uitwisseling kunnen de FHIR Resources worden weergegeven in XML en/of JSON formaten.
...
Nieuwe plaat:
- Kleuren verwijderd omdat niemand wist wat ze voorstelden
- Related person Out of Scope geplaatst.
Volgend lijstje geeft de verplichte velden weer van de FHIR resources R4, die binnen Koppeltaal 2.0 worden gebruikt.
Dit lijstje is door VZVZ samengesteld. De CapabilityStatement, Bundle en OperationOutcome zijn niet opgenomen in dit lijstje, omdat deze resource niet in de FHIR Store worden opgenomen.
| Info | ||
|---|---|---|
| ||
Van bovenstaande 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. |
...
FHIR R4 Resource
...
Element
...
Verplicht in KT 2.0 (profile)
...
Patient
...
identifier
...
X..*
...
active
...
X
...
name
...
telecom
...
gender
...
birthDate
...
Practitioner
...
identifier
...
X..*
...
active
...
X
...
name
...
telecom
...
gender
...
birthDate
...
RelatedPerson
...
Voorlopig out of scope)
...
identifier
...
X..*
...
active
...
X
...
patient
...
name
...
gender
...
Task
...
instantiatesCanonical
...
X
...
status
...
X
...
intent
...
X
...
requester
...
owner
...
X
...
restriction.recipient
...
for
...
ActivityDefinition
...
ext: publisherIdentifier
...
X
...
ext: endpoint
...
X..*
...
url
...
X
...
identifier
...
name
...
title
...
X
...
status
...
X
...
description
...
Endpoint
...
identifier
...
status
...
X
...
name
...
address
...
X
...
connectionType
...
X
...
payloadType
...
X
...
Subscription
...
status
...
X
...
criteria
...
X
...
reason
...
X
...
channel
...
X
...
channel.type
...
X
...
channel.endpoint
...
X?
...
channel.header
...
X?
...
Soort gebeurtenis. Zie "system": http://terminology.hl7.org/CodeSystem/audit-event-type. Standaard "code": "rest"
Bij het lanceren van applicaties wordt het:
"system":"http://dicom.nema.org/resources/ontology/DCM",
"code":"110100",
"display":"Application Activity"
...
Gedetailleerde beschrijving van FHIR gebeurtenis. Zie system: http://hl7.org/fhir/restful-interaction
Bij het lanceren van applicaties gebruiken we:
"system":"http://dicom.nema.org/resources/ontology/DCM",
"code":"110120",
"display":"Application Start"
...
Zie: system: http://dicom.nema.org/resources/ontology/DCM
- code: 110150 display: "Application" - Audit participant role ID of software application
- code: 110151 display: "Application Launcher" - Audit participant role ID of software application launcher, i.e., the entity that started or stopped an application
- code: 110152 display: "Destination Role ID" Audit participant role ID of the receiver of data
- code: 110153 display: "Source Role ID" Audit participant role ID of the sender of data
...
? = in Simplifier 0..1
Rationale
FHIR Resources zijn in de basis generiek en worden met behulp van profielen uitgebreid en specifieker gemaakt voor specifieke toepassingen, zoals Koppeltaal. In Koppeltaal worden FHIR resources toegepast om gegevens uit te wisselen. In Koppeltaal zijn de gegevens die worden uitgewisseld beperkt tot de afspraak. Binnen deze afspraak ligt vast welke gegevens uitgewisseld moeten worden en wat dit voor alle applicaties in het domein betekend. Dit vormt zogenaamd de "maximale gegevensset". Het is in Koppeltaal expliciet niet toegestaan meer gegevens dan zijn afgesproken uit te wisselen. Dit omdat door het uitwisselen van gegevens impliciet bepaald gedrag verwacht wordt, en in dat geval moeten alle partijen in het domein hier mee overweg kunnen. Een goed voorbeeld om dit idee toe te lichtten is de deceased waarde in de patient. Indien deze gevuld zou worden, wordt van de gekoppelde systemen in het domein bepaald gedrag verwacht. Zonder over dit gedrag afspraken te maken, is het niet de bedoeling van dit veld gebruikt te maken. De koppeltaal FHIR resources kunnen gezien worden als een koppelvlak, en niet als een resource service of database.
Implicaties
Voorbeelden
Toepassingsgebied
Onderbouwen
Eisen
...
| Expand | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||
|
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
| Drawio | ||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
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.
| Info | ||
|---|---|---|
| ||
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.
Tabel: Koppeltaal functionele profielen.
| Profiel | Omschrijving | User stories | Simplifier |
|---|---|---|---|
Patient | De (FHIR) Patient (resource) is een representatie van een persoon die in behandeling is bij de Zorgaanbieder aan wie eHealth activiteiten worden toegewezen. |
| 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. |
| 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. |
| n.v.t. |
Task | De (FHIR) Task (resource) beschrijft een eHealth taak, dat is, een aan een patiënt toegewezen eHealth activiteit. |
| 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. |
| https://simplifier.net/koppeltaalv2.0/kt2_activitydefinition |
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. |
| 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. |
| https://simplifier.net/koppeltaalv2.0/kt2_organization |
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. |
| 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. |
| 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. |
| 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