Implementatie handleiding ketenlogging en monitoring AS v2.2.X

Productie endpoint voor de logging service

https://api.medmij.nl/eagleeye/v1/logs

Swagger definitie voor de productie endpoint

https://api.medmij.nl/eagleeye/v1/swagger

Acceptatie endpoint voor de logging service

https://acc-api.medmij.nl/eagleeye/v1/logs

Swagger definitie voor de acceptatie endpoint

https://acc-api.medmij.nl/eagleeye/v1/swagger
Of download de swagger definitie en laad deze in de publieke swagger editor.
Definitie: Swagger Definitie Logcomponent
Swagger editor: https://editor.swagger.io/

Maximale berichtgrootte

60 MB (Megabyte)

Maximaal aantal karakters

62.914.560 karakters

type

Bevat het type event waarvoor het bericht wordt gelogd. Dit is een van de berichttypen zoals genoemd in tabel met berichten.

String (48)

1 van de event typen zoals gedefinieerd in afsprakenstelsel

48

Ja

AS 2.1

location

De FQDN  van het endpoint van de DVP, danwel DVA, waarop het request wordt ontvangen cq waarvan het request wordt verstuurd.

String (64)

64

Ja

Geregistreerde common name in R&A

datetime

Datum en tijd van de gebeurtenis (UTC)+offset.

DateTime (UTC format)

2024-02-14T01:29:22−07:00

In dit geval is het tijdstip 7 uur terug ten opzichte van UTC. Servers dienen zo geconfigureerd te zijn om rekening te houden met DST (daylight saving time). In de code dient men altijd de juiste offset te berekenen t.o.v. UTC. Alle ontwikkeltalen kennen methods om dit te doen. Een voorbeeld in .NET is hier te vinden:
https://stackoverflow.com/questions/33636460/how-to-get-the-offset-of-daylight-saving-time-if-applicable

29

Ja

https://afsprakenstelsel.medmij.nl/asverplicht/mmverplicht/a-12-4-4-kloksynchronisatie

session_id

Identifier van de sessie bij de loggende partij. Wanneer een sessie wordt gestart (uit eigen initiatief of als reactie op een ontvangen verzoek), zal een sessie_id aangemaakt worden welke in alle logberichten kan worden opgenomen.

De DVP is een initiërende partij en bepaalt zelf wanneer de sessie start en eindigt. Voor de DVA is een sessie gedefinieerd als het moment waarop een verzoek binnenkomt (request) tot het moment dat het antwoord geeft op dit verzoek (response). De DVA is stateless en kan derhalve geen sessie onderhouden over meerdere verzoeken heen.

String (36)

Bij voorkeur UUIDv4

36

Ja

Door deelnemer gegenereerd

trace_id

Unique identifier van het ketenverzoek. Deze wordt aangemaakt door de DVP voor alle berichten in een enkele keten gebruikt. Hierdoor is het mogelijk alle berichten welke behoren bij de gehele flow zoals hierboven beschreven te identificeren. Deze wordt in de praktijk meegegeven als X-correlation-ID.

Belangrijk: Dit trace_id wordt voor elke nieuwe flow op het moment van het ophalen van een refresh token opnieuw door de DVP gegenereerd. De DVA gebruikt alleen de trace_id welke door de DVP in het bericht wordt doorgegeven. De DVA genereert dus zelf geen trace_id. Als er geen trace_id beschikbaar is in het request moet een lege UUIDv4 worden gebruikt (00000000-0000-0000-0000-000000000000)

String (36)

6cc1cd7c-7086-4344-be00-e5c7e4c332bc

36

Ja

Door DVP gegenereerd

id

Het unieke ID van het verzoek. Ieder request heeft een eigen, nieuwe, unieke ID welke gekoppeld moet kunnen worden aan een response object van de ontvangende partij.

String

UUIDv4

36

Ja

method

De gebruikte HTTP method (Get/Post/Put) van het verzoek. Let op: niet van het logbericht.

String

Een van de volgende waarden: “get“, “post“, “put“

4

Ja

client_id

De FQDN verzoekbericht verstuurd. Dit is NIET de zorgaanbieder. Dit is altijd ofwel de DVP ofwel de DVA.

String

Indien niet beschikbaar kan deze worden gevuld met 'unknown'

Ja

R&A

server_id

De FQDN van de ontvanger van het verzoek (waar het request naartoe wordt gestuurd danwel wie het request ontvangt).

String

Ja

R&A

uri

De URI waar het request naartoe wordt gestuurd (endpoint)

String

Ja

Stap

Logbericht

1

send_authorization_request*

provider_id

Het identificerende kenmerk (MedMij Aanbiedersnaam) van de betrokken aanbieder.

String

280

Ja

ZAL (zorgaanbiedernaam)

https://afsprakenstelsel.medmij.nl/asverplicht/mmverplicht/aanbiedersnamenbeleid

https://afsprakenstelsel.medmij.nl/asverplicht/mmverplicht/authorization-interface core.authint.200

response_type

Zolang gebruikt gemaakt wordt van oAuth grant, altijd de waarde “code”.

String

code

4

Ja

https://afsprakenstelsel.medmij.nl/asverplicht/mmverplicht/authorization-interface core.authint.200

redirect_uri

De uri waarnaar geredirect wordt zodra authenticatie is voltooid.

String

Ja

oAuthClientList (RedirectUri)

state

De oAuth2 state parameter. De deelnemers genereren deze zelf volgens de specificatie en geven deze mee met authenticatie requests. Bij de response wordt deze waarde vergeleken met de waarde in het antwoord.

String

512

(min 128)

Ja

https://afsprakenstelsel.medmij.nl/asverplicht/mmverplicht/authorization-interface core.authint.200

Stap

Logbericht

6

send_artifact_resolution_request*

request_type

Het type request. Deze bevat altijd de waarde 'SAML_assertion'.

String

“SAML_assertion“

14

Ja

Stap

Logbericht

13

send_token_request*

grant_type

De waarde moet 'authorization_code' of 'refresh_token' zijn, waarbij de laatste alleen gebruikt mag worden bij het uitvoeren van een langdurige toestemming

String

“authorization_code“ of “refresh_token“ (bij langdurige toestemming)

18

Ja

initiated_by

De waarde moet 'person' of 'machine' zijn, waarbij de laatste alleen gebruikt mag worden bij automatisch verzamelen.

Let op! Deze waarde wordt alleen door de DVP gelogd.

String

“person“ indien geïnitieerd vanuit gebruiker, “machine“ voor wanneer een geautomatiseerde trigger de actie start)

7

Ja

Stap

Logbericht

14

receive_token_request*

grant_type

De ontvangen grant_type van de aanvrager

String

“authorization_code“ of “refresh_token“ (bij langdurige toestemming)

18

Ja

Stap

Logbericht

18

send_resource_request*

provider_id

Het identificerende kenmerk (MedMij Aanbiedersnaam) van de betrokken aanbieder.

String

280

Ja

ZAL (zorgaanbiedernaam)

https://afsprakenstelsel.medmij.nl/asverplicht/mmverplicht/aanbiedersnamenbeleid

https://afsprakenstelsel.medmij.nl/asverplicht/mmverplicht/authorization-interface core.authint.200

service_id

Het identificerende kenmerk (nummer) van de opgevraagde gegevensdienst.

String

7

Ja

GDL (gegevensdienstid)

request_id

De corresponderende id welke door de aanvrager in het request object is meegegeven. Dit ID koppelt request aan de response.

Als er geen request_id beschikbaar is, gebruik dan een lege UUIDv4 (00000000-0000-0000-0000-000000000000).

String

UUIDv4

36

Ja

MedMij Request ID (AS 2.1)

core.authint.200

core.tknint.208

core.rscint.201

status

De HTTP status code van de response naar de requestor. Status codes zijn gegroeppeerd in de volgende classen:

    #; - Informational responses (100 – 199)

    #; - Successful responses (200 – 299)

    #; - Redirection messages (300 – 399)

    #; - Client error responses (400 – 499)

    #; - Server error responses (500 – 599)

Integer

3

Ja

Stap

Logbericht

17a

receive_availability_check_error

17b

receive_token_request_error

23a

receive_availability_check_error

23b

receive_resource_request_error

23c

receive_resource_error_response

Stap

Logbericht

3a

authorization_request_error

3b

send_authorization_request_error*

5b

receive_authentication_error*

7a

receive_artifact_request_error

8a

availability_check_error

15a

availability_check_error & send_availability_check_error

16a

send_token_request_error

20a

availability_check_error & send_availability_check_error

22a

send_resource_request_error

22b

send_resource_error_response

code

Indien de fout is ontstaan als gevolg van de oAuth flow, wordt de waarde van het oAuth 2.0 attribuut 'error' overgenomen.

Indien de fout is ontstaan buiten de oAuth flow of geen gevolg is van het oAuth process, , wordt aanbevolen de waarde 'other' te gebruiken.

String

• "invalid_scope"

• "invalid_token"

• "insufficient_scope"

• "invalid_request"

• "invalid_client"

• "invalid_grant"

• "unauthorized_client"

• "unsupported_grant_type"

• "access_denied"

• "unsupported_response_type"

• "server_error"

• "temporarily_unavailable"

• "other"

Ja

description

Beknopte omschrijving van de geregistreerde fout.

In het bericht availability_check_error wordt de description gevuld met de volgende waarden: no_information_available (bij geen behandelrelatie), invalid_age of blocked

String

Ja

Stap

Logbericht

17b

receive_token_request_error

23b

receive_resource_request_error

Stap

Logbericht

3a

authorization_request_error

3b

send_authorization_request_error*

7a

receive_artifact_request_error

16a

send_token_request_error

22a

send_resource_request_error

request_id

De id van het request waarbij de fout is opgetreden.

Als er geen request_id beschikbaar is, gebruik dan een lege UUIDv4 (00000000-0000-0000-0000-000000000000).

String

UUIDv4

36

Ja

status

De HTTP status code

Integer

3

Ja

Antwoord- type

Veldnaam

Formaat

Meer informatie

succes

SAMLart

string

Het SAML-Artifact dat de dienstaanbieder gebruikt om het resultaat van de (gelukte of niet gelukte) authenticatie via de back channel op te halen.

RelayState

string

De waarde van RelayState die de dienstaanbieder app in het verzoek heeft doorgegeven. Indien de dienstaanbieder dit veld niet heeft gevuld in stap 2b, heeft dit veld in het antwoord de waarde null (niet de string "null").

fout

ErrorMessage

string

Een ‘plain tekst’ foutmelding in geval van technische fouten, waarbij het niet mogelijk is een SAMLart te versturen, meldt de app dat via deze ErrorMessage. 

Ook in enkele functionele foutsituaties stuurt de DigiD app via deze ErrorMessage een melding naar de dienstaanbieder, zodat die daar direct op kan reageren:

• _by_user: bij annuleren door de gebruiker.

• not_activated: als de app niet geactiveerd is.

• timeout: als het AuthNRequest van de dienstaanbieder blijkt te zijn verlopen.

• icon_missing: als het verzoek van de dienstaanbieder geen icon bevat.

NB In overige foutsituaties stuurt de DigiD app een succes-response met een niet te resolven SAMLart.  

_by_user

5a receive_authorization_cancellation

not_activated, timeout of icon_missing

5b receive_authentication_error

Description bevat hier de inhoud van de ErrorMessage.

Logstap

Logbericht

21

result_gathering_information

successful

Bevat een array met de namen van de resources voor welke informatie succesvol opgehaald kon worden.

Array of String

Ja

Catalogus

empty

Bevat een array met de namen van de resources voor welke geen informatie beschikbaar is.

Array of String

Ja

Catalogus

unsuccessful

Bevat een array met de namen van de resources voor welke informatie niet succesvol opgehaald kon worden.

Array of String

Ja

Catalogus

mijn.pgo.nl

api.dva.nl

c6a27d45-4316-464e-81e0-48d5dbccacbb

Verschillend per elk request

79dc6181-6239-4fdd-ad98-594312aeac71

79dc6181-6239-4fdd-ad98-594312aeac71 (ontvangen van DVP)

mijn.pgo.nl

api.dva.nl

api.dva.nl

api.dva.nl

Uniek voor elk request bericht

https://api.dva.nl/2.0.0/authorize

een.huisarts@medmij

code

https://mijn.pgo.nl/medmij

ipcxyhlbjtvduydtneoaflwiismwxfmj

SAML_assertion

authorization_code

person

49

access_denied

invalid parameter

1

DVP initieert een nieuwe uitwisseling

2

DVA ontvangt het request van de DVP en logt het ontvangen van het request.

Belangrijk:

• trace_id wordt overgenomen van het bericht van de DVP (parameter X-Correlation-ID)

• location is de eigen location van de DVA

• request_id wordt overgenomen van het bericht van de DVP

• session_id wordt door DVA gegenereerd totdat het antwoord op het verzoek van de DVP wordt gegeven.

3

Na controle van het binnenkomende verzoek logt de DVA het tonen van de landingspagina aan de deelnemer.

Belangrijk:

• session_id is gelijk aan het id dat is gegenereerd bij binnenkomst van het verzoek en gelijk aan dat van bericht 2

3a

Indien de DVA constateert dat het ontvangen client_id, trace_id, request_id of redirect_uri invalide is, logt de DVA 2 foutberichten en toont een foutpagina. (er wordt geen response naar de deelnemer gestuurd?).

Belangrijk:

• Op dit moment eindigt de keten. Er wordt geen response event gelogd.

• Indien het request geen trace_id, request_id of beide bevat, wordt aangeraden voor deze parameters een lege UUIDv4 “00000000-0000-0000-000000000000“ te gebruiken om succesvol het bericht te kunnen loggen bij de logging server.

• Als er geen client_id beschikbaar is, gebruik dan de waarde "not available"

3b

Indien de DVA een poging doet een authorization middels oAuth tot stand te brengen en er een fout optreed, logt de DVA deze gebeurtenis.

Belangrijk:

• Op dit moment eindigt de keten. Er wordt geen response event gelogd.

4

De DVA stuurt het verzoek naar de authorization authority.

Belangrijk:

• trace_id wordt overgenomen van het bericht van de DVP

• location is de eigen location van de DVA

• id is een nieuw UUIDv4 welke door de DVA wordt gegenereerd.

• client_id is hier de DVA

• server_id is hier de authorization authority (digid).

• session_id is nog steeds dezelfde als welke tijdens de ontvangst van het request van de DVP is gegenereerd (in bericht 2).

4a

Indien de burger op de landing page besluit de authenticatie niet te starten (annuleren), logt de DVA dit.

Belangrijk:

• Op dit moment eindigt de keten. Er wordt geen response gestuurd naar de DVP.

5

De DVA ontvangt het resultaat van de authenticatie en logt dit.

Belangrijk:

• trace_id wordt overgenomen van het bericht van de DVP

• location is de eigen location van de DVA

• request_id is gelijk aan de id uit het request object van stap 4

• session_id is nog steeds dezelfde als welke tijdens de ontvangst van het request van de DVP is gegenereerd (in bericht 2).

5a

Indien de gebruiker de authenticatie tijdens het proces annuleert, ontvangt de DVA een cancellation en logt deze gebeurtenis.

Belangrijk:

• trace_id wordt overgenomen van het bericht van de DVP

• location is de eigen location van de DVA

• session_id is nog steeds dezelfde als welke tijdens de ontvangst van het request van de DVP is gegenereerd.

5b

Indien de authenticatie faalt om andere redenen dan cancellation, ontvangt de DVA een error van de DVAuthN en logt de error.

Belangrijk:

• trace_id wordt overgenomen van het bericht van de DVP

• location is de eigen location van de DVA

• session_id is nog steeds dezelfde als welke tijdens de ontvangst van het request van de DVP is gegenereerd.

6

De DVA logt het versturen van de artifact resolution request naar de DVAuthN.

Belangrijk:

• trace_id wordt overgenomen van het bericht van de DVP

• location is de eigen location van de DVA

• id is een nieuw UUIDv4 welke door de DVA wordt gegenereerd.

• client_id is hier de DVA

• server_id is hier de authorization authority (digid).

• session_id is nog steeds dezelfde als welke tijdens de ontvangst van het request van de DVP is gegenereerd.

7

De DVA logt het ontvangen van de artifact resolution response van de DVAuthN.

Belangrijk:

• trace_id wordt overgenomen van het bericht van de DVP

• location is de eigen location van de DVA

• request_id is gelijk aan het id van het request object van stap 6.

• session_id is nog steeds dezelfde als welke tijdens de ontvangst van het request van de DVP is gegenereerd.

7a

Indien de DVA een negatief resultaat van de artifact resolution ontvangt, wordt dit gelogd en wordt teven het tonen van de foutpagina gelogd.

Dit leidt dus tot 2 events in de logging.

Belangrijk:

• trace_id wordt overgenomen van het bericht van de DVP

• location is de eigen location van de DVA

• session_id is nog steeds dezelfde als welke tijdens de ontvangst van het request van de DVP is gegenereerd.

8

Zodra de artifact resolution is afgehandeld, wordt de availability check uitgevoerd door de DVA (indien nog niet geauthoriseerd).

Belangrijk:

• trace_id wordt overgenomen van het bericht van de DVP

• location is de eigen location van de DVA

• session_id is nog steeds dezelfde als welke tijdens de ontvangst van het request van de DVP is gegenereerd.

8a

Indien er een fout optreedt als gevolg van beschikbaarheid- en/of ontvankelijkheidstoets, wordt een foutpagina getoond en worden beide events gelogd.

Dit leidt dus tot 2 events in de logging.

Belangrijk:

• trace_id wordt overgenomen van het bericht van de DVP

• location is de eigen location van de DVA

• session_id is nog steeds dezelfde als welke tijdens de ontvangst van het request van de DVP is gegenereerd.

• Bij description in het error object dient 1 van de volgende waarden te zijn opgenomen: “no_information_available“, "invalid_age" or "blocked"

9

De DVA toont vervolgens het toestemmingsscherm voor het vastleggen van de toestemming.

Belangrijk:

• trace_id wordt overgenomen van het bericht van de DVP

• location is de eigen location van de DVA

• session_id is nog steeds dezelfde als welke tijdens de ontvangst van het request van de DVP is gegenereerd.

10

De DVA logt vervolgens het verkrijgen van toestemming.

Belangrijk:

• trace_id wordt overgenomen van het bericht van de DVP

• location is de eigen location van de DVA

• session_id is nog steeds dezelfde als welke tijdens de ontvangst van het request van de DVP is gegenereerd.

11

De DVA stuurt vervolgens het resultaat van het authenticatie en authorisatie proces naar de DVP. Het beëindigd hiermee de Authenticatie en Authorisatie fase.

Belangrijk:

• trace_id wordt overgenomen van het bericht van de DVP

• location is de eigen location van de DVA

• session_id is nog steeds dezelfde als welke tijdens de ontvangst van het request van de DVP is gegenereerd.

• Het request_id in het response object correspondeert met het originele id uit de request van de DVP.

11a

Indien een gebruiker besluit geen toestemming te verlenen, logt de DVA deze gebeurtenis. De DVA stuurt een aantwoord naar de DVP en logt de gebeurtenis.

Belangrijk:

• trace_id wordt overgenomen van het bericht van de DVP

• location is de eigen location van de DVA

• session_id is nog steeds dezelfde als welke tijdens de ontvangst van het request van de DVP is gegenereerd.

• Omdat de gebruiker zelf de flow onderbreekt wordt er geen error object meegegeven.

12

De DVP ontvangt het resultaat van de authenticatie en authorisatie flow en logt deze gebeurtenis. De DVP kan ofwel een positief, danwel een negatief resultaat terugkrijgen van de DVA. Op dit moment logt de DVP alleen het ontvangen van een response.

Belangrijk:

• trace_id bevat de UUID genereert tijdens het starten van de flow.

• location is de eigen location van de DVP

• session_id is nog steeds dezelfde als welke is gegenereerd bij het starten van de flow door de DVP.

13

Na een succesvolle authenticatie start de DVP met het ophalen van de refresh token bij de token interface. Indien er gebruik gemaakt wordt van langdurige toestemming start het proces in deze stap.

Belangrijk:

• trace_id bevat de UUID genereert tijdens het starten van de flow. Indien het proces hier start genereert de DVP het id op dit moment.

• location is de eigen location van de DVP

• session_id is nog steeds dezelfde als welke is gegenereerd bij het starten van de flow door de DVP. Indien het proces hier start genereert de DVP het id op dit moment.

• grant_type is bij een normale flow “authorization_code“ en bij langdurige toestemming “refresh_token“.

• initated_by is altijd “person“ tenzij het backchannel (geautomatiseerd verzamelen) betreft, in dat geval bevat het “machine“. Deze wordt alleen door de DVP gelogd.

14

De DVA logt het ontvangen van de token request en start een nieuwe sessie. Hiervoor genereert het opnieuw een UUIDv4 voor de sessie.

Belangrijk:

• trace_id wordt overgenomen van het bericht van de DVP

• location is de eigen location van de DVA

• session_id is een nieuwe identifier voor het verwerken van dit request

• grant_type is bij een normale flow “authorization_code“ en bij langdurige toestemming “refresh_token“.

15

De DVA voert de availability check uit indien dit nog niet is gedaan (in het geval van langdurige toestemming).

Belangrijk:

• trace_id wordt overgenomen van het bericht van de DVP

• location is de eigen location van de DVA

• session_id is nog steeds dezelfde als welke tijdens de ontvangst van het request van de DVP is gegenereerd.

15a

Bericht is gelijk aan dat van event in logstap 8a.

Indien er een fout optreedt als gevolg van beschikbaarheid- en/of ontvankelijkheidstoets, wordt een foutpagina getoond en worden beide events gelogd.

Dit leidt dus tot 2 events in de logging.

Belangrijk:

• trace_id wordt overgenomen van het bericht van de DVP

• location is de eigen location van de DVA

• session_id is nog steeds dezelfde als welke tijdens de ontvangst van het request van de DVP is gegenereerd.

• Bij description in het error object dient 1 van de volgende waarden te zijn opgenomen: “no_information_available“, "invalid_age" or "blocked"

16

De DVA stuurt de token response terug naar de DVP en logt dit bij het logcomponent.

Belangrijk:

• trace_id wordt overgenomen van het bericht van de DVP

• location is de eigen location van de DVA

• session_id is nog steeds dezelfde als welke tijdens de ontvangst van het request van de DVP is gegenereerd.

16a

Tijdens het verkrijgen van de token door de DVA treedt een fout op. De DVA stuurt de response van de fout naar de DVP en logt de gebeurtenis.

Belangrijk:

• trace_id wordt overgenomen van het bericht van de DVP

• location is de eigen location van de DVA

• session_id is nog steeds dezelfde als welke tijdens de ontvangst van het request van de DVP is gegenereerd.

• request_id is gelijk aan het id in het request object van de DVP, als er geen request_id beschikbaar is, gebruik dan een lege UUIDv4 (00000000-0000-0000-0000-000000000000).

• status: De HTTP status code van de response.

17

De DVP ontvangt het resultaat van de token refresh flow en logt deze gebeurtenis. De DVP kan ofwel een positief, danwel een negatief resultaat terugkrijgen van de DVA. Op dit moment logt de DVP alleen het ontvangen van een response.

De token fase wordt hiermee afgesloten.

Belangrijk:

• trace_id bevat de UUID genereert tijdens het starten van de flow

• location is de eigen location van de DVP

• session_id is nog steeds dezelfde als welke is gegenereerd bij het starten van de flow door de DVP.

17a

Indien de DVP een error ontvangt doordat de beschikbaarheids of ontvankelijkheidstoets faalt, logt de DVP deze gebeurtenis.

Belangrijk:

• trace_id bevat de UUID genereert tijdens het starten van de flow

• location is de eigen location van de DVP

• session_id is nog steeds dezelfde als welke is gegenereerd bij het starten van de flow door de DVP.

• Bij description in het error object dient 1 van de volgende waarden te zijn opgenomen: “no_information_available“, "invalid_age" or "blocked", afhankelijk van de error in de response van de DVA

17b

Indien de DVA een error ontvangt tijdens de token refresh zal de DVP een error bericht van de DVA ontvangen. De DVP logt deze gebeurtenis.

18

Nu alle authenticatie, authorisatie en token processen zijn voltooid, kan de DVP de gegevens opvragen voor de gegevensdiensten bij de betreffende aanbieder.

Belangrijk:

• trace_id bevat de UUID genereert tijdens het starten van de flow.

• location is de eigen location van de DVP

• session_id is nog steeds dezelfde als welke is gegenereerd bij het starten van de flow door de DVP.

• provider_id bevat de dienstverlener welke de betreffende gegevensdienst aanbiedt.

• service_id is het uniek identificerende kenmerk van een gegevensdienst, zoals genoemd in de catalogus voor gegevensdiensten.

19

De DVA ontvangt het resource verzoek van de DVP en logt dit.

Belangrijk:

• trace_id wordt overgenomen van het bericht van de DVP

• location is de eigen location van de DVA

• session_id is een nieuwe identifier na ontvangst van het request van de DVP.

• provider_id bevat de dienstverlener welke de betreffende gegevensdienst aanbiedt.

• service_id is het uniek identificerende kenmerk van een gegevensdienst, zoals genoemd in de catalogus voor gegevensdiensten.

20

De DVA voert de availability check uit indien dit nog niet is gedaan (in het geval van langdurige toestemming).

Belangrijk:

• trace_id wordt overgenomen van het bericht van de DVP

• location is de eigen location van de DVA

• session_id is nog steeds dezelfde als welke tijdens de ontvangst van het request van de DVP is gegenereerd.

20a

Indien er een fout optreedt als gevolg van beschikbaarheid- en/of ontvankelijkheidstoets, logt de DVA de fout en logt de DVA tevens dat de fout naar de DVP wordt gestuurd.

Dit leidt dus tot 2 events in de logging.

Belangrijk:

• trace_id wordt overgenomen van het bericht van de DVP

• location is de eigen location van de DVA

• session_id is nog steeds dezelfde als welke tijdens de ontvangst van het request van de DVP is gegenereerd.

• Bij description in het error object dient 1 van de volgende waarden te zijn opgenomen: “no_information_available“, "invalid_age" or "blocked"

21

De DVA logt het resultaat van het ophalen van de informatie bij de aanbieder. Hij geeft hier in 3 arrays aan welke diensten hij succesvol, niet succesvol of waarvoor geen gegevens ontvangen konden worden.

Belangrijk:

• trace_id wordt overgenomen van het bericht van de DVP

• location is de eigen location van de DVA

• session_id is nog steeds dezelfde als welke tijdens de ontvangst van het request van de DVP is gegenereerd.

• Het “Information“ object bevat 3 arrays met de namen van de opgehaalde ZIB’s.

!In de arrays mag geen gevoelige persoonsinformatie worden opgenomen, ook niet in versleutelde vorm!

22

De DVA stuurt de informatie terug naar de DVP en logt de gebeurtenis.

Belangrijk:

• trace_id wordt overgenomen van het bericht van de DVP

• location is de eigen location van de DVA

• session_id is nog steeds dezelfde als welke tijdens de ontvangst van het request van de DVP is gegenereerd.

22a

Bij het ontvangen van het verzoek van de DVP, constateert de DVA een fout in het verzoek van de DVP. De DVA stuurt een response naar de DVP en logt de gebeurtenis.

Belangrijk:

• trace_id wordt overgenomen van het bericht van de DVP

• location is de eigen location van de DVA

• session_id is nog steeds dezelfde als welke tijdens de ontvangst van het request van de DVP is gegenereerd.

• request_id is gelijk aan het id in het request object van de DVP, als er geen request_id beschikbaar is, gebruik dan een lege UUIDv4 (00000000-0000-0000-0000-000000000000).

22b

Bij een correct verzoek van de DVP treedt tijdens het verkrijgen van de resources door de DVA een fout op. De DVA stuurt de response van de fout naar de DVP en logt de gebeurtenis.

Belangrijk:

• trace_id wordt overgenomen van het bericht van de DVP

• location is de eigen location van de DVA

• session_id is nog steeds dezelfde als welke tijdens de ontvangst van het request van de DVP is gegenereerd.

• request_id is gelijk aan het id in het request object van de DVP; als er geen request_id beschikbaar is, gebruik dan een lege UUIDv4 (00000000-0000-0000-0000-000000000000).

• code (in het error object) kan hier de waardes “invalid_scope”, “invalid_token” of “insufficient_scope” hebben, zoals beschreven in https://datatracker.ietf.org/doc/html/rfc6750#section-6.2 .

23

De DVP ontvangt de opgevraagde informatie van de aanbieder en logt dit.

Hiermee wordt de resource fase afgesloten en daarmee de volledige cyclus in de keten.

Belangrijk:

• trace_id bevat de UUID genereert tijdens het starten van de flow.

• location is de eigen location van de DVP

• session_id is nog steeds dezelfde als welke is gegenereerd bij het starten van de flow door de DVP. De sessie wordt beeindigd zodra de gebruiker uitlogt of gedwongen wordt uitgelogd.

23a

Indien de DVP een error ontvangt doordat de beschikbaarheids of ontvankelijkheidstoets faalt, logt de DVP deze gebeurtenis.
De DVA stuurt conform de resource interface specificatie, resource interface 5 een http status 403 met een error attribuut “access_denied“ terug.

https://afsprakenstelsel.medmij.nl/asverplicht/mmverplicht/resource-interface

Belangrijk:

• trace_id bevat de UUID genereert tijdens het starten van de flow

• location is de eigen location van de DVP

• session_id is nog steeds dezelfde als welke is gegenereerd bij het starten van de flow door de DVP.

• Bij description in het error object dient 1 van de volgende waarden te zijn opgenomen: “no_information_available“, "invalid_age" or "blocked", afhankelijk van de error in de response van de DVA.

23b

Indien de DVP een error ontvangt doordat de DVA de fouten constateert in het originele verzoek van de DVP, logt hij deze gebeurtenis.
De DVA stuurt conform de resource interface specificatie, resource interface 4 een http status 400 met een error attribuut “invalid_request“ terug.

https://afsprakenstelsel.medmij.nl/asverplicht/mmverplicht/resource-interface

Omdat het een request error is, moeten de atributen ‘request_id' en 'status’ aan het error object worden toegevoegd.

Belangrijk:

• trace_id bevat de UUID genereert tijdens het starten van de flow

• location is de eigen location van de DVP

• session_id is nog steeds dezelfde als welke is gegenereerd bij het starten van de flow door de DVP.

23c

Indien de DVP een error ontvangt doordat de DVA de gegevens niet kon ophalen, logt hij deze gebeurtenis.
De DVA stuurt conform de resource interface specificatie, resource interface 6 een http status anders dan bovenstaande met bijbehorend error attribuut.

Indien de DVP geen antwoord van de DVA ontvangt, wordt geadviseerd een status 408 te loggen met code “temporarily_unavailable” en description “request timed out” (voorbeeld 2).

https://afsprakenstelsel.medmij.nl/asverplicht/mmverplicht/resource-interface

Belangrijk:

• trace_id bevat de UUID genereert tijdens het starten van de flow

• location is de eigen location van de DVP

• session_id is nog steeds dezelfde als welke is gegenereerd bij het starten van de flow door de DVP