Vorlage:Elga-cdalab-2.06.3: Dokumentenstruktur

Aus HL7 Austria MediaWiki
Wechseln zu: Navigation, Suche

1 Dokumentenstruktur

1.1 Elemente ohne spezielle Vorgaben

  • XML Metainformationen
  • Wurzelelement
  • Hoheitsbereich („realmCode“)
  • Dokumentformat („typeId“)
  • Dokumenten-Id („id”)
  • Erstellungsdatum des Dokuments („effectiveTime“)
  • Vertraulichkeitscode („confidentialityCode“)
  • Sprachcode des Dokuments („languageCode“)

Verweis auf den Allgemeinen Leitfaden:
Das Element erfordert keine speziellen Vorgaben. Es gelten die Vorgaben des entsprechenden Kapitels des „Allgemeinen Implementierungsleitfadens“.


Auszug aus dem Allgemeinen Implementierungsleitfaden

1.2 XML Metainformationen

1.2.1 Zeichencodierung

CDA-Dokumente MÜSSEN mit UTF-8 (8-Bit Universal Character Set Transformation Format, nach RFC 3629 / STD 63 (2003)) codiert werden.

<?xml version="1.0" encoding="UTF-8" standalone=”yes”?>
<ClinicalDocument xmlns="urn:hl7-org:v3">
:


1.2.2 Hinterlegung eines Stylesheets

Um ein CDA-Dokument in einem Webbrowser anzeigen zu können, muss es nach HTML tranformiert werden. Das kann durch eine XSLT-Transformation (ein so genanntes „Stylesheet“) geschehen. Ist das Stylesheet im angegebenen Pfad erreichbar, wird dieses beim Öffnen des CDA-Dokuments mit einem Browser üblicherweise automatisch auf das CDA-Dokument angewandt und die Darstellung gerendert.

ELGA stellt zur einheitlichen Darstellung von CDA-Dokumenten ein „Referenz-Stylesheet“ zur Verfügung (Download ist von der ELGA Website http://www.elga.gv.at/cda möglich). Da der Zugriff auf XSLT-Programme von den meisten Browsern eingeschränkt ist, wird kein absoluter Pfad auf eine Webressource angegeben.

<?xml version="1.0" encoding="UTF-8" standalone=”yes”?>
<?xml-stylesheet type="text/xsl" href="ELGA_Stylesheet_v1.0.xsl"?>
 <ClinicalDocument xmlns="urn:hl7-org:v3">
:

Das Stylesheet „ELGA_Stylesheet_v1.0.xsl“ MUSS angegeben werden [M]. Die Angabe eines Pfades ist NICHT ERLAUBT. Ausnahmen können für automatisiert erstellte Dokumente notwendig sein, diese müssen im allgemeinen und speziellen Leitfäden beschrieben werden.

1.3 Wurzelelement

Der XML-Namespace für CDA Release 2.0 Dokumente ist urn:hl7-org:v3 (Default-Namespace). Dieser MUSS in geeigneter Weise in jeder CDA XML Instanz genannt werden. In speziellen Leitfäden können weitere namespace-Präfixe angegeben werden.

Für ELGA CDA-Dokumente MUSS der Zeichensatz UTF-8 verwendet werden.

CDA-Dokumente beginnen mit dem Wurzelelement ClinicalDocument, der grobe Aufbau ist im folgenden Übersichtsbeispiel gegeben. 

<ClinicalDocument xmlns="urn:hl7-org:v3">
   <!-- CDA Header -->
      … siehe Beschreibung CDA R2 Header …
   <!-- CDA Body -->
   <component>
      <structuredBody>
         … siehe Beschreibung CDA R2 Body …
      </structuredBody>
   </component>
</ClinicalDocument>

1.4 Hoheitsbereich des Dokuments („realmCode“)

Dieses Element kennzeichnet, dass das Dokument aus dem Hoheitsbereich Österreich (bzw. Bereich der HL7 Affiliate Austria, Code „AT“) stammt.

1.4.1 Strukturbeispiel

<realmCode code="AT'"/>


1.4.2 Spezifikation

Element/Attribut DT Kard Konf Beschreibung
realmCode CS
CNE		 1..1 M Hoheitsbereich des Dokuments

Fester Wert: @code = AT
(aus ValueSet „ELGA_RealmCode“)

1.5 Dokumentformat („typeId“)

Dieses Element kennzeichnet, dass das Dokument im Format CDA R2 vorliegt.

1.5.1 Strukturbeispiel

<typeId root="2.16.840.1.113883.1.3" extension="POCD_HD000040"/>


1.5.2 Spezifikation

Element/Attribut DT Kard Konf Beschreibung
typeId II 1..1 M Dokumentformat CDA R2
Feste Werte:
@root = 2.16.840.1.113883.1.3'
@extension = POCD_HD000040

1.6 Dokumenten-Id („id”)

Die Dokumenten-Id eines CDA-Dokuments ist ein eindeutiger Instanzidentifikator, der das Dokument weltweit eindeutig und für alle Zeit identifiziert. Ein CDA-Dokument hat genau eine Id.

1.6.1 Strukturbeispiel

<id
  root="1.2.40.0.34.99.111.1.1"
  extension="134F989"
  assigningAuthorityName="Amadeus Spital"/>

1.6.2 Spezifikation

Es MUSS eine gültige und innerhalb des ID-Pools eindeutige Dokumenten-ID angegeben werden.

Element/Attribut DT Kard Konf Beschreibung
id II 1..1 M Dokumenten-Id

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

1.7 Erstellungsdatum des Dokuments („effectiveTime“)

1.7.1 Spezifikation

Id1.2.40.0.34.11.90008
ref
elgabbr-
Gültigkeit2016‑07‑21
Andere Versionen mit dieser Id:
  • Kblank.png CDeffectiveTime vom 2013‑11‑07
StatusKgreen.png AktivVersions-Label
NameCDeffectiveTimeBezeichnungCD effectiveTime
Beschreibung

Mit Erstellungsdatum ist jenes Datum gemeint, welches normalerweise im Briefkopf eines Schriftstückes angegeben wird. (z.B.: Wien, am …). Das Erstellungsdatum dokumentiert den Zeitpunkt, an dem das Dokument inhaltlich fertiggestellt wurde.

Bemerkung: Das Erstellungsdatum des Dokuments muss nicht mit dem Datum der rechtli-chen Unterzeichnung (oder „Vidierung“) übereinstimmen.

KlassifikationCDA Header Level Template
Offen/GeschlossenOffen (auch andere als die definierten Elemente sind erlaubt)
Assoziiert mit
Assoziiert mit 1 Konzept
IdNameDatensatz
elgagab-data​element-8Kyellow.png Erstellungsdatum Kyellow.png Datensatz
BeziehungVersion: Template 1.2.40.0.34.11.90008 CD effectiveTime (2016‑07‑21)
ref
elgabbr-
Beispiel
Nur Datum: Zeitpunkt als Datum (ohne Zeit) im Format YYYYMMDD
<effectiveTime value="20081224"/>
Beispiel
Datum, Zeit und Zeitzone: Zeitpunkt als Datum mit Zeit und Zeitzone im Format YYYYMMDDhhmmss[+/-]HHMM
<effectiveTime value="20081224082015+0100"/>
ItemDTKardKonfBeschreibungLabel
hl7:effectiveTime
TS.AT.TZ1 … 1M
Erstellungsdatum des Dokuments.
Grundsätzlich sind die Vorgaben für „Zeit-Elemente“ zu befolgen.
(CDe...ime)
 
Target.png
elgagab-data​element-8Kyellow.png Erstellungsdatum Kyellow.png Datensatz

1.8 Vertraulichkeitscode („confidentialityCode“)

1.8.1 Spezifikation

Id1.2.40.0.34.11.90009
ref
elgabbr-
Gültigkeit2013‑11‑07
StatusKgreen.png AktivVersions-Label
NameCDconfidentialityCodeBezeichnungCD confidentialityCode
Beschreibung

“Vertraulichkeitscode” (im CDA das Element ClinicalDocument/confidentialityCode) bezeichnet die Vertraulichkeitsstufe dieses Dokuments.

Der tatsächliche Zugriff auf das Dokument muss von der übergeordneten Infrastrukturschicht geregelt werden. Die Information des Vertraulichkeitscodes im Dokument selbst, dient nur der reinen Information und hat keine technischen Konsequenzen.

Da Dokumente nach der Vidierung weder technisch noch legistisch geändert werden dürfen, kann der Vertraulichkeitscode keine konkreten Zugriffsrechte auf das Dokument regeln, sondern nur auf „Metaebenen“, wie beispielsweise „geltendes Recht XY“ oder weiterführende Verwendungen über das IHE BPPC Profil, verweisen.

KlassifikationCDA Header Level Template
Offen/GeschlossenOffen (auch andere als die definierten Elemente sind erlaubt)
Assoziiert mit
Assoziiert mit 1 Konzept
IdNameDatensatz
elgagab-data​element-266Kyellow.png Vertraulichkeitscode Kyellow.png Datensatz
BeziehungVersion: Template 1.2.40.0.34.11.90009 CD confidentialityCode (2013‑11‑07)
ref
elgabbr-
Beispiel
Beispiel
<confidentialityCode code="N" codeSystem="2.16.840.1.113883.5.25" displayName="normal"/>
ItemDTKardKonfBeschreibungLabel
hl7:confidentialityCode
CE1 … 1M(CDc...ode)
 
Target.png
elgagab-data​element-266Kyellow.png Vertraulichkeitscode Kyellow.png Datensatz
Treetree.png@code
CONF1 … 1FN
Treetree.png@codeSystem
1 … 1F2.16.840.1.113883.5.25 (BasicConfidentialityKind)
Treetree.png@displayName
1 … 1Fnormal

1.9 Sprachcode des Dokuments („languageCode“)

1.9.1 Spezifikation

Id1.2.40.0.34.11.90010
ref
elgabbr-
Gültigkeit2013‑11‑07
StatusKgreen.png AktivVersions-Label
NameCDlanguageCodeBezeichnungCD languageCode
Beschreibung

Die Sprache des Dokuments wird in diesem Attribut gemäß IETF (Internet Engineering Task Force), RFC 1766: Tags for the Identification of Languages nach ISO-639-1 (zweibuchstabige Codes für Sprachen, Kleinbuchstaben) und ISO 3166 (hier: zweibuchstabige Ländercodes, Großbuchstaben) festgelegt.

Das Format ist entsprechend ss-CC, mit ss, zwei Kleinbuchstaben für den Sprachencode gemäß ISO-639-1, und CC, zwei Großbuchstaben für den Ländercode gemäß ISO 3166 (Tabelle mit zwei Buchstaben).

KlassifikationCDA Header Level Template
Offen/GeschlossenOffen (auch andere als die definierten Elemente sind erlaubt)
Assoziiert mit
Assoziiert mit 1 Konzept
IdNameDatensatz
elgagab-data​element-265Kyellow.png Sprachcode Kyellow.png Datensatz
BeziehungVersion: Template 1.2.40.0.34.11.90010 CD languageCode (2013‑11‑07)
ref
elgabbr-
Beispiel
Beispiel
<languageCode code="de-AT"/>
ItemDTKardKonfBeschreibungLabel
hl7:language​Code
CS.LANG1 … 1MSprachcode des Dokuments.(CDl...ode)
 
Target.png
elgagab-data​element-265Kyellow.png Sprachcode Kyellow.png Datensatz
Treetree.png@code
CONF1 … 1Fde-AT


1.10 Elemente mit spezielle Vorgaben

1.10.1 Template („ClinicalDocument/templateId“)

Das Template definiert die Summe der Einschränkungen dieser Spezifikation in Bezug auf den CDA R2 Standard. Eine templateID für den ELGA Laborbefund ist anzugeben. Ein Dokument, welches dem vorliegenden Implementierungsleitfaden folgt, muss auch dem übergeordneten „Allgemeinen Implementierungsleitfaden“ folgen. Als templateID für CDA Labordokumente gemäß diesem Leitfaden ist 1.2.40.0.34.11.4 zu verwenden.

1.10.1.1 Strukturbeispiel
<ClinicalDocumentxmlns="urn:hl7-org:v3">
  : 	
  <!-- ELGA CDA Dokumente -->
  <templateId root="1.2.40.0.34.11.1"/>
  <!-- ELGA CDA Laborbefund -->
  <templateId root="1.2.40.0.34.11.4"/>

  <!--   In Abhängigkeit von der ELGA Interoperabilitätsstufe (EIS) -->
  <!-- EIS „Basic“ -->
  <templateId root="1.2.40.0.34.11.4.0.1"/>
  ... oder ...
  <!-- EIS „Enhanced“ -->
  <templateId root="1.2.40.0.34.11.4.0.2"/>
  ... oder ...
  <!-- EIS „Full support“ -->
  <templateId root="1.2.40.0.34.11.4.0.3"/>
  :
</ClinicalDocument>
1.10.1.2 Spezifikation
Element/Attribut DT Kard Konf Beschreibung
templateId II 1..1 M ELGA TemplateId für den Allgemeinen Implementierungsleitfaden
Fester Wert: @root = 1.2.40.0.34.11.1
templateId II 1..1 M ELGA TemplateId für den speziellen Implementierungsleitfaden Laborbefund
Fester Wert: @root = .2.40.0.34.11.4
--- zusätzlich eine der folgenden templateIds ---
Im Falle von EIS „Basic“

(Das Dokument enthält entweder unstrukturierten oder eingebetteten Inhalt (z.B. PDF) oder enthält strukturierten Inhalt, wobei jedoch nicht alle Sektionen den Vorgaben von EIS „Enhanced“ oder höher folgen)

templateId II 1..1 M ELGA CDA Laborbefund
Fester Wert @root = 1.2.40.0.34.11.4.0.1
--- oder ---
Im Falle von EIS „Enhanced“
(Alle Sections folgen ausnahmelos den Vorgaben von EIS „Enhanced“ oder höher, aber nicht alle Sections folgen den Vorgaben von EIS „Full support“)
templateId II 1..1 M ELGA CDA Laborbefund in EIS „Enhanced“
Fester Wert @root = 1.2.40.0.34.11.4.0.2
--- oder ---
Im Falle von EIS „Full support“:

(Alle Sektionen folgen ausnahmslos den Vorgaben von EIS „Full support“)

templateId II 1..1 M ELGA CDA Laborbefund in EIS „Full support“
Fester Wert @root = 1.2.40.0.34.11.4.0.3

1.10.2 Dokumentenklasse (“ClinicalDocument/code”)

Die zur Anwendung kommende Dokumentenklasse wird durch den LOINC Code 11502-2 für einen allgemeinen Laborbefund („multidisciplinary laboratory report“) abgebildet. Im Falle eines reinen mikrobiologischen Befundes wird der LOINC Code 18725-2 (Microbio-logy studies) zur Codierung der Dokumentenklasse verwendet.

Diese Codierung stellt einen allgemeinen Laborbefund dar, der es erlaubt beliebige Befundarten und Ergebnisse im Rahmen eines Dokumentes zu übermitteln, auch wenn der Befund nur eine bestimmte Befundart (wie z.B. Hämatologie) enthält. Diesem Umstand wird jedoch durch die Angabe der enthaltenen Laborbefundarten bei der Registrierung eines Labordokumentes in der Registry Rechnung getragen. Durch die Registrierung der in einem Labordokument enthaltenen Befundkategorien über die Service-Event-Metadaten („eventCodeList“) sind auch Detailbefunde in der ELGA einfach auffindbar.

1.10.3 Strukturbeispiel

<ClinicalDocumentxmlns="urn:hl7-org:v3">
	:
	<!-- —Dokumentenklasse für den allgemeinen Laborbefund (welcher event. auch
    mikrobiologische Ergebnisse enthalten kann) -->
<code code="11502-2" codeSystem="2.16.840.1.113883.6.1"
 codeSystemName="LOINC"
 displayName="Laboratory report"/>
	
	<!-- Titel des Dokuments -->
	<title>Allgemeiner Laborbefund</title>
	
<!--  ODER  -->:

 <!—Dokumentenklasse für den mikrobiologischen Befund -->
<code code="18725-2" codeSystem="2.16.840.1.113883.6.1"
 codeSystemName="LOINC"
 displayName="Microbiology studies"/>
	
	<!-- Titel des Dokuments -->
	<title></title>

</ClinicalDocument>
1.10.3.1 Spezifikation
Element/Attribut DT Kard Konf Beschreibung
code CE
CWE		 1..1 M Code des Dokuments
@code cs 1..1 M Fester Wert für den allgemeinen Laborbefund: 11502-2
ODER
Fester Wert für den mikrobiologischen Befund:
18725-2
@displayName st 0..1 R2 Fester Wert für den allgemeinen Laborbefund: Laboratory report
ODER
Fester Wert für den mikrobiologischen Befund:
Microbiology studies
@codeSystem uid 1..1 M Fester Wert: 2.16.840.1.113883.6.1
@codeSystemName ADXP 0..1 R2 Fester Wert: LOINC

1.10.4 Dokumenttitel („ClinicalDocument/title“)

Der Titel des Dokumentes ist verpflichtend anzugeben, vom Ersteller frei zu vergeben und beschreibt die Art des Dokumentes näher. Der Titel des Dokuments ist für den lesenden Do-kumentempfänger das sichtbare Element. Dieser wird nicht dem Attribut displayName des Elements code entnommen, sondern dem (verpflichtenden) Element title. Der Sinn der Be-nennung ist jedoch gemäß der Dokumentenklassen zu wählen. Im allgemeinen Fall wird die Bezeichnung „Laborbefund“ verwendet bzw. die Bezeichnung „Mikrobiologischer Befund“ für mikrobiologische Befunde.

1.10.4.1 Strukturbeispiel
<ClinicalDocumentxmlns="urn:hl7-org:v3">
	:
	<!-- Dokumentenklasse -->
        <code code="11502-2" codeSystem="2.16.840.1.113883.6.1" codeSystemName="LOINC" displayName="Laboratory report"/>
	
	<!-- Titel des Dokuments -->
	<title>Allgemeiner Laborbefund</title>
	:
</ClinicalDocument>
1.10.4.2 Spezifikation
Element/Attribut DT Kard Konf Beschreibung
title ST 1..1 M Dokumententitel
Der Sinn der Benennung MUSS mit der Dokumentenklasse übereinstimmen.

1.10.5 Versionierung des Dokuments („setId“ und „versionNumber“)

Für alle Dokumente ist gemäß den Vorgaben des „Allgemeinen Implementierungsleitfadens“ eine Versionierung verpflichtend vorzusehen. Für Detailinformationen wird auf dieses Dokument verwiesen. 

<ClinicalDocument xmlns="urn:hl7-org:v3">
	:
	<!-- Versionierung des Dokuments -->
	<setId root="2.2.40.0.34.99.111.1.1" extension="AAAAAAAAAAAAAAAAAAA"/>
	<versionNumber value="1"/>
	:
</ClinicalDocument>
Abgerufen von „http://wiki.hl7.at/index.php?title=Vorlage:Elga-cdalab-2.06.3:_Dokumentenstruktur&oldid=13932“