Use cases Register Sync Broker

Resource Client (GBx-applicatie)

Register Sync Broker

Synchronisatie Afhandelaar

AOF.UC.RSB.100.v1

RequestRegisterSync

Het systeem biedt een endpoint voor de aanvragen register sync operatie van de Register Sync Broker Interface.

Het systeem is slechts benaderbaar voor

• componenten van VZVZ die zijn aangesloten via een intern netwerk of op het AORTA netwerk

De primaire actor heeft het op te halen RegisterSync inputbestand beschikbaar gesteld, en houdt deze beschikbaar gedurende de datum/tijd aangegeven in het verzoek.

De secundaire actor is aangesloten op het systeem.

Stap

Omschrijving

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.

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 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.

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.

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

1

Het systeem initieert de register synchronisatie bij de secundaire actor.

2

<exit>

Het systeem retourneert een response naar de primaire actor.

Verwerking succesvol

statuscode 200 OK

Het systeem heeft het verzoek op de juiste wijze verwerkt en heeft een daarbij passende response geretourneerd.

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

• datum en tijd van ontvangst

• request-id

• initial-request-id

• sender-id

  • role-id wanneer de sender van het request een VZVZ component is, en de aanroep niet via TLS geschiedt

  • common name wanneer de aanroep via TLS geschiedt

==

Het systeem heeft voor ieder uitgaand request, dat bij het doorlopen van de use case werd verzonden, de volgende attributen gelogd:

• datum en tijd van verzending

• request-id

• initial-request-id

• receiver-id

  • role-id wanneer de receiver van het request een VZVZ component is, en de aanroep niet via HTTP geschiedt

  • FQDN wanneer de aanroep via HTTP geschiedt

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

• receiver-id

  • role-id wanneer de receiver van de response een VZVZ component is, en de aanroep niet via TLS geschiedt

  • common name wanneer de aanroep via TLS geschiedt

• HTTP statuscode en eventueel geretourneerde foutinformatie

==

Het systeem heeft voor iedere response, die bij het doorlopen van de use case werd ontvangen, 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 wanneer de sender van de response een VZVZ component is, en de aanroep niet via TLS geschiedt

  • common name wanneer de aanroep via TLS geschiedt

• HTTP statuscode en eventueel geretourneerde foutinformatie

Synchronisatie Afhandelaar

Register Sync Broker

Resource Client (GBx-applicatie)

AOF.UC.RSB.200.v1

De primaire actor is aangesloten op het systeem.

Het systeem is slechts benaderbaar voor

• componenten van VZVZ die zijn aangesloten via een intern netwerk of op het AORTA netwerk

1

Het systeem ontvangt een verzoek en start de verwerking.

2

Het systeem verkrijgt, m.b.v. Feature getApplication(s), informatie over GBx-applicatie die moet worden genotificeerd.

Ontvanger onbekend

statuscode 400 Bad Request

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

3

Het systeem bepaalt m.b.v. de geregistreerde conformances in het APR (verkregen in een vorige stap) of een FHIR- of een v3 Register Sync Notificatie moet worden uitgestuurd.

De FQDN waarop de notificatie moet worden afgeleverd wordt eveneens verkregen uit het APR.

4

Het systeem verstuurt de Register Sync Notificatie via het bestaande mechanisme voor guaranteed delivery, op de wijze zoals gespecificeerd in:

• HL7-FHIR: RegisterSyncNotification;

• HL7v3: Decor - Notificeren van beschikbaar bestand

5 <exit>

Het systeem retourneert een response naar de primaire actor.

Het systeem heeft het verzoek op de juiste wijze verwerkt en heeft een daarbij passende response geretourneerd.

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

• datum en tijd van ontvangst

• request-id

• initial-request-id

• sender-id

  • role-id wanneer de sender van het request een VZVZ component is, en de aanroep niet via TLS geschiedt

  • common name wanneer de aanroep via TLS geschiedt

==

Het systeem heeft voor ieder uitgaand request, dat bij het doorlopen van de use case werd verzonden, de volgende attributen gelogd:

• datum en tijd van verzending

• request-id

• initial-request-id

• receiver-id

  • role-id wanneer de receiver van het request een VZVZ component is, en de aanroep niet via HTTP geschiedt

  • FQDN wanneer de aanroep via HTTP geschiedt

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

• receiver-id

  • role-id wanneer de receiver van de response een VZVZ component is, en de aanroep niet via TLS geschiedt

  • common name wanneer de aanroep via TLS geschiedt

• HTTP statuscode en eventueel geretourneerde foutinformatie

==

Het systeem heeft voor iedere response, die bij het doorlopen van de use case werd ontvangen, 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 wanneer de sender van de response een VZVZ component is, en de aanroep niet via TLS geschiedt

  • common name wanneer de aanroep via TLS geschiedt

• HTTP statuscode en eventueel geretourneerde foutinformatie

Synchronisatie Afhandelaar

Register Sync Broker

Resource Client (GBx-applicatie)

AOF.UC.RSB.300.v1

De primaire actor is aangesloten op het systeem.

Het systeem is slechts benaderbaar voor

• componenten van VZVZ die zijn aangesloten via een intern netwerk of op het AORTA netwerk

1

Het systeem ontvangt een verzoek en start de verwerking.

2

Het systeem verkrijgt, m.b.v. Feature getApplication(s), informatie over GBx-applicatie die moet worden genotificeerd.

Ontvanger onbekend

statuscode 400 Bad Request

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

3

Het systeem bepaalt m.b.v. de geregistreerde conformances in het APR (verkregen in een vorige stap) of een FHIR- of een v3 Process Register Sync Report notificatie moet worden uitgestuurd.

De FQDN waarop de notificatie moet worden afgeleverd wordt eveneens verkregen uit het APR.

4

Het systeem verstuurt de notificatie via het bestaande mechanisme voor guaranteed delivery, op de wijze zoals gespecificeerd in:

• HL7-FHIR: ProcessRegisterSyncReport;

• HL7v3: Decor - Download en validatie antwoord

5 <exit>

Het systeem retourneert een response naar de primaire actor.

Het systeem heeft het verzoek op de juiste wijze verwerkt en heeft een daarbij passende response geretourneerd.

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

• datum en tijd van ontvangst

• request-id

• initial-request-id

• sender-id

  • role-id wanneer de sender van het request een VZVZ component is, en de aanroep niet via TLS geschiedt

  • common name wanneer de aanroep via TLS geschiedt

==

Het systeem heeft voor ieder uitgaand request, dat bij het doorlopen van de use case werd verzonden, de volgende attributen gelogd:

• datum en tijd van verzending

• request-id

• initial-request-id

• receiver-id

  • role-id wanneer de receiver van het request een VZVZ component is, en de aanroep niet via HTTP geschiedt

  • FQDN wanneer de aanroep via HTTP geschiedt

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

• receiver-id

  • role-id wanneer de receiver van de response een VZVZ component is, en de aanroep niet via TLS geschiedt

  • common name wanneer de aanroep via TLS geschiedt

• HTTP statuscode en eventueel geretourneerde foutinformatie

==

Het systeem heeft voor iedere response, die bij het doorlopen van de use case werd ontvangen, 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 wanneer de sender van de response een VZVZ component is, en de aanroep niet via TLS geschiedt

  • common name wanneer de aanroep via TLS geschiedt

• HTTP statuscode en eventueel geretourneerde foutinformatie

Resource Client (GBx-applicatie)

Register Sync Broker

Synchronisatie Afhandelaar

AOF.UC.RBS.400

CompleteRegisterSync

Het systeem biedt een endpoint voor de Complete Register Sync operatie van de Register Sync Broker Interface.

Het systeem is slechts benaderbaar voor

• componenten van VZVZ die zijn aangesloten via een intern netwerk of op het AORTA netwerk

De secundaire actor is aangesloten op het systeem.

Stap

Omschrijving

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.

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 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.

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.

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

1

Het systeem stuurt de notificatie door naar de secundaire actor.

2

<exit>

Het systeem retourneert een response naar de primaire actor.

Verwerking succesvol

statuscode 200 OK

Het systeem heeft het verzoek op de juiste wijze verwerkt en heeft een daarbij passende response geretourneerd.

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

• datum en tijd van ontvangst

• request-id

• initial-request-id

• sender-id (role-id van de VZVZ component die het request verzendt)

• 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)

• receiver-id (role-id van de VZVZ component die de response ontvangt)

• HTTP statuscode en eventueel geretourneerde foutinformatie