Brontekst bekijken van kwalificatie:V1.0 Handleiding Touchstone

__NUMBEREDHEADINGS__
{{kwalificatie:V1.0_Issuebox}}
<section begin="Introductie Touchstone"/>
===Introductie Touchstone===

Om FHIR-implementaties van een informatiestandaard te beproeven en te kwalificeren is de Touchstone-simulatieomgeving beschikbaar. Dit is een online platform waarmee leveranciers zelf tests kunnen uitvoeren en validatieresultaten kunnen inzien. Nictiz stelt de hiervoor benodigde testscripts beschikbaar. Deze komen overeen met de functionele testscripts bij een informatiestandaard.

Algemene opmerkingen over het gebruik van de simulator:
* De simulator is niet bedoeld voor loadtesten, maar voor inhoudelijke controles tegen informatiestandaarden;
* Nictiz vraagt verantwoord gebruik van deze simulator, neem bij twijfel over gebruik contact op.

====Testopzet client====
Bij testen waar de FHIR-client het testobject is ziet de testopstelling er als volgt uit:

[[Bestand:Touchstone client.jpg|link= |750px]]

De opzet is hier als volgt:
* De client is het testobject van de leverancier.
* Touchstone staat in het midden en stelt testen/testscripts, logging, validatie en overzicht beschikbaar.
* Daarachter staat een FHIR-server (WildFHIR) met de FHIR-profielen en testberichten passend bij de testscripts.

====Testopzet server====
Bij testen waar de FHIR-server het testobject is ziet de testopstelling er als volgt uit:

[[Bestand:Touchstone server.jpg|link= |550px]]

De opzet is hier als volgt:
* Touchstone stelt testen/testscripts, logging, validatie en overzicht beschikbaar. Daarnaast is Touchstone ook een FHIR-client die interacties kan versturen volgens de testscripts.
* De server is het testobject van de leverancier.
<section end="Introductie Touchstone" />
<section begin="Touchstone-account"/>

===Touchstone-account===
====Account aanmaken====

Leveranciers hebben een eigen bedrijfsaccount nodig voor hun organisatie op Touchstone. Er zijn [https://touchstone.aegis.net/touchstone/subscription verschillende abonnementsvormen beschikbaar], waaronder een gratis abonnement. Deze optie (Open) biedt die alle mogelijkheden om te kunnen testen en kwalificeren, maar kent wel limieten, onder meer het aantal tests dat per dag kan worden uitgevoerd.

Voor het aanmaken van een organisatie op Touchstone kunnen de stappen op https://touchstone.aegis.net/touchstone/userguide/html/registration-and-login/membership.html gevolgd worden. Let er op dat de "Name" van de organisatie het liefst herkenbaar moet zijn voor Nictiz en dat er niet bijvoorbeeld de naam van een onderontwikkelaar wordt ingevuld. Dit vereenvoudigt het aanmeldproces.

Let erop dat Touchstone standaard e-mailadressen en de organisatie van geregistreerde gebruikers toont. Individuele gebruikers kunnen dit in de instellingen van hun account aanpassen.

====Join Org Group====

Het bedrijfsaccount moet vervolgens toegang krijgen tot de Nictiz-materialen. Dit gaat door lid te worden van de relevant "Org Group(s)". De [https://touchstone.aegis.net/touchstone/userguide/html/org-groups/joining.html Touchstone-handleiding beschrijft] hoe een verzoek hiervoor kan worden ingediend. Nictiz zal vervolgens het verzoek voor toetreding goedkeuren. Merk op dat hierbij goedkeuring van één van onze medewerkers nodig is en er dus korte tijd overheen kan gaan. Nadat goedkeuring is verleend dient de gebruiker, als deze nog is ingelogd, uit te loggen en opnieuw in te loggen.
<section end="Touchstone-account"/>
<section begin="Testsysteem aanmaken"/>
===Testsysteem aanmaken===

De volgende stap is om het systeem dat getest moet worden als "Test System" te registreren in Touchstone. Volg hiervoor [https://touchstone.aegis.net/touchstone/userguide/html/test-systems/creating.html de stappen in de Touchstone-handleiding].
<section end="Testsysteem aanmaken"/>
<section begin="Uitvoeren van testen"/>
===Uitvoeren van testen===

Leveranciers kunnen zelfstandig de scripts die Nictiz publiceert uitvoeren en de resultaten bekijken. Hoe dit moet, [https://touchstone.aegis.net/touchstone/userguide/html/executing-tests/test-setup.html wordt uitgelegd in de Touchstone-documentatie].
<section end="Uitvoeren van testen"/>
<section begin="Tokens"/>
===Mock-authenticatie met vaste tokens===
De authenticatie-stap is geen onderdeel van de Touchstone-test. Authenticatie van de FHIR-requests via een Bearer-token wordt op Touchstone nagebootst door het gebruik van vaste, niet-verlopende tokens.

Het gebruik hiervan verschilt per rol die wil testen of kwalificeren:
* Voor clients die getest worden, is er per testpatiënt uit het scenario [https://github.com/Nictiz/Nictiz-testscripts/blob/main/Configuration/QualificationTokens.json een Bearer-token gedefinieerd]. De client dient deze tokens te gebruiken in elke request naar Touchstone/WildFHIR.
* Bij servers die getest worden, wordt er tijdens het aanmaken van de test gevraagd om een Bearer-token voor elke testpatiënt. Touchstone zal deze tokens gebruiken in de requests naar de server die getest wordt. Standaard zijn hier [https://github.com/Nictiz/Nictiz-testscripts/blob/main/Configuration/QualificationTokens.json de zelfde tokens] ingevuld die ook voor client-testen gebruikt worden, het staat gebruikers vrij om deze tokens over te nemen.<br />'''Let op''': De tokens moeten gedefinieerd worden als <q>Bearer<spatie>[token]</q>, bijvoorbeeld <q>Bearer 0aed465d-aab0-4417-9b3c-e6f635892fea</q> (zonder aanhalingstekens).
[[Bestand:TouchstoneEnterToken.png|link=]]
<section end="Tokens"/>
<section begin="Aandachtspunten"/>

===Aandachtspunten===
====USER_KEY en ORG_KEY weghalen in tickets====
Bij het aanmaken van een ticket over Touchstone is het vaak zinvol om een deel van de (request)code mee te sturen ter verheldering van het probleem. Als deze vraag op een openbaar platform wordt gesteld (bv. een openbaar BITS/Jira-project) is het van belang dat de USER_KEYs en ORG_KEYs in deze transactie worden verwijderd (voor het opslaan van de tekst!). Deze keys zijn namelijk gebruiker/organisatie-specifiek en mogen niet voor derden zichtbaar zijn. Mocht dit toch gebeuren, laat het ons dan direct weten in het ticket. Het ticket zal dan worden verwijderd, met evt. een nieuwe clone waar de keys niet instaan zodat de vraag wel behandeld kan worden.

====Volgorde van tests====

Het kwalificatiescript vraagt om een vaste volgorde voor het sturen van requests, waar de informatiestandaard mogelijk meer ruimte laat om dit ook in een andere volgorde te doorlopen. Het is daarom van belang om bij het uitvoeren van testen op de kwalificatiesimulator de interacties uit te voeren in dezelfde volgorde waarin ze worden gevraagd in de testscripts.
====Ophalen van references====

Antwoorden uit de kwalificatiesimulator bevatten soms references naar extra informatie. Een voorbeeld uit de BGZ: <code><reference value="Practitioner/medmij-bgz-practitioner-ts-02"/></code>

Deze references zijn los op te halen bij de kwalificatiesimulator, maar omdat er een bepaalde volgorde van interacties wordt gevraagd, kan het tussendoor ophalen van references ervoor zorgen dat een test faalt. We raden in dat geval aan om:
De references pas op te halen als de test op de kwalificatiesimulator is afgelopen. Het ophalen van references zal er dan niet meer voor zorgen dat testen falen.

Indien dat niet mogelijk is:

Testen 2 keer uit te voeren:
* De test één keer uit te voeren zonder het ophalen van references. Het doel hierbij is om aan te tonen dat de applicatie de juiste interacties kan versturen die worden gevraagd in het testscript.
* De test een tweede keer uit te voeren, maar dan zonder dat hiervoor een testexecutie is gestart op de kwalificatiesimulator. Tijdens deze test kunnen dan wel alle references tussendoor worden opgehaald. Het doel van deze test is om aan te tonen dat de applicatie goed om kan goed met de inhoud verstuurd tijdens de test, inclusief de los op te halen references.

====Infrastructuur====

Bij het gebruik van Touchstone willen we de volgende punten onder de aandacht brengen:
* Touchstone maakt geen gebruik van tweezijdige TLS-authenticatie.

====Vragen over uitvoer van testscript====

Indien er vragen zijn over uitgevoerde testen is het voor ons van belang om gericht te kunnen terugvinden welke interacties er uitgewisseld zijn. Bij contact hierover vragen wij daarom om (indien mogelijk) een testexecutie uit te voeren op de kwalificatiesimulator. Stuur bij vragen daarover altijd de link mee naar de uitgevoerde testexecutie uit de History op Touchstone.

Een voorbeeld in schermprints:

Klikken naar History in Touchstone:

[[Bestand:Touchstone_history.png|link= |250px|Touchstone history.png]]

Ophalen van de link van de testexecutie uit de History:

[[Bestand:Touchstone_history_link_20210318.png|link= |750px|Touchstone_history_link.png]]

De link van de testexecutie ziet er dan bijvoorbeeld zo uit: <code><nowiki>https://touchstone.aegis.net/touchstone/execution?exec=201904050520537715673006</nowiki></code>
<section end="Aandachtspunten"/>
<section begin="Variabele T datum"/>

===Variabele T datum===
Test- en kwalificatiescenario's werken vaak met relatieve datums, die ervoor zorgen dat scenario's niet gedateerd raken. Een datum 'volgende week' blijft zodoende altijd in de toekomst. Om dit te vertalen naar concrete datums die gebruikt worden tijdens het testen en kwalificeren wordt gewerkt met de zogenaamde T-datum. De betekenis van deze T-datum en waar een deelnemer rekening mee moet houden bij het gebruik hiervan verschilt per rol. Voor iedere rol volgt hierna verdere uitleg.
====Server: beschikbaarstellen (serve) en client: sturen (send)====
Leveranciers die de inhoudelijke gegevens van test- en kwalificatiescenario's in hun bronsysteem invoeren ter voorbereiding op de Touchstone-tests voor beschikbaarstellen (serve) of sturen (send), bepalen een T-datum die zij hanteren bij het invoeren van alle gegevens. 

Wanneer de bepaalde T-datum bijvoorbeeld '2022-01-01' is en de kwalificatiescripts spreken van 'T + 400D', berekent de leverancier de datum die 400 dagen ná de bepaalde T-datum ligt. Die datum wordt vervolgens in het bronsysteem ingevoerd bij het betreffende veld – in dit voorbeeld dus '2023-02-05'.

Mogelijke eenheden die gebruik worden bij het verrekenen van de T-datum zijn 'D' (dagen), 'M' (maanden) en 'Y' (jaren).

Wanneer er datums gebruikt worden in de testscenario's, die invloed hebben op de Touchstone-scripts, bijvoorbeeld in de zoekparameters van het scenario "Persoon 1 vraagt alle meetwaarden op in een periode ('T – 30D t/m T')",  wordt ook bij het uitvoeren van het betreffende TouchStone-script gevraagd de bepaalde T-datum in te voeren. Touchstone berekent vervolgens zelf de exact benodigde datums. Als de T-datum van het Touchstone-script overeenkomt met die van de ingevoerde gegevens, worden de gevraagde resources opgeleverd.

De verwachting is dat een leverancier de gebruikte T-datum vermeldt bij het aanleveren van de materialen en dat deze datum correspondeert met de aangeleverde screenshots en Touchstone-testexecutie(s).

====Server: ontvangen (receive) en client: ophalen (retrieve)====
Leveranciers die gegevens ophalen of ontvangen tijdens het gebruik van Touchstone, ontvangen testberichten van WildFHIR. Elke maandag worden de gegevens op WildFHIR ververst, waarbij alle datums opnieuw worden berekend met de datum van die maandag als referentie.

Als een client gegevens ophaalt in de week van '2022-08-01', zal, indien het kwalificatiescript spreekt van een veld met als datum 'T + 400D', er een resource opgehaald worden waarin dat betreffende veld gevuld is met de datum '2023-09-05'.

Wanneer er datums gebruikt worden in de testscenario's, die invloed hebben op de Touchstone-scripts, bijvoorbeeld in de zoekparameters van het scenario "Persoon 1 vraagt alle meetwaarden op in een periode ('T – 30D t/m T')", wordt ook bij het uitvoeren van het betreffende Touchstone-script gevraagd de T-datum in te voeren. Hier dient dus de datum van de maandag uit de testweek te worden ingevuld. Touchstone berekent vervolgens zelf de exact benodigde datums. Als de T-datum van het Touchstone-script overeenkomt met de datum die gebruikt is tijdens het verversen van WildFHIR, worden de gevraagde resources opgeleverd.

De verwachting is dat een client tijdens kwalificatie in screenshots datums laat zien die corresponderen met gegevens die opgehaald zijn tijdens de aangeleverde Touchstone-testexecutie(s).

===Tijdzones===
In de FHIR-datatypes {{datatype|dateTime}} (indien uren en minuten worden gebruikt) en {{datatype|instant}} is het verplicht om een tijdzone in te vullen. De tijdzone kan daarom niet worden weglaten uit de testgegevens. Touchstone heeft helaas de beperking dat de Nederlandse tijdzone niet berekend kan worden aan de hand van de T-datum. De tijdzone die nu in onze testgegevens staat is daarom de Nederlandse tijdzone bij de eerste keer invullen van dit scenario met concrete datums. Dit komt niet per definitie overeen met de geldende tijdzone in Nederland voor de (in een testexecutie gebruikte, uiteindelijke) datum. In productie moet gerekend worden op een juiste tijdzone en het is dan ook juist om deze tijdzone gewoon te interpreteren, dit betekent dat de gegevens mogelijk soms een uur later of vroeger zijn dan in het addendum staat. Dit is geen reden voor afkeuren tijdens kwalificatie.
<section end="Variabele T datum"/>