Ihevs:Vokabular-Management
Tidris (Diskussion | Beiträge) (→Vokabular-Management) |
Foemig (Diskussion | Beiträge) (Kommentarauflösung) |
||
| Zeile 1: | Zeile 1: | ||
{{DocumentPart}} | {{DocumentPart}} | ||
=Vokabular-Management= | =Vokabular-Management= | ||
| − | |||
| − | |||
| − | Ein Value Set ist eine eindeutige identifizierbare Sammlung von Konzeptrepräsentationen und es ist einer oder mehreren Konzeptdomänen zugeordnet. Ein Value Set kann Codes aus einem oder mehreren Kodiersystemen enthalten. Ein Kodiersystem wird dabei durch eine Liste von Codes mit zugehörigen Anzeigenamen und Beschreibungen definiert. Innerhalb eines Kodiersystems muss ein Code eine eindeutig definierte Bedeutung haben. | + | Die Übermittlung von konkreten Daten kann auf zweierlei Art und Weise erfolgen: Die einfachste Variante ist Freitext, bei der beliebige Daten - als Zeichenkette (ggf. noch eingeschränkt auf einen bestimmten Datentyp) - übertragen werden. Dieses Verfahren bietet sich an, wenn die individuelle Ausprägung sehr unterschiedlich sein kann wie bspw. dem Namen des Patienten oder ein Kommentar. Für immer wiederkehrende und im Prinzip gleiche Information - wie bspw. der Familienstand - werden die zu übertragenden Daten abgekürzt und durch einen "Platzhalter" ersetzt. Bei letzterem muss die Bedeutung aber klar sein. Hierfür werden Kodesysteme definiert, die sowohl die Abkürzungen - Kodes - als auch die Bedeutung auflisten. Die Zuordnung von einzelnen Feldern in einer Datenaustauschspeziifkation zu konkreten Wertelisten erfolgt mehrstufig: Die Festlegung der erlaubten Werte für ein kodiertes Attribut erfolgt über die Angabe von sog. Konzept- oder Vokabeldomänen (''Concept / Vocabulary Domains''), Kodiersystemen (''Code Systems'') und Wertemengen (''Value Sets''). |
| + | |||
| + | Eine '''Konzeptdomäne''' dient dazu, den Wertebereich eines Attributs einzugrenzen ohne dabei direkt schon feste Kodiersysteme oder Value Sets vorzugeben. Eine Konzeptdomäne wird durch einen Namen, eine textuelle Beschreibung sowie eine Reihe von Beispielkonzepten definiert. Zum Beispiel soll die Konzeptdomäne DocumentEntry.typeCode den Typ eines Dokuments aus Benutzersicht kodieren. | ||
| + | |||
| + | Ein '''Value Set''' ist eine eindeutige identifizierbare Sammlung von Konzeptrepräsentationen und es ist einer oder mehreren Konzeptdomänen zugeordnet. Ein Value Set kann Codes aus einem oder mehreren Kodiersystemen enthalten. Ein '''Kodiersystem''' wird dabei durch eine Liste von Codes mit zugehörigen Anzeigenamen und Beschreibungen definiert. Innerhalb eines Kodiersystems muss ein Code eine eindeutig definierte Bedeutung haben. | ||
Value Sets können in unterschiedlicher Art und Weise definiert werden: ''extensional'' als Sammlungen von Codes (Konzepten) oder ''intensional'' über einen berechenbaren Ausdruck, aus dem sich eine Codeliste exakt ermitteln lässt. Die Value Sets für DocumentEntry.typeCode und DocumentEntry.classCode in diesem Leitfaden sind beispielsweise extensional als Listen definiert, während das Value Set für DocumentEntry.formatCode intensional über Konstruktionsvorschriften für URNs definiert wurde. | Value Sets können in unterschiedlicher Art und Weise definiert werden: ''extensional'' als Sammlungen von Codes (Konzepten) oder ''intensional'' über einen berechenbaren Ausdruck, aus dem sich eine Codeliste exakt ermitteln lässt. Die Value Sets für DocumentEntry.typeCode und DocumentEntry.classCode in diesem Leitfaden sind beispielsweise extensional als Listen definiert, während das Value Set für DocumentEntry.formatCode intensional über Konstruktionsvorschriften für URNs definiert wurde. | ||
| Zeile 10: | Zeile 12: | ||
Wenn ein Value Set neben den genannten oder beschriebenen Codes zusätzliche Werte erlaubt, wird es als offen (''open'') bezeichnet, andernfalls als geschlossen (''closed''). Das Value Set für DocumentEntry.languageCode ist beispielsweise offen, da neue Sprachcodes gebildet und wenn notwendig auch verwendet werden können. Die Value Sets für DocumentEntry.classCode und DocumentEntry.healthcareFacilityTypeCode sind hingegen geschlossen. Das heißt, dass eine Erweiterung nur über eine neue Version der Value Sets erfolgen sollte. | Wenn ein Value Set neben den genannten oder beschriebenen Codes zusätzliche Werte erlaubt, wird es als offen (''open'') bezeichnet, andernfalls als geschlossen (''closed''). Das Value Set für DocumentEntry.languageCode ist beispielsweise offen, da neue Sprachcodes gebildet und wenn notwendig auch verwendet werden können. Die Value Sets für DocumentEntry.classCode und DocumentEntry.healthcareFacilityTypeCode sind hingegen geschlossen. Das heißt, dass eine Erweiterung nur über eine neue Version der Value Sets erfolgen sollte. | ||
| − | Die Identifikation eines Value Sets erfolgt | + | Die Identifikation eines Value Sets erfolgt bei CDA und IHE XDS über eine OID, bei FHIR über eine URL. Die Version eines Value Sets wird über einen Zeitstempel charakterisiert. Die Bindung eines kodierten Elementes an ein Value Set (Binding) kann nun dynamisch (''dynamic'') oder statisch (''static'') erfolgen. Ein dynamisches Binding bezieht sich auf die jeweils aktuellste Version eines Value Sets, während bei einem statischen Binding eine feste Version angegeben wird. Bei einem statischen Binding müssen OID bzw. ein eindeutiger Bezeichner sowie ein Zeitstempel angegeben werden. Beim dynamischen Binding fehlt der Zeitstempel. |
Unabhängig davon gibt es für das Binding von ValueSets noch weitere Unterscheidungsmöglichkeiten. Beim ''Design-Time Binding'' wird das zu verwendende Value Set explizit angegeben. Beim ''Runtime Binding'' werden nur die Konzeptdomäne und die sogenannte Realm (z.B. „Deutschland“) festgelegt. Das effektive Value Set wird dann dynamisch über einen Terminologieserver an Hand von Konzeptdomäne und Realm ermittelt. | Unabhängig davon gibt es für das Binding von ValueSets noch weitere Unterscheidungsmöglichkeiten. Beim ''Design-Time Binding'' wird das zu verwendende Value Set explizit angegeben. Beim ''Runtime Binding'' werden nur die Konzeptdomäne und die sogenannte Realm (z.B. „Deutschland“) festgelegt. Das effektive Value Set wird dann dynamisch über einen Terminologieserver an Hand von Konzeptdomäne und Realm ermittelt. | ||
| Zeile 37: | Zeile 39: | ||
|-} | |-} | ||
</div> | </div> | ||
| + | |||
| + | {{FAQBox| | ||
| + | '''Wie geht man mit Anforderungen nach Kodes um, die in den Value Sets nicht vorkommen?''' | ||
| + | |||
| + | Das hängt primär von der Erweiterbarkeit und der Bindungsstärke ab! | ||
| + | |||
| + | Value Set Vorgaben mit der Bindungsstärke "required" müssen verwendet werden. Bei "suggested" kann eine Alternative definiert werden, die dann genutzt werden kann. Allerdings ist hierbei zu beachten, dass man von einer Empfehlung abweicht und damit in zukünftigen Anbindungen Probleme bekommen kann. | ||
| + | |||
| + | Die Erweiterbarkeit zeigt an, ob das Value Set durch eigene Festlegungen ergänzt werden kann ("open") oder nicht ("closed"). Wenn Ergänzungen zugelassen sind, so ist ein eigenes Kodesystem zu definieren, das in in das Value Set mit eingebunden wird. Auf diese Weise werden die bekannten Kodes aus dem bereits vorhandenen Kodesystem eingesetzt und nur für fehlende, aber notwendige Konzepte eigene Kodes definiert. | ||
| + | |||
| + | Eine elegantere Methode ist die Kontaktaufnahme mit dem Interoperabilitätsforum, um dort die neuen Kodes für eine Aufnahme in das offizielle Value Set vorzuschlagen. Das wird dann dort diskutiert und über einen Änderungs-/Erweiterungsvorschlag in einem Abstimmungsverfahren (Ballot) abgestimmt. | ||
| + | }} | ||
| + | |||
| + | {{BestPracticeBox| | ||
| + | Wie soll verfahren werden, wenn das hier beschriebene Vorgehen nicht ganz klar ist? | ||
| + | |||
| + | Das einfachste ist eine eMail an tcs@hl7.de, in der die Frage übermittelt wird. Das Interoperabilitätsforum wird versuchen, darauf schnellstmöglich eine Antwort allgemein verfügbar bereitzustellen. | ||
| + | }} | ||
| + | |||
[[Kategorie:ihevs]] | [[Kategorie:ihevs]] | ||
Version vom 7. Oktober 2016, 13:34 Uhr
Dieses Material ist Teil des Leitfadens [[Category:|Ihevs:Vokabular-Management]].
|
Vokabular-Management
Die Übermittlung von konkreten Daten kann auf zweierlei Art und Weise erfolgen: Die einfachste Variante ist Freitext, bei der beliebige Daten - als Zeichenkette (ggf. noch eingeschränkt auf einen bestimmten Datentyp) - übertragen werden. Dieses Verfahren bietet sich an, wenn die individuelle Ausprägung sehr unterschiedlich sein kann wie bspw. dem Namen des Patienten oder ein Kommentar. Für immer wiederkehrende und im Prinzip gleiche Information - wie bspw. der Familienstand - werden die zu übertragenden Daten abgekürzt und durch einen "Platzhalter" ersetzt. Bei letzterem muss die Bedeutung aber klar sein. Hierfür werden Kodesysteme definiert, die sowohl die Abkürzungen - Kodes - als auch die Bedeutung auflisten. Die Zuordnung von einzelnen Feldern in einer Datenaustauschspeziifkation zu konkreten Wertelisten erfolgt mehrstufig: Die Festlegung der erlaubten Werte für ein kodiertes Attribut erfolgt über die Angabe von sog. Konzept- oder Vokabeldomänen (Concept / Vocabulary Domains), Kodiersystemen (Code Systems) und Wertemengen (Value Sets).
Eine Konzeptdomäne dient dazu, den Wertebereich eines Attributs einzugrenzen ohne dabei direkt schon feste Kodiersysteme oder Value Sets vorzugeben. Eine Konzeptdomäne wird durch einen Namen, eine textuelle Beschreibung sowie eine Reihe von Beispielkonzepten definiert. Zum Beispiel soll die Konzeptdomäne DocumentEntry.typeCode den Typ eines Dokuments aus Benutzersicht kodieren.
Ein Value Set ist eine eindeutige identifizierbare Sammlung von Konzeptrepräsentationen und es ist einer oder mehreren Konzeptdomänen zugeordnet. Ein Value Set kann Codes aus einem oder mehreren Kodiersystemen enthalten. Ein Kodiersystem wird dabei durch eine Liste von Codes mit zugehörigen Anzeigenamen und Beschreibungen definiert. Innerhalb eines Kodiersystems muss ein Code eine eindeutig definierte Bedeutung haben.
Value Sets können in unterschiedlicher Art und Weise definiert werden: extensional als Sammlungen von Codes (Konzepten) oder intensional über einen berechenbaren Ausdruck, aus dem sich eine Codeliste exakt ermitteln lässt. Die Value Sets für DocumentEntry.typeCode und DocumentEntry.classCode in diesem Leitfaden sind beispielsweise extensional als Listen definiert, während das Value Set für DocumentEntry.formatCode intensional über Konstruktionsvorschriften für URNs definiert wurde.
Wenn ein Value Set neben den genannten oder beschriebenen Codes zusätzliche Werte erlaubt, wird es als offen (open) bezeichnet, andernfalls als geschlossen (closed). Das Value Set für DocumentEntry.languageCode ist beispielsweise offen, da neue Sprachcodes gebildet und wenn notwendig auch verwendet werden können. Die Value Sets für DocumentEntry.classCode und DocumentEntry.healthcareFacilityTypeCode sind hingegen geschlossen. Das heißt, dass eine Erweiterung nur über eine neue Version der Value Sets erfolgen sollte.
Die Identifikation eines Value Sets erfolgt bei CDA und IHE XDS über eine OID, bei FHIR über eine URL. Die Version eines Value Sets wird über einen Zeitstempel charakterisiert. Die Bindung eines kodierten Elementes an ein Value Set (Binding) kann nun dynamisch (dynamic) oder statisch (static) erfolgen. Ein dynamisches Binding bezieht sich auf die jeweils aktuellste Version eines Value Sets, während bei einem statischen Binding eine feste Version angegeben wird. Bei einem statischen Binding müssen OID bzw. ein eindeutiger Bezeichner sowie ein Zeitstempel angegeben werden. Beim dynamischen Binding fehlt der Zeitstempel.
Unabhängig davon gibt es für das Binding von ValueSets noch weitere Unterscheidungsmöglichkeiten. Beim Design-Time Binding wird das zu verwendende Value Set explizit angegeben. Beim Runtime Binding werden nur die Konzeptdomäne und die sogenannte Realm (z.B. „Deutschland“) festgelegt. Das effektive Value Set wird dann dynamisch über einen Terminologieserver an Hand von Konzeptdomäne und Realm ermittelt.
Bindings können verpflichtend sein (required), empfohlen werden (suggested oder preferred) oder dienen nur als Beispiel (example). Einzelne Werte eines Value Sets können als verpflichtend (required), erlaubt (permitted) oder ausgeschlossen (excluded) gekennzeichnet werden. Die in diesem Leitfaden definierten Codes besitzen alle den Status permitted.
Die folgende Tabelle gibt eine Übersicht über die Eigenschaften der bereits definierten Value Sets:
| XDS-Metadatum | Beschreibung | Definitionsart | Erweiterbarkeit | Bindungsstärke | Bindungsart | Versionsbindung |
|---|---|---|---|---|---|---|
| classCode | Dokumentenklasse | extensional | closed | suggested | design-time | dynamic |
| typeCode | Dokumententyp | extensional | closed | suggested | design-time | dynamic |
| healthcareFacilityTypeCode | Einrichtungsart | extensional | closed | suggested | design-time | dynamic |
| practiceSettingCode | Erstellende Fachrichtung | extensional | closed | suggested | design-time | dynamic |
| formatCode | Dokumentenformat | intensional | open | suggested | design-time | dynamic |
| languageCode | Dokumentensprache | intensional | open | suggested | design-time | dynamic |
| Folder.codeList | Ordnerklassifizierung | extensional | open | suggested | design-time | dynamic |
 |
Wie geht man mit Anforderungen nach Kodes um, die in den Value Sets nicht vorkommen?
Das hängt primär von der Erweiterbarkeit und der Bindungsstärke ab! Value Set Vorgaben mit der Bindungsstärke "required" müssen verwendet werden. Bei "suggested" kann eine Alternative definiert werden, die dann genutzt werden kann. Allerdings ist hierbei zu beachten, dass man von einer Empfehlung abweicht und damit in zukünftigen Anbindungen Probleme bekommen kann. Die Erweiterbarkeit zeigt an, ob das Value Set durch eigene Festlegungen ergänzt werden kann ("open") oder nicht ("closed"). Wenn Ergänzungen zugelassen sind, so ist ein eigenes Kodesystem zu definieren, das in in das Value Set mit eingebunden wird. Auf diese Weise werden die bekannten Kodes aus dem bereits vorhandenen Kodesystem eingesetzt und nur für fehlende, aber notwendige Konzepte eigene Kodes definiert. Eine elegantere Methode ist die Kontaktaufnahme mit dem Interoperabilitätsforum, um dort die neuen Kodes für eine Aufnahme in das offizielle Value Set vorzuschlagen. Das wird dann dort diskutiert und über einen Änderungs-/Erweiterungsvorschlag in einem Abstimmungsverfahren (Ballot) abgestimmt. |
 |
Wie soll verfahren werden, wenn das hier beschriebene Vorgehen nicht ganz klar ist? Das einfachste ist eine eMail an tcs@hl7.de, in der die Frage übermittelt wird. Das Interoperabilitätsforum wird versuchen, darauf schnellstmöglich eine Antwort allgemein verfügbar bereitzustellen. |
