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.

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.:

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.	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	https://simplifier.net/koppeltaalv2.0/kt2_relatedperson
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/kt2_device
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/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.	Abonnement nemen op nieuwe opgevoerde patiënten Volgen of het monitoren van (afgeronde) taken	https://simplifier.net/koppeltaalv2.0/kt2_subscription
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

Daaraan zijn toegevoegd de profielen:

CapabilityStatement
Bundle
OperationOutcome

Elke resource wordt voorzien van

Metadata

De CapabilityStatement, Bundle en OperationOutcome zijn niet opgenomen in Simplifier, omdat deze resources 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.

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.

Speciale aandacht voor de velden met paarse stip. Deze zijn in Simplifier aangegeven als optioneel maar binnen Koppeltaal functioneel verplicht.

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

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.

Meta					Elke FHIR R4 Resource bevat een "meta" element van het type Meta wat een set metadata is die technische content meegeeft aan de resource. Binnen de context van Koppeltaal zullen we gebruik maken van enkele elementen uit de metadata set.
FHIR R4 Resource	Element	Type	Verplicht in KT 2.0 (profile)	Functioneel nodig in KT 2.0	Omschrijving en reden
	versionId	id	X		De waarde van versionId verandert elke keer als de inhoud van de resource verandert. Er kan naar worden verwezen in een resource referentie (voorbeeld: ResourceType/id/_history/versionId). Dit veld wordt door FHIR Resource Provider bijgehouden.
	lastUpdated	instant	X		Dit element verandert de waarde als de content van de resource verandert.
	source	uri	X		Een samengestelde string die het resource systeem en interactie (bv create, update, etc) uniek identificeert. In de context van Koppeltaal wordt voor het resource systeem het "applicatie of client id" gebruikt. Voorbeeld: `"source": "urn:uuid:client_id#interaction_id"`
	profile	canonical(StructureDefinition)			Een bewering of toekenning dat de inhoud van de resource overeenkomt met een resource profile (vastgelegd in een StructureDefinition). Zie FHIR Profiles voor verdere uitleg. Een profile wordt gewijzigd als de waardensets wijzigen of het systeem de conformiteit opnieuw controleert. De profile kan worden gebruikt om aan te geven aan welke versie(s) de FHIR resource moet voldoen.
Patient					De persoon die in behandeling is bij de zorgaanbieder.
	identifier	Identifier	X..*		Elke patiënt moet uniek te identificeren zijn a.d.h.v. een identifier, zodat we altijd de gegevens kunnen opvragen. Er mogen meerdere type identifiers gebruikt worden
	active	boolean	X		Of de patiënt actief is, binnen de Koppeltaal context. Initieel op 'true' zetten.
	name	HumanName		X..*	Eén of meerdere namen die aan de patiënt wordt geassocieerd.
	name.nameInformation.use	code	X		Fixed value: Official
	name.nameInformation .family	string		X	Achternaam
	name.nameInformation.given	string		X..*	Voorna(a)m(en)
	telecom	ContactPoint			De contactdetails (telefoonnummers, emailadressen)van de patiënt.
	gender	code		X	Het geslacht van de patiënt. Zie https://www.hl7.org/fhir/valueset-administrative-gender.html
	birthDate	date		X	Geboorte datum van de patiënt.
	adress	nl core AddressInformation			Adres van de patient (straat, huisnummer, woonplaats, postcode, land)
	managingOrganization	Reference
Practitioner					De zorgverlener die in overleg met de patiënt een eHealth activiteit toewijst.
	identifier	Identifier	X..*		Elke behandelaar moet uniek te identificeren zijn a.d.h.v. identifiers, zodat we altijd de gegevens kunnen opvragen.
	active	boolean	X		Of de behandelaar actief is, binnen de Koppeltaal context. Initieel op 'true' zetten.
	name	HumanName		X..*	De naam die aan de behandelaar wordt geassocieerd.
	telecom	ContactPoint		X	Contact details van de behandelaar. (email adres is verplicht, telefoonnummer optioneel)
	gender	code			Het geslacht van de behandelaar. Zie https://www.hl7.org/fhir/valueset-administrative-gender.html.
	birthDate	date			Geboortedatum van de behandelaar
RelatedPerson	(Voorlopig out of scope)				Naaste van de patiënt die betrokken is in het behandelproces. (voorlopig out of scope)
	identifier	Identifier	X..*		Elke naaste moet uniek te identificeren zijn a.d.h.v. een identifier, zodat we altijd de gegevens kunnen opvragen.
	active	boolean	X		Of de naaste persoon actief betrokken is, binnen de Koppeltaal context. Initieel op 'true' zetten.
	patient	Reference(Patient)			Uit FHIR R4. De patiënt waarmee deze persoon een relatie mee heeft.
	telecom	ContactPoint			Contactdetails van deze persoon.
	birthDate	date	X		Geboortedatum van deze persoon.
	address	Address			Adres waar deze persoon bereikt kan worden (straat, huisnummer, woonplaats, postcode, land).
	name	HumanName		X..*	De naam die aan deze persoon wordt geassocieerd.
	name.nameInformation.use	code	X		Fixed value: Official
	name.nameInformation.family	string		X	Achternaam
	name.nameInformation.given	string		X..*	Voorna(a)m(en)
	gender	code		X	Het geslacht van deze persoon. Zie https://www.hl7.org/fhir/valueset-administrative-gender.html
Task					De aan een patiënt toegewezen eHealth activiteit.
	identifier	Identifier	X..*		Identificatie van een activiteit
	description	string			Leesbare uitleg van taakomschrijving
	code	CodeableConcept			Taaktype
	instantiatesCanonical	canonical(ActivityDefinition)	X		Een referentie naar een beschrijving van een eHealth activiteit moet bij het opvoeren van een taak In de context van Koppeltaal altijd gevuld worden.
	status	code	X		In de context van Koppeltaal moet altijd de status van een eHealth activiteit bekend zijn. Initieel wordt de taak op 'ready' gezet om aan te geven dat de taak toegewezen en geaccepteerd is. Zie https://www.hl7.org/fhir/valueset-task-status.html.
	intent	code	X		Uit FHIR R4. De intentie vertegenwoordigt een 'order' tot een eHealth activiteit en autorisatie voor uitvoering van de taak door een participant. Zie http://hl7.org/fhir/R4/codesystem-request-intent.html.
	requester	Reference(Practitioner)			In Koppeltaal wordt dit veld uitgevoerd met een referentie naar de aanvrager van de eHealth activiteit.
	owner	Reference(Patient)	X		Een verplichte referentie naar de patiënt die verantwoordelijk is voor de uitvoering van de toegewezen eHealth activiteit.
	restriction.recipient	Reference(Practitioner)			Wordt in Koppeltaal gebruikt voor het koppelen van betrokkenen aan de eHealth activiteit.
	restriction.period	Period			Taak periode (beperking)
	for	Reference(Patient)			Bevat een referentie naar voor wie we het doen of wie er baat bij heeft. Bij Koppeltaal is dit de Patient.
	authoredOn	dateTime			Creatie datum van de eHealth activiteit.
	lastModified	dateTime			Datum waarop laatste wijziging is doorgevoerd op de eHealth activiteit.
ActivityDefinition					Beschrijving van een eHealth activiteit.
	ext: publisherIdentifier	id	X		Verplichte identificatie van de uitgever van de eHealth activiteit.
	ext: endpoint	Reference(Endpoint)	X..*		Verplichte referentie naar de dienstverlenende applicatie (endpoint) die de eHealth activiteit levert. Kunnen er meerdere van zijn
	version	string			Bedrijfsversie van deze eHealth activiteit.
	url	uri	X		Een herkenbare identifier voor deze eHealth activiteit dat als een URI gepresenteerd wordt.
	identifier	Identifier			Een extra (globale) identificatie element voor het kunnen identificeren van een eHealth activiteit.
	name	string			De naam van de eHealth activiteit.
	title	string	X		Dit titel van de eHealth activiteit wordt (verplicht) getoond aan gebruikers en moet gevuld worden. Nodig voor het kunnen toewijzen van een eHealth activiteit.
	subtitle	string			Ondergeschikte titel van de ehealth activiteit.typexxxxx
	status	code	X		Uit FHIR R4. Zodra de eHealth activiteit gepubliceerd wordt, wordt deze op 'active' gezet. Indien de activiteit NIET meer gebruikt wordt, wordt deze op 'retired' gezet. Zie: http://hl7.org/fhir/publication-status
	subject	SubjectReference			Onderwerp
	description	markdown			Een omschrijving van de eHealth activiteit.
Endpoint					Een eHealth (eind)punt is een technische representatie van een adres of Uniform Resource Locator (URL) van een applicatie instantie die eHealth of FHIR REST diensten aanbiedt.
	identifier	Identifier			Unieke endpoint identifier.
	status	code	X		Uit FHIR R4. De status van een endpoint. Standaard wordt deze op 'active' gezet. Andere mogelijke modes zijn beschreven in https://www.hl7.org/fhir/valueset-endpoint-status.html
	name	string			Naam waarmee het endpoint geïdentificeerd kan worden.
	address	url	X		Uit FHIR R4. Het technische basis adres waarmee de verbinding wordt opgezet.
	connectionType	Coding	X		Uit FHIR R4. Het protocol wat gebruikt wordt bij dit endpoint. Standaard voor Koppeltaal op 'hl7-fhir-rest' zetten. Zie ook: https://www.hl7.org/fhir/valueset-endpoint-connection-type.html.
	payloadType	CodeableConcept	X		Uit FHIR R4. Type inhoud wat gebruikt wordt voor dit endpoint. Zie ook: https://www.hl7.org/fhir/valueset-endpoint-payload-type.html.
Device					Een (gefabriceerde) applicatie instantie (in Koppeltaal terminologie) dat gebruikt wordt ter ondersteuning of het verlenen van gezondheidszorg.
	identifier	Identifier	X		Instantie identifier van het product. Is de client id
	status	code	X		De status van het product
	type	CodeableConcept			Soort/type product. Zie: http://hl7.org/fhir/ValueSet/device-type
	url	uri			Netwerk adres om applicatie te bereiken
	specialization	BackboneElement			Mogelijkheden van product
	deviceName.name	string	X		Naam van het product
	deviceName.type	code	X		Standaard waarde: user-friendly-name
Subscription					Een abonnement wordt gebruikt om geïnformeerd te worden over wijzigingen op (resource) gegevens door andere systemen. Nadat een abonnement is geregistreerd en wijzigingen op (resource) gegevens voorkomen die overeen komen met een vastgelegde criteria, verzendt deze een bericht (notificatie) op een voor gedefinieerde "kanaal", zodat een ander systeem hierop actie kan ondernemen.
	status	code	X		Uit FHIR R4. Status van het abonnement. Zie: http://hl7.org/fhir/subscription-status.
	criteria	string	X		Uit FHIR R4. De vastgelegde criteria waarop er een bericht (notificatie) wordt verstuurd.
	reason	string	X		Uit FHIR R4. Omschrijving waarom dit abonnement is gecreëerd.
	channel	BackboneElement	X		Uit FHIR R4. Voor gedefinieerd kanaal waar het bericht wordt verstuurd.
	channel.type	code	X		Uit FHIR R4. Ondersteunen alleen: "rest-hook" kanaal.
	channel.endpoint	url	X?		Omdat we rest-hook als kanaaltype verplichten, moet ook het endpoint vastgelegd worden. Endpoint zou niet raadbaar moeten zijn en uniek per subscription.
	channel.header	string	X?		Om DOS aanvallen te voorkomen, wordt een "Authorization" header verplicht (voor afgesproken token meesturen). Men kan ook de vastgelegde criteria in de header vastleggen.
	channel.payload	code	XXX (NIET)		Dit veld MOET NIET gebruikt worden. De notificaties worden zonder payload verstuurd. Extra informatie over een notificatie kan via de channel.header meegegeven worden.
CareTeam					Beschrijft het zorgteam met de participanten.
	identifier	Identifier	X		Elke zorgteam moet uniek te identificeren zijn a.d.h.v. een identifier, zodat we altijd de gegevens kunnen opvragen.
	status	code	X		In de context van Koppeltaal moet altijd de status van het zorgteam bekend zijn.
	subject	Reference(Patient)	X		Uit FHIR R4. Voor wie het team aan de slag is. In de context van Koppeltaal is dit een referentie naar Patient.
	period	Period			Tijdsperiode van het zorgteam.
	participant	BackboneElement			Lijst van betrokken participanten bij het zorgproces
	participant.role	CodeableConcept	x		Uit FHIR R4. Verplichte rol van de participant, bij toevoeging van participant.
	participant.member	Reference (Practitioner\|RelatedPerson)	x		Uit FHIR R4. Verplichte type participant, bij toevoeging van participant.
AuditEvent					Een logrecord van een interactie tussen systemen. Koppeltaal Logging moet het mogelijk maken "achteraf onweerlegbaar vast te stellen welke activiteiten waar en wanneer hebben plaatsgevonden.
	type	Coding	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"
	subtype	Coding	X?		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"
	action	code			Welke CRUDE acties is uitgevoerd. Zie: http://hl7.org/fhir/audit-event-action
	recorded	instant	X		Tijdstip van logmoment.
	agent.who	Reference(Device)	X?		De device actor (audit participant) van de zendende of ontvangende partij.
	agent.type	CodeableConcept	X?		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
	agent.role	CodeableConcept			Kunnen we onze applicatie rollen hier voor gebruiken, als deze zijn vastgelegd?
	agent.requestor	boolean	X		Is de agent de initiator van de gebeurtenissen, dan 'true' anders 'false'.
	entity.type	CodeableConcept	X?		Type resource. Zie: "http://hl7.org/fhir/resource-types". Zie het KT 2.0 FHIR Resource Model.
	entity.what	Reference(Any)	X?		Over welke (FHIR) resource gaat het Reference(Any). B.v: entity.what=Patient/123
	entity.name	string			resource.identifier
	source.site	string			Naam van de omgeving (domein!)
	source.observer	Reference(Device)	X		Wie heeft het gelogd. Misschien een aparte Log Device.
	source.type	Coding			Wat voor systeem is dit. Zie: http://terminology.hl7.org/CodeSystem/security-source-type

? = 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.

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	Type	Verplicht in KT 2.0 (profile)	Functioneel nodig in KT 2.0	Omschrijving en reden
Meta					Elke FHIR R4 Resource bevat een "meta" element van het type Meta wat een set metadata is die technische content meegeeft aan de resource. Binnen de context van Koppeltaal zullen we gebruik maken van enkele elementen uit de metadata set.
	versionId	id	X		De waarde van versionId verandert elke keer als de inhoud van de resource verandert. Er kan naar worden verwezen in een resource referentie (voorbeeld: ResourceType/id/_history/versionId). Dit veld wordt door FHIR Resource Provider bijgehouden.
	lastUpdated	instant	X		Dit element verandert de waarde als de content van de resource verandert.
	source	uri	X		Een samengestelde string die het resource systeem en interactie (bv create, update, etc) uniek identificeert. In de context van Koppeltaal wordt voor het resource systeem het "applicatie of client id" gebruikt. Voorbeeld: `"source": "urn:uuid:client_id#interaction_id"`
	profile	canonical(StructureDefinition)			Een bewering of toekenning dat de inhoud van de resource overeenkomt met een resource profile (vastgelegd in een StructureDefinition). Zie FHIR Profiles voor verdere uitleg. Een profile wordt gewijzigd als de waardensets wijzigen of het systeem de conformiteit opnieuw controleert. De profile kan worden gebruikt om aan te geven aan welke versie(s) de FHIR resource moet voldoen.
Patient					De persoon die in behandeling is bij de zorgaanbieder.
	identifier	Identifier	X..*		Elke patiënt moet uniek te identificeren zijn a.d.h.v. een identifier, zodat we altijd de gegevens kunnen opvragen. Er mogen meerdere type identifiers gebruikt worden
	active	boolean	X		Of de patiënt actief is, binnen de Koppeltaal context. Initieel op 'true' zetten.
	name	HumanName		X..*	Eén of meerdere namen die aan de patiënt wordt geassocieerd.
	name.nameInformation.use	code	X		Fixed value: Official
	name.nameInformation.family	string		X	Achternaam
	name.nameInformation.given	string		X..*	Voorna(a)m(en)
	telecom	ContactPoint			De contactdetails (telefoonnummers, emailadressen)van de patiënt.
	gender	code		X	Het geslacht van de patiënt. Zie https://www.hl7.org/fhir/valueset-administrative-gender.html
	birthDate	date		X	Geboorte datum van de patiënt.
	adress	nl core AddressInformation			Adres van de patient (straat, huisnummer, woonplaats, postcode, land)
	managingOrganization	Reference
Practitioner					De zorgverlener die in overleg met de patiënt een eHealth activiteit toewijst.
	identifier	Identifier	X..*		Elke behandelaar moet uniek te identificeren zijn a.d.h.v. identifiers, zodat we altijd de gegevens kunnen opvragen.
	active	boolean	X		Of de behandelaar actief is, binnen de Koppeltaal context. Initieel op 'true' zetten.
	name	HumanName		X..*	De naam die aan de behandelaar wordt geassocieerd.
	telecom	ContactPoint		X	Contact details van de behandelaar. (email adres is verplicht, telefoonnummer optioneel)
	gender	code			Het geslacht van de behandelaar. Zie https://www.hl7.org/fhir/valueset-administrative-gender.html.
	birthDate	date			Geboortedatum van de behandelaar
RelatedPerson	Voorlopig out of scope)				Naaste van de patiënt die betrokken is in het behandelproces. (voorlopig out of scope)
	identifier	Identifier	X..*		Elke naaste moet uniek te identificeren zijn a.d.h.v. een identifier, zodat we altijd de gegevens kunnen opvragen.
	active	boolean	X		Of de naaste persoon actief betrokken is, binnen de Koppeltaal context. Initieel op 'true' zetten.
	patient	Reference(Patient)			Uit FHIR R4. De patiënt waarmee deze persoon een relatie mee heeft.
	telecom	ContactPoint			Contactdetails van deze persoon.
	birthDate	date	X		Geboortedatum van deze persoon.
	address	Address			Adres waar deze persoon bereikt kan worden (straat, huisnummer, woonplaats, postcode, land).
	name	HumanName		X..*	De naam die aan deze persoon wordt geassocieerd.
	name.nameInformation.use	code	X		Fixed value: Official
	name.nameInformation.family	string		X	Achternaam
	name.nameInformation.given	string		X..*	Voorna(a)m(en)
	gender	code		X	Het geslacht van deze persoon. Zie https://www.hl7.org/fhir/valueset-administrative-gender.html
Task					De aan een patiënt toegewezen eHealth activiteit.
	identifier	Identifier	X..*		Identificatie van een activiteit
	description	string			Leesbare uitleg van taakomschrijving
	code	CodeableConcept			Taaktype
	instantiatesCanonical	canonical(ActivityDefinition)	X		Een referentie naar een beschrijving van een eHealth activiteit moet bij het opvoeren van een taak In de context van Koppeltaal altijd gevuld worden.
	status	code	X		In de context van Koppeltaal moet altijd de status van een eHealth activiteit bekend zijn. Initieel wordt de taak op 'ready' gezet om aan te geven dat de taak toegewezen en geaccepteerd is. Zie https://www.hl7.org/fhir/valueset-task-status.html.
	intent	code	X		Uit FHIR R4. De intentie vertegenwoordigt een 'order' tot een eHealth activiteit en autorisatie voor uitvoering van de taak door een participant. Zie http://hl7.org/fhir/R4/codesystem-request-intent.html.
	requester	Reference(Practitioner)			In Koppeltaal wordt dit veld uitgevoerd met een referentie naar de aanvrager van de eHealth activiteit.
	owner	Reference(Patient)	X		Een verplichte referentie naar de patiënt die verantwoordelijk is voor de uitvoering van de toegewezen eHealth activiteit.
	restriction.recipient	Reference(Practitioner)			Wordt in Koppeltaal gebruikt voor het koppelen van betrokkenen aan de eHealth activiteit.
	restriction.period	Period			Taak periode (beperking)
	for	Reference(Patient)			Bevat een referentie naar voor wie we het doen of wie er baat bij heeft. Bij Koppeltaal is dit de Patient.
	authoredOn	dateTime			Creatie datum van de eHealth activiteit.
	lastModified	dateTime			Datum waarop laatste wijziging is doorgevoerd op de eHealth activiteit.
ActivityDefinition					Beschrijving van een eHealth activiteit.
	ext: publisherIdentifier	id	X		Verplichte identificatie van de uitgever van de eHealth activiteit.
	ext: endpoint	Reference(Endpoint)	X..*		Verplichte referentie naar de dienstverlenende applicatie (endpoint) die de eHealth activiteit levert. Kunnen er meerdere van zijn
	version	string			Bedrijfsversie van deze eHealth activiteit.
	url	uri	X		Een herkenbare identifier voor deze eHealth activiteit dat als een URI gepresenteerd wordt.
	identifier	Identifier			Een extra (globale) identificatie element voor het kunnen identificeren van een eHealth activiteit.
	name	string			De naam van de eHealth activiteit.
	title	string	X		Dit titel van de eHealth activiteit wordt (verplicht) getoond aan gebruikers en moet gevuld worden. Nodig voor het kunnen toewijzen van een eHealth activiteit.
	subtitle	string			Ondergeschikte titel van de ehealth activiteit.typexxxxx
	status	code	X		Uit FHIR R4. Zodra de eHealth activiteit gepubliceerd wordt, wordt deze op 'active' gezet. Indien de activiteit NIET meer gebruikt wordt, wordt deze op 'retired' gezet. Zie: http://hl7.org/fhir/publication-status
	subject	SubjectReference			Onderwerp
	description	markdown			Een omschrijving van de eHealth activiteit.
Endpoint					Een eHealth (eind)punt is een technische representatie van een adres of Uniform Resource Locator (URL) van een applicatie instantie die eHealth of FHIR REST diensten aanbiedt.
	identifier	Identifier			Unieke endpoint identifier.
	status	code	X		Uit FHIR R4. De status van een endpoint. Standaard wordt deze op 'active' gezet. Andere mogelijke modes zijn beschreven in https://www.hl7.org/fhir/valueset-endpoint-status.html
	name	string			Naam waarmee het endpoint geïdentificeerd kan worden.
	address	url	X		Uit FHIR R4. Het technische basis adres waarmee de verbinding wordt opgezet.
	connectionType	Coding	X		Uit FHIR R4. Het protocol wat gebruikt wordt bij dit endpoint. Standaard voor Koppeltaal op 'hl7-fhir-rest' zetten. Zie ook: https://www.hl7.org/fhir/valueset-endpoint-connection-type.html.
	payloadType	CodeableConcept	X		Uit FHIR R4. Type inhoud wat gebruikt wordt voor dit endpoint. Zie ook: https://www.hl7.org/fhir/valueset-endpoint-payload-type.html.
Device					Een (gefabriceerde) applicatie instantie (in Koppeltaal terminologie) dat gebruikt wordt ter ondersteuning of het verlenen van gezondheidszorg.
	identifier	Identifier	X		Instantie identifier van het product. Is de client id
	status	code	X		De status van het product
	type	CodeableConcept			Soort/type product. Zie: http://hl7.org/fhir/ValueSet/device-type
	url	uri			Netwerk adres om applicatie te bereiken
	specialization	BackboneElement			Mogelijkheden van product
	deviceName.name	string	X		Naam van het product
	deviceName.type	code	X		Standaard waarde: user-friendly-name
Subscription					Een abonnement wordt gebruikt om geïnformeerd te worden over wijzigingen op (resource) gegevens door andere systemen. Nadat een abonnement is geregistreerd en wijzigingen op (resource) gegevens voorkomen die overeen komen met een vastgelegde criteria, verzendt deze een bericht (notificatie) op een voor gedefinieerde "kanaal", zodat een ander systeem hierop actie kan ondernemen.
	status	code	X		Uit FHIR R4. Status van het abonnement. Zie: http://hl7.org/fhir/subscription-status.
	criteria	string	X		Uit FHIR R4. De vastgelegde criteria waarop er een bericht (notificatie) wordt verstuurd.
	reason	string	X		Uit FHIR R4. Omschrijving waarom dit abonnement is gecreëerd.
	channel	BackboneElement	X		Uit FHIR R4. Voor gedefinieerd kanaal waar het bericht wordt verstuurd.
	channel.type	code	X		Uit FHIR R4. Ondersteunen alleen: "rest-hook" kanaal.
	channel.endpoint	url	X?		Omdat we rest-hook als kanaaltype verplichten, moet ook het endpoint vastgelegd worden. Endpoint zou niet raadbaar moeten zijn en uniek per subscription.
	channel.header	string	X?		Om DOS aanvallen te voorkomen, wordt een "Authorization" header verplicht (voor afgesproken token meesturen). Men kan ook de vastgelegde criteria in de header vastleggen.
	channel.payload	code	XXX (NIET)		Dit veld MOET NIET gebruikt worden. De notificaties worden zonder payload verstuurd. Extra informatie over een notificatie kan via de channel.header meegegeven worden.
CareTeam					Beschrijft het zorgteam met de participanten.
	identifier	Identifier	X		Elke zorgteam moet uniek te identificeren zijn a.d.h.v. een identifier, zodat we altijd de gegevens kunnen opvragen.
	status	code	X		In de context van Koppeltaal moet altijd de status van het zorgteam bekend zijn.
	subject	Reference(Patient)	X		Uit FHIR R4. Voor wie het team aan de slag is. In de context van Koppeltaal is dit een referentie naar Patient.
	period	Period			Tijdsperiode van het zorgteam.
	participant	BackboneElement			Lijst van betrokken participanten bij het zorgproces
	participant.role	CodeableConcept	x		Uit FHIR R4. Verplichte rol van de participant, bij toevoeging van participant.
	participant.member	Reference(Practitioner\|RelatedPerson)	x		Uit FHIR R4. Verplichte type participant, bij toevoeging van participant.
AuditEvent					Een logrecord van een interactie tussen systemen. Koppeltaal Logging moet het mogelijk maken "achteraf onweerlegbaar vast te stellen welke activiteiten waar en wanneer hebben plaatsgevonden.
	type	Coding	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"
	subtype	Coding	X?		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"
	action	code			Welke CRUDE acties is uitgevoerd. Zie: http://hl7.org/fhir/audit-event-action
	recorded	instant	X		Tijdstip van logmoment.
	agent.who	Reference(Device)	X?		De device actor (audit participant) van de zendende of ontvangende partij.
	agent.type	CodeableConcept	X?		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
	agent.role	CodeableConcept			Kunnen we onze applicatie rollen hier voor gebruiken, als deze zijn vastgelegd?
	agent.requestor	boolean	X		Is de agent de initiator van de gebeurtenissen, dan 'true' anders 'false'.
	entity.type	CodeableConcept	X?		Type resource. Zie: "http://hl7.org/fhir/resource-types". Zie het KT 2.0 FHIR Resource Model.
	entity.what	Reference(Any)	X?		Over welke (FHIR) resource gaat het Reference(Any). B.v: entity.what=Patient/123
	entity.name	string			resource.identifier
	source.site	string			Naam van de omgeving (domein!)
	source.observer	Reference(Device)	X		Wie heeft het gelogd. Misschien een aparte Log Device.
	source.type	Coding			Wat voor systeem is dit. Zie: http://terminology.hl7.org/CodeSystem/security-source-type

? = 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.

Beschrijving

Overwegingen

Toepassing en restricties

Eisen

Voorbeelden

Links naar gerelateerde onderwerpen

Oude tekst

Beschrijving

Rationale

Implicaties

Voorbeelden

Toepassingsgebied

Onderbouwen

Eisen

Referenties

TOP-KT-009 - Overzicht gebruikte FHIR Resources

Overwegingen

Toepassing en restricties

Eisen

Voorbeelden

Links naar gerelateerde onderwerpen

Oude tekst

Beschrijving

Rationale

Implicaties

Voorbeelden

Toepassingsgebied

Onderbouwen

Eisen

Referenties