Codelist Bindings: verschil tussen versies
(→Over deze informatie) |
(→Criteria wanneer geen ‘OTH’ bij binding ‘Required’ gebruikt mag worden) |
||
(11 tussenliggende versies door 2 gebruikers niet weergegeven) | |||
Regel 44: | Regel 44: | ||
Voorbeeld van een waardenlijst met binding ‘Extensible’: [[Contactpersoon-v3.4(2020NL)#RolCodelijst | RolCodelijst]] in zib Contactpersoon. | Voorbeeld van een waardenlijst met binding ‘Extensible’: [[Contactpersoon-v3.4(2020NL)#RolCodelijst | RolCodelijst]] in zib Contactpersoon. | ||
+ | |||
+ | ==Additionele bepalingen bij het uitbreiden van waardenlijsten== | ||
+ | ===Uitbreiden bij binding ‘Extensible’=== | ||
+ | Bij waardenlijst met binding Extensible’ wordt de uitbreidingsmogelijkheid, met in achtneming van hetgeen hierboven vermeld is, altijd beperkt tot codes uit hetzelfde codestelsel dat voor de codes uit die waardenlijst wordt gebruikt. | ||
+ | ===Uitbreiden met waarde 'Anders'=== | ||
+ | Binnen waardenlijsten mag naast de genoemde waardenlijst ook de waarde ‘OTH’ uit het ‘NullFlavor’ codestelsel (en alleen ‘OTH’) gebruikt worden. De ‘OTH’ waarde mag gebruikt worden als een concept niet voorkomt in het voorgeschreven codestelsel. Dit geldt voor zowel ‘Extensible’ als ‘Required’ bindings behalve voor een aantal gevallen die hieronder beschreven zijn. | ||
+ | ====Criteria wanneer geen ‘OTH’ bij binding ‘Required’ gebruikt mag worden==== | ||
+ | De waarde ‘OTH’ mag niet worden toegevoegd aan een waardenlijst met binding ‘Required’ onder de volgende condities: | ||
+ | #Als de waardenlijst onderdeel is van de groep Scorelijst en het toevoegen van een waarde voor een ongeldige score zal zorgen. | ||
+ | #Voor status en code lijsten waarbij deze lijsten in de praktijk uitgebreider of anders zouden kunnen worden gepresenteerd, maar waarbij de lijst zelf voor eenheid van taal moet zorgen binnen het concept. Bijvoorbeeld lijstjes die een Ernst (Licht, Matig, Ernstig) representeren. | ||
+ | #Waardenlijst waar het concept ‘OTH’ al op een andere manier in de waardenlijst staat. | ||
+ | Waardenlijsten (uit zibs 2020) voldoen aan bovenstaande condities en geen ‘OTH’ mogen bevatten [[File:PDF.png|link=Special:Redirect/file/Waardenlijsten_waar_'Oth'_niet_toegestaan_is_v1_0_0.pdf]] | ||
+ | |||
+ | ==Beperkte waardenlijst== | ||
+ | In specifieke gevallen kan een waardenlijst van een bouwsteen (basis waardenlijst) waarnaar wordt verwezen vanuit een andere bouwsteen beperkt worden (beperkte waardenlijst). Zo’n beperking moet worden gezien als een aanwijzing voor systeembouwers of UI-ontwikkelaars dat men bij het ontwikkelen dit lijstje als eerste uitgangspunt kan nemen. Dit betekent echter niet dat deze beperking de overige codes uitsluit. In het geval de binding van basis waardenlijst ‘Required’ is en de beperkte waardenlijst ‘Extensible’ is dan mag men deze waardenlijst niet verder uitbreiden dan tot wat de basis waardenlijst voorschrijft.<br> | ||
+ | Ter illustratie de bouwsteen MedischHulpmiddel bevat de basis waardenlijst ProductType (‘Required binding’). De bouwsteen FunctieZien verwijst naar ProductType maar neemt daarbij een beperkte waardenlijst voor ProductType op, de ZienHulpmiddelTypeCodelijst (‘Extensible’ Binding). Deze bevat alleen waarden die waarschijnlijk relevant zijn bij FunctieZien. Bij het gebruik van FunctieZien is de ZienHulpmiddelTypeCodelijst lijst het startpunt, bevat die echter niet de gevraagde codes dan mag men deze uitbreiden tot maximaal de basis waardenlijst van ProductType uit MedischHulpmiddel. | ||
+ | Bij gebruik in uitwisselingsstandaarden (zoals HL7 FHIR), zal men altijd de basiswaardenlijst moeten opnemen. Binnen de Zibs ontbreekt momenteel een formalisme voor beperkte waardenlijsten waardoor de ‘Extensible’ binding wordt gebruikt voor beperkte waardenlijsten. | ||
==Over deze informatie== | ==Over deze informatie== | ||
Regel 52: | Regel 69: | ||
|Publicatiedatum:||'''19-03-2021''' | |Publicatiedatum:||'''19-03-2021''' | ||
|- | |- | ||
− | |Versie:||'''1.0''' | + | |Versie:||'''1.0''' (onder revisie) |
|- | |- | ||
|Status:||'''Definitief''' | |Status:||'''Definitief''' | ||
|- | |- | ||
− | |Downloads:|| '''[[Media:Notitie binding bij waardelijsten v1.0.pdf |Binding van waardenlijsten ]]''' [[File:PDF.png|link=:Notitie binding bij waardelijsten v1.0.pdf]] | + | |Downloads:|| '''[[Media:Notitie binding bij waardelijsten v1.0.pdf |Binding van waardenlijsten ]]''' [[File:PDF.png|link=Special:Redirect/file/Notitie binding bij waardelijsten v1.0.pdf]] |
|} | |} |
Huidige versie van 6 jul 2023 om 21:44
Beschikbare achtergrondinformatie
Inhoud
Inleiding
In Pre-publicatie 2018-1 is het attribuut ‘binding’ bij waardenlijsten in de zibs geïntroduceerd.
De binding geeft aan in welke mate het gebruik van de in de waardenlijst opgenomen waarden verplicht is voor het concept waar de waardenlijst bij hoort. Omdat in de zibs waardenlijsten uniek zijn en niet hergebruikt worden, wordt deze binding aangegeven bij de waardenlijst en niet bij het bijbehorende concept.
De vulling van de binding is bij Pre-publicatie 2018-2 pragmatisch en relatief snel gedaan. Bij Publicatie 2020 zijn de bindingswaarden opnieuw geëvalueerd en waar nodig aangepast.
Dit memo is een beschrijving van de criteria voor de vaststelling van de waarde van binding, die daarbij zijn toegepast. Deze criteria gelden vanaf nu ook voor het vaststellen van de waarde van de bindings bij zowel nieuwe zibs en nieuwe waardenlijsten bij bestaande zibs, als bij het aanpassen (wijzigen) van de binding van bestaande.
De mogelijke waarden van de binding zijn in lijn met de waarden die o.a. in HL7 FHIR worden toegepast. De volgende vier, ook in FHIR gedefinieerde, waarden zijn mogelijk (uit https://www.hl7.org/fhir/valueset-binding-strength.html):
- Required: To be conformant, the concept in this element SHALL be from the specified value set
- Extensible: To be conformant, the concept in this element SHALL be from the specified value set if any of the codes within the value set can apply to the concept being communicated. If the value set does not cover the concept (based on human review), alternate codings (or, data type allowing, text) may be included instead.
- Preferred: Instances are encouraged to draw from the specified codes for interoperability purposes but are not required to do so to be considered conformant.
- Example: Instances are not expected or even encouraged to draw from the specified value set. The value set merely provides examples of the types of concepts intended to be included.
In de zibs wordt daarnaast een additionele waarde gehanteerd:
- Deprecated: De gehele waardenlijst is niet meer geldig. Deze waarde wordt gehanteerd als een in eerdere versies van de zib geldige lijst uit gefaseerd is ten gunste van een nieuwe waardenlijst. Daarbij worden, ten behoeve van de continuïteit, in de publicatie, waarin de nieuwe waardenlijst voor het eerst geïntroduceerd wordt, éénmalig beide lijsten opgenomen.
Daarnaast geldt het volgende voor waardenlijsten, zoals ze gebruikt worden in de zibs:
Alle waardenlijsten zijn statisch, behalve waardenlijsten die expliciet naar een heel codestelsel, middels een expressie naar een codestelsel deel of naar een SNOMED CT refset verwijzen.
Deze waardenlijsten zijn dynamisch. Hierbij dient dus (bij voorkeur) de meest recente versie gehanteerd te worden.
Criteria voor binding bij waardenlijsten in de zib
Bij het toepassen van het attribuut ‘binding’ bij de waardenlijsten in zibs worden vooralsnog alleen de bindingscodes Required en Extensible gebruikt.
In de zib blauwdrukken wordt ook de bindingcode Example toegepast.
Criteria voor toepassen binding 'Required':
- Waardenlijst bevat alle mogelijke waarden (Links, rechts, beide zijden)
- Waardenlijst bevat een heel codestelsel of een hele (SNOMED CT) tak (er valt dan niets uit te breiden).
- Waardenlijst bevat codes uit 'eigen', door het zib-centrum vastgesteld, codestelsel dat alle gedefinieerde waarden bevat, dus toevoegen uit zelfde codestelsel is dan niet mogelijk.
- Waardenlijst bevat keuzes die bewust zijn ingeperkt, hetzij omdat het een score instrument betreft hetzij omdat dat bij het maken van de zib afgesproken is.
- Indien bij waardenlijsten met binding 'Required' gewenste codes ontbreken, kan een issue worden ingediend om deze toe te voegen.
Voorbeeld van een waardenlijst met binding ‘Required’: ProbleemStatusCodelijst in zib Probleem
Noot: In sommige zibs, b.v. AllergieIntolerantie, zijn aan één concept meerdere waardenlijsten gekoppeld die op zich alle naar een geheel codestelsel verwijzen. In dat geval hebben al deze codelijsten conform de criteria hierboven een binding ‘Required’. Dit betekent niet dat ze allemaal tegelijk verplicht zijn, maar dat er bij gebruik in een informatie standaard gekozen moet worden en dat die waardenlijst om reden hierboven genoemd, niet uitbreidbaar is. Het gebruik van een andere binding zou foutief de indruk kunnen wekken dat er ook een totaal ander codestelsel gekozen zou kunnen worden.
Criteria voor toepassen binding 'Extensible':
- Codelijst bevat een niet uitputtende lijst, die als startlijst bedoeld is. Gebruik van andere codes van gelijksoortige concepten uit hetzelfde codestelsel is toegestaan. M.a.w. als de lijst uit codes uit de subset voor lichaamsstructuur (in e.g. SNOMED CT) bestaat, dienen de andere extra codes ook een uit die subset te komen. Bij communicatie is geen garantie dat de ontvanger de code kent en kan interpreteren. Het verdient aanbeveling om, indien deze codes vaak gebruikt worden, een issue in te dienen om deze aan de waardenlijst toe te voegen.
Voorbeeld van een waardenlijst met binding ‘Extensible’: RolCodelijst in zib Contactpersoon.
Additionele bepalingen bij het uitbreiden van waardenlijsten
Uitbreiden bij binding ‘Extensible’
Bij waardenlijst met binding Extensible’ wordt de uitbreidingsmogelijkheid, met in achtneming van hetgeen hierboven vermeld is, altijd beperkt tot codes uit hetzelfde codestelsel dat voor de codes uit die waardenlijst wordt gebruikt.
Uitbreiden met waarde 'Anders'
Binnen waardenlijsten mag naast de genoemde waardenlijst ook de waarde ‘OTH’ uit het ‘NullFlavor’ codestelsel (en alleen ‘OTH’) gebruikt worden. De ‘OTH’ waarde mag gebruikt worden als een concept niet voorkomt in het voorgeschreven codestelsel. Dit geldt voor zowel ‘Extensible’ als ‘Required’ bindings behalve voor een aantal gevallen die hieronder beschreven zijn.
Criteria wanneer geen ‘OTH’ bij binding ‘Required’ gebruikt mag worden
De waarde ‘OTH’ mag niet worden toegevoegd aan een waardenlijst met binding ‘Required’ onder de volgende condities:
- Als de waardenlijst onderdeel is van de groep Scorelijst en het toevoegen van een waarde voor een ongeldige score zal zorgen.
- Voor status en code lijsten waarbij deze lijsten in de praktijk uitgebreider of anders zouden kunnen worden gepresenteerd, maar waarbij de lijst zelf voor eenheid van taal moet zorgen binnen het concept. Bijvoorbeeld lijstjes die een Ernst (Licht, Matig, Ernstig) representeren.
- Waardenlijst waar het concept ‘OTH’ al op een andere manier in de waardenlijst staat.
Waardenlijsten (uit zibs 2020) voldoen aan bovenstaande condities en geen ‘OTH’ mogen bevatten
Beperkte waardenlijst
In specifieke gevallen kan een waardenlijst van een bouwsteen (basis waardenlijst) waarnaar wordt verwezen vanuit een andere bouwsteen beperkt worden (beperkte waardenlijst). Zo’n beperking moet worden gezien als een aanwijzing voor systeembouwers of UI-ontwikkelaars dat men bij het ontwikkelen dit lijstje als eerste uitgangspunt kan nemen. Dit betekent echter niet dat deze beperking de overige codes uitsluit. In het geval de binding van basis waardenlijst ‘Required’ is en de beperkte waardenlijst ‘Extensible’ is dan mag men deze waardenlijst niet verder uitbreiden dan tot wat de basis waardenlijst voorschrijft.
Ter illustratie de bouwsteen MedischHulpmiddel bevat de basis waardenlijst ProductType (‘Required binding’). De bouwsteen FunctieZien verwijst naar ProductType maar neemt daarbij een beperkte waardenlijst voor ProductType op, de ZienHulpmiddelTypeCodelijst (‘Extensible’ Binding). Deze bevat alleen waarden die waarschijnlijk relevant zijn bij FunctieZien. Bij het gebruik van FunctieZien is de ZienHulpmiddelTypeCodelijst lijst het startpunt, bevat die echter niet de gevraagde codes dan mag men deze uitbreiden tot maximaal de basis waardenlijst van ProductType uit MedischHulpmiddel.
Bij gebruik in uitwisselingsstandaarden (zoals HL7 FHIR), zal men altijd de basiswaardenlijst moeten opnemen. Binnen de Zibs ontbreekt momenteel een formalisme voor beperkte waardenlijsten waardoor de ‘Extensible’ binding wordt gebruikt voor beperkte waardenlijsten.
Over deze informatie
Uitgegeven door: | Zib-centrum Nictiz |
Publicatiedatum: | 19-03-2021 |
Versie: | 1.0 (onder revisie) |
Status: | Definitief |
Downloads: | Binding van waardenlijsten ![]() |