Interfaces Resource Client
Abonnement Notificatie Interface
Algemeen
Base endpoint en FHIR-versions
De waarde van de base-URL van de FHIR endpoints die het Abonnementenregister biedt t.b.v. de Abonnement Interface ( [base] dus ), dient voor alle FHIR-interacties gelijk te zijn aan "https://<FQDN>/fhir/<fhir-version>". De waarde van <fhir-version> is dan bijvoorbeeld "R4" of "R5".
T.b.v. de Abonnement Notificatie Interface worden de volgende FHIR-versions ondersteund:
R4
HTTP-request headers
Bij iedere interactie, worden in ieder HTTP-request, de volgende HTTP headers meegezonden:
Feature | AORTA-ID HTTP Header |
|---|---|
Type | Subfeature |
Versie | 1.0.0 |
Groep | HTTP Headers |
Gepubliceerd |
|
Delta | Initiële versie van feature. |
AORTA-ID: initialRequestID=<UUID conform RFC4122>; requestID=<UUID conform RFC4122>
Het initialRequestID attribuut bevat het ID van het allereerste request in de hele keten en dient te worden opgenomen in de logbestanden van alle partijen in de keten, zodat bij foutopsporing de verschillende logbestanden aan elkaar kunnen worden gerelateerd.
Het requestID is voor iedere request message uniek. In requests wordt deze gegenereerd door de client. Ook het requestID dient te worden opgenomen in de verschillende logbestanden, zodat altijd duidelijk is op welk bericht een log entry van toepassing is.
Feature | AORTA-Version HTTP Header |
|---|---|
Type | Subfeature |
Versie | 1.0.0 |
Groep | HTTP Headers |
Gepubliceerd |
|
Delta | Initiële versie van feature. |
AORTA-Version: contentVersion=<versienummer>; acceptVersion=<versienummer>
Wanneer een Resource Server een FHIR interactie ontvangt, dan kan het a.d.h.v. de syntax van het ontvangen request afleiden om welke interactie het gaat, bijvoorbeeld "een FHIR-search naar Obervations", of "een FHIR-read van een Binary". Daarnaast is iedere interactie voorzien van een versienummer. Voor versienummering wordt gebruik gemaakt van semantic versioning.
De acceptVersion geeft aan conform welke versie(s) de interactie mag worden verwerkt en beantwoord. Het versienummer in de acceptVersion wordt gespecificeerd conform semver, dus bijvoorbeeld "2.x" of "~1.2.3 || ^2.1.0". In het algemeen geldt dat een resource server een interactie dient te verwerken conform de hoogst aangegeven acceptVersion die het zelf op dat moment kan toepassen.
De contentVersion geeft aan welke versie van de interactie daadwerkelijk is gehanteerd. In de contentVersion dient het versienummer de exacte versie van de interactie te bevatten die is gehanteerd, dus zonder wildcards of ranges, bijvoorbeeld “1”, of "2.2". De versie van een FHIR-interactie is opgenomen in het interactie-id.
HTTP-response headers
Bij iedere interactie, worden in iedere HTTP-response, de volgende HTTP headers meegezonden:
geen specifieke eisen.
FHIR-profielen
Feature | |
|---|---|
Type | Subfeature |
Versie | 1.0.0 |
Groep | FHIR-profielen |
Gepubliceerd |
|
Delta | Initiële versie van feature. |
Voorbeelden:
https://simplifier.net/vzvz/aorta-subscription-notification-vwi-contextcode
https://simplifier.net/vzvz/aorta-subscription-notification-vwi-gegevenssoort
Interacties
Notificatie
Feature | |
|---|---|
Type | Service |
Versie | 1.0.1 |
Groep | Notificatie |
Gepubliceerd |
|
Delta | AORTA-Version HTTP header verwijderd uit response op de notificatie. |
Use case |
Feature | Versie | Dependency | Aanbieder | Afnemer |
|---|---|---|---|---|
1.0.1 | 1.0 | 1.0 | ||
1.0.1 | AORTA-ID HTTP Header | * | * | |
1.0.1 | AORTA-Version HTTP Header | * | * |
Een notificatie betreft een POST van een subscription-notification Bundle op het base endpoint.
Functionele datamodel van een Notificatie
Het functionele datamodel van een Notificatie, en de mapping ervan naar FHIR is beschreven in onderstaande tabel.
Element/attribuut | Cardinaliteit | Toelichting | |
Functioneel | Technisch | ||
|---|---|---|---|
abonnement-id | SubscriptionStatus.subscripton.identifier van de aorta-subscription instance in de Bundle | 1..1 | ID van het abonnement o.b.v. deze notificatie wordt verzonden. M.b.v. dit ID kan de ontvanger van de notificatie de andere attributen van het abonnement vinden in het eigen systeem. |
gebeurtenis-object | aorta-DataReference of aorta-AuditEvent instance in de Bundle | 1..1 | Object met daarin informatie over de gebeurtenis die aanleiding was voor deze notificatie. Bijv. een VWI/ACT-entry of een LOG-regel. Ook aanwezig bij notificatie naar patiënt. |
bron-organisatie-id | Via aorta-DataReference of aorta-AuditEvent instance in de Bundle | 0..1 | Bron van de gebeurtenis. Aanwezig indien beschikbaar in de melding aan het Abonnementenregister. |
bron-applicatie-id | Via aorta-DataReference of aorta-AuditEvent instance in de Bundle | 0..1 | Bron van de gebeurtenis. Aanwezig indien beschikbaar in de melding aan het Abonnementenregister. |
De notificatie bevat de volgende elementen:
een status (FHIR resource SubscriptionStatus), met een verwijzing naar de Subscription
een kopie van de aanpassing die tot de gebeurtenis/notificatie heeft geleid. De aanpassing is een FHIR resource die overeenkomt met het element dat in de criteria benoemd is. Bijv. een
criteria = 'List?_query=vwi&patientid=123456789&gegevenssoort=12345'levert een FHIRListresource (aorta-DataReference) op.deze resources zijn samengevat in een
Bundlevan het typecollection.