elga-cdaalf-2.06.2:Dokumentenstruktur: Unterschied zwischen den Versionen

Aus HL7 Austria MediaWiki
Wechseln zu: Navigation, Suche
[gesichtete Version][Markierung ausstehend]
K (Lahnsteiner verschob die Seite elga-cdaalf-2.06.2:Dokumentenstruktur nach Dokumentenstruktur)
(Dokumentenklasse („code“))
 
(Eine dazwischenliegende Version von einem anderen Benutzer wird nicht angezeigt)
Zeile 7: Zeile 7:
  
 
===Dokumentenklasse („code“)===
 
===Dokumentenklasse („code“)===
Der “Code des Dokuments” (im CDA das Element ''ClinicalDocument/code'') bezeichnet die „'''''Dokumentklasse''''“ bzw den präziseren „''''Dokumenentyp''''“.
+
Der “Code des Dokuments” (im CDA das Element ''ClinicalDocument/code'') bezeichnet die „'''''Dokumentklasse''''“ bzw den präziseren „''''Dokumententyp''''“.
  
 
Beispiele für die Klasseneinteilung der Dokumente:
 
Beispiele für die Klasseneinteilung der Dokumente:

Aktuelle Version vom 18. Juli 2018, 08:15 Uhr

1 Dokumentenstruktur

1.1 XML Metainformationen

1.1.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.1.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.2 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.3 Hoheitsbereich des Dokuments („realmCode“)

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

1.3.1 Strukturbeispiel

<realmCode code="AT'"/>


1.3.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.4 Dokumentformat („typeId“)

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

1.4.1 Strukturbeispiel

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


1.4.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.5 ELGA Implementierungsleitfaden-Kennzeichnung („templateId“)

Templates sind definierte Vorlagen, die Strukturen von Dokumenten, Dokumentteilen oder Datenelementen vorgeben. In CDA bezeichnen solche Templates bestimmte Teilstrukturen. Mittels templateId-Elementen können Teile von CDA-Dokumenten hinsichtlich ihrer Konformität zu Templates oder Implementierungsleitfäden gekennzeichnet werden.

Der Einsatz von so genannten „templateId”-Elementen sichert zu, dass eine CDA-Instanz nicht nur CDA konform ist, sondern auch dem referenzierten Template oder Implementierungsleitfaden entspricht. Mit Zusicherung ist dabei nur eine informelle Behauptung des Verfassers gemeint und nicht notwendigerweise auch eine erfolgreich durchgeführte Validierung bzw. Zertifizierung.

Ein CDA Dokument, welches den Vorgaben dieses Implementierungsleitfadens entspricht, ist berechtigt und verpflichtet, die entsprechende templateId-Kennung einzutragen.

1.5.1 Strukturbeispiel

<ClinicalDocument xmlns="urn:hl7-org:v3">
  <realmCode code="AT"/>
  <typeId root="2.16.840.1.113883.1.3" extension="POCD_HD000040"/>

  <!—   Folgt dem vorliegenden Implementierungsleitfaden-Template -->
  <templateId root="1.2.40.0.34.11.1"/>
  
  <!—   Beliebig viele weitere templateIds, falls das Dokumente noch weiteren Implementierungsleitfäden oder Spezifikationen folgt -->
  <templateId root="…"/>
	:
</ClinicalDocument>

1.5.2 Spezifikation

Die OID des vorliegenden Implementierungsleitfadens MUSS im @root Attribut des Elements angegeben werden.

Mit Angabe dieses Elements wird ausgesagt, dass das vorliegende CDA-Dokument zu diesem Implementierungsleitfaden konform ist.

Element/Attribut DT Kard Konf Beschreibung
templateId[1] II 1..1 M ELGA TemplateId für den Allgemeinen Implementierungsleitfaden

Fester Wert: @root = 1.2.40.0.34.11.1

templateId[n] II 0..* O Weitere TemplateIds

Verweis auf speziellen Implementierungsleitfaden:
Des Weiteren können zusätzlich die geforderten templateIds eines weiteren speziellen Implementierungsleitfadens angegeben werden (z.B. Entlassungsbrief, Laborbefund, etc.).

Die jeweils im @root Attribut einzutragende OID entnehmen Sie bitte den entsprechenden Implementierungsleitfaden gemäß der Dokumentklasse.

Folgt das CDA-Dokument noch anderen Implementierungsleitfäden oder Spezifikationen können beliebig viele weitere templateId-Elemente angegeben werden. 

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 Dokumentenklasse („code“)

Der “Code des Dokuments” (im CDA das Element ClinicalDocument/code) bezeichnet die „Dokumentklasse'“ bzw den präziseren „'Dokumententyp'“.

Beispiele für die Klasseneinteilung der Dokumente:

Für das Mapping in XDS siehe den entsprechenden Leitfaden „ELGA XDS Metadaten“.

1.7.1 Strukturbeispiel

  displayName="Physician Discharge summary"
  codeSystem="2.16.840.1.113883.6.1"
  codeSystemName="LOINC" />

1.7.2 Spezifikation

Element/Attribut DT Kard Konf Beschreibung
code CE
CWE
1..1 M Dokumententyp oder Dokumentenklasse

Zulässige Werte gemäß Value-Set „ELGA_Dokumentklassen
Grundsätzlich sind die Vorgaben gemäß „code-Element CE CWE“ zu befolgen.

Verweis auf speziellen Implementierungsleitfaden:
Die gültigen Wertebereiche dieses Elements entnehmen Sie bitte den entsprechenden speziellen Implementierungsleitfaden gemäß der Dokumentklasse bzw dem Dokumententyp.


1.8 Titel des Dokuments („title“)

“Titel” (im CDA das Element ClinicalDocument/title) bezeichnet die verpflichtende „Dokumentenüberschrift“ (zusätzlich zur Dokumentenklasse).

Beispiele für Titel der Dokumente:

  • „Arztbrief“
  • „Entlassungsbrief der gynäkologischen Abteilung des SMZ Ost“
  • „Vorläufiger Entlassungsbrief“
  • „Befundbericht“

1.8.1 Strukturbeispiel

<title>Entlassungsbrief</title>


1.8.2 Spezifikation

Element/Attribut DT Kard Konf Beschreibung
title ST 1..1 M Dokumententitel

Der Sinn der Benennung MUSS mit der Dokumentklasse übereinstimmen.

1.9 Erstellungsdatum des Dokuments („effectiveTime“)

1.9.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
NameCDeffectiveTimeAnzeigenameCD 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.10 Vertraulichkeitscode („confidentialityCode“)

1.10.1 Spezifikation

Id1.2.40.0.34.11.90009
ref
elgabbr-
Gültigkeit2013‑11‑07
StatusKgreen.png AktivVersions-Label
NameCDconfidentialityCodeAnzeigenameCD 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 (Confidentialty (HL7))
Treetree.png@displayName
1 … 1Fnormal

1.11 Sprachcode des Dokuments („languageCode“)

1.11.1 Spezifikation

Id1.2.40.0.34.11.90010
ref
elgabbr-
Gültigkeit2013‑11‑07
StatusKgreen.png AktivVersions-Label
NameCDlanguageCodeAnzeigenameCD 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.12 Versionierung des Dokuments („setId“ und „versionNumber“)

1.12.1 Spezifikation

Es MÜSSEN immer beide Elemente (setID und versionNumber) angegeben werden.

Id1.2.40.0.34.11.90007
ref
elgabbr-
Gültigkeit2015‑09‑18
Andere Versionen mit dieser Id:
  • Kblank.png CDsetIdversionNumber vom 2015‑05‑29
  • Kblank.png CDsetIdversionNumber vom 2013‑11‑07
StatusKgreen.png AktivVersions-Label
NameCDsetIdversionNumberAnzeigenameSetId VersionNumber
Beschreibung

Der CDA-Header repräsentiert ebenfalls die Beziehungen zu anderen Dokumenten mit Referenz auf die oben genannte Dokumenten-Identifikation.

Mittels der Attribute setId und versionNumber kann eine Versionskennung des Dokuments erreicht werden. Für ELGA-CDA-Dokumente MÜSSEN immer beide Elemente angegeben werden.

Die setId bezeichnet das Set von Dokumenten, die zu einer Reihe von Versionen gehören. Sie bleibt über alle Versionen der Dokumente gleich (initialer Wert bleibt erhalten). Die versionNumber ist eine natürliche Zahl für die fortlaufende Versionszählung. Mit einer neuen Version wird diese Zahl hochgezählt, die setId bleibt gleich.

KlassifikationCDA Header Level Template
Offen/GeschlossenOffen (auch andere als die definierten Elemente sind erlaubt)
BeziehungVersion: Template 1.2.40.0.34.11.90007 SetId VersionNumber (2015‑09‑18)
ref
elgabbr-
Beispiel
Beispiel für die 1.Version eines Dokuments
<!-- Die bei setId angegebene ID SOLLTE nicht gleich sein wie die id des Dokuments.-->
<art:placeholder>
  <id root="1.2.40.0.34.99.111.1.1" extension="AAAAAAAAAAAAAAA"/>  <setId root="1.2.40.0.34.99.111.1.1" extension="ZZZZZZZZZZZZZZZ"/>  <versionNumber value="1"/></art:placeholder>
Beispiel
Beispiel für die 2.Version eines Dokuments
<!--Die bei setId angegebene ID MUSS mit der setId der Vorversion übereinstimmen.-->
<art:placeholder>
  <id root="1.2.40.0.34.99.111.1.1" extension="BBBBBBBBBBBBBBB"/>  <setId root="1.2.40.0.34.99.111.1.1" extension="ZZZZZZZZZZZZZZZ"/>  <versionNumber value="2"/></art:placeholder>
ItemDTKardKonfBeschreibungLabel
hl7:setId
II1 … 1M

Eindeutige Id des Dokumentensets.
Grundsätzlich sind die Vorgaben für „Identifikations-Elemente“ zu befolgen.

Hinweis: Bestimmte Systeme, die bei der Übernahme der SetID in die XDS-Metadaten mit dem V2-Datentyp CX arbeiten, könnten ein Problem mit @Extension-Attributen haben, die länger als 15 Zeichen sind. Die SetID sollte unterschiedlich zur clinicalDocument.id sein.

(CDs...ber)
 Beispiel<setId extension="D1127" root="1.2.276.0.76.3.1.139.2.427"/>
hl7:versionNumber
INT.​NONNEG1 … 1M
Versionsnummer des Dokuments.
(CDs...ber)
 Beispiel<versionNumber value="1"/>

Für die setId sind grundsätzlich die Vorgaben gemäß Kapitel „id-Element II“ zu befolgen. Die versionNumber von neuen Dokumenten wird mit 1 festgelegt.

Anhänge oder Ersetzungen von Vordokumenten MÜSSEN ebenfalls diese zusätzlichen Angaben enthalten.

Der genaue Zusammenhang zwischen diesen Attributen finden Sie im „Bezug zu vorgehenden Dokumenten“.

Achtung: Manche Validatoren erkennen es als Fehler, wenn die SetID und ID gleich sind.