Interfaces Resource Broker GTK

AORTA CapabilityStatement Interface

Feature	capabilities-GTK
Type	Service
Versie	1.0.0
Systeemrolcode	-
Groep	GTK
Gepubliceerd	15 Feb 2024
Delta	Initiële versie van feature. NB. dit Feature is niet vereist wanneer RB GTK en RB VnC in dezelfde omgeving worden beheerd, EN het ook niet gaat worden vereist vanuit TWIIN.
Use case	AOF-UC.RS.050.v1

Resource server biedt op zijn endpoint een CapabilityStatement aan. Een resource client kan het statement als volgt bij de resource server opvragen:

GET [base]/metadata {?_format=[mime-type]}

Het gaat hier om een CapabilityStatement van het type "Instance", oftewel het bevat informatie over de daadwerkelijke installatie die benaderbaar is. Bovenstaande capabilities interactie is binnen FHIR verplicht voor FHIR servers en dient binnen AORTA als een equivalent van de Ping-Pong interactie in HL7v3.

Let op: de capabilities interactie wordt geboden in de <fhir-version> die geldt voor het betreffende endpoint.

Op deze interface worden de additionele HTTP headers, die gelden voor de AORTA FHIR Resource Interface, NIET toegepast.

HTTP statuscodes

HTTP statuscodes die kunnen worden geretourneerd zijn opgenomen in onderstaande tabel.

Omdat bepaalde Confluence macro’s nog niet worden ondersteund in de publicatie omgeving, bevat de tabel, in de publicatieomgeving, ook informatie over de wijze waarop de betreffende interface wordt geïmplementeerd in de server component. De statuscodes die kunnen worden geretourneerd zijn opgenomen in de kolom “Uitkomst”. De overige informatie mag worden genegeerd.

Stap	Omschrijving	Uitkomst
1	Het systeem ontvangt een verzoek en start de verwerking.
2	Het systeem toetst of het verzoek voldoet aan de interface specificatie.	Ongeldig verzoek statuscode 400 Bad Request
2		Het systeem genereert de vereiste response en gaat verder met de exit stap van de main flow.
3 <exit>	Het systeem retourneert een response naar de primaire actor.	Verwerking succesvol statuscode 200 OK

AORTA FHIR Resource Interface

Deze interface is slechts bedoeld voor gebruik door VZVZ-componenten, en kan niet (rechtstreeks) worden gebruikt door GBx-applicaties.

Feature	core-FHIR-interactie-GTK-uit
Type	Abstracte Service
Versie	1.0.1
Systeemrolcode	-
Groep	GTK
Gepubliceerd	21 Jun 2024
Delta	Component logging toegevoegd aan de use case. Fix: AORTA access_token moet worden gevalideerd op de wijze waarop een Resource Server dit doet.
Use case	AOF.UC.RBGTK.200.v2

Feature	Versie	Dependency	Aanbieder	Afnemer
core-FHIR-interactie-GTK-uit	1.0.1	AORTA Stelseltoken	>=*	>=*
core-FHIR-interactie-GTK-uit	1.0.1	AORTA-ID HTTP Header	>=1.0.0	>=1.0.0
core-FHIR-interactie-GTK-uit	1.0.1	AORTA-Version HTTP Header	>=1.0.0	>=1.0.0
core-FHIR-interactie-GTK-uit	1.0.1	Authorization HTTP Header	>=1.0.0	>=1.0.0
core-FHIR-interactie-GTK-uit	1.0.1	AORTA access_token	>=*	-
core-FHIR-interactie-GTK-uit	1.0.1	getMetadataZA	>=1.0.0	-
core-FHIR-interactie-GTK-uit	1.0.1	Issue TWIIN Assertions	>=1.*	-

Zie interface specificaties van de Resource Server.

FHIR interacties die worden ondersteund zijn:

AORTA FHIR create
AORTA FHIR read
AORTA FHIR update
AORTA FHIR search
AORTA FHIR batch/transaction

TWIIN FHIR Resource Interface

Deze interface is slechts bedoeld voor gebruik door Twinn GTK’s, en kan niet (rechtstreeks) worden gebruikt door GBx-applicaties.

Feature	core-FHIR-interactie-GTK-in
Type	Abstracte Service
Versie	1.1.1
Systeemrolcode	-
Groep	GTK
Gepubliceerd	23 Sep 2024
Delta	Bug fix: Wijzigen ID van initiërend systeem in notification-Task naar appID van RB GTK.
Use case	AOF.UC.RBGTK.100.v3

Feature	Versie	Dependency	Aanbieder	Afnemer
core-FHIR-interactie-GTK-in	1.1.1	AORTA Stelseltoken	>=*	-
core-FHIR-interactie-GTK-in	1.1.1	AORTA access_token	>=*	-
core-FHIR-interactie-GTK-in	1.1.1	getMetadataZA	>=1.0.0	-
core-FHIR-interactie-GTK-in	1.1.1	Initiëren reguliere FHIR-interactie	>=1.*	-
core-FHIR-interactie-GTK-in	1.1.1	Uitvoeren push-aorta-data	>=1.*	-

Inkomend FHIR request

Zie: https://twiin-afsprakenstelsel.scrollhelp.site/ta12/10-3-1-twiin-01-send-notification-task#id-10.3.1%7CTwiin-01%7CSendNotificationTask-Requestmessage

De waarde van de base-URL van de FHIR endpoints die het GTK biedt ( [base] dus ), dient voor alle FHIR-interacties gelijk te zijn aan:

https://<FQDN>{</path extension>}/fhir/<fhir-version>/<twiin-interface-version>{/<app-id>}

De waarde van <fhir-version> is dan bijvoorbeeld "STU3", "R4" of "R5".

De waarde van <twiin-interface-version> is de major versie van de Technische Kern binnen Twiin die door het GTK wordt geïmplementeerd. Deze is gelijk aan “v1”.

Voor instance-level interacties (bijvoorbeeld een FHIR-read of een FHIR-update) dient het <app-id> van de GBZ-applicatie die fungeert als Resource Server te worden toegevoegd aan de base-URL. Voor FHIR-search interacties mag een <app-id> ook worden toegevoegd, maar is het niet verplicht. Een <app-id> die wordt gebruikt in de base-URL dient overeen te komen met het app-id dat is opgenomen in de audience van het gebruikte AORTA access_token.

Geretourneerde FHIR-response

Zie: https://twiin-afsprakenstelsel.scrollhelp.site/ta12/10-3-1-twiin-01-send-notification-task#id-10.3.1%7CTwiin-01%7CSendNotificationTask-Responsemessage

HTTP statuscodes

HTTP statuscodes die kunnen worden geretourneerd zijn opgenomen in onderstaande tabel.

Omdat bepaalde Confluence macro’s nog niet worden ondersteund in de publicatie omgeving, bevat de tabel, in de publicatieomgeving, ook informatie over de wijze waarop de betreffende interface wordt geïmplementeerd in de server component. De statuscodes die kunnen worden geretourneerd zijn opgenomen in de kolom “Uitkomst”. De overige informatie mag worden genegeerd.

AOF.UCe.VAL.100.v1 - Toetsing type content		Uitkomst
Stap	Omschrijving	Uitkomst
i	Het systeem ontvangt een verzoek en start de verwerking. Het systeem toetst of het gevraagde type content (Accept header) en het gehanteerde type content (Content-Type header) worden ondersteund. NB. wanneer het verzoek wordt ontvangen van een component van VZVZ, dan hoeft geen toets op type content te worden uitgevoerd.	Gevraagd type content niet ondersteund statuscode 406 Not Acceptable
		Gehanteerd type content niet ondersteund statuscode 415 Unsupported Media Type
		Het systeem genereert de vereiste response en gaat verder met de exit stap van de main flow.

AOF.UCe.VAL.200.v1 - Toetsing tokens bij inkomend request		Uitkomst
Stap	Omschrijving	Uitkomst
i	Het systeem controleert of alle vereiste tokens zijn toegevoegd aan het request	Ontbrekend token statuscode 401 Unauthorized In deze situatie wordt geen nadere informatie over de opgetreden fout geretourneerd. In deze situatie wordt, conform RFC 6750, ook een WWW-Authenticate HTTP response header met als auth-scheme "Bearer", maar zonder foutcode of nadere informatie omtrent de fout geretourneerd. Indien de `WWW-Authenticate` HTTP response header wordt geproduceerd door de resource broker, dan wordt een `realm` attribuut met waarde "`aorta`" toegevoegd.
i		Het systeem genereert de vereiste response en gaat verder met de exit stap van de main flow.
ii	Het systeem controleert de geldigheid van de meegezonden, van toepassing zijnde, tokens MedMij access_token, zoals omschreven in de toelichting de sectie "Toetsing MedMij access_token". DigiD Authenticatietoken, géén toetsing vereist door Resource Broker. AORTA access_token, zoals omschreven in de sectie "Toetsing AORTA access_token". Welke tokens van toepassing zijn is beschreven in de interface specificaties die horen bij deze use case.	Ongeldig token statuscode 401 Unauthorized In deze situatie wordt, conform RFC 6750, ook een `WWW-Authenticate` HTTP response header met als auth-scheme "`Bearer`" en een `error` attribuut met waarde "`invalid_token`" geretourneerd. Indien de `WWW-Authenticate` HTTP response header wordt geproduceerd door de resource broker, dan wordt een `realm` attribuut met waarde "`aorta`" toegevoegd. In deze situatie mag daarnaast ook een OperationOutcome met issue.code "`security`" worden geretourneerd.
ii		Het systeem genereert de vereiste response en gaat verder met de exit stap van de main flow.

AOF.UCe.VAL.150.v2 - Inhoudelijke toetsing request		Uitkomst
Stap	Omschrijving	Uitkomst
i	Het systeem toetst of het request geen malafide inhoud bevat (zie FHIR security, input validation).	Ongeldig FHIR-verzoek statuscode 400 Bad Request Wanneer een verplichte FHIR zoekparameter ontbreekt, dan wordt een OperationOutcome met issue.code "`required`" en de van toepassing zijnde issue.details geretourneerd. Wanneer een verplichte FHIR zoekparameter een ongeldige waarde heeft, d.w.z. een waarde die niet is gespecificeerd binnen de gegevensdienst, dan wordt een OperationOutcome met issue.code "`value`" en de van toepassing zijnde issue.details geretourneerd; Wanneer een ontvangen FHIR resource instance ongeldig is, dan wordt een OperationOutcome met issue.code "`invalid`" en de van toepassing zijnde issue.details geretourneerd. In deze situatie wordt, indien van toepassing, conform RFC 6750, ook een `WWW-Authenticate` HTTP response header met als auth-scheme "`Bearer`" en een `error` attribuut met waarde "`invalid_request`" geretourneerd. Indien de `WWW-Authenticate` HTTP response header wordt geproduceerd door de resource broker, dan wordt een `realm` attribuut met waarde "`aorta`" toegevoegd.
i		Het systeem genereert de vereiste response en gaat verder met de exit stap van de main flow.
ii	Het systeem bepaalt, m.b.v. de interactietabel en m.b.v. de _vrb_ter_scope claim in het AORTA access_token, welk interactie-id van toepassing is op het ontvangen request. Zie ook de toelichting "Bepalen van het interactie-id".	Ongeldig FHIR-verzoek statuscode 400 Bad Request Wanneer een verplichte FHIR zoekparameter ontbreekt, dan wordt een OperationOutcome met issue.code "`required`" en de van toepassing zijnde issue.details geretourneerd. Wanneer een verplichte FHIR zoekparameter een ongeldige waarde heeft, d.w.z. een waarde die niet is gespecificeerd binnen de gegevensdienst, dan wordt een OperationOutcome met issue.code "`value`" en de van toepassing zijnde issue.details geretourneerd; Wanneer een ontvangen FHIR resource instance ongeldig is, dan wordt een OperationOutcome met issue.code "`invalid`" en de van toepassing zijnde issue.details geretourneerd. In deze situatie wordt, indien van toepassing, conform RFC 6750, ook een `WWW-Authenticate` HTTP response header met als auth-scheme "`Bearer`" en een `error` attribuut met waarde "`invalid_request`" geretourneerd. Indien de `WWW-Authenticate` HTTP response header wordt geproduceerd door de resource broker, dan wordt een `realm` attribuut met waarde "`aorta`" toegevoegd.
ii		Het systeem genereert de vereiste response en gaat verder met de exit stap van de main flow.
iii	Het systeem toetst of het verzoek voldoet aan de interface specificatie. Hierbij moet ook worden voldaan aan de toelichting "Controle van batch en transaction requests". FHIR-requests dienen te worden getoetst tegen de core FHIR specificaties (RESTful API). Indien een `If-None-Exists` HTTP header van toepassing is op de interactie, dan dient deze te worden behandeld als een reguliere zoekparameter. Indien een specifieke FHIR-profiel van toepassing is voor het gevonden interactie-id, dan dient het FHIR-request hier ook tegen te worden getoetst. NB. toetsing tegen een volledig FHIR-profiel wordt nog niet gedaan - consequenties van deze toets worden eerst in kaart gebracht.	Ongeldig FHIR-verzoek statuscode 400 Bad Request Wanneer een verplichte FHIR zoekparameter ontbreekt, dan wordt een OperationOutcome met issue.code "`required`" en de van toepassing zijnde issue.details geretourneerd. Wanneer een verplichte FHIR zoekparameter een ongeldige waarde heeft, d.w.z. een waarde die niet is gespecificeerd binnen de gegevensdienst, dan wordt een OperationOutcome met issue.code "`value`" en de van toepassing zijnde issue.details geretourneerd; Wanneer een ontvangen FHIR resource instance ongeldig is, dan wordt een OperationOutcome met issue.code "`invalid`" en de van toepassing zijnde issue.details geretourneerd. In deze situatie wordt, indien van toepassing, conform RFC 6750, ook een `WWW-Authenticate` HTTP response header met als auth-scheme "`Bearer`" en een `error` attribuut met waarde "`invalid_request`" geretourneerd. Indien de `WWW-Authenticate` HTTP response header wordt geproduceerd door de resource broker, dan wordt een `realm` attribuut met waarde "`aorta`" toegevoegd.
iii		Het systeem genereert de vereiste response en gaat verder met de exit stap van de main flow.

AOF.UCe.VAL.300.v1 - Toetsing scope van request

Uitkomst

Stap

Omschrijving

i

Het systeem controleert of het ontvangen resource request is toegestaan binnen de scope van het access_token. Zie ook de toelichting "Controle of request binnen scope valt" en de toelichting "Controle van batch en transaction requests".

Scope is niet toereikend

statuscode 403 Forbidden

In deze situatie wordt, conform RFC 6750, ook een WWW-Authenticate HTTP response header met als auth-scheme "Bearer" en een error attribuut met waarde "insufficient_scope" geretourneerd. Indien de WWW-Authenticate HTTP response header wordt geproduceerd door de resource broker, dan wordt een realm attribuut met waarde "aorta" toegevoegd.
In deze situatie mag daarnaast ook een OperationOutcome met issue.code "forbidden" of "security" worden geretourneerd.

Het systeem genereert de vereiste response en gaat verder met de exit stap van de main flow.

De stappen in onderstaande tabel worden slechts uitgevoerd indien een notification-Task wordt ontvangen met de indicatie dat een workflow-Task moet worden opgevraagd (attribuut get-workflow-task is aanwezig en heeft waarde true).

Indien een workflow-Task moet worden opgevraagd		Uitkomst
Stap	Omschrijving	Uitkomst
i	Het systeem verkrijgt, o.b.v. de URA in de audience van het ontvangen AORTA access_token, via ZORG-AB het authorization endpoint en het resource endpoint van de zorgaanbieder aan wie het ontvangen resource request moet worden doorgezet. NB. omdat verwacht wordt dat ZORG-AB hiervoor niet tijdig geschikt zal zijn, wordt in eerste instantie gewerkt met een interne registratie in het systeem, waarbij per URA een authorization endpoint en een resource endpoint worden vastgelegd.	Endpoints niet gevonden binnen Twiin statuscode 500 Internal Server Error
		Fout bij bepalen endpoints statuscode 500 Internal Server Error
		Het systeem genereert de vereiste response en gaat verder met de exit stap van de main flow.
ii	Het systeem verkrijgt m.b.v. Feature Issue TWIIN Assertions een client_assertion en zonodig een assertion om te gebruiken bij het gevonden authorization endpoint. Indien de ontvangen notification-Task een authorization_base bevat, dan moet deze worden doorgegeven in het issueAssertionsRequest, zodat deze kan worden toegevoegd aan de uit te geven assertion.	Geen assertions verkregen statuscode 500 Internal Server Error
ii		Het systeem genereert de vereiste response en gaat verder met de exit stap van de main flow.
iii	Het systeem verzendt, conform het Twiin afsprakenstelsel, een token request naar het gevonden authorization endpoint. De scope van het token request wordt gevuld met `"system/Task.r"`.
iv	Het systeem ontvangt een token response.	Geen access_token verkregen statuscode 403 Forbidden Indien een `Authorization` header werd gebruikt in het request, dan wordt in deze situatie, conform RFC 6750, een `WWW-Authenticate` HTTP response header met als auth-scheme "`Bearer`" en een `error` attribuut met waarde "`access_denied`" geretourneerd. Indien de `WWW-Authenticate` HTTP response header wordt geproduceerd door de resource broker, dan wordt een `realm` attribuut met waarde "`aorta`" toegevoegd. Indien het een FHIR-request betreft, dan wordt in deze situatie (ook) een OperationOutcome met issue.code "`forbidden`" geretourneerd.
iv	Het systeem ontvangt een token response.	Het systeem genereert de vereiste response en gaat verder met de exit stap van de main flow.
v	Het systeem verzend, conform het Twiin afsprakenstelsel, het ontvangen resource request naar het gevonden resource endpoint. Het gaat hier om een FHIR-read van de workflow-Task, zoals opgenomen in de `basedOn` van de ontvangen notification-Task.
vi	Het systeem ontvangt een response.	Geen (tijdig) antwoord van secundaire actor statuscode 504 Gateway Timeout
vi	Het systeem ontvangt een response.	Het systeem genereert de vereiste response en gaat verder met de exit stap van de main flow.
vii	Het systeem voegt de volgende informatie uit de ontvangen workflow-Task toe aan de eerder ontvangen notification-Task: alle `input:read-available-resource` elementen alle `input:query-available-resources` elementen het BSN van de patiënt (de `for` van de workflow-Task dient een `identifier` te bevatten met een BSN)	Géén enkele input en/of geen BSN aanwezig in workflow-Task statuscode 400 Bad Request
vii		Het systeem genereert de vereiste response en gaat verder met de exit stap van de main flow.

De stappen in onderstaande tabel worden slechts uitgevoerd indien een notification-Task werd ontvangen, met daarbij een AORTA access_token zonder een patient claim.

Indien AORTA access_token ontvangen zonder patient claim		Uitkomst
Stap	Omschrijving	Uitkomst
i	Het systeem gebruikt Feature GetTokenRequest om een AORTA access_token te verkrijgen. Hierbij worden de volgende attributen gebruikt: client.organisationId - wordt gevuld met de URA uit de _vrb_ion uit het ontvangen AORTA access_token client.applicationId - wordt gevuld met het appID uit de _vrb_client_id van het ontvangen AORTA access_token (dit is het appID van Resource Broker GTK) destination.organisationId - wordt gevuld met de URA uit de aud het ontvangen AORTA access_token scope - wordt gevuld met de vrb_ter_scope (zonder eventuele transformatie-id’s) uit het ontvangen AORTA access_token (deze is dan gelijk aan de scope die werd gebruikt om het access_token zonder BSN aan te vragen) patient - wordt gevuld met het patient BSN uit de verkregen workflow-Task user.userId - wordt gevuld met de sub uit het ontvangen AORTA access_token user.userRole - wordt gevuld met de role uit het ontvangen AORTA access_token user.acr - wordt gevuld met de acr uit het ontvangen AORTA access_token
ii	Het systeem retourneert een response naar de primaire actor.	Geen access_token verkregen statuscode 403 Forbidden Indien een `Authorization` header werd gebruikt in het request, dan wordt in deze situatie, conform RFC 6750, een `WWW-Authenticate` HTTP response header met als auth-scheme "`Bearer`" en een `error` attribuut met waarde "`access_denied`" geretourneerd. Indien de `WWW-Authenticate` HTTP response header wordt geproduceerd door de resource broker, dan wordt een `realm` attribuut met waarde "`aorta`" toegevoegd. Indien het een FHIR-request betreft, dan wordt in deze situatie (ook) een OperationOutcome met issue.code "`forbidden`" geretourneerd.
ii		Het systeem genereert de vereiste response en gaat verder met de exit stap van de main flow.

Stap	Omschrijving	Uitkomst
1	Indien het ontvangen verzoek een notification-Task betreft: Het systeem wijzigt de inhoud van het het attribuut die de ID van het initiërende systeem bevat (`requester.agent.identifier`) naar de appID van zichzelf, Resource Broker GTK dus.
2	Het systeem initieert de use case Verzenden & Consolideren benodigde interacties middels de Verzending & Consolidatie Interface. Het kan hierbij gaan om een push-aorta-data operatie (de ontvangen interactie wordt in de AORTA interactietabel gekenmerkt als een “push” interactie) een reguliere FHIR-interactie, bijvoorbeeld een FHIR-search of een FHIR-read (overige situaties) Het systeem genereert hiervoor, t.b.v. de vulling van de AORTA-ID header, naast een requestID zelf ook een initialRequestID.
3	Het systeem ontvangt een response.	Verwerking succesvol statuscode 200 OK
		Geen (tijdig) antwoord van secundaire actor statuscode 504 Gateway Timeout
		Het systeem genereert de vereiste response en gaat verder met de exit stap van de main flow.

AOF.UCe.SCR.100.v1 - Screening van response		Uitkomst
Stap	Omschrijving	Uitkomst
i	Het systeem toetst of eventueel aanwezige patiënt BSN's uit het opgeleverde resultaat overeenkomen met het BSN dat is opgenomen in de `patient` claim van het gehanteerde AORTA access_token. Het al dan niet aanwezig zijn van voorloopnullen moet hierbij worden genegeerd.	BSN in resultaat komt niet overeen met access_token statuscode 500 Internal Server Error In deze situatie wordt, voor iedere resource server die een fout produceerde, een OperationOutcome toegevoegd met issue.severity "`warning`", issue.code "`processing`" en issue.diagnostics "`<appID van betreffende resource server>`".
i		Het systeem genereert de vereiste response en gaat verder met de exit stap van de main flow.
ii	Indien de response moet worden geretourneerd aan MedMij, dan verwijderd het systeem alle aanwezige BSN's uit de op te leveren response.
iii	Het systeem voert de filtering uit zoals beschreven in de toelichting "Filtering HTTP-response".

Stap

Omschrijving

Uitkomst

3

<exit>

Het systeem retourneert een response naar de primaire actor.

AOF.UCe.VAL.100.v1 - Toetsing type content		Uitkomst
Stap	Omschrijving	Uitkomst
i	Het systeem ontvangt een verzoek en start de verwerking. Het systeem toetst of het gevraagde type content (Accept header) en het gehanteerde type content (Content-Type header) worden ondersteund. NB. wanneer het verzoek wordt ontvangen van een component van VZVZ, dan hoeft geen toets op type content te worden uitgevoerd.	Gevraagd type content niet ondersteund statuscode 406 Not Acceptable
		Gehanteerd type content niet ondersteund statuscode 415 Unsupported Media Type
		Het systeem genereert de vereiste response en gaat verder met de exit stap van de main flow.

AOF.UCe.VAL.250.v1 - Toetsing van een intern RB-request		Uitkomst
Stap	Omschrijving	Uitkomst
i	Het systeem controleert of alle vereiste tokens zijn toegevoegd aan het request	Ontbrekend token statuscode 401 Unauthorized In deze situatie wordt geen nadere informatie over de opgetreden fout geretourneerd. In deze situatie wordt, conform RFC 6750, ook een WWW-Authenticate HTTP response header met als auth-scheme "Bearer", maar zonder foutcode of nadere informatie omtrent de fout geretourneerd. Indien de `WWW-Authenticate` HTTP response header wordt geproduceerd door de resource broker, dan wordt een `realm` attribuut met waarde "`aorta`" toegevoegd.
i		Het systeem genereert de vereiste response en gaat verder met de exit stap van de main flow.
ii	Het systeem controleert de geldigheid van de meegezonden, van toepassing zijnde, tokens AORTA access_token, zoals omschreven in de sectie "Toetsing AORTA access_token". DigiD Authenticatietoken, zoals omschreven in de sectie “Toetsing DigiD Authenticatietoken”. NB. wanneer het verzoek via een intern netwerk wordt ontvangen, en van een component van VZVZ, dan hoeft deze toets niet te worden uitgevoerd. Welke tokens van toepassing zijn is beschreven in de interface specificaties die horen bij deze use case.	Ongeldig token statuscode 401 Unauthorized In deze situatie wordt, conform RFC 6750, ook een `WWW-Authenticate` HTTP response header met als auth-scheme "`Bearer`" en een `error` attribuut met waarde "`invalid_token`" geretourneerd. Indien de `WWW-Authenticate` HTTP response header wordt geproduceerd door de resource broker, dan wordt een `realm` attribuut met waarde "`aorta`" toegevoegd. In deze situatie mag daarnaast ook een OperationOutcome met issue.code "`security`" worden geretourneerd.
ii		Het systeem genereert de vereiste response en gaat verder met de exit stap van de main flow.
iii	Indien van toepassing: Het systeem controleert de samenhang tussen het AORTA access_token en het DigiD authenticatietoken, zoals omschreven in de de sectie "Toetsing van samenhang tussen tokens". NB. wanneer het verzoek via een intern netwerk wordt ontvangen, en van een component van VZVZ, dan hoeft deze toets niet te worden uitgevoerd. Welke tokens van toepassing zijn is beschreven in de interface specificaties die horen bij deze use case.	Ongeldig token statuscode 401 Unauthorized In deze situatie wordt, conform RFC 6750, ook een `WWW-Authenticate` HTTP response header met als auth-scheme "`Bearer`" en een `error` attribuut met waarde "`invalid_token`" geretourneerd. Indien de `WWW-Authenticate` HTTP response header wordt geproduceerd door de resource broker, dan wordt een `realm` attribuut met waarde "`aorta`" toegevoegd. In deze situatie mag daarnaast ook een OperationOutcome met issue.code "`security`" worden geretourneerd.
iii		Het systeem genereert de vereiste response en gaat verder met de exit stap van de main flow.

Stap	Omschrijving	Uitkomst
1	Indien een get-aorta-data request OF een FHIR-search interactie wordt ontvangen die is gericht aan een zorgaanbieder (URA): Het systeem achterhaald, m.b.v. de AORTA Token Interface (middels een AORTA Token Request), welke interactie(s) moet(en) worden geïnitieerd, en bij welke GBx-applicatie(s).	Interactie(s) en/of GBx-applicaties kunnen niet worden vastgesteld statuscode 500 Internal Server Error
		Het systeem genereert de vereiste response en gaat verder met de exit stap van de main flow.
		Géén GBx-applicatie gevonden Het systeem gaat direct naar stap 5 (samenstellen van response) van de main flow.
2	Voor elke GBx-applicatie, waar één of meerdere interacties moeten worden geïnitieerd, worden voor iedere te initieren interactie de volgende stappen doorlopen: Het systeem stelt, o.b.v. het, door de primaire actor, gevraagde protocol van de response en het al dan niet aanwezig zijn van een transformationId in de _vrb_ter_scope claim van het AORTA access_token, vast of een HL7-v3, of een HL7-FHIR interactie moet worden uitgestuurd, en of een transformatie moet worden uitgevoerd (zie ook de toelichtingen “Opbouwen van queries“ en “Vaststellen van het te hanteren protocol”). Het systeem stelt vast naar welke endpoint de interactie dient te worden doorgestuurd, zoals omschreven in de toelichting "Bepalen van de ontvangende resource servers". Het systeem initieert de vereiste interactie. Indien een transformatie is vereist, en de te initieren interactie is géén v3-query, een FHIR-read of een FHIR-search, dan initieert het systeem hiervoor eerst de use case Transformeer content middels de Transformatie Interface. De base-URL van de Transformatie Server wordt verkregen uit het AORTA Stelseltoken.	Ongeldige adressering Er is bijvoorbeeld een probleem met het FQDN dat is opgenomen in de audience van het AORTA access_token. Het systeem voegt een OperationOutcome toe (issue.severity=”warning”, issue.code "processing") met daarin informatie over de reden. statuscode 500 Internal Server Error
		Het systeem gaat verder met de volgende interactie of GBx-applicatie.
		Transformatie niet geslaagd statuscode 500 Internal Server Error
		Het systeem genereert de vereiste foutresponse en gaat verder met de volgende interactie of GBx-applicatie.
		Interactie kon niet worden geïnitieerd Er is bijvoorbeeld een probleem met de scope van het AORTA access_token, waardoor het systeem een interactie niet kan opbouwen. Het systeem voegt een OperationOutcome toe (issue.severity=”warning”, issue.code "processing") met daarin informatie over de reden. statuscode 500 Internal Server Error
		Het systeem gaat verder met de volgende interactie of GBx-applicatie.
3	Voor elke ontvangen response worden de volgende stappen doorlopen: Het systeem toetst of de response géén attachment met daarin malafide inhoud bevat (zie FHIR security, attachments). Indien een response wordt ontvangen en een transformatie moet worden uitgevoerd, dan initieert het systeem de use case Transformeer content middels de Transformatie Interface. In de toelichting “Transformatie van FHIR results naar v3-responses” is omschreven hoe moet worden omgegaan met ontvangen HTTP statuscodes, headers en OperationOutcomes van een FHIR Resource Server. Indien (eventueel na transformatie) een FHIR searchset Bundle is verkregen dan voegt het systeem er een Provenance resource aan toe, zodat voor iedere opgeleverde resource instance in de Bundle duidelijk is, van welk bronsysteem deze werd verkregen. Indien geen (tijdige) response wordt ontvangen, dan worden bovenstaand stappen niet doorlopen en genereert het systeem zelfstandig de vereiste foutresponse.	Malafide inhoud Het systeem logt de gebeurtenis, negeert de betreffende response en gaat verder met de volgende interactie of GBx-applicatie.
		Geen (tijdig) antwoord van GBx-applicatie statuscode 504 Gateway Timeout
		Transformatie niet geslaagd statuscode 500 Internal Server Error
		Het systeem genereert de vereiste foutresponse en gaat verder met de volgende interactie of GBx-applicatie.
4	Het systeem consolideert alle ontvangen responses, zoals omschreven in de toelichting "Consolideren van de responses naar één FHIR-result" of, wanneer één v3-response moet worden opgeleverd, in AORTA documentatie voor v3-uitwisseling.
5	Bij opleveren van een FHIR-result: het systeem overschrijft eventuele URL's in het opgeleverde resultaat Absolute URL's in Bundle entries (fullUrl's, references en link elementen van het type “self”, “first”, “next”, “previous” en “last”) dienen te worden aangepast conform het volgende formaat: `<base endpointadres Resource Broker XXX-in>/<appID>/<type>/<id>`. DocumentReference.content.attachment.url dient, zowel voor absolute URL’s als voor relatieve URL’s, te worden aangepast conform het volgende formaat: `<base endpointadres Resource Broker XXX-in>/<appID>/<type>/<id>`. URL in Location header dient te worden aangepast conform het volgende formaat: `<base endpointadres Resource Broker XXX-in>/<appID>/<type>/<id>/_history/[vid]` waarbij `<appID>` het applicatie-id (zonder root OID) bevat van het bronsysteem. Het in te vullen `appID` kan worden bepaald door het opgeleverde base endpointadres in de Bundle, te vergelijken met het FQDN van iedere GBZ-applicatie, die eerder in de flow werd betrokken bij de verwerking van het resource request. De juiste Resource Broker XXX-in wordt bepaald o.b.v. de inhoud van de vrb_client_id claim in het AORTA access_token. De base URL die hierbij hoort wordt verkregen uit het AORTA Stelseltoken.
6 <exit>	Het systeem retourneert een response naar de primaire actor.	Zie de toelichting "Consolideren van de responses naar één FHIR-result".
		Verwerking succesvol statuscode 200 OK Wanneer een geldige FHIR zoekparameter wordt ontvangen die niet wordt ondersteund, dan wordt een OperationOutcome met issue.code "`not supported`" opgenomen in het resultaat. Wanneer een ongeldige FHIR zoekparameter wordt ontvangen, dan wordt een OperationOutcome met issue.code "`invalid`" en de van toepassing zijnde issue.details geretourneerd opgenomen in het resultaat. Wanneer een FHIR zoekparameter een geldige waarde bevat die niet wordt ondersteund, dan wordt een OperationOutcome met issue.code "`not supported`" en de van toepassing zijnde issue.details geretourneerd. Wanneer een optionele FHIR zoekparameter een ongeldige waarde heeft, dan wordt een OperationOutcome met issue.code "`value`" en de van toepassing zijnde issue.details geretourneerd. Voor bovenstaande criteria geldt dat ze voor FHIR-interacties die worden vertaald van naar HL7v3: worden getoetst in de resource broker; voor FHIR-interacties die niet worden vertaald: worden getoetst in de resource server. Wanneer een feitelijk, door Resource Server, geretourneerde statuscode moet worden toegevoegd aan een response, dan wordt dit gedaan in een OperationOutcome met: voor statuscode 2xx: issue.severity=information, issue.code=processing. en issue.diagnostics="<appID van resource server>:<statuscode van resource server>", OF anders: issue.severity=warning, issue.code=processing. en issue.diagnostics="<appID van resource server>:<statuscode van resource server>".
		Verwerking succesvol - resource instance gecreëerd statuscode 201 Created