Österreichischer e-Health-Terminologie-Browser
2.7.0+20240404 - TerminoloGit

Dateiformate

For the english version please click here.

Dateiformate Übersicht

Die folgenden Dateiformate werden derzeit unterstützt:

NameDateiendungZeichenkodierungHinweis
FHIR® R4B xml.4.fhir.xmlUTF-8 
FHIR® R4B json.4.fhir.jsonUTF-8 
fsh v1.1.fshUTF-8 
fsh v2.2.fshUTF-8 
propCSV v1 csv.1.propcsv.csvcp-1252 oder UTF-8 bei Encoding-Fehler 
propCSV v1 xlsx.1.propcsv.xlsxUTF-8 
ClaML v2.2.claml.xmlUTF-8 
ClaML v3.3.claml.xmlUTF-8 
SVSextELGA v1.1.svsextelga.xmlUTF-8Warnung! DEPRECATED!
Dieses Format kann technisch nicht alle Informationen enthalten,
die in den anderen Formaten verfügbar sind.
Dieses Format ist nur noch für Legacy-Zwecke verfügbar.
SVSextELGA v2.2.svsextelga.xmlUTF-8Warnung! DEPRECATED!
Dieses Format kann technisch nicht alle Informationen enthalten,
die in den anderen Formaten verfügbar sind.
Dieses Format ist nur noch für Legacy-Zwecke verfügbar.
Es sind jedoch alle Konzept-Properties verfügbar.
outdatedCSV v1.1.outdatedcsv.csvUTF-8Warnung! DEPRECATED!
Dieses Format kann technisch nicht alle Informationen enthalten,
die in den anderen Formaten verfügbar sind.
Dieses Format ist nur noch für Legacy-Zwecke verfügbar.
outdatedCSV v2.2.outdatedcsv.csvUTF-8Warnung! DEPRECATED!
Dieses Format kann technisch nicht alle Informationen enthalten,
die in den anderen Formaten verfügbar sind.
Dieses Format ist nur noch für Legacy-Zwecke verfügbar.
Es sind jedoch alle Konzept-Properties verfügbar.

Haftungsausschluss bezüglich der Konvertierung zwischen Dateiformaten

Bitte beachten Sie, dass das propCSV-Format das Kernformat für die Konvertierung zwischen den verschiedenen Dateiformaten darstellt. Darüber hinaus ist die XLSX-Version von propCSV vollständig für Menschen lesbar.

Wenn es z.B. ein Element in der FHIR®-Spezifikation gibt, das in propCSV nicht unterstützt wird, kann es nicht in die anderen Dateiformate konvertiert werden.

FHIR® R4B

Den Aufbau der FHIR®-Ressourcen entnehmen Sie bitte der entsprechenden Dokumentation, z.B.:

Die XML-Darstellung für eine Ressource wird mit diesem Format beschrieben (siehe XML-Darstellung von Ressourcen):

<name xmlns="http://hl7.org/fhir" (attrA="value")>
  <!-- von Ressource: id, meta, implicitRules, und language -->
  <nameA><!-- 1..1 Typ Beschreibung des Inhalts --><nameA>
  <nameB[x]><!-- 0..1 Typ1|Typ1 Beschreibung --></nameB[x]>
  <nameC> <!-- 1..* -->
    <nameD><!-- 1..1 type>Relevante Elemente --></nameD>
  </nameC>
<name>

Die JSON-Darstellung für eine Ressource basiert auf dem JSON-Format, beschrieben in STD 90 (RFC 8259), und wird mit diesem Format beschrieben (siehe JSON-Darstellung von Ressourcen):

{
  "resourceType" : "[Ressourcentyp]",
  // von Quelle: property0
  "property1" : "<[primitiv]>", // Kurzbeschreibung
  "property2" : { [Datentyp] }, // Kurzbeschreibung
  "property3" : { // Kurzbeschreibung
    "propertyA" : { CodeableConcept }, // Kurzbeschreibung (Beispiel)
  },
  "property4" : [{ // Kurzbeschreibung
    "propertyB" : { Referenz(ResourceType) } // R!  Kurzbeschreibung
  }]
}

FHIR® Shorthand (FSH)

FHIR® Shorthand (FSH) ist eine domänenspezifische Sprache zur Definition des Inhalts von FHIR® Implementation Guides (IG). Die Sprache wurde speziell für diesen Zweck entwickelt, ist einfach und kompakt und ermöglicht es dem Autor, seine Absichten auszudrücken, ohne sich Gedanken über die zugrundeliegende FHIR®-Mechanik machen zu müssen. FSH kann mit einem beliebigen Texteditor erstellt und aktualisiert werden. Da es sich um Text handelt, ermöglicht es eine verteilte, teambasierte Entwicklung unter Verwendung von Quellcode-Kontrolltools wie GitHub.

Dokumentation von FSH:

Proprietäres CSV (propCSV) - CSV und XLSX

Das proprietäre CSV (propCSV) ermöglicht eine vereinfachte Bearbeitung von Terminologien. Dieses Format basiert auf der FHIR®-Spezifikation für Codesysteme und Value-Sets. Es ermöglicht die Dokumentation der Metadatenelemente sowie der Konzeptelemente einer Terminologie.

Die FHIR®-Spezifikation definiert die Pflichtelemente für Codesysteme (http://hl7.org/fhir/codesystem.html#resource) und Value-Sets (http://hl7.org/fhir/valueset.html#resource). Die Namen der entsprechenden Elemente dürfen nicht verändert werden. Generell dürfen keine anderen als die in der FHIR®-Spezifikation definierten Elemente verwendet werden, es sei denn, es wird eine FHIR®-Erweiterung verwendet. In einigen Ausnahmefällen kann es jedoch notwendig sein, benutzerdefinierte Elemente hinzuzufügen (z.B. parent und parentSystem zur Unterstützung hierarchischer Strukturen in ValueSet.expansion), um bestimmte Anforderungen zu unterstützen, die noch auf der FHIR®-Spezifikation basieren.

Der Wert eines Elements wird in die jeweiligen FHIR®-Datentypen (uri, identifier, string, code, …) konvertiert und bei erfolgreicher Konvertierung gespeichert.

Das propCSV wird sowohl als CSV- als auch als XLSX-Datei bereitgestellt. **Für die Bearbeitung wird die XLSX-Datei empfohlen.

Dateistruktur

Die ersten beiden Zeilen bestehen aus den Metadatenelementen für die Terminologie, d.h. in der ersten Zeile wird der Name des Elements angegeben, in der zweiten Zeile wird der Wert des entsprechenden Elements dokumentiert.

Eine Leerzeile trennt die Metadatenelemente von den Konzeptelementen.

Bei den Konzeptelementen folgt auf eine Zeile, in der die erforderlichen Konzeptelementnamen angegeben sind, die jeweiligen Werte für jedes Konzept, das Teil der Terminologie sein soll.

Die Metadatenelemente und Konzeptelemente können in beliebiger Reihenfolge angegeben werden. Nach dem Schlüssel-Wert-Prinzip wird immer der Schlüssel gelesen, der dem darunter stehenden Wert die Bedeutung gibt.

Codesystem

Die folgende Liste enthält sowohl erforderliche als auch empfohlene Metadatenelemente für Codesysteme. Eine Beispieldatei kann hier heruntergeladen werden: Codesystem Hinweis: Zellen, die bearbeitet werden müssen, sind gelb hervorgehoben

NameKardinalitätBeschreibungBeispiel
resource1..1Gibt die Art der Terminologie an. Fester Wert: CodeSystemCodeSystem
id1..1Logische ID dieses Artefakts.cs-import-template
url1..1Kanonischer Identifikator für dieses Codesystem, dargestellt als URI (weltweit eindeutig) (Coding.system).https://my-terminology-server.com/CodeSystem/cs-import-template
identifier0..*Zusätzlicher Identifikator für das Codesystem ("Business Identifier"). Derzeit wird nur urn:oid: unterstützt. Der angegebene Wert entspricht somit Identifier.value (vgl. http://www.hl7.org/fhir/datatypes.html#Identifier).1.25.256.25.8.9
version1..1Business-Version des Codesystems (Coding.version).1.0.0+20230601
name0..1Name dieses Codesystems (computerfreundlich).cs-import-template
title0..1Name dieses Codesystems (menschenfreundlich).CS Import Template
status1..1draft | active | retired | unknownactive
date0..1Datum der letzten Änderung. Das Format ist YYYY-MM-DD.2015-02-07
contact0..*Kontaktinformationen des Herausgebers. Alle Subattribute (vgl. http://hl7.org/fhir/R4B/metadatatypes.html#ContactDetail) werden in der ersten Ebene mit einem | und in der zweiten Ebene mit einem ^ verbunden.
  • name - Name einer Kontaktperson.
  • telecom - Kontaktangaben zur Person oder Organisation.
    • system - phone | fax | email | pager | url | sms | other
    • value - Die eigentlichen Angaben zur Kontaktstelle
    • use - home | work | temp | old | mobile - Zweck dieser Kontaktstelle
    • rank - Bevorzugte Reihenfolge der Verwendung (1 = höchste)
    • periodStart - Anfangszeitpunkt mit inklusiver Grenze, wann die Kontaktstelle in Gebrauch war/ist.
    • periodEnd - Endzeitpunkt mit inklusiver Grenze, falls nicht fortlaufend, wann die Kontaktstelle in Gebrauch war/ist.
John Doe|url^https://my-terminology-publishing.com^^^^
description0..1Freitext-Beschreibung des Codesystems.
copyright0..1Einschränkungen bei der Nutzung und/oder Veröffentlichung.
content1..1not-present | example | fragment | complete | supplementcomplete
count0..1Gesamtzahl der Konzepte im Codesystem238
property0..*Zusätzliche Informationen zu jedem Konzept. Alle Unterattribute werden durch ein | verbunden.
  • code required - Identifiziert die Eigenschaft auf den Konzepten, und wann in Operationen darauf Bezug genommen wird.
  • uri - Formaler Identifikator für die Eigenschaft
  • description - Warum die Eigenschaft definiert ist und/oder was sie vermittelt
  • type required - code | Coding | string | integer | boolean | dateTime | decimal
child|||code

Die folgende Liste enthält sowohl erforderliche als auch empfohlene Konzeptelemente für Codesysteme:

NameKardinalitätBeschreibungBeispiel
code1..1Code, der den Begriff identifiziert.123456
display0..1Text, der den Usern angezeigt werden soll.bear
definition0..1Formale DefinitionBären sind fleischfressende Säugetiere aus der Familie der Ursidae.
designation0..*Zusätzliche Angaben zum Konzept. Alle Subattribute werden durch ein | verbunden.
  • language - Menschliche Sprache der zusätzlichen Angaben.
  • use - Details zur Verwendung der zusätzlichen Angaben.
  • value required - Der Klartext dieser zusätzlichen Angaben.
de-AT|^^^^|Bär oder |http://snomed.info/sct^^900000000000003001^Fully specified name^|Ursidae
property0..*Wert der Eigenschaft für das Konzept. Alle Subattribute werden mit einem | verbunden.
  • code required - Identifiziert die Eigenschaft auf den Konzepten, und wann in Operationen darauf Bezug genommen wird.
  • value required - Wert der Eigenschaft für dieses Konzept.
  • type required - code | Coding | string | integer | boolean | dateTime | decimal
Farbe|braun|string

Value-Sets

Die folgende Liste enthält sowohl erforderliche als auch empfohlene Metadatenelemente für Value-Sets. Eine Beispieldatei kann hier heruntergeladen werden: Value-Set *Hinweis: Zellen, die bearbeitet werden müssen, sind gelb hinterlegt.

NameKardinalitätBeschreibungBeispiel
resource1..1Gibt die Art der Terminologie an. Fester Wert: ValueSetValueSet
id1..1Logische ID dieses Artefakts.vs-import-template
url1..1Kanonischer Identifikator für dieses Codesystem, dargestellt als URI (weltweit eindeutig).https://my-terminology-server.com/ValueSet/vs-import-template
identifier0..*Zusätzlicher Identifikator für das Value-Set ("Business Identifier"). Derzeit wird nur urn:oid: is unterstützt. Der angegebene Wert entspricht somit Identifier.value (vgl. http://www.hl7.org/fhir/datatypes.html#Identifier).1.2.3.4.5.6.7.9.10
version1..1Business-Version des Value-Sets.1.0.0+20230601
name0..1Name dieses Value-Sets (computerfreundlich).vs-import-template
title0..1Name dieses Value-Sets (menschenfreundlich).VS Import Template
status1..1draft | active | retired | unknownactive
date0..1Datum der letzten Änderung. Das Format ist YYYY-MM-DD.2015-02-07
contact0..*Kontaktinformationen des Herausgebers. Alle Subattribute (vgl. http://hl7.org/fhir/R4B/metadatatypes.html#ContactDetail) werden in der ersten Ebene mit einem | und in der zweiten Ebene mit einem ^ verbunden.
  • name - Name einer Kontaktperson.
  • telecom - Kontaktangaben zur Person oder Organisation.
    • system - phone | fax | email | pager | url | sms | other
    • value - Die eigentlichen Angaben zur Kontaktstelle
    • use - home | work | temp | old | mobile - Zweck dieser Kontaktstelle
    • rank - Bevorzugte Reihenfolge der Verwendung (1 = höchste)
    • periodStart - Anfangszeitpunkt mit inklusiver Grenze, wann die Kontaktstelle in Gebrauch war/ist.
    • periodEnd - Endzeitpunkt mit inklusiver Grenze, falls nicht fortlaufend, wann die Kontaktstelle in Gebrauch war/ist.
John Doe|url^https://my-terminology-publishing.com^^^^
description0..1Freitext-Beschreibung des Value-Sets.
copyright0..1Einschränkungen bei der Nutzung und/oder Veröffentlichung.

Die folgende Liste enthält sowohl erforderliche als auch empfohlene Konzeptelemente für Value-Sets:

NameKardinalitätBeschreibungBeispiel
system1..1Das Codesystem, aus dem die Codes stammen.https://my-terminology-server.com/CodeSystem/cs-import-template
version0..1Spezifische Version des Codesystems, auf das Bezug genommen wird.1.0.0+20230601
code1..1Code oder Expression aus dem System123456
display0..1Text, der für diesen Code in diesem Value-Set angezeigt werden soll.bear
designation0..*Zusätzliche Angaben zum Konzept. Alle Subattribute werden durch ein | verbunden.
  • language - Menschliche Sprache der zusätzlichen Angaben.
  • use - Details zur Verwendung der zusätzlichen Angaben.
  • value required - Der Klartext dieser zusätzlichen Angaben.
de-AT|^^^^|Bär or |http://snomed.info/sct^^900000000000003001^Fully specified name^|Ursidae
exclude0..1Als Gegenteil von "include" erlaubt dies, ein bestimmtes Konzept eines Codesystems explizit auszuschließen. Auch ganze Codesysteme oder Value-Sets mit all ihren Konzepten können ausgeschlossen werden. Zusätzlich können Codesystem- Filter verwendet werden, um mehrere Konzepte auf der Grundlage ihrer Eigenschaften auszuschließen. true wenn die Zeile in der propCSV als Ausschluss interpretiert werden soll. Wenn nicht angegeben, wird false angenommen, d. h. die Zeile wird als Einschluss interpretiert.

Hinweis: Mindestens eine Zeile muss einen Einschluss darstellen.
true
parent0..1Code des übergeordneten Codes / Elternteils dieses Konzepts. Kombiniert mit parentSystem ist dieses Element notwendig, wenn es sich um hierarchische Value-Sets handelt. In einem FHIR®-ValueSet führt dies dann zu einer hierarchischen Erweiterung, d.h. ValueSet.expansion.contains.contains.123457
parentSystem0..1Codesystem des übergeordneten Codes / Elternteils dieses Konzepts. Erforderlich, wenn parent verwendet wird.https://my-terminology-server.com/CodeSystem/cs-import-template

ClaML v2 und v3

ClaML (Classification Markup Language) ist ein spezielles XML-Datenformat für Klassifikationen. Das ClaML-Dateiformat unterstützt in erster Linie Codesysteme.

Die folgenden Elemente beschreiben die Metadaten einer Terminologie:

ElementBeschreibung
TitleEnthält den Namen (Attribut name), die Version (Attribut version) sowie das Gültigkeitsdatum (Attribut date, Format: YYYY-MM-DD).
IdentifierEnthält die OID der Terminologie im Attribut uid.
AuthorsEnthält ein oder mehrere Author-Elemente, die den Namen (Attribut name) des Autors und die Kontaktangaben als Elementinhalt enthalten.
MetaMehrere Meta-Elemente enthalten weitere Informationen als Schlüssel-Werte-Paare.

Die am häufigsten verwendeten Meta-Elemente sind:

  • titleLong - Von Menschen lesbarer Titel
  • resource - Gibt den Typ der Terminologie an (z.B. CodeSystem, ValueSet)
  • id - Logische Kennung dieses Artefakts
  • url - Kanonischer Bezeichner für diese Terminologie, dargestellt als URI (global eindeutig)
  • status - draft | active | retired | unknown
  • description - Deutsche Beschreibung der Terminologie
  • description_eng - Englische Beschreibung der Terminologie
  • content - Nur für Codesysteme relevant. not-present | example | fragment | complete | supplement
  • website - Link zur Quelle usw.
  • copyright - Verwendung und/oder Veröffentlichungsbeschränkungen.
  • version_description - Beschreibung der Version
  • property - Deklariert die Eigenschaften, die im Rahmen der Konzepte dieser Terminologie zu erwarten sind

Die Konzepte werden als Class-Elemente dargestellt:

  • Class/@code - Code des Konzepts
  • Class/Rubric[@kind='preferred'] - Darstellung des Konzepts
  • Class/Rubric[@kind='note'] - ausführlichere Beschreibung (Anwendungsbeschreibung) des Konzepts
  • Class/Meta[@name='TS_ATTRIBUTE_HINTS'] - Hinweise auf die Anwendung des Konzepts
  • Class/Meta[@name='TS_ATTRIBUTE_MEANING'] oder Class/Rubric[@kind='designation'] mit de-AT - deutsche Sprachvariante
  • Class/Meta[@name='Level'] und Class/Meta[@name='Type'] - Abbildung der Hierarchie
  • Class/SubClass - gibt die untergeordneten Konzepte dieses Konzepts an
  • Class/SuperClass - gibt die übergeordneten Konzepte dieses Konzepts an.

SVSextELGA v1 und v2

HINWEIS: Dieses Dateiformat ist deprecated. SVSextELGA wird bis auf Weiteres weiterhin unterstützt. Es werden jedoch keine weiteren Entwicklungen für dieses Format durchgeführt. Daher kann dieses Dateiformat technisch nicht alle Informationen enthalten, die in nicht veralteten Dateiformaten verfügbar sind. Außerdem wird dieses Format mittelfristig (ca. 2025) vollständig abgeschafft werden.

Das unterstützte SVS basiert auf dem IHE Sharing Value Set Format und wurde für ELGA-Zwecke erweitert. Dieses XML-Format unterstützt sowohl Codesysteme als auch Value-Sets.

Das Root-Element valueSet enthält die Metadaten der Terminologie als Attribute:

  • name - Name der Terminologie
  • displayName - menschenlesbarer Name der Terminologie
  • beschreibung - Beschreibung der Terminologie auf Deutsch
  • description - Beschreibung der Terminologie in englischer Sprache
  • effectiveDate - Gültigkeitsdatum
  • id - OID der Terminologie
  • last_change_date - Datum der letzten Änderung
  • version - Version der Terminologie
  • website - Link zur Quelle usw.

Das Element conceptList enthält die als concept-Elemente dargestellten Konzepte. Die folgende Liste erläutert die wichtigsten Attribute des Elements concept:

  • code - Code, der das Konzept identifiziert
  • displayName - Text, der für diesen Code in dieser Value-Set angezeigt wird
  • displayNameAlt - Alternativer Anzeigename
  • codeSystem - OID des Codesystems, aus dem der Code stammt
  • concept_beschreibung - detailliertere Beschreibung (Anwendungsbeschreibung) des Konzepts
  • deutsch - deutsche Sprachvariante, Bedeutung
  • einheit_codiert - kodierte Darstellung der Einheit eines Prüfergebnisses
  • einheit_print - menschenlesbare Form der Einheit eines Prüfergebnisses
  • hinweise - Anmerkungen zur Anwendung des Konzepts
  • level - gibt die Ebene des Konzepts innerhalb einer Hierarchie an
  • orderNumber - Index zur Festlegung der Reihenfolge der Konzepte (nur für Value-Sets relevant)
  • parentCodeSystemName - kanonische Url des Codesystems, aus dem der Code stammt
  • relationships - mögliche Verbindungen zu anderen Konzepten
  • type - Typ des Konzepts (L - Blatt, S - spezialisierbar, A - abstrakt, D - veraltet)

In Version 2 von SVSextELGA können undefinierte Attribute/Properties als zusätzliche Konzeptattribute aufgenommen werden.

Veraltetes CSV (outdatedcsv) v1 und v2

HINWEIS: Dieses Dateiformat ist deprecated. Das outdatedcsv wird bis auf Weiteres weiterhin unterstützt. Es werden jedoch keine weiteren Entwicklungen für dieses Format durchgeführt. Daher kann dieses Dateiformat technisch nicht alle Informationen enthalten, die in nicht veralteten Dateiformaten verfügbar sind. Außerdem wird dieses Format mittelfristig (ca. 2025) vollständig abgeschafft werden.

Das veraltete CSV (outdatedcsv) stellt das CSV-Exportformat des alten Terminologieservers (termpub.gv.at) dar. Das Format enthält keine Metadaten zu Codesystemen oder Value-Sets und kann nicht alle für FHIR® erforderlichen Informationen darstellen, die in anderen Dateiformaten darstellbar sind.

Für jedes Konzept können nur die folgenden Informationen in outdatedcsv dargestellt werden:

  • code
  • codeSystem
  • displayName
  • parentCode (nur Codesysteme)
  • parentCodeSystemName (nur Value-Sets)
  • concept_Beschreibung
  • meaning
  • hints
  • orderNumber (nur Value-Sets)
  • level
  • type
  • relationships
  • einheit print (nur Value-Sets)
  • einheit codiert (nur Value-Sets)

In Version 2 von outdatedcsv können undefinierte Attribute als zusätzliche Spalten aufgenommen werden. Darüber hinaus wurden in Version 2 die folgenden zusätzlichen Änderungen vorgenommen:

  • Leere Werte sind wirklich leer und nicht mit '' kodiert.
  • Wenn am Ende einer Zeile nur leere Werte stehen, werden die ; zwischen den bezeichneten Spalten weggelassen (CSV-konform). Dies führt zu einer Größeneinsparung von bis zu 20% bei großen Terminologien.
  • Die Implementierungsempfehlung für das Lesen von CSV-Dateien lautet, die Spaltennamen und nicht den Spaltenindex zu verwenden. Hier ist ein Beispiel für einen Python-Codeausschnitt, wie dies mit einem DictReader aus der csv-Bibliothek implementiert werden kann:
    import csv
    with open(FILEPATH, 'r', newline='') as file:
    csvFile = csv.DictReader(file, quotechar='\'', delimiter=';') # DictReader allows access by keys/columns
    for csv_line in csvFile:
    ...