ClinicalDocument

Aus Hl7wiki
(Teildokument von Arztbrief 2.x)
Wechseln zu: Navigation, Suche
(Die Seite wurde neu angelegt: „{{DocumentPart}} ==Clinical-Document Klasse== Zentrale Klasse des Clinical Document Architecture Modells ist die ''ClinicalDocument'' Klasse. Die zugehörig…“)
 
K
Zeile 36: Zeile 36:
 
Regel NMSP: Das Dokument muss mit dem Element <ClinicalDocument> beginnen und die in obiger Abbildung genannten xmlns: Deklarationen aufweisen.
 
Regel NMSP: Das Dokument muss mit dem Element <ClinicalDocument> beginnen und die in obiger Abbildung genannten xmlns: Deklarationen aufweisen.
 
}}
 
}}
 +
 +
 +
===Metadaten===
 +
Die folgende Tabelle gibt eine Übersicht über die in diesem Leitfaden besprochenen CDA-Header-Elemente, deren Datentyp bzw. Bedeutung und deren Kardinalität:
 +
 +
{| class="hl7table"
 +
!Element (Sequenz)!!Datentyp!!Bedeutung!!Kard.
 +
|-
 +
|''' ''ClinicalDocument Klasse'' '''
 +
|-
 +
|realmCode||CS||''–nicht verwendet–''||0..*
 +
|-
 +
|typeId||II||-konstant-||1..1
 +
|-
 +
|templateId ||II||Template Id für das ganze Dokument||0..1
 +
|-
 +
|id||II||Dokumenten-Id||1..1
 +
|-
 +
|code ||CE||Dokumententyp||1..1
 +
|-
 +
|title ||ST||Zusätzliche Dokumententyp-Bezeichnung||0..1
 +
|-
 +
|effectiveTime ||TS||Erstellungsdatum des Dokuments||1..1
 +
|-
 +
|confidentialityCode ||CE||Vertraulichkeitsgrad||1..1
 +
|-
 +
|languageCode ||CS||Sprache des Dokuments||0..1
 +
|-
 +
|setId ||II||Set-Kennung||0..1
 +
|-
 +
|versionNumber ||INT||Versionsnummer||0..1
 +
|-
 +
|copyTime ||TS||''–nicht verwenden–''||0..1
 +
 +
|}
 +
 +
''Tabelle 1: Übersicht über die (in diesem Leitfaden besprochenen) CDA-Header-Elemente, deren Datentyp bzw. Bedeutung und deren Kardinalität''
 +
 +
 +
===Metadaten Details===
 +
 +
{{WorkBox|
 +
mit vorhergehender Tabelle kombinieren
 +
}}
 +
 +
{| class="hl7table"
 +
! Lvl
 +
! RIM
 +
! Name
 +
! DT
 +
! Kard
 +
! Conf
 +
! Beschreibung
 +
 +
|-
 +
| 1
 +
|bgcolor="ff8888"| act
 +
| ClinicalDocument
 +
|
 +
| 1..1
 +
| R
 +
| Root Element für CDA Dokumente
 +
 +
|-
 +
| 2
 +
|bgcolor="ff8888"| act
 +
| templateID
 +
| II
 +
| 1..1
 +
| R
 +
| Angabe, nach welchem Schema das Dokument erstellt wurde
 +
 +
|-
 +
| 2
 +
|bgcolor="ff8888"| act
 +
| typeId
 +
| II
 +
| 1..1
 +
| R
 +
| fix: Angabe, dass es sich um ein CDA-Dokument handelt
 +
 +
|-
 +
| 2
 +
|bgcolor="ff8888"| act
 +
| id
 +
| II
 +
| 1..1
 +
| R
 +
| eindeutige Identifikation des Dokumentes
 +
 +
|-
 +
| 2
 +
|bgcolor="ff8888"| act
 +
| code
 +
| CE
 +
| 1..1
 +
| R
 +
| um welchen Dokumenttyp handelt es sich
 +
 +
|-
 +
| 2
 +
|bgcolor="ff8888"| act
 +
| title
 +
| ST
 +
| 1..1
 +
| R
 +
| Titel bzw. Bezeichnung des Dokuments
 +
 +
|-
 +
| 2
 +
|bgcolor="ff8888"| act
 +
| effectiveTime
 +
| TS
 +
| 1..1
 +
| R
 +
| Erstellungszeitpunkt
 +
 +
|-
 +
| 2
 +
|bgcolor="ff8888"| act
 +
| confidentialityCode
 +
| CE
 +
| 1..1
 +
| R
 +
|
 +
 +
|-
 +
| 2
 +
|bgcolor="ff8888"| act
 +
| languageCode
 +
| CS
 +
| 0..1
 +
| O
 +
|
 +
 +
|-
 +
| 2
 +
|bgcolor="ff8888"| act
 +
| setId
 +
| II
 +
| 0..1
 +
| O
 +
| Set-Kennung
 +
 +
|-
 +
| 2
 +
|bgcolor="ff8888"| act
 +
| versionNumber
 +
| INT
 +
| 0..1
 +
| O
 +
| Versionsnummer
 +
 +
|-
 +
|2
 +
|bgcolor="ccffff"| part
 +
|
 +
|
 +
|
 +
|
 +
| diverse participations: recordTarget, author, custodian, informationRecipient, ..
 +
 +
|-
 +
| 3
 +
|bgcolor="ffff88"| role
 +
|
 +
|
 +
 +
|-
 +
|2
 +
|bgcolor="ffaaaa"| rel
 +
|relatedDocument
 +
|
 +
|0..*
 +
|O
 +
|Beziehungen zu anderen Dokumenten (Vor- und Basisversionen)
 +
 +
|-
 +
|3
 +
|bgcolor="ff8888"| act
 +
| parentDocument
 +
|
 +
|1..1
 +
|R
 +
|
 +
 +
|-
 +
| 2
 +
|bgcolor="ffaaaa"| rel
 +
| component
 +
|
 +
| 1..1
 +
| R
 +
| Body des Dokuments
 +
 +
|-
 +
| 3
 +
|bgcolor="ff8888"| act
 +
| ...
 +
|
 +
| 1..1
 +
| R
 +
|
 +
 +
|}
 +
 +
===Beispiel===
 +
 +
<syntaxhighlight lang="xml">
 +
<?xml version="1.0"? encoding="UTF-8">
 +
<ClinicalDocument
 +
  xmlns="urn:hl7-org:v3"
 +
  xmlns:voc="urn:hl7-org:v3/voc"
 +
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
 +
 +
  <!-- CDA Header -->
 +
  <typeId root="2.16.840.1.113883.1.3" extension="POCD_HD000040"/>
 +
  <id extension="60878,33988" root="1.2.276.0.58"/>
 +
  <code code="11488-4" codeSystem="2.16.840.1.113883.6.1" displayName="Consultation note"/>
 +
  <title></title>
 +
  <effectiveTime value="20070905"/>
 +
  <confidentialityCode code="N" codeSystem="2.16.840.1.113883.5.25"/>
 +
  <languageCode code="de" />
 +
  <setId extension="D1" root="2.16.840.1.113883.3.933"/>
 +
  <versionNumber value="2"/>
 +
  ...
 +
  <recordTarget />
 +
  <author />
 +
  <custodian />
 +
  <informationRecipient />
 +
  <legalAuthenticator />
 +
  <participant />
 +
  ...
 +
  <relatedDocument typeCode="RPLC">
 +
    <parentDocument>
 +
      <id extension="60878,33977" root="1.2.276.0.58"/>
 +
      <setId extension="D1" root="2.16.840.1.113883.3.933"/>
 +
      <versionNumber value="1"/>
 +
    </parentDocument>
 +
  </relatedDocument>
 +
  ...
 +
  <documentationOf />
 +
  ...
 +
  <!-- CDA Body -->
 +
  <component>
 +
    ...
 +
  </component>
 +
</ClinicalDocument>
 +
</syntaxhighlight>
  
  
 
[[Kategorie:cdaab2|ClinicalDocument]]
 
[[Kategorie:cdaab2|ClinicalDocument]]

Version vom 29. November 2013, 12:57 Uhr

Dieses Material ist Teil des Leitfadens Arztbrief 2.x.
  • Direkt im Wiki geändert werden sollten Schreibfehler, ergänzende Hinweise.
  • Offene Fragen, die der Diskussionen bedürfen, sollten auf der Diskussionsseite aufgenommen werden.
  • Liste der Seiten dieses Leitfadens: hier, Liste der Seiten, in denen dieses Material verwendet (transkludiert) siehe hier .


Clinical-Document Klasse

Zentrale Klasse des Clinical Document Architecture Modells ist die ClinicalDocument Klasse. Die zugehörigen Attribute, so wie sie in den hier beschriebenen Anwendungsszenarien zur Anwendung kommen, werden im weiteren Verlauf dieses Leitfadens beschrieben. Dazu werden XML Fragmente als Beispiele gezeigt.

Clinical Document

Abbildung 6: Clinical Document Klasse

Der blaue Pfeil mit dem angehängten gelben Kasten steht stellvertretend für die verschiedenen einbezogenen Personen in ihren jeweiligen Rollen. Diese sind nachfolgend in der Tabelle der Metadaten aufgelistet.

Der XML-Namespace für CDA Release 2 Dokumente ist urn:hl7-org:v3 (Default-Namespace). Dieser muss in geeigneter Weise in jeder XML Instanz genannt werden. In diesem Leitfaden werden namespace-Präfixe nicht genutzt. Für die Arztbrief XML-Dokumente auf der Basis von CDA Release 2 ist der Zeichensatz UTF-8 vorgeschrieben. Arztbrief XML-Dokumente beginnen mit dem Wurzelelement Clinical¬Document, der grobe Aufbau ist im folgenden Übersichtsbeispiel gegeben. 

<?xml version="1.0"? encoding="UTF-8">
<ClinicalDocument
    xmlns="urn:hl7-org:v3"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <typeId root="2.16.840.1.113883.1.3" extension="POCD_HD000040"/>
    <!-- CDA Header -->
              … siehe Beschreibung '''CDA R2 Header'''
    <!-- CDA Body -->
    <component>
        <structuredBody>
              … siehe Beschreibung '''CDA R2 Body'''
        </structuredBody>
    </component>
</ClinicalDocument>
Conformance.svg Regel NMSP: Das Dokument muss mit dem Element <ClinicalDocument> beginnen und die in obiger Abbildung genannten xmlns: Deklarationen aufweisen.


Metadaten

Die folgende Tabelle gibt eine Übersicht über die in diesem Leitfaden besprochenen CDA-Header-Elemente, deren Datentyp bzw. Bedeutung und deren Kardinalität:

Element (Sequenz) Datentyp Bedeutung Kard.
ClinicalDocument Klasse
realmCode CS –nicht verwendet– 0..*
typeId II -konstant- 1..1
templateId II Template Id für das ganze Dokument 0..1
id II Dokumenten-Id 1..1
code CE Dokumententyp 1..1
title ST Zusätzliche Dokumententyp-Bezeichnung 0..1
effectiveTime TS Erstellungsdatum des Dokuments 1..1
confidentialityCode CE Vertraulichkeitsgrad 1..1
languageCode CS Sprache des Dokuments 0..1
setId II Set-Kennung 0..1
versionNumber INT Versionsnummer 0..1
copyTime TS –nicht verwenden– 0..1

Tabelle 1: Übersicht über die (in diesem Leitfaden besprochenen) CDA-Header-Elemente, deren Datentyp bzw. Bedeutung und deren Kardinalität


Metadaten Details

Under construction icon-blue.svg mit vorhergehender Tabelle kombinieren
Lvl RIM Name DT Kard Conf Beschreibung
1 act ClinicalDocument 1..1 R Root Element für CDA Dokumente
2 act templateID II 1..1 R Angabe, nach welchem Schema das Dokument erstellt wurde
2 act typeId II 1..1 R fix: Angabe, dass es sich um ein CDA-Dokument handelt
2 act id II 1..1 R eindeutige Identifikation des Dokumentes
2 act code CE 1..1 R um welchen Dokumenttyp handelt es sich
2 act title ST 1..1 R Titel bzw. Bezeichnung des Dokuments
2 act effectiveTime TS 1..1 R Erstellungszeitpunkt
2 act confidentialityCode CE 1..1 R
2 act languageCode CS 0..1 O
2 act setId II 0..1 O Set-Kennung
2 act versionNumber INT 0..1 O Versionsnummer
2 part diverse participations: recordTarget, author, custodian, informationRecipient, ..
3 role
2 rel relatedDocument 0..* O Beziehungen zu anderen Dokumenten (Vor- und Basisversionen)
3 act parentDocument 1..1 R
2 rel component 1..1 R Body des Dokuments
3 act ... 1..1 R

Beispiel

<?xml version="1.0"? encoding="UTF-8">
<ClinicalDocument
  xmlns="urn:hl7-org:v3"
  xmlns:voc="urn:hl7-org:v3/voc"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

  <!-- CDA Header -->
  <typeId root="2.16.840.1.113883.1.3" extension="POCD_HD000040"/>
  <id extension="60878,33988" root="1.2.276.0.58"/>
  <code code="11488-4" codeSystem="2.16.840.1.113883.6.1" displayName="Consultation note"/>
  <title></title>
  <effectiveTime value="20070905"/>
  <confidentialityCode code="N" codeSystem="2.16.840.1.113883.5.25"/>
  <languageCode code="de" />
  <setId extension="D1" root="2.16.840.1.113883.3.933"/>
  <versionNumber value="2"/>
  ...
  <recordTarget />
  <author />
  <custodian />
  <informationRecipient />
  <legalAuthenticator />
  <participant />
  ...
  <relatedDocument typeCode="RPLC">
    <parentDocument>
      <id extension="60878,33977" root="1.2.276.0.58"/>
      <setId extension="D1" root="2.16.840.1.113883.3.933"/>
      <versionNumber value="1"/>
    </parentDocument>
  </relatedDocument>
  ...
  <documentationOf />
  ...
  <!-- CDA Body -->
  <component>
    ...
  </component>
</ClinicalDocument>
Abgerufen von „https://wiki.hl7.de/index.php?title=cdaab2:ClinicalDocument&oldid=16485“