Abonneren
- Dennis de Gouw
VERSIE: 19-05-2023 STATUS: definitief
Incrementele implementatie
Het iWlz-netwerkmodel wordt incrementeel geïmplementeerd aan de hand van het afsprakenstelsel iWlz-netwerkmodel. Het eerste deel dat wordt geïmplementeerd is het Indicatieregister, voor deze implementatiestap is de dienst Abonneren deels van toepassing.
De dienst Abonneren wordt in de eerste implementatiestap deels ingevoerd. De operationeel netwerkbeheerder VECOZO maakt namens bronhouder CIZ in deze eerste fase de abonnementen aan voor de afnemers (zorgkantoren). Het is in deze eerst implementatiestap voor zorgkantoren nog niet mogelijk om zelf een abonnementsverzoek naar bronhouder CIZ te sturen.
De inhoud van dit artikel is derhalve niet van toepassing op deze implementatiestap.
Inleiding
Dit artikel beschrijft de dienst Abonneren. Deze dienst wordt door bronhouders aangeboden aan (toekomstige) afnemers.
1 Abonnementen binnen de iWlz
Voor het kunnen versturen van een notificatie aan een deelnemer is het nodig om abonnementen te faciliteren. Een abonnement beschrijft wat de reden is voor een notificatie, welke nieuwe gegevens of welke (combinatie van) wijzigingen er toeleiden dat er een notificatie moet worden verstuurd. de trigger. Elke abonnement bevat één specifieke trigger. Zo kan een deelnemer zich abonneren op een trigger en ontvangt daarmee een notificatie wanneer de trigger geactiveerd wordt.
In de iWlz worden alleen abonnementen beschreven die een bronhouder MOET implementeren en aanbieden. Of een deelnemer een abonnement heeft op een bepaald abonnement hangt af van de abonnementsvorm.
Het staat een bronhouder en deelnemer vrij om buiten de afgesproken iWlz-abonnementen een willekeurig abonnement af te spreken en te faciliteren. Deze ‘ongereguleerde’ abonnementen worden verder niet besproken, maar passen in hetzelfde principe van het iWlz-vrijwillige abonnement.
2 iWlz-abonnementsvormen
Er zijn twee iWlz-abonnementsvormen, voor elk type notificatie één. Het onderscheid zit in de noodzaak dat een deelnemer een bepaalde notificatie ontvangt. Voor de iWlz-verplichte abonnementen krijgt de deelnemer altijd een notificatie, voor de iWlz-vrijwillige abonnementen geldt dat als de deelnemer een bepaalde notificatie wenst te ontvangen, het aan de deelnemer is om een abonnement te nemen.
Abonnementsvorm | Deelnemer abonnement | Abonneren door | Voor type notificatie |
iWlz-verplicht | Verplicht | Bronhouder voor deelnemer | Noodzakelijke |
iWlz-vrijwillig | Vrijwillig | Deelnemer zelf | Vrijwillige |
Wanneer een deelnemer van een gebeurtenis op de hoogte gesteld moet worden, bijvoorbeeld in het geval dat er een nieuwe indicatie is, dan plaatst de bronhouder voor de deelnemer het abonnement zodat gegarandeerd kan worden dat de deelnemer genotificeerd zal worden. De bronhouder is verantwoordelijk voor het plaatsen van het abonnement.
N.B. Het uitwerken van de verschillen tussen de verplichte en vrijwillige abonnementsvormen is nog onderwerp van discussie. Deze worden in een volgende versie van het afsprakenstelsel worden deze nader uitgewerkt.
3 Vastleggen en raadplegen abonnementen
De verschillende typen abonnementen die een organisatie aanbiedt worden gepubliceerd in de Service Directory. De overige netwerkdeelnemers kunnen vervolgens de Service Directory raadplegen om te ontdekken welke abonnementen een organisatie aanbiedt en welk type door de twee bronhouders worden aangeboden (minimaal de hierboven beschreven iWlz-abonnementen).
# | Beschrijving | Toelichting |
1 | publiceer abonnementtype | registreer de gegevens van het abonnementtype in de servicedirectory |
2 | response | verwerk response |
3 | raadpleeg abonnementtypen | raadpleeg de servicedirectory op de beschikbare abonnementtypen |
4 | informatie | beoordeel de informatie over het abonnementtype |
4 Inhoud abonnementtype
Bij het vastleggen van een abonnementtype in de service directory worden de volgende gegevens geregistreerd:
Gegeven | Beschrijving |
organisatieID | Identificatie van de partij die het abonnement verstrekt in het netwerk |
abonnementTypeID | Identificatie van het abonnement type |
abonnementVorm | Aanduiding van de abonnementsvorm |
abonnementOmschrijving | Beschrijving van het abonnement |
idTypeAbonnee | Aanduiding van het type Id dat moet worden meegegeven bij het afsluiten van het abonnement. Een abonnement kan werken op basis van meerdere idTypeAbonnee’s |
eventType | Aanduiding welke register event de notificatie veroorzaakt |
eventTriggerOmschrijving | Beschrijving van de trigger die de notificatie veroorzaakt |
objectIDType | Beschrijving welke ObjectID wordt teruggeven in de notificatie, voor gebruik als juiste ID in de GraphQL query |
4.1 Voorbeeld abonnementtype-specificatie
Het voorbeeld beschrijft de json-string voor het verplichte abonnement van een zorgkantoor, dat een zorgaanbieder notificeert op een nieuwe bemiddeling wanneer de betreffende zorgaanbieder de of een van de bemiddelde aanbieders is.
{
"organisatieID": "89e0e41a-13df-4fe2-ad72-d9c32ca5641c",
"abonnementTypeID": "NIEUWE_BEMIDDELING_VOOR_ZORGAANBIEDER",
"abonnementVorm": "IWLZ_VERPLICHT",
"abonnementOmschrijving": "Elke nieuw betrokken bemiddelde aanbieder ontvangt hiervan een notificatie",
"iDTypeAbonnee": "AgbCode",
"eventType": "CREATE",
"eventTriggerOmschrijving": "Bij elke registratie in BemiddeldeInstelling van een zorgaanbieder ontvangt die aanbieder met die AgbCode een notificatie",
"objectIDType": "bemiddeldeInstellingId"
}5 Afhandelen abonnemensttypen
De twee abonnementstypen worden verschillend afgehandeld. Voor het abonnementstype iWlz-vrijwillig moet de deelnemer het abonnement voor zichzelf plaatsen bij de bronhouder, de aanbieder van het abonnement. Voor het abonnementstype iWlz-verplicht zijn er twee mogelijkheden. Een waarbij de bronhouder vergelijkbaar aan de wijze waarop de deelnemer bij het iWlz-vrijwillige abonnement een abonnement plaatst, maar dan namens de deelnemer of een variant waarbij er geen sprake is van een abonnement. Uiteindelijk zal er één variant worden geïmplementeerd.
5.1 Afhandelen iWlz-Vrijwillig abonnementstype
Het abonneren van een deelnemer voor een iWlz-vrijwillig abonnement is een handeling van de deelnemer zelf. De deelnemer mag zelf bepalen of een abonnement wenselijk is en om een notificatie te ontvangen. De deelnemer mag zich abonneren op een iWlz-Vrijwillig abonnement mits is voldaan aan de eisen van het abonnement en bijvoorbeeld het bezit van een geldige AgbCode. het identificatie kenmerk past binnen de toegestane van de deelnemer voldoet aan de set aan idTypeAbonnee’s voor dat abonnement.
# | Beschrijving | Toelichting |
1 | abonnement verzoek | Stel een abonnementsverzoek op |
2 | verstuur verzoek | Dien een abonnementsverzoek in |
3 | valideer verzoek | Bepaal of de deelnemer abonnee mag worden op het betreffende abonnement |
4 | verstuur verzoek | verstuur het verzoek verder |
5 | registreer abonnement | registreer het abonnement en genereer {abonnementID} voor abonnee |
6 | response {abonnementID} | retourneer het {abonnementID} |
7 | response {abonnementID} | retourneer het {abonnementID} |
8 | response {abonnementID} | retourneer het {abonnementID} |
9 | register {abonnementID} | registreer het {abonnementID} |
ALT | ongeldig verzoek | Deelnemer is niet gerechtigd voor een abonnement |
10 | response ongeldig verzoek | retourneer ongeldig verzoek |
11 | response ongeldig verzoek | ontvang ongeldig verzoek terug |
Alleen bij het abonneren van een deelnemer zelf ontvangt de deelnemer daar een abonnementID voor terug. Met dit ID kan de deelnemer zelf het abonnement opzeggen.
5.2. Afhandelen iWlz-Verplicht abonnementstype
Voor het afhandelen van de iWlz-verplichte abonnementen zijn er twee mogelijkheden. Een met abonnementenregistratie en een zonder.
5.2.1. Afhandelen iWlz-verplicht abonnement MET abonnement registratie
Het abonneren van een deelnemer voor een iWlz-verplicht abonnement is een handeling van de bronhouder, omdat de verantwoordelijkheid van het notificeren bij de bronhouder ligt. De bronhouder doet dit volgens een vaste afspraak.
Bronhouder | Deelnemer | Basis voor abonneren |
CIZ | Zorgkantoor | Postcode regio tabel |
Zorgkantoor | Zorgaanbieder | Actieve AgbCode volgens de iWlz AGBcode tabel |
Zorgkantoor | Zorgkantoor | Zorgkantoorcode |
# | Beschrijving | Toelichting |
1 | nieuwe deelnemer | nieuwe deelnemer treedt toe aan iWlz-netwerk |
2 | plaats verplicht abonnement voor deelnemer | Voor elke (nieuwe) deelnemer maakt de bronhouder een abonnement aan voor de iWlz-verplichte abonnementen die bij de rol van die deelnemer horen. |
Bijvoorbeeld wanneer er een nieuw gecontracteerde iWlz zorgaanbieder is, abonneert het zorgkantoor met wie het contract is afgesloten die zorgaanbieder op de iWlz-Verplichte abonnementen voor zorgaaanbieders.
5.2.2. Afhandelen iWlz-verplicht abonnementstype ZONDER abonnement registratie
De bronhouder is verantwoordelijk voor het verzenden van de notificatie bij een iWlz-verplicht abonnementstype. Bij elk abonnementstype is beschreven welke registratie de grondslag voor notificatie is en aan welke deelnemer. Een bronhouder kan op basis daarvan bepalen wanneer en aan wie de notificatie gestuurd moet worden zonder dat die deelnemer een abonnement heeft.
Door het ontbreken van een abonnementsregistratie moet de bronhouder voor elke deelnemer die nog niet eerder is genotificeerd het organisatieID van die deelnemer opzoeken in het Adresboek.
# | Beschrijving | Toelichting |
0 | lookup abonnee | Na een notificatie trigger moet de abonnee opgezocht worden |
1 | lookup {organisatieID} deelnemer | Het gaat om een verplicht abonnement, waardoor de trigger een functionele organisatieID bevat, bijvoorbeeld de Agbcode van een zorgaanbieder. Voor het kunnen opstellen van de notificatie moet het NetwerkID worden opgezocht voor het kunnen bepalen van het Endpoint van de deelnemer. |
2 | lookup {organisatieID} deelnemer | Netwerkpunt zet verzoek door |
3 | response {organisatieID} | Adresboek retourneert het ID van de deelnemer |
4 | response {organisatieID} | netwerkpunt zet response door naar backoffice voor het opstellen van de notificatie. |
5.3 Inhoud plaatsen abonnement
De inhoud voor het plaatsen van een abonnement, abonneren, is gelijk voor het plaatsen van een iWlz-verplicht abonnement met abonnement registratie door de bronhouder en het plaatsten van een iWlz-vrijwillig abonnement door de deelnemer.
Bij het abonneren van een deelnemer moeten de volgende gegevens worden aangeboden:
Gegeven | Beschrijving |
organisatieID | Netwerkidentificatie van de abonnerende partij, identificerend voor het kunnen afleveren van de notificatie. |
abonnementTypeID | Identificatie van het abonnement waarop deelnemer wil abonneren of geabonneerd moet worden. |
iDTypeAbonnee | Aanduiding van het type Id dat moet worden meegegeven bij het afsluiten van het abonnement |
idAbonnee | Daadwerkelijk identificatie conform bij idType geselecteerd id type |
5.3.1 Voorbeeld abonneren
Voor het abonneren van een zorgaanbieder op het iWlz-verplicht abonnement ‘Nieuwe bemiddeling voor zorgaanbieder’ moet het volgende worden aangeboden:
{
"organisatieID": "c40b3669-1b06-4c99-8c84-f4fac1264b39",
"abonnementTypeID": "NIEUWE_BEMIDDELING_VOOR_ZORGAANBIEDER",
"iDTypeAbonnee": "AgbCode",
"iDAbonnee": "12341234"
}response:
{
"abonnementID": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
6 Verwijderen abonnement
6.1 Verwijderen abonnement iWlz-verplicht abonnement
Alleen bij de variant dat de bronhouder voor iWlz-verplichte abonnementtype en abonnement registratie gebruikt is het nodig dat de bronhouder het abonnement ook verwijdert van een deelnemer wanneer de partij geen deelnemer meer is van de iWlz of een andere rol heeft. Dit is bijvoorbeeld in het geval dat een zorgaanbieder geen iWlz zorgaanbieder meer is en de zorgaanbieder niet meer op de hoogte gebracht hoeft te worden.
# | Beschrijving | Toelichting |
1 | deelnemer verliest toegang | Een deelnemer kan de grondslag voor een iWlz verplicht abonnement verliezen. Bijvoorbeeld als de deelnemer geen iWlz zorgaanbieder meer is. |
2 | verwijder abonnement van deelnemer | De bronhouder verwijderd alle abonnementen op notificaties voor de deelnemer uit d abonnementenregistratie |
6.2 Verwijderen abonnement iWlz-vrijwillig abonnement
Wanneer een deelnemer bij een iWlz-vrijwillig abonnement ervoor kiest geen notificaties meer te ontvangen naar aanleiding van dat abonnement, kan de deelnemer zelf het abonnement opzeggen door het te verwijderen bij de bronhouder.
# | Beschrijving | Toelichting |
1 | abonnement verwijder verzoek {abonnementID} | Deelnemer stuurt verzoek om te verwijderen in voor het betreffende iWlz-vrijwillig abonnement |
2 | verstuur verzoek {abonnementID} |
|
3 | verstuur verzoek |
|
4 | valideer verzoek | bepaal of verzoek voor verwijderen afkomstig is van juiste deelnemer |
5 | response {204} | abonnement is verwijderd, opdracht uitgevoerd |
6 | response {204} |
|
7 | response {204} |
|
ALT | Ongeldig abonnements verzoek |
|
8 | ongeldig verzoek | verzoek afkomstig van onjuiste deelnemer |
9 | ongeldig verzoek |
|
10 | ongeldig verzoek |
|
7 Huidige iWlz-abonnementtypen
Momenteel zijn er twee registers in ontwikkeling, het Indicatieregister van het CIZ en het Bemiddelingsregister van de zorgkantoren.
Er zijn op dit moment voor de deelnemers voor het Indicatieregister en het Bemiddelingsregister de volgende iWlz-abonnementen gespecificeerd:
# | Trigger | Bronhouder | Deelnemer | Abo-vorm |
1 | De registratie van een nieuwe indicatie | CIZ | zorgkantoor | iWlz-verplicht |
2 | Een wijziging van een bestaande indicatie | CIZ | zorgkantoor | iWlz-verplicht |
3 | De registratie van een nieuwe ZorgInNatura | zorgkantoor | zorgaanbieder | iWlz-verplicht |
4 | Een wijziging van een bestaande ZorgInNatura | zorgkantoor | zorgaanbieder | iWlz-verplicht |
5 | Gewijzigde bemiddeling t.g.v nieuwe of gewijzigde ZorgInNatura ander betrokken zorgaanbieder | zorgkantoor | Overig betrokken zorgaanbieder | iWlz-vrijwillig |
6 | Gewijzigde Dossierhouder of CZT | zorgkantoor | alle betrokken zorgaanbieders | iWlz-vrijwillig |
7 | Dossieroverdracht cliënt | zorgkantoor | zorgkantoor | iWlz-verplicht |
In de toekomst kan het zijn dat er van iWlz-verplichte abonnementen een iWlz-vrijwillige variant bijkomt voor een andere type deelnemer. Het iWlz-verplichte abonnement “Wijziging van een nieuwe indicatie” voor het zorgkantoor, kan voor een zorgaanbieder een iWlz-vrijwillige variant worden.
Er zullen er nieuwe iWlz-abonnementen worden toegevoegd bij het ontwerp en ontwikkeling van nieuwe registers.