Use Cases Resource Broker v3-in
Overzicht Resource Broker v3-in
Onderstaande figuur toont een overzicht van de interfaces, services en functies van de Resource Broker v3-in component. Resource Broker v3-in is voor HL7-v3 Resource Clients de ingang om interacties te initiëren bij AORTA Resource Servers. 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 RB v3-in component maakt zelf ook gebruik van een aantal interfaces, bijvoorbeeld van de Verzending & Consolidatie Interface.
Verwerken AORTA v3-interactie
Primaire actor | Resource Client (GBx-applicatie) |
|---|---|
Systeem | ZA V3 Processor |
Secundaire actor | Autorisatie Server ZA, Resource Broker VnC |
Code | |
Realiseert Feature |
Pre-condities
De primaire actor is aangesloten op het systeem. |
Het systeem is slechts benaderbaar voor
|
Het systeem ontvangt een v3-request slechts indien het hiervoor vereiste vertrouwensniveau wordt gehanteerd. Dit wordt getoetst in de technische infrastructuur. |
Triggers
De primaire actor stuurt een resource request in
Main flow
Stap | Omschrijving | Uitzondering(en) |
|---|---|---|
1 | Het systeem ontvangt een verzoek en start de verwerking. | |
2 | Het systeem controleert de ingezonden SAML Assertions zoals omschreven in de toelichting "Toetsing tokens bij inkomend v3-request". | Een verplicht token ontbreekt Het systeem genereert de vereiste response conform de reguliere verwerking van berichten in AORTA en de AORTA foutentabel en keert terug naar de exit stap van de main flow. Token kan niet worden gevalideerd of is ongeldig Het systeem genereert de vereiste response conform de reguliere verwerking van berichten in AORTA en de AORTA foutentabel en keert terug naar de exit stap van de main flow. |
3 | Het systeem controleert het ontvangen request, zoals omschreven in de toelichting "Inhoudelijke toetsing v3-request". | Het resource request voldoet niet aan de specificaties Het systeem genereert de vereiste response conform de reguliere verwerking van berichten in AORTA en de AORTA foutentabel en keert terug naar de exit stap van de main flow. |
4 | Indien het ontvangen request op vertrouwensniveau Laag wordt uitgevoerd, dan verkrijgt het systeem een AORTA access_token middels Feature GetTokenRequest. Het verkrijgt daarbij de behorende attributen op de wijze zoals beschreven in de toelichting ”Verkrijgen attributen t.b.v. GetTokenRequest”. | Géén AORTA access_token verkregen Het systeem genereert de vereiste response conform de reguliere verwerking van berichten in AORTA en de AORTA foutentabel en keert terug naar de exit stap van de main flow. Mapping van getTokenResponse/tokenExchangeResponse naar v3 foutcodes:
|
5 | Indien het ontvangen request op vertrouwensniveau Midden wordt uitgevoerd, dan verkrijgt het systeem een AORTA access_token middels Feature AORTA Token Exchange. Eventueel ontvangen zoekparameters in een generieke v3-query worden hierbij doorgegeven, zoals beschreven in de toelichting “Transformatie generieke parameters naar interactie-specifieke parameters“. | |
6 | Afhankelijk van het type uit te voeren interactie, initieert het systeem Feature Eventueel ontvangen zoekparameters in een generieke v3-query worden hierbij doorgegeven, zoals beschreven in de toelichting “Transformatie generieke parameters naar interactie-specifieke parameters“. | |
7 | Het systeem ontvangt een response. | |
8 <exit> | Het systeem retourneert een response naar de primaire actor. |
Post-condities
Het systeem heeft het verzoek op de juiste wijze verwerkt en heeft een daarbij passende response geretourneerd. |
Het systeem heeft het ontvangen request en de geretourneerde response gelogd. |
Het systeem heeft van het ontvangen request, de volgende attributen gelogd:
== Het systeem heeft voor ieder uitgaand request, dat bij het doorlopen van de use case werd verzonden, de volgende attributen gelogd:
|
Het systeem heeft van de geretourneerde response, de volgende attributen gelogd:
== Het systeem heeft voor iedere response, die bij het doorlopen van de use case werd ontvangen, de volgende attributen gelogd:
|
Toelichtingen
Toetsing tokens bij inkomend v3-request
De volgende tokens kunnen worden meegezonden:
AORTA Transactietoken;
AORTA Mandaattoken;
AORTA Inschrijftoken.
Deze tokens dienen te worden getoetst op de wijze, zoals omschreven in de implementatiehandleidingen van de betreffende tokens. Bij deze validatie wordt ook de relatie tussen de tokens en het ontvangen bericht getoetst.
Inhoudelijke toetsing v3-request
Het systeem toetst of de ontvangen SOAP Envelope en de HL7v3-wrappers voldoen aan de van toepassing zijnde standaarden (hiervoor zijn XML-Schema beschikbaar).
Indien een request is gericht aan de Resource Broker zelf (bijvoorbeeld in geval van een generieke query), wordt daarnaast ook de inhoud van het request gevalideerd.
Verkrijgen attributen t.b.v. GetTokenRequest
Het systeem gebruikt ondermeer de volgende attributen:
De URA van de Resource Client wordt verkregen uit het UZI servercertificaat van de TLS Client.
Het appID van de Resource Client wordt verkregen uit het binnenkomende bericht (<interactieID>/sender/device/id).
Het BSN wordt verkregen uit de attentionline van het binnenkomende bericht (<interactieID>/attentionline/value).
Het interactieID wordt verkregen uit het binnenkomende bericht (<interactieID>).
Transformatie generieke parameters naar interactie-specifieke parameters
Eventuele additionele zoekparameters die zijn ontvangen in de generieke v3-query worden als volgt doorgegeven in de scope van het token request en bij de aanroep van de protocol-agnostische get-aorta-data:
Interactie-specifieke v3-parameter | Generieke parameter |
|---|---|
MBHid | therapy-identifier |
Identificatie | instance-identifier |
GebruiksPeriode, VerstrekkingsPeriode, ToedieningsPeriode | effective-time |