Skip to main content
Skip table of contents

Use Cases Applicatieregister

Overzicht Applicatieregister

Onderstaande figuur toont een overzicht van de interfaces, services en functies van de Applicatieregister component. Het Applicatieregister bevat en ontsluit gegevens omtrent capabilities (conformances), status en technische adressen van AORTA Resource Clients en Servers.

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

Verwerken TKID-activatie

Primaire actor

Resource Client

Systeem

Applicatie Register

Secundaire actor

-

Code

AOF.UC.APR.100.v1

Realiseert Feature

activateTKID

Pre-condities

Het systeem is slechts benaderbaar voor

  • GBx-applicaties die zijn aangesloten op het AORTA netwerk

Triggers

  • Een GBZ-beheerder wil een TKID(-set) activeren.

Main flow

Stap

Omschrijving

Uitzondering(en)

1

Het systeem ontvangt een verzoek en start de verwerking.

2

Het systeem controleert of het verzoek t.b.v. deze primaire actor mag worden verwerkt, d.w.z. betreft het een update van de eigen TKID-set van de primaire actor, d.w.z. valt de primaire actor onder dezelfde organisatie als het appID dat is opgenomen in de interactie.

Mag niet worden verwerkt

statuscode 403 Forbidden

  • In deze situatie wordt geen nadere informatie over de opgetreden fout geretourneerd.

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

3

Het systeem toetst of het verzoek voldoet aan de interface specificatie.

Ongeldig verzoek

statuscode 400 Bad Request

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

4

Het systeem toetst of de activatie van de ontvangen TKID's voldoet aan de TKID activatieregels, zoals omschreven in de toelichting "TKID activatieregels".

Ongeldig verzoek

statuscode 400 Bad Request

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

5

Het systeem verwerkt het verzoek in het APR, d.w.z. het vervangt een eventueel reeds geregistreerde set van TKID's door de nieuwe set.

6

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

AOF.UC-APR.POS.140.v1

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

AOF.UC-APR.POS.160.v1

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

Het systeem heeft ontvangen request en de geretourneerde response daarnaast ook gelogd op de wijze, zoals beschreven in de Toelichting logging.

TKID activatieregels

Voor de verwerking van activaties zijn een aantal regels van toepassing. De volgende (typen) systeemrollen mogen per Organisatie (URA) maximaal door één GBZ-applicatie worden vervuld:

  1. Systeemrollen van de vorm "<resourcetype> <interactietype> Verwerkend Systeem", waarbij het interactietype gelijk is aan "create";

  2. Systeemrollen die zijn verbonden aan de ontvangst en verwerking van een HL7v3-interactie, waarbij de aard van de interactie equivalent is aan die van een FHIR-create;

  3. De systeemrol "Ontvankelijkheidstatus Opleverend Systeem".

Toetsing van deze regels vereist een aanpassing van het APR en wordt daarom vooralsnog niet gedaan. Volgt in een latere, nader te bepalen, release.

Opleveren gegevens

Primaire actor

Adressering Server

Systeem

Applicatie Register

Secundaire actor

-

Code

AOF.UC.APR.200.v1

Realiseert Feature

getApplication(s)

Pre-condities

Het systeem is slechts benaderbaar voor

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

Triggers

  • De primaire actor heeft APR gegevens nodig.

Main flow

Stap

Omschrijving

Uitzondering(en)

1

Het systeem ontvangt een verzoek en start de verwerking.

2

Het systeem toetst of het verzoek voldoet aan de interface specificatie.

Ongeldig verzoek

statuscode 400 Bad Request

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

3

Het systeem verkrijgt de gevraagde gegevens.

4

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

AOF.UC-APR.POS.140.v1

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

AOF.UC-APR.POS.160.v1

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

Toetsen conformances

Primaire actor

Autorisatie Server ZA

Systeem

Applicatie Register

Secundaire actor

-

Code

AOF.UC.APR.300.v2

Realiseert Feature

hasConformance

Pre-condities

Het systeem is slechts benaderbaar voor

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

Het systeem beschikt over up-to-date gegevens betreffende de ondersteunde interacties en compatible interacties.

Triggers

  • De primaire actor wil toetsen of een GBx-applicatie beschikt over bepaalde conformances.

Main flow

Stap

Omschrijving

Uitzondering(en)

1

Het systeem ontvangt een verzoek en start de verwerking.

2

Het systeem toetst of het verzoek voldoet aan de interface specificatie.

Ongeldig verzoek

statuscode 400 Bad Request

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

3

Het systeem toetst de conformances, en gebruikt hierbij zonodig de informatie uit de AORTA interactietabel (zie ook de Toelichting systeemrollen en conformances).

4

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

AOF.UC-APR.POS.140.v1

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

AOF.UC-APR.POS.160.v1

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

Toetsen Mitz-status

Primaire actor

Autorisatie Server ZA

Systeem

Applicatie Register

Secundaire actor

-

Code

AOF.UC.APR.400.v2

Realiseert Feature

migratedToMitz

Pre-condities

Het systeem is slechts benaderbaar voor

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

Triggers

  • De primaire actor wil weten of voor een GBx-applicatie patiënttoestemmingen worden vastgelegd in Mitz.

Main flow

Stap

Omschrijving

Uitzondering(en)

1

Het systeem ontvangt een verzoek en start de verwerking.

2

Het systeem toetst of het verzoek voldoet aan de interface specificatie.

Ongeldig verzoek

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 de Mitz-status van de GBZ-applicatie(s) van de zorgaanbieder (URA).

4

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

AOF.UC-APR.POS.140.v1

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

AOF.UC-APR.POS.160.v1

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

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.