...
| Expand | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||
|
Beschrijving
Elke resource moet uniek identificeerbaar zijn door de business en technische systemen. Hypermedia/links kunnen hierbij gebruikt worden om referenties of verwijzingen naar resources te gebruiken.
...
Voor correct gebruik van Identifiers wordt verwezen naar: IDR - Eisen (en aanbevelingen) voor identifiers en referenties
In deze topic wordt onderscheid gemaakt in Logische ID, Bedrijfsidentifier, Referenties en Referentie integriteit.
Logische ID
Overwegingen
Elke resource heeft een ID-element dat de "logische ID" (logical ID) bevat.
...
Bedrijfsidentifier
Een "bedrijf identifier" wordt gebruikt om resources uniek te kunnen identificeren met (andere) systemen, die in andere omgevingen/domeinen aanwezig zijn.
Bijvoorbeeld elke patiënt kan men identificeren a.d.h.v. een e-mail adres (geregistreerd bij IRMA) of een BSN, een zorgverlener kan men identificeren via zijn AGB code en een taak kan men identificeren aan een Taaknummer.
Met de hulp van de "bedrijfsidentifier" kan je altijd achterhalen of de resource instantie al aanwezig en bekend is. Hiermee kan men vervolgens ook de "logische ID" achterhalen, als deze resource instantie bij de FHIR Resource Provider is aangemeld.
Referenties
De "logische ID" (logical ID) wordt gebruikt als referentie in resources.
Referentie integriteit
Aanname is dat de gebruikte FHIR (Resource) Provider referentie integriteit afdwingt.
...
De Logische ID dient uniek te zijn zodat de resource eenduidig terug te vinden is of naar verwezen kan worden. Verder is moet de logische ID een identifier zijn die met voorkeur slecht te raden is en geen probleem vormt bij toekomstige migratie en integraties tussen systemen. Om deze reden stelt koppeltaal dat de logische id een UUID versie 4 (rfc4122) moet zijn.
Toepassing en restricties
Volgens de FHIR standaard:
Wanneer een nieuwe resource wordt aangemeld bij de FHIR Resource Provider, geeft de FHIR Resource Provider een nieuwe uniek logische id af binnen het domein van alle resources
...
op dezelfde FHIR Resource Provider.
Eenmaal toegewezen door de FHIR Resource Provider, wordt de "logische id" NOOIT gewijzigd. Een nieuwe logische ID betekent namelijk een nieuwe resource-instantie.
De locatie van een resource-instantie is een absolute (locatie) URL die is samengesteld uit het basisadres waarop de instantie is gevonden, het resourcetype en de logische ID, zoals: https:/vzvz.fhir.nl/Patient/
...
d9333b01-4491-42d3-b670-3cedc6c88a00 (waarbij d9333b01-4491-42d3-b670-3cedc6c88a00 de logische id van een patiënt is).
Wanneer een resource wordt gekopieerd van de ene provider naar een andere provider, kan de kopie al dan niet dezelfde logische id op de nieuwe server behouden. Dit is afhankelijk van replicatie en beleid.
Bedrijfsidentifier
- Naast de "logische ID" (logical ID) moet bij de resource ook minimaal één "bedrijf identifier" (business identifier) element gebruikt worden, die door de cliënt applicatie worden toegekend, die het originele bronsysteem is.
- De applicatie die een nieuwe resource instantie creëert en publiceert MOET het bedrijfsidentifier element (Identifier type) specificeren, als het identifier element in de resource instantie beschikbaar is.
Referenties
- De "logische ID" (logical ID) wordt eenmaal toegewezen
EN - wijzigt NOOIT.
Referentie integriteit
- Resources moeten altijd worden aangeboden in dezelfde volgorde waarin referenties verwijzen naar reeds bestaande resources. In het geval dat er een eHealth Taak wordt aangeboden, zullen dus eerst de eHealth Activiteit (ActivityDefinition) en Patient resource waar deze eHealth Taak naar verwijst moeten bestaan.
...
Bedrijfsidentifier
...
| language | js |
|---|---|
| title | Patient.identifier |
...
Specifiek voor Koppeltaal:
De applicaties mogen zelf geen Logische ID's toekennen.
De logische ID is een UUID (rfc4122), versie 4.
Voorbeelden
Patient.id
|
|
|
Opvragen a.d.h.v een Patient.
...
id
|
|
Referenties
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"resourceType": "Task",
"for":
{
"reference": "Patient/61",
"type": "Patient"
}
} |
Elke resource moet uniek identificeerbaar zijn door de business en technische systemen. Hypermedia/links kunnen hierbij gebruikt worden om referenties of verwijzingen naar resources te gebruiken.
Logische ID
Elke resource heeft een id element dat de "logische ID" (logical ID) bevat van de resource die toegewezen MOET worden door de FHIR Resource Provider, die verantwoordelijk is voor het opslaan en beheren van de resource. Wanneer een nieuwe resource wordt aangemeld bij de FHIR Resource Provider, geeft de FHIR Resource Provider een nieuwe uniek logische id af binnen het domein van alle resources van hetzelfde type op dezelfde FHIR Resource Provider. Eenmaal toegewezen door de FHIR Resource Provider, wordt de "logische id" NOOIT gewijzigd.
De locatie van een resource-instantie is een absolute (locatie) URL die is samengesteld uit het basisadres waarop de instantie is gevonden, het resourcetype en de logische ID, zoals: https:/vzvz.fhir.nl/Patient/123 (waarbij 123 is de logische id van een patiënt).
Wanneer een resource wordt gekopieerd van de ene provider naar een andere provider, kan de kopie al dan niet dezelfde logische id op de nieuwe server behouden. Dit is afhankelijk van replicatie en beleid.
Bedrijf identifier
...
|
Bedrijfsidentifier
Overwegingen
Een "bedrijfsidentifier" wordt gebruikt om resources uniek te kunnen identificeren met (andere) systemen, die in andere omgevingen /domeinen aanwezig zijn. Bijvoorbeeld elke patiënt kan men identificeren a.d.h.v.
Een patiënt kan bijvoorbeeld geidentificeerd worden aan de hand van een e-mail adres (geregistreerd bij IRMA) of een BSNpatientnummer. Een Een zorgverlener kan men identificeren via zijn AGB code. Een taak kan men identificeren aan een Taaknummer.
Met de hulp van de "bedrijf identifierbedrijfsidentifier" kan je altijd achterhalen of de resource instantie al aanwezig en bekend is. Hiermee kan men vervolgens ook de de "logische ID" achterhalen, als waaronder deze resource instantie bij de FHIR Resource Provider is aangemeld. Daarnaast kan de bedrijfsidentifier gebruikt worden om de relatie tussen de eigen entitetiten en de server weer op te bouwen als deze verloren is geraakt.
Koppeltaal stelt geen eisen aan welke identifiers gebruikt worden, zolang het bronsysteem de resource eenduidig kan relateren.
Voorbeeld:
...
Toepassing en restricties
Volgens de FHIR standaard:
Naast de "logische ID" (logical ID) kan bij de resource ook één tot meerdere "bedrijf identifier" (business identifier) element(en) gebruikt worden.
Specifiek voor Koppeltaal:
De applicatie die een nieuwe resource instantie creëert en publiceert MOET het bedrijfsidentifier element (Identifier type) specificeren, als het identifier element in de resource instantie verplicht is.
Optioneel mogen andere applicaties ook bedrijfsidentifiers toekennen.
Voorbeelden
Patient.identifier
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
Zoekopdracht
...
|
...
|
Opvragen a.d.h.v een Patient.identifier
|
...
|
...
Referenties
...
| title | Bedrijf identifier specificeren |
|---|
De applicatie die een nieuwe resource instantie creëert en publiceert MOET het bedrijf identifier element (Identifier type) specificeren, als het identifier element in de resource instantie beschikbaar is.
Referenties
...
Overwegingen
...
De "logische ID" (logical ID) wordt gebruikt kan in combinatie met de resource type gebruikt worden als referentie in resources, omdat een eenmaal toegewezen "logische id" NOOIT wijzigt.
Voorbeeld:
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"resourceType": "Task",
"for":
{
"reference": "Patient/61",
"type": "Patient"
}
} |
Referentie integriteit
Aanname is dat de gebruikte FHIR (Resource) Provider referentie integriteit afdwingt, waardoor resources altijd moeten worden aangeboden in zo'n volgorde dat referenties verwijzen naar reeds bestaande resources. In het geval dat er een eHealth Taak wordt aangeboden, zullen dus eerst de eHealth Activiteit (ActivityDefinition) en Patient resource waar naar deze eHealth Taak verwijst moeten bestaan.
. Dit wordt dan een zogeheten "literal" reference. Zie ook: https://www.hl7.org/fhir/references.html#literal
Toepassing en restricties
Specifiek voor Koppeltaal:
De Logische referentie (op basis van bedrijfsidentifier) wordt in Koppeltaal niet gebruikt.
Voorbeelden
"Literal" referentie
|
Referentie integriteit
De FHIR resource service MOET referentiële integratie afdwingen. Dit houdt in dat er enkel naar resources gerefereerd kan worden indien deze ook daadwerkelijk bestaan in de FHIR resource service. Deze integriteit MOET op zowel “write” als “delete” interacties gewaarborgd worden.
Write integriteit
Aangezien gerefereerde resources altijd moeten bestaan, is de volgorde van resources aanmaken van belang. Bijvoorbeeld bij het aanmaken van een Task , kan dit de volgorde zijn van resources aanmaken:
Patient → Practitioner → Endpoint → ActivityDefinition → Task
Logical Delete integriteit
Koppeltaal raadt het gebruik van logical deletes af. By default zal het RBAC permissie-model ook voorkomen dat deze actie uitgevoerd kan worden door applicatie-instanties. Indien de logical delete toch gebruikt wordt, moet de referentiële integriteit bewaakt worden. De regel is: een referentie MOET refereren naar een bestaand, non-deleted, object. Zo is het verwijderen van een Task vaak simpel, omdat hier nauwelijks naar gerefereerd wordt. In het geval van een Patient delete is de kans op integriteitsproblemen veel groter. Een Task of een Practitioner verwijzen bijvoorbeeld vaak naar een Patient resource. Indien een delete niet voldoet aan de referentiële integriteit MOET de server de request afkeuren middels met een HTTP 409 Conflict .
Uitzondering logical delete integriteit
De FHIR resource service maakt gedurende vele interacties automatisch een log aan in de vorm van een AuditEvent. Deze kan refereren naar een resource via het AuditEvent.entity.what veld. Wanneer de gerefereerde entiteit wordt verwijderd, moet de AuditEvent blijven bestaan. De FHIR resource service MOET een uitzondering bouwen in de referentiële integriteit voor het FHIRPath AuditEvent.entity.what tijdens een logical delete.
Eisen
IDR - Eisen (en aanbevelingen) voor identifiers en referenties
Links naar gerelateerde onderwerpen
Logische ID: https://www.hl7.org/fhir/resource.html#id
UUID: https://datatracker.ietf.org/doc/html/rfc4122
Bedrijfsidentifier http://hl7.org/fhir/R4/datatypes.html#identifier
Referentie: https://www.hl7.org/fhir/references.html