Dokumentenmetadaten (DocumentReference)

Dieses Profil spezifiziert die Minimalanforderungen für die Bereitstellung von Dokumentenmetadaten im Rahmen des Bestätigungsverfahrens der gematik.

Motivation

Die Ressource DocumentReference enthält die Metadaten, die für die Verwaltung von und die Suche nach Dokumenten benötigt werden. Der Inhalt des Dokumentes wird über DocumentReference.content beschrieben und über DocumentReference.content.attachment referenziert. Die Trennung von Dokument und Metadaten ermöglicht Clients die effiziente Suche und Auflistung von verfügbaren Dokumenten, ohne dass diese vollständig vom Server geladen werden müssen. Servern ermöglicht dieser Ansatz die Trennung zwischen den Metadaten in einer Datenbank und der Dokumentenablage in z.B. einem Dateisystem.

Kompatibilität

Dieses Profil basiert auf dem Profil MHD DocumentReference Comprehensive UnContained References Option (Version 4.2.0) von IHE International.

Abweichungen vom IHE-Profil

  • Die Verwendung von DocumentReference.docStatus ist im ISiK-Kontext gestattet.
  • DocumentReference.category muss vom Client bei Vorhandensein eines KDL-Codes in DocumentReference.type nicht gefüllt werden. Bei der Verarbeitung auf dem Server im Rahmen der Interaktion Interaktion: Dokumentenbereitstellung wird DocumentReference.category anhand der KDL-Mappings ergänzt und damit die IHE-Kompatibilität hergestellt.
  • DocumentReference.sourcePatientInfo muss im Rahmen von ISiK nicht gefüllt werden

Einschränkungen des IHE-Profils

Elemente mit ValueSet-Bindings ohne verbindliche Vorgabe seitens IHE wurden auf die in Deutschland gebräuchlichen Terminologien (gemäß der Festlegungen von IHE Deutschland e.V.) eingeschränkt.

Metadaten

Canonicalhttps://gematik.de/fhir/isik/StructureDefinition/ISiKDokumentenMetadaten
Statusactive
Version4.0.1
Basishttp://hl7.org/fhir/StructureDefinition/DocumentReference

Inhalt

idΣ0..1string
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
extensionI0..*Extension
modifierExtension?! I0..*Extension
id0..1string
extensionI0..*Extension
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemS Σ1..1uriPattern
valueS Σ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
identifierS Σ0..*Identifier
statusS Σ ?!1..1codeBinding
docStatusS Σ0..1codeBinding
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemS Σ1..1uriPattern
versionΣ0..1string
codeS Σ1..1code
displayS Σ1..1string
userSelectedΣ0..1boolean
id0..1string
extensionI0..*Extension
systemS Σ1..1uriPattern
versionΣ0..1string
codeS Σ1..1code
displayS Σ1..1string
userSelectedΣ0..1boolean
textΣ0..1string
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemS Σ1..1uriPattern
versionΣ0..1string
codeS Σ1..1code
displayS Σ1..1string
userSelectedΣ0..1boolean
textΣ0..1string
id0..1string
extensionI0..*Extension
referenceS Σ I1..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayΣ0..1string
dateΣ0..1instant
id0..1string
extensionI0..*Extension
referenceΣ I0..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayS Σ0..1string
authenticatorI0..1Reference(Practitioner | PractitionerRole | Organization)
custodianI0..0Reference(Organization)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
codeΣ1..1codeBinding
targetΣ I1..1Reference(DocumentReference)
descriptionS Σ1..1string
securityLabelS Σ1..*CodeableConceptBinding
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
id0..1string
extensionI0..*Extension
contentTypeS Σ1..1codeBinding
languageS Σ1..1codeBinding
dataS0..1base64Binary
urlS Σ0..1url
sizeΣ0..1unsignedInt
hashΣ0..1base64Binary
titleΣ0..1string
creationS Σ1..1dateTime
formatS Σ1..1CodingBinding
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
id0..1string
extensionI0..*Extension
referenceS Σ I1..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayΣ0..1string
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemΣ1..1uri
versionΣ0..1string
codeΣ1..1code
displayΣ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
periodΣ I0..1Period
facilityTypeS1..1CodeableConceptBinding
practiceSettingS1..1CodeableConceptBinding
sourcePatientInfoI0..1Reference(Patient)
relatedI0..*Reference(Resource)
<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="ISiKDokumentenMetadaten" />
    <url value="https://gematik.de/fhir/isik/StructureDefinition/ISiKDokumentenMetadaten" />
    <version value="4.0.1" />
    <name value="ISiKDokumentenMetadaten" />
    <title value="Erforderliche Metadaten f&#252;r Dokumentenaustausch in ISiK" />
    <status value="active" />
    <experimental value="false" />
    <date value="2025-01-24" />
    <publisher value="gematik GmbH" />
    <description value="Dieses Profil spezifiziert die Minimalanforderungen f&#252;r die Bereitstellung von Dokumentenmetadaten im Rahmen des Best&#228;tigungsverfahrens der gematik.  \n\n  ### Motivation\nDie Ressource DocumentReference enth&#228;lt die Metadaten, die f&#252;r die Verwaltung von und die Suche nach Dokumenten ben&#246;tigt werden. Der Inhalt des Dokumentes wird &#252;ber DocumentReference.content beschrieben und &#252;ber DocumentReference.content.attachment referenziert. Die Trennung von Dokument und Metadaten erm&#246;glicht Clients die effiziente Suche und Auflistung von verf&#252;gbaren Dokumenten, ohne dass diese vollst&#228;ndig vom Server geladen werden m&#252;ssen. Servern erm&#246;glicht dieser Ansatz die Trennung zwischen den Metadaten in einer Datenbank und der Dokumentenablage in z.B. einem Dateisystem.\n\n  ### Kompatibilit&#228;t\nDieses Profil basiert auf dem Profil [MHD DocumentReference Comprehensive UnContained References Option](https://profiles.ihe.net/ITI/MHD/StructureDefinition-IHE.MHD.UnContained.Comprehensive.DocumentReference.html) (Version 4.2.0) von IHE International.\n\n  #### Abweichungen vom IHE-Profil\n- Die Verwendung von `DocumentReference.docStatus` ist im ISiK-Kontext gestattet.\n- `DocumentReference.category` muss vom Client bei Vorhandensein eines KDL-Codes in `DocumentReference.type` nicht gef&#252;llt werden. Bei der Verarbeitung auf dem Server im Rahmen der Interaktion {{pagelink: Dokumentenbereitstellung}} wird `DocumentReference.category` anhand der [KDL-Mappings](https://simplifier.net/kdl/%7Eresources?category=ConceptMap&amp;sortBy=RankScore_desc) erg&#228;nzt und damit die IHE-Kompatibilit&#228;t hergestellt.\n- `DocumentReference.sourcePatientInfo` muss im Rahmen von ISiK nicht gef&#252;llt werden\n\n#### Einschr&#228;nkungen des IHE-Profils\nElemente mit ValueSet-Bindings ohne verbindliche Vorgabe seitens IHE wurden auf die in Deutschland gebr&#228;uchlichen Terminologien (gem&#228;&#223; der Festlegungen von IHE Deutschland e.V.) eingeschr&#228;nkt." />
    <fhirVersion value="4.0.1" />
    <mapping>
        <identity value="CompositionDocumentReferenceMapping" />
        <uri value="http://hl7.org/fhir/StructureDefinition/Composition" />
        <name value="Metadaten eines strukturieren Dokumentes (Document-Bundle)" />
    </mapping>
    <kind value="resource" />
    <abstract value="false" />
    <type value="DocumentReference" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/DocumentReference" />
    <derivation value="constraint" />
    <differential>
        <element id="DocumentReference.masterIdentifier">
            <path value="DocumentReference.masterIdentifier" />
            <short value="Versionsspezifische OID des Dokumentes" />
            <min value="1" />
            <mustSupport value="true" />
            <mapping>
                <identity value="CompositionDocumentReferenceMapping" />
                <map value="Bundle.identifier" />
            </mapping>
        </element>
        <element id="DocumentReference.masterIdentifier.system">
            <path value="DocumentReference.masterIdentifier.system" />
            <short value="Namensraum des Identifiers" />
            <comment value="Fix: `urn:ietf:rfc:3986`" />
            <min value="1" />
            <patternUri value="urn:ietf:rfc:3986" />
            <mustSupport value="true" />
        </element>
        <element id="DocumentReference.masterIdentifier.value">
            <path value="DocumentReference.masterIdentifier.value" />
            <short value="Wert des Identifiers" />
            <comment value="OID mit URI-Pr&#228;fix &amp;quot;urn:oid:&amp;quot;. Es sei darauf hingewiesen, dass OIDs auf Basis von UUIDs generiert werden k&#246;nnen, ohne einen eigenen Namesraum zu beantragen. Zun&#228;chst m&#252;ssen hierzu alle 128 Bit der UUID in einen Integer-Wert umgerechnet werden. Das Ergebnis muss ohne Bindestriche an die Root-OID &#39;2.25&#39; angeh&#228;ngt werden. Siehe [IHE International - Creating Unique IDs - OID and UUID](https://wiki.ihe.net/index.php/Creating_Unique_IDs_-_OID_and_UUID)." />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="DocumentReference.identifier">
            <path value="DocumentReference.identifier" />
            <comment value="Abweichend zu MHD V4.0.1 ist die Angabe eines Identifiers in ISiK nicht erforderlich.\nEin solcher kann bei Bedarf (z.B. zur Weitergabe des Dokumentes per XDS) erzeugt werden.\n&amp;#13;[Konsens der Arbeitsgruppe vom 12.11.2021]\n\nUpdate f&#252;r Stufe 3:\nIn MHD 4.2.0 wurde die Verpflichtung zur Angabe eines Identifiers gelockert, das ISiK-Profil ist damit in diesem Punkt wieder kompatibel zu IHE MHD." />
            <mustSupport value="true" />
            <mapping>
                <identity value="CompositionDocumentReferenceMapping" />
                <map value="Composition.identifier" />
            </mapping>
        </element>
        <element id="DocumentReference.status">
            <path value="DocumentReference.status" />
            <short value="Status des Dokumentenmetadatensatzes" />
            <comment value="Der Status des Dokumentes wird in DocumentReference.docStatus gesetzt." />
            <mustSupport value="true" />
            <mapping>
                <identity value="CompositionDocumentReferenceMapping" />
                <map value="=current" />
            </mapping>
        </element>
        <element id="DocumentReference.docStatus">
            <path value="DocumentReference.docStatus" />
            <short value="Bearbeitungsstatus des Dokumentes" />
            <comment value="Abweichend zu MHD V4.0.1 ist die Verwendung von docStatus im ISiK-Kontext erlaubt. Die Verwendung von docStatus bleibt jedoch optional,\n  da nicht alle Dokumentenerzeugende Systeme einen expliziten Freigabe-Workflow haben. Dokumentenserver m&#252;ssen jedoch in der Lage sein, den Dokumentenstatus\n (sofern vorhanden) zu persistieren, anzuzeigen und zu reproduzieren.\n  &amp;#13;[Konsens der Arbeitsgruppe vom 10.12.2021]" />
            <mustSupport value="true" />
            <mapping>
                <identity value="CompositionDocumentReferenceMapping" />
                <map value="Composition.status" />
            </mapping>
        </element>
        <element id="DocumentReference.type">
            <path value="DocumentReference.type" />
            <short value="Dokumententyp" />
            <comment value="Im ISiK-Kontext ist die Typisierung eines Dokumentes mit Hilfe eines KDL-Codes *und* des IHE-XDS-Type-Codes erforderlich und ein Server MUSS beide Kodierungen bereitstellen - trotz der Kardinalit&#228;t DocumentReference.type.coding:XDS 0..1 -, jedoch ist der IHE-XDS-Type-Code bei &#220;bermittlung f&#252;r Clients nicht verpflichtend (s.u. zu XDS).\n  W&#228;hrend KDL-Codes eine feingranulare Dokumentenklassifikation f&#252;r die gezielte Suche nach medizinischen und Administrativen Dokumenten erm&#246;glichen,\n  sind IHE-XDS-Type-Codes f&#252;r den einrichtungs&#252;bergreifenden Dokumentenaustausch ma&#223;geblich.\n  Der XDS-Type-Code kann mit Hilfe der bereitgestellten [ConceptMaps](https://simplifier.net/kdl/~resources?category=ConceptMap)\n  aus dem KDL-Code ermittelt werden. Weitere Typisierungen (z.B. nach SNOMED oder LOINC) sind uneingeschr&#228;nkt erlaubt. [Konsens der Arbeitsgruppe vom 18.02.2022]. Im Falle, dass der Code &#39;UNK&#39; entsprechend der ConceptMap verwendet werden soll, MUSS das System &#39;http://terminology.hl7.org/CodeSystem/v3-NullFlavor&#39; verwendet werden." />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="DocumentReference.type.coding">
            <path value="DocumentReference.type.coding" />
            <slicing>
                <discriminator>
                    <type value="pattern" />
                    <path value="$this" />
                </discriminator>
                <rules value="open" />
            </slicing>
            <min value="1" />
        </element>
        <element id="DocumentReference.type.coding:KDL">
            <path value="DocumentReference.type.coding" />
            <sliceName value="KDL" />
            <short value="Dokumenttyp gem. KDL-Terminologie" />
            <min value="1" />
            <max value="1" />
            <patternCoding>
                <system value="http://dvmd.de/fhir/CodeSystem/kdl" />
            </patternCoding>
            <mustSupport value="true" />
            <binding>
                <strength value="required" />
                <valueSet value="http://dvmd.de/fhir/ValueSet/kdl" />
            </binding>
            <mapping>
                <identity value="CompositionDocumentReferenceMapping" />
                <map value="Composition.type.coding[KDL]" />
            </mapping>
        </element>
        <element id="DocumentReference.type.coding:KDL.system">
            <path value="DocumentReference.type.coding.system" />
            <short value="Kodiersystem" />
            <comment value="Fix: &amp;quot;http://dvmd.de/fhir/CodeSystem/kdl&amp;quot;" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="DocumentReference.type.coding:KDL.code">
            <path value="DocumentReference.type.coding.code" />
            <short value="Code" />
            <comment value="Der KDL-Code" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="DocumentReference.type.coding:KDL.display">
            <path value="DocumentReference.type.coding.display" />
            <short value="Anzeigetext" />
            <comment value="Der Anzeigetext zum KDL-Code" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="DocumentReference.type.coding:XDS">
            <path value="DocumentReference.type.coding" />
            <sliceName value="XDS" />
            <short value="Dokumenttyp gem. IHE-De-Terminologie" />
            <comment value="Die &#220;bermittlung des XDS-Type-Codes ist im Rahmen der Dokumentenbereitstellung f&#252;r Clients nicht verpflichtend,\n  MUSS jedoch vom Server bei der Entgegennahme ggf. erg&#228;nzt und bei der Dokumentenabfrage zur&#252;ckgegeben werden. Der XDS-Type-Code kann &#252;ber die im Rahmen der [KDL-Spezifikation](https://simplifier.net/kdl) publizierten\n  [ConceptMaps](https://simplifier.net/kdl/~resources?category=ConceptMap) aus dem KDL-Code ermittelt werden" />
            <min value="0" />
            <max value="1" />
            <patternCoding>
                <system value="http://ihe-d.de/CodeSystems/IHEXDStypeCode" />
            </patternCoding>
            <mustSupport value="true" />
            <binding>
                <strength value="required" />
                <valueSet value="http://ihe-d.de/ValueSets/IHEXDStypeCode" />
            </binding>
            <mapping>
                <identity value="CompositionDocumentReferenceMapping" />
                <map value="Composition.type.coding[XDS]" />
                <comment value="Kann mittels Lookup in den KDL-&gt;XDS ConceptMaps anhand des KDL-Type-Codes ermittelt werden" />
            </mapping>
        </element>
        <element id="DocumentReference.type.coding:XDS.system">
            <path value="DocumentReference.type.coding.system" />
            <short value="Kodiersystem" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="DocumentReference.type.coding:XDS.code">
            <path value="DocumentReference.type.coding.code" />
            <short value="Code" />
            <comment value="Der XDS-Type-Code" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="DocumentReference.type.coding:XDS.display">
            <path value="DocumentReference.type.coding.display" />
            <short value="Anzeigetext" />
            <comment value="Der Anzeigetext zum XDS-Type-Code" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="DocumentReference.category">
            <path value="DocumentReference.category" />
            <short value="Dokumentklasse/-Kategorie" />
            <comment value="Die Kategorisierung von Dokumenten erfolgt mittels der von IHE Deutschland publizierten XDS-Class-Codes.\n  Die &#252;bermittlung des XDS-Class-Codes ist im Rahmen der Dokumentenbereitstellung f&#252;r Clients nicht verpflichtend,\n  muss jedoch vom Server bei der Entgegennahme ggf. erg&#228;nzt und bei der Dokumentenabfrage zur&#252;ckgegeben werden.\n  Der XDS-Class-Code kann mit Hilfe der bereitgestellten [ConceptMap](https://simplifier.net/kdl/~resources?category=ConceptMap)\n  aus dem KDL-Code ermittelt werden." />
            <max value="1" />
            <mustSupport value="true" />
        </element>
        <element id="DocumentReference.category.coding">
            <path value="DocumentReference.category.coding" />
            <slicing>
                <discriminator>
                    <type value="pattern" />
                    <path value="$this" />
                </discriminator>
                <rules value="open" />
            </slicing>
            <min value="1" />
        </element>
        <element id="DocumentReference.category.coding:XDS">
            <path value="DocumentReference.category.coding" />
            <sliceName value="XDS" />
            <min value="1" />
            <max value="1" />
            <patternCoding>
                <system value="http://ihe-d.de/CodeSystems/IHEXDSclassCode" />
            </patternCoding>
            <mustSupport value="true" />
            <binding>
                <strength value="required" />
                <valueSet value="http://ihe-d.de/ValueSets/IHEXDSclassCode" />
            </binding>
            <mapping>
                <identity value="CompositionDocumentReferenceMapping" />
                <map value="Composition.category.coding[XDS]" />
                <comment value="Kann mittels Lookup in den KDL-&gt;XDS ConceptMaps anhand des KDL-Type-Codes ermittelt werden" />
            </mapping>
        </element>
        <element id="DocumentReference.category.coding:XDS.system">
            <path value="DocumentReference.category.coding.system" />
            <short value="Kodiersystem" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="DocumentReference.category.coding:XDS.code">
            <path value="DocumentReference.category.coding.code" />
            <short value="Code" />
            <comment value="Der XDS-Class-Code" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="DocumentReference.category.coding:XDS.display">
            <path value="DocumentReference.category.coding.display" />
            <short value="Anzeigetext" />
            <comment value="Der Anzeigetext zum XDS-Class-Code" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="DocumentReference.subject">
            <path value="DocumentReference.subject" />
            <short value="Patientenbezug" />
            <min value="1" />
            <mustSupport value="true" />
            <mapping>
                <identity value="CompositionDocumentReferenceMapping" />
                <map value="Lookup Composition.subject.resolve().identifier[PID]" />
                <comment value="Ermittlung des korrekten Patienten auf dem Server anhand des Identifiers (PID) und/oder weiterer Kriterien erforderlich" />
            </mapping>
        </element>
        <element id="DocumentReference.subject.reference">
            <path value="DocumentReference.subject.reference" />
            <short value="Patienten-Link" />
            <comment value="**Begr&#252;ndung Pflichtfeld:** Die Verlinkung auf eine Patienten-Ressource dient der technischen Zuordnung der Dokumentation zu einem Patienten und erm&#246;glicht wichtige API-Funktionen wie verkettete Suche, (Reverse-)Include etc." />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="DocumentReference.date">
            <path value="DocumentReference.date" />
            <comment value="Abweichend zu MHD V4.0.1 ist die Verwendung von date im ISiK-Kontext nicht verpflichtend.\nDie Motivation f&#252;r die verbindliche Verwendung von `date` seitens IHE ist nicht nachvollziehbar.\nEin entsprechender Change Request zur Harmonisierung wurde eingereicht. Das Dokumentendatum wird in attachment.creation gesetzt.\n\nUpdate f&#252;r Stufe 3:\nIn MHD 4.2.0 wurde die Verpflichtung zur Angabe von date gelockert, das ISiK-Profil ist damit in diesem Punkt wieder kompatibel zu IHE MHD." />
        </element>
        <element id="DocumentReference.author">
            <path value="DocumentReference.author" />
            <short value="Autor des Dokumentes" />
            <comment value="In dieser Ausbaustufe ist die Nennung des Namens oder K&#252;rzels des Autors ausreichend.\n  Eine dar&#252;ber hinaus gehende Verlinkung auf einen Practitioner (aufl&#246;sbar auf dem Server) ist m&#246;glich aber nicht erforderlich." />
            <mustSupport value="true" />
            <mapping>
                <identity value="CompositionDocumentReferenceMapping" />
                <map value="Composition.author" />
            </mapping>
        </element>
        <element id="DocumentReference.author.display">
            <path value="DocumentReference.author.display" />
            <mustSupport value="true" />
        </element>
        <element id="DocumentReference.custodian">
            <path value="DocumentReference.custodian" />
            <comment value="Einschr&#228;nkung der Kardinalit&#228;t analog MHD V4.0.1" />
            <max value="0" />
        </element>
        <element id="DocumentReference.relatesTo">
            <path value="DocumentReference.relatesTo" />
            <comment value="Inbesondere relevant im Kontext von Updates. Bei inhaltlichen Updates MUSS eine `replaces`-Relation angegeben werden." />
            <mustSupport value="true" />
        </element>
        <element id="DocumentReference.relatesTo.code">
            <path value="DocumentReference.relatesTo.code" />
            <mapping>
                <identity value="CompositionDocumentReferenceMapping" />
                <map value="Composition.relatesTo.code" />
            </mapping>
        </element>
        <element id="DocumentReference.relatesTo.target">
            <path value="DocumentReference.relatesTo.target" />
            <mapping>
                <identity value="CompositionDocumentReferenceMapping" />
                <map value="Lookup Composition.relatesTo.targetReference.resolve().identifier" />
                <comment value="Ermittlung der zu ersetzenden DocumentReference anhand des identifiers der referenzierten Composition erforderlich" />
            </mapping>
        </element>
        <element id="DocumentReference.description">
            <path value="DocumentReference.description" />
            <comment value="Genaue menschenlesbare Beschreibung des Dokumentes, z.B. &amp;quot;Lungenfunktionstest vom 18.02.2022&amp;quot;" />
            <min value="1" />
            <mustSupport value="true" />
            <mapping>
                <identity value="CompositionDocumentReferenceMapping" />
                <map value="Composition.title" />
            </mapping>
        </element>
        <element id="DocumentReference.securityLabel">
            <path value="DocumentReference.securityLabel" />
            <short value="Vertraulichkeit" />
            <comment value="Die Bereitstellung der Vertraulichkeitsinformation durch den Ersteller des Dokumentes ist verpflichtend.\nEbenso sind Dokumentenserver verpflichtet, diese Information zu persistieren und bei der Dokumentenabfrage zu reproduzieren.\nDie ISiK-Spezifikation trifft jedoch keine Annahmen dar&#252;ber, wie sich einzelne Vertraulichkeitsstufen auf die Zugriffsberechtigungen\nverschiedener benutzer auf ein Dokument auswirken. Im ISiK-Kontext ist die Angabe einer der drei Vertraulichkeitsstufen\nN | R | V verpflichtend, jedoch ohne Einschr&#228;nkung der Verwendung zus&#228;tzlicher Vertraulichkeits-Flags.\n&amp;#13;\n\n[Konsens der Arbeitsgruppe vom 12.11.2021]" />
            <min value="1" />
            <mustSupport value="true" />
            <binding>
                <strength value="required" />
                <valueSet value="https://gematik.de/fhir/isik/ValueSet/ISiKConfidentialityCodes" />
            </binding>
        </element>
        <element id="DocumentReference.content">
            <path value="DocumentReference.content" />
            <short value="Beschreibung des Dokumenteninhaltes" />
            <comment value="Die Kardinalit&#228;t wurde angepasst, um den Vorgaben von IHE MHD zu ensprechen [&#196;nderung im Zuge der Kommentierung Stufe 3]." />
            <max value="1" />
            <mustSupport value="true" />
        </element>
        <element id="DocumentReference.content.attachment">
            <path value="DocumentReference.content.attachment" />
            <short value="Anhang" />
            <mustSupport value="true" />
        </element>
        <element id="DocumentReference.content.attachment.contentType">
            <path value="DocumentReference.content.attachment.contentType" />
            <short value="Mimetype des Dokumentes" />
            <comment value="Mimetype (Dateityp) des Dokumentes (z.B. &amp;quot;application/pdf&amp;quot;)" />
            <min value="1" />
            <mustSupport value="true" />
            <mapping>
                <identity value="CompositionDocumentReferenceMapping" />
                <map value="`application/html` f&#252;r den extrahierten Narrative, `application/fhir+xml` oder `application/fhir+json` f&#252;r das Bundle" />
            </mapping>
        </element>
        <element id="DocumentReference.content.attachment.language">
            <path value="DocumentReference.content.attachment.language" />
            <short value="Sprache, in der das Dokument verfasst wurde." />
            <comment value="Kann bei Systemen, die keine Mehrsprachigkeit unterst&#252;tzen,\n      fest auf &amp;quot;de&amp;quot; oder &amp;quot;de-DE&amp;quot; gesetzt werden." />
            <min value="1" />
            <mustSupport value="true" />
            <mapping>
                <identity value="CompositionDocumentReferenceMapping" />
                <map value="=de sofern keine abweichende Angabe in Composition.language" />
            </mapping>
        </element>
        <element id="DocumentReference.content.attachment.data">
            <path value="DocumentReference.content.attachment.data" />
            <short value="Base64-codierte Bin&#228;rdaten" />
            <comment value="Um die Suche nach Dokumenten effizient zu gestalten, d&#252;rfen die Dokumente selbst nicht in die DocumentReference eingebettet werden, \n      sondern m&#252;ssen als separates Datenobjekt referenziert werden. \n      \nUpdate f&#252;r Stufe 3:\nDie Ausnahme bildet die Interaktion &amp;quot;Dokumentenbereitstellung&amp;quot;, \nbei der die Bin&#228;rdaten des Dokumentes eingebettet in die DocumentReference an den Server &#252;bermittelt und dort dann in eine separate \nRessource ausgelagert und &#252;ber Attachment.url referenziert werden.\n\nEs ist zu beachten, dass diese base64-codierten Daten wiederum ein FHIR-Bundle (z.B. ein MIO oder ein ISiK Bericht aus einem Subsystem) repr&#228;sentieren k&#246;nnen. Um eine einheitliche Handhabung der Dokumente f&#252;r Clients zu erm&#246;glichen werden diese trotz strukturiertem Inhalt per base64 abgebildet." />
            <mustSupport value="true" />
        </element>
        <element id="DocumentReference.content.attachment.url">
            <path value="DocumentReference.content.attachment.url" />
            <short value="Referenz auf Dokument" />
            <comment value="Um die Suche nach Dokumenten effizient zu gestalten, d&#252;rfen die Dokumente selbst nicht in die DocumentReference eingebettet werden, \n      sondern m&#252;ssen als separates Datenobjekt referenziert werden. \n\nWird ein separates Datenobjekt im ISIK-Kontext referenziert, so MUSS dieses konform zum Profil [ISIKBinary](https://gematik.de/fhir/isik/v3/Basismodul/StructureDefinition/ISiKBinary) aus dem Basismodul sein.\n      \nUpdate f&#252;r Stufe 3:\nDie Ausnahme bildet die Interaktion &amp;quot;Dokumentenbereitstellung&amp;quot;, \nbei der die Bin&#228;rdaten des Dokumentes eingebettet in die DocumentReference an den Server &#252;bermittelt und dort dann in eine separate \nRessource ausgelagert und &#252;ber Attachment.url referenziert werden." />
            <mustSupport value="true" />
            <mapping>
                <identity value="CompositionDocumentReferenceMapping" />
                <map value="vom Server festgelegter Speicherort des Bundles/Narratives" />
            </mapping>
        </element>
        <element id="DocumentReference.content.attachment.creation">
            <path value="DocumentReference.content.attachment.creation" />
            <short value="Dokumentendatum" />
            <comment value="Es obliegt dem erzeugenden System, zu entscheiden,\n      welches Datum als Dokumentendatum geeignet ist, z.B. Datum der Erstellung oder Datum der letzten &#196;nderung" />
            <min value="1" />
            <mustSupport value="true" />
            <mapping>
                <identity value="CompositionDocumentReferenceMapping" />
                <map value="Composition.date" />
            </mapping>
        </element>
        <element id="DocumentReference.content.format">
            <path value="DocumentReference.content.format" />
            <short value="Format des Dokumentes" />
            <comment value="Sofern das Dokument nicht auf einem standardisierten,\n    strukturierten Austauschformat (z.B. CDA) basiert, f&#252;r dessen Interpretation ein konkretes Schema herangezogen werden muss,\n    gen&#252;gt die Angabe des Codes\n    &amp;quot;urn:ihe:iti:xds:2017:mimeTypeSufficient&amp;quot;" />
            <min value="1" />
            <mustSupport value="true" />
            <binding>
                <strength value="required" />
                <valueSet value="http://ihe-d.de/ValueSets/IHEXDSformatCodeDE" />
            </binding>
            <mapping>
                <identity value="CompositionDocumentReferenceMapping" />
                <map value="=urn:ihe:iti:xds:2017:mimeTypeSufficient" />
            </mapping>
        </element>
        <element id="DocumentReference.context">
            <path value="DocumentReference.context" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="DocumentReference.context.encounter">
            <path value="DocumentReference.context.encounter" />
            <short value="Aufenthaltsbezug" />
            <max value="1" />
            <mustSupport value="true" />
            <mapping>
                <identity value="CompositionDocumentReferenceMapping" />
                <map value="Lookup Composition.encounter.resolve().identifier" />
                <comment value="Ermittlung des korrekten Encounters auf dem Server anhand des Identifiers(Fallnummer) und/oder weiterer Kriterien erforderlich" />
            </mapping>
        </element>
        <element id="DocumentReference.context.encounter.reference">
            <path value="DocumentReference.context.encounter.reference" />
            <short value="Encounter-Link" />
            <comment value="**Begr&#252;ndung Pflichtfeld:** Die Verlinkung auf eine Encounter-Ressource dient der technischen Zuordnung der Dokumentation zu einem Aufenthalt und erm&#246;glicht wichtige API-Funktionen wie verkettete Suche, (Reverse-)Include etc.  **Hinweis Kompatibilit&#228;t:** In MHD 4.2.0 wurde das Verbot der Angabe einer Encounter-Referenz gelockert, das ISiK-Profil ist damit in diesem Punkt wieder kompatibel zu IHE MHD." />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="DocumentReference.context.event">
            <path value="DocumentReference.context.event" />
            <comment value="Binding auf IHE-DE Terminologie hinzugef&#252;gt" />
            <binding>
                <strength value="required" />
                <valueSet value="http://ihe-d.de/ValueSets/IHEXDSeventCodeList" />
            </binding>
        </element>
        <element id="DocumentReference.context.event.coding">
            <path value="DocumentReference.context.event.coding" />
            <min value="1" />
            <max value="1" />
        </element>
        <element id="DocumentReference.context.event.coding.system">
            <path value="DocumentReference.context.event.coding.system" />
            <min value="1" />
        </element>
        <element id="DocumentReference.context.event.coding.code">
            <path value="DocumentReference.context.event.coding.code" />
            <min value="1" />
        </element>
        <element id="DocumentReference.context.facilityType">
            <path value="DocumentReference.context.facilityType" />
            <short value="Art der Einrichtung, aus der das Dokument stammt" />
            <comment value="Kann, sofern keine abweichende Information bekannt ist auf &amp;quot;KHS&amp;quot; gesetzt werden." />
            <min value="1" />
            <mustSupport value="true" />
            <binding>
                <strength value="required" />
                <valueSet value="http://ihe-d.de/ValueSets/IHEXDShealthcareFacilityTypeCode" />
            </binding>
            <mapping>
                <identity value="CompositionDocumentReferenceMapping" />
                <map value="=KHS, sofern nichts anderes bekannt" />
            </mapping>
        </element>
        <element id="DocumentReference.context.practiceSetting">
            <path value="DocumentReference.context.practiceSetting" />
            <comment value="Binding auf IHE-DE Terminologie hinzugef&#252;gt" />
            <min value="1" />
            <mustSupport value="true" />
            <binding>
                <strength value="required" />
                <valueSet value="http://ihe-d.de/ValueSets/IHEXDSpracticeSettingCode" />
            </binding>
        </element>
    </differential>
</StructureDefinition>
{
    "resourceType": "StructureDefinition",
    "id": "ISiKDokumentenMetadaten",
    "url": "https://gematik.de/fhir/isik/StructureDefinition/ISiKDokumentenMetadaten",
    "version": "4.0.1",
    "name": "ISiKDokumentenMetadaten",
    "title": "Erforderliche Metadaten für Dokumentenaustausch in ISiK",
    "status": "active",
    "experimental": false,
    "date": "2025-01-24",
    "publisher": "gematik GmbH",
    "description": "Dieses Profil spezifiziert die Minimalanforderungen für die Bereitstellung von Dokumentenmetadaten im Rahmen des Bestätigungsverfahrens der gematik.  \n\n  ### Motivation\nDie Ressource DocumentReference enthält die Metadaten, die für die Verwaltung von und die Suche nach Dokumenten benötigt werden. Der Inhalt des Dokumentes wird über DocumentReference.content beschrieben und über DocumentReference.content.attachment referenziert. Die Trennung von Dokument und Metadaten ermöglicht Clients die effiziente Suche und Auflistung von verfügbaren Dokumenten, ohne dass diese vollständig vom Server geladen werden müssen. Servern ermöglicht dieser Ansatz die Trennung zwischen den Metadaten in einer Datenbank und der Dokumentenablage in z.B. einem Dateisystem.\n\n  ### Kompatibilität\nDieses Profil basiert auf dem Profil [MHD DocumentReference Comprehensive UnContained References Option](https://profiles.ihe.net/ITI/MHD/StructureDefinition-IHE.MHD.UnContained.Comprehensive.DocumentReference.html) (Version 4.2.0) von IHE International.\n\n  #### Abweichungen vom IHE-Profil\n- Die Verwendung von `DocumentReference.docStatus` ist im ISiK-Kontext gestattet.\n- `DocumentReference.category` muss vom Client bei Vorhandensein eines KDL-Codes in `DocumentReference.type` nicht gefüllt werden. Bei der Verarbeitung auf dem Server im Rahmen der Interaktion {{pagelink: Dokumentenbereitstellung}} wird `DocumentReference.category` anhand der [KDL-Mappings](https://simplifier.net/kdl/%7Eresources?category=ConceptMap&sortBy=RankScore_desc) ergänzt und damit die IHE-Kompatibilität hergestellt.\n- `DocumentReference.sourcePatientInfo` muss im Rahmen von ISiK nicht gefüllt werden\n\n#### Einschränkungen des IHE-Profils\nElemente mit ValueSet-Bindings ohne verbindliche Vorgabe seitens IHE wurden auf die in Deutschland gebräuchlichen Terminologien (gemäß der Festlegungen von IHE Deutschland e.V.) eingeschränkt.",
    "fhirVersion": "4.0.1",
    "mapping":  [
        {
            "identity": "CompositionDocumentReferenceMapping",
            "name": "Metadaten eines strukturieren Dokumentes (Document-Bundle)",
            "uri": "http://hl7.org/fhir/StructureDefinition/Composition"
        }
    ],
    "kind": "resource",
    "abstract": false,
    "type": "DocumentReference",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/DocumentReference",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "DocumentReference.masterIdentifier",
                "path": "DocumentReference.masterIdentifier",
                "short": "Versionsspezifische OID des Dokumentes",
                "min": 1,
                "mustSupport": true,
                "mapping":  [
                    {
                        "identity": "CompositionDocumentReferenceMapping",
                        "map": "Bundle.identifier"
                    }
                ]
            },
            {
                "id": "DocumentReference.masterIdentifier.system",
                "path": "DocumentReference.masterIdentifier.system",
                "short": "Namensraum des Identifiers",
                "comment": "Fix: `urn:ietf:rfc:3986`",
                "min": 1,
                "patternUri": "urn:ietf:rfc:3986",
                "mustSupport": true
            },
            {
                "id": "DocumentReference.masterIdentifier.value",
                "path": "DocumentReference.masterIdentifier.value",
                "short": "Wert des Identifiers",
                "comment": "OID mit URI-Präfix &quot;urn:oid:&quot;. Es sei darauf hingewiesen, dass OIDs auf Basis von UUIDs generiert werden können, ohne einen eigenen Namesraum zu beantragen. Zunächst müssen hierzu alle 128 Bit der UUID in einen Integer-Wert umgerechnet werden. Das Ergebnis muss ohne Bindestriche an die Root-OID '2.25' angehängt werden. Siehe [IHE International - Creating Unique IDs - OID and UUID](https://wiki.ihe.net/index.php/Creating_Unique_IDs_-_OID_and_UUID).",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "DocumentReference.identifier",
                "path": "DocumentReference.identifier",
                "comment": "Abweichend zu MHD V4.0.1 ist die Angabe eines Identifiers in ISiK nicht erforderlich.\nEin solcher kann bei Bedarf (z.B. zur Weitergabe des Dokumentes per XDS) erzeugt werden.\n&#13;[Konsens der Arbeitsgruppe vom 12.11.2021]\n\nUpdate für Stufe 3:\nIn MHD 4.2.0 wurde die Verpflichtung zur Angabe eines Identifiers gelockert, das ISiK-Profil ist damit in diesem Punkt wieder kompatibel zu IHE MHD.\n",
                "mustSupport": true,
                "mapping":  [
                    {
                        "identity": "CompositionDocumentReferenceMapping",
                        "map": "Composition.identifier"
                    }
                ]
            },
            {
                "id": "DocumentReference.status",
                "path": "DocumentReference.status",
                "short": "Status des Dokumentenmetadatensatzes",
                "comment": "Der Status des Dokumentes wird in DocumentReference.docStatus gesetzt.",
                "mustSupport": true,
                "mapping":  [
                    {
                        "identity": "CompositionDocumentReferenceMapping",
                        "map": "=current"
                    }
                ]
            },
            {
                "id": "DocumentReference.docStatus",
                "path": "DocumentReference.docStatus",
                "short": "Bearbeitungsstatus des Dokumentes",
                "comment": "Abweichend zu MHD V4.0.1 ist die Verwendung von docStatus im ISiK-Kontext erlaubt. Die Verwendung von docStatus bleibt jedoch optional,\n  da nicht alle Dokumentenerzeugende Systeme einen expliziten Freigabe-Workflow haben. Dokumentenserver müssen jedoch in der Lage sein, den Dokumentenstatus\n (sofern vorhanden) zu persistieren, anzuzeigen und zu reproduzieren.\n  &#13;[Konsens der Arbeitsgruppe vom 10.12.2021]",
                "mustSupport": true,
                "mapping":  [
                    {
                        "identity": "CompositionDocumentReferenceMapping",
                        "map": "Composition.status"
                    }
                ]
            },
            {
                "id": "DocumentReference.type",
                "path": "DocumentReference.type",
                "short": "Dokumententyp",
                "comment": "Im ISiK-Kontext ist die Typisierung eines Dokumentes mit Hilfe eines KDL-Codes *und* des IHE-XDS-Type-Codes erforderlich und ein Server MUSS beide Kodierungen bereitstellen - trotz der Kardinalität DocumentReference.type.coding:XDS 0..1 -, jedoch ist der IHE-XDS-Type-Code bei Übermittlung für Clients nicht verpflichtend (s.u. zu XDS).\n  Während KDL-Codes eine feingranulare Dokumentenklassifikation für die gezielte Suche nach medizinischen und Administrativen Dokumenten ermöglichen,\n  sind IHE-XDS-Type-Codes für den einrichtungsübergreifenden Dokumentenaustausch maßgeblich.\n  Der XDS-Type-Code kann mit Hilfe der bereitgestellten [ConceptMaps](https://simplifier.net/kdl/~resources?category=ConceptMap)\n  aus dem KDL-Code ermittelt werden. Weitere Typisierungen (z.B. nach SNOMED oder LOINC) sind uneingeschränkt erlaubt. [Konsens der Arbeitsgruppe vom 18.02.2022]. Im Falle, dass der Code 'UNK' entsprechend der ConceptMap verwendet werden soll, MUSS das System 'http://terminology.hl7.org/CodeSystem/v3-NullFlavor' verwendet werden.",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "DocumentReference.type.coding",
                "path": "DocumentReference.type.coding",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "pattern",
                            "path": "$this"
                        }
                    ],
                    "rules": "open"
                },
                "min": 1
            },
            {
                "id": "DocumentReference.type.coding:KDL",
                "path": "DocumentReference.type.coding",
                "sliceName": "KDL",
                "short": "Dokumenttyp gem. KDL-Terminologie",
                "min": 1,
                "max": "1",
                "patternCoding": {
                    "system": "http://dvmd.de/fhir/CodeSystem/kdl"
                },
                "mustSupport": true,
                "binding": {
                    "strength": "required",
                    "valueSet": "http://dvmd.de/fhir/ValueSet/kdl"
                },
                "mapping":  [
                    {
                        "identity": "CompositionDocumentReferenceMapping",
                        "map": "Composition.type.coding[KDL]"
                    }
                ]
            },
            {
                "id": "DocumentReference.type.coding:KDL.system",
                "path": "DocumentReference.type.coding.system",
                "short": "Kodiersystem",
                "comment": "Fix: &quot;http://dvmd.de/fhir/CodeSystem/kdl&quot;",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "DocumentReference.type.coding:KDL.code",
                "path": "DocumentReference.type.coding.code",
                "short": "Code",
                "comment": "Der KDL-Code",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "DocumentReference.type.coding:KDL.display",
                "path": "DocumentReference.type.coding.display",
                "short": "Anzeigetext",
                "comment": "Der Anzeigetext zum KDL-Code",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "DocumentReference.type.coding:XDS",
                "path": "DocumentReference.type.coding",
                "sliceName": "XDS",
                "short": "Dokumenttyp gem. IHE-De-Terminologie",
                "comment": "Die Übermittlung des XDS-Type-Codes ist im Rahmen der Dokumentenbereitstellung für Clients nicht verpflichtend,\n  MUSS jedoch vom Server bei der Entgegennahme ggf. ergänzt und bei der Dokumentenabfrage zurückgegeben werden. Der XDS-Type-Code kann über die im Rahmen der [KDL-Spezifikation](https://simplifier.net/kdl) publizierten\n  [ConceptMaps](https://simplifier.net/kdl/~resources?category=ConceptMap) aus dem KDL-Code ermittelt werden",
                "min": 0,
                "max": "1",
                "patternCoding": {
                    "system": "http://ihe-d.de/CodeSystems/IHEXDStypeCode"
                },
                "mustSupport": true,
                "binding": {
                    "strength": "required",
                    "valueSet": "http://ihe-d.de/ValueSets/IHEXDStypeCode"
                },
                "mapping":  [
                    {
                        "identity": "CompositionDocumentReferenceMapping",
                        "map": "Composition.type.coding[XDS]",
                        "comment": "Kann mittels Lookup in den KDL->XDS ConceptMaps anhand des KDL-Type-Codes ermittelt werden"
                    }
                ]
            },
            {
                "id": "DocumentReference.type.coding:XDS.system",
                "path": "DocumentReference.type.coding.system",
                "short": "Kodiersystem",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "DocumentReference.type.coding:XDS.code",
                "path": "DocumentReference.type.coding.code",
                "short": "Code",
                "comment": "Der XDS-Type-Code",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "DocumentReference.type.coding:XDS.display",
                "path": "DocumentReference.type.coding.display",
                "short": "Anzeigetext",
                "comment": "Der Anzeigetext zum XDS-Type-Code",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "DocumentReference.category",
                "path": "DocumentReference.category",
                "short": "Dokumentklasse/-Kategorie",
                "comment": "Die Kategorisierung von Dokumenten erfolgt mittels der von IHE Deutschland publizierten XDS-Class-Codes.\n  Die übermittlung des XDS-Class-Codes ist im Rahmen der Dokumentenbereitstellung für Clients nicht verpflichtend,\n  muss jedoch vom Server bei der Entgegennahme ggf. ergänzt und bei der Dokumentenabfrage zurückgegeben werden.\n  Der XDS-Class-Code kann mit Hilfe der bereitgestellten [ConceptMap](https://simplifier.net/kdl/~resources?category=ConceptMap)\n  aus dem KDL-Code ermittelt werden.",
                "max": "1",
                "mustSupport": true
            },
            {
                "id": "DocumentReference.category.coding",
                "path": "DocumentReference.category.coding",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "pattern",
                            "path": "$this"
                        }
                    ],
                    "rules": "open"
                },
                "min": 1
            },
            {
                "id": "DocumentReference.category.coding:XDS",
                "path": "DocumentReference.category.coding",
                "sliceName": "XDS",
                "min": 1,
                "max": "1",
                "patternCoding": {
                    "system": "http://ihe-d.de/CodeSystems/IHEXDSclassCode"
                },
                "mustSupport": true,
                "binding": {
                    "strength": "required",
                    "valueSet": "http://ihe-d.de/ValueSets/IHEXDSclassCode"
                },
                "mapping":  [
                    {
                        "identity": "CompositionDocumentReferenceMapping",
                        "map": "Composition.category.coding[XDS]",
                        "comment": "Kann mittels Lookup in den KDL->XDS ConceptMaps anhand des KDL-Type-Codes ermittelt werden"
                    }
                ]
            },
            {
                "id": "DocumentReference.category.coding:XDS.system",
                "path": "DocumentReference.category.coding.system",
                "short": "Kodiersystem",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "DocumentReference.category.coding:XDS.code",
                "path": "DocumentReference.category.coding.code",
                "short": "Code",
                "comment": "Der XDS-Class-Code",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "DocumentReference.category.coding:XDS.display",
                "path": "DocumentReference.category.coding.display",
                "short": "Anzeigetext",
                "comment": "Der Anzeigetext zum XDS-Class-Code",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "DocumentReference.subject",
                "path": "DocumentReference.subject",
                "short": "Patientenbezug",
                "min": 1,
                "mustSupport": true,
                "mapping":  [
                    {
                        "identity": "CompositionDocumentReferenceMapping",
                        "map": "Lookup Composition.subject.resolve().identifier[PID]",
                        "comment": "Ermittlung des korrekten Patienten auf dem Server anhand des Identifiers (PID) und/oder weiterer Kriterien erforderlich"
                    }
                ]
            },
            {
                "id": "DocumentReference.subject.reference",
                "path": "DocumentReference.subject.reference",
                "short": "Patienten-Link",
                "comment": "**Begründung Pflichtfeld:** Die Verlinkung auf eine Patienten-Ressource dient der technischen Zuordnung der Dokumentation zu einem Patienten und ermöglicht wichtige API-Funktionen wie verkettete Suche, (Reverse-)Include etc.",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "DocumentReference.date",
                "path": "DocumentReference.date",
                "comment": "Abweichend zu MHD V4.0.1 ist die Verwendung von date im ISiK-Kontext nicht verpflichtend.\nDie Motivation für die verbindliche Verwendung von `date` seitens IHE ist nicht nachvollziehbar.\nEin entsprechender Change Request zur Harmonisierung wurde eingereicht. Das Dokumentendatum wird in attachment.creation gesetzt.\n\nUpdate für Stufe 3:\nIn MHD 4.2.0 wurde die Verpflichtung zur Angabe von date gelockert, das ISiK-Profil ist damit in diesem Punkt wieder kompatibel zu IHE MHD.\n"
            },
            {
                "id": "DocumentReference.author",
                "path": "DocumentReference.author",
                "short": "Autor des Dokumentes",
                "comment": "In dieser Ausbaustufe ist die Nennung des Namens oder Kürzels des Autors ausreichend.\n  Eine darüber hinaus gehende Verlinkung auf einen Practitioner (auflösbar auf dem Server) ist möglich aber nicht erforderlich.",
                "mustSupport": true,
                "mapping":  [
                    {
                        "identity": "CompositionDocumentReferenceMapping",
                        "map": "Composition.author"
                    }
                ]
            },
            {
                "id": "DocumentReference.author.display",
                "path": "DocumentReference.author.display",
                "mustSupport": true
            },
            {
                "id": "DocumentReference.custodian",
                "path": "DocumentReference.custodian",
                "comment": "Einschränkung der Kardinalität analog MHD V4.0.1",
                "max": "0"
            },
            {
                "id": "DocumentReference.relatesTo",
                "path": "DocumentReference.relatesTo",
                "comment": "Inbesondere relevant im Kontext von Updates. Bei inhaltlichen Updates MUSS eine `replaces`-Relation angegeben werden.",
                "mustSupport": true
            },
            {
                "id": "DocumentReference.relatesTo.code",
                "path": "DocumentReference.relatesTo.code",
                "mapping":  [
                    {
                        "identity": "CompositionDocumentReferenceMapping",
                        "map": "Composition.relatesTo.code"
                    }
                ]
            },
            {
                "id": "DocumentReference.relatesTo.target",
                "path": "DocumentReference.relatesTo.target",
                "mapping":  [
                    {
                        "identity": "CompositionDocumentReferenceMapping",
                        "map": "Lookup Composition.relatesTo.targetReference.resolve().identifier",
                        "comment": "Ermittlung der zu ersetzenden DocumentReference anhand des identifiers der referenzierten Composition erforderlich"
                    }
                ]
            },
            {
                "id": "DocumentReference.description",
                "path": "DocumentReference.description",
                "comment": "Genaue menschenlesbare Beschreibung des Dokumentes, z.B. &quot;Lungenfunktionstest vom 18.02.2022&quot;",
                "min": 1,
                "mustSupport": true,
                "mapping":  [
                    {
                        "identity": "CompositionDocumentReferenceMapping",
                        "map": "Composition.title"
                    }
                ]
            },
            {
                "id": "DocumentReference.securityLabel",
                "path": "DocumentReference.securityLabel",
                "short": "Vertraulichkeit",
                "comment": "Die Bereitstellung der Vertraulichkeitsinformation durch den Ersteller des Dokumentes ist verpflichtend.\nEbenso sind Dokumentenserver verpflichtet, diese Information zu persistieren und bei der Dokumentenabfrage zu reproduzieren.\nDie ISiK-Spezifikation trifft jedoch keine Annahmen darüber, wie sich einzelne Vertraulichkeitsstufen auf die Zugriffsberechtigungen\nverschiedener benutzer auf ein Dokument auswirken. Im ISiK-Kontext ist die Angabe einer der drei Vertraulichkeitsstufen\nN | R | V verpflichtend, jedoch ohne Einschränkung der Verwendung zusätzlicher Vertraulichkeits-Flags.\n&#13;\n\n[Konsens der Arbeitsgruppe vom 12.11.2021]",
                "min": 1,
                "mustSupport": true,
                "binding": {
                    "strength": "required",
                    "valueSet": "https://gematik.de/fhir/isik/ValueSet/ISiKConfidentialityCodes"
                }
            },
            {
                "id": "DocumentReference.content",
                "path": "DocumentReference.content",
                "short": "Beschreibung des Dokumenteninhaltes",
                "comment": "Die Kardinalität wurde angepasst, um den Vorgaben von IHE MHD zu ensprechen [Änderung im Zuge der Kommentierung Stufe 3].",
                "max": "1",
                "mustSupport": true
            },
            {
                "id": "DocumentReference.content.attachment",
                "path": "DocumentReference.content.attachment",
                "short": "Anhang",
                "mustSupport": true
            },
            {
                "id": "DocumentReference.content.attachment.contentType",
                "path": "DocumentReference.content.attachment.contentType",
                "short": "Mimetype des Dokumentes",
                "comment": "Mimetype (Dateityp) des Dokumentes (z.B. &quot;application/pdf&quot;)",
                "min": 1,
                "mustSupport": true,
                "mapping":  [
                    {
                        "identity": "CompositionDocumentReferenceMapping",
                        "map": "`application/html` für den extrahierten Narrative, `application/fhir+xml` oder `application/fhir+json` für das Bundle"
                    }
                ]
            },
            {
                "id": "DocumentReference.content.attachment.language",
                "path": "DocumentReference.content.attachment.language",
                "short": "Sprache, in der das Dokument verfasst wurde.",
                "comment": "Kann bei Systemen, die keine Mehrsprachigkeit unterstützen,\n      fest auf &quot;de&quot; oder &quot;de-DE&quot; gesetzt werden.",
                "min": 1,
                "mustSupport": true,
                "mapping":  [
                    {
                        "identity": "CompositionDocumentReferenceMapping",
                        "map": "=de sofern keine abweichende Angabe in Composition.language"
                    }
                ]
            },
            {
                "id": "DocumentReference.content.attachment.data",
                "path": "DocumentReference.content.attachment.data",
                "short": "Base64-codierte Binärdaten",
                "comment": "Um die Suche nach Dokumenten effizient zu gestalten, dürfen die Dokumente selbst nicht in die DocumentReference eingebettet werden, \n      sondern müssen als separates Datenobjekt referenziert werden. \n      \nUpdate für Stufe 3:\nDie Ausnahme bildet die Interaktion &quot;Dokumentenbereitstellung&quot;, \nbei der die Binärdaten des Dokumentes eingebettet in die DocumentReference an den Server übermittelt und dort dann in eine separate \nRessource ausgelagert und über Attachment.url referenziert werden.\n\nEs ist zu beachten, dass diese base64-codierten Daten wiederum ein FHIR-Bundle (z.B. ein MIO oder ein ISiK Bericht aus einem Subsystem) repräsentieren können. Um eine einheitliche Handhabung der Dokumente für Clients zu ermöglichen werden diese trotz strukturiertem Inhalt per base64 abgebildet.",
                "mustSupport": true
            },
            {
                "id": "DocumentReference.content.attachment.url",
                "path": "DocumentReference.content.attachment.url",
                "short": "Referenz auf Dokument",
                "comment": "Um die Suche nach Dokumenten effizient zu gestalten, dürfen die Dokumente selbst nicht in die DocumentReference eingebettet werden, \n      sondern müssen als separates Datenobjekt referenziert werden. \n\nWird ein separates Datenobjekt im ISIK-Kontext referenziert, so MUSS dieses konform zum Profil [ISIKBinary](https://gematik.de/fhir/isik/v3/Basismodul/StructureDefinition/ISiKBinary) aus dem Basismodul sein.\n      \nUpdate für Stufe 3:\nDie Ausnahme bildet die Interaktion &quot;Dokumentenbereitstellung&quot;, \nbei der die Binärdaten des Dokumentes eingebettet in die DocumentReference an den Server übermittelt und dort dann in eine separate \nRessource ausgelagert und über Attachment.url referenziert werden.",
                "mustSupport": true,
                "mapping":  [
                    {
                        "identity": "CompositionDocumentReferenceMapping",
                        "map": "vom Server festgelegter Speicherort des Bundles/Narratives"
                    }
                ]
            },
            {
                "id": "DocumentReference.content.attachment.creation",
                "path": "DocumentReference.content.attachment.creation",
                "short": "Dokumentendatum",
                "comment": "Es obliegt dem erzeugenden System, zu entscheiden,\n      welches Datum als Dokumentendatum geeignet ist, z.B. Datum der Erstellung oder Datum der letzten Änderung",
                "min": 1,
                "mustSupport": true,
                "mapping":  [
                    {
                        "identity": "CompositionDocumentReferenceMapping",
                        "map": "Composition.date"
                    }
                ]
            },
            {
                "id": "DocumentReference.content.format",
                "path": "DocumentReference.content.format",
                "short": "Format des Dokumentes",
                "comment": "Sofern das Dokument nicht auf einem standardisierten,\n    strukturierten Austauschformat (z.B. CDA) basiert, für dessen Interpretation ein konkretes Schema herangezogen werden muss,\n    genügt die Angabe des Codes\n    &quot;urn:ihe:iti:xds:2017:mimeTypeSufficient&quot;",
                "min": 1,
                "mustSupport": true,
                "binding": {
                    "strength": "required",
                    "valueSet": "http://ihe-d.de/ValueSets/IHEXDSformatCodeDE"
                },
                "mapping":  [
                    {
                        "identity": "CompositionDocumentReferenceMapping",
                        "map": "=urn:ihe:iti:xds:2017:mimeTypeSufficient"
                    }
                ]
            },
            {
                "id": "DocumentReference.context",
                "path": "DocumentReference.context",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "DocumentReference.context.encounter",
                "path": "DocumentReference.context.encounter",
                "short": "Aufenthaltsbezug",
                "max": "1",
                "mustSupport": true,
                "mapping":  [
                    {
                        "identity": "CompositionDocumentReferenceMapping",
                        "map": "Lookup Composition.encounter.resolve().identifier",
                        "comment": "Ermittlung des korrekten Encounters auf dem Server anhand des Identifiers(Fallnummer) und/oder weiterer Kriterien erforderlich"
                    }
                ]
            },
            {
                "id": "DocumentReference.context.encounter.reference",
                "path": "DocumentReference.context.encounter.reference",
                "short": "Encounter-Link",
                "comment": "**Begründung Pflichtfeld:** Die Verlinkung auf eine Encounter-Ressource dient der technischen Zuordnung der Dokumentation zu einem Aufenthalt und ermöglicht wichtige API-Funktionen wie verkettete Suche, (Reverse-)Include etc.  **Hinweis Kompatibilität:** In MHD 4.2.0 wurde das Verbot der Angabe einer Encounter-Referenz gelockert, das ISiK-Profil ist damit in diesem Punkt wieder kompatibel zu IHE MHD.",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "DocumentReference.context.event",
                "path": "DocumentReference.context.event",
                "comment": "Binding auf IHE-DE Terminologie hinzugefügt",
                "binding": {
                    "strength": "required",
                    "valueSet": "http://ihe-d.de/ValueSets/IHEXDSeventCodeList"
                }
            },
            {
                "id": "DocumentReference.context.event.coding",
                "path": "DocumentReference.context.event.coding",
                "min": 1,
                "max": "1"
            },
            {
                "id": "DocumentReference.context.event.coding.system",
                "path": "DocumentReference.context.event.coding.system",
                "min": 1
            },
            {
                "id": "DocumentReference.context.event.coding.code",
                "path": "DocumentReference.context.event.coding.code",
                "min": 1
            },
            {
                "id": "DocumentReference.context.facilityType",
                "path": "DocumentReference.context.facilityType",
                "short": "Art der Einrichtung, aus der das Dokument stammt",
                "comment": "Kann, sofern keine abweichende Information bekannt ist auf &quot;KHS&quot; gesetzt werden.",
                "min": 1,
                "mustSupport": true,
                "binding": {
                    "strength": "required",
                    "valueSet": "http://ihe-d.de/ValueSets/IHEXDShealthcareFacilityTypeCode"
                },
                "mapping":  [
                    {
                        "identity": "CompositionDocumentReferenceMapping",
                        "map": "=KHS, sofern nichts anderes bekannt"
                    }
                ]
            },
            {
                "id": "DocumentReference.context.practiceSetting",
                "path": "DocumentReference.context.practiceSetting",
                "comment": "Binding auf IHE-DE Terminologie hinzugefügt",
                "min": 1,
                "mustSupport": true,
                "binding": {
                    "strength": "required",
                    "valueSet": "http://ihe-d.de/ValueSets/IHEXDSpracticeSettingCode"
                }
            }
        ]
    }
}

Mappings

Ziel: DocumentReferenceQuelle: Document-BundleHinweis
DocumentReference.masterIdentifierBundle.identifier
DocumentReference.identifierComposition.identifier
DocumentReference.status=current
DocumentReference.docStatusComposition.status
DocumentReference.type.coding:KDLComposition.type.coding[KDL]
DocumentReference.type.coding:XDSComposition.type.coding[XDS]Kann mittels Lookup in den KDL->XDS ConceptMaps anhand des KDL-Type-Codes ermittelt werden
DocumentReference.category.coding:XDSComposition.category.coding[XDS]Kann mittels Lookup in den KDL->XDS ConceptMaps anhand des KDL-Type-Codes ermittelt werden
DocumentReference.subjectLookup Composition.subject.resolve().identifier[PID]Ermittlung des korrekten Patienten auf dem Server anhand des Identifiers (PID) und/oder weiterer Kriterien erforderlich
DocumentReference.authorComposition.author
DocumentReference.relatesTo.codeComposition.relatesTo.code
DocumentReference.relatesTo.targetLookup Composition.relatesTo.targetReference.resolve().identifierErmittlung der zu ersetzenden DocumentReference anhand des identifiers der referenzierten Composition erforderlich
DocumentReference.descriptionComposition.title
DocumentReference.content.attachment.contentType`application/html` für den extrahierten Narrative, `application/fhir+xml` oder `application/fhir+json` für das Bundle
DocumentReference.content.attachment.language=de sofern keine abweichende Angabe in Composition.language
DocumentReference.content.attachment.urlvom Server festgelegter Speicherort des Bundles/Narratives
DocumentReference.content.attachment.creationComposition.date
DocumentReference.content.format=urn:ihe:iti:xds:2017:mimeTypeSufficient
DocumentReference.context.encounterLookup Composition.encounter.resolve().identifierErmittlung des korrekten Encounters auf dem Server anhand des Identifiers(Fallnummer) und/oder weiterer Kriterien erforderlich
DocumentReference.context.facilityType=KHS, sofern nichts anderes bekannt

Anmerkungen zu Must-Support-Feldern

FeldnameKurzbeschreibungHinweise
DocumentReference.masterIdentifierVersionsspezifische OID des Dokumentes
DocumentReference.masterIdentifier.systemNamensraum des Identifiers

Fix: urn:ietf:rfc:3986

DocumentReference.masterIdentifier.valueWert des Identifiers

OID mit URI-Präfix "urn:oid:". Es sei darauf hingewiesen, dass OIDs auf Basis von UUIDs generiert werden können, ohne einen eigenen Namesraum zu beantragen. Zunächst müssen hierzu alle 128 Bit der UUID in einen Integer-Wert umgerechnet werden. Das Ergebnis muss ohne Bindestriche an die Root-OID '2.25' angehängt werden. Siehe IHE International - Creating Unique IDs - OID and UUID.

DocumentReference.identifier

Abweichend zu MHD V4.0.1 ist die Angabe eines Identifiers in ISiK nicht erforderlich. Ein solcher kann bei Bedarf (z.B. zur Weitergabe des Dokumentes per XDS) erzeugt werden.

[Konsens der Arbeitsgruppe vom 12.11.2021]

Update für Stufe 3: In MHD 4.2.0 wurde die Verpflichtung zur Angabe eines Identifiers gelockert, das ISiK-Profil ist damit in diesem Punkt wieder kompatibel zu IHE MHD.

DocumentReference.statusStatus des Dokumentenmetadatensatzes

Der Status des Dokumentes wird in DocumentReference.docStatus gesetzt.

DocumentReference.docStatusBearbeitungsstatus des Dokumentes

Abweichend zu MHD V4.0.1 ist die Verwendung von docStatus im ISiK-Kontext erlaubt. Die Verwendung von docStatus bleibt jedoch optional, da nicht alle Dokumentenerzeugende Systeme einen expliziten Freigabe-Workflow haben. Dokumentenserver müssen jedoch in der Lage sein, den Dokumentenstatus (sofern vorhanden) zu persistieren, anzuzeigen und zu reproduzieren.

[Konsens der Arbeitsgruppe vom 10.12.2021]

DocumentReference.typeDokumententyp

Im ISiK-Kontext ist die Typisierung eines Dokumentes mit Hilfe eines KDL-Codes und des IHE-XDS-Type-Codes erforderlich und ein Server MUSS beide Kodierungen bereitstellen - trotz der Kardinalität DocumentReference.type.coding:XDS 0..1 -, jedoch ist der IHE-XDS-Type-Code bei Übermittlung für Clients nicht verpflichtend (s.u. zu XDS). Während KDL-Codes eine feingranulare Dokumentenklassifikation für die gezielte Suche nach medizinischen und Administrativen Dokumenten ermöglichen, sind IHE-XDS-Type-Codes für den einrichtungsübergreifenden Dokumentenaustausch maßgeblich. Der XDS-Type-Code kann mit Hilfe der bereitgestellten ConceptMaps aus dem KDL-Code ermittelt werden. Weitere Typisierungen (z.B. nach SNOMED oder LOINC) sind uneingeschränkt erlaubt. [Konsens der Arbeitsgruppe vom 18.02.2022]. Im Falle, dass der Code 'UNK' entsprechend der ConceptMap verwendet werden soll, MUSS das System 'http://terminology.hl7.org/CodeSystem/v3-NullFlavor' verwendet werden.

DocumentReference.type.coding:KDLDokumenttyp gem. KDL-Terminologie
DocumentReference.type.coding:KDL.systemKodiersystem

Fix: "http://dvmd.de/fhir/CodeSystem/kdl"

DocumentReference.type.coding:KDL.codeCode

Der KDL-Code

DocumentReference.type.coding:KDL.displayAnzeigetext

Der Anzeigetext zum KDL-Code

DocumentReference.type.coding:XDSDokumenttyp gem. IHE-De-Terminologie

Die Übermittlung des XDS-Type-Codes ist im Rahmen der Dokumentenbereitstellung für Clients nicht verpflichtend, MUSS jedoch vom Server bei der Entgegennahme ggf. ergänzt und bei der Dokumentenabfrage zurückgegeben werden. Der XDS-Type-Code kann über die im Rahmen der KDL-Spezifikation publizierten ConceptMaps aus dem KDL-Code ermittelt werden

DocumentReference.type.coding:XDS.systemKodiersystem
DocumentReference.type.coding:XDS.codeCode

Der XDS-Type-Code

DocumentReference.type.coding:XDS.displayAnzeigetext

Der Anzeigetext zum XDS-Type-Code

DocumentReference.categoryDokumentklasse/-Kategorie

Die Kategorisierung von Dokumenten erfolgt mittels der von IHE Deutschland publizierten XDS-Class-Codes. Die übermittlung des XDS-Class-Codes ist im Rahmen der Dokumentenbereitstellung für Clients nicht verpflichtend, muss jedoch vom Server bei der Entgegennahme ggf. ergänzt und bei der Dokumentenabfrage zurückgegeben werden. Der XDS-Class-Code kann mit Hilfe der bereitgestellten ConceptMap aus dem KDL-Code ermittelt werden.

DocumentReference.category.coding:XDS
DocumentReference.category.coding:XDS.systemKodiersystem
DocumentReference.category.coding:XDS.codeCode

Der XDS-Class-Code

DocumentReference.category.coding:XDS.displayAnzeigetext

Der Anzeigetext zum XDS-Class-Code

DocumentReference.subjectPatientenbezug
DocumentReference.subject.referencePatienten-Link

Begründung Pflichtfeld: Die Verlinkung auf eine Patienten-Ressource dient der technischen Zuordnung der Dokumentation zu einem Patienten und ermöglicht wichtige API-Funktionen wie verkettete Suche, (Reverse-)Include etc.

DocumentReference.authorAutor des Dokumentes

In dieser Ausbaustufe ist die Nennung des Namens oder Kürzels des Autors ausreichend. Eine darüber hinaus gehende Verlinkung auf einen Practitioner (auflösbar auf dem Server) ist möglich aber nicht erforderlich.

DocumentReference.author.display
DocumentReference.relatesTo

Inbesondere relevant im Kontext von Updates. Bei inhaltlichen Updates MUSS eine replaces-Relation angegeben werden.

DocumentReference.description

Genaue menschenlesbare Beschreibung des Dokumentes, z.B. "Lungenfunktionstest vom 18.02.2022"

DocumentReference.securityLabelVertraulichkeit

Die Bereitstellung der Vertraulichkeitsinformation durch den Ersteller des Dokumentes ist verpflichtend. Ebenso sind Dokumentenserver verpflichtet, diese Information zu persistieren und bei der Dokumentenabfrage zu reproduzieren. Die ISiK-Spezifikation trifft jedoch keine Annahmen darüber, wie sich einzelne Vertraulichkeitsstufen auf die Zugriffsberechtigungen verschiedener benutzer auf ein Dokument auswirken. Im ISiK-Kontext ist die Angabe einer der drei Vertraulichkeitsstufen N | R | V verpflichtend, jedoch ohne Einschränkung der Verwendung zusätzlicher Vertraulichkeits-Flags.

[Konsens der Arbeitsgruppe vom 12.11.2021]

DocumentReference.contentBeschreibung des Dokumenteninhaltes

Die Kardinalität wurde angepasst, um den Vorgaben von IHE MHD zu ensprechen [Änderung im Zuge der Kommentierung Stufe 3].

DocumentReference.content.attachmentAnhang
DocumentReference.content.attachment.contentTypeMimetype des Dokumentes

Mimetype (Dateityp) des Dokumentes (z.B. "application/pdf")

DocumentReference.content.attachment.languageSprache, in der das Dokument verfasst wurde.

Kann bei Systemen, die keine Mehrsprachigkeit unterstützen, fest auf "de" oder "de-DE" gesetzt werden.

DocumentReference.content.attachment.dataBase64-codierte Binärdaten

Um die Suche nach Dokumenten effizient zu gestalten, dürfen die Dokumente selbst nicht in die DocumentReference eingebettet werden, sondern müssen als separates Datenobjekt referenziert werden.

Update für Stufe 3: Die Ausnahme bildet die Interaktion "Dokumentenbereitstellung", bei der die Binärdaten des Dokumentes eingebettet in die DocumentReference an den Server übermittelt und dort dann in eine separate Ressource ausgelagert und über Attachment.url referenziert werden.

Es ist zu beachten, dass diese base64-codierten Daten wiederum ein FHIR-Bundle (z.B. ein MIO oder ein ISiK Bericht aus einem Subsystem) repräsentieren können. Um eine einheitliche Handhabung der Dokumente für Clients zu ermöglichen werden diese trotz strukturiertem Inhalt per base64 abgebildet.

DocumentReference.content.attachment.urlReferenz auf Dokument

Um die Suche nach Dokumenten effizient zu gestalten, dürfen die Dokumente selbst nicht in die DocumentReference eingebettet werden, sondern müssen als separates Datenobjekt referenziert werden.

Wird ein separates Datenobjekt im ISIK-Kontext referenziert, so MUSS dieses konform zum Profil ISIKBinary aus dem Basismodul sein.

Update für Stufe 3: Die Ausnahme bildet die Interaktion "Dokumentenbereitstellung", bei der die Binärdaten des Dokumentes eingebettet in die DocumentReference an den Server übermittelt und dort dann in eine separate Ressource ausgelagert und über Attachment.url referenziert werden.

DocumentReference.content.attachment.creationDokumentendatum

Es obliegt dem erzeugenden System, zu entscheiden, welches Datum als Dokumentendatum geeignet ist, z.B. Datum der Erstellung oder Datum der letzten Änderung

DocumentReference.content.formatFormat des Dokumentes

Sofern das Dokument nicht auf einem standardisierten, strukturierten Austauschformat (z.B. CDA) basiert, für dessen Interpretation ein konkretes Schema herangezogen werden muss, genügt die Angabe des Codes "urn:ihe:iti:xds:2017:mimeTypeSufficient"

DocumentReference.context
DocumentReference.context.encounterAufenthaltsbezug
DocumentReference.context.encounter.referenceEncounter-Link

Begründung Pflichtfeld: Die Verlinkung auf eine Encounter-Ressource dient der technischen Zuordnung der Dokumentation zu einem Aufenthalt und ermöglicht wichtige API-Funktionen wie verkettete Suche, (Reverse-)Include etc. Hinweis Kompatibilität: In MHD 4.2.0 wurde das Verbot der Angabe einer Encounter-Referenz gelockert, das ISiK-Profil ist damit in diesem Punkt wieder kompatibel zu IHE MHD.

DocumentReference.context.facilityTypeArt der Einrichtung, aus der das Dokument stammt

Kann, sofern keine abweichende Information bekannt ist auf "KHS" gesetzt werden.

DocumentReference.context.practiceSetting

Binding auf IHE-DE Terminologie hinzugefügt

Interaktionen

InteraktionHinweiseVerbindlichkeit
create

siehe Interaktion: Dokumentenbereitstellung

SHALL
read

siehe Interaktion: Dokumentenabfrage und -Zugriff

SHALL
search-typeSHALL
ParameterTypVerbindlichkeitHinweise
_idtokenSHALL

Beispiel: GET [base]/[Resourcetype]?_id=103270 Anwendungshinweis: Der Parameter _id wird selten alleinstehend verwendet, da sich zum Abruf einer Ressource anhand der id die READ-Interaktion besser anbietet. Der Parameter kann jedoch verwendet werden, um den Abruf einer Ressource bspw. mit einem _include weiterer Ressourcen zu verbinden, z.B. zum Abruf eines Encounters in Verbindung mit dem zugehörigen Patienten: GET [base]/Encounter?_id=103270&_include=Encounter:patient Weitere Details siehe FHIR-Kernspezifikation, Abschnitt Parameters for all resources. Dieser Suchparameter ist für die Umsetzung des IHE PDQm Profils verpflichtend.

_tagtokenSHALL

Beispiel: GET [base]/[Resourcetype]?_tag=https://example.org/codes|needs-review Anwendungshinweis: Weitere Details siehe FHIR-Kernspezifikation, Abschnitt Parameters for all resources sowie Abschnitt Tags.

_countnumberSHALL

Beispiel: GET [base]/[Resourcetype]?_count=100 Anwendungshinweis: Weitere Details siehe FHIR-Kernspezifikation, Abschnitt Page Count.

_hasstringMAY

Beispiel: Suche nach allen Patienten, die eine Observation mit dem Code '1234-5' haben GET [base]/Patient?_has:Observation:patient:code=1234-5 Beispiel: Suche nach allen Encountern, bei denen die Diagnose 'A12.3' gestellt wurde GET [base]/Encounter?_has:Condition:encounter:code=A12.3 Anwendungshinweis: Weitere Details siehe FHIR-Kernspezifikation, Abschnitt Reverse Chaining.

statustokenSHALL

Beispiel: GET [base]/DocumentReference?status=final Anwendungshinweis: Weitere Details siehe FHIR-Kernspezifikation. Dieser Suchparameter ist für die Umsetzung des IHE MHD Profils für Clients und Server verpflichend.

patientreferenceSHALL

Beispiel: GET [base]/DocumentReference?patient=Patient/123 GET [base]/DocumentReference?patient.identifier=http://mein-krankenhaus.example/fhir/sid/patienten|1032702 GET [base]/DocumentReference?patient.identifier=1032702 Anwendungshinweis: Weitere Details siehe FHIR-Kernspezifikation. Weitere Informationen zur Suche nach verketteten Parametern finden sich in der FHIR-Kernspezifikation - Abschnitt Chained Parameters. Dieser Suchparameter ist für die Umsetzung des IHE MHD Profils für Clients und Server verpflichend.

typetokenSHALL

Beispiel: GET [base]/DocumentReference?type=http://dvmd.de/fhir/CodeSystem/kdl|AD010101 Anwendungshinweis: Weitere Details siehe FHIR-Kernspezifikation. Dieser Suchparameter ist für die Umsetzung des IHE MHD Profils für Server verpflichtend.

categorytokenSHALL

Beispiel: GET [base]/DocumentReference?category=http://ihe-d.de/CodeSystem/IHEXDSclassCode|BEF Anwendungshinweis: Weitere Details siehe FHIR-Kernspezifikation. Dieser Suchparameter ist für die Umsetzung des IHE MHD Profils für Server verpflichtend.

creationdateSHALL

Beispiel: GET [base]/DocumentReference?creation=2021-11-05 Anwendungshinweis: Weitere Details siehe FHIR-Kernspezifikation. Dieser Suchparameter ist Teil der IHE-MHD-Spezifikation und für die Umsetzung des IHE MHD Profils für Server verpflichtend.

encounterreferenceSHALL

Beispiel: GET [base]/DocumentReference?encounter=Encounter/123 Anwendungshinweis: Weitere Details siehe FHIR-Kernspezifikation.

(Reverse-)Include

Include
DocumentReference:patient; DocumentReference:encounter

Beispiele

Serverseitiges Dokument (vollständig annotiert)

DocumentReference
<DocumentReference xmlns="http://hl7.org/fhir">
    <id value="dok-beispiel-server" />
    <meta>
        <profile value="https://gematik.de/fhir/isik/StructureDefinition/ISiKDokumentenMetadaten" />
        <security>
            <system value="http://terminology.hl7.org/CodeSystem/v3-ActReason" />
            <code value="HTEST" />
        </security>
    </meta>
    <masterIdentifier>
        <system value="urn:ietf:rfc:3986" />
        <value value="urn:oid:1.2.840.113556.1.8000.2554.58783.21864.3474.19410.44358.58254.41281.46340" />
    </masterIdentifier>
    <status value="current" />
    <type>
        <coding>
            <system value="http://dvmd.de/fhir/CodeSystem/kdl" />
            <code value="PT130102" />
            <display value="Molekularpathologiebefund" />
        </coding>
        <coding>
            <system value="http://ihe-d.de/CodeSystems/IHEXDStypeCode" />
            <code value="PATH" />
            <display value="Pathologiebefundberichte" />
        </coding>
    </type>
    <category>
        <coding>
            <system value="http://ihe-d.de/CodeSystems/IHEXDSclassCode" />
            <code value="BEF" />
            <display value="Befundbericht" />
        </coding>
    </category>
    <subject>
        <reference value="Patient/PatientinMusterfrau" />
    </subject>
    <description value="Molekularpathologiebefund vom 31.12.21" />
    <securityLabel>
        <coding>
            <system value="http://terminology.hl7.org/CodeSystem/v3-Confidentiality" />
            <code value="N" />
        </coding>
    </securityLabel>
    <content>
        <attachment>
            <contentType value="application/pdf" />
            <language value="de" />
            <url value="https://mein-Dokumentenserver/dokumente/1.2.840.113556.1.8000.2554.58783.21864.3474.19410.44358.58254.41281.46340.pdf" />
            <creation value="2020-12-31T23:50:50-05:00" />
        </attachment>
        <format>
            <system value="http://ihe.net/fhir/ihe.formatcode.fhir/CodeSystem/formatcode" />
            <code value="urn:ihe:iti:xds:2017:mimeTypeSufficient" />
            <display value="mimeType Sufficient" />
        </format>
    </content>
    <context>
        <encounter>
            <reference value="Encounter/BeispielBesuch" />
        </encounter>
        <facilityType>
            <coding>
                <system value="http://ihe-d.de/CodeSystems/PatientBezogenenGesundheitsversorgung" />
                <code value="KHS" />
                <display value="Krankenhaus" />
            </coding>
        </facilityType>
        <practiceSetting>
            <coding>
                <system value="http://ihe-d.de/CodeSystems/AerztlicheFachrichtungen" />
                <code value="ALLG" />
            </coding>
        </practiceSetting>
    </context>
</DocumentReference>
{
    "resourceType": "DocumentReference",
    "id": "dok-beispiel-server",
    "meta": {
        "security":  [
            {
                "code": "HTEST",
                "system": "http://terminology.hl7.org/CodeSystem/v3-ActReason"
            }
        ],
        "profile":  [
            "https://gematik.de/fhir/isik/StructureDefinition/ISiKDokumentenMetadaten"
        ]
    },
    "masterIdentifier": {
        "system": "urn:ietf:rfc:3986",
        "value": "urn:oid:1.2.840.113556.1.8000.2554.58783.21864.3474.19410.44358.58254.41281.46340"
    },
    "type": {
        "coding":  [
            {
                "system": "http://dvmd.de/fhir/CodeSystem/kdl",
                "code": "PT130102",
                "display": "Molekularpathologiebefund"
            },
            {
                "system": "http://ihe-d.de/CodeSystems/IHEXDStypeCode",
                "code": "PATH",
                "display": "Pathologiebefundberichte"
            }
        ]
    },
    "category":  [
        {
            "coding":  [
                {
                    "system": "http://ihe-d.de/CodeSystems/IHEXDSclassCode",
                    "code": "BEF",
                    "display": "Befundbericht"
                }
            ]
        }
    ],
    "status": "current",
    "description": "Molekularpathologiebefund vom 31.12.21",
    "subject": {
        "reference": "Patient/PatientinMusterfrau"
    },
    "securityLabel":  [
        {
            "coding":  [
                {
                    "code": "N",
                    "system": "http://terminology.hl7.org/CodeSystem/v3-Confidentiality"
                }
            ]
        }
    ],
    "content":  [
        {
            "attachment": {
                "contentType": "application/pdf",
                "url": "https://mein-Dokumentenserver/dokumente/1.2.840.113556.1.8000.2554.58783.21864.3474.19410.44358.58254.41281.46340.pdf",
                "language": "de",
                "creation": "2020-12-31T23:50:50-05:00"
            },
            "format": {
                "code": "urn:ihe:iti:xds:2017:mimeTypeSufficient",
                "system": "http://ihe.net/fhir/ihe.formatcode.fhir/CodeSystem/formatcode",
                "display": "mimeType Sufficient"
            }
        }
    ],
    "context": {
        "facilityType": {
            "coding":  [
                {
                    "code": "KHS",
                    "system": "http://ihe-d.de/CodeSystems/PatientBezogenenGesundheitsversorgung",
                    "display": "Krankenhaus"
                }
            ]
        },
        "practiceSetting": {
            "coding":  [
                {
                    "code": "ALLG",
                    "system": "http://ihe-d.de/CodeSystems/AerztlicheFachrichtungen"
                }
            ]
        },
        "encounter":  [
            {
                "reference": "Encounter/BeispielBesuch"
            }
        ]
    }
}

Clientseitiges Dokument (nur mit KDL annotiert)

DocumentReference
<DocumentReference xmlns="http://hl7.org/fhir">
    <id value="dok-beispiel-client-with-binary-pdf-example-short" />
    <meta>
        <profile value="https://gematik.de/fhir/isik/StructureDefinition/ISiKDokumentenMetadaten" />
        <security>
            <system value="http://terminology.hl7.org/CodeSystem/v3-ActReason" />
            <code value="HTEST" />
        </security>
    </meta>
    <masterIdentifier>
        <system value="urn:ietf:rfc:3986" />
        <value value="urn:oid:1.2.840.113556.1.8000.2554.58783.21864.3474.19410.44358.58254.41281.46340" />
    </masterIdentifier>
    <status value="current" />
    <type>
        <coding>
            <system value="http://dvmd.de/fhir/CodeSystem/kdl" />
            <code value="PT130102" />
            <display value="Molekularpathologiebefund" />
        </coding>
    </type>
    <subject>
        <reference value="Patient/PatientinMusterfrau" />
    </subject>
    <description value="Molekularpathologiebefund vom 31.12.21" />
    <securityLabel>
        <coding>
            <system value="http://terminology.hl7.org/CodeSystem/v3-Confidentiality" />
            <code value="N" />
        </coding>
    </securityLabel>
    <content>
        <attachment>
            <contentType value="application/pdf" />
            <language value="de" />
            <data value="JVBERi0xLjUNJeLjz9MNCjEw" />
            <creation value="2020-12-31T23:50:50-05:00" />
        </attachment>
        <format>
            <system value="http://ihe.net/fhir/ihe.formatcode.fhir/CodeSystem/formatcode" />
            <code value="urn:ihe:iti:xds:2017:mimeTypeSufficient" />
            <display value="mimeType Sufficient" />
        </format>
    </content>
    <context>
        <encounter>
            <reference value="Encounter/BeispielBesuch" />
        </encounter>
        <facilityType>
            <coding>
                <system value="http://ihe-d.de/CodeSystems/PatientBezogenenGesundheitsversorgung" />
                <code value="KHS" />
                <display value="Krankenhaus" />
            </coding>
        </facilityType>
        <practiceSetting>
            <coding>
                <system value="http://ihe-d.de/CodeSystems/AerztlicheFachrichtungen" />
                <code value="ALLG" />
            </coding>
        </practiceSetting>
    </context>
</DocumentReference>
{
    "resourceType": "DocumentReference",
    "id": "dok-beispiel-client-with-binary-pdf-example-short",
    "meta": {
        "security":  [
            {
                "code": "HTEST",
                "system": "http://terminology.hl7.org/CodeSystem/v3-ActReason"
            }
        ],
        "profile":  [
            "https://gematik.de/fhir/isik/StructureDefinition/ISiKDokumentenMetadaten"
        ]
    },
    "masterIdentifier": {
        "system": "urn:ietf:rfc:3986",
        "value": "urn:oid:1.2.840.113556.1.8000.2554.58783.21864.3474.19410.44358.58254.41281.46340"
    },
    "type": {
        "coding":  [
            {
                "system": "http://dvmd.de/fhir/CodeSystem/kdl",
                "code": "PT130102",
                "display": "Molekularpathologiebefund"
            }
        ]
    },
    "status": "current",
    "description": "Molekularpathologiebefund vom 31.12.21",
    "subject": {
        "reference": "Patient/PatientinMusterfrau"
    },
    "securityLabel":  [
        {
            "coding":  [
                {
                    "code": "N",
                    "system": "http://terminology.hl7.org/CodeSystem/v3-Confidentiality"
                }
            ]
        }
    ],
    "content":  [
        {
            "attachment": {
                "contentType": "application/pdf",
                "data": "JVBERi0xLjUNJeLjz9MNCjEw",
                "language": "de",
                "creation": "2020-12-31T23:50:50-05:00"
            },
            "format": {
                "code": "urn:ihe:iti:xds:2017:mimeTypeSufficient",
                "system": "http://ihe.net/fhir/ihe.formatcode.fhir/CodeSystem/formatcode",
                "display": "mimeType Sufficient"
            }
        }
    ],
    "context": {
        "facilityType": {
            "coding":  [
                {
                    "code": "KHS",
                    "system": "http://ihe-d.de/CodeSystems/PatientBezogenenGesundheitsversorgung",
                    "display": "Krankenhaus"
                }
            ]
        },
        "practiceSetting": {
            "coding":  [
                {
                    "code": "ALLG",
                    "system": "http://ihe-d.de/CodeSystems/AerztlicheFachrichtungen"
                }
            ]
        },
        "encounter":  [
            {
                "reference": "Encounter/BeispielBesuch"
            }
        ]
    }
}