e-Impfpass Datentypen

Aus HL7 Austria MediaWiki
Wechseln zu: Navigation, Suche
[unmarkierte Version][unmarkierte Version]
(Spezifikation)
(Datentypen)
Zeile 21: Zeile 21:
 
==Identifikations-Elemente==
 
==Identifikations-Elemente==
 
===id-Element II===
 
===id-Element II===
Identifikationselemente erlauben die global eindeutige Identifikation durch Verwendung von Objektidentifikatoren (kurz „OID“), gemäß dem in ISO/IEC 9834-1 normierten Mechanismus zur weltweit eindeutigen Kennzeichnung von Informationsobjekten [OIDLEIT]. Die relevanten OID werden im OID-Portal für das Österreichische Gesundheitswesen<sup>7</sup> registriert und veröffentlicht.
+
Identifikationselemente erlauben die global eindeutige Identifikation durch Verwendung von Objektidentifikatoren (kurz „OID“), gemäß dem in ISO/IEC 9834-1 normierten Mechanismus zur weltweit eindeutigen Kennzeichnung von Informationsobjekten [OIDLEIT]. Die relevanten OID werden im <ref name=OIDPortal>OID Portal für das Österreichische Gesundheitswesen [Online Juli 2019]: https://www.gesundheit.gv.at/OID_Frontend/</ref> registriert und veröffentlicht.
  
 
Identifikationselemente können im id-Element grundsätzlich auf zweierlei Arten angegeben werden:
 
Identifikationselemente können im id-Element grundsätzlich auf zweierlei Arten angegeben werden:
 
* '''Methode 1''': Angabe der ID sowie einer OID der ID-Liste, aus der die ID stammt
 
* '''Methode 1''': Angabe der ID sowie einer OID der ID-Liste, aus der die ID stammt
 
* '''Methode 2''': Direkte Angabe der ID in Form einer OID. Alternativ zu OID kann hier auch eine UUID gemäß Standard ISO/IEC 9834-8:2005 verwendet werden, wobei die Buchstaben A-F der Hexadezimalzahlen in Großschreibung angegeben werden MÜSSEN.  
 
* '''Methode 2''': Direkte Angabe der ID in Form einer OID. Alternativ zu OID kann hier auch eine UUID gemäß Standard ISO/IEC 9834-8:2005 verwendet werden, wobei die Buchstaben A-F der Hexadezimalzahlen in Großschreibung angegeben werden MÜSSEN.  
 
 
<sup>7</sup> OID Portal für das Österreichische Gesundheitswesen: https://www.gesundheit.gv.at/OID_Frontend/ 
 
  
 
====Strukturbeispiele====
 
====Strukturbeispiele====

Version vom 17. Oktober 2019, 07:51 Uhr

Inhaltsverzeichnis

Datentypen

Im folgenden Abschnitt werden nur die Datentypen beschrieben, die in e-Impfpass CDA-Dokumenten zur Anwendung kommen. Für weiterführende Informationen wird auf den zugrundeliegenden Standard Health Level Seven Version 3 (V3), Normative Edition verwiesen.

Identifikations-Elemente

id-Element II

Identifikationselemente erlauben die global eindeutige Identifikation durch Verwendung von Objektidentifikatoren (kurz „OID“), gemäß dem in ISO/IEC 9834-1 normierten Mechanismus zur weltweit eindeutigen Kennzeichnung von Informationsobjekten [OIDLEIT]. Die relevanten OID werden im [1] registriert und veröffentlicht.

Identifikationselemente können im id-Element grundsätzlich auf zweierlei Arten angegeben werden:

  • Methode 1: Angabe der ID sowie einer OID der ID-Liste, aus der die ID stammt
  • Methode 2: Direkte Angabe der ID in Form einer OID. Alternativ zu OID kann hier auch eine UUID gemäß Standard ISO/IEC 9834-8:2005 verwendet werden, wobei die Buchstaben A-F der Hexadezimalzahlen in Großschreibung angegeben werden MÜSSEN.

Strukturbeispiele

Methode 1:

<!—
    Angabe der OID der ID-Liste in @root
    sowie der eigentlichen ID in @extension
-->
<id root="1.2.40.0.34.99.111.1.1"
    extension="134F989"
    assigningAuthorityName="KH Eisenstadt" />

Methode 2:

<!-- Angabe einer OID als direkten Identifikator -->
<id root="1.2.40.0.34.99.111.0.1"
    assigningAuthorityName="KH Eisenstadt" />


<!-- Angabe einer UUID als direkten Identifikator -->
<id root="6B48B496-C68E-CD08-55D4-B40CAC520F28"
    assigningAuthorityName="KH Eisenstadt" />

Spezifikation

Bei II Elementen werden, sofern nicht anders spezifiziert, immer die folgenden Attribute angegeben.

Element/Attribut DT Kard Konf Beschreibung
Id II ID
@root uid 1..1 M Methode 1: OID der ID-Liste, der die ID angehört

Methode 2: OID oder UUID des Objekts

Die Hexadezimalzahlen A-F der UUID MÜSSEN bei der Verwendung in HL7 CDA in Großschreibung angegeben werden


@extension st 0..1 C
Konditioinale Konformität:
Methode 1
Methode 2

1..1
0..0

M
NP
ID des Objekts aus der ID-Liste
@assigningAuthorityName st 0..1 O Klartext-Darstellung der die ID ausgebenden Stelle

Vorschriften für bereits definierte ID-Arten

Die folgenden Unterkapitel zeigen IDs, die in CDA-Dokumenten zur Anwendung kommen können.

ID aus dem GDA-Index

Die Vorgaben für IDs aus dem GDA-Index sind in der Basiskomponente „GDA-Index“ beschrieben.

Informationen zum österreichischen OID-Konzept finden Sie online auf dem „OID Portal Österreich“: https://www.gesundheit.gv.at/OID_Frontend/index.jsp?section=1

DVR-Nummer

Die Datenverarbeitungsregister-Nummer (DVR-Nummer) des jeweiligen Gesundheitsdienstleisters kann als zusätzliches ID-Element abgebildet werden.

Spezifikation
Element/Attribut DT Kard Konf Beschreibung
Id II ID
@root uid 1..1 M Fester Wert: 1.2.40.0.10.2.0.2.1
@extension st 1..1 M Datenverarbeitungsregister-Nummer
(DVR-Nummer)
z.B.: 0000137
@assigningAuthorityName st 0..1 O Fester Wert: Österreichisches Datenverarbeitungsregister
ATU Nummer

Die Umsatzsteueridentifikationsnummer (ATU-Nummer) des jeweiligen Gesundheits-dienstleisters kann als zusätzliches ID-Element abgebildet werden.

Spezifikation
Element/Attribut DT Kard Konf Beschreibung
Id II ID
@root uid 1..1 M Fester Wert: 1.2.40.0.10.2.0.3.1
@extension st 1..1 M Umsatzsteueridentifikationsnummer
(ATU-Nummer)
z.B.: ATU56658245
@assigningAuthorityName st 0..1 O Fester Wert: Österreichisches Finanzamt
Bankverbindung

Die einzelnen Elemente einer Bankverbindung (IBAN, SWIFT-Adresse oder BIC) können jeweils als eigene ID-Elemente abgebildet werden. Bankleitzahl und Kontonummer werden nicht mehr unterstützt.

Spezifikation: IBAN
Element/Attribut DT Kard Konf Beschreibung
Id II ID
@root uid 1..1 M Fester Wert: 1.0.13616
@extension st 1..1 M IBAN
z.B.: 1200052066543301
@assigningAuthorityName st 0..1 O Fester Wert: Society for Worldwide Interbank Financial Telecommunication
Spezifikation: SWIFT-Adresse oder BIC
Element/Attribut DT Kard Konf Beschreibung
Id II ID
@root uid 1..1 M Fester Wert: 1.0.9362
@extension st 1..1 M SWIFT/BIC
z.B.: BKAUATWW
@assigningAuthorityName st 0..1 O Fester Wert: Society for Worldwide Interbank Financial Telecommunication

Codierungs-Elemente

Mit Codierungselementen können Konzepte über einen Code und der Angabe des Terminologie- bzw des Codesystems, aus dem der Code stammt ausgedrückt werden.

code-Element CE CWE

Begriffsdefinitionen: CE “Coded with Equivalents”, CWE „Coded with Exceptions“ (bedeutet, dass das vom Standard angegebene Vokabular empfohlen wird, im Leitfaden können Ausnahmen definiert werden).

Strukturbeispiele

Minimal-Variante um einen Code eindeutig darzustellen:
<code code="E10"
      codeSystem="1.2.40.0.34.5.56"/>
Gebräuchlichste Variante mit zusätzlichem Klartext für Code und Codesystem
<code code="E10"
      displayName="Primär insulinabhängiger Diabetes mellitus, Typ-2-Diabetes"
      codeSystem="1.2.40.0.34.5.56"
      codeSystemName="ICD-10 BMG 2014"/>
Vollständige-Variante mit direkter Angabe des Textinhalts
<code code="E10"
    displayName="Primär insulinabhängiger Diabetes mellitus, Typ-2-Diabetes"
    codeSystem="1.2.40.0.34.5.56"
    codeSystemName="ICD-10 BMG 2014"
    codeSystemVersion="1.00">
  <originalText>Diabetes mellitus Typ 2</originalText>
</code>
Vollständige-Variante mit Referenz in den narrativen Textbereich
<code code="E11"
      displayName="Primär insulinabhängiger Diabetes mellitus, Typ-2-Diabetes"
      codeSystem="1.2.40.0.34.5.56"
      codeSystemName="ICD-10 BMG 2014"
      codeSystemVersion="1.00">
   <originalText>
      <reference value="#entldiag-1"/>
   </originalText>
</code>

Für eine detaillierte Beschreibung der Abbildung von Referenzen in den narrativen Bereich siehe Spezifikation und „Zusammenhang Text und Entry“.

Vollständige-Variante mit Referenz in den narrativen Textbereich und Übersetzung in zwei andere Code-Systeme
<code code="E10"
     displayName="Primär insulinabhängiger Diabetes mellitus, Typ-2-Diabetes"
     codeSystem="1.2.40.0.34.5.56"
     codeSystemName="ICD-10 BMG 2014">
  <originalText>
     <reference value="#entldiag-1"/>
  </originalText>
  <translation code="46635009"
     displayName="Diabetes mellitus type I"
     codeSystem="2.16.840.1.113883.6.96" codeSystemName="SNOMED CT">
   <originalText>
     <reference value="#entldiag-1"/>
   </originalText>
  </translation>
  <translation code="xyz"
     displayName="Diabetes mellitus juvenilis"
     codeSystem="9.8.7.6.5.4.3.2.1" codeSystemName="AnderesCodesystem">
   <originalText>
     <reference value="#entldiag-1"/>
   </originalText>
 </translation>
</code>

Spezifikation

Bei CE CWE Elementen werden, sofern nicht anders spezifiziert, immer die folgenden Attribute angegeben:

Element/Attribut DT Kard Konf Beschreibung
code CE
CWE
Code Element
@code cs 1..1 M Der eigentliche Code-Wert
z.B. E10
@displayName st 0..1 R Die Klartext-Darstellung des Code-Werts, wie vom originalen Codesystem (in der entsprechenden offiziellen Sprachvariante) vorgesehen.
z.B. Primär insulinabhängiger Diabetes mellitus, Typ-2-Diabetes
Der DisplayName ist nicht zur Weiterverarbeitung und zur Anzeige in einem User-Interface vorgesehen.

Die Bedeutung wird durch @code und @codeSystem getragen und SOLL über die entsprechende Codeliste aufgelöst werden.

@codeSystem uid 1..1 M Die Identifikation der Codeliste
z.B. 1.2.40.0.34.5.56 bzw. die aktuell gültige OID der Codeliste
@codeSystemName st 0..1 R Der Klartext-Darstellung der Codeliste
z.B. ICD-10 BMG 2014 bzw. die aktuell gültige Version


@codeSystemVersion st 0..1 O Die Versionsnummer der Codeliste
z.B. 1.00
originalText ED 0..1 O Textinhalt, der als Basis zur Codierung herangezogen wurde (… von der Person gesehen, als sie den Code vergeben hat).
Entweder direkt angegeben als „String“ oder indirekt als „Referenz“ auf eine Textstelle im narrativen Bereich.
Im Falle der direkten Angabe als „String“, z.B. Diabetes mellitus Typ 1
reference TEL 0..1 C Referenz Element
Konditionale Konformität:
Wenn indirekte Angabe als „Referenz“
Wenn direkte Angabe

1..1
0..0

M
NP
@value url 1..1 M #{generierter_ref_string}-{generierteID}
z.B.: #entldiag-1, verweist auf die Textstelle im narrativen Block: <td ID=“entldiag-1“>Diabetes mellitus Typ 1</td>
translation CE
CWE
0..* O Beliebig viele optionale Übersetzungen des Codes in andere Codesysteme gemäß derselben Spezifikation (CE CWE) wie das Code-Element selbst.

code-Element CS CNE

Begriffsdefinitionen: CS “Coded simple”; CNE „coded no exceptions“ (bedeutet, dass das angegebene Vokabular verwendet werden MUSS)

Strukturbeispiel

<languageCode code="de-AT" />


Spezifikation

Bei CS CNE Elementen wird nur das folgende Attribut angegeben:

Element/Attribut DT Kard Konf Beschreibung
code CS CNE Code Element
@code cs 1..1 M Der eigentliche Code-Wert
z.B. de-AT

Zeit-Elemente

Angaben von Zeiten sind in HL7 CDA auf vielerlei Arten möglich. Es können Zeitpunkte, Zeitintervalle bestehend aus Beginn- und Endzeitpunkt, Zeitintervalle bestehend aus Beginnzeitpunkt und Dauer und vielerlei mehr Varianten abgebildet werden. Damit nicht alle beliebigen Varianten implementiert werden müssen, werden die Varianten über den Leitfaden stark eingeschränkt. Weitere Spezifizierungen von Zeit-Elementen können von den speziellen Implementierungsleitfäden vorgenommen werden, z.B. spezifiziert der Implementierungsleitfaden e-Medikation den Datentyp GTS (General Timing Specification) für komplexe Zeitangaben mit Anfang, Ende und Häufigkeit bei den Einnahmeregeln für Medikamente. Allgemein gilt, dass nicht angegebene Datums- und Zeitanteile (also z.B. fehlende Sekunden) mit 0 (Null) angenommen werden. D.h. 201908071633 entspricht 20190807163300.

Normale Angabe von Datum und Zeit
1) Zeitpunkte: Die häufigsten Datums- und Zeitangaben werden über den Datentyp TS.AT.TZ zusammengefasst und im Folgenden unter Einfaches Zeitelement TS beschrieben. Hier kann der Wert für einen Zeitpunkt auf zweierlei Arten angegeben werden:

  • Als taggenaues Datum
  • Als Datum mit sekundengenauer Uhrzeit und Zeitzone

2) Zeitintervalle: Bestehen aus Anfangs- und Endpunkt, die wiederum als Zeitpunkt wie oben angegeben werden. Dieser Datentyp wird als Intervall-Zeitelement IVL_TS im Anschluss spezifiziert.

Zeitpunkt: Einfaches Zeitelement TS

Nur Datum

Wird ein Zeitpunkt als Datum (ohne Zeit) angegeben, MUSS dies in folgendem Format erfolgen: YYYYMMDD

Bedeutung:

  • Jahr 4-stellig +
  • Monat 2-stellig +
  • Tag 2-stellig

Strukturbeispiel

<effectiveTime value="20081224"/>


Datum, Zeit und Zeitzone

Wird ein Zeitpunkt als Datum mit Zeit angegeben, MUSS dies in folgendem Format erfolgen: YYYYMMDDhhmmss[+/-]HHMM

Bedeutung:

  • Jahr 4-stellig +
  • Monat 2-stellig +
  • Tag 2-stellig
  • Stunde 2-stellig (24 Stunden Format)
  • Minute 2-stellig
  • Sekunde 2-stellig
  • + oder -
  • Zeitzonenverschiebung Stunde 2-stellig
  • Zeitzonenverschiebung Minute 2-stellig

Wird in einem Zeitelement zusätzlich zum Datum eine Zeit angegeben, MUSS die Zeitzone verpflichtend angegeben werden!

Die angegebene Zeitzone MUSS die aktuelle Sommerzeitregelung inkludieren.

Strukturbeispiele

a) Winterzeit, Österreich (MEZ)

<effectiveTime value="20081224150000+0100"/>

b) Sommerzeit, Österreich (MESZ)

<effectiveTime value="20080824150000+0200"/>


Spezifikation

Bei Zeitpunkten werden, sofern nicht anders spezifiziert, immer die folgenden Unterelemente/Attribute angegeben:

Element/Attribut DT Kard Konf Beschreibung
effectiveTime TS.AT.TZ
@value ts 1..1 M Zeitpunkt (bei Zeitangabe mit Zeitzone)
z.B. 20131224180000+0100

Zeitintervall: Intervall-Zeitelement IVL_TS

Strukturbeispiel

<effectiveTime>
  <low value="..."/>   <!-- Zeitpunkt von -->
  <high value="..."/>   <!-- Zeitpunkt bis -->
</effectiveTime>

Spezifikation

Bei Zeitintervallen werden, sofern nicht anders spezifiziert, immer die folgenden Unterelemente/Attribute angegeben:

Element/Attribut DT Kard Konf Beschreibung
effectiveTime IVL_TS Zeitintervall
low TS.AT.TZ 1..1 R Beginn des Intervalls
Zugelassene nullFlavor: UNK
@value ts 1..1 M Zeitpunkt des Beginns des Intervalls
high TS.AT.TZ 1..1 R Ende des Intervalls
Zugelassene nullFlavor: UNK
@value ts 1..1 M Zeitpunkt des Endes des Intervalls

Ein Datum, das mit yyyymmdd angegeben wurde, wird gemäß Standard HL7 CDA Rel.2 interpretiert als yyyymmdd000000 – also der Tag um 0:00:00 Uhr. Wenn also als Zeitraum z.B.: der ganze 1.Dezember 2013 angegeben werden soll, MUSS das so erfolgen:

  <low value="20131201"/> 
  <high value="20131202"/>

Für mehr Klarheit empfiehlt sich daher die zusätzliche Angabe der Zeit mit Zeitzone:

  <low value="20131201000000+0100"/> 
  <high value="20131201235959+0100"/>


Minimale Datumsangabe: TS.DATE

Eine minimale Datumsangabe umfasst die möglichen Formate: YYYYMMDD, YYYYMM oder YYYY. Dies wird mit dem Datentyp TS.DATE angezeigt.

Strukturbeispiel

Datum: "Juni 2008"

<effectiveTime value="200806"/>


Spezifikation

Beim Datum TS.DATE werden, sofern nicht anders spezifiziert, immer die folgenden Unterelemente/Attribute angegeben:

Element/Attribut DT Kard Konf Beschreibung
effectiveTime TS.DATE
@value ts 1..1 M Datum im Format YYYY, YYYYMM, YYYYMMDD
z.B. 20131224, 201312, 2013

Kontaktdaten-Elemente

telecom-Element TEL

Ein telecom Kommunikations-Element dient zur Angabe von Kontaktdaten zu einem Personen- oder Organisationselement.

Strukturbeispiele

Beispiele für Präfixe in TEL Elementen

<telecom value="tel:+43.1.40400"/>
<telecom value="fax:(02236)83.12323-12"/>
<telecom value="mailto:office@organisation.at"/>
<telecom value="http://www.organisation.at"/>


Beispiel für die Angabe einer Mobilnummer

<telecom use="MC" value="tel:+43.660.1234567"/>


Spezifikation

Bei TEL Elementen werden, sofern nicht anders spezifiziert, immer die folgenden Unterelemente/Attribute angegeben:

Element/Attribut DT Kard Konf Beschreibung
telecom TEL Kontakt-Element
@value url 1..1 M Die Kontaktadresse (Telefonnummer, Email, etc.)
Formatkonvention siehe „telecom – Format Konventionen für Telekom-Daten
Bsp: tel:+43.1.1234567
Zulässige Werteliste für telecom Präfixe gemäß Value-Set „ELGA_URLScheme
@use cs 0..1 O Bedeutung des angegebenen Kontakts (Heim, Arbeitsplatz, …)
Bsp: WP
Zulässige Werte gemäß Value-Set „ELGA_TelecomAddressUse

telecom – Format Konventionen für Telekom-Daten

Das @value Attribut des telecom-Elements …

  • … MUSS das URI Schema „tel:“, „mailto:“, etc. aufweisen
    • Zulässige Werteliste für telecom Präfixe gemäß Value-Set „ELGA_URLScheme
  • … MUSS im Falle von internationalen Telefonnummern mit einem „+“ beginnen
  • … DARF nur Ziffernzeichen 0 bis 9 nutzen sowie als visuelle Separatorzeichen nur Bindestrich –, Punkte . oder Klammern () verwenden.
    • … Leerzeichen sind in Telefonnummern NICHT ERLAUBT

Namen-Elemente

Namen-Elemente von Personen PN

Personen-Namen werden über das Element name abgebildet.

Die Bedeutung des Namen-Elements KANN mit dem Attribut @use angegeben werden. Fehlt das Attribut, wird der Name als „rechtlicher Name“ (Realname bzw. bürgerlicher Name) angenommen (entsprechend @use=“L“, legal name).

Werden mehrere Namen angegeben, MUSS die Bedeutung für jedes Namen-Element über das Attribut @use angegeben werden, wobei nur EIN rechtlicher Name angegeben werden DARF.

Granularitätsstufe 1: Unstrukturierte Angabe

In Granularitätsstufe 1 wird der Personen-Name unstrukturiert angegeben. Die einzelnen Elemente des Namens (Vorname, Nachname) werden nicht getrennt.

Strukturbeispiele

Beispiele für name-Elemente in Granularitätsstufe 1:

<name>Dr. Herbert Mustermann</name>


<name use="A">Dr. Kurt Ostbahn </name>


Spezifikation

Bei name-Elementen in dieser Granularitätsstufe werden, sofern nicht anders spezifiziert, immer die folgenden Elemente angegeben:

Element/Attribut DT Kard Konf Beschreibung
name PN Namen-Element (Person)
@use cs 0..1 O Die genaue Bedeutung des angegebenen Namens, beispielsweise, dass der angegebene Personen-Name ein „Künstlername“ ist. Weitere Bsp: L (rechtlicher Name), A (Künstlername), R (Ordensname)
Zulässige Werte gemäß Value-Set „ELGA_EntityNameUse

Wird kein @use Attribut angegeben, gilt der Name als rechtlicher Name („L“).

Granularitätsstufe 2: Strukturierte Angabe

In Granularitätsstufe 2 wird der Personen-Name strukturiert angegeben. Die einzelnen Elemente des Namens (mindesten der Vorname und Nachname) werden getrennt angegeben.

Strukturbeispiel

Beispiel für ein name-Element in Granularitätsstufe 2:

<name>
   <prefix qualifier="PR">OMedR</prefix>
   <prefix qualifier="AC">Dr.</prefix>
   <given>Sissi</given>
   <family>Österreich</family>
   <family qualifier="BR">Habsburg</family>
   <suffix qualifier="AC">MSc</suffix>
</name>
Spezifikation

Bei name-Elementen in dieser Granularitätsstufe werden, sofern nicht anders spezifiziert, immer die folgenden Elemente angegeben:

Element/Attribut DT Kard Konf Beschreibung
name PN Namen-Element (Person)
@use cs 0..1 O Die genaue Bedeutung des angegebenen Namens, beispielsweise, dass der angegebene Personen-Name ein „Künstlername“ ist.
Bsp: L (rechtlicher Name), A (Künstlername), R (Ordensname)

Zulässige Werte gemäß Value-Set „ELGA_EntityNameUse
Wird kein @use Attribut angegeben, gilt der Name als rechtlicher Name („L“).

prefix en.prefix 0..* O Beliebig viele Präfixe zum Namen
z.B. Akademische Titel, Adelstitel

Achtung: Die Angabe der Anrede („Frau“, „Herr“), ist im CDA nicht vorgesehen!


@qualifier cs 0..1 O Die genaue Bedeutung eines prefix-Elements, beispielsweise, dass das angegebene Präfix einen akademischen Titel darstellt.
z.B.: AC („Akademischer Titel“)
Zulässige Werte gemäß Value-Set „ELGA_EntityNamePartQualifier
given en.given 1..* M Mindestens ein Vorname
@qualifier cs 0..1 O Die genaue Bedeutung eines given-Elements, beispielsweise, dass das angegebene Element eine Initial (z.B. middle initial) bezeichnet.
z.B.: IN („Initial“)
Zulässige Werte gemäß Value-Set „ELGA_EntityNamePartQualifier
family en.family 1..* M Mindestens ein Hauptname (Nachname)
@qualifier cs 0..1 O Die genaue Bedeutung eines family-Elements, beispielsweise, dass das angegebene Element einen Geburtsnamen bezeichnet.
z.B.: BR („Geburtsname“)
Zulässige Werte gemäß Value-Set br/>Zulässige Werte gemäß Value-Set „ELGA_EntityNamePartQualifier
suffix en.suffix 0..* O Beliebig viele Suffixe zum Namen
z.B. Akademische Titel, Adelstitel
@qualifier cs 0..1 O Die genaue Bedeutung eines suffix-Elements, beispielsweise, dass das angegebene Suffix einen akademischen Titel darstellt.
z.B.: AC („Akademischer Titel“)
Zulässige Werte gemäß Value-Set br/>Zulässige Werte gemäß Value-Set „ELGA_EntityNamePartQualifier

Die korrekte Reihenfolge der einzelnen Namenselemente ist wichtig. Als Richtlinie gilt, dass diese in der "natürlichen" Reihenfolge der Benutzung des Namens angegeben werden. Das ist besonders in den folgenden Fällen relevant:

  • Präfixe (prefix) MÜSSEN immer vor dem Namen stehen, zu dem sie gehören.
  • Vornamen (given) MÜSSEN immer in der offiziellen (gesetzlichen) Sequenz stehen.
  • Nachnamen (family) und ein eventuelles Trennzeichen (meistens ‘-‘) MÜSSEN in der offiziellen Sequenz stehen, abhängig von der Wahl bei der Eheschließung.
  • Suffixe (suffix) MÜSSEN immer hinter dem Namen stehen, zu dem sie gehören.

Für die Namenselemente kann zur näheren Bestimmung ein Qualifier angegeben werden (aus dem Value Set ELGA_EntityNamePartQualifier“), v.a. für Prefix/Suffix.

Es gibt auch nicht näher bestimmte Prefixe/Suffixe, z.B. trifft das für die Angabe von "Junior" oder "Senior" bzw "Jun."/"Sen" oder "Jr."/"Sr" zu.

<name>
  <given>Herbert</given>
  <family>Mustermann</family>
  <suffix>Sen.</suffix>
</name>

Namen-Elemente von Organisationen ON

Organisations-Namen werden über das Element name abgebildet.

Dieser Implementierungsleitfaden lässt nur die unstrukturierte Angabe des Organisationsnamens zu. Die Verwendung des @qualifier Attributs beim name-Element ist nicht gestattet.

Strukturbeispiel

Beispiel für die Angabe eines Organisationsnamens:

<name>Krankenhaus Wels</name>


Spezifikation

Element/Attribut DT Kard Konf Beschreibung
name ON Name der Organisation

Adress-Elemente

Adressen von Personen und Organisationen werden über das Element addr abgebildet. Das Adress-Element kann in verschiedenen Kontexten mit unterschiedlicher Detailgenauigkeit vorkommen. Daher werden drei Granularitätsstufen definiert, auf die je nach Anwendung entsprechend verwiesen wird.

Sind keine Adressdaten vorhanden, kann das Element entweder wegelassen werden oder mit NullFlavor angegeben werden – je nachdem wie das Adress-Element im Kontext spezifiziert wurde.

Granularitätsstufe 1: Unstrukturierte Angabe

In Granularitätsstufe 1 wird die Adresse unstrukturiert angegeben. Die einzelnen Elemente der Adresse (Straße, PLZ, Ort, …) werden nicht getrennt.

Hinweis: Diese Granularitätsstufe wird für Adressen in e-Impfpass nicht verwendet!


Granularitätsstufe 2: Strukturierte Angabe, Stufe 1

In Granularitätsstufe 2 wird die Adresse strukturiert angegeben, wobei aber Straße und Hausnummer noch zusammen angegeben werden.

Strukturbeispiel

Beispiel für ein addr-Element in Granularitätsstufe 2:

<addr>
   <streetAddressLine>Musterstraße 11a/2/1</streetAddressLine>
   <postalCode>7000</postalCode>
   <city>Eisenstadt</city>
   <state>Burgenland</state>
   <country>AUT</country>
   <additionalLocator>Station A, Zimmer 9</additionalLocator>
</addr>

Spezifikation

Bei addr-Elementen in dieser Granularitätsstufe werden, sofern nicht anders spezifiziert, immer die folgenden Elemente angegeben:

Element/Attribut DT Kard Konf Beschreibung
addr AD Namen-Element
@use cs 0..1 O Die genaue Bedeutung der angegebenen Adresse, beispielsweise, dass die angegebene Adresse die Wohn-Adresse ist.
Bsp: HP („Home primary“)
Zulässige Werte gemäß Value-Set

ELGA_AddressUse
Wird kein @use Attribut angegeben, gilt bei Personen die Adresse als „Wohnadresse“ („H“) und bei Organisationen als Büroadresse („WP“).

streetAddressLine ADXP 1..1 M Straße mit Hausnummer
Bsp: Musterstraße 11a/2/1
postalCode ADXP 1..1 M Postleitzahl
city ADXP 1..1 M Stadt
state ADXP 0..1 O Bundesland
country ADXP 1..1 M Staat

Es wird EMPFOHLEN, den Staat im ISO 3 Ländercode (ISO-3166-1 Alpha 3) anzugeben, z.B. „AUT“ für Österreich, „DEU“ für Deutschland…

additionalLocator ADXP 0..1 O Zusätzliche Addressinformationen
z.B.: Station, Zimmernummer im Altersheim

Granularitätsstufe 3: Strukturierte Angabe, Stufe 2

In Granularitätsstufe 3 wird die Adresse maximal strukturiert angegeben (Straße und Hausnummer getrennt).

Strukturbeispiel

Beispiel für ein addr-Element in Granularitätsstufe 3:

<addr>
   <streetName>Musterstraße</streetName>
   <houseNumber>11a/2/1</houseNumber>
   <postalCode>7000</postalCode>
   <city>Eisenstadt</city>
   <state>Burgenland</state>
   <country>AUT</country>
   <additionalLocator>Station A, Zimmer 9</additionalLocator>
</addr>

Spezifikation

Bei addr-Elementen in dieser Granularitätsstufe werden, sofern nicht anders spezifiziert, immer die folgenden Elemente angegeben:

Element/Attribut DT Kard Konf Beschreibung
addr AD Namen-Element
@use cs 0..1 O Die genaue Bedeutung der angegebenen Adresse, beispielsweise, dass die angegebene Adresse die Wohn-Adresse ist.
Bsp: HP („Home primary“)
Zulässige Werte gemäß Value-Set

ELGA_AddressUse
Wird kein @use Attribut angegeben, gilt bei Personen die Adresse als „Wohnadresse“ („H“) und bei Organisationen als Büroadresse („WP“).

streetName ADXP 1..1 M Straße
Bsp: Musterstraße
houseNumber ADXP 1..1 M Hausnummer
Bsp: 11a/2/1
postalCode ADXP 1..1 M Postleitzahl
city ADXP 1..1 M Stadt
state ADXP 0..1 R Bundesland
country ADXP 1..1 M Staat

Es wird EMPFOHLEN, den Staat im ISO 3 Ländercode (ISO-3166-1 Alpha 3) anzugeben, z.B. „AUT“ für Österreich, „DEU“ für Deutschland…

additionalLocator ADXP 0..1 O Zusätzliche Addressinformationen
z.B.: Station, Zimmernummer im Altersheim

Komplexe (zusammengesetzte) Elemente

Personen-Element

Personen-Elemente im CDA sind komplexe, zusammengesetzte Objekte und dienen zur Abbildung von Personen. Ein Personen-Element beinhaltet im Wesentlichen das name-Element der Person.

Strukturbeispiel

<assignedPerson>
  <name>
    <prefix qualifier="AC">Dr.</prefix>
    <given>Hubert</given>
    <family>Muster</family>
  </name>
</assignedPerson>

Spezifikation

Bei Personen-Elementen MÜSSEN, sofern nicht anders spezifiziert, immer die folgenden Elemente angegeben werden:

Element/Attribut DT Kard Konf Beschreibung
name PN 1..* M Name der Person
Grundsätzlich sind die Vorgaben gemäß „Namen-Elemente von Personen PN“ zu befolgen.

Organisations-Element

Organisations-Elemente im CDA sind komplexe, zusammengesetzte Objekte und dienen zur Abbildung von Organisationen unter Berücksichtigung ihrer essentiellen Informationen, wie ID, Name, Adresse, Kontaktdaten, etc.

Strukturbeispiel

<serviceProviderOrganization>
   <id root="1.2.40.0.34.3.1.xxx" assigningAuthorityName="GDA Index"/>
   <name>Amadeus Spital</name>
   <telecom value="tel:+43.1.3453446.0"/>
   <telecom value="fax:+43.1.3453446.4674"/>
   <telecom value="mailto:info@amadeusspital.at"/>
   <telecom value="http://www.amadeusspital.at"/>
   <addr>
	<streetName>Mozartgasse</streetName>
	<houseNumber>1-7</houseNumber>
	<postalCode>1234</postalCode>
	<city>St.Wolfgang</city>
	<state>Salzburg</state>
	<country>AUT</country>
   </addr>
</serviceProviderOrganization>

Spezifikation

Bei Organisations-Elementen MÜSSEN, sofern nicht anders spezifiziert, immer die folgenden Elemente angegeben werden:

id
Element/Attribut DT Kard Konf Beschreibung
id II 0..* O Beliebig viele IDs der Organisation. z.B.: ID aus dem GDA-Index, DVR-Nummer, ATU-Nummer, etc.
Grundsätzlich sind die Vorgaben gemäß „Identifikations-Elemente“ zu befolgen.
Name der Organisation
Element/Attribut DT Kard Konf Beschreibung
name PN 1..1 M Name der Organisation
Grundsätzlich sind die Vorgaben gemäß „Namen-Elemente von Organisationen ON“ zu befolgen.
Kontakt-Elemente der Organisation
Element/Attribut DT Kard Konf Beschreibung
telecom TEL 0..* O Beliebig viele Kontakt-Elemente der Organisation
Grundsätzlich sind die Vorgaben gemäß „Kontaktdaten-Element“ zu befolgen.
Adress-Element der Organisation
Element/Attribut DT Kard Konf Beschreibung
addr AD 0..1 O Ein Adress-Elemente der Organisation
Grundsätzlich sind die Vorgaben gemäß „Adress-Elemente“ zu befolgen.

AssignedEntity-Element (Person + Organisation)

AssignedEntity-Elemente im CDA sind komplexe, zusammengesetzte Objekte und dienen zur Abbildung von abstrakten Entitäten, welche sich aus Person- und Organisationsinformationen zusammensetzen.

Hierbei MUSS jedenfalls die „Person“ der Entität angegeben werden. Die Angabe der Organisation, der die Person angehört, ist prinzipiell optional. Diese Optionalität kann sich in Abhängigkeit vom konkreten Anwendungsfall in „verpflichtend“ ändern.

Strukturbeispiel

<assignedEntity>
  <id root="1.2.40.0.34.99.111.1.3"
      extension="2222"
      assigningAuthorityName="Amadeus Spital"/>
  <addr>
      <streetName>Währinger Gürtel</streetName>
      <houseNumber>18-20</houseNumber>
      <postalCode>1090</postalCode>
      <city>Wien</city>
      <state>Wien</state>
      <country>AUT</country>
  </addr>
  <telecom value="tel:+43.1.3453446.0"/>
  <telecom value="fax:+43.1.3453446.4674"/>
  <telecom value="mailto:info@amadeusspital.at"/>
  <telecom value="http://www.amadeusspital.at"/>
  <assignedPerson>
	:
  </assignedPerson>
  <representedOrganization>
	:
  </representedOrganization>
</assignedEntity>

Spezifikation

Bei AssignedEntity-Elementen MÜSSEN, sofern nicht anders spezifiziert, immer die folgenden Elemente angegeben werden:

id
Element/Attribut DT Kard Konf Beschreibung
id II 1..* R Mindestens eine ID der Person der Entität

Zugelassene nullFlavor:

  • NI … Die Person der Entität hat keine Identifikationsnummer
  • UNK … Die Person der Entität hat eine Identifikationsnummer, diese ist jedoch unbekannt

Grundsätzlich sind die Vorgaben gemäß „Identifikations-Elemente“ zu befolgen.

Adress-Element der Organisation
Element/Attribut DT Kard Konf Beschreibung
addr AD 0..1 O Ein Adress-Element der Person der Entität

Grundsätzlich sind die Vorgaben gemäß „Adress-Elemente“ zu befolgen.

Kontakt-Elemente der Organisation
Element/Attribut DT Kard Konf Beschreibung
telecom TEL 0..* O Beliebig viele Kontakt-Elemente der Person der Entität

Grundsätzlich sind die Vorgaben gemäß „Kontaktdaten-Element“ zu befolgen.

Personen-Element der Entität
Element/Attribut DT Kard Konf Beschreibung
assignedPerson POCD_MT000040.
Person
1..1 M Personendaten der Person der Entität

Grundsätzlich sind die Vorgaben gemäß „Personen-Element“ zu befolgen.

Organisations-Element der Entität
Element/Attribut DT Kard Konf Beschreibung
representedOrganization POCD_MT000040.
Organization
0..1 O Organisationsdaten der Entität

Grundsätzlich sind die Vorgaben gemäß „Organisations-Element“ zu befolgen.

  1. OID Portal für das Österreichische Gesundheitswesen [Online Juli 2019]: https://www.gesundheit.gv.at/OID_Frontend/