X_CORRELATION_ID toevoegen in de headers van Touchstone

Description

Vanaf het MedMij 2.x afsprakenstelsel wordt het toevoegen van de X_CORRELATION_ID in de headers in het resourcerequest verwacht (Resource interface (medmij.nl))

De OAuth Client voegt bij het versturen van een resource request twee HTTP Header Fields toe, de eerste met de naam MedMij-Request-ID, de tweede met de naam X-correlation-ID. Het MedMij-Request-ID moet een willekeurige waarde bevatten en dient uniek te zijn voor ieder request binnen het MedMij netwerk. De waarde bestaat uit een UUID. Het X-Correlation-ID wordt overgenomen van X-Correlation-ID uit het Authorization request. Als gebruikgemaakt wordt van langdurige toestemming, dan wordt X-Correlation-ID uit het Token request overgenomen.

Hier moet de DVA op controleren en wanneer de verplichte header niet aanwezig is er een status-code 400 invalid-request moet worden gestuurd.

De wens vanuit de DVA is dat de X-Correlation-ID aanwezig is in ons materiaal van Touchstone, zodat ze geen workaround hoeven te implementeren voor de 'foutmelding' die nu getoond wordt vanwege de afwezigheid van X-Correlation-ID in de header.

Dit is vergelijkbaar met het al eerder toevoegen van de MedMij-Request-ID in . Ook hier kan de waarde een (door Touchstone gegenereerde) UUID zijn, gezien de UUID binnen de context van Touchstone slechts dient om te voldoen aan de verplichting en geen authorisatie-functie heeft. Daarnaast zit deze header niet in de weg voor deelnemers die de header (nog) niet kennen of verwerken.

Na ruggespraak met een deelnemer is besloten om de X-Correlation-ID als variabele toe te voegen in de TestScripts. Dit betekent dat de UUID uniek is per TestScript (in plaats van alternatieven als een uniek UUID per request of een fixed dummy UUID). Dit heeft als nadeel dat de variabele zichtbaar is bij het aanmaken van een testexecutie. wat enigszins vervuilend is, maar wat uiteindelijk geen impact heeft.

Een toelichting op beide headers moet worden geplaatst op en MedMij:V2019.01 Kwalificatie aansluiten - informatiestandaarden (nictiz.nl). MedMij V6 bleek geen eigen Touchstone-handleiding te hebben, hiervoor aangemaakt

Verduidelijking van Impact

Deelnemers die al geaccepteerd zijn voor MedMij Afsprakenstelsel 2.x en de headers die daarbij verwacht worden correct verwerken, kunnen nog steeds gebruikt maken van de Touchstone-testmaterialen voor (her)testen

Proposed solution (NL)

Aan iedere operation binnen alle MedMij-TestScripts een requestHeader met naam 'X-Correlation-ID' toevoegen met als value een UUID. Een toelichting op de MedMij-headers in de Touchstone-handleidingen plaatsen.

Proposed solution (EN)

Add a requestHeader with the name 'X-Correlation-ID' with a UUID as value to each operation within all MedMij TestScripts. Add explanation on the MedMij headers to the Touchstone manuals.

Release notes (NL)

Aan iedere operation binnen alle MedMij-TestScripts wordt een requestHeader met naam 'X-Correlation-ID' toegevoegd met als value een UUID. Een toelichting op de MedMij-headers is in de Touchstone-handleidingen geplaatst.

Release notes (EN)

A requestHeader with the name 'X-Correlation-ID' with a UUID as value has been added to each operation within all MedMij TestScripts. An explanation on the MedMij headers has been added to the Touchstone manuals.