Voor het uitvoeren van monitoring en het opstellen van rapportages moet Aanvullende ketenmonitoring is een aanvulling op de reeds bestaande faciliteiten ten aanzien van logging van de deelnemers. Om aanvullende ketenmonitoring te kunnen uitvoeren moet Stichting MedMij beschikken over goede loggegevens van alle deelnemers. Deze pagina beschrijft welke gebeurtenissen moeten worden vastgelegd, aan welke eisen logregels en verzamelingen van logregels moeten voldoen, hoe deze aangeleverd moeten worden en welke verantwoordelijkheden de verschillende rollen hebben.

Gebeurtenissen

Image Removed

In bovenstaande plaat staat de functie Verzamelen uitgewerkt, inclusief de momenten waarop iets gelogd moet worden. Voor Abonneren en Delen moeten dezelfde gebeurtenissen worden vastgelegd.

...

1. authorization_request_error & show_authorization_request_error_page: in plaats van het tonen van de landingspagina logt de DVA het ontvangen van een incorrecte client_id en/of redirect_uri en toont een foutpagina. Ook dit wordt vastgelegd.
2. send_authorization_request_error: in plaats van het tonen van de landingspagina logt de DVA het ontvangen van incorrecte parameters

...

1. send_authorization_cancellation: in plaats van het sturen van een authentication request naar de DVAuthN stuurt de DVA een authorization cancellation naar de DVP. De DVA moet deze gebeurtenis vastleggen.

...

1. receive_authorization_cancellation: in plaats van een authentication response ontvangt de DVA een authorization cancellation van de DVAuthN en logt deze gebeurtenis.
2. receive_authentication_error: in plaats van een authentication response ontvangt de DVA een authentication error van de DVAuthn en logt deze gebeurtenis.

...

send_artifact_resolution_request: de DVA logt het versturen van een artifact resolution request naar de DVAuthN.

...

Met deze loggegevens kan Stichting MedMij eerder verstoringen in de keten signaleren en hier sneller op acteren. Uiteindelijk leidt dit tot een afname van de duur van verstoringen en zullen zorggebruikers minder problemen ervaren bij het gebruik van  PGO's. Met de vastlegging van gebeurtenissen in het aanvullende ketenlog wordt ook de basis gelegd voor het verkrijgen van verschillende inzichten in de keten (bijvoorbeeld in de kwaliteit van uitwisseling en de volledigheid van uitwisseling). Dit alles verbetert de kwaliteit van gegevensuitwisseling en draagt daardoor bij aan de verhoging van gegevensuitwisselingen binnen de schakels van de MedMij keten.

Deze pagina beschrijft welke gebeurtenissen moeten worden vastgelegd, aan welke eisen logregels en verzamelingen van logregels moeten voldoen, hoe deze aangeleverd moeten worden en welke verantwoordelijkheden de verschillende rollen hebben. 

Gebeurtenissen

In bovenstaande plaat staat de functie Verzamelen uitgewerkt, inclusief de momenten waarop iets gelogd moet worden. Voor Abonneren en Delen moeten dezelfde gebeurtenissen worden vastgelegd.

1. send_authorization_request: de DVP logt het versturen van een authorization request naar de DVA.
2. receive_authorization_request: de DVA logt het ontvangen van een artifact responseauthorization request van de DVP.
3. receive_artifactshow_landing_page: de DVA logt het tonen van de landingspagina.
   
   1. authorization_request_error & show_authorization_authenticationrequest_error_page: De DVA ontvangt een negatief resultaat op het authenticatie proces, logt dit in plaats van het tonen van de landingspagina logt de DVA het ontvangen van een incorrecte client_id en/of redirect_uri en toont een foutpagina. Ook , ook dit wordt vastgelegd.
   result
   1. send_authorization_
   availability
   1. request_
   check: indien op dit moment de beschikbaarheids- of ontvankelijkheidstoets wordt uitgevoerd, dan
   1. error: in plaats van het tonen van de landingspagina logt de DVA het
   resultaat hiervan.
   
   1. availability_check_error & show_availability_check_error_page: De DVA logt een fout in de beschikbaarheids- of ontvankelijkheidstoets en toont een foutscherm met de mogelijkheid terug te keren naar de DVP. Ook het tonen van het scherm wordt gelogt.
4. show_consent_page: de DVA logt het tonen van de toestemmings- of bevestigingsverklaring.
5. receive_consent: de DVA logt het verkrijgen van de toestemming.
6. send_authorization_response: de DVA logt het versturen van een authorization response.
   
   1. send_authorization_cancellation:  ontvangen van incorrecte parameters
7. send_authentication_request: de DVA logt het versturen van een authentication request naar de DVAuthN.
   1. send_authorization_cancellation: in plaats van het sturen van een authorization response authentication request naar de DVP DVAuthN stuurt de DVA een authorization cancellation naar de DVP. De DVA moet deze gebeurtenis vastleggen.
8. receive_authorizationauthentication_response: de DVP DVA logt het ontvangen van een authorization authentication response van de DVAuthN.
   send
   1. receive_
   token
   1. authorization_
   request: de DVP logt het versturen van een token request.receive_token
   1. cancellation: in plaats van een authentication response ontvangt de DVA een authorization cancellation van de DVAuthN en logt deze gebeurtenis.
   2. receive_authentication_error: in plaats van een authentication response ontvangt de DVA een authentication error van de DVAuthn en logt deze gebeurtenis.

9. send_artifact_resolution_request: de DVA logt het

   ontvangen

   versturen van een

   token request.

    artifact resolution request naar de DVAuthN.

10. receive_artifact_response: de DVA logt het ontvangen van een artifact response.
    
    1. receive_artifact_request_error & show_authentication_error_page: De DVA ontvangt een negatief resultaat op het authenticatie proces, logt dit en toont een foutpagina, ook dit wordt vastgelegd.
11. result_availability_check: indien op dit moment de beschikbaarheids- of ontvankelijkheidstoets wordt uitgevoerd, dan logt de DVA het resultaat hiervan.
    
    1. availability_check_error & sendshow_availibilityavailability_check_error_page: De DVA logt de een fout in de beschikbaarheids- of ontvankelijkheidstoets en logt ook dat het de fout naar de DVP stuurttoont een foutscherm met de mogelijkheid terug te keren naar de DVP. Ook het tonen van het scherm wordt gelogd.
12. show_consent_page: de DVA logt het tonen van de toestemmings- of bevestigingsverklaring.
13. receive_consent: de DVA logt het verkrijgen van de toestemming.
14. send_tokenauthorization_response: de DVA logt het versturen van een token authorization response.
    
    1. send_tokenauthorization_request_errorcancellation:  in plaats van het sturen van een token authorization response naar de DVP stuurt de DVA een token request errorauthorization cancellation naar de DVP. De DVA moet deze gebeurtenis loggenvastleggen.
15. receive_tokenauthorization_response: de DVP logt het ontvangen van een token authorization response.
    1. receive_availibility_check_error: in plaats van een token response ontvangt de DVP een availibility check error van de DVA en logt deze gebeurtenis.
    2. receive_token_request_error:  in plaats van een token response ontvangt de DVP een token request error van de DVA en logt deze gebeurtenis.
16. send_resource_send_token_request: de DVP logt het versturen van een resource token request.
17. receive_resourcetoken_request: de DVA logt het ontvangen van een resource token request.
18. result_availability_check: indien op dit moment de beschikbaarheids- of ontvankelijkheidstoets wordt uitgevoerd, dan logt de DVA het resultaat hiervan.
    
    1. availability_check_error & send_availibilityavailability_check_error:  De De DVA logt de fout in de beschikbaarheids- of ontvankelijkheidstoets en logt ook dat het de fout naar de DVP stuurt.
    result_gathering_information: de DVA logt welke gegevens opgehaald konden worden en welke niet
    1. .
19. send_resourcetoken_response: de DVA logt het versturen van een resource token response.
    1. send_resourcetoken_request_error: in plaats van het sturen van een resource token response naar de DVP stuurt de DVA een resource token request error naar de DVP. De DVA moet deze gebeurtenis vastleggen.send_resource_error_responseloggen.
20. receive_token_response: de DVP logt het ontvangen van een token response.
    
    1. receive_availability_check_error: in plaats van het sturen van een resource token response naar ontvangt de DVP stuurt de DVA een resource error response naar de DVP. De DVA logt dat de gegevens niet gevonden of verstuurd konden wordeneen availability check error van de DVA en logt deze gebeurtenis.
    2. receive_
    resource_response: de DVP logt het ontvangen van een resource response.
    
    1. receive_availibility_checktoken_request_error:  in plaats van een resource token response ontvangt de DVP een availibility check token request error van de DVA en logt deze gebeurtenis.receive
21. send_resource_request_error: in plaats van een resource response ontvangt de DVP logt het versturen van een resource request error van .
22. receive_resource_request: de DVA en logt deze gebeurtenislogt het ontvangen van een resource request.receive
23. result_resourceavailability_error_response: in plaats van een resource response ontvangt de DVP een availibility resource error response van de DVA en logt deze gebeurtenis.

Verantwoordelijkheden

...

Alle aan te leveren logregels bevatten een event-object met een vaste set aan attributen:

• type
  een vaste code per gebeurtenis, te kiezen uit de lijst hierboven.
• location
  De hostname van deelnemer die de logregel vastlegt.
• datetime
  De datum, het tijdstip en de tijdzone van de gebeurtenis, vastgelegd in het formaat "2023-03-28T22:14:23.618+01:00".
• session_id
  Het identificerende kenmerk van de sessie bij de deelnemer, bij voorkeur een UUID.
• trace_id
  Het identificerende kenmerk van het proces waarbinnen de stap wordt uitgevoerd, vastgelegd als UUID.

{
	"event": {
  		"type": "send_authorization_request",
  		"location": "mijn.pgo.nl",
  		"datetime": "2023-03-28T22:14:23.618+01:00",
  		"session_id": "c6a27d45-4316-464e-81e0-48d5dbccacbb",
  		"trace_id": "79dc6181-6239-4fdd-ad98-594312aeac71"
  	 }
 }

...

De logregels van alle verzonden en ontvangen verzoeken bevatten een request-object met een vaste set aan attributen:

• id
  Het unieke identificerende kenmerk (UUID) van het verzoek dat door versturende en ontvangende partij gebruikt wordt.
• method
  De gebruikte http method.
• client_id
  De hostname van de verzender van het verzoek.
• server_id
  De hostname van de ontvanger van het verzoek.
• uri
  De URI waar het verzoek naartoe wordt gestuurd.

...

...

1. check: indien op dit moment de beschikbaarheids- of ontvankelijkheidstoets wordt uitgevoerd, dan logt de DVA het resultaat hiervan.
   
   1. availability_check_error & send_availability_check_error: De DVA logt de fout in de beschikbaarheids- of ontvankelijkheidstoets en logt ook dat het de fout naar de DVP stuurt.
2. result_gathering_information: de DVA logt welke gegevens opgehaald konden worden en welke niet.

3. send_resource_response: de DVA logt het versturen van een resource response.

   1. send_resource_request_error: Indien het request van de DVP niet correct is (inhoudelijk of technisch), stuurt de DVA in plaats van een resource response een resource request error naar de DVP. De DVA logt hiervoor een send_resource_request_error.

   2. send_resource_error_response: Indien bij het opvragen van de resources bij de aanbieder een fout ontstaat, stuurt de DVA in plaats van een resource response een resource error response naar de DVP. De DVA logt dat de gegevens niet gevonden of verstuurd konden worden met behulp van een send_resource_error_response.

4. receive_resource_response: de DVP logt het ontvangen van een resource response.
   
   1. receive_availability_check_error:  in plaats van een resource response ontvangt de DVP een availability check error van de DVA en logt deze gebeurtenis.
   2. receive_resource_request_error: in plaats van een resource response ontvangt de DVP een resource request error van de DVA en logt deze gebeurtenis.
   3. receive_resource_error_response: in plaats van een resource response ontvangt de DVP een availability resource error response van de DVA en logt deze gebeurtenis.

Verantwoordelijkheden

{
	"event": {
  		"type": "send_authorization_request",
  		"location": "mijn.pgo.nl",
  		"datetime": "2023-03-28T22:14:23.618+01:00",
  		"session_id": "c6a27d45-4316-464e-81e0-48d5dbccacbb",
  		"trace_id": "79dc6181-6239-4fdd-ad98-594312aeac71"
  	 }
 }

{

	"event": { 

		"type": "send_authorization_request", 

		"location": "mijn.pgo.nl", 

		"datetime": "2023-03-28T22:14:23.618+01:00", 

		"session_id": "c6a27d45-4316-464e-81e0-48d5dbccacbb", 

		"trace_id": "79dc6181-6239-4fdd-ad98-594312aeac71"

	}, 

	"request": { 

		"id": "8b5d6cb2-a2c0-4893-bd97-240621c3e488", 

		"method": "get", 

		"client_id": "mijn.pgo.nl", 

		"server_id": "

as.dva.nl", 

		"uri": "https://api.as.dva.nl/2.0.0/authorize"

}
 }

{
  "event": {
    "

type": "

send_authorization_request",
  

  "location": "mijn.pgo.nl",
    "datetime": "2023-03-28T22:14:23.618+01:00",
    "session_id": "c6a27d45-4316-464e-81e0-48d5dbccacbb",
    "

trace_id": "

79dc6181-6239-4fdd-ad98-594312aeac71"
  },
  "

request": 

{
    "

id": "

8b5d6cb2-a2c0-4893-bd97-240621c3e488",
    "

method": "

get",
    "

client_id": "

mijn.pgo.nl",
    

"server_id": "

api.dva.nl",
    "

uri": "

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

provider_id": "

een.

huisarts@medmij",
    "

response_

type": "

code",
    "redirect_uri": "https://

mijn.

pgo.

nl/

medmij",
    "

state": "

ipcxyhlbjtvduydtneoaflwiismwxfmj"
  }
}

{
  "event": {
    "type": "send_artifact_

resolution_request",
    "location": "

api.

dva.nl",
    "datetime": "2023-03-28T22:14:23.618+01:00",
    "session_id": "c6a27d45-4316-464e-81e0-48d5dbccacbb",
    "trace_id": "79dc6181-6239-4fdd-ad98-594312aeac71"
  },
  "request": {
    "id": "8b5d6cb2-a2c0-4893-bd97-240621c3e488",
    "method": "get",
    "client_id": "

api.

dva.nl",
    "server_id": "

digid.

nl",

    "uri": "https://api.as.dva.nl/2.0.0/authorize",
  

 "

request_type": "

SAML_assertion"
  }
}

{
  "event": {
    "type": "send_

token_request",
    "location": "mijn.pgo.nl",
    "datetime": "2023-03-28T22:14:23.618+01:00",
    "session_id": "c6a27d45-4316-464e-81e0-48d5dbccacbb",
    "trace_id": "79dc6181-6239-4fdd-ad98-594312aeac71"
  },
  "request": {
    "id": "8b5d6cb2-a2c0-4893-bd97-240621c3e488",
    "method": "get",
    "client_id": "mijn.pgo.nl",
    "server_id": "api.dva.nl", 
    "uri": "https://api.dva.nl/2.0.0/authorize",
  

 "

grant_

type": "

authorization_code",
    "

initiated_

by": 

"person"
  }
}

{
  "event": {
    "type": "

receive_

token_

request",
    "location": "

api.dva.nl",
    "datetime": "2023-

09-28T22:14:

36.618+01:00",
    "session_id": "

d7382884-

865e-

4185-

8347-

2c4922d8ef73",
    "trace_id": "79dc6181-6239-4fdd-ad98-594312aeac71"
  },
  "

request": {
    "

id": "

1p5d6cb2-a2c0-4893-bd97-

240621c3e582",
    "

method": "get",

{
  "event": {
    "type": "availibility_check_error",
    "location": "as.dva.nl",
    "datetime": "2023-03-28T22:14:23.618+01:00",
    "session_id": "c6a27d45-4316-464e-81e0-48d5dbccacbb",
    "trace_id": "79dc6181-6239-4fdd-ad98-594312aeac71"
  },
  "error": {
    "code": "access_denied",
    "description": "no_information_available"
  }
}

"client_id": "mijn.pgo.nl",
    "server_id": "api.dva.nl",
    "uri": "https://api.dva.nl/2.0.0/token",
    "grant_type": "authorization_code",
  }
}

<Gegevensdienstnamenlijst xmlns="xmlns://afsprakenstelsel.medmij.nl/gegevensdienstnamenlijst/release1/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="xmlns://afsprakenstelsel.medmij.nl/gegevensdienstnamenlijst/release1/">
     <Tijdstempel>2020-05-04T18:13:51.0+01:00</Tijdstempel>
          <Volgnummer>50</Volgnummer>
          <Gegevensdiensten>
            <Gegevensdienst>
              <GegevensdienstId>1</GegevensdienstId>
              <Weergavenaam>Basisgegevens Zorg</Weergavenaam></Gegevensdienst>
            </Gegevensdiensten>
</Gegevensdienstnamenlijst>

{
  "event": {
    "type": "send_

resource_

request",
    "location": "

mijn.

pgo.nl",
    "datetime": "2023-03-28T22:14:23.618+01:00",
    "session_id": "c6a27d45-4316-464e-81e0-48d5dbccacbb",
    "trace_id": "79dc6181-6239-4fdd-ad98-594312aeac71"
  },
  "

request": {
    "

id": "

8b5d6cb2-a2c0-4893-bd97-240621c3e488",
    "

method": "

get",
    "

client_id": "

mijn.pgo.nl",
    "

server_id":

 "api.dva.nl",
    

"uri": "https://api.dva.nl/2.0.0/authorize",
    "provider_id": "een.huisarts@medmij",
    "service_id": 49
  }
}

{
  "event": {
    "type": "

send_

authorization_

response",
    "location": "

as.dva.nl",
    "datetime": "2023-03-28T22:14:23.618+01:00",
    "session_id": "c6a27d45-4316-464e-81e0-48d5dbccacbb",
    "trace_id": "79dc6181-6239-4fdd-ad98-594312aeac71"
  },
  "

response": {
    "

request_id": 

"8b5d6cb2-a2c0-4893-bd97-240621c3e488",
    "

status": 200

}
}

{
  "event": {
    "type": "availability_check_error",
    "location": "as.dva.nl",
    "datetime": "2023-03-28T22:14:23.618+01:00",
    "session_id": "c6a27d45-4316-464e-81e0-48d5dbccacbb",
    "trace_id": "79dc6181-6239-4fdd-ad98-594312aeac71"
  },
  "error": {
    "code": "access_denied",
    "description": "no_information_available"
  }
}

{
	"event": {
		"type": "send_authorization_request_error",
		"location": "api.dva.nl",
		"datetime": "2023-03-28T22:14:23.618+01:00",
		"session_id": "c47f3eb8-3a70-4317-87ce-e6d3e3e53167",
		"trace_id": "79dc6181-6239-4fdd-ad98-594312aeac71"
	},
	"error": {
		"code": "access_denied",
		"description": "invalid_parameter",
		"request_id": "8b5d6cb2-a2c0-4893-bd97-240621c3e488",
		"status": 400
	}
}

{
  "event": {
    "type": "result_gathering_information",
    "location": "api.dva.nl",
    "datetime": "2023-03-28T22:14:23.618+01:00",
    "session_id": "c6a27d45-4316-464e-81e0-48d5dbccacbb",
    "trace_id": "79dc6181-6239-4fdd-ad98-594312aeac71"
  },
  "information": {
    "successful": ["name1", "name2"],
    "empty":  ["name3", "name4"],
    "unsuccessful": ["name5", "name6"]
  }
}

Object Model Logregel

In onderstaand model wordt de samenstelling van een logregel schematisch weergegeven. Elke logregel bestaat uit een Event object, met daarbij optioneel één of meer van de andere objecten uit het schema. Zowel het Request- als het Response object hebben enkele afgeleiden welke additionele attributen toevoegen in specifieke situaties. Onder elk object is opgenomen bij welke gebeurtenis het object wordt verwacht.

Let op! Elk bericht bevat minimaal het event object.