Ihevs:DocumentEntry.formatCode

Aus Hl7wiki
(Teildokument von )
Wechseln zu: Navigation, Suche
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.

Aufbau der formatCodes

Aufbau der durch IHE International vergebenen 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.

Aufbau der durch IHE Deutschland vergebenen formatCodes

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

urn:ihe-d:

Von IHE Deutschland festgelegte formatCodes werden wie folgt aufgebaut:

Aufbau für 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 (IG:CDA_und_PDF/A3)

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
Aufbau für 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'

„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:iti:xds:2017:mimeTypeSufficient“ ausgedrückt. Der MIME Type selbst wird in den IHE Document Sharing Metadaten bei DocumentEntry.mimeType angegeben. Die URN „urn:ihe:iti:xds:2017:mimeTypeSufficient“ wurde von IHE International im Dezember 2017 festgelegt und wird Teil der Revision 15 des IHE ITI Technical Frameworks werden. Der equivalente, von IHE Deutschland eingeführte formatCode "urn:ihe-d:mime" gilt ab sofort als "deprecated" und sollte nicht mehr verwendet werden.

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:iti:xds:2017:mimeTypeSufficient“ 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 bestimmten Fällen statt des Codes „urn:ihe:iti:xds:2017:mimeTypeSufficient“ selbst definierte formatCodes. Beispiel: „urn:ihe-d:spec:PDF_A1:2005”. Wenn IHE Deutschland keinen formatCode für die verwendete PDF Ausprägung definiert hat (wie z.B. für PDF/X), wird der Code „urn:ihe:iti:xds:2017:mimeTypeSufficient“ als formatCode und „application/pdf“ als MIME Type verwendet.

Empfehlungen von IHE Deutschland für den Aufbau von formatCodes 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.

formatCodes für FHIR Ressourcen

FHIR Ressourcen die über IHE XDS/XDR/XDM kommuniziert werden sollten die MIME Types "application/fhir+xml" für die XML Repräsentation und "application/fhir+json" für die JSON Repräsentation verwenden. Für einfache Ressourcen ist dies ausreichend, daher kann "urn:ihe:iti:xds:2017:mimeTypeSufficient" als formatCode verwendet werden. Bei Verwendung von FHIR Documents und ähnlichen Konstrukten mit Dokumentencharakter wird der Einsatz eines spezifischeren formatCodes empfohlen. Von IHE Deutschland definierte formatCodes für FHIR Dokumentenleitfäden werden den oben dargestellten Vorgehen für CDA-Leitfäden ohne binären Inhalt folgen, d.h. urn:ihe-d:ig:'Bezeichner':'Jahr'.


Die Codes für das ValueSet werden in ART-DECOR zusammen mit den anderen von IHE Deutschland erstellten ValueSets veröffentlicht (http://art-decor.org/art-decor/decor-valuesets--ihede-) und hier eingebunden. Sollte es zu Darstellungsproblemen bei den eingebundenen Wertelisten kommen, bitten wir den geneigten Leser direkt auf [ART-DECOR] zuzugreifen.


Id1.2.276.0.76.11.35Gültigkeit2018‑07‑13 16:16:59
Canonical URIhttp://ihe-d.de/ValueSets/IHEXDSformatCodeDE
StatusKgreen.png DefinitivVersions-Labelv2
NameIHEXDSformatCodeDEAnzeigenameIHE XDS formatCode
BeschreibungEN-US.png formatCode (XDSDocumentEntry)
Globally unique code specifying the format of an XDS Document. Along with the typeCode, it should provide sufficient information to allow a potential consumer to know if it will be able to process the document.
3 Quell-Codesysteme
1.3.6.1.4.1.19376.1.2.3 - IHE Format Codes - urn:oid:1.3.6.1.4.1.19376.1.2.3
1.2.840.10008.2.6.1 - DICOM UID - urn:oid:1.2.840.10008.2.6.1
1.3.6.1.4.1.19376.3.276.1.5.6 - Deutsche Dokumentenformate - urn:oid:1.3.6.1.4.1.19376.3.276.1.5.6
Level/ TypCodeAnzeigenameCodesystemDesignationsBeschreibung
0‑L
Medical Summaries (XDS-MS)
IHE Format Codes
0‑L
Exchange of Personal Health Records (XPHR)
IHE Format Codes
0‑L
Emergency Department Referral (EDR)
IHE Format Codes
0‑L
Antepartum Summary (APS)
IHE Format Codes
0‑L
Emergency Department Encounter Summary (EDES)
IHE Format Codes
0‑L
Antepartum History and Physical (APHP)
IHE Format Codes
0‑L
Antepartum Laboratory (APL)
IHE Format Codes
0‑L
Antepartum Education (APE)
IHE Format Codes
0‑L
Immunization Content (IC)
IHE Format Codes
0‑L
Care Management (CM)
IHE Format Codes
0‑LIHE Format Codes
0‑LIHE Format Codes
0‑LIHE Format Codes
0‑LIHE Format Codes
0‑LIHE Format Codes
0‑LIHE Format Codes
0‑LIHE Format Codes
0‑LIHE Format Codes
0‑LIHE Format Codes
0‑LIHE Format Codes
0‑LIHE Format Codes
0‑LIHE Format Codes
0‑LIHE Format Codes
0‑L
Scanned Documents (PDF)
IHE Format Codes
0‑L
Scanned Documents (text)
IHE Format Codes
0‑L
Basic Patient Privacy Consents
IHE Format Codes
0‑L
Basic Patient Privacy Consents with Scanned Document
IHE Format Codes
0‑L
APPC Privacy Consent Document
IHE Format Codes
0‑L
XDW Workflow Document
IHE Format Codes
0‑L
DSG Detached Document
IHE Format Codes
0‑L
DSG Enveloping Document
IHE Format Codes
0‑L
CDA Laboratory Report
IHE Format Codes
0‑L
XDS-I CDA Wrapped Text Report (XDS-I)
IHE Format Codes
0‑L
XDS-I PDF (XDS-I)
IHE Format Codes
0‑L
XDS-I Imaging Report with Structured Headings (XDS-I)
IHE Format Codes
0‑L
Cardiology ??? (CRC)
IHE Format Codes
0‑L
Cardiology ??? (EPRC-IE)
IHE Format Codes
0‑L
Cardiac Imaging Report
IHE Format Codes
0‑L
Dental CDA Wrapped Text Report (DENT)
IHE Format Codes
0‑L
Dental PDF (DENT)
IHE Format Codes
0‑L
Dental Imaging Report with Structured Headings (DENT)
IHE Format Codes
0‑L
Anatomic Pathology Structured Report (APSR)
IHE Format Codes
0‑L
Pharmacy ??? (urn:ihe:pharm:pre:2010)
IHE Format Codes
0‑L
Pharmacy ??? (urn:ihe:pharm:padv:2010)
IHE Format Codes
0‑L
Pharmacy ??? (urn:ihe:pharm:dis:2010)
IHE Format Codes
0‑L
Pharmacy ??? (urn:ihe:pharm:pml:2013)
IHE Format Codes
0‑L
1.2.840.10008.5.1.4.1.1.88.59
DICOM Manifest (DICOM KOS SOP Class UID)
DICOM UID
0‑L
Format aus MIME Type ableitbar
IHE Format Codes
0‑L
Entlassmanagementbrief
Deutsche Dokumentenformate
0‑L
NotaufnahmeregisterTraumamodul
Deutsche Dokumentenformate
0‑L
NotaufnahmeregisterBasismodul
Deutsche Dokumentenformate
0‑L
Meldepflichtige Krankheiten: Labormeldung
Deutsche Dokumentenformate
0‑L
Übermittlung meldepflichtiger Krankheiten – Arztmeldung
Deutsche Dokumentenformate
0‑L
Ärztlicher Reha-Entlassungsbericht
Deutsche Dokumentenformate
0‑L
Überleitungsmanagement Ärztlicher Kurzbericht über den Krankenhausaufenthalt
Deutsche Dokumentenformate
0‑L
Überleitungsmanagement Ärztlicher Kurzbericht des niedergelassenen Arztes
Deutsche Dokumentenformate
0‑L
Medikationsplan
Deutsche Dokumentenformate
0‑L
Arztbrief plus
Deutsche Dokumentenformate
0‑L
Arztbrief 2014
Deutsche Dokumentenformate
0‑L
Enhanced Patient Privacy Consent - Germany
Deutsche Dokumentenformate
0‑L
Enhanced Patient Privacy Consent - Germany - Scanned Document Option
Deutsche Dokumentenformate
0‑L
PDF/A-1
Deutsche DokumentenformatePDF Format für die elektronische Archivierung nach ISO 19005-1:2005
0‑L
PDF/A-2
Deutsche DokumentenformatePDF Format für die elektronische Archivierung nach ISO 19005-2
0‑L
PDF/A-3
Deutsche DokumentenformatePDF Format für die elektronische Archivierung nach ISO 19005-3
0‑L
PDF/UA
Deutsche DokumentenformateBarrierefreies PDF nach ISO 14289
0‑D
obsolet
Deutsche Dokumentenformate
DE-DE.png Synonym: durch MIME Type beschrieben
Dieser Code wurde verwendet, wenn das Dokumentenformat ausreichend durch den MIME Type beschrieben war. Dafür gibt es nun den internationalen Code "urn:ihe:iti:xds:2017:mimeTypeSufficient" mit Code System 1.3.6.1.4.1.19376.1.2.3. Daher gilt dieser code als obsolet (engl. "deprecated") und sollte nicht mehr für neue Dokumente verwendet werden.

Legende: Typ L=leaf, S=specializable, A=abstract, D=deprecated. NullFlavors werden im @nullFlavor Attribut statt in @code angegeben.

Links