Use Cases Resource Client

Overzicht Resource Client

Een Resource Client is een GBx-applicatie. Een GBZ-applicatie kan zowel fungeren in de rol van Resource Server als in de rol van Resource Client. Een GBP-applicatie en een GBK-applicatie fungeren slechts in de rol van Resource Client.

Een Resource Client initieert interacties. Een Resource Server reageert op interacties die worden geïnitieerd middels een interface. Een Resource Client biedt zelf geen in principe geen interfaces. Uitzondering hierop zijn callback interfaces, bijvoorbeeld t.b.v. notificaties.

Onderstaande figuur toont een overzicht van de interfaces en services van de Resource Client.

Services zijn toegankelijk via interfaces en worden beschreven in de vorm van use cases. De Resource Client maakt gebruik van een aantal interfaces, in het bijzonder van de AORTA FHIR RB Interface.

Een aantal services maken gebruik van onderliggende services. Een dergelijk onderliggende service wordt dan beschreven in de vorm van een use case inclusion of als een use case extension.

Services behoren tot een bepaalde functie. Onderstaande figuur toont een overzicht van de services en functies van de Resource Client.

Generieke use cases

Activeren TKID

Primaire actor	GBx-beheerder
Systeem	<GBx-systeemrol>
Secundaire actor	Resource Broker APR
Code	AOF.UC.RC.100.v1

Pre-condities

Het systeem is aangesloten op de secundaire actor(en).

De kwalificaties van de Resource Client/Server zijn reeds geaccepteerd door VZVZ en zijn ook geregistreerd in de secundaire actor.

De primaire actor beschikt over de juiste TKID's (ID's die zijn uitgereikt n.a.v. acceptatie van succesvol doorlopen kwalificaties) van alle te activeren AORTA systeemrollen.

Het systeem beschikt over een voldoende actueel AORTA Stelseltoken die het via de AORTA Stelsel Metadata Interface heeft verkregen.

Triggers

De primaire actor wil één of meerdere TKID's activeren.

Main flow

Stap

Omschrijving

Uitkomst

1

De primaire actor kiest de optie om één of meerdere TKID's te activeren voor een bepaalde resource server.

2

Het systeem activeert één of meerdere TKID’s middels de Applicatie Register Interface.

3

<exit>

Het systeem ontvangt en verwerkt een response.

Post-condities

Postconditie bij succes:

De verzonden TKID's zijn verwerkt door de secundaire actor, waardoor de Resource Client/Server nu is gekoppeld aan de bijbehorende AORTA systeemrollen. Hiermee zijn tevens eventueel eerder doorlopen TKID activaties ongedaan gemaakt.

Post-conditie bij falen:

De bestaande koppelingen tussen AORTA systeemrollen met de Resource Client/Server is ongewijzigd gebleven.

Het systeem heeft van het verzonden request, de volgende attributen gelogd:

datum en tijd van ontvangst
request-id
initial-request-id
sender-id (app-id van de GBx-applicatie die het request verzendt)
receiver-id (role-id van de VZVZ component die het request ontvangt)

Het systeem heeft van de ontvangen response, de volgende attributen gelogd:

datum en tijd van response
request-id van het bijbehorende request
initial-request-id van het bijbehorende request
sender-id (role-id van de VZVZ component die de response heeft verzonden)
receiver-id (app-id van de GBx-applicatie die de response ontvangt)
HTTP statuscode en eventueel geretourneerde foutinformatie

Initieren AORTA FHIR-interactie

Primaire actor	Gebruiker of Time
Systeem	<GBx-systeemrol>
Secundaire actor	Resource Broker ZA-in, Autorisatie Server ZA, Adressering Server
Code	AOF.UC.RC.200.v1

Pre-condities

Het systeem is aangesloten op de secundaire actor(en).

Het systeem beschikt over een voldoende actueel AORTA Stelseltoken die het via de AORTA Stelsel Metadata Interface heeft verkregen.

Triggers

De primaire actor wil gegevens opvragen of versturen.

Main flow

Stap	Omschrijving	Uitkomst
1	Optioneel: het systeem vraagt routeringsinformatie op middels de Routing Info Interface.
2	Het systeem verkrijgt autorisatie middels de AORTA Token Exchange Interface.
3	Het systeem initieert een FHIR-interactie middels de AORTA FHIR Resource Broker Interface. Bij instance level interacties, bijv. een FHIR-read, dient het systeem het appID van de Resource Server (GBZ-applicatie of Resource Broker GTK) toe te voegen aan de URL. Het juiste appID kan zijn verkregen in stap 1 van de use case, maar kan ook zijn opgenomen in een query_string binnen een Notified-Pull Task.
4 <exit>	Het systeem ontvangt en verwerkt een response.

Bij het opvragen van gegevens zijn ook de generieke, d.w.z. niet HL7v3-specifieke, eisen van toepassing die gelden voor een Patiëntgegevens raadplegend systeem, zoals gespecificeerd in het PvE Infrastructurele Systeemrollen.

Bij het versturen van gegevens zijn ook de generieke, d.w.z. niet HL7v3-specifieke, eisen van toepassing die gelden voor een Gegevens versturend systeem, zoals gespecificeerd in het PvE Infrastructurele Systeemrollen.

Post-condities

De response is correct verwerkt in het systeem.

Het systeem heeft van het verzonden request, de volgende attributen gelogd:

datum en tijd van ontvangst
request-id
initial-request-id
sender-id (app-id van de GBx-applicatie die het request verzendt)
receiver-id (role-id van de VZVZ component die het request ontvangt)

Het systeem heeft van de ontvangen response, de volgende attributen gelogd:

datum en tijd van response
request-id van het bijbehorende request
initial-request-id van het bijbehorende request
sender-id (role-id van de VZVZ component die de response heeft verzonden)
receiver-id (app-id van de GBx-applicatie die de response ontvangt)
HTTP statuscode en eventueel geretourneerde foutinformatie

Initiëren notified-pull

Primaire actor	Gebruiker of Time
Systeem	<GBx-systeemrol>
Secundaire actor	Adressering Server
Code	AOF.UC.RC.300.v1

Pre-condities

Het systeem is aangesloten op de secundaire actor(en).

Het systeem beschikt over een voldoende actueel AORTA Stelseltoken die het via de AORTA Stelsel Metadata Interface heeft verkregen.

Triggers

De primaire actor wil een notified-pull initieren.

Main flow

Stap

Omschrijving

Uitkomst

1

Optioneel: het systeem vraagt routeringsinformatie op middels de Routing Info Interface.

2

Het systeem genereert een AORTA consent_token.

3

<exit>

Het systeem creëert, t.b.v. de uitvoering van een notified-pull, een AORTA Task, middels de use case Initieren AORTA-FHIR-interactie.

Post-condities

De response is correct verwerkt in het systeem.

Het systeem heeft van het verzonden request, de volgende attributen gelogd:

datum en tijd van ontvangst
request-id
initial-request-id
sender-id (app-id van de GBx-applicatie die het request verzendt)
receiver-id (role-id van de VZVZ component die het request ontvangt)

Het systeem heeft van de ontvangen response, de volgende attributen gelogd:

datum en tijd van response
request-id van het bijbehorende request
initial-request-id van het bijbehorende request
sender-id (role-id van de VZVZ component die de response heeft verzonden)
receiver-id (app-id van de GBx-applicatie die de response ontvangt)
HTTP statuscode en eventueel geretourneerde foutinformatie

ACT/VWI use cases

Aanleveren mutaties ACT/VWI

Primaire actor	Gebruiker of Time
Systeem	<GBx-systeemrol>
Secundaire actor	Resource Broker ZA-in
Code	AOF.UC.RC.400.v1

Pre-condities

Het systeem is aangesloten op de secundaire actor(en).

Het systeem beschikt over de juiste kwalificaties om deze use case te mogen uitvoeren.

Het systeem beschikt over een voldoende actueel AORTA Stelseltoken die het via de AORTA Stelsel Metadata Interface heeft verkregen.

Triggers

De primaire actor wil het actualiteitsregister of de verwijsindex bijwerken.

Main flow

Stap	Omschrijving	Uitkomst
1	De primaire actor kiest de optie om haar ACT/VWI registratie bij te werken.
2	Het systeem verkrijgt autorisatie middels de AORTA Token Exchange Interface. Deze interactie mag worden uitgevoerd op vertrouwensniveau “Laag” (of hoger). Zie ook de “toelichting vertrouwensniveaus”. De contextcode die moet worden meegegeven in de scope van het token exchange request is altijd “VWIMGT”, ongeacht welke gegevens worden aangemeld of afgemeld.
3	Het systeem maakt, wijzigt of verwijdert, via de AORTA FHIR Resource Broker Interface, één of meerdere ACT/VWI entries, inhoudelijk op de wijze zoals beschreven in de Actualiteitsregister Interface.
4 <exit>	Het systeem ontvangt en verwerkt een response.

Post-condities

De response is correct verwerkt in het systeem.

Het systeem heeft van het verzonden request, de volgende attributen gelogd:

datum en tijd van ontvangst
request-id
initial-request-id
sender-id (app-id van de GBx-applicatie die het request verzendt)
receiver-id (role-id van de VZVZ component die het request ontvangt)

Het systeem heeft van de ontvangen response, de volgende attributen gelogd:

datum en tijd van response
request-id van het bijbehorende request
initial-request-id van het bijbehorende request
sender-id (role-id van de VZVZ component die de response heeft verzonden)
receiver-id (app-id van de GBx-applicatie die de response ontvangt)
HTTP statuscode en eventueel geretourneerde foutinformatie

Opvragen ACT/VWI

Primaire actor	Gebruiker of Time
Systeem	<GBx-systeemrol>
Secundaire actor	Resource Broker ZA-in
Code	AOF.UC.RC.500.v1

Pre-condities

Het systeem is aangesloten op de secundaire actor(en).

Het systeem beschikt over de juiste kwalificaties om deze use case te mogen uitvoeren.

Het systeem beschikt over een voldoende actueel AORTA Stelseltoken die het via de AORTA Stelsel Metadata Interface heeft verkregen.

Triggers

De primaire actor wil het actualiteitsregister of de verwijsindex raadplegen.

Main flow

Stap	Omschrijving	Uitkomst
1	De primaire actor kiest de optie om te zoeken in haar ACT/VWI registratie.
2	Het systeem verkrijgt autorisatie middels de AORTA Token Exchange Interface. Deze interactie mag worden uitgevoerd op vertrouwensniveau “Midden” (of hoger). Zie ook de “toelichting vertrouwensniveaus”. De contextcode die moet worden meegegeven in de scope van het token exchange request is, voor patiënten die opvragen via het GBP, gelijk aan “PATVWI”.
3	Het systeem vraagt, via de AORTA FHIR Resource Broker Interface, ACT/VWI entries op, inhoudelijk op de wijze zoals beschreven in de Actualiteitsregister Interface.
4 <exit>	Het systeem ontvangt en verwerkt een response.

Post-condities

De response is correct verwerkt in het systeem.

Het systeem heeft van het verzonden request, de volgende attributen gelogd:

datum en tijd van ontvangst
request-id
initial-request-id
sender-id (app-id van de GBx-applicatie die het request verzendt)
receiver-id (role-id van de VZVZ component die het request ontvangt)

Het systeem heeft van de ontvangen response, de volgende attributen gelogd:

datum en tijd van response
request-id van het bijbehorende request
initial-request-id van het bijbehorende request
sender-id (role-id van de VZVZ component die de response heeft verzonden)
receiver-id (app-id van de GBx-applicatie die de response ontvangt)
HTTP statuscode en eventueel geretourneerde foutinformatie

Abonneren use cases

Initieren Abonnement Interactie

Primaire actor	Gebruiker
Systeem	<GBx-systeemrol>
Secundaire actor	Zie use case extensions
Code	AOF.UC.RC.600.v1

Pre-condities

Het systeem is aangesloten op de secundaire actor(en).

Het systeem beschikt over de juiste kwalificaties om deze use case te mogen uitvoeren.

Het systeem beschikt over een voldoende actueel AORTA Stelseltoken die het via de AORTA Stelsel Metadata Interface heeft verkregen.

Triggers

De primaire actor wil een interactie initieren m.b.t. het Abonnement Register.

Main flow

Stap

Omschrijving

Uitkomst

1

Het systeem

neem een Abonnement, OF
verlengt een Abonnement , OF
beëindigt een Abonnement, OF
zoekt naar bestaande Abonnementen

dit verloopt middels de use case Initieren AORTA-FHIR-interactie, en inhoudelijk op de wijze zoals beschreven in de Abonnement Interface.

Deze interactie mag worden uitgevoerd op vertrouwensniveau “Midden” (of hoger). Zie ook de “toelichting vertrouwensniveaus”.

De contextcode die moet worden meegegeven in de scope van het token exchange request is voor

het zoeken naar abonnementen gelijk aan “OPVABR”;
de andere interacties gelijk aan de contextcode die wordt gehanteerd in het betreffende abonnement zelf.

Post-condities

De response is correct verwerkt in het systeem.

Het systeem heeft van het verzonden request, de volgende attributen gelogd:

datum en tijd van ontvangst
request-id
initial-request-id
sender-id (app-id van de GBx-applicatie die het request verzendt)
receiver-id (role-id van de VZVZ component die het request ontvangt)

Het systeem heeft van de ontvangen response, de volgende attributen gelogd:

datum en tijd van response
request-id van het bijbehorende request
initial-request-id van het bijbehorende request
sender-id (role-id van de VZVZ component die de response heeft verzonden)
receiver-id (app-id van de GBx-applicatie die de response ontvangt)
HTTP statuscode en eventueel geretourneerde foutinformatie

Verwerken Abonnement Notificatie

Primaire actor	ABR Server
Systeem	<GBx-systeemrol>
Code	AOF.UC.RC.700.v1

Pre-condities

Het systeem is aangesloten op de secundaire actor(en).

Het systeem beschikt over de juiste kwalificaties om deze use case te mogen uitvoeren.

Main flow

Stap

Omschrijving

Uitkomst

1

Het systeem ontvangt een notificatie

2

Het systeem verwerkt de notificatie.

Ongeldig verzoek

statuscode 400 Bad Request

3

<exit>

Het systeem retourneert een response naar de primaire actor.

Verwerking succesvol

statuscode 200 OK

Post-condities

Het systeem heeft van het ontvangen request, de volgende attributen gelogd:

datum en tijd van ontvangst
request-id
initial-request-id
receiver-id (app-id van de GBx-applicatie die het request ontvangt)

Het systeem heeft van de geretourneerde response, de volgende attributen gelogd:

datum en tijd van response
request-id van het bijbehorende request
initial-request-id van het bijbehorende request
sender-id (app-id van de GBx-applicatie die de response verzendt)
HTTP statuscode en eventueel geretourneerde foutinformatie

Register synchronisatie use cases

Om een register synchronisatie uit te voeren heeft de GBx-beheerder een verschillenrapportage nodig.

Verkrijgen Verschillenrapportage

Primaire actor	GBx-beheerder
Systeem	<GBx-systeemrol>
Secundaire actor	Resource Broker ZA-in, Synchronisatie Afhandelaar
Code	AOF.UC.RC.900.v1

Pre-condities

Het systeem is aangesloten op de secundaire actor(en).

Het systeem beschikt over de juiste kwalificaties om deze use case te mogen uitvoeren.

Het systeem beschikt over een voldoende actueel AORTA Stelseltoken die het via de AORTA Stelsel Metadata Interface heeft verkregen.

Triggers

De primaire actor wil een register synchronisatie uitvoeren.

Main flow

Stap	Omschrijving	Uitkomst
1	De primaire actor kiest ervoor om een register synchronisatie aan te vragen.
2	Het systeem heeft het op te halen register synchronisatie Inputbestand gereed via de Feature GetInputDocument, en houdt deze beschikbaar gedurende de datum/tijd aangegeven in het verzoek. Het register synchronisatie inputbestand voldoet aan de AORTA_VWI_IH_Verwijsindex_HL7 specificaties.	Inputbestand gereed om op te halen
2	Het systeem verkrijgt autorisatie middels de AORTA Token Exchange Interface. Deze interactie mag worden uitgevoerd op vertrouwensniveau “Laag” (of hoger). Zie ook de “toelichting vertrouwensniveaus”. De contextcode die moet worden meegegeven in de scope van het token exchange request is altijd “REGSYNC”.
3	Het systeem verzendt via de AORTA FHIR Resource Broker Interface, een aanvraag voor een register synchronisatie, inhoudelijk op de wijze zoals beschreven in de Feature RequestDocumentPickup (Proxy). Het type register welke dient te worden gesynchroniseerd (bijv. VWI, ACT of ABR) wordt in het RequestDocumentPickup aangegeven.	Het systeem voldoet aan de post-condities mbt logging voor dit verzonden request.
4	Het systeem ontvangt en verwerkt een response. Indien een foutmelding wordt ontvangen beëindigd het systeem de flow. Mogelijke foutmeldingen: DocumentId url is al gebruikt Onjuiste bestandtype Ongeldige URL	Het systeem voldoet aan de post-condities mbt logging voor dit ontvangen respons.
5	Het systeem wacht op het asynchrone ophalen van het Inputdocument volgens de Feature GetInputDocument.	Het systeem voldoet aan de post-condities mbt logging voor dit ontvangen verzoek.
6	Het systeem wacht op een notificatie volgens de Feature DocumentPickupNotification over de status van het opgehaalde inputdocument.	Het systeem voldoet aan de post-condities mbt logging voor dit verzonden respons. Indien een hieronder genoemnde foutmelding wordt ontvangen beëindigd het systeem de flow. Mogelijke foutmeldingen: Het opgeleverde bestand bevat geen URA of applicatie id. URL onbereikbaar (HTTP 401) Document niet gevonden (HTTP 404) URA onjuist Download niet gelukt Applicatie id valt niet onder de UYRA Onjuiste syntax van het bestand
7	Het systeem toetst of het verzoek voldoet aan de interface specificatie. Het systeen toetst of de referentie naar het gerelateerde RequestDocumentPickup bekend is.	Verwerking succesvol statuscode 200 OK
7		Ongeldig verzoek statuscode 400 Bad Request
8	Het systeem retourneert een response naar de primaire actor.	Bij een foutmelding beëindigd het systeem de flow.
9	Het systeem wacht op een notificatie volgens de Feature RequestDocumentPickup, welke aangeeft dat de verschillenrapportage gereed is om op te halen.	Het systeem voldoet aan de post-condities mbt logging voor dit ontvangen respons.
11	Het systeem toetst of het verzoek voldoet aan de interface specificatie. Het systeem toetst: Document url is al gebruikt Onjuiste bestandtype Ongeldige URL Of de bijhorende RequestDocumentPickup (van stap 3) bekend is Indien een foutmelding wordt ontvangen beëindigd het systeem de flow.	Het systeem voldoet aan de post-condities mbt logging voor dit ontvangen respons.
		Indien alle controles succesvol worden uitgevoerd dan wordt de volgende response gestuurd in stap 12. Verwerking succesvol statuscode 200 OK ,
		Indien een controle faalt wordt de volgende response gestuurd in stap 12. Ongeldig verzoek statuscode 400 Bad Request
12	Het systeem retourneert een response naar de primaire actor.	Bij een foutmelding beëindigd het systeem de flow.
13	Het systeem haalt het verschillenrapportage op, m.b.v. Feature GetVerschillenrapportage. Het verschllenrapportage voldoet aan de AORTA VWI Synchronisatie Best Practices. Het systeem toetst: Het opgeleverde bestand bevat geen URA of applicatie id. URL onbereikbaar (HTTP 401) Document niet gevonden (HTTP 404) URA onjuist Download niet gelukt Applicatie id valt niet onder de URA Onjuiste syntax van het bestand	Het systeem voldoet aan de post-condities mbt logging voor dit verzonden request.
14	Het systeem verkrijgt autorisatie middels de AORTA Token Exchange Interface. Deze interactie mag worden uitgevoerd op vertrouwensniveau “Laag” (of hoger). Zie ook de “toelichting vertrouwensniveaus”. De contextcode die moet worden meegegeven in de scope van het token exchange request is altijd “REGSYNC”.
15	Het systeem verzendt via de AORTA FHIR Resource Broker Interface, een bevestiging dat de verschillenrapportage is opgehaald, inhoudelijk op de wijze zoals beschreven in DocumentPickupNotification.	Het systeem voldoet aan de post-condities mbt logging voor dit verzonden request.
16	Het systeem ontvangt en verwerkt een response.

Post-condities

Deze gelden voor stap 1.4, 2.6 , 3.7 …

GroupIdentifier loggen voor relevante stappen.

Naast de standaard logging …

De response is correct verwerkt in het systeem.

Het systeem heeft van het verzonden request, de volgende attributen gelogd:

datum en tijd van ontvangst
request-id
initial-request-id
sender-id (app-id van de GBx-applicatie die het request verzendt)
receiver-id (role-id van de VZVZ component die het request ontvangt)

Het systeem heeft van de ontvangen response, de volgende attributen gelogd:

datum en tijd van response
request-id van het bijbehorende request
initial-request-id van het bijbehorende request
sender-id (role-id van de VZVZ component die de response heeft verzonden)
receiver-id (app-id van de GBx-applicatie die de response ontvangt)
HTTP statuscode en eventueel geretourneerde foutinformatie

Mitz use cases

Verwerken Toestemming Notificatie

Primaire actor	Notificatie Broker
Systeem	<GBx-systeemrol>
Code	AOF.UC.RC.800.v1

Pre-condities

Het systeem is aangesloten op de secundaire actor(en).

Het systeem beschikt over de juiste kwalificaties om deze use case te mogen uitvoeren.

Main flow

Stap

Omschrijving

Uitkomst

1

Het systeem ontvangt een notificatie

2

<exit>

Het systeem retourneert een response naar de primaire actor.

Verwerking succesvol

statuscode 200 OK

Post-condities

Het systeem heeft van het ontvangen request, de volgende attributen gelogd:

datum en tijd van ontvangst
request-id
initial-request-id
receiver-id (app-id van de GBx-applicatie die het request ontvangt)

Het systeem heeft van de geretourneerde response, de volgende attributen gelogd:

datum en tijd van response
request-id van het bijbehorende request
initial-request-id van het bijbehorende request
sender-id (app-id van de GBx-applicatie die de response verzendt)
HTTP statuscode en eventueel geretourneerde foutinformatie