Implementierungsleitfaden ISiK-Dokumentenaustausch

Dokumentenmetadaten (DocumentReference)

Die nachfolgenden Festlegungen spezifizieren 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 "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.

FHIR-Profil

DocumentReference

Canonical URL: https://gematik.de/fhir/isik/v3/Dokumentenaustausch/StructureDefinition/ISiKDokumentenMetadaten

Command 'tree' could not render: File was not found for 'https://gematik.de/fhir/isik/v3/Dokumentenaustausch/StructureDefinition/ISiKDokumentenMetadaten'

Link Simplifier Profil Übersicht

Anmerkungen zu Must-Support-Feldern

Interaktionen

Für die Ressource DocumentReference MUSS die REST-Interaktion "CREATE" implementiert werden, siehe

Command 'pagelink' could not render: Page not found.

. Für die Ressource DocumentReference MUSS die REST-Interaktion "READ" implementiert werden, siehe

Command 'pagelink' could not render: Page not found.

Folgende Suchparameter sind für das Bestätigungsverfahren relevant, auch in Kombination:

Die in IHE-MHD geltende Einschränkung, dass Clients bei allen Suchen mindestens die Parameter patient oder patient.identifier sowie status verwenden müssen, gilt nicht. Siehe dazu Kapitel

Command 'pagelink' could not render: Page not found.

Der Suchparameter "_id" MUSS unterstützt werden:

Beispiele:

GET [base]/DocumentReference?_id=103270

Anwendungshinweise: Weitere Informationen zur Suche nach "_id" finden sich in der FHIR-Basisspezifikation - Abschnitt "Parameters for all resources".
Der Suchparameter "status" MUSS unterstützt werden:

Beispiele:

GET [base]/DocumentReference?status=final

Anwendungshinweise: Weitere Informationen zur Suche nach Token-type Parametern finden sich in der FHIR-Basisspezifikation - Abschnitt "Token Search".

Dieser Suchparameter ist für die Umsetzung des IHE MHD Profils für Clients und Server verpflichend.
Der Suchparameter "patient" MUSS unterstützt werden:

Beispiele:

GET [base]/DocumentReference?patient=Patient/123

Anwendungshinweise: Weitere Informationen zur Suche nach Reference-type Parametern finden sich in der FHIR-Basisspezifikation - Abschnitt "Reference Search".

Dieser Suchparameter ist für die Umsetzung des IHE MHD Profils für Clients und Server verpflichend.
Der verkettete Suchparameter "patient.identifier" MUSS unterstützt werden:

Beispiele:

GET [base]/DocumentReference?patient.identifier=http://mein-krankenhaus.example/fhir/sid/patienten|1032702

GET [base]/DocumentReference?patient.identifier=1032702

Anwendungshinweise: Weitere Informationen zur Suche nach Token-type Parametern finden sich in der FHIR-Basisspezifikation - Abschnitt "Token Search".

Dieser Suchparameter ist für die Umsetzung des IHE MHD Profils für Client und Server verpflichtend.

Weitere Informationen zur Suche nach verketteten Parametern finden sich in der FHIR-Basisspezifikation - Abschnitt "Chained Parameters".
Der Suchparameter "type" MUSS unterstützt werden:

Beispiele:

GET [base]/DocumentReference?type=http://dvmd.de/fhir/CodeSystem/kdl|AD010101

Anwendungshinweise: Weitere Informationen zur Suche nach Token-type Parametern finden sich in der FHIR-Basisspezifikation - Abschnitt "Token Search".

Dieser Suchparameter ist für die Umsetzung des IHE MHD Profils für Server verpflichtend.
Der Suchparameter "category" MUSS unterstützt werden:

Beispiele:

GET [base]/DocumentReference?category=http://ihe-d.de/CodeSystem/IHEXDSclassCode|BEF

Anwendungshinweise: Weitere Informationen zur Suche nach Token-type Parametern finden sich in der FHIR-Basisspezifikation - Abschnitt "Token Search".

Dieser Suchparameter ist für die Umsetzung des IHE MHD Profils für Server verpflichtend.
Der custom Suchparameter "creation" MUSS unterstützt werden:

Beispiele:

GET [base]/DocumentReference?creation=2021-11-05

Anwendungshinweise: Weitere Informationen zur Suche nach Date-type Parametern finden sich in der FHIR-Basisspezifikation - Abschnitt "Date Search".

Dieser Suchparameter ist nicht Bestandteil der FHIR-Kernspezifikation und wurde von IHE im Rahmen der MHD-Spezifikation definiert.

Dieser Suchparameter ist für die Umsetzung des IHE MHD Profils für Server verpflichtend.
Der Suchparameter "encounter" MUSS unterstützt werden:

Beispiele:

GET [base]/DocumentReference?encounter=Encounter/123

Anwendungshinweise: Weitere Informationen zur Suche nach Reference-type Parametern finden sich in der FHIR-Basisspezifikation - Abschnitt "Reference Search".

Beispiele

Serverseitiges Dokument (vollständig annotiert)

in XML

<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/CodeSystem/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>

in JSON

{
    "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"
            },
            {
                "code": "PATH",
                "system": "http://ihe-d.de/CodeSystem/IHEXDStypeCode",
                "display": "Pathologiebefundberichte"
            }
        ]
    },
    "status": "current",
    "category":  [
        {
            "coding":  [
                {
                    "code": "BEF",
                    "system": "http://ihe-d.de/CodeSystems/IHEXDSclassCode",
                    "display": "Befundbericht"
                }
            ]
        }
    ],
    "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)

in XML

<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>

in JSON

{
    "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"
            }
        ]
    }
}