Onderstaande figuur toont een overzicht van de interfaces, services en functies van de Resource Broker ZA-in component. Resource Broker ZA-in is voor AORTA Resource Clients de ingang om interacties te initiëren bij AORTA Resource Servers of bij Resource Broker componenten (bijv. ACT/VWI Server). Wanneer een interactie moet worden geïnitieerd bij een AORTA Resource Server, dan verloopt dit altijd via Resource Broker VnC.
De services zijn toegankelijk via een geboden interface en worden beschreven in de vorm van use cases. Een service wordt altijd vervult middels één of meerdere applicatiefuncties, bijvoorbeeld Screening. De Resource Broker ZA-in component maakt zelf ook gebruik van een aantal interfaces, bijvoorbeeld van de Verzending & Consolidatie Interface.
GBx-applicaties die zijn aangesloten op het AORTA netwerk
Triggers
De primaire actor stuurt een resource request in
Main flow
AOF.UCe.VAL.100.v1 - Toetsing type content
Uitkomst
Stap
Omschrijving
i
Het systeem ontvangt een verzoek en start de verwerking.
Gevraagd type content niet ondersteund
statuscode 406 Not Acceptable
Gehanteerd type content niet ondersteund
statuscode 415 Unsupported Media Type
Het systeem genereert de vereiste foutresponse en gaat verder met de exit stap van de main flow.
AOF.UCe.VAL.200.v1 - Toetsing tokens bij inkomend request
Uitkomst
Stap
Omschrijving
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.
Het systeem genereert de vereiste foutresponse en gaat verder met de exit stap van de main flow.
ii
Het systeem controleert de geldigheid van de meegezonden, van toepassing zijnde, tokens
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.
Het systeem genereert de vereiste foutresponse en gaat verder met de exit stap van de main flow.
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.
Het systeem genereert de vereiste foutresponse 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.
Het systeem genereert de vereiste foutresponse en gaat verder met de exit stap van de main flow.
iii
Het systeem toetst of het verzoek voldoet aan de interface specificatie.
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.
Het systeem genereert de vereiste foutresponse en gaat verder met de exit stap van de main flow.
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 foutresponse en gaat verder met de exit stap van de main flow.
Stap
Omschrijving
Uitkomst
1
Het systeem
interactie gericht aan GBZ: initieert de use case Verzenden & Consolideren benodigde interacties middels de Verzending & Consolidatie Interface. Het kan hierbij gaan om
een get-aorta-data operatie (het ontvangen resource request is een $get-aorta-data FHIR operation)
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)
interactie gericht aan een VZVZ component anders dan Resource Broker VnC: stuurt de ontvangen interactie door aan de geadresseerde component, e.e.a. inclusief de vereiste HTTP headers
Subscription, bestemd voor het Abonnementenregister: conform de Abonnement Interface.
3
FHIR-result ontvangen van een VZVZ-component anders dan Resource Broker VnC: 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>/role/<roleID>/<type>/<id>.
URL in Location header dient te worden aangepast conform het volgende formaat: <base endpointadres Resource Broker XXX-in>//role/<roleID>/<type>/<id>/_history/[vid]
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.
3
Het systeem ontvangt een response.
AOF.UCe.SCR.100.v1 - Screening van response
Uitkomst
Stap
Omschrijving
i
Het systeem toetst of eventueel aanwezige BSN's uit het opgeleverde resultaat overeenkomen met het BSN dat is opgenomen in de patient claim van het gehanteerde AORTA access_token
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>".
Het systeem genereert de vereiste foutresponse 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.
Verwerking succesvol
statuscode 200 OK
Post-condities
Het systeem heeft het verzoek op de juiste wijze verwerkt en heeft een daarbij passende response geretourneerd.
Het systeem heeft ontvangen request en de geretourneerde response gelogd, zoals beschreven in de Toelichting logging.
JavaScript errors detected
Please note, these errors can depend on your browser setup.
If this problem persists, please contact our support.
