Leeswijzer
Deze publicatie bevat specificaties m.b.t. het gebruik van de AORTA on FHIR (AoF) infrastructuur. Deze infrastructuur bestaat uit meerdere verschillende componenten. GBx-applicaties kunnen m.b.v. deze componenten gegevens met elkaar uitwisselen.
De specificaties zijn bedoeld voor:
ontwikkelpartners van VZVZ die AoF componenten willen bouwen;
leveranciers van xIS’en die willen weten op welke wijze zij de AoF componenten kunnen gebruiken;
medewerkers van VZVZ die AoF specificaties nodig hebben bij het vervullen van hun functie.
Specificaties voor xIS-leveranciers
De volgende specificaties zijn van toepassing voor leveranciers van xIS'en.
deze bevat een overzicht van de betrokken systemen/componenten en
een set sequence diagrammen, waarin de flow die wordt gevolgd voor verschillende interacties is beschreven.
deze bevat een overzicht van alle in AORTA geboden functionaliteit in termen van Features,
inclusief de wijzigingen van deze Features in relatie tot de vorige versie ervan.
een overzicht van alle systeemrollen die een GBx-applicatie kan implementeren.
Use Cases Resource Client (initiërende GBx-applicatie of reagerende GBZ-applicatie) - deze bevat te realiseren use cases, van waaruit interacties worden gestart met de Resource Broker, of wanneer een interactie wordt ontvangen op een callback interface (Abonnement Notificatie).
Use Cases Resource Server (reagerende GBZ-applicatie) - deze bevat te realiseren use cases, waarbij een onderverdeling is gemaakt tussen
use cases die worden getriggered door een FHIR-interactie (xIS'en die een HL7-FHIR koppelvlak bieden).
use cases die worden getriggered door een HL7v3-interactie (xIS'en die een HL7v3 koppelvlak bieden).
Generieke aspecten m.b.t. interfaces:
Interfaces Algemeen - generieke eisen voor server-to-server interfaces. Uitzonderingssituaties die kunnen optreden zijn altijd omschreven in de use case van de component die de betreffende interface biedt. Bijvoorbeeld, uitzonderingen die kunnen optreden bij gebruik van de Routing Info Interface, zoals geboden door de Adressering Server, zijn beschreven in Use Cases Adressering Server.
Token specificaties - specificaties van gebruikte tokens.
hier is de interface beschreven voor het verkrijgen van een AORTA Stelseltoken, dit token bevat de URL’s van alle componenten die een rol spelen in de AORTA infrastructuur.
overzicht van alle beschikbare FHIR en v3 interacties.
Interfaces die worden gebruikt door Resource Clients:
AORTA Stelsel Metadata Interface - verkrijgen van informatie (base-URL’s) van beschikbare VZVZ-componenten, bijvoorbeeld t.b.v. door Resource Client, aan te roepen interfaces.
Routing Info Interface - verkrijgen van routeringsinformatie t.b.v. een, via de Resource Broker, te initiëren FHIR-interactie bij een specifieke Resource Server.
AORTA Token Exchange Interface - verkrijgen van een AORTA access_token, dat nodig is om FHIR-interacties te kunnen initiëren bij de Resource Broker.
AORTA FHIR Resource Broker Interface - initiëren van FHIR-interacties bij de Resource Broker zelf, of bij een of meerdere Resource Servers (via de Resource Broker).
AORTA v3 Resource Broker Interface - initiëren van v3-interacties bij een of meerdere Resource Servers, via de Resource Broker.
Applicatie Register Interface - activeren van TKID('s).
Actualiteitsregister Interface - aanmelden/bijwerken, verwijderen en opvragen van entries in/bij de Verwijsindex/Actualiteitsregister. Technisch verloopt dit via Resource Broker ZA-in.
Abonnementenregister Interface - registeren, wijzigen, opvragen en verwijderen van Abonnementen op Notificaties bij wijzigingen in Verwijsindex/Actualiteitsregister of in de Toegangslog. Technisch verloopt dit via Resource Broker ZA-in.
RB-Logging Interface - opvragen van de berichtenlog van de Resource Broker. Wordt momenteel slechts gebruikt door GBP-applicaties. Technisch verloopt dit via Resource Broker ZA-in.
Interfaces die worden geboden door Resource Clients (callback):
Abonnement Notificatie Interface - ontvangen van notificaties n.a.v. een genomen Abonnement.
Toestemming Notificatie Interface - ontvangen van notificaties n.a.v. wijzigingen in Mitz toestemmingen.
Interfaces die worden gebruikt door Resource Servers:
AORTA Stelsel Metadata Interface - verkrijgen van betrouwbare URL van, door Resource Server, aan te roepen interfaces en van FQDN van betrouwbare clients die een Resource Server kunnen aanroepen.
AS Metadata Interface - verkregen van JWKS t.b.v. controle van signature AORTA access_token.
Interfaces die worden geboden door Resource Servers:
AORTA CapabilityStatement Interface - interface wordt door Resource Broker aangeroepen t.b.v. toetsing connectiviteit.
AORTA FHIR Resource Interface - te implementeren AORTA-specifieke schil (HTTP-headers) om, door Resource Server geboden FHIR-interfaces.
Programma's van Eisen:
Programma van Eisen GBx - deze bevat generieke eisen die van toepassing zijn op GBx-applicaties en GBx'en.
Wijzigingen t.o.v. AoF 0.7
Wijzigingen voor reeds op AoF 0.7 aangesloten bronsystemen (Resource Servers):
Aanscherping gebruik van OperationOutcomes m.b.t. gebruikte zoekparameters.
Aanpassen scope van AORTA access_token naar SMART-on-FHIR v2. Inclusief fine-grained scopes.
CapabilityStatement kunnen opleveren voor alle ondersteunde fhir-versions.
Aanpassing (interface) Adressering Server.
Toevoeging van major versienummer aan interfaces van componenten. Aanroep van token exchange ook iets aangepast naar “tokenx”.
AORTA-Version header optioneel gemaakt op RB *-in interfaces.
Specifieke wijzigingen voor reeds op AoF 0.7 aangesloten systemen voor notified-pull:
Om een notificatie te kunnen sturen via het Twiin afsprakenstelsel, zal een Resource Client in de audience van een token exchange request een appID (van het AORTA GTK) én een URA (van de Receiver) moeten meegeven.
Consent_token mag slechts worden gesigned met een UZI-servercertificaat.
Het kunnen ontvangen van AORTA access_tokens met een lokaal gebruikers-id.
Afhankelijk van besluitvorming in Twiin en in AORTA volgen in een later stadium mogelijk nog andere wijzigingen, waaronder
het kunnen ontvangen van een notificatie (en AORTA access_token) zonder BSN van patient en/of zonder informatie over uit te voeren queries (vereist een wijziging in het FHIR-profiel van de notificatie).
het kunnen opvragen en verwerken van een workflow-Task bij de Sender van een notificatie.
het ondersteunen van FHIR STU3 gebaseerde Tasks (notificatie- en/of workflow-Task).
het kunnen ontvangen van een notificatie op vertrouwensniveau Laag.
het mogen verzenden van een notificatie op vertrouwensniveau Laag.
het kunnen ontvangen van een opvraag van BGZ en/of Documenten op vertrouwensniveau Laag (wel met attest in AORTA access_token die aangeeft dat het gaat om een pull na notificatie).
het mogen opvragen van BGZ en/of Documenten op vertrouwensniveau Laag (wel onder meezenden van een ontvangen consent_token in het token exchange request).
het ondersteunen van een “wijzigen notificatie” (verzenden en ontvangen).
het ondersteunen van een “cancel notificatie” (verzenden en ontvangen).