1.5.0Twiin Implementatiewijzer Zorgtoepassingen
BgZ: PvE Notified Pull-eisen
Eisencatalogus
De volledige, doorzoekbare en filterbare eisen staan in de Eisencatalogus.
De eisen van communicatiepatroon Notified Pull die benodigd voor deze toepassing staan hier genoemd. Waar aanvullende afspraken zijn gemaakt, vind je deze bij ‘Implicatie bij toepassing’ of is er een afgeleide van de basiseis aangemaakt. Toelichting over de opgenomen attributen is te vinden onder 1.3 | Schrijfwijze van objecten.
Communicatiepatroon: Notified Pull
| TW-P-NP-001 |
Aanbieden notificatie-endpoint |
| Legacy code |
BgZ-2a-TANP-01 |
| Status |
Normatief |
| Omschrijving |
De GTK Ontvanger MOET een notificatie-endpoint aanbieden aan de GTK Verzender. |
| Toelichting |
Een endpoint kan worden gedeeld door meerdere Twiin Deelnemers (bijv. een endpoint per GTK/ SaaS-dienst) of er kan sprake zijn van een endpoint per Twiin Deelnemer. |
| Vereiste |
MOET |
| Rol |
GTK |
| Patroon |
Notified Pull |
| Actor |
GTK Ontvanger |
| Toepassing |
BgZ Correspondentie |
| Referenties |
10.3.1 | TTA FHIR - Notified pull |
| Toetsingscategorie |
Via Twiin |
| Toetsingsvorm |
Technisch |
| Niveau |
Generiek |
| TW-P-NP-002 |
Aanbieden resource-endpoint |
| Legacy code |
BgZ-2a-TANP-02 |
| Status |
Normatief |
| Omschrijving |
De GTK Verzender MOET een resource-endpoint aanbieden aan GTK Ontvanger. |
| Toelichting |
Een endpoint kan worden gedeeld door meerdere Twiin Deelnemers (bijv. een endpoint per GTK/ SaaS-dienst) of er kan sprake zijn van een endpoint per Twiin Deelnemer. |
| Vereiste |
MOET |
| Rol |
GTK |
| Patroon |
Notified Pull |
| Actor |
GTK Verzender |
| Toepassing |
BgZ Correspondentie |
| Referenties |
10.3.1 | TTA FHIR - Notified pull |
| Toetsingscategorie |
Via Twiin |
| Toetsingsvorm |
Technisch |
| Niveau |
Generiek |
| TW-P-NP-003 |
Aanbieden token-endpoint |
| Legacy code |
BgZ-2a-TANP-03 |
| Status |
Normatief |
| Omschrijving |
De GTK Verzender en de GTK Ontvanger MOETEN een token-endpoint aan elkaar aanbieden. |
| Toelichting |
Een endpoint kan worden gedeeld door meerdere Twiin Deelnemers (bijv. een endpoint per GTK/ SaaS-dienst) of er kan sprake zijn van een endpoint per Twiin Deelnemer. |
| Vereiste |
MOET |
| Rol |
GTK |
| Patroon |
Notified Pull |
| Actor |
GTK Ontvanger GTK Verzender |
| Toepassing |
BgZ Correspondentie |
| Referenties |
10.3.1 | TTA FHIR - Notified pull |
| Toetsingscategorie |
Via Twiin |
| Toetsingsvorm |
Technisch |
| Niveau |
Generiek |
| TW-P-NP-004 |
Aanmaken authorization_base |
| Legacy code |
BgZ-2a-AA-06 |
| Status |
Normatief |
| Omschrijving |
De GTK Verzender MOET een digitale representatie van de in de context van een verwijzing veronderstelde toestemming aan kunnen maken (authorization_base). |
| Toelichting |
Omdat de authorization_base alleen door GTK Verzender wordt verwerkt, worden de vorm en inhoud ervan bepaald door GTK Verzender. GTK Ontvanger mag niet afhankelijk zijn van het formaat of de inhoud van authorization_base. De vorm en inhoud van de authorization_base is (nog) niet gebonden aan normatieve eisen. Het bepalen van vorm en inhoud doet GTK Verzender bij voorkeur in afstemming met de gebruikte infrastructuur. |
| Vereiste |
MOET |
| Rol |
GTK |
| Patroon |
Notified Pull |
| Actor |
GTK Verzender |
| Toepassing |
BgZ Correspondentie |
| Referenties |
Twiin-07 | Token Request | Authorization base |
| Toetsingscategorie |
Via Twiin |
| Toetsingsvorm |
Technisch |
| Niveau |
Generiek |
| TW-P-NP-005 |
Aanmaken autorization_grant |
| Legacy code |
BgZ-2a-AA-07 / BgZ-2a-AA-12 |
| Status |
Normatief |
| Omschrijving |
De GTK Verzender en GTK Ontvanger MOET een authorization_grant aan kunnen maken die voldoet aan de specificaties. |
| Vereiste |
MOET |
| Rol |
GTK |
| Patroon |
Notified Pull |
| Actor |
GTK Ontvanger GTK Verzender |
| Toepassing |
BgZ Correspondentie |
| Referenties |
10.4.2 | TTA FHIR - Authorization |
| Toetsingscategorie |
Via Twiin |
| Toetsingsvorm |
Technisch |
| Niveau |
Generiek |
| TW-P-NP-006 |
Aanmaken access token request voor notification-endpoint |
| Legacy code |
BgZ-2a-AA-08 |
| Status |
Normatief |
| Omschrijving |
De GTK Verzender MOET conform de specificaties een accestoken-request voor toegang tot het notificatie-endpoint aan kunnen maken en aan GTK Ontvanger versturen. |
| Vereiste |
MOET |
| Rol |
GTK |
| Patroon |
Notified Pull |
| Actor |
GTK Verzender |
| Toepassing |
BgZ Correspondentie |
| Referenties |
Twiin-07 | Token Request | Access token request |
| Toetsingscategorie |
Via Twiin |
| Toetsingsvorm |
Technisch |
| Niveau |
Generiek |
| TW-P-NP-007 |
Gelijke waardes in authentication_grant en access token request |
| Legacy code |
BgZ-2a-AA-09 |
| Status |
Normatief |
| Omschrijving |
De GTK Verzender en GTK Ontvanger MOETEN ervoor zorgen dat het veld sub in de authentication_grant en het veld client_id in het access token request dezelfde waarde bevatten. |
| Vereiste |
MOET |
| Rol |
GTK |
| Patroon |
Notified Pull |
| Actor |
GTK Ontvanger GTK Verzender |
| Toepassing |
BgZ Correspondentie |
| Referenties |
Twiin-07 | Token Request |
| Toetsingscategorie |
Via Twiin |
| Toetsingsvorm |
Technisch |
| Niveau |
Generiek |
| TW-P-NP-008 |
Afhandelen access token request voor notification server endpoint |
| Legacy code |
BgZ-2a-AA-10 |
| Status |
Normatief |
| Omschrijving |
De GTK Ontvanger MOET in staat zijn om conform de specificaties een accestoken-request van GTK Verzender voor toegang tot het notificatie server endpoint af te handelen. |
| Vereiste |
MOET |
| Rol |
GTK |
| Patroon |
Notified Pull |
| Actor |
GTK Ontvanger |
| Toepassing |
BgZ Correspondentie |
| Referenties |
Twiin-07 | Token Request |
| Toetsingscategorie |
Via Twiin |
| Toetsingsvorm |
Technisch |
| Niveau |
Generiek |
| TW-P-NP-009 |
Controleren autorization_base |
| Legacy code |
BgZ-1-authz-03 |
| Status |
Normatief |
| Omschrijving |
De GTK Verzender MOET controleren of de grondslag (authorization_base) waarmee de GTK Ontvanger een verzoek doet daadwerkelijk is uitgegeven (aan de GTK Ontvanger). |
| Toelichting |
Wanneer de grondslag niet meekomt in de uitwisseling, is er geen sprake van het notified pull communicatiepatroon en dient de GTK Ontvanger op basis van de in de autorisatierichtlijn beschreven rollen het verzoek te autoriseren. |
| Vereiste |
MOET |
| Implicatie bij toepassing |
Voor de zorgtoepassing BgZ betreft dit de Autorisatierichtlijn Basisgegevensset Zorg |
| Rol |
GTK |
| Patroon |
Notified Pull |
| Actor |
GTK Verzender |
| Toepassing |
BgZ Correspondentie |
| Referenties |
10.4.2 | TTA FHIR - Authorization 10.5.5 | Twiin-05 | Retrieve Resource |
| Toetsingscategorie |
Via Twiin |
| Toetsingsvorm |
Technisch |
| Niveau |
Generiek |
| TW-P-NP-010 |
Aanmaken Workflow-Taks |
| Legacy code |
BgZ-2b-trans-01 |
| Status |
Normatief |
| Omschrijving |
De GTK Verzender MOET een Workflow-Task aan kunnen maken indien verzender geen Workflow-Task stuurt als payload van de Notification-Task. |
| Vereiste |
MOET |
| Rol |
GTK |
| Patroon |
Notified Pull |
| Actor |
GTK Verzender |
| Toepassing |
BgZ Correspondentie |
| Referenties |
10.3.1.1 Notified Pull - Data interactions |
| Toetsingscategorie |
Via Twiin |
| Toetsingsvorm |
Technisch |
| Niveau |
Generiek |
| TW-P-NP-011 |
Versturen notificatie-create-request |
| Legacy code |
BgZ-2b-trans-02 |
| Status |
Normatief |
| Omschrijving |
GTK Verzender MOET een notificatie-create-request kunnen versturen. |
| Vereiste |
MOET |
| Rol |
GTK |
| Patroon |
Notified Pull |
| Actor |
GTK Verzender |
| Toepassing |
BgZ Correspondentie |
| Referenties |
10.5.1 | Twiin-01 | Send Notification Task 10.3.1.1 Notified Pull - Data interactions |
| Toetsingscategorie |
Via Twiin |
| Toetsingsvorm |
Technisch |
| Niveau |
Generiek |
| TW-P-NP-012 |
Afhandelen notificatie-create-request |
| Legacy code |
BgZ-2b-trans-03 |
| Status |
Normatief |
| Omschrijving |
De GTK Ontvanger MOET een binnenkomend notificatie-create-request kunnen afhandelen en een passende response te versturen. |
| Vereiste |
MOET |
| Rol |
GTK |
| Patroon |
Notified Pull |
| Actor |
GTK Ontvanger |
| Toepassing |
BgZ Correspondentie |
| Referenties |
10.5.1 | Twiin-01 | Send Notification Task 10.3.1.1 Notified Pull - Data interactions |
| Toetsingscategorie |
Via Twiin |
| Toetsingsvorm |
Technisch |
| Niveau |
Generiek |
| TW-P-NP-013 |
Versturen notificatie-create-request bij updates |
| Legacy code |
BgZ-2b-trans-04 |
| Status |
Normatief |
| Omschrijving |
De GTK Verzender MOET een notificatie-create-request kunnen versturen wanneer de dataset van de verwijzing is geüpdatet. |
| Vereiste |
MOET |
| Rol |
GTK |
| Patroon |
Notified Pull |
| Actor |
GTK Verzender |
| Toepassing |
BgZ Correspondentie |
| Referenties |
10.5.1 | Twiin-01 | Send Notification Task 10.3.1.1 Notified Pull - Data interactions |
| Toetsingscategorie |
Via Twiin |
| Toetsingsvorm |
Technisch |
| Niveau |
Generiek |
| TW-P-NP-014 |
Afhandelen notificatie-create-request bij updates |
| Legacy code |
BgZ-2b-trans-05 |
| Status |
Normatief |
| Omschrijving |
De GTK Ontvanger MOET in staat zijn om een naar aanleiding van een geüpdatete dataset binnenkomend notificatie-create-request af te kunnen handelen en een passende response te versturen. |
| Vereiste |
MOET |
| Rol |
GTK |
| Patroon |
Notified Pull |
| Actor |
GTK Ontvanger |
| Toepassing |
BgZ Correspondentie |
| Referenties |
10.5.1 | Twiin-01 | Send Notification Task 10.3.1.1 Notified Pull - Data interactions |
| Toetsingscategorie |
Via Twiin |
| Toetsingsvorm |
Technisch |
| Niveau |
Generiek |
| TW-P-NP-015 |
Versturen annulering |
| Legacy code |
BgZ-2b-trans-06 |
| Status |
Normatief |
| Omschrijving |
De GTK Verzender MAG een notificatie-update-request versturen wanneer GTK Verzender de notificatie wil annuleren of intrekken. |
| Vereiste |
MAG |
| Rol |
GTK |
| Patroon |
Notified Pull |
| Actor |
GTK Verzender |
| Toepassing |
BgZ Correspondentie |
| Referenties |
10.5.2 | Twiin-02 | Cancel Notification Task 10.3.1.1 Notified Pull - Data interactions |
| Toetsingscategorie |
Via Twiin |
| Toetsingsvorm |
Technisch |
| Niveau |
Generiek |
| TW-P-NP-016 |
Afhandeling annulering |
| Legacy code |
BgZ-2b-trans-07 |
| Status |
Normatief |
| Omschrijving |
GTK Ontvanger MOET een binnenkomend notificatie-update-request kunnen afhandelen en een passende response versturen. |
| Vereiste |
MOET |
| Rol |
GTK |
| Patroon |
Notified Pull |
| Actor |
GTK Ontvanger |
| Toepassing |
BgZ Correspondentie |
| Referenties |
10.5.2 | Twiin-02 | Cancel Notification Task 10.3.1.1 Notified Pull - Data interactions |
| Toetsingscategorie |
Via Twiin |
| Toetsingsvorm |
Technisch |
| Niveau |
Generiek |
| TW-P-NP-017 |
Uitvoeren read-operaties |
| Legacy code |
BgZ-2b-trans-08.read |
| Status |
Normatief |
| Omschrijving |
De GTK Ontvanger MOET een read-operaties uit de notificatie-taak uit kunnen voeren op het resource-endpoint van GTK Verzender. |
| Toelichting |
De read-operaties zijn opgenomen in de notificatie-task onder Task.input:read-available-resources. |
| Vereiste |
MOET |
| Rol |
GTK |
| Patroon |
Notified Pull |
| Actor |
GTK Ontvanger |
| Toepassing |
BgZ Correspondentie |
| Referenties |
10.5.5 | Twiin-05 | Retrieve Resource 10.3.1.1 Notified Pull - Data interactions |
| Toetsingscategorie |
Via Twiin |
| Toetsingsvorm |
Technisch |
| Niveau |
Generiek |
| TW-P-NP-018 |
Afhandelen read-requests |
| Legacy code |
BgZ-2b-trans-09.read |
| Status |
Normatief |
| Omschrijving |
GTK Verzender MOET een binnenkomende read-requests af kunnen handelen en een passende response versturen. |
| Vereiste |
MOET |
| Rol |
GTK |
| Patroon |
Notified Pull |
| Actor |
GTK Verzender |
| Toepassing |
BgZ Correspondentie |
| Referenties |
10.5.5 | Twiin-05 | Retrieve Resource 10.3.1.1 Notified Pull - Data interactions |
| Toetsingscategorie |
Via Twiin |
| Toetsingsvorm |
Technisch |
| Niveau |
Generiek |
| TW-P-NP-019 |
Uitvoeren search-operaties resource-endpoint |
| Legacy code |
BgZ-2b-trans-08.search |
| Status |
Normatief |
| Omschrijving |
GTK Ontvanger MOET search-operaties uit de notificatie-taak uit kunnen voeren op het resource-endpoint van GTK Verzender. |
| Toelichting |
De search-operaties zijn opgenomen in de notificatie-task onder Task.input:query-available-resources. |
| Vereiste |
MOET |
| Rol |
GTK |
| Patroon |
Notified Pull |
| Actor |
GTK Ontvanger |
| Toepassing |
BgZ Correspondentie |
| Referenties |
10.3.1.1 Notified Pull - Data interactions |
| Toetsingscategorie |
Via Twiin |
| Toetsingsvorm |
Technisch |
| Niveau |
Generiek |
| TW-P-NP-020 |
Afhandelen search-requests resource-endpoint |
| Legacy code |
BgZ-2b-trans-09.search |
| Status |
Normatief |
| Omschrijving |
GTK Verzender MOET binnenkomende search-requests af kunnen handelen en een passende response versturen. |
| Vereiste |
MOET |
| Rol |
GTK |
| Patroon |
Notified Pull |
| Actor |
GTK Verzender |
| Toepassing |
BgZ Correspondentie |
| Referenties |
10.3.1.1 Notified Pull - Data interactions |
| Toetsingscategorie |
Via Twiin |
| Toetsingsvorm |
Technisch |
| Niveau |
Generiek |
| TW-P-NP-021 |
Uitvoeren read-operatie ophalen workflow-task |
| Legacy code |
BgZ-2b-trans-10 |
| Status |
Normatief |
| Omschrijving |
De GTK Ontvanger MOET een read-operatie voor het ophalen van de Workflow-task uit kunnen voeren op het resource-endpoint van GTK Verzender. |
| Toelichting |
De indicator voor de aanwezigheid van een workflow-task is opgenomen in de notificatie-task onder Task.input:get-worflow-task.valueBoolean (waarde is true). |
| Vereiste |
MOET |
| Rol |
GTK |
| Patroon |
Notified Pull |
| Actor |
GTK Ontvanger |
| Toepassing |
BgZ Correspondentie |
| Referenties |
10.5.3 | Twiin-03 | Get Workflow Task 10.3.1.1 Notified Pull - Data interactions |
| Toetsingscategorie |
Via Twiin |
| Toetsingsvorm |
Technisch |
| Niveau |
Generiek |
| TW-P-NP-022 |
Afhandelen read-operatie workflow-task |
| Legacy code |
BgZ-2b-trans-11 |
| Status |
Normatief |
| Omschrijving |
De GTK Verzender MOET een binnenkomende read-request op de workflow-task af kunnen handelen en een passende response versturen. |
| Vereiste |
MOET |
| Rol |
GTK |
| Patroon |
Notified Pull |
| Actor |
GTK Verzender |
| Toepassing |
BgZ Correspondentie |
| Referenties |
10.3.1.1 Notified Pull - Data interactions |
| Toetsingscategorie |
Via Twiin |
| Toetsingsvorm |
Technisch |
| Niveau |
Generiek |
| TW-P-NP-023 |
Uitvoeren read-operatie uit workflow-task |
| Legacy code |
BgZ-2b-trans-12.read |
| Status |
Normatief |
| Omschrijving |
GTK Ontvanger MOET read-operaties uit de workflow-taak uit kunnen voeren op het resource-endpoint van GTK Verzender. |
| Toelichting |
De read-operaties zijn opgenomen in de workflow-task onder Task.input:read-available-resources. |
| Vereiste |
MOET |
| Rol |
GTK |
| Patroon |
Notified Pull |
| Actor |
GTK Ontvanger |
| Toepassing |
BgZ Correspondentie |
| Referenties |
10.5.5 | Twiin-05 | Retrieve Resource 10.3.1.1 Notified Pull - Data interactions |
| Toetsingscategorie |
Via Twiin |
| Toetsingsvorm |
Technisch |
| Niveau |
Generiek |
| TW-P-NP-024 |
Afhandelen read-request |
| Legacy code |
BgZ-2b-trans-13.read |
| Status |
Normatief |
| Omschrijving |
GTK Verzender MOET binnenkomende read-requests af kunnen handelen en een passende response versturen. |
| Vereiste |
MOET |
| Rol |
GTK |
| Patroon |
Notified Pull |
| Actor |
GTK Verzender |
| Toepassing |
BgZ Correspondentie |
| Referenties |
10.5.5 | Twiin-05 | Retrieve Resource 10.3.1.1 Notified Pull - Data interactions |
| Toetsingscategorie |
Via Twiin |
| Toetsingsvorm |
Technisch |
| Niveau |
Generiek |
| TW-P-NP-025 |
Uitvoeren search-operaties op resource-endpoint |
| Legacy code |
BgZ-2b-trans-12.search |
| Status |
Normatief |
| Omschrijving |
GTK Ontvanger MOET search-operaties uit de workflow-taak uit kunnen voeren op het resource-endpoint van GTK Verzender. |
| Toelichting |
De search-operaties zijn opgenomen in de workflow-task onder Task.input:query-available-resources. |
| Vereiste |
MOET |
| Rol |
GTK |
| Patroon |
Notified Pull |
| Actor |
GTK Ontvanger |
| Toepassing |
BgZ Correspondentie |
| Referenties |
10.3.1.1 Notified Pull - Data interactions |
| Toetsingscategorie |
Via Twiin |
| Toetsingsvorm |
Technisch |
| Niveau |
Generiek |
| TW-P-NP-026 |
Afhandelen search-operaties op resource-endpoint |
| Legacy code |
BgZ-2b-trans-13.search |
| Status |
Normatief |
| Omschrijving |
GTK Verzender MOET binnenkomende search-requests af kunnen handelen en een passende response versturen. |
| Vereiste |
MOET |
| Rol |
GTK |
| Patroon |
Notified Pull |
| Actor |
GTK Verzender |
| Toepassing |
BgZ Correspondentie |
| Referenties |
10.3.1.1 Notified Pull - Data interactions |
| Toetsingscategorie |
Via Twiin |
| Toetsingsvorm |
Technisch |
| Niveau |
Generiek |