Ihevs:DocumentEntry.formatCode

Aus Hl7wiki
(Teildokument von )
Wechseln zu: Navigation, Suche
Zeile 2: Zeile 2:
 
==DocumentEntry.formatCode==
 
==DocumentEntry.formatCode==
  
−
Der Code spezifiziert das Format des Dokumentes. Zusammen mit dem typeCode soll der formatCode für hinreichende Information sorgen, um einem potenziellen XDS-Dokument-Verbraucher die Entscheidung zu ermöglichen, ob er das Dokumentenformat verarbeiten kann.
+
Der Code spezifiziert das Format des Dokumentes. Zusammen mit dem typeCode (und ggf. mit dem mimeType) soll der formatCode für hinreichende Information sorgen, um einem potenziellen XDS-Dokument-Konsumenten die Entscheidung zu ermöglichen, ob und wie er das Dokumentenformat verarbeiten kann.
  
−
Das formatCode muss dabei hinreichend eindeutig formuliert sein, um die Verarbeitung/Anzeige des von der Registry angeforderten Dokumentes zu gewährleisten. D.h. die jeweiligen Werte des formatCodes stellen eine Sammlung von Schlüsselwörtern dar, die dem Anwender der Dokumente die Bedeutung der Dokumentenart erläutert.
+
Der formatCode muss dabei hinreichend eindeutig formuliert sein, um die Verarbeitung/Anzeige des von der Registry angeforderten Dokumentes durch den Dokumentenkonsumer zu gewährleisten.
  
−
formatCodes können durch verschiedene Organisationen definiert werden, insbesondere durch die Betreiber einer XDS-Domäne.
+
===Vergabe von formatCodes===
 +
 
 +
formatCodes können durch verschiedene Organisationen, insbesondere durch IHE International, IHE Deutschland, HL7 Deutschland oder die Betreiber einer XDS-Domäne definiert werden. Die vergebende Organisation legt den Aufbau des Codes fest. Die einzige Vorgabe für alle vergebenden Organisationen besteht darin, dass eine eindeutige URN verwendet werden soll.
 +
 
 +
 
 +
===Umfang des IHE Deutschland formatCode ValueSets===
 +
 
 +
Das ValueSet hat die OID 1.2.276.0.76.11.35 und setzt sich aus Codes von IHE International, IHE Deutschland, HL7 und HL7 Deutschland zusammen.
 +
 
 +
====Durch IHE International vergebene formatCodes====
  
 
formatCodes, welche von IHE ITI definiert werden, haben immer das Präfix
 
formatCodes, welche von IHE ITI definiert werden, haben immer das Präfix
Zeile 12: Zeile 21:
 
  urn:ihe:iti:
 
  urn:ihe:iti:
  
−
Beipiele hierzu finden sich im Wiki von IHE International (http://wiki.ihe.net/index.php?title=IHE_Format_Codes). Wenn andere IHE Domänen formatCodes definieren, so sollen sie das Präfix
+
Beispiel: urn:ihe:iti:xds-sd:pdf:2008. Beipiele hierzu finden sich im Wiki von IHE International (http://wiki.ihe.net/index.php?title=IHE_Format_Codes). Wenn andere IHE Domänen formatCodes definieren, so sollen sie das Präfix
  
 
  urn:ihe:’domain initials’:
 
  urn:ihe:’domain initials’:
  
−
benutzen, wobei „domain initials“ die Domäne selbst repräsentiert. Wenn ein Betreiber einer XDS-Domäne einen eigenen formatCode definiert, so muss das Präfix
+
benutzen, wobei „domain initials“ die Domäne selbst repräsentiert.  
−
 
 
−
urn:ad:’creating entity’:
 
  
−
verwendet werden, wobei „creating entity“ die definierende Institution vertritt. Definiert beispielsweise die Domäne „Gesundheitsversorgung Deutschland“, welche die Abkürung „GesDe“ nutzt, formatCodes, so lautet das Präfix „urn:ad:GesDe:“. Idealerweise wird für die AD die OID verwendet, da die OID der AD im Gegensatz zu freitextlichen Bezeichnern immer eindeutig ist. Damit wird zugleich die Vorgabe bzgl. der Vergabe des namespace identifier entsprochen, dass dieser mehr als zwei Zeichen umfassen muss .
+
====Durch IHE Deutschland vergebene formatCodes====
  
−
formatCodes, welche von IHE Deutschland herausgegeben werden, haben immer das Präfix
+
formatCodes, welche von IHE Deutschland definiert werden, haben immer das Präfix
  
 
  urn:ihe-d:
 
  urn:ihe-d:
−
 
−
URN-Codes können außerhalb des Einsatzes für formatCodes auch für andere Zwecke verwendet werden. Daher werden die URN-Codes in zwei URN-Codesystemen angegeben: 1) MIME-Codes, 2) Non-MIME-Codes. MIME-Types wird immer das Präfix „urn:ihe-d:mime:“ vorangestellt, Non-MIME-Codes das Präfix „urn:ihe-d:xxxyyyzzz:“. Aus diesen Codesystemen sowie aus international verfügbaren Angaben von IHE zum Einsatz von formatCodes wird das ValueSet für formatCodes zusammengestellt.
 
−
 
−
Die Codes für das ValueSet „formatCode“ werden in art-decor zusammen mit den anderen von IHE Deutschland erstellten ValueSets veröffentlicht (http://art-decor.org/art-decor/decor-valuesets--ihede-).
 
  
 
Innerhalb von Deutschland sollen URN-Codes dem folgenden Aufbau genügen:
 
Innerhalb von Deutschland sollen URN-Codes dem folgenden Aufbau genügen:
  
 
===CDA-Dokumente===
 
===CDA-Dokumente===
 +
 
{| border=1
 
{| border=1
 
|-
 
|-
 
|CDA-Dokumente ohne binärem Inhalt
 
|CDA-Dokumente ohne binärem Inhalt
 
|
 
|
−
  urn:ihe-d:xxxyyyzzz:’Bezeichner’:’Jahr’
+
  urn:ihe-d:ig:'Bezeichner':'Jahr'
−
bzw.
 
−
urn:ad:’creating entity’:’Bezeichner’:’Jahr’
 
 
|-
 
|-
 
|CDA-Dokumente mit einem Body, der aus einem binärem Inhalt besteht
 
|CDA-Dokumente mit einem Body, der aus einem binärem Inhalt besteht
 
|
 
|
−
  urn:ihe-d:xxxyyyzzz:’Bezeichner’:’Jahr’:’nonXmlBody’
+
  urn:ihe-d:ig:'Bezeichner':'Jahr':'nonXmlBody'
−
bzw.
 
−
urn:ad:’creating entity’:’Bezeichner’:’Jahr’:’nonXmlBody’
 
 
|-
 
|-
 
|CDA-Dokumente mit einem Body, der aus einer XML-Inhalten und mind. einer eingebettenen binärem Datei  besteht
 
|CDA-Dokumente mit einem Body, der aus einer XML-Inhalten und mind. einer eingebettenen binärem Datei  besteht
 
|
 
|
−
  urn:ihe-d:xxxyyyzzz:’Bezeichner’:’Jahr’:’crossXmlBody’
+
  urn:ihe-d:ig:'Bezeichner':'Jahr':'crossXmlBody'
−
bzw.
 
−
urn:ad:’creating entity’:’Bezeichner’:’Jahr’:’crossXmlBody’
 
 
|}
 
|}
  
−
wobei „Bezeichner“ für den Inhalt des Dokumentes steht, „Jahr“ für das Jahr der Veröffentlichung. Sollten innerhalb eines Jahres mehr als eine Version erscheinen, wird zusätzlich die zweistellige Monatszahl der Angabe des Jahres hinzugefügt, getrennt von einem Bindestrich ‘-‘. (Beispiel: 2010-07).
+
„ig“ ist die feste Abkürzung für Implementierungsleitfäden (implementation guide). 'Bezeichner' und 'Jahr' sollen Platzhalter für den Inhalt des Dokuments und für das Jahr der Veröffentlichung sein. Sollten innerhalb eines Jahres mehrere Versionen erscheinen, wird der Angabe des Jahres zusätzlich eine zweistellige Monatszahl, getrennt von einem Bindestrich, '-'. hinzugefügt (Beispiel: 2010-07).
  
−
Beispiel: Der 2014 von HL7 Deutschland veröffentlichte CDA-Arztbrief wird entsprechend der obigen Beschreibung wie folgt abgebildet:
+
Beispiel: Sollte IHE Deutschland 2016 ein eigenes CDA-Dokument für eine Verordnung veröffentlichen, wird dieses entsprechend der obigen Beschreibung wie folgt abgebildet:
  
−
a) Arztbrief: Level1-3 ohne binärem Inhalt
+
a) Verordnung: Level 1-3 ohne binärem Inhalt
−
  urn:ihe-d:pcc:arztbrief:2014
+
  urn:ihe-d:ig:Verordnung:2016
−
b) Arztbrief: Level 1 CDA mit Body bestehend aus einer PDF-Datei (http://wiki.hl7.de/index.php?title=cdaab2:Beispiel_(vollst%C3%A4ndig))
+
b) Verordnung: Level 1 CDA mit Body bestehend aus einer PDF-Datei (http://wiki.hl7.de/index.php?title=cdaab2:Beispiel_(vollst%C3%A4ndig))
−
  urn:ihe-d:pcc:arztbrief:2014:nonXmlBody
+
  urn:ihe-d:ig:Verordnung:2016:nonXmlBody
−
c) Arztbrief: sowohl mit XML-Inhalt wie auch mindestens einer eingebetteten binären Datei  
+
c) Verordnung: sowohl mit XML-Inhalt wie auch mindestens einer eingebetteten binären Datei  
−
  urn:ihe-d:pcc:arztbrief:2014:crossXmlBody
+
  urn:ihe-d:ig:Verordnung:2016:crossXmlBody
  
 
===Nicht CDA-Dokumente===
 
===Nicht CDA-Dokumente===
  
−
Nicht CDA-Dokumente sollten über eine möglichst genaue Beschreibung des Dokumentenformats abgebildet werden. Ist dies nicht möglich, so soll der MIME-Type entsprechen der Liste von IANA  genutzt werden:
+
Nicht-CDA-Dokumente sollten über eine möglichst genaue Beschreibung des Dokumentenformats abgebildet werden, sobald der MIME Type allein das Format des Dokuments nicht ausreichend beschreibt.
 +
 
 
{| border=1
 
{| border=1
 
|-
 
|-
 
|IHE Deutschland
 
|IHE Deutschland
 
|
 
|
−
  urn:ihe-d:xxxyyyzzz:‘Bezeichner‘:Jahr
+
  urn:ihe-d:ig:'Bezeichner':'Jahr'
−
  urn:ihe-d:mime:‘mime‘:Jahr
+
  urn:ihe-d:spec:'Bezeichner':'Jahr'
−
|-
+
urn:ihe-d:mime
−
|Betreiber einer XDS-Domäne
+
|}
−
|
+
 
−
urn:ad:’creating entity’:’Bezeichner’
+
„ig“ ist die feste Abkürzung für Implementierungsleitfäden (implementation guide), „spec“ für eine Spezifikation (specification). Auch hier sind 'Bezeichner' und 'Jahr' Platzhalter für den Inhalt des Dokumentes bzw. für das Jahr der Veröffentlichung, welches wann immer möglich angegeben werden sollte. Werden innerhalb eines Jahres mehrere Versionen des Formates veröffentlicht, so wird auch hier zusätzlich die zweistellige Monatszahl der Angabe des Jahres hinzugefügt, getrennt von einem Bindestrich '-' (Beispiel: 2010-07).
−
urn:ad:’creating entity’:’mime’
+
 
−
urn:ad:’pdfA1’
+
Falls der MIME Type allein das Format des Dokuments ausreichend beschreibt, wird dies im formatCode durch die fest vorgegebene URN „urn:ihe-d:mime“ ausgedrückt. Der MIME Type selbst wird in den IHE Document Sharing Metadaten bei DocumentEntry.mimeType angegeben.
 +
 
 +
'''Beispiel'''
 +
Um ein gewöhnliches PDF-Dokument in einer Document Registry zu registrieren, über dessen Aufbau (Strukturierung) keine weiteren Informationen vorhanden sind, werden der Format-Code (DocumentEntry.formatCode) „urn:ihe-d:mime“ und der MIME Type (DocumentEntry.mimeType) „application/pdf“ verwendet.
  
−
Bezeichner = Typisierung des Formats, wenn kein genauerer Bezeichner da ist, Angabe mime-type
+
'''Sonderfall'''
−
|}
+
Die unterschiedlichen Ausprägungen des PDF Formats (z.B. PDF-A für elektronische Archivierung) benötigen eine gesonderte Behandlung. Da der MIME Type „application/pdf“ diese unterschiedlichen Ausprägungen nicht differenziert, nutzt IHE Deutschland in diesen Fällen statt des Codes „urn:ihe-d:mime“ selbst definierte Format Codes. Beispiel: „urn:ihe-d:spec:PDF_A1:2005”.
  
−
Auch hier steht „Bezeichner“ für den Inhalt des Dokumentes und „Jahr“ für das Jahr der Veröffentlichung, welches wann immer möglich angegeben werden sollte. Werden innerhalb eines Jahres mehr als eine Version des Formates veröffentlicht, so wird auch hier zusätzlich die zweistellige Monatszahl der Angabe des Jahres hinzugefügt, getrennt von einem Bindestrich ‘-‘. (Beispiel: 2010-07).
+
===Empfehlungen von IHE Deutschland für andere Organisationen===
 +
Wir empfehlen die Verwendung eines IANA-registrierten domain names als Namespace Identifier (NID: der Teil der URN, der auf „urn: “ folgt und bis zum nächsten Doppelpunkt reicht). Definiert beispielsweise die Domäne „Gesundheitsversorgung Deutschland“ formatCodes, lautet das Präfix „urn:gesde.de:“, da die Domäne die URL http://www.gesde.de verwendet. Eine weitere Unterstrukturierung des Namensraums (d.h. nach dem zweiten Doppelpunkt) in Anlehnung an die Vorgehensweise von IHE Deutschland wird empfohlen.
  
−
Beispiel: um ein pdf darzustellen kann der Format-Code „urn:ihe-d:mime:application/pdf“ unter Nutzung des MIMe-Types verwendet werden. Spezifischer wäre die Nutzung eines Bezeichners „PDF/A-1“, um das hiermit bezeichnete pdf-Format für die elektronische Archivierung abzubilden: „urn:ihe-d:xxxyyyzzz:PDF/A-1“
+
===Veröffentlichung der formatCodes===
−
In beiden Fällen kommt „/“ vor, was in dieser Form nicht in einer URN verwendet werden darf . Entsprechend Kapitel 5.2 „Encoding Considerations and Lexical Equivalence“ von RFC 2288 muss „/“ %-encoded werden (siehe auch RFC 2141 ).
+
Die Codes für das ValueSet „formatCode“ werden in art-decor zusammen mit den anderen von IHE Deutschland erstellten ValueSets veröffentlicht (http://art-decor.org/art-decor/decor-valuesets--ihede-).
−
Dementsprechend sind die Angaben aus dem Beispiel wie folgt umzusetzen (%2F repräsentiert „/“, siehe RFC 3151 ):
 
−
a) urn:ihe-d:application %2Fpdf
 
−
b) urn:ihe-d:PDF %2FA-1
 
 
   
 
   
−
 
 
===Links===
 
===Links===
 
* RFC 3406 (2002) URN Namespace Definition Mechanisms. Online, verfügbar unter http://tools.ietf.org/html/rfc3406*  Internet Assigned Numbers Authority (IANA). Media Types. Online, verfügbar unter  http://www.iana.org/assignments/media-types/media-types.xhtml
 
* RFC 3406 (2002) URN Namespace Definition Mechanisms. Online, verfügbar unter http://tools.ietf.org/html/rfc3406*  Internet Assigned Numbers Authority (IANA). Media Types. Online, verfügbar unter  http://www.iana.org/assignments/media-types/media-types.xhtml

Version vom 4. Mai 2016, 17:44 Uhr

Dieses Material ist Teil des Leitfadens [[Category:|Ihevs:DocumentEntry.formatCode]].
  • 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: [[:Category:|hier]], Liste der Seiten, in denen dieses Material verwendet (transkludiert) siehe hier .

DocumentEntry.formatCode

Der Code spezifiziert das Format des Dokumentes. Zusammen mit dem typeCode (und ggf. mit dem mimeType) soll der formatCode für hinreichende Information sorgen, um einem potenziellen XDS-Dokument-Konsumenten die Entscheidung zu ermöglichen, ob und wie er das Dokumentenformat verarbeiten kann.

Der formatCode muss dabei hinreichend eindeutig formuliert sein, um die Verarbeitung/Anzeige des von der Registry angeforderten Dokumentes durch den Dokumentenkonsumer zu gewährleisten.

Vergabe von formatCodes

formatCodes können durch verschiedene Organisationen, insbesondere durch IHE International, IHE Deutschland, HL7 Deutschland oder die Betreiber einer XDS-Domäne definiert werden. Die vergebende Organisation legt den Aufbau des Codes fest. Die einzige Vorgabe für alle vergebenden Organisationen besteht darin, dass eine eindeutige URN verwendet werden soll.


Umfang des IHE Deutschland formatCode ValueSets

Das ValueSet hat die OID 1.2.276.0.76.11.35 und setzt sich aus Codes von IHE International, IHE Deutschland, HL7 und HL7 Deutschland zusammen.

Durch IHE International vergebene formatCodes

formatCodes, welche von IHE ITI definiert werden, haben immer das Präfix 

urn:ihe:iti:

Beispiel: urn:ihe:iti:xds-sd:pdf:2008. Beipiele hierzu finden sich im Wiki von IHE International (http://wiki.ihe.net/index.php?title=IHE_Format_Codes). Wenn andere IHE Domänen formatCodes definieren, so sollen sie das Präfix 

urn:ihe:’domain initials’:

benutzen, wobei „domain initials“ die Domäne selbst repräsentiert.

Durch IHE Deutschland vergebene formatCodes

formatCodes, welche von IHE Deutschland definiert werden, haben immer das Präfix 

urn:ihe-d:

Innerhalb von Deutschland sollen URN-Codes dem folgenden Aufbau genügen:

CDA-Dokumente

CDA-Dokumente ohne binärem Inhalt 
urn:ihe-d:ig:'Bezeichner':'Jahr'
CDA-Dokumente mit einem Body, der aus einem binärem Inhalt besteht 
urn:ihe-d:ig:'Bezeichner':'Jahr':'nonXmlBody'
CDA-Dokumente mit einem Body, der aus einer XML-Inhalten und mind. einer eingebettenen binärem Datei besteht 
urn:ihe-d:ig:'Bezeichner':'Jahr':'crossXmlBody'

„ig“ ist die feste Abkürzung für Implementierungsleitfäden (implementation guide). 'Bezeichner' und 'Jahr' sollen Platzhalter für den Inhalt des Dokuments und für das Jahr der Veröffentlichung sein. Sollten innerhalb eines Jahres mehrere Versionen erscheinen, wird der Angabe des Jahres zusätzlich eine zweistellige Monatszahl, getrennt von einem Bindestrich, '-'. hinzugefügt (Beispiel: 2010-07).

Beispiel: Sollte IHE Deutschland 2016 ein eigenes CDA-Dokument für eine Verordnung veröffentlichen, wird dieses entsprechend der obigen Beschreibung wie folgt abgebildet:

a) Verordnung: Level 1-3 ohne binärem Inhalt 

urn:ihe-d:ig:Verordnung:2016

b) Verordnung: Level 1 CDA mit Body bestehend aus einer PDF-Datei (http://wiki.hl7.de/index.php?title=cdaab2:Beispiel_(vollst%C3%A4ndig)) 

urn:ihe-d:ig:Verordnung:2016:nonXmlBody

c) Verordnung: sowohl mit XML-Inhalt wie auch mindestens einer eingebetteten binären Datei 

urn:ihe-d:ig:Verordnung:2016:crossXmlBody

Nicht CDA-Dokumente

Nicht-CDA-Dokumente sollten über eine möglichst genaue Beschreibung des Dokumentenformats abgebildet werden, sobald der MIME Type allein das Format des Dokuments nicht ausreichend beschreibt.

IHE Deutschland 
urn:ihe-d:ig:'Bezeichner':'Jahr'
urn:ihe-d:spec:'Bezeichner':'Jahr'
urn:ihe-d:mime

„ig“ ist die feste Abkürzung für Implementierungsleitfäden (implementation guide), „spec“ für eine Spezifikation (specification). Auch hier sind 'Bezeichner' und 'Jahr' Platzhalter für den Inhalt des Dokumentes bzw. für das Jahr der Veröffentlichung, welches wann immer möglich angegeben werden sollte. Werden innerhalb eines Jahres mehrere Versionen des Formates veröffentlicht, so wird auch hier zusätzlich die zweistellige Monatszahl der Angabe des Jahres hinzugefügt, getrennt von einem Bindestrich '-' (Beispiel: 2010-07).

Falls der MIME Type allein das Format des Dokuments ausreichend beschreibt, wird dies im formatCode durch die fest vorgegebene URN „urn:ihe-d:mime“ ausgedrückt. Der MIME Type selbst wird in den IHE Document Sharing Metadaten bei DocumentEntry.mimeType angegeben.

Beispiel Um ein gewöhnliches PDF-Dokument in einer Document Registry zu registrieren, über dessen Aufbau (Strukturierung) keine weiteren Informationen vorhanden sind, werden der Format-Code (DocumentEntry.formatCode) „urn:ihe-d:mime“ und der MIME Type (DocumentEntry.mimeType) „application/pdf“ verwendet.

Sonderfall Die unterschiedlichen Ausprägungen des PDF Formats (z.B. PDF-A für elektronische Archivierung) benötigen eine gesonderte Behandlung. Da der MIME Type „application/pdf“ diese unterschiedlichen Ausprägungen nicht differenziert, nutzt IHE Deutschland in diesen Fällen statt des Codes „urn:ihe-d:mime“ selbst definierte Format Codes. Beispiel: „urn:ihe-d:spec:PDF_A1:2005”.

Empfehlungen von IHE Deutschland für andere Organisationen

Wir empfehlen die Verwendung eines IANA-registrierten domain names als Namespace Identifier (NID: der Teil der URN, der auf „urn: “ folgt und bis zum nächsten Doppelpunkt reicht). Definiert beispielsweise die Domäne „Gesundheitsversorgung Deutschland“ formatCodes, lautet das Präfix „urn:gesde.de:“, da die Domäne die URL http://www.gesde.de verwendet. Eine weitere Unterstrukturierung des Namensraums (d.h. nach dem zweiten Doppelpunkt) in Anlehnung an die Vorgehensweise von IHE Deutschland wird empfohlen.

Veröffentlichung der formatCodes

Die Codes für das ValueSet „formatCode“ werden in art-decor zusammen mit den anderen von IHE Deutschland erstellten ValueSets veröffentlicht (http://art-decor.org/art-decor/decor-valuesets--ihede-).

Links

Abgerufen von „https://wiki.hl7.de/index.php?title=Ihevs:DocumentEntry.formatCode&oldid=29143“