RFC0023 Harmonisering Register van Informatiestandaarden en Catalogus: informatiemodellen
Samenvatting
Waarom is deze RFC nodig? | A. Onderscheid tussen Register en Catalogus is onwenselijk (en enkele kleine verbeterpunten) A1. Het huidige onderscheid tussen het Register van Informatiestandaarden en de Catalogus is onnodig en niet goed verklaarbaar. Op dit moment bevat het Register de informatiestandaarden die zijn toegelaten voor gebruik binnen MedMij, en de Catalogus de gegevensdiensten. Beide hebben geen bestaansrecht zonder elkaar: een informatiestandaard zonder gegevensdienst kan niet worden gebruikt, een gegevensdienst zonder informatiestandaard kan niet worden gedefinieerd. Het onderscheid tussen de twee lijsten leidt tot een onnodige beheerlast, tot kans op fouten door inconsistenties, en tot verlaagde toegankelijkheid van de opzet van en verantwoordelijkheden van MedMij. A2. Het Register bevat enkele concepten die vooral betrekking hebben op het ontwikkel- en toetsingsproces van standaarden, maar geen operationele betekenis hebben binnen MedMij. Dit leidt tot ambiguïteit in de formele status van een informatiestandaard. A3. Binnen het MedMij Afsprakenstelsel is niet voorzien in een mogelijkheid om aan te geven welke versies van de afsprakenset gebruikt kunnen worden in combinatie met welke Gegevensdienst. De Catalogus bepaalt wel de geldigheidsperiode van een Gegevensdienst, maar in die periode kunnen er op enig moment twee versies van de afsprakenset (de gepubliceerde en de verplichte versie) in operationeel gebruik zijn. Het is denkbaar dat een Gegevensdienst niet compatibel is met beide versies. B. Catalogus is niet machine-leesbaar De Catalogus is maar beperkt machineleesbaar en de juistheid wordt ook maar beperkt afgedwongen door de implementatie van het logische model in ODS of HTML. Ook is (facultatief) geautomatiseerd gebruik door belanghebbende partijen daarmee moeilijk. |
---|---|
Oplossingsrichting | Ad A: Catalogus neemt functie van Register over en het concept Gegevensdienst krijgt een nog centralere rol
Ad B: de Catalogus wordt gepubliceerd in XML-formaat en een human readable formaat
|
Aanpassing van | Er is geen aanpassing nodig van de logische modellen en XML-schema's van de OCL, de ZAL en de GNL. |
Impact op rollen | Niet op de relatie Deelnemer - Deelnemer of Deelnemer - Beheerorganisatie. Wel op rollen die niet in het MedMij Afsprakenstelsel zijn beschreven (rollen gerelateerd aan het "stelsel van standaarden"). |
Impact op beheer |
|
Impact op RnA | Optioneel: mogelijkheid tot geautomatiseerd inlezen van de Catalogus. Optioneel: mogelijkheid tot eenvoudige geautomatiseerde afleiding van de GNL uit de Catalogus. Verplicht: bij de registratie van een ZAL-entry moet worden gecontroleerd op een geldige combinatie Gegevensdienst-Interfaceversie. Verplicht: bij de publicatie van de nieuwe versie van de Catalogus moet deze worden ingelezen en worden gebruikt als bron voor andere het genereren van de Gegevensdienstnamenlijst. |
Impact op Acceptatie | Geen. |
Gerelateerd aan (Andere RFCs, PIM issues) | Geanalyseerd: de RFC's die per 30-10-2020 kandidaat zijn voor release 1.3.0. Inhoudelijke relatie:
De volgende RFC's hebben geen inhoudelijke relatie, maar vragen wel om bijstelling van de informatiemodellen. Dit vraagt om extra coördinatie/integratie bij de uitwerking:
Geen relatie:
RFC0023 is gekoppeld aan intern issue AF-967. |
Eigenaar | |
Implementatietermijn | De RFC heeft betrekking op de Catalogus en de afsprakenset. Die kennen elk een eigen releasecyclus. De Catalogus ontleent haar structuur echter aan de afsprakenset; synchronisatie van de wijzigingen in de Catalogus en de afsprakenset is dus nodig. De implementatie van deze RFC is beoogd voor:
|
Motivatie verkorte RFC procedure (patch) | Geen patch benodigd. Analyse van de impact van deze RFC op afsprakenset release 1.2.0 (de enig andere release van de afsprakenset, naast 1.3.0, die gebruikt kan worden op het moment van het doorvoeren van deze RFC):
|
Input voor release notes / communicabele samenvatting | Wijzigingen zonder directe implementatie-impact voor de Deelnemers: Catalogus is vernieuwd, Register van Informatiestandaarden is vervallen - Het Register van Informatiestandaarden is vervallen, voortaan worden Informatiestandaarden niet meer zelfstandig toegelaten maar worden de eisen waaraan een systeemrol/Informatiestandaard moet voldoen meegewogen bij het samenstellen van een specifieke Gegevensdienst. De Catalogus is uitgebreid om de relevante onderdelen van het Register van Informatiestandaarden over te kunnen nemen. Tegelijkertijd is die geoptimaliseerd zodat die alleen relevante en heldere concepten bevat. De Catalogus wordt beschikbaar gesteld als XML-bestand en een automatische vertaling naar een gebruiksvriendelijke versie. Het Gegevensdienstenbeleid reflecteert de vereenvoudiging. Relatie tussen Gegevensdiensten en Interfaceversies is geëxpliciteerd - In de Catalogus wordt aangegeven met welke Interfaceversies een Gegevensdienst mag worden gebruikt. |
Goedkeuring
Beoordelaar | Datum | Toelichting | Beoordelaar | Datum | Toelichting |
---|---|---|---|---|---|
Productmanager Stichting MedMij | Productmanager Beheerorganisatie | ||||
Leadarchitect Stichting MedMij | Leadarchitect Beheerorganisatie | ||||
Ontwerpteam | |||||
Deelnemersraad | Eigenaarsraad |
Principes
Principe | Principe | ||
---|---|---|---|
1 Het MedMij-netwerk is zoveel mogelijk gegevensneutraal | Positief | 11 Stelselfuncties worden vanaf de start ingevuld | Neutraal |
2 Dienstverleners zijn transparant over de gegevensdiensten | Positief | 12 Het afsprakenstelsel is een groeimodel | Neutraal |
3 Dienstverleners concurreren op de functionaliteiten | Neutraal | 13 Ontwikkeling geschiedt in een half-open proces met verschillende stakeholders | Neutraal |
4 Dienstverleners zijn aanspreekbaar door de gebruiker | Neutraal | 14 Uitwisseling is een keuze | Neutraal |
5 De persoon wisselt gegevens uit met de zorgaanbieder | Neutraal | 15 Het MedMij-netwerk is gebruiksrechten-neutraal | Neutraal |
6 MedMij spreekt alleen af wat nodig is | Neutraal | 16 De burger regisseert zijn gezondheidsinformatie als uitgever | Neutraal |
7 De persoon en de zorgaanbieder kiezen hun eigen dienstverlener | Neutraal | 17 Aan de persoonlijke gezondheidsomgeving zelf worden eisen gesteld | Neutraal |
9 De dienstverleners zijn deelnemers van het afsprakenstelsel | Neutraal | 18 Afspraken worden aantoonbaar nageleefd en gehandhaafd | Neutraal |
10 Alleen de dienstverleners oefenen macht uit over persoonsgegevens bij de uitwisseling | Neutraal | 19 Het afsprakenstelsel snijdt het gebruik van normen en standaarden op eigen maat | Neutraal |
Uitwerking
Toevoegingen in paars. Verwijderingen doorgehaald.
Uitgangspunt is dat toelichtingen in de te publiceren producten (bijvoorbeeld bij het metamodel) vooral daar worden verschaft waar die zinvol zijn (bijdragen aan duidelijkheid, begrip, gewenste standaardisatie).
Links naar andere pagina's binnen het Afsprakenstelsel zijn niet nagelopen, dat kan het beste bij de eindredactie plaatsvinden.
Noot voor eindredactie
De uitwerking van deze RFC gaat ervan uit dat RFC0035 Verzamel RFC reeds is verwerkt.
Metamodel (aanpassing)
Model
Noot voor eindredactie
In dit model zijn alleen de voor de aanpassing relevante klassen opgenomen. Dit deel moet door de eindredactie worden geïntegreerd in de afbeelding van het volledige metamodel.
Het plaatje met de 'domeinen', onderdeel van het metamodel, behoeft ook aanpassing om de nieuwe situatie te reflecteren.
Toelichting
Op enkele punten is afgeweken van deze modelleerstijl, om de presentatie van het model niet onnodig te compliceren. door gebruik van:
de uses-relatie, vooral in het Informatiestandaarden-domein, omdat dat domein niet onder beheer van MedMij valt;de aggregatie-relatie, idem;de objectgeoriënteerde specialisatie, namelijk waar we een opsommende definitie geven van Deelnemersrol, Businessrol, Usecase en Bedrijfsrol;attributen voor identificatie of omschrijving.
In al deze gevallen zouden ook associatieklassen gebruikt kunnen worden, maar zou dat de presentatie van het model onnodig compliceren.
(...)
Gegevensdiensten horen bij een Usecase en hebben een geldigheidsperiode. Bovendien wordt, door middel van het attribuut Vereist, van sommige Gegevensdiensten vereist dat, als een Zorgaanbieder die Gegevensdienst aanbiedt, hij ook zekere andere Gegevensdiensten moet aanbieden. Vaak zal die lijst leeg zijn, maar het heeft bijvoorbeeld weinig zin het Delen van een afspraakverzoek aan te bieden, zonder ook het Verzamelen van het antwoord daarop aan te bieden. De klasse RolInGegevensdienst wordt gebruikt om, via de Deelnemer, de MedMij-rollen DienstverlenerpersoonDeelnemersrol en DienstverlenerzorgaanbiederDeelnemersrol te verbinden met de dienovereenkomstige rollen die Nictiz in het Informatiestandaarden-domein heeft geformuleerd, namelijk respectievelijk PatiëntBedrijfsrol en ZorgaanbiederBedrijfsrol. Een GegevensdienstInterfaceversie geeft aan dat een Gegevensdienst via de Interfaceversie mag worden aangeboden.
De klassen in het modeldomein Informatiestandaarden, inclusief hun namen, moeten begrepen worden in de zin waarin Nictiz ze gebruikt in het kader van de Informatiestandaarden die voor gebruik binnen MedMij zijn toegelaten waarvan de onderdelen de basis vormen voor Gegevensdiensten. Daarom zijn de randen van deze klassen gestippeld. De bouwblokjes van een Informatiestandaard noemen we een Transactie, die zowel functionele als technische specificaties bevat. Een Bedrijfsrol, waarvan er twee zijn (PatiëntBedrijfsrol en ZorgaanbiederBedrijfsrol), wordt aangenomen door een Systeemrol Transactie.
De klassen in het modeldomein Systeemrollen leggen de verbinding tussen het domein van de Informatiestandaarden en dat van de Gegevensdiensten. Een Systeemrol is een Transactie die voorzien is van een Systeemrolcode om hem binnen MedMij uniek te kunnen aanduiden. Merk op dat een Systeemrol een concept is met een specifieke betekenis binnen het MedMij Afsprakenstelsel. Het is niet hetzelfde als het concept "Systeemrol" zoals dat wordt gebruikt binnen de Nictiz-informatiestandaarden. Een Systeemrol kan een Ondersteuningsorganisatie hebben die dienstverlening biedt aan Deelnemers bij vragen over de specificaties behorend bij de Systeemrol. Vaak zal dit de beheerder van de onderliggende Informatiestandaard zijn, maar het is ook denkbaar dat er geen beheerder is of dat een andere partij de rol van beheerder vervult (bijvoorbeeld als de beheerder van de Informatiestandaard geen dienstverlening biedt voor MedMij-stakeholders). Een Systeemrol kan ook verbonden zijn met een Kwalificatieloket waar de ondersteuning van Systeemrollen kan worden aangetoond.
Systeemrollen worden gegroepeerd in Systeemrolverzamelingen die samen met een Usecase een Gegevensdienst vormen. Een actueel voorbeeld van een Systeemrolverzameling is een verzameling van vier Systeemrollen waarvan er twee (één voor elke betrokken Bedrijfsrol) een overzicht van beschikbare PDF-documenten uitwisselen en twee (opnieuw één voor elke betrokken Bedrijfsrol) een PDF-document uit dat overzicht uitwisselen. Gegevensdiensten worden als geheel (dat wil zeggen met hun gehele Systeemrolverzameling) aan Zorggebruikers aangeboden en die gebruikers zullen deze ook ineens autoriseren.
De klassen in het metamodel horen bij de verschillende lagen in de architectuur van het afsprakenstelsel. De betreffende laag is aangegeven door de inkleuringen van de klassen. Alleen bij de Nictiz-klassen in het Register van Informatiestandaarden hebben we dit achterwege gelaten.
Invarianten
Betreft instanties van klasse ... | Invariant | Modeldomein | Toelichting | Aard |
---|---|---|---|---|
| ||||
ZorgaanbiederGegevensdienst | Voor elke ZorgaanbiederGegevensdienst zg geldt: ALS er een ZorgaanbiederGegevensdienstInterfaceversie zgi1 is zodat:
EN er een GegevensdienstInterfaceversie gi is zodat:
DAN is er een ZorgaanbiederGegevensdienstInterfaceversie zgi2 zodat:
| Zorgaanbieders | Wanneer een Zorgaanbieder een Gegevensdienst aanbiedt op de gepubliceerde Interfaceversie, moet hij deze ook aanbieden op de verplichte Interfaceversie. Dit geldt uiteraard alleen als de Gegevensdienst ook mag worden aangeboden op de verplichte Interfaceversie. Zie Change- en releasebeleid. | niet-lokale afhankelijkheid |
ZorgaanbiederGegevensdienst | Voor elke ZorgaanbiederGegevensdienst zg geldt: ALS er een ZorgaanbiedersAbonnerenOpGegevensdienstInterfaceversie zagi1 is zodat:
EN er een GegevensdienstAbonnerenOpGegevensdienstInterfaceversie agi is zodat:
DAN is er een ZorgaanbiedersAbonnerenOpGegevensdienstInterfaceversie zagi2 zodat:
| Zorgaanbieders | Wanneer een Zorgaanbieder Abonneren op een Gegevensdienst aanbiedt op de gepubliceerde Interfaceversie, moet hij dat ook aanbieden op de verplichte Interfaceversie. Dit geldt uiteraard alleen als de Gegevensdienst ook mag worden aangeboden op de verplichte Interfaceversie. Zie Change- en releasebeleid. | niet-lokale afhankelijkheid |
Ondersteuningsloket | Elk Ondersteuningsloket heeft ten minste één van de volgende attributen: Emailadres, Telefoonnummer en Emailadres. | Systeemrollen | Een Ondersteuningsloket moet ten minste langs één wijze een contactadres kennen. | lokale afhankelijkheid |
ResourceEndpoint | Voor elk ResourceEndpoint r geldt:
de combinatie van r.MedMijNode.DeelnemerNode.Node.Hostname en r.ResourceEndpointpath is gelijk aan wat in de specificaties van r.ZorgaanbiederGegevensdienstSysteemrolInterfaceversie.Systeemrol.Transactie
| Zorgaanbieders | Deze invariant regelt | niet-lokale afhankelijkheid |
Gegevensdienst | Voor elke Gegevensdienst geldt: g.Usecase is ofwel VerzamelenUsecase ofwel DelenUsecase. | Gegevensdiensten | Zo wordt geregeld dat een Gegevensdienst alleen gebaseerd kan zijn op de primaire use cases Verzamelen of Delen. | opsomming |
Kwalificatieloket | Elk Kwalificatieloket heeft ten minste één van de volgende attributen: Emailadres, Telefoonnummer en Emailadres. | Systeemrollen | Een Kwalificatieloket moet ten minste langs één wijze een kanaal kennen waarlangs meer informatie over de kwalificatie kan worden verkregen. | lokale afhankelijkheid |
| ||||
ZorgaanbiederGegevensdienst | Voor elke ZorgaanbiederGegevensdienst.Gegevensdienst. waarvoor geldt dat s.Transactie.Bedrijfsrol = ZorgaanbiederBedrijfsrol, geldt dat er een ZorgaanbiederGegevensdienstSysteemrol z is zodat z.Systeemrol = s. | Zorgaanbieders | Als in de Catalogus een Systeemrol voor Zorgaanbieders hoort bij een namens een zekere Zorgaanbieder aangeboden Gegevensdienst, dan moet namens dezelfde Zorgaanbieder ook deze Systeemrol worden aangeboden. | niet-lokale afhankelijkheid |
| ||||
| ||||
OAuthclientGegevensdienstInterfaceversie | Voor elke OAuthclientGegevensdienstInterfaceversie ogi geldt: ALS er een OAuthClientAbonnerenOpGegevensdienstInterfaceversie oagi1 is zodat:
DAN is er een OAuthClientAbonnerenOpGegevensdienstInterfaceversie oagi2 zodat:
| Zorgaanbieders | Wanneer een OAuthClient Abonneren op een Gegevensdienst aanbiedt op de gepubliceerde Interfaceversie, moet hij dat ook aanbieden op de verplichte Interfaceversie. Zie /wiki/spaces/MedMijAfsprakenstelsel130/pages/135628810. | niet-lokale afhankelijkheid |
|
Noot voor eindredactie
Er is vanuit gegaan dat OAuthclientGegevensdienst niet meer voorkomt in het metamodel, op grond van RFC0014 Extra controles door Authorization Interface.
Basisklassen
Basisklasse | Definitie |
---|---|
HttpsUrl | Semantiek: adres van een resource die via het internet benaderbaar is volgens het HTTPS-protocol. Syntax: string die altijd start met |
Versienummer | |
Telefoonnummer | Semantiek: internationaal telefoonnummer volgens Recommendation ITU-T E.164 (11/2010). Syntax: string die altijd start met + en vervolgens bestaat uit maximaal vijftien cijfers (0 tot en met 9). |
Emailadres | Semantiek: e-mailadres volgens sectie 3.4.1 van IETF RFC 5322. Syntax: string van een of meer tekens, gevolgd door het teken |
NederlandseDatum | Semantiek: datum volgens lokale Nederlandse tijd. Syntax: datum volgens het type |
LangeWeergavenaam | String van minimaal drie en maximaal 125 tekens. |
Logische modellen (aanpassing)
Model Catalogus
Noot voor eindredactie
Het model wordt worden vervangen door de inhoud van onderstaand model. De stijl van de bestaande logische modellen kan daarop worden toegepast.
Toelichting bij wijziging (niet verwerken)
De Catalogus is geen specialisatie van MedMijBeheerlijst, omdat het een aantal (impliciete) kenmerken van MedMijBeheerlijsten niet deelt, zoals de gebondenheid aan een specifieke interfaceversie.
Invarianten bij logisch model Catalogus
Betreft instanties van klasse ... | Invariant | Component | Toelichting | Aard | Herkomst |
---|---|---|---|---|---|
Catalogus | Er is precies één instantie hiervan. | Catalogus | Dit is een eenling in het model. | getalsverhouding | logisch model |
| |||||
Systeemrol | Voor elke Systeemrol s geldt: s.Presentatievolgorde wordt bepaald door de relatieve positie van de systeemrol in de tijdsvolgorde waarin s.Transactie binnen de uitvoering van s.Systeemrolverzameling.Gegevensdienst.Usecase zijn werk moet doen. Daarbij gelden als elkaar aanvullende richtlijnen:
| Catalogus | De volgorde waarin die Systeemrolcodes bij een Gegevensdienst staan opgesomd is formeel om het even, maar voor de presentatie wel relevant. Die volgorde van presentatie komt overeen met de tijdsvolgorde waarin de betreffende Systeemrollen hun werk moeten doen. | lokale afhankelijkheid | logisch model |
Invarianten bij logisch model Lijsten
Betreft instanties van logische klasse ... | Invariant | Component | Toelichting | Aard | Herkomst |
---|---|---|---|---|---|
| |||||
| |||||
| |||||
Systeemrol | Voor elke Systeemrol s met haar corresponderende ZorgaanbiederGegevensdienstSysteemrol z geldt: s.Systeemrolcode ← z.Systeemrol.Systeemrolcode. | Zorgaanbiederslijst | Zo erft de Zorgaanbiederslijst de Systeemrolcodes van | vererving | logisch model |
Toelichting bij wijziging (niet verwerken)
De invarianten voor de klasse "Interfaceversies_ZAL" zouden moeten worden aangepast als gevolg van een wijziging van de gerelateerde invariant in het metamodel. De logische invariant zou daardoor nog complexer worden. Omdat de invariant echter geen duidelijke functie lijkt te hebben in het logische model (dat is gericht op de publicatie van de ZAL, en niet op de registratie; de betreffende invarianten hebben nu ook geen vertaling in het technische model), worden zij in plaats daarvan geschrapt.
Basisklassen bij logisch model Catalogus
Basisklasse | Definitie | Herkomst |
---|---|---|
DeelnemersrolWeergavenaam | String met de waarde "Dienstverlener persoon" of "Dienstverlener zorgaanbieder". | logisch model |
UsecaseWeergavenaam | String met de waarde "Verzamelen" of "Delen". | logisch model |
BedrijfsrolWeergavenaam | String met de waarde "Patiënt" of "Zorgaanbieder". | logisch model |
NederlandseDatum | Semantiek: datum volgens lokale Nederlandse tijd. Syntax: datum volgens het type | metamodel |
HttpsUrl | Semantiek: adres van een resource die via het internet benaderbaar is volgens het HTTPS-protocol. Syntax: string die altijd start met | metamodel |
Telefoonnummer | Semantiek: internationaal telefoonnummer volgens Recommendation ITU-T E.164 (11/2010). Syntax: string die altijd start met + en vervolgens bestaat uit maximaal vijftien cijfers (0 tot en met 9). | metamodel |
Emailadres | Semantiek: e-mailadres volgens sectie 3.4.1 van IETF RFC 5322. Syntax: string van een of meer tekens, gevolgd door het teken | metamodel |
Versienummer | String van minimaal één en maximaal 30 tekens. | metamodel |
Positiefnummer | Een geheel getal ongelijk 0. | logisch model |
LangeWeergavenaam | String van minimaal één en maximaal 125 tekens. | metamodel |
Verband klassen logisch model Catalogus met metamodel
Klasse/waarde in logisch model | Herkomstklasse in metamodel |
---|---|
Usecase | Usecase |
Interfaceversie | Interfaceversie |
Transactie | Transactie |
Bedrijfsrol | Bedrijfsrol |
Ondersteuningsloket | Ondersteuningsloket |
Kwalificatieloket | Kwalificatieloket |
Transactieaanduiding | Transactieaanduiding |
Volledigetransactienaam | Volledigetransactienaam |
Deelnemersrol | Deelnemersrol |
VereisteGegevensdienst | Gegevensdienst |
Toelichting
De klasse Usecase is een abstracte klasse in het metamodel. In het logische model zijn, in de compositiehiërarchie, echter concrete klassen nodig. In het kader van de Catalogus zijn we hier niet geïnteressseerd in de gehele semantiek van de conceptuele klassen VerzamelenUsecase en DelenUsecase, maar enkel in hun respectievelijke instanties, met de Weergavenaam die zij van de abstracte klasse Usecase krijgen, door middel van een invariant. Daarom gebruiken we in dit logische model een concrete klasse Usecase, die tot deze twee instantieert.
Toelichting bij wijziging (niet verwerken)
Er zijn bewust geen klassen opgenomen t.b.v. het wijzigingsbeheer. In de huidige Catalogus komen de kolommen "Datum aanmaak", "Datum mutatie" en "Opmerking mutatie" voor. Voor toelichting op de wijzigingen wordt verwezen naar de toelichting op de Catalogus. Daarnaast kunnen gebruikers met eigen tooling desgewenst een automatische vergelijking uitvoeren tussen verschillende versies van het XML-bestand van de Catalogus. Aan de toelichting op de Catalogus zal voor nieuwe wijzigingen ook de datum van de mutatie worden toegevoegd.
XML-schema Catalogus (nieuw)
Het releasenummer wordt met één opgehoogd omdat de structuur van het technische model van de Catalogus is gewijzigd.
De bestandsnaam bevat niet de bestandsversie, noch het volgnummer, maar wel het nummer van de release van de Catalogus.
Pagina XML-schema’s (aanpassing)
Toelichting
Op deze pagina staan de XML-schema's van:
- de lijsten die door MedMij Beheer aan Bron en Uitgever voor uiteenlopende doelen ter beschikking worden gesteld;
- de rapporten die door Deelnemers moeten kunnen worden opgeleverd;
- de Catalogus.
De XML-schema's zijn een implementatie van de relevante logische modellen van de lijsten in XML-syntax en vervullen daarom de rol van technisch model. XML past bij de hiërarchische structurering waarop al in de logische modellen is ingezet.
- Bij het logische model van de lijsten en rapporten horen vier technische componenten. De hoogste klasse van elke component wordt het rootelement van het betreffende XML-schema. De attributen van de abstracte klassen bovenaan (MedMijBeheerlijst en MedMijRapport) worden over de technische modellen van de vier lijsten, respectievelijk de twee rapporten, verspreid. Er is dus voor elke lijst of rapport een apart XML-schema. Daardoor is de homonymie van
Gegevensdienst
enGegevensdiensten
geen probleem meer en kunnen in de namen de achtervoegsels_ZAL
,_GNL
,_OCL
,_BR
en_PR
achterwege blijven.- De Catalogus vormt hierop een uitzondering. Die kent een zelfstandig logisch model. De klasse Catalogus uit het logisch model dient als root element van het XML-schema van de Catalogus.
Lijst of rapport | Bestandsnaam | Release | Versie bestand |
---|---|---|---|
Catalogus | MedMij_Catalogus_release3.xsd | 3 | 5 |
Tijdaspect
Het metamodel en de logische modellen, met hun invarianten, werken "door de tijd". Zij beschrijven hoe de klassen samenhangen op elk moment. De XML-bestanden voor de lijsten zijn echter specifieke momentopnames van de instanties van de klassen. Er moet daarom een tijdselement worden toegevoegd om lijsten die op verschillende momenten zijn gegenereerd, uit elkaar te kunnen houden, en om in retrospectief de geldigheidstermijn van een lijst te kunnen vaststellen.
- Elk XML-bestand kent een versie-aanduiding. Hiertoe wordt de combinatie van een
Volgnummer
en eenTijdstempel
gebruikt. Hiermee wordt aan drie informatiebehoeften tegemoet gekomen:- Wanneer twee lijsten (van hetzelfde type) met opeenvolgende
Volgnummers
beschikbaar zijn, kan de geldigheidstermijn van de oudere lijst worden vastgesteld. Dat helpt bij de interpretatie van audit logs of foutopsporing. - Lijsten kunnen uniek worden geïdentificeerd. Dit kan aan de hand van
Volgnummer
ofTijdstempel
, waarbijVolgnummer
voor menselijke gebruikers vaak de meest intuïtieve zal zijn. - Per lijst kan worden nagegaan wanneer de laatste mutatie heeft plaatsgevonden. Dit zal in de regel een 'functionele' mutatie betreffen, geen foutherstel. Hieruit kan door vergelijking van opeenvolgende versies worden afgeleid wanneer de actuele lijst voor het laatst is gewijzigd; dat kan zinvol zijn bij het beoordelen van de effecten van changes of bij foutopsporing.
- Wanneer twee lijsten (van hetzelfde type) met opeenvolgende
Tijdstempel
bestaat uit Datum, Tijd en Tijdzone-aanduiding, gebaseerd opxs:dateTime
-type. Door voor een native XML-datatype te kiezen, wordt de implementatie vergemakkelijkt. Er geldt wel een restrictie op het element, dat afdwingt dat er altijd een Tijdzone-aanduiding wordt meegegeven.- Voor de Catalogus geldt een uitzondering, en wordt gebruikgemaakt van een uitdrukking van de lokale Nederlandse datum (
xs:date
-type zonder tijdzone-aanduiding).
- Voor de Catalogus geldt een uitzondering, en wordt gebruikgemaakt van een uitdrukking van de lokale Nederlandse datum (
Namespaces
Voor de aanduiding van namespaces wordt gebruikgemaakt van een URL. Dit is de gemakkelijkste optie, omdat dit - anders dan bij een URN - geen namespaceregistratie bij IANA vereist. De namespace-URL kent de volgende opbouw: xmlns://afsprakenstelsel.medmij.nl/[naamLijst|naamRapport|"catalogus"]/release[releasenummer]
.
- Een namespace-URL gebruikt
xmlns://
als schema-aanduiding. Daarmee wordt duidelijk gemaakt dat het slechts een identificatie betreft, en dat de URL niet is bedoeld voor dereferencing (bijvoorbeeld om het XML-schema te downloaden). - Het domein
afsprakenstelsel.medmij.nl
is een unieke hostname op het internet. Gebruik daarvan biedt zowel voldoende herkenbaarheid als uniciteit. - De
naamLijst
kent één van de volgende waarden:Whitelist
,OAuthclientlist
,Zorgaanbiederslijst
ofGegevensdienstnamenlijst
. - De
naamRapport
kent één van de volgende waarden:Beheerrapport
ofPortabiliteitsrapport
. - De aanduiding
release
is toegevoegd voor de menselijke leesbaarheid en daarmee duidelijkheid.
Waar het metamodel geen namen heeft gedefinieerd, kiezen we om redenen van consistentie en elegantie voor lowercase in de opbouw van de URL. Er wordt gebruikgemaakt van elementFormDefault
= "qualified
". Dit vergroot de leesbaarheid van de XML-schema's omdat er geen prefixes nodig zijn bij het definiëren van elementen, en doet niet af aan enige functionaliteit . De prefixes voor de namespaces worden omwille van de leesbaarheid van de XML-schema's zo kort mogelijk gehouden, bestaan altijd uit drie letters en zijn geheel in lowercase. Onderstaande tabel geeft weer bij welke lijst of rapport welke prefix wordt gebruikt.
Pagina XML-bestanden voor lijsten (aanpassing)
De XML-bestanden waarmee MedMij Beheer de Zorgaanbiederslijst, de Whitelist, de OAuth Client List en de Gegevensdienstnamenlijst en de Catalogus ontsluit voldoen aan enkele eisen, zodat PGO Server, Authorization Server en MedMijNode en anderen weten waarop zij kunnen rekenen voor de goede verwerking van deze lijsten.
1. Het XML-bestand van de Zorgaanbiederslijst heet MedMij_Zorgaanbiederslijst.xml
. Het XML-bestand van de Whitelist heet MedMij_Whitelist.xml
. Het XML-bestand van de OAuth Client List heet MedMij_OAuthclientlist.xml
. Het XML-bestand van de Gegevensdienstnamen heet MedMij_Gegevensdienstnamenlijst.xml
. Het XML-bestand van de Catalogus heet MedMij_Catalogus.xml
.
XML-bestand Catalogus (nieuw)
Noot voor eindredactie
De definitieve versie van het XML-bestand van de Catalogus volgt later. Bij deze RFC is een voorbeeld opgenomen.
De versie van de Catalogus maakt geen onderdeel uit van de bestandsnaam/URL, zodat de verwijzing altijd plaatsvindt naar de meest actuele versie.
Alle gegevensdiensten (volledige historie) worden geconverteerd en opgenomen in de nieuwe structuur. Daarbij wordt uitgegaan van de actuele versie van de Catalogus. Eerdere versies worden genegeerd.
Waar nodig wordt ook informatie uit de actuele versie van het Register van Informatiestandaarden betrokken. Bij concepten die voorkomen in zowel de Catalogus als het Register, is de Catalogus leidend.
Bij de conversie van gegevensdiensten die ten tijde van publicatie van release 1.3.0 niet meer geldig zijn, wordt de waarde "Pre-1.2.0" gehanteerd als InterfaceversieId. Voor die gegevensdiensten gold dat er geen specifieke koppeling met een interfaceversie was en er dus vanuit kan worden gegaan dat gebruik met elke interfaceversie voor 1.2.0 mogelijk was, zolang zowel de Gegevensdienst als de interfaceversie/versie van de afsprakenset tegelijkertijd geldig waren. Voor de overige (actueel geldige) Gegevensdiensten geldt ten tijde van publicatie van release 1.3.0 dat ervan uit wordt gegaan dat zij zowel met interfaceversie 1.2.0 als met interfaceversie 1.3.0 gebruikt kunnen worden, en dat in de Catalogus beide interfaceversies dus aan de gegevensdienst worden gekoppeld.
Voor alle Gegevensdiensten wordt een Ondersteuningsloket toegevoegd. Binnen die set worden bij elke systeemrol de kanalen als volgt gevuld:
- Ondersteuningsorganisatienaam =
MedMij-loket
- Telefoonnummer =
+31703173434
- Emailadres =
info@medmij.nl
- Webpagina =
https://www.medmij.nl
Voor alle GegevensdienstSysteemrollen wordt Kwalificatieloket als volgt gevuld:
- Kwalificerendeorganisatienaam =
Nictiz Kwalificatiecentrum
Het attribuut Vervangt wordt bij alle Gegevensdiensten verwijderd.
De Majorminorversie van een Transactie is aangevuld; het Register en de Catalogus bevatten dit concept eerder niet. Er is gebruikgemaakt van de release van de publicatie van Nictiz-standaarden die binnen MedMij worden gebruikt, omdat die het duidelijkst versies van Transacties van elkaar onderscheiden.
De Technischespecificatieverwijzing van een Transactie is aangevuld; het Register en de Catalogus bevatten dit concept eerder niet.
Met betrekking tot specifieke elementen:
- De systeemrollen behorend bij de Gegevensdienst "Verzamelen Basisgegevens zorg 1.0" kwamen niet voor in het Register. In de nieuwe Catalogus zal worden verwezen naar publicatie 2018.01 van Nictiz; de meest recente publicatie waarin de systeemrolcodes behorend bij de Gegevensdienst voorkomen.
- De Gegevensdienstnamen "Verzamelen Medicatieoverzichten 9.0" en "Verzamelen Medicatiegegevens 9.0" kwamen elk voor bij twee Gegevensdiensten, terwijl de naam uniek hoort te zijn. Om de uniciteit te herstellen wijzigen de Gegevensdienstnamen van de Gegevensdiensten met id's 2 en 3 in "Verzamelen Medicatieoverzichten 9.0 (2018.06)" respectievelijk "Verzamelen Medicatiegegevens 9.0 (2018.06)".
Omdat de conversie niet volledig neutraal verloopt, zal de eerste uitgave van de nieuwe Catalogus leiden tot ophoging van het versienummer.
N.B. In de Gegevensdienstnaam en Weergavenaam van enkele Gegevensdiensten komt nu een (*)
voor. Het gebruik hiervan is niet meer nodig om Gegevensdienstnamen uniek te houden, omdat de vaste opbouw van de Gegevensdienstnaam verdwijnt en er daarmee ruimte is om eventuele naamconflicten op verschillende manieren op te lossen, of te voorkomen dat zij ontstaan (bijvoorbeeld door de gehele Majorminorversie van de Informatiestandaard op te nemen en niet alleen de eerste twee delen). Het gebruik van (*)
is evenwel wel toegestaan onder de nieuwe regels. Daarom wordt er geen wijziging aangebracht bij de conversie.
Noot voor eindredactie
De publicatieplaats van het XML-bestand van de Catalogus wordt door het eindredactieteam bepaald en het team publiceert daar ook de definitieve versies van het bestand. Van belang is dat dit een (herkenbare) permalink is in het medmij.nl-domein, met https als "scheme", waarbij de bestandsnaam MedMij_Catalogus.xml
is, en er geen query-of fragment-onderdeel in de URL voorkomt.
Opmerking van eindredactie: De publicatieplaats is nog niet gereed. Als tijdelijke oplossing wordt het XML-bestand als attachment bij de Catalogus in Confluence gepubliceerd.
Publicatie XML-bestanden (nieuw)
Publicatie van het XML-bestand vindt plaats op een nader (door de eindredactie) te bepalen permalink op (*).MedMij.nl (openbaar toegankelijk). Van belang is dat dit een (herkenbare) permalink is in het medmij.nl-domein, met https als "scheme", waarbij de bestandsnaam onderdeel is van de URL en gelijk is aan MedMij_Catalogus.xml
, en er geen query- of fragment-onderdeel in de URL voorkomt.
Sluit daarbij waar mogelijk aan bij de publicatiewijze van de AKL zoals gedefinieerd in RFC0017 Koppelen van Zorgaanbiedersnamen (ter consultatie).
Historische, eerder geldige versies van het XML-bestand van de Catalogus blijven beschikbaar in een archief op Confluence.
Historische releases van de XSD blijven gepubliceerd als onderdeel van het archief van een bepaalde release van de afsprakenset.
Oplegger/introductie afsprakenstelsel (aanpassing)
(Equivalente pagina in release 1.2.0: https://vzvz.atlassian.net/wiki/display/MedMijAfsprakenstelsel120/MedMij+Afsprakenstelsel+1.2.0)
- De beheerorganisatie onderhoudt
twee registerseen Catalogus die relevantzijnis voor de dienstverlening die via het MedMij-netwerk kan worden aangeboden.Het Register van Informatiestandaarden bevat de toegelaten informatiestandaarden.De Catalogus definieert welke Gegevensdiensten deelnemers kunnen ontsluitenaanbieden. - Verwijderen tabelrij "Register van Informatiestandaarden".
Gegevensdienstenbeleid (aanpassing)
De aanpassingen in het Gegevensdienstenbeleid zijn geïntegreerd in de uitwerking van RFC0024 Harmonisatie Gegevensdiensten- en Stelselbeleid.
Testbeleid (aanpassing)
Voor (C) geldt dat in de Catalogus te vinden is welke Informatiestandaard bij een Gegevensdienst hoort en in het Register van Informatiestandaarden bij de Informatiestandaard vervolgens is opgenomen waar de ondersteuning van de Systeemrollen behorend bij een Gegevensdienst kan worden aangetoond.
Catalogus: toelichting (aanpassing)
Actuele Catalogus
|
|
|
|
---|---|---|---|
Algemene toelichting
De Catalogus bevat de Gegevensdiensten die over het MedMij-netwerk kunnen worden ontsloten. De Catalogus wordt formeel gepubliceerd in XML-formaat (hier te vinden). Een gebruiksvriendelijke weergave is te vinden op de pagina /wiki/spaces/MMCatalogus/pages/159187749. Een gebruiksvriendelijke weergave is te vinden op de pagina Actuele catalogus.
Noot voor eindredactie
Op de pagina Actuele Catalogus zorgdragen voor een goede human-readable weergave (zie elders in deze RFC).
De te gebruiken CSS-stylesheet voor de tabel:
De te gebruiken XML-stylesheet voor het genereren van de human-readable versie:
in een spreadsheet weergegeven als een (niet-genormaliseerde) tabel. Het is een implementatie van het logisch model van de Catalogus. Er is gekozen voor het open bestandsformaat OpenDocument Spreadsheet (ODS) omdat hiermee aansluiting wordt gezocht bij een reeds beschikbare en open norm.
De Systeemrollen waaruit een Systeemrolverzameling bestaat zijn onderdeel van het Register van Informatiestandaarden. Voor informatieve doeleinden bevat de spreadsheet ook enkele klassen uit het Register van Informatiestandaarden. Ook is ter informatie de Deelnemersrol weergegeven; deze volgt echter niet uit de Catalogus, maar uit de invarianten van het metamodel. Wanneer mutaties worden doorgevoerd binnen een reeds gedefinieerde Gegevensdienst, wordt dit aangegeven onder de kolommen bij Wijzigingsbeheer. Ter vergroting van de leesbaarheid is een Datum aanmaak opgenomen, zodat wijzigingen in de Catalogus (toevoegingen dan wel mutaties) gemakkelijk zichtbaar zijn.
Wijzigingen in de Catalogus kunnen op grond van het Gegevensdienstenbeleid plaatsvinden onafhankelijk van releases van het afsprakenstelsel. Het bestuur van de Stichting MedMij stelt (wijzigingen in) de Catalogus vast.
Actuele Catalogus: pagina (nieuw)
Voor de gebruiksvriendelijke weergave van de actuele Catalogus moet:
- een nieuwe pagina op Confluence worden aangemaakt, in de space Catalogus;
- op deze pagina een macro worden gebruikt;
- de stylesheet voor de Catalogus-space worden aangevuld;
- een XSL-stylesheet worden toegevoegd;
- een plugin worden geïnstalleerd en geconfigureerd.
Noot voor eindredactie
Deze aanpassingen kunnen in overleg met de RFC-eigenaar worden gedetailleerd. De benodigde informatie is grotendeels gereed (stand 22 oktober 2010).
Noot van eindredactie: gebruik van de plug-in wordt nog bestudeerd, tot die tijd wordt een statische publicatie van de human-readable versie verzorgd.
Releasebeheer
Bij een wijziging in de Catalogus wordt het releasenummer met één opgehoogd.
De spreadsheet krijgt daarnaast een versienummer mee. Het versienummer is een geheel getal en wordt bij elke wijziging in het bestand met één opgehoogd. Met behulp van versienummering kunnen bestandsversies gedurende de ontwikkeling uit elkaar worden gehouden. Het nummer is ook aanwezig in productieversies. De versienummering is, om redenen van eenvoud en duidelijkheid, onafhankelijk van de releasenummering van de Catalogus.
De Catalogus bevat ook Gegevensdiensten die inmiddels niet meer geldig zijn, omdat de einddatum van de geldigheidsperiode is gepasseerd. Door deze Gegevensdiensten te blijven vermelden wordt op een gemakkelijke wijze inzage geboden in de historie van Gegevensdiensten (bijvoorbeeld ten behoeve van het interpreteren van loggegevens). Het voorkomt ook dat de Catalogus (een op dit moment handmatig beheerd en gepubliceerd product) aanpassing behoeft op het moment van het verstrijken van de geldigheid van een Gegevensdienst. Gegevensdiensten die al bij publicatie van de betreffende versie van de Catalogus ongeldig waren, hebben voor de overzichtelijkheid een grijze achtergrond.
Toelichting bij inhoud van de Catalogus
De volgende Gegevensdiensten vereisen of vervangen een andere Gegevensdienst:
- Gegevensdiensten 43 en 45 en Gegevensdiensten 59 en 60 vereisen elkaar paarsgewijs, omdat het Verzamelen van een verwijzing naar een vragenlijst en het Delen van de ingevulde vragenlijst vast deel uitmaken van hetzelfde gebruikersproces.
Gegevensdienst 31 vervangt Gegevensdienst 35 omdat Gegevensdienst 35 geïntroduceerd is als tijdelijke tussenstap richting Gegevensdienst31. Een Dienstverlener zorgaanbieder mag deze Gegevensdiensten niet tegelijkertijd ontsluiten voor een Zorgaanbieder, omdat de Gegevensdiensten niet te onderscheiden zijn voor de Zorggebruiker.
In de Catalogus staan bij een Gegevensdienst de Systeemrolcodes die bij de Gegevensdienst betrokken zijn. De volgorde waarin die Systeemrolcodes bij een Gegevensdienst staan opgesomd is formeel om het even, maar voor de presentatie wel relevant. Die volgorde van presentatie komt overeen met de tijdsvolgorde waarin de betreffende Systeemrollen hun werk moeten doen, dat wil zeggen:
Raadplegen (te herkennen aan de suffix...R-FHIR
) vóór Beschikbaar stellen (te herkennen aan de suffix...B-FHIR
);Sturen (te herkennen aan de suffix...S-FHIR
) vóór Ontvangen (te herkennen aan de suffix...O-FHIR
);bij meerdere transacties: in tijdsvolgorde van transactie.
Toelichting bij versie 23 van de Catalogus (mutatiedatum: 30-10-2020)
- De Systeemrollen behorend bij de Gegevensdienst "Verzamelen Basisgegevens zorg 1.0" kwamen niet voor in het Register van Informatiestandaarden. In de Catalogus zijn deze nu wel opgenomen en is verwezen naar publicatie 2018.01 van Nictiz; de meest recente publicatie waarin de systeemrolcodes behorend bij de Gegevensdienst voorkomen.
- De Catalogus heeft een herziene opzet. Daarmee is ook het afzonderlijke Register van Informatiestandaarden vervallen. Enkele relevante concepten uit het voormalige Register zijn opgenomen in de Catalogus. Het attribuut Vervangt van een Gegevensdienst is verwijderd.
- De Technischespecificatieverwijzingen zijn toegevoegd aan de Transacties behorend bij Systeemrollen.
- De Majorminorversies zijn toegevoegd aan de Transacties behorend bij Systeemrollen.
- De Interfaceversies zijn toegevoegd aan de Gegevensdiensten.
- De Ondersteuningsloketten zijn toegevoegd aan de Gegevensdiensten.
- De Kwalificatieloketten zijn toegevoegd aan de Gegevensdiensten.
- De Gegevensdienstnamen van de Gegevensdiensten met id's 2 en 3 zijn gewijzigd in "Verzamelen Medicatieoverzichten 9.0 (2018.06)" respectievelijk "Verzamelen Medicatiegegevens 9.0 (2018.06)".
- Uitgebreidere toelichting kan worden gevonden in RFC0023 Harmonisering Register van Informatiestandaarden en Catalogus: informatiemodellen.
Archief Catalogus (aanpassen)
Toevoegen van de huidige Catalogus (versie 22) aan het Archief.
Register van Informatiestandaarden (uitfaseren)
In de plaats van het huidige Register zal een korte toelichting op de wijziging worden geplaatst met een link naar de vindplaats van de Catalogus. In die toelichting wordt aangegeven hoe de Catalogus de relevante functies van het Register heeft overgenomen, en hoe die met betrekking tot die functies moet worden gelezen en gebruikt.
De doorverwijzing blijft ten minste twee jaar in stand. Daarna mag de pagina van het Register geheel worden verwijderd.
Beheerinstructies (aanpassing)
Toevoegen van het volgende aan bestaande beheerinstructies, of creëren van een nieuw overzicht met daarin:
- Wanneer gedurende de periode dat release 1.2.0 gebruikt mag worden, een Gegevensdienst geldig wordt die alleen met Interfaceversie 1.3.0 gebruikt kan worden, is een toelichting benodigd voor gebruikers van 1.2.0: niet de gehele Catalogus is dan voor hen van toepassing.
- Voordat een nieuwe versie van het XML-bestand van de Catalogus wordt gepubliceerd, moet die worden gevalideerd tegen het XML-schema van de Catalogus en moet die worden gecontroleerd tegen de regels op de pagina /wiki/spaces/MedMijAfsprakenstelsel112/pages/134710553.
- Voordat een nieuwe versie van het XML-bestand van de Catalogus wordt gepubliceerd, moet de vorige versie worden opgenomen in het openbaar toegankelijke archief van de Catalogus.
- Historische releases van het XML-schema van de Catalogus blijven gepubliceerd op de publicatieplaats, zonder wijziging van de permalink.
Risico's
Er zijn geen significante nettorisico's (risico's die resteren na volledige doorvoering van deze RFC, dus inclusief maatregelen die al in de RFC zelf zijn opgenomen) onderkend.
Bijlagen