Versie	Datum	Omschrijving
v6.10.0.0	12-okt-2011	Nieuw document na herstructurering van AORTA-documentatie.
v6.10.0.0	12-okt-2011	RfC 35188: Versturen van een gebeurtenis-signaal bij aanmelden en heraanmelden toegevoegd.
v6.10.0.0	12-okt-2011	RfC 45521: Heraanmelden op vertrouwensniveau laag
v6.10.0.0	12-okt-2011	RfC 36012: Synchronisatie GBZ en VWI
v6.10.0.0	12-okt-2011	RfC 45917: Blokkering toevoegen nieuwe BSN’s (Moratorium)
v6.10.0.0	12-okt-2011	RfC 34734 : Onrechtmatig verzoek tot heraanmelding
v6.10.0.0	12-okt-2011	RfC 46035: opt-in voor beschikbaar maken en opvragen van gegevens via AORTA
V6.10.0.0	12-okt-2011	RfC 34778: Aanpassen Applicatie-id bij heraanmelden
V6.10.0.0	12-okt-2011	RfC 46629: Opnemen Einde geldigheidsduur GBZ in de documentatie.
V6.10.0.0	12-okt-2011	RfC 46606: Logica voor vulling Bijwerktijd in GBZ en bijwerktijd in VWI verduidelijken.
V6.11.0.0	5-dec-2012	Herpublicatie als onderdeel van AORTA-Infrastructuur v6·11.

2 Kaders en uitgangspunten

2.1 Externe normen en kaders

Er zijn geen specifieke kaders en normen van toepassing op de VWI buiten de genoemde kaders en normen in het document.

2.2 Relatie met AORTA-principes en –beslissingen

De AORTA-principes en –beslissingen zijn beschreven in Hoofdstuk 3 van de [Arch AORTA].

3 Context van Verwijsindex

Een zorgverlener houdt de door hem gegenereerde patiëntgegevens bij in zijn eigen zorgsysteem. Deze patiëntgegevens worden voor andere zorgverleners beschikbaar gemaakt door het mogelijk te maken om het systeem van de zorgverlener te bevragen over bepaalde patiëntgegevens. Om voor een zorgverlener inzichtelijk te maken welke gegevens waar op te vragen zijn, is er een database nodig met metagegevens aangaande de zorggegevens in de diverse zorgsystemen van de aangesloten zorgverleners. AORTA maakt hiervoor gebruik van een verwijsindex.

De Verwijsindex (VWI) houdt per patiënt bij in welke bij de ZIM aangesloten zorgsystemen patiëntgegevens aanwezig zijn. Deze gegevens moeten overigens eerst bij de VWI worden aangemeld voordat ze geraadpleegd kunnen worden. De VWI houdt geen medische informatie bij, deze blijft in het aangesloten zorgsysteem.

Het aanmelden van patiëntgegevens leidt tot een nieuwe verwijzing in de VWI. Deze verwijzing bevat metagegevens over de informatie die in het systeem van de aanmeldende zorgverlener aanwezig is (bijvoorbeeld patiënt-id en gegevenssoort).

Een zorgverlener kan een verwijzing actueel houden met een heraanmelding. Een afmelding van patiëntgegevens heeft verwijdering van een verwijzing tot gevolg.

Om de hierboven beschreven functionaliteit te kunnen bieden, zijn er verschillende services en functies opgenomen in de VWI. Voor elke service in de VWI wordt een interface geïmplementeerd, waardoor de service kan worden aangesproken door een systeemrol.

Diagram LSP.VWI.d2010 – interacties met de ZIM

De applicatiecomponent VWI ondersteunt de volgende services die kunnen worden aangesproken door externe systemen:

· Toevoegen van een verwijzing;

· Bijwerken van een verwijzing;

· Verwijderen van een verwijzing;

· Opvragen van verwijzingen;

· Opvragen van verwijzingen met beheerder;

· Opvragen van eigen verwijzingen.

Naast de services voor externe systemen ondersteunt de VWI de volgende functies voor interne applicatiecomponenten in de ZIM:

· Verwijderen vewijzingen zonder opt-in;

· Opvragen van verwijzingen;

· Zoek gegevenssoort bij interactie;

· Signaleren eerste aanmelding;

· Signaleren verwijdering indexgegevens.

De samenhang tussen alle componenten is weergegeven in LSP.VWI.d2010. Deze services en functies worden uitgebreid beschreven in Hoofdstuk 5.

De services Toevoegen, Bijwerken en het Verwijderen van een verwijzing worden aangesproken door het Verwijsindex Bewerkend Systeem. De service Opvragen van verwijzingen wordt aangesproken door het Verwijsindex Raadplegend Systeem. De eisen die gelden voor beide systeemrollen worden beschreven in respectievelijk [PvE GBx Rollen] Hoofdstuk 4.2 en [PvE GBx Rollen] Hoofdstuk 4.1.

De ZIM biedt voor elk van de genoemde systemen een interface met een specifieke functie in de VWI. Voor de systeemrol VerwijsindexBewerkendSysteem zijn de volgende interfaces toegekend:

LSP.VWI.i1010: Aanmelden gegevens;
LSP.VWI.i1020: Heraanmelden gegevens;
LSP.VWI.i1030: Afmelden gegevens.

De ZIM biedt specifiek voor het opvragen van patiëntgegevens de volgende interfaces:

LSP.VWI.i1040: Opvragen index;
LSP.VWI.i1050: Opvragen index met gegevensbeheerder;
LSP.VWI.i1060: Opvragen eigen verwijzingen.

Daarnaast zijn twee automatische notificaties gerelateerd aan het gebruik van de VWI.

GBX.VWI.i1010: Signalering eerste aanmelding;
GBX.VWI.i1020: Signalering verwijderde indexgegevens.

Voor de LSP-beheerder is er een specifieke interface:

· Eindgebruikersinterface beheerder.

De interfaces worden beschreven in Hoofdstuk 4.

Naast externe bevragingen is het ook mogelijk dat VWI-functies intern worden geactiveerd door andere componenten binnen de ZIM. Interne interfaces vallen buiten scope van dit document. De te leveren functionaliteit wordt wel opgenomen in Hoofdstuk 5.2.

4 Interfaces (koppelvlakken)

In dit hoofdstuk worden zowel de systeeminterfaces als de eindgebruikersinterfaces beschreven, die de VWI beschikbaar stelt voor externe systemen.

4.1 Systeeminterfaces

In Tabel LSP.VWI.t2010 en Tabel LSP.VWI.t2020 wordt per systeemrol aangegeven met welke berichten en via welke interface de systeemrol kan communiceren met een VWI-service. De interacties worden weergegeven in de eerste kolom.

Tabel LSP.VWI.t2010 : Interactie tussen VWI Bewerkend Systeem en Functies

Logisch bericht	Interface	VWI Functie
aanmeldenGegevens-bericht bevestigingsbericht	Aanmelden gegevens LSP.VWI.i1010	Toevoegen van een verwijzing
heraanmeldenGegevens-bericht bevestigingsbericht	Heraanmelden gegevens LSP.VWI.i1020	Bijwerken van een verwijzing
afmeldenGegevens-bericht bevestigingsbericht	Afmelden gegevens LSP.VWI.i1030	Verwijderen van een verwijzing

Tabel LSP.VWI.t2020 : Interactie tussen VWI Raadplegend Systeem en Functies

Logisch bericht	Interface	VWI Functie
opvragenIndex-bericht opleverenIndex-bericht	Opvragen index LSP.VWI.i1040	Opvragen van verwijzingen
opvragenIndexMetGegevensbeheerder-bericht opleverenIndex opvragenIndexMetGegevensbeheerder -bericht	Opvragen index met gegevensbeheerder LSP.VWI.i1050	Opvragen van verwijzing met beheerder
opvragenEigenVerwijzingen-bericht opleverenEigenVerwijzingen-bericht	Opvragen eigen verwijzingen LSP.VWI.i1060	Opvragen van eigen verwijzingen

De interfaces moeten de berichten die naar de VWI worden gestuurd verwerken. Verschillende attributen in de berichten zijn daarom verplicht of worden aangemerkt als optioneel. In de volgende paragrafen volgt per logisch bericht een beschrijving van de verplichte of optionele attributen. Het verplichte of optionele karakter van een attribuut wordt weergegeven door middel van kardinaliteiten.

In de volgende paragrafen worden de interfaces besproken die de VWI beschikbaar stelt voor externe systemen. Voor iedere interface wordt in een sequentiediagram de volgorde van boodschappen tussen de systeemrol en de VWI en tussen de VWI en andere componenten in de ZIM weergegeven. De ZIM orchestratieservice en de handelingen die worden uitgevoerd door de ZIM orchestratieservice, zoals berichtcontroles en eindafhandeling (beantwoorden en loggen), worden beschreven in AORTA.ZIM.d1050 [Arch AORTA].

4.1.1 Systeeminterface 1 – LSP.VWI.i1010 : Aanmelden gegevens

Voor het aanmelden van gegevens wordt het aanmeldenGegevens-bericht verstuurd door het Verwijsindex Bewerkend Systeem, zoals weergegeven in LSP.VWI.d2020. De attributen die zijn opgenomen in het bericht zijn vermeld in LSP.VWI.t2030. Dit bericht wordt afgehandeld door de interface Aanmelden gegevens. De ZIM orchestratieservice ontvangt het bericht, doet de standaard berichtcontroles (AORTA.ZIM.d1050 [Arch AORTA]) en zet het bericht door naar de VWI.

In het applicatieregister (APR) houdt de ZIM van elke aangesloten XIS-applicatie bij wat de aanmeldbevoegdheid van de applicatie is. Voordat een verwijzing wordt toegevoegd bevraagd de VWI de APR voor deze aanmeldbevoegdheid.

Afhankelijk van de status van de aanmeldbevoegdheid zorgt de service Toevoegen van een verwijzing binnen de VWI ervoor dat er een verwijzing wordt toegevoegd aan de VWI. Na het toevoegen van een verwijzing wordt de gebeurtenisverdeler (GVE) op de hoogte gesteld van de aanmelding. De service Toevoegen van een verwijzing wordt uitgewerkt in Hoofdstuk 5.1.1.

Diagram LSP.VWI.d2020 – Afhandelen van interface Aanmelden gegevens

De VWI stuurt vervolgens een bevestigingsbericht terug naar de ZIM orchestratieservice. Van hieruit wordt er een bevestigingsbericht opgesteld ter attentie van het Verwijsindex Bewerkend Systeem en het proces wordt gelogd. Het bevestigingsbericht zal een bevestiging of een foutmelding bevatten.

Tabel LSP.VWI.t2030 - aanmeldenGegevens-bericht

Systeeminterface 1 – uitgaand bericht
Attribuut	Definitie	Herkomst	Additionele informatie
Patiëntgegevens-id/ patiëntstuk-id (1)		Zie Hoofdstuk 6.1	De unieke identificatie van een categorie van patiëntgegevens (categoriaal) of patiëntstuk (atomair).
Patiënt-id (1)		Zie Hoofdstuk 6.1
Beheerverantwoordelijke (1): - Zorgaanbieder-id (1) - Zorgverlener-id (1) - Zorgverlener-functie (1) - Applicatie-id (1)		Zie Hoofdstuk 6.1	De zorgverlener-id en de zorgverlener-functie worden toegevoegd, omdat een opleverbericht in versie 6 deze verplicht stelt.
Gegevenssoort (1)		Zie Hoofdstuk 6.1
Actualiteit (0..1) - Aanmaaktijd in GBZ (0..1) - Bijwerktijd in GBZ (0..1) - Einde geldigheid GBZ (0..1)		Zie Hoofdstuk 6.1
Inhoudverantwoordelijke(1): - Zorgaanbieder-id (1) - Zorgverlener-id (1) - Zorgverlener-functie (1)		Zie Hoofdstuk 6.1
Patiëntstuk-type(1)		Zie Hoofdstuk 6.1	Zoals gespecificeerd door de betreffende zorgtoepassing.

4.1.2 Systeeminterface 2 – LSP.VWI.i1020 : Heraanmelden gegevens

Voor het heraanmelden van gegevens wordt het heraanmeldenGegevens-bericht verstuurd door het Verwijsindex Bewerkend Systeem, zoals weergegeven in LSP.VWI.d2030. De attributen die zijn opgenomen in het bericht zijn vermeld in LSP.VWI.t2040. Dit bericht wordt afgehandeld door de interface Heraanmelden gegevens. De ZIM orchestratieservice ontvangt het bericht, doet de standaard berichtcontroles (AORTA.ZIM.d1050 [Arch AORTA]) en zet het bericht door naar de VWI.

Vervolgens zorgt de service Bijwerken van een verwijzing binnen de VWI ervoor dat een bestaande verwijzing in de VWI wordt bijgewerkt. Na het bijwerken wordt de GVE op de hoogte gesteld van de heraanmelding. De service Bijwerken van een verwijzing wordt uitgewerkt in Hoofdstuk 5.1.2.

Diagram LSP.VWI.d2030 – Afhandelen van interface Heraanmelden gegevens

Tabel LSP.VWI.t2040 - heraanmeldenGegevens-bericht

Systeeminterface 2 – uitgaand bericht
Attribuut	Definitie	Herkomst	Additionele informatie
Patiëntgegevens-id/ patiëntstuk-id (1)		Zie Hoofdstuk 6.1	De unieke identificatie van een categorie van patiëntgegevens (categoriaal) of patiëntstuk (atomair).
Patiënt-id (1)		Zie Hoofdstuk 6.1
Beheerverantwoordelijke (1): - Zorgaanbieder-id (1) - Zorgverlener-id (1) - Zorgverlener-functie (1) - Applicatie-id (1)		Zie Hoofdstuk 6.1
Gegevenssoort (1)		Zie Hoofdstuk 6.1
Actualiteit (0..1) - Aanmaaktijd in GBZ (0..1) - Bijwerktijd in GBZ (0..1) - Einde geldigheid GBZ (0..1)		Zie Hoofdstuk 6.1	Wanneer het de versie van het heraanmeldenGegevens-bericht speciaal voor vertrouwensniveau laag betreft, is het attribuut Bijwerktijd in GBZ verplicht. De kardinaliteit is dan (1).
Inhoudverantwoordelijke (1): - Zorgaanbieder-id (1) - Zorgverlener-id (1) - Zorgverlener-functie (1)		Zie Hoofdstuk 6.1	De gegevens van de inhoudverantwoordelijke zal niet worden overschreven in de VWI, ongeacht de inhoud.
Patiëntstuk-type(1)		Zie Hoofdstuk 6.1	Zoals gespecificeerd door de betreffende zorgtoepassing.

4.1.3 Systeeminterface 3 – LSP.VWI.i1030 : Afmelden gegevens

Voor het verwijderen van een verwijzing wordt het afmeldenGegevens-bericht verstuurd door het Verwijsindex Bewerkend Systeem, zoals weergegeven in LSP.VWI.d2040. De attributen die zijn opgenomen in het bericht zijn vermeld in LSP.VWI.t2050. Dit bericht wordt afgehandeld door de interface Afmelding gegevens. De ZIM orchestratieservice ontvangt het bericht, doet de standaard berichtcontroles (AORTA.ZIM.d1050 [Arch AORTA]) en zet het bericht door naar de VWI. Vervolgens zorgt de service Verwijderen van een verwijzing binnen de VWI ervoor dat een bestaande verwijzing in de VWI wordt verwijderd. Na het verwijderen wordt de GVE op de hoogte gesteld van de verwijdering. De service Verwijderen van een verwijzing wordt uitgewerkt in Hoofdstuk 5.1.3.

Diagram LSP.VWI.d2040 – Afhandelen van interface Verwijderen van een verwijzing

Tabel LSP.VWI.t2050 – afmeldenGegevens-bericht

Systeeminterface 2 – uitgaand bericht
Attribuut	Definitie	Herkomst	Additionele informatie
Patiëntgegevens-id/ patiëntstuk-id (1)		Zie Hoofdstuk 6.1	De unieke identificatie van een categorie van patiëntgegevens (categoriaal) of patiëntstuk (atomair).
Patiënt-id (1)		Zie Hoofdstuk 6.1
Gegevenssoort (1)		Zie Hoofdstuk 6.1
Patiëntstuk-type(1)		Zie Hoofdstuk 6.1

4.1.4 Systeeminterface 4 – LSP.VWI.i1040 : Opvragen index

Voor het opvragen van indexgegevens wordt het opvragenIndex-bericht verstuurd door het Verwijsindex Raadplegend Systeem, zoals weergegeven in LSP.VWI.d2050. De attributen die zijn opgenomen in het bericht zijn vermeld in LSP.VWI.t2060. Dit bericht wordt afgehandeld door de interface Opvragen index. De ZIM orchestratieservice ontvangt het bericht, doet de standaard berichtcontroles (AORTA.ZIM.d1050 [Arch AORTA]) en zet het bericht door naar de VWI. Vervolgens zorgt de service Opvragen van verwijzingen binnen de VWI ervoor dat de juiste verwijzingen worden gevonden in de VWI. De service Opvragen van verwijzingen wordt uitgewerkt in Hoofdstuk 5.1.4.

Het autorisatieprotocol wordt aangesproken om de autorisaties op te vragen van de zorgverlener die de opvraag initieert. Vervolgens dient gecontroleerd te worden of de gevonden indexgegevens in de VWI ook daadwerkelijk verstuurd mogen worden.

Diagram LSP.VWI.d2050 – Afhandelen van interface Opvragen van verwijzingen

De VWI stuurt vervolgens een opleverenIndex-bericht terug naar de ZIM orchestratieservice met de indexgegevens waar de zorgverlener voor geautoriseerd is. Van hieruit wordt er een opleverenIndex-bericht opgesteld ter attentie van het Verwijsindex Bewerkend Systeem en het proces wordt gelogd. LSP.VWI.t2070 geeft de opgenomen attributen in het opleverenIndex-bericht weer.

In het opvraagbericht is een voorkomen van tenminste een patiëntgegevens-id/patiëntstuk-id, patiënt-id of applicatie-id verplicht.

Tabel LSP.VWI.t2060 - OpvragenIndex-bericht

Systeeminterface 2 – uitgaand bericht
Attribuut	Definitie	Herkomst	Additionele informatie
Patiëntgegevens-id/ patiëntstuk-id (0..n)		Zie Hoofdstuk 6.1	De unieke identificatie van een categorie van patiëntgegevens (categoriaal) of patiëntstuk (atomair).
Patiënt-id (0..1)		Zie Hoofdstuk 6.1
Gegevenssoort (0..*)		Zie Hoofdstuk 6.1
Actualiteit(0..1)		Zie Hoofdstuk 6.1
Inhoudverantwoordelijke(0..1): - Zorgverlener-functie (0..1) - Zorgverlener-id (0..1)		Zie Hoofdstuk 6.1

Tabel LSP.VWI.t2070 – opleverenIndex-bericht

Systeeminterface 2 – antwoordbericht

Attribuut

Definitie

Herkomst

Additionele informatie

Verwijzing (1..n):

- Patiëntgegevens-id/patiëntstuk-id (1)

- Patiënt-id (1)

- Inhoudsverantwoordelijke(0..1)

- Gegevenssoort (1)

- Actualiteit (0..1)

- Aanmaaktijd in GBZ (0..1)

- Bijwerktijd in GBZ (0..1)

- Patiëntstuk-type(1)

Zie Hoofdstuk 6.1

4.1.5 Systeeminterface 5 – LSP.VWI.i1050 : Opvragen index met gegevensbeheerder

Voor het opvragen van indexgegevens met gegevensbeheerder wordt het opvragenIndexMetGegevensbeheerder-bericht verstuurd door het Verwijsindex Raadplegend Systeem, zoals weergegeven in LSP.VWI.d2060. De attributen die zijn opgenomen in het bericht zijn vermeld in LSP.VWI.t2080. Dit bericht wordt afgehandeld door de interface Opvragen index met gegevensbeheerder. De ZIM orchestratieservice ontvangt het bericht, doet de standaard berichtcontroles (AORTA.ZIM.d1050 [Arch AORTA]) en zet het bericht door naar de VWI. Vervolgens zorgt de service Opvragen van verwijzingen binnen de VWI ervoor dat de juiste verwijzingen worden gevonden in de VWI. De service Opvragen van verwijzingen met beheerder wordt uitgewerkt in paragraaf5.1.5.

Diagram LSP.VWI.d2060 – Afhandelen van interface Opvragen van verwijzingen met gegevensbeheerder

De VWI stuurt vervolgens een opleverenIndexMet Gegevensbeheerder-bericht terug naar de ZIM orchestratieservice met de indexgegevens waar de zorgverlener voor geautoriseerd is. Van hieruit wordt er een opleverenIndexMetGegevensbeheerder-bericht opgesteld ter attentie van het Verwijsindex Bewerkend Systeem en het proces wordt gelogd. LSP.VWI.t2090 geeft de opgenomen attributen in het opleverenIndexMetGegevensbeheerder-bericht weer.

In het opvraagbericht is een voorkomen van tenminste een patiëntgegevens-id of patiënt-id verplicht.

Tabel LSP.VWI.t2080 - OpvragenIndexMetGegevensbeheerder-bericht

Systeeminterface 2 – uitgaand bericht
Attribuut	Definitie	Herkomst	Additionele informatie
Patiëntgegevens-id/patiëntstuk-id (0..n)		Zie Hoofdstuk 6.1	De unieke identificatie van een categorie van patiëntgegevens (categoriaal) of patiëntstuk (atomair).
Patiënt-id (0..1)		Zie Hoofdstuk 6.1
Gegevenssoort (0..n)		Zie Hoofdstuk 6.1
Actualiteit (0..1)		Zie Hoofdstuk 6.1
Beheerverantwoordelijke (0..1): - Zorgaanbieder-id (0..1) - Applicatie-id (0..1)		Zie Hoofdstuk 6.1
Inhoudverantwoordelijke (0..n): - Zorgverlener-id (0..1) - Zorgverlener-functie(0..1)		Zie Hoofdstuk 6.1

Tabel LSP.VWI.t2090 – opleverenIndexMetGegevensbeheerder-bericht

Systeeminterface 2 – antwoordbericht

Attribuut

Definitie

Herkomst

Additionele informatie

Verwijzing (1..n):

- Patiëntgegevens-id (1)

- Patiënt-id (1)

- Beheerverantwoordelijke(1)

- Zorgaanbieder-id(1)

- Zorgaanbieder-naam(0..1)

- Zorgaanbieder-adres(0..1)

- Applicatie-id(1)

- Zorgverlener-naam(0..1)

- Zorgverlener-id (1)

- Zorgverlenerfunctie (1)

- Inhoudverantwoordelijke(1)

- Zorgaanbieder-id

- Zorgverlener-id

- Zorgverlenerfunctie

- Gegevenssoort (1)

- Actualiteit (1)

- Patiëntstuk-type(1)

Zie Hoofdstuk 6.1

Let op: de vulling van dit attribuut verschilt per versie van het bericht.

4.1.6 Systeeminterface 6 – LSP.VWI.i1060 : Opvragen eigen verwijzingen

Voor het opvragen van eigen verwijzingen in de VWI wordt het opvragenEigenVerwijzingen-bericht verstuurd door het Verwijsindex Raadplegend Systeem, zoals weergegeven in LSP.VWI.d2055. De attributen die zijn opgenomen in het bericht zijn vermeld in LSP.VWI.t2093. Dit bericht wordt afgehandeld door de interface Opvragen eigen verwijzingen. De ZIM orchestratieservice ontvangt het bericht, doet de standaard berichtcontroles (AORTA.ZIM.d1050 [Arch AORTA]) en zet het bericht door naar de VWI. Vervolgens zorgt de service Opvragen eigen verwijzingen binnen de VWI ervoor dat de juiste verwijzingen worden gevonden in de VWI. De service Opvragen eigen verwijzingen wordt uitgewerkt in paragraaf 5.1.6 .

Diagram LSP.VWI.d2055 – Afhandelen van interface Opvragen eigen verwijzingen

De VWI stuurt vervolgens een opleverenEigenGegevens-bericht terug naar de ZIM orchestratieservice met de indexgegevens. Van hieruit wordt er een opleverenEigenVerwijzingen-bericht opgesteld ter attentie van het Verwijsindex Bewerkend Systeem en het proces wordt gelogd. LSP.VWI.t2095 geeft de opgenomen attributen in het opleverenEigenGegevens-bericht weer.

Tabel LSP.VWI.t2093 - opvragenEigenVerwijzingen-bericht

Systeeminterface 2 – uitgaand bericht
Attribuut	Definitie	Herkomst	Additionele informatie
Patiëntgegevens-id/patiëntstuk-id (0..n)		Zie Hoofdstuk 6.1	De unieke identificatie van een categorie van patiëntgegevens (categoriaal) of patiëntstuk (atomair).
Patiënt-id (0..1)		Zie Hoofdstuk 6.1
Gegevenssoort (0..n)		Zie Hoofdstuk 6.1
Actualiteit (0..1)		Zie Hoofdstuk 6.1	Let op: dit attribuut wordt niet in iedere versie van het bericht toegestaan.
Aanmaaktijd in GBZ (0..1): - Start (0..1) - Eind (0..1)	Opgeleverde gegevens moeten een aanmaaktijd in GBZ hebben binnen de opgegeven periode (Start – Eind).	Zie Hoofdstuk 6.1	Let op: dit attribuut wordt niet in iedere versie van het bericht toegestaan. Merk op dat de Aanmaaktijd GBZ een optioneel gevuld gegeven bij het aanmelden/ heraanmelden. Als deze parameter wordt gebruikt dan worden gegevens zonder aanmaaktijd niet opgeleverd.
Bijwerktijd in GBZ (0..1): - Start (0..1) - Eind (0..1)	Opgeleverde gegevens moeten een Bijwerktijd in GBZ hebben binnen de opgegeven periode (Start – Eind).	Zie Hoofdstuk 6.1	Let op: dit attribuut wordt niet in iedere versie van het bericht toegestaan..
Aanmaaktijd in VWI (0..1): - Start (0..1) - Eind (0..1)	Opgeleverde gegevens moeten een aanmaaktijd in VWI hebben binnen de opgegeven periode (Start – Eind).	Zie Hoofdstuk 6.1	Let op: dit attribuut wordt niet in iedere versie van het bericht toegestaan.
Bijwerktijd in VWI (0..1): - Start (0..1) - Eind (0..1)	Opgeleverde gegevens moeten een bijwerktijd in VWI hebben binnen de opgegeven periode (Start – Eind).	Zie Hoofdstuk 6.1	Let op: dit attribuut wordt niet in iedere versie van het bericht toegestaan.
Applicatie-id (0..1)		Zie Hoofdstuk 6.1
Beheerverantwoordelijke (0..1): - Zorgaanbieder-id (0..1)		Zie Hoofdstuk 6.1	Let op: dit attribuut wordt niet in iedere versie van het bericht toegestaan.
Inhoudverantwoordelijke (0..n): - Zorgverlener-id (0..1) - Zorgverlener-functie(0..1)		Zie Hoofdstuk 6.1

Tabel LSP.VWI.t2095 – opleverenEigenVerwijzingen-bericht

Systeeminterface 2 – antwoordbericht

Attribuut

Definitie

Herkomst

Additionele informatie

Verwijzing (1..n):

- Patiëntgegevens-id (1)

- Patiënt-id (1)

- Beheerverantwoordelijke(1)

- Zorgaanbieder-id(1)

- Applicatie-id(1)

- Zorgverlener-id (1)

- Zorgverlenerfunctie (1)

- Inhoudverantwoordelijke(1)

- Zorgaanbieder-id

- Zorgverlener-id

- Zorgverlenerfunctie

- Gegevenssoort (1)

- Actualiteit (1)

- Aanmaaktijd in GBZ (0..1)

- Bijwerktijd in GBZ (0..1)

- Actualiteit VWI (1)

- Aanmaaktijd in VWI (1)

- Bijwerktijd in VWI (1)

- Patiëntstuk-type(1)

Zie Hoofdstuk 6.1

Let op: de vulling van dit attribuut verschilt per versie van het bericht.

4.2 Eindgebruikersinterfaces

De VWI stelt naast systeeminterfaces ook eindgebruikersinterfaces ter beschikking. Deze worden vermeld in LSP.VWI.t2100.

Tabel LSP.VWI.t2100 - Eindgebruikersinterfaces

Type gebruikersinterface	Doelgroep (gebruikersrol)	Beschrijving
Beheerderinterface	Beheerder	Verwijderen van verwijzingen zoals vermeld in LSP.VWI.t2150.

5 Services en functies

De VWI stelt services beschikbaar voor externe systemen en functies voor interne componenten in de ZIM. De services en functies worden beschreven in respectievelijk paragraaf 5.1 en 5.2.

Paragraaf 5.3 beschrijft op systematische wijze de beheerfuncties die de VWI beschikbaar stelt.

De activiteitendiagrammen in dit hoofdstuk zijn gebaseerd op de standaard berichtafhandeling zoals beschreven in [PvE GBx Rollen]. In de activiteitendiagrammen wordt op sommige plaatsen verwezen naar de betreffende diagrammen in [Arch AORTA].

5.1 Primaire services

Deze paragraaf beschrijft op systematische wijze de primaire services die de VWI beschikbaar stelt aan de buitenwereld aan de hand van UML activiteitendiagrammen. Het gaat hierbij om de volgende services:

· toevoegen van een verwijzing;

· bijwerken van een verwijzing;

· verwijderen van een verwijzing;

· opvragen van verwijzingen;

· opvragen van verwijzingen met beheerder.

5.1.1 Toevoegen van een verwijzing

Een verwijzing wordt atomair of categoraal aangemeld. Een atomaire aanmelding beslaat een aanmelding van één patiëntstuk. Er ontstaat in de VWI voor elke atomaire aanmelding één verwijzing (patiëntstuk-id). In het geval van een categorale aanmelding wordt een categorie van patiëntstukken (gegevenssoort) aangemeld en krijgen alle patiëntstukken met dezelfde gegevenssoort één gezamenlijke verwijzing in de VWI (patiëntgegevens-id).

Het activiteitendiagram van de service, Toevoegen van een verwijzing, is weergegeven in LSP.VWI.d2060.

De service wordt geactiveerd door het ontvangen van een aanmeldenGegevens-bericht door de ZIM. Dit bericht bevat de attributen zoals beschreven in LSP.VWI.t2030. Het bericht wordt gecontroleerd zoals beschreven in [Arch AORTA], Diagram AORTA.ZIM.d1050.

Voordat een verwijzing in de VWI wordt toegevoegd moet er gecontroleerd worden of het initiërende systeem gekwalificeerd is voor opt-in. In het geval dit niet het geval blijkt te zijn volgens het APR, moet gecontroleerd worden of er een totaal bezwaar geldt. Bij een totaal bezwaar moet de foutmelding “patiënt niet akkoord” worden gegeven. Mocht er geen bezwaar geregistreerd staan moeten de moratoriumregels zoals beschreven in Hoofdstuk 5.1.1.1 worden toegepast.

Indien volgens de moratoriumregels blijkt dat er een aanmelding mag plaatsvinden van de gegevens van de betreffende patiënt moeten er een aantal attributen in het aanmeldenGegevens-bericht gecontroleerd worden. De controles en de foutmeldingen, die worden opgenomen in het bevestigingsbericht, zijn opgenomen in LSP.VWI.t2103.

Tabel LSP.VWI.t2103 – Controles tijdens het aanmelden proces

Attribuut	Foutsituatie	Herstelacties	Foutmelding	Fout-id
Patiëntgegevens-id/Patiëntstuk-id	Er bestaat al een verwijzing in de VWI met het betreffende patiëntgegevens/stuk-id.	-	Bestaat reeds	5n
	Patiënt heeft totaal bezwaar.		Patiënt niet akkoord	4g

Het is van belang om voor de verwijzing een unieke identificatie te gebruiken. De unieke identificatie wordt gevormd door het patiëntgegevens-id, die in het aanmeldenGegevens-bericht is opgenomen. Voordat er dus daadwerkelijk een verwijzing wordt gecreëerd dient er een controle te zijn op het al voorkomen van een verwijzing met het betreffende patiëntgegevens-id. Als dit het geval is, dan wordt er een foutmelding “bestaat reeds” voorbereid en eindigt de activiteitenstroom.

Naast de unieke identificatie is het van belang om te controleren of de initiërende applicatie wel aanmeldbevoegdheid heeft. Deze controle wordt gedaan in het applicatieregister [Ontw APR].

Indien er nog geen verwijzing met het betreffende patiëntgegevens-id bestaat en de initiërende applicatie aanmeldbevoegdheid heeft, wordt er een nieuwe verwijzing gecreëerd. De gebeurtenisverdeler (GVE) wordt door middel van een signaal op de hoogte gebracht van de aanmelding. Het signaal bestaat uit de attributen zoals weergegeven in LSP.VWI.t2105. De afhandeling van het signaal wordt besproken in [Ontw Sgl GBV]. In geval de aanmelding is gebeurd door een systeem die is gekwalificeerd voor opt-in, dan moet ook de opt-in status worden bijgewerkt.

Als de nieuwe verwijzing gecreëerd is wordt er een bevestigingsbericht voorbereid en tevens wordt door de functie signaleren eerste aanmelding, beschreven in Hoofdstuk 5.2.1, een eventuele eerste aanmelding afgehandeld. De activiteitenstroom eindigt hier en het proces wordt verder afgehandeld zoals beschreven in [Arch AORTA], Diagram AORTA.ZIM.d1050.

Tabel LSP.VWI.t2105 – Attributen in gebeurtenis-signaal

Attribuut	Toevoeging
Zorgaanbieder-id	URA
Applicatie-id
Gebeurtenis-type	Wijziging in gegevens
Patiënt-id	BSN
Gegevenssoort
Actualiteit	Aanmaaktijd in VWI

Diagram LSP.VWI.d2060– afhandeling service Toevoegen van een verwijzing

5.1.1.1 Blokkering toevoegen nieuwe BSNs

Vanaf april 2011 is er een tijdelijk moratorium op het aanmelden van nieuwe patiënten in de verwijsindex. De patiëntnummers die toen al bekend waren, staan op een zogenaamde ‘moratoriumlijst’ van bekende BSN’s. De VWI accepteert alleen aanmeldingen van patiëntnummers die op deze moratoriumlijst staan. Voor applicaties die een opt-in registratie voeren, en in het applicatieregister de status ‘aanmeldbevoegd’ hebben gekregen, geldt deze beperking niet.

In de ZIM bevindt zich een schakelaar waarmee het toevoegen van onbekende BSNs geblokkeerd wordt. De status van een BSN, bekend of onbekend, wordt bepaald aan de hand van de moratoriumlijst.

Vanaf het moment dat de blokkering voor het toevoegen van nieuwe patiënten is aangezet, kunnen er alleen nog maar aan-, heraan- en afmeldingen gedaan worden op de BSNs die in de lijst staan. Indien er een aanmelding komt van een BSN die niet op de lijst staat, dan wordt er een foutmelding ERR_ALG gegenereerd met als fouttekst: “Aanmelden voor deze patiënt niet toegestaan”.

Als de blokkering weer wordt opgeheven, dan vervalt de controle of het BSN op de lijst staat.

5.1.2 Bijwerken van een verwijzing

Het activiteitendiagram van de service Bijwerken van een verwijzing, is weergegeven in LSP.VWI.d2070.

De service wordt geactiveerd door het ontvangen van een heraanmeldenGegevens-bericht door de ZIM. Dit bericht bevat de attributen zoals beschreven in LSP.VWI.t2050. Het bericht wordt gecontroleerd zoals beschreven in [Arch AORTA], Diagram AORTA.ZIM.d1050.

Een eerder aangemelde verwijzing kan bijgewerkt worden met de attributen uit een heraanmeldenGegevens-bericht zoals beschreven in LSP.VWI.t2040. Bij een heraanmelding zal één of meerdere van de opgeslagen attributen van de verwijzing mogelijk kunnen veranderen. Welke attributen kunnen worden gewijzigd is afhankelijk van het vertrouwensniveau waaronder het heraanmeldenGegevens-bericht is verstuurd. Met vertrouwensniveau laag is het alleen mogelijk om de actualiteit van de verwijzing in de VWI aan te passen. Met vertrouwensniveau midden zijn de mogelijk te veranderen gegevens beperkt tot de volgende gegevens in de verwijzing:

· Actualiteit;

· Beheerverantwoordelijke:

o Zorgverlender-id;

o Zorgverlener-functie;

· Inhoudverantwoordelijke:

o Zorgverlener-id;

o Zorgverlener-functie;

· Applicatie-id.

Voordat de VWI een wijziging doorvoert, worden er een aantal attributen in het heraanmeldenGegevens-bericht gecontroleerd. De controles en de eventuele foutmeldingen, die onderdeel zijn van het bevestigingsbericht, zijn opgenomen in LSP.VWI.t2110. Bij optionele attributen in het bericht, wordt er alleen een controle uitgevoerd als het attribuut ook daadwerkelijk in het bericht is opgenomen.

Tabel LSP.VWI.t2110 – Controles tijdens het heraanmeld proces

Attribuut	Foutsituatie	Herstelacties	Foutmelding	Fout-id
Patiëntgegevens-id/Patiëntstuk-id	Patiëntgegevens/stuk-id in het bericht moet overeenkomen met de patiëntgegevens-id die is opgenomen in de verwijzing in de VWI.		ZIM kan vermelde patiënt-gegevens-id niet (meer) vinden in VWI.	5g
Patiënt-id	Patiënt-id in het bericht moet overeenkomen met de patiënt-id die is opgenomen in de verwijzing in de VWI.		Patiënt-id correspondeert niet met patiëntgegevens-id	5by
Gegevenssoort	Gegevenssoort in het bericht moet overeenkomen met de gegevenssoort die is opgenomen in de verwijzing in de VWI.		Onjuiste gegevenssoort: %1	5ba
Beheerverantwoordelijke	Zorgaanbieder-id in het bericht moet overeenkomen met de zorgaanbieder-id die is opgenomen in de verwijzing in de VWI.		Niet onder eigen beheer	5v
Bijwerktijd in GBZ	Bijwerktijd in GBZ ligt te ver in de toekomst (groter dan Bijwerktijd in VWI)		De GBZ-bijwerktijd in bericht eerder dan geregistreerde GBZ-bijwerktijd in VWI.	5cb
Actualiteit	Actualiteit is niet valide.		Onjuiste datum is opgegeven	5bl

Na het succesvol doorlopen van de controles moet worden gecontroleerd of eventueel de opt-in status bijgewerkt moet worden. In geval de bij te werken verwijzing niet is aangemeld onder opt-in en het initiërende systeem is inmiddels gekwalificeerd voor opt-in, dan moet de opt-in status worden bijgewerkt.

Uiteindelijk wordt de verwijzing bijgewerkt. De gegevens over de inhoudsverantwoordelijke worden bij een heraanmelding nooit veranderd. De gebeurtenisverdeler (GVE) wordt door middel van een signaal op de hoogte gebracht van de heraanmelding. Het signaal bestaat uit de attributen zoals weergegeven in LSP.VWI.t2105. De afhandeling van het signaal wordt besproken in [Ontw Sgl GBV]. Als laatste stap wordt er een bevestigingsbericht voorbereid.

De activiteitenstroom eindigt hier en het proces wordt verder afgehandeld zoals beschreven in [Arch AORTA], Diagram AORTA.ZIM.d1050.

Diagram LSP.VWI.d2070 – afhandeling service Bijwerken van een verwijzing

5.1.3 Verwijderen van een verwijzing

Het activiteitendiagram van de service, Verwijderen van een verwijzing, is weergegeven in LSP.VWI.d2080.

De service wordt geactiveerd door het ontvangen van een afmeldenGegevens-bericht door de ZIM. Dit bericht bevat de attributen zoals beschreven in LSP.VWI.t2050. Het bericht wordt gecontroleerd zoals beschreven in [Arch AORTA], Diagram AORTA.ZIM.d1050.

Voordat de VWI een verwijzing verwijdert, worden er een aantal attributen in het afmeldenGegevens-bericht gecontroleerd. De controles en de foutmeldingen, die onderdeel zijn van het bevestigingsbericht, zijn opgenomen in LSP.VWI.t2120.

Tabel LSP.VWI.t2120 – Controles tijdens het verwijder proces

Attribuut	Controle	Foutmelding
Patiëntgegevens-id	Patiëntgegevens-id in het bericht moet overeenkomen met de patiëntgegevens-id die is opgenomen in de verwijzing in de VWI.	Bestaat niet
Beheerverantwoordelijke	Zorgaanbieder-id in het bericht moet overeenkomen met de zorgaanbieder-id die is opgenomen in de verwijzing in de VWI.	Niet onder eigen beheer

Na het succesvol doorlopen van de controles wordt de verwijzing verwijderd en wordt er een bevestigingsbericht voorbereid. Vervolgens wordt de gebeurtenisverdeler (GVE) door middel van een signaal op de hoogte gebracht van de verwijdering. Het proces wordt verder afgehandeld zoals beschreven in [Arch AORTA], Diagram AORTA.ZIM.d1050.

Diagram LSP.VWI.d2080 – inhoudelijke afhandeling service Verwijderen van een verwijzing

5.1.4 Opvragen van verwijzingen

Het activiteitendiagram van de service, Opvragen van verwijzingen, is weergegeven in LSP.VWI.d2090.1 .

De service wordt geactiveerd door het ontvangen van een opvragenIndex-bericht door de ZIM. Dit bericht bevat de attributen zoals beschreven in LSP.VWI.t2060.Het bericht wordt gecontroleerd zoals beschreven in [Arch AORTA], Diagram AORTA.ZIM.d1050.

Voordat een verwijzing in de VWI wordt opgevraagd worden er een aantal attributen in het opvragenIndex-bericht gecontroleerd. De controles en de foutmeldingen, die worden opgenomen in het bevestigingsbericht, zijn opgenomen in LSP.VWI.t2121.

Aan de hand van de attributen die worden meegezonden in het bericht worden in de VWI de relevante verwijzingen geselecteerd. Mochten er geen verwijzingen gevonden worden, dan moet er een foutmelding “niks gevonden” worden voorbereid en eindigt het activiteitendiagram voor wat betreft het Opvragen van verwijzingen.

Mocht een opvrager niet geautoriseerd zijn, dan zal er ook geen informatie worden verzonden omtrent de verwijzing. Voor de opvrager lijkt de verwijzing niet te bestaan. In het geval er geen één verwijzing is waar de opvrager voor geautoriseerd is, zal er weer een foutbericht worden voorbereid met de melding “niks gevonden”.

Mocht er voor een opvraagbericht verwijzingen zijn gevonden en de opvrager is volgens het autorisatieprotocol geautoriseerd om de verwijzing(en) te ontvangen, dan zal er een opleverenIndex-bericht worden voorbereid.

De activiteitenstroom eindigt hier en het proces wordt verder afgehandeld zoals beschreven in [Arch AORTA], Diagram AORTA.ZIM.d1050. Dit zal uiteindelijk resulteren in het verzenden van een opleverenIndex-bericht aan de opvrager.

Diagram LSP.VWI.d2090 – inhoudelijke afhandeling service Opvragen van

verwijzingen

5.1.5 Opvragen van verwijzingen met beheerder

Het activiteitendiagram van de service, Opvragen van verwijzingen, is weergegeven in LSP.VWI.d2100.

De service wordt geactiveerd door het ontvangen van een opvragenIndexMetGegevensbeheerder-bericht door de ZIM. Dit bericht bevat de attributen zoals beschreven in LSP.VWI.t2080. Het bericht wordt gecontroleerd zoals beschreven in [Arch AORTA], Diagram AORTA.ZIM.d1050.

Voordat een verwijzing in de VWI wordt opgevraagd worden er een aantal attributen in het opvragenIndexMetGegevensbeheerder-bericht gecontroleerd. De controles en de foutmeldingen, die worden opgenomen in het bevestigingsbericht, zijn opgenomen in LSP.VWI.t2121.

Tabel LSP.VWI.t2121 – Controles tijdens opvragen proces

Attribuut	Controle	Foutmelding
Applicatie-id	Het is mogelijk dat er een applicatie-id aanwezig is in de wrapper en in het bericht zelf. Als deze niet overeenkomen dan volgt er een foutmelding.	VALIDAT “applicatie-id in parameter ongelijk aan applicatie-id afzender”

Aan de hand van de attributen die worden meegezonden in het bericht selecteert de VWI de relevante verwijzingen. Mochten er geen verwijzingen gevonden worden, dan moet er een foutmelding “niks gevonden” (fout-id 5b [Foutentabel]) worden voorbereid en eindigt het activiteitendiagram voor wat betreft het Opvragen van verwijzingen.

Voor de gevonden verwijzingen dient er een autorisatiecontrole plaats te vinden. Deze controle vindt plaats door in de APT de autorisaties op te vragen van de specifieke opvrager, die de opvraag initieert. Vervolgens dient gecontroleerd te worden of de gevonden indexgegevens ook daadwerkelijk verstuurd mogen worden.

Mocht een opvrager niet geautoriseerd zijn, dan zal er ook geen informatie worden verzonden omtrent de (betreffende) verwijzing. Voor de opvrager lijkt de verwijzing niet te bestaan. In het geval er geen één verwijzing is waar de opvrager voor geautoriseerd is, zal er een foutbericht worden voorbereid met de melding “niks gevonden”.

Het is mogelijk dat niet elke verwijzing in de verwijsindex een Bijwerktijd GBZ heeft. In het geval er een Bijwerktijd GBZ in het opvragenIndexMetGegevensbeheerder-bericht is opgenomen, dan moet er ook gecontroleerd worden of er verwijzingen bestaan waarvan er geen Bijwerktijd GBZ, maar wel de Aanmaaktijd GBZ binnen de start en eindtijd van de Bijwerktijd GBZ (in het opvragenIndexMetGegevensbeheerder-bericht) valt.

Mocht er voor een opvraagbericht verwijzingen zijn gevonden en de opvrager is volgens het autorisatieprotocol geautoriseerd om de verwijzing te ontvangen, dan zal het zorgadresboek (ZAB) worden geraadpleegd om de op te leveren gegevens te verrijken met informatie over de zorgaanbieder en zorgverlener. Het gaat hierbij om informatie als zorgverlenernaam, zorgaanbiedernaam en adres.

Met de aanvullende informatie uit het ZAB zal er uiteindelijk een opleverenIndexMetGegevensbeheerder-bericht worden voorbereid.

Het aantal indexgegevens dat teruggegeven wordt is gebonden aan een bepaald maximum, zim-max-opleveren-indexgegevens (LSP.VWI.t2160). Dit maximum geldt alleen voor het nieuwe opvragenIndexMetGegevensbeheerder-bericht, niet voor de oude versie. Mocht de maximaal op te leveren indexgegevens overschreden worden, dan moet er, naast de oplevering van het maximum aantal indexgegevens, een foutmelding “teveel resultaten” komen. De parameter geldt onafhankelijk van de query parameters die meegegeven worden.

Diagram LSP.VWI.d2090.1 – inhoudelijke afhandeling service Opvragen van verwijzingen met beheerder

LSP

5.1.6 Opvragen eigen verwijzingen

Het activiteitendiagram van de service, Opvragen eigen verwijzingen, is weergegeven in LSP.VWI.d2100.

De service wordt geactiveerd door het ontvangen van een opvragenEigenGegevens-bericht door de ZIM. Dit bericht bevat de attributen zoals beschreven in LSP.VWI.t2093. Het bericht wordt gecontroleerd zoals beschreven in [Arch AORTA], Diagram AORTA.ZIM.d1050.

Het is alleen mogelijk om gegevens op te vragen van de betreffende applicatie van waar het bericht wordt verstuurd. Er dienen dus in de VWI alleen de verwijzingen te worden geselecteerd behorende bij die applicatie. Daarnaast is het nog mogelijk om te selecteren op de attributen zoals opgenomen in het opvragenEigenVerwijzingen-bericht, zoals opgenomen in LSP.VWI.t2093 .

Mochten er geen verwijzingen gevonden kunnen worden, dan dient er een foutmelding “niks gevonden” (fout-id 5b [Foutentabel]) te worden opgenomen in het opleverbericht.

Diagram LSP.VWI.d2100 – inhoudelijke afhandeling service Opvragen eigen verwijzingen

5.2 Ondersteunende functies

In dit hoofdstuk worden de functies beschreven die de component beschikbaar stelt aan andere componenten binnen de ZIM. Het gaat hier om zowel functies ter ondersteuning van de primaire services beschreven in hoofdstuk 5.1, als om functies die ondersteuning bieden aan andere componenten binnen de ZIM.

5.2.1 Signaleren eerste aanmelding

Het activiteitendiagram van de functie, Signaleren eerste aanmelding, is weergegeven in LSP.VWI.d2110.

De functie wordt geactiveerd door de service Toevoegen van een verwijzing, LSP.VWI.d2020. De functie Signaleren eerste aanmelding controleert voor een aanmelding of de aangemelde gegevenssoort in aanmerking komt voor het verzenden van een signalerenEersteAanmelding-bericht. Er zijn een aantal gegevenssoorten, opgenomen in [Config-inst], die niet in aanmerking komen voor signalering.

In het geval de gegevenssoort in aanmerking komt voor een signalering eerste aanmelding, moet er gecontroleerd worden of er reeds aangemelde gegevens zijn (met gegevenssoorten die niet zijn uitgesloten voor signaleren eerste aanmelding). Als dit niet het geval is, zal er een signalerenEersteAanmelding-bericht (LSP.VWI.t2123) voorbereid worden, waarna de activiteitenstroom eindigt.

In het geval wanneer een patiënt totaal bezwaar heeft ingesteld en deze in een later stadium weer opheft, zal de VWI leeg zijn en wordt dan wordt er weer een signaal eerste aanmelding verstuurd.

Tabel LSP.VWI.t2123 – SignalerenEersteAanmelding-bericht

Systeeminterface 2 – uitgaand bericht
Attribuut	Definitie	Herkomst	Additionele informatie
Patiëntgegevens-id (1)		Zie Hoofdstuk 6.1
Actualiteit (1)	Tijdstip waarop de eerste aanmelding plaatsvond; de aanmaaktijd in de VWI.
Patiënt-id (1)		Zie Hoofdstuk 6.1
Beheerverantwoordelijke (1): - Zorgaanbieder-id (1) - Zorgverlener-id(1) - Zorgverlener-functie(1) - Applicatie-id (1)		Zie Hoofdstuk 6.1
Inhoudverantwoordelijke(1): - Zorgaanbieder-id (1) - Zorgverlener-id(1) - Zorgverlener-functie(1)		Zie Hoofdstuk 6.1
Gegevenssoort (1)		Zie Hoofdstuk 6.1
Patiëntstuktype(1)		Zie Hoofdstuk 6.1

Diagram LSP.VWI.d2110 – inhoudelijke afhandeling functie Signaleren eerste aanmelding

5.2.2 Verwijderen verwijzingen zonder opt-in

Het activiteitendiagram van de functie, Verwijderen verwijzingen zonder opt-in, is weergegeven in LSP.VWI.d2120. De functie Verwijderen verwijzingen zonder opt-in wordt geactiveerd door het Autorisatieprofiel, [Ontw OPV]. Alle verwijzingen die verkregen zijn zonder opt-in voor een specifieke patiënt dienen verwijderd te worden. Voor elke verwijzing die verwijderd wordt, wordt de functie Signaleren verwijdering indexgegevens aangeroepen.

Diagram LSP.VWI.d2120 – inhoudelijke afhandeling functie Verwijderen verwijzingen zonder opt-in

5.2.3 Signaleren verwijdering indexgegevens

Het activiteitendiagram van de functie, Signaleren verwijdering indexgegevens, is weergegeven in LSP.VWI.d2140 – Signaleren verwijdering indexgegevens.

De functie wordt geactiveerd door de functie Verwijderen verwijzingen zonder opt-in, beschreven in hoofdstuk 5.2.2. Voor elke verwijzing die uit de VWI verwijderd wordt door de functie Verwijderen verwijzingen zonder opt-in moet een signalering voorbereid worden, zoals beschreven in hoofdstuk 5.2.2 LSP.VWI.t2125.

Het signaal dient naar de beheerverantwoordelijke applicatie van de betreffende verwijzing verstuurd te worden. Mocht deze applicatie om wat voor reden dan ook het signaal niet kunnen ontvangen of verwerken, dan dient het signalerenVerwijderingIndexGegevens-bericht verstuurd te worden naar het klantenloket.

Tabel LSP.VWI.t2125 – SignalerenVerwijderingIndexGegevens-bericht

Systeeminterface 2 – uitgaand bericht
Attribuut	Definitie	Herkomst	Additionele informatie
Verwijderde verwijzingen (1..n) Per verwijzing:
Patiëntgegevens-id (1)		Zie Hoofdstuk 6.1
Actualiteit (1)	Tijdstip waarop de indexgegevens zijn verwijderd.	Zie Hoofdstuk 6.1
Patiënt-id (1)		Zie Hoofdstuk 6.1
Beheerverantwoordelijke (1): - Zorgaanbieder-id (1) - Zorgverlener-id (1) - Zorgverlener-functie (1) - Applicatie-id (1)		Zie Hoofdstuk 6.1
Inhoudverantwoordelijke(1): - Zorgaanbieder-id (1) - Zorgverlener-id (1) - Zorgverlener-functie (1)		Zie Hoofdstuk 6.1
Gegevenssoort (1)		Zie Hoofdstuk 6.1
Patiëntstuktype(1)		Zie Hoofdstuk 6.1

Diagram LSP.VWI.d2140 – inhoudelijke afhandeling functie Signaleren verwijdering indexgegevens

5.2.4 Opvragen van verwijzingen

De functie opvragen van verwijzingen wordt aangesproken door de OPV component, beschreven in [Ontw OPV]. De OPV component raadpleegt de VWI voor specifieke verwijzingen. De gezochte verwijzingen worden bepaald aan de hand van de attributen die de OPV component meestuurt met de opvraag. Het gaat hierbij om de volgende attributen:

· Patiënt-id;

· Gegevenssoort;

· Actualiteit.

Verwijzingen die overeenkomen met bovenstaande attributen worden doorgegeven aan de OPV component.

5.2.5 Zoek gegevenssoort bij interactie

De functie Zoek gegevenssoort bij interactie zoekt aan de hand van een binnenkomend HL7v3-interactie-id het gegevenssoort-id op in de gegevenssoortentabel. De gegevenssoortentabel bevat per regel een gegevenssoort-id en een HL7v3-interactie-id. Het gevonden gegevenssoort-id wordt als antwoord geretourneerd naar de gebruiker van de service.

5.3 Beheerfuncties

In LSP.VWI.t2130 worden de beheerfuncties beschreven die de LSP-beheerder kan uitvoeren op de VWI. De beheerder gebruikt hiervoor de ZIM-beheerapplicatie (ZBA). De ZBA heeft een interface met de beheerservice van de VWI.

Tabel LSP.VWI.t2130 – VWI Beheerfuncties

Beheerfunctie	Type gebruikersinterface	Beschrijving
Verwijderen verwijzingen zonder opt-in	Beheerderinterface	Alle verwijzingen naar een bepaalde GBZ-applicatie moeten verwijderd kunnen worden door de beheerder.
Verwijderen verwijzingen specifiek UZI-nummer	Beheerderinterface	Alle verwijzingen naar een bepaalde GBZ-applicatie, die zijn aangemeld door of namens een bepaald UZI-nummer, moeten verwijderd kunnen worden door de beheerder.
Verwijderen verwijzingen specifiek BSN	Beheerderinterface	Alle verwijzingen naar een bepaalde GBZ-applicatie met betrekking tot een bepaald BSN moeten verwijderd kunnen worden door de beheerder.

6 Gegevensmodel

Dit hoofdstuk beschrijft het gegevensmodel voor de VWI. Hier worden alleen de gegevens beschreven die door de VWI zelf beheerd worden.

6.1 (Logisch) model van entiteiten en relaties

Tabel LSP.VWI.t2140 bevat de attributen die worden opgeslagen in de VWI.

Tabel LSP.VWI.t2140 – Gegevensmodel Verwijsindex

Attribuut	Definitie
Patiëntgegevens-id /patiëntstuk-id (1)	De unieke identificatie van een categorie van patiëntgegevens (categoriaal) of patiëntstuk (atomair). In het geval van een categorale aanmelding mag het patiëntgegevens-id niet gelijk zijn aan een (lokaal) patiëntstuk-id dat in de categorie voor komt.
Patiënt-id (1)	Unieke identificatie van de patiënt (BSN) waarop de aanmelding betrekking heeft.
Beheerverantwoordelijke (1): - Zorgaanbieder-id (1) - Zorgverlener-id (1) - Zorgverlener-functie (1) - Applicatie-id (1)	Verantwoordelijke voor het bewaren/beschikbaar stellen van patiëntgegevens: - Unieke identificatie van de zorgaanbieder (URA) - Unieke identificatie van de zorgverlener (UZI) - Rolcode van de zorgverlener - Unieke identificatie van de applicatie van de beheerverantwoordelijke
Inhoudverantwoordelijke (1): - Zorgaanbieder-id (1) - Zorgverlener-id (1) - Zorgverlener-functie (1)	Unieke identificatie van de inhoudsverantwoordelijke van de gegevens die worden aangemeld.
Gegevenssoort (1)	Unieke code van de gegevenssoort die wordt aangemeld. Eén gegevenssoort kan worden vertegenwoordigd door één of meer patiëntstuk-typen.
Actualiteit(1): - Aanmaaktijd in GBZ (0..1) - Bijwerktijd in GBZ (0..1) - Aanmaaktijd in VWI (1) - Bijwerktijd in VWI (1) - Einde geldigheid GBZ (0..1)	De tijd waarop de verwijzing voor het eerst aangemeld of het laatst gewijzigd is. Einde geldigheid GBZ wordt alleen opgeslagen in geval er sprake is van een atomaire verwijzing.
Patiëntstuk-type(1)	Code “CATEGORY” voor categorale aanmeldingen en de unieke code voor het patiëntstuk-type voor atomaire aanmeldingen. Ieder patiëntstuk-type heeft één gegevenssoort.
Registratie-id	Unieke identificatie die de VWI zelf aan een VWI-registratie koppelt.
Opt-in status	Verwijzingen die zijn (her)aangemeld door een voor opt-in gekwalificeerd systeem worden gekenmerkt door een specifieke opt-in status.

6.2 Gegevensautorisatiemodel

Tabel LSP.VWI.t2150 – Gegevensmodel Verwijsindex

Gegevensautorisatiemodel (aanduiding CRUD-rechten per rol)
Entiteit	Beheerder
Verwijzing in VWI	Delete

7 Configuratieaspecten

De VWI heeft instellingen voor gegevenssoorten.

In het geval van een eerste aanmelding zijn er een aantal gegevenssoorten die uitgesloten zijn voor een signalering eerste aanmelding. Deze gegevenssoorten worden vermeld in [Config-inst].

Andere configuratieparameters die betrekking hebben op de verwijsindex zijn opgenomen in LSP.VWI.t2160.

Tabel LSP.VWI.t2160 – Configuratieparameters voor verwijsindex

Configuratie-parameter	Betekenis van parameter	Datatype	Domein (mogelijke waarden)
zim-max-opleveren-indexgegevens	Het maximaal aantal op te leveren indexresultaten. Geldt alleen voor de nieuwe versie van het opvragenIndexMetGegevens-beheerderbericht (QUMT_IN020011NL02). De parameter geldt onafhankelijk van de query-parameters die zijn ingevuld.	Integer	verstekwaarde: oneindig

8 Ontwerpaspecten ten behoeve van niet-functionele eisen

Er zijn geen specifieke ontwerpaspecten ten behoeve van niet-functionele eisen. De generieke zaken worden beschreven in [Arch AORTA].

9 Interne componentenstructuur en werking

Het staat de leverancier vrij om de interne componentenstructuur te ontwerpen op basis van (niet-)functionele eisen.

10 Procedurele beheeraspecten

Er worden geen beheeraspecten voorzien waarvan is te verwachten dat deze tot bijzondere beheerprocedures leiden.

Bijlage A: Referenties

Referentie	Document	Versie
[Arch AORTA]	Architectuur AORTA	6.11.0.0
[PvE GBx Rollen]	Programma van eisen infrastructurele systeemrollen	6.11.0.0
[Ontw APF]	Ontwerp autorisatieprofiel	6.11.0.0
[Config-inst]	Configuratie-instellingen	6.11.0.0
[Ontw OPV]	Ontwerp opvragen patiëntgegevens	6.11.0.0
[Ontw Sgl GBV]	Ontwerp gebeurtenisverwerking	6.11.0.0
[Foutentabel]	Foutentabel	6.11.0.0
[HL7v3 IH Wrp]	HL7v3-implementatiehandleiding berichtwrappers	6.11.0.0
[Ontw Authenticatie]	Ontwerp authenticatie	6.11.0.0
[Ontw APR]	Ontwerp applicatieregister	6.11.0.0

Ontwerp verwijsindex
AORTA 2012 (v6·11)

Datum:	5 december 2012
Versie:	6.11.0.0
Referentie:	[Ontw VWI]