Use Cases Abonnementenregister

Resource Client (Abonnerend Systeem)

Abonnementenregister

-

AOF.UC.ABR.100.v5

createSubscription

Het systeem biedt een endpoint voor de registreren abonnement interactie van de Abonnement Interface.

Het systeem is slechts benaderbaar voor

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

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 toetst of het BSN in de patient claim van het AORTA access_token overeenkomt met het BSN in het criterium van het beoogde abonnement.

BSN in criterium komt niet overeen met token

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.

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

2

Het systeem toetst of de registratie van het abonnement is toegestaan:

• een zorgverlener mag slechts een abonnement nemen op de Verwijsindex

• een patient mag zich abonneren op zowel de Toegangslog (LOG) als op de Verwijsindex/Actualiteitsregister (gebeurtenis-type)

• het abonnement mag de maximum toegestane duur niet overschrijden (de maximale toegestane duur is een configureerbare parameter). Indien geen gewenste einddatum wordt meegegeven, dan geldt de maximaal toegestane duur.

• het gebeurtenis-subtype van het abonnement (bijv. de contextcode) moet in overeenstemming zijn met de _vrb_ter_scope claim van het ontvangen AORTA access_token.

• de aanvrager-functie van het abonnement moet, indien aanwezig, overeenkomen met de role claim van het ontvangen AORTA access_token.

Registratie niet toegestaan

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.

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

3

Het systeem toetst het gebeurtenis-subtype

• een abonnement op de Verwijsindex/Actualiteitsregister kan slechts worden genomen voor subtype “contextcode”.

Abonnement niet mogelijk

statuscode 422 Unprocessable Entity

• In deze situatie wordt een OperationOutcome met issue.code “business-rule” geretourneerd, met in de issue.diagnostics meer informatie over aan welke business-rule niet is voldaan.

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

4

Het systeem toetst of er al een abonnement bestaat met dezelfde kenmerken:

• voor abonnementen die zijn genomen door een zorgaanbieder: er bestaat al een abonnement met dezelfde abonnee-organisatie-id, abonnee-applicatie-id, aanvrager-functie, gebeurtenis-type, gebeurtenis-subtype, gebeurtenis-subject.

• voor abonnementen die zijn genomen door een patiënt: er bestaat al een abonnement met dezelfde abonnee-organisatie-id, abonnee-applicatie-id, aanvrager-id, gebeurtenis-type, gebeurtenis-subtype, gebeurtenis-subject.

Vergelijkbaar abonnement bestaat al

statuscode 422 Unprocessable Entity

• In deze situatie wordt een OperationOutcome met issue.code “duplicate” geretourneerd.

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

5

Indien nog geen equivalent abonnement bestaat, zoals aangeduid door het equivalentie criterium (If-None-Exist) in het request, dan registreert het systeem het abonnement.

Zie ook de toelichting “Interne verwerking van abonnementen en signalen”.

Meer dan één equivalent abonnement gevonden

statuscode 412

• In deze situatie wordt een OperationOutcome met issue.code "multiple-matches" en de van toepassing zijnde issue.details geretourneerd.

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

6

<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

Resource Client (Abonnerend Systeem)

Abonnementenregister

-

AOF.UC.ABR.200.v2

searchSubscription

Het systeem biedt een endpoint voor de opvragen abonnementen interactie van de Abonnement Interface.

Het systeem is slechts benaderbaar voor

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

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 voert de zoekopdracht uit:

• voor zorgaanbieder abonnementen worden slechts abonnementen opgeleverd waarvoor

  • het abonnee-applicatie-id van het abonnement overeenkomt met het app-id in de vrb_client_id claim van het AORTA access_token, EN

  • het BSN in het criterium van het abonnement overeenkomt met de patient claim van het AORTA access_token

• voor patiënt abonnementen worden slechts abonnementen opgeleverd waarvoor

  • het aanvrager-id van het abonnement overeenkomt met het sub claim van het AORTA access_token, EN

  • het BSN in het criterium van het abonnement overeenkomt met de patient claim van het AORTA access_token

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

Resource Client (Abonnerend Systeem)

Abonnementenregister

-

AOF.UC.ABR.300.v6

updateSubscription

Het systeem biedt een endpoint voor de wijzigen abonnement interactie van de Abonnement Interface.

Het systeem is slechts benaderbaar voor

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

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 toets of er inderdaad een abonnement bestaat met de identifier, zoals doorgegeven in het request.

Abonnement bestaat niet

statuscode 422 Unprocessable Entity

• In deze situatie wordt een OperationOutcome met issue.code "search-none" en de van toepassing zijnde issue.details geretourneerd.

Het systeem kan niet eenduidig vaststellen welke entry wordt bedoeld

statuscode 412

• In deze situatie wordt een OperationOutcome met issue.code "multiple-matches" en de van toepassing zijnde issue.details geretourneerd.

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

2

Het systeem toetst of het BSN in de patient claim van het AORTA access_token overeenkomt met het BSN in het criterium van het bestaande abonnement.

BSN in criterium komt niet overeen met token

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.

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

3

Het systeem toetst of de wijziging van het abonnement is toegestaan:

• het gebeurtenis-subtype van het abonnement (bijv. de contextcode) moet in overeenstemming zijn met de _vrb_ter_scope claim van het ontvangen AORTA accesstoken.

• de aanvrager-functie van het abonnement moet, indien aanwezig, overeenkomen met de role claim van het ontvangen AORTA access_token.

• een patient mag een abonnement slechts wijzigen wanneer de aanvrager-id van het abonnement overeenkomt met het sub claim van het AORTA access_token.

• het abonnement mag de maximum toegestane duur niet overschrijden (de maximale toegestane duur is een configureerbare parameter). Indien geen gewenste einddatum wordt meegegeven, dan geldt de maximaal toegestane duur. Een abonnement kan dus telkens met een maximaal toegestane duur worden verlengd.

• indien bij een zorgaanbieder abonnement een aanvrager-id van een zorgverlener/medewerker wordt meegegeven, dan mag deze afwijken van een eventueel reeds geregistreerd aanvrager-id (de aanvrager-functie echter mag niet worden gewijzigd)

• andere wijzigingen dan de einddatum, en bij zorgaanbieder abonnementen eventueel de aanvrager-id (zie boven), aan het bestaande abonnement zijn niet toegestaan

Een zorgaanbieder abonnement mag verder slechts worden gewijzigd wanneer de abonnee-applicatie-id van het abonnement overeenkomt met het app-id van de client GBx-applicatie. Dit wordt geborgd door Resource Broker ZA-in via toetsing van de scope van het access_token, die is beperkt tot dit app-id).

Wijziging niet toegestaan

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.

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

4

Het systeem toetst het gebeurtenis-subtype

• een abonnement op de Verwijsindex/Actualiteitsregister kan slechts worden genomen voor subtype “contextcode”.

Abonnement niet mogelijk

statuscode 422 Unprocessable Entity

• In deze situatie wordt een OperationOutcome met issue.code “business-rule” geretourneerd, met in de issue.diagnostics meer informatie over aan welke business-rule niet is voldaan.

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

5

Het systeem verwerkt de wijziging.

Zie ook de toelichting “Interne verwerking van abonnementen en signalen”.

5

<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

Resource Client (Abonnerend Systeem)

Abonnementenregister

-

AOF.UC.ABR.400.v3

deleteSubscription

Het systeem biedt een endpoint voor de beëindigen abonnement interactie van de Abonnement Interface.

Het systeem is slechts benaderbaar voor

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

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 toetst of er inderdaad een abonnement bestaat met de identifier, zoals doorgegeven in het request.

Abonnement bestaat niet

statuscode 200 OK

• In deze situatie wordt een OperationOutcome met issue.severity “warning“, issue.code "not-found" en de van toepassing zijnde issue.details geretourneerd, in dit geval “SEARCH_NONE”.

Het systeem kan niet eenduidig vaststellen welke entry wordt bedoeld

statuscode 412

• In deze situatie wordt een OperationOutcome met issue.code "multiple-matches" en de van toepassing zijnde issue.details geretourneerd.

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

2

Het systeem toetst of de beëindiging van het abonnement is toegestaan:

• het BSN in de patient claim van het AORTA access_token moet overeenkomen met het BSN in het criterium van het abonnement

• een zorgaanbieder abonnement mag slechts worden beëindigd wanneer de abonnee-applicatie-id van het abonnement overeenkomt met het app-id in de vrb_client_id claim van het AORTA access_token.

• een patient mag een abonnement slechts beëindigen wanneer de aanvrager-id van het abonnement overeenkomt met het sub claim van het AORTA access_token.

• het gebeurtenis-subtype van het abonnement (bijv. de contextcode) moet in overeenstemming zijn met de _vrb_ter_scope claim van het ontvangen AORTA accesstoken.

Beëindiging niet toegestaan

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.

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

3

Het systeem beëindigt het abonnement.

4

<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

Gebeurtenisverdeler, Housekeeping

Abonnementenregister (Gebeurtenisafhandelaar)

Resource Broker VnC

AOF.UC.ABR.500.v1

subscriptionNotification

Het systeem biedt een endpoint voor het ontvangen van gebeurtenissen.

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 voert de reguliere stappen uit voor het ontvangen type gebeurtenis.

Zie ook de toelichting “Interne verwerking van abonnementen en signalen”.

3

Het systeem bepaalt m.b.v. de geregistreerde conformances in het APR of een FHIR- of een v3-notificatie moet worden uitgestuurd.

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

De conformances en het FQDN worden verkregen o.b.v. het appID van de abonnee (abonnee-applicatie-id).

4

Het systeem verstuurt de notificatie via het bestaande mechanisme voor guaranteed delivery, op de wijze zoals gespecificeerd in de Abonnement Notificatie Interface.

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.