Diese Profil beschreibt die Metadaten zu einem klinischen Dokument. Eine ausführliche Beschreibung und Empfehlungen zur Verwendung des Profils befinden sich in der Beschreibung des Moduls (Beschreibung Modul).
| MII_PR_Dokument_Dokument (DocumentReference) | C | DocumentReference | |
| id | Σ | 0..1 | string |
| meta | S Σ | 0..1 | Meta |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| versionId | Σ | 0..1 | id |
| lastUpdated | Σ | 0..1 | instant |
| source | Σ | 0..1 | uri |
| profile | S Σ | 0..* | canonical(StructureDefinition) |
| security | Σ | 0..* | CodingBinding |
| tag | Σ | 0..* | Coding |
| implicitRules | Σ ?! | 0..1 | uri |
| language | 0..1 | codeBinding | |
| text | 0..1 | Narrative | |
| contained | 0..* | Resource | |
| extension | C | 0..* | Extension |
| nlp-processing-status | S C | 0..1 | Extension(CodeableConcept) |
| modifierExtension | ?! C | 0..* | Extension |
| masterIdentifier | S Σ | 0..1 | Identifier |
| identifier | S Σ | 0..* | Identifier |
| status | S Σ ?! | 1..1 | codeBinding |
| docStatus | S Σ | 0..1 | codeBinding |
| type | S Σ C | 0..1 | CodeableConceptBinding |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| coding | Σ | 1..* | Coding |
| (All Slices) | |||
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| system | S Σ | 1..1 | uri |
| version | Σ | 0..1 | string |
| code | S Σ | 1..1 | code |
| display | Σ | 0..1 | string |
| userSelected | Σ | 0..1 | boolean |
| KDL | S Σ | 0..1 | CodingBinding |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| system | S Σ | 1..1 | uriFixed Value |
| version | Σ | 0..1 | string |
| code | S Σ | 1..1 | code |
| display | Σ | 0..1 | string |
| userSelected | Σ | 0..1 | boolean |
| LNC | S Σ | 0..1 | CodingBinding |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| system | S Σ | 1..1 | uriFixed Value |
| version | Σ | 0..1 | string |
| code | S Σ | 1..1 | code |
| display | Σ | 0..1 | string |
| userSelected | Σ | 0..1 | boolean |
| SCT | S Σ | 0..1 | CodingBinding |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| system | S Σ | 1..1 | uriFixed Value |
| version | Σ | 0..1 | string |
| code | S Σ | 1..1 | code |
| display | Σ | 0..1 | string |
| userSelected | Σ | 0..1 | boolean |
| XDS | S Σ | 0..1 | CodingBinding |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| system | S Σ | 1..1 | uriFixed Value |
| version | Σ | 0..1 | string |
| code | S Σ | 1..1 | code |
| display | Σ | 0..1 | string |
| userSelected | Σ | 0..1 | boolean |
| text | Σ | 0..1 | string |
| category | S Σ C | 0..* | CodeableConcept |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| coding | Σ | 1..* | Coding |
| (All Slices) | |||
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| system | S Σ | 1..1 | uri |
| version | Σ | 0..1 | string |
| code | S Σ | 1..1 | code |
| display | Σ | 0..1 | string |
| userSelected | Σ | 0..1 | boolean |
| LNC | S Σ | 0..1 | CodingBinding |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| system | S Σ | 1..1 | uriFixed Value |
| version | Σ | 0..1 | string |
| code | S Σ | 1..1 | code |
| display | Σ | 0..1 | string |
| userSelected | Σ | 0..1 | boolean |
| SCT | S Σ | 0..1 | CodingBinding |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| system | S Σ | 1..1 | uriFixed Value |
| version | Σ | 0..1 | string |
| code | S Σ | 1..1 | code |
| display | Σ | 0..1 | string |
| userSelected | Σ | 0..1 | boolean |
| XDS | S Σ | 0..1 | CodingBinding |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| system | S Σ | 1..1 | uriFixed Value |
| version | Σ | 0..1 | string |
| code | S Σ | 1..1 | code |
| display | Σ | 0..1 | string |
| userSelected | Σ | 0..1 | boolean |
| text | Σ | 0..1 | string |
| subject | S Σ | 0..1 | Reference(Patient | https://www.medizininformatik-initiative.de/fhir/core/modul-person/StructureDefinition/Patient | https://www.medizininformatik-initiative.de/fhir/core/modul-person/StructureDefinition/PatientPseudonymisiert) |
| date | Σ | 0..1 | instant |
| author | Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) |
| authenticator | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | |
| custodian | 0..1 | Reference(Organization) | |
| relatesTo | S Σ | 0..* | BackboneElement |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| code | S Σ | 1..1 | codeBinding |
| target | S Σ | 1..1 | Reference(DocumentReference) |
| description | S Σ | 0..1 | string |
| securityLabel | S Σ | 0..* | CodeableConceptBinding |
| content | S Σ | 1..* | BackboneElement |
| (All Slices) | |||
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| attachment | S Σ | 1..1 | Attachment |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| contentType | S Σ | 0..1 | codeBinding |
| language | S Σ | 0..1 | codeBinding |
| data | 0..1 | base64Binary | |
| url | Σ | 0..1 | url |
| size | Σ | 0..1 | unsignedInt |
| hash | Σ | 0..1 | base64Binary |
| title | Σ | 0..1 | string |
| creation | S Σ | 0..1 | dateTime |
| format | S Σ | 0..1 | CodingBinding |
| Binaerdaten | S Σ | 0..* | BackboneElement |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| attachment | S Σ | 1..1 | Attachment |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| contentType | S Σ | 0..1 | codeBinding |
| language | S Σ | 0..1 | codeBinding |
| data | 1..1 | base64Binary | |
| url | Σ | 0..0 | url |
| size | Σ | 0..1 | unsignedInt |
| hash | Σ | 0..1 | base64Binary |
| title | Σ | 0..1 | string |
| creation | S Σ | 0..1 | dateTime |
| format | S Σ | 0..1 | CodingBinding |
| Verweis | S Σ | 0..* | BackboneElement |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| attachment | S Σ | 1..1 | Attachment |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| contentType | S Σ | 0..1 | codeBinding |
| language | S Σ | 0..1 | codeBinding |
| data | 0..0 | base64Binary | |
| url | Σ | 1..1 | url |
| size | Σ | 0..1 | unsignedInt |
| hash | Σ | 0..1 | base64Binary |
| title | Σ | 0..1 | string |
| creation | S Σ | 0..1 | dateTime |
| format | S Σ | 0..1 | CodingBinding |
| context | S Σ | 0..1 | BackboneElement |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| encounter | S | 0..* | Reference(Encounter | https://www.medizininformatik-initiative.de/fhir/core/modul-fall/StructureDefinition/KontaktGesundheitseinrichtung) |
| event | S | 0..* | CodeableConceptBinding |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| coding | Σ | 1..* | Coding |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| system | S Σ | 1..1 | uri |
| version | Σ | 0..1 | string |
| code | S Σ | 1..1 | code |
| display | Σ | 0..1 | string |
| userSelected | Σ | 0..1 | boolean |
| text | Σ | 0..1 | string |
| period | S Σ | 0..1 | Period |
| facilityType | S | 0..1 | CodeableConceptBinding |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| coding | Σ | 1..* | Coding |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| system | S Σ | 1..1 | uri |
| version | Σ | 0..1 | string |
| code | S Σ | 1..1 | code |
| display | Σ | 0..1 | string |
| userSelected | Σ | 0..1 | boolean |
| text | Σ | 0..1 | string |
| practiceSetting | S | 0..1 | CodeableConceptBinding |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| coding | Σ | 1..* | Coding |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| system | S Σ | 1..1 | uri |
| version | Σ | 0..1 | string |
| code | S Σ | 1..1 | code |
| display | Σ | 0..1 | string |
| userSelected | Σ | 0..1 | boolean |
| text | Σ | 0..1 | string |
| sourcePatientInfo | 0..1 | Reference(Patient) | |
| related | 0..* | Reference(Resource) |
| Datensatz | Erklärung | FHIR |
|---|---|---|
| Versionsspezifische Kennung | Versionsspezifische eindeutige Kennung, die dem Dokument durch die Dokumentenquelle zugewiesen wurde | DocumentReference.masterIdentifier |
| Versionsunabhängige Kennung | Andere versionsunabhängige Kennung, die dem Dokument (z.B. durch weitere dokumentenverarbeitende Systeme) zugewiesen wurde | DocumentReference.identifier |
| Status der Dokumentenreferenz | Status dieser Dokumentenreferenz (aktuell, überholt oder irrtümlich eingegeben) | DocumentReference.status |
| Status des Dokuments | Status des zugrunde liegenden Dokuments (vorläufig, final, geändert oder irrtümlich eingegeben) | DocumentReference.docStatus |
| Art des Dokuments | Art des Dokuments auf das verwiesen wird (z.B. Anamnese und Untersuchung, Entlassungsbericht, Verlaufsbericht) | DocumentReference.type |
| Kategorien des Dokuments | Übergeordnete Kategorie des Dokuments auf das verwiesen wird (z.B. Arztberichte oder Arztdokumentation) | DocumentReference.category |
| Verweis auf Patient | Patient auf den sich das verwiesene Dokument bezieht | DocumentReference.subject |
| Beschreibung des Dokuments | Menschenlesbare Beschreibung zum verwiesenen Dokuments | DocumentReference.description |
| Vertraulichkeit des Dokuments | Grad der Vertraulichkeit/Sicherheit des verwiesenen Dokuments (z. B. uneingeschränkt, gering, mittel, normal oder eingeschränkt) | DocumentReference.securityLabel |
| Beziehung des Dokuments | Beziehungen des verwiesenen Dokuments zu anderen Dokumenten | DocumentReference.relatesTo |
| Art der Beziehung | Beziehung zu anderen Dokumenten | DocumentReference.relatesTo.code |
| Verweis auf Dokument | Ziel der Dokumentenbeziehung | DocumentReference.relatesTo.target |
| Inhalt des Dokuments | Dokument (Base64-kodierte Daten) oder Verweis (URL) mit relevanten Metadaten zum Anhang | DocumentReference.content |
| Verfassungssprache des Inhalts | Verwendete Sprache in dem Dokument | DocumentReference.attachment.language |
| Erstellungsdatum des Inhalts | Datum der Erstellung des Dokumentes | DocumentReference.attachment.creation |
| Binärdaten zum Inhalt | Dokument als Binärdaten | DocumentReference.attachment.data |
| URL zum Inhalt | Verweis auf den (lokalen) Ablageort des Dokuments | DocumentReference.attachment.url |
| MIME-Typ zum Inhalt | MIME-Typ des Dokumenteninhalts | DocumentReference.attachment.contentType |
| Erzeugungskontext des Dokuments | Klinischer Kontext, in welchem das Dokument erzeugt wurde | DocumentReference.context |
| Verweis auf Einrichtungskontakt | Kontakt zur Gesundheitseinrichtung oder die Art der Versorgung, die mit dem Dokumenteninhalt assoziiert ist | DocumentReference.context.encounter |
| Dokumentierter Vorgang | Handlungen oder Prozeduren, die im Kontext dokumentiert wurden | DocumentReference.context.event |
| Klinisches Fachgebiet zum Vorgang | Klinisches Fachgebiet, in dem Dokumenteninhalt erstellt wurde | DocumentReference.context.practiceSetting |
| Durchführungszeitraum zum Vorgang | Zeitraum, in dem die in dem Dokument beschriebene Handlung oder Prozedur durchgeführt wurde | DocumentReference.context.period |
| Art der Einrichtung zum Vorgang | Art der Einrichtung, in der die Handlung oder Prozedur am Patienten erfolgte | DocumentReference.context.facilityType |
Folgende Suchparameter sind für diese Modul relevant, auch in Kombination:
Der Suchparameter "_id" MUSS unterstützt werden:
Beispiele:
GET [base]/DocumentReference?_id=12345
Anwendungshinweise: Weitere Informationen zur Suche nach "_id" finden sich in der FHIR-Basisspezifikation - Abschnitt "Token Search".
Der Suchparameter "_profile" MUSS unterstützt werden:
Beispiele:
GET [base]/DocumentReference?_profile=https://www.medizininformatik-initiative.de/fhir/ext/modul-dokument/StructureDefinition/mii-pr-dokument-dokument
Anwendungshinweise: Weitere Informationen zur Suche nach "_profile" finden sich in der FHIR-Basisspezifikation - Abschnitt "URI Search".
Der Suchparameter "identifier" MUSS unterstützt werden:
Beispiele:
GET [base]/DocumentReference?identifier=urn:ietf:rfc:3986|urn:uuid:0c287d32-01e3-4d87-9953-9fcc9404eb21
Anwendungshinweise: Weitere Informationen zur Suche nach "identifier" finden sich in der FHIR-Basisspezifikation - Abschnitt "Token Search".
Der Suchparameter "status" MUSS unterstützt werden:
Beispiele:
GET [base]/DocumentReference?status=current
Anwendungshinweise: Weitere Informationen zur Suche nach "status" finden sich in der FHIR-Basisspezifikation - Abschnitt "Token Search".
Der Suchparameter "doc-status" MUSS unterstützt werden:
Beispiele:
GET [base]/DocumentReference?doc-status=final
Anwendungshinweise: Weitere Informationen zur Suche nach "doc-status" finden sich in der FHIR-Basisspezifikation - Abschnitt "Token Search".
Der Suchparameter "type" MUSS unterstützt werden:
Beispiele:
GET [base]/DocumentReference?type=http://dvmd.de/fhir/CodeSystem/kdl|AD010110
Anwendungshinweise: Weitere Informationen zur Suche nach "type" finden sich in der FHIR-Basisspezifikation - Abschnitt "Token Search".
Der Suchparameter "category" MUSS unterstützt werden:
Beispiele:
GET [base]/DocumentReference?category=http://ihe-d.de/CodeSystems/IHEXDSclassCode|BRI
Anwendungshinweise: Weitere Informationen zur Suche nach "category" finden sich in der FHIR-Basisspezifikation - Abschnitt "Token Search".
Der Suchparameter "patient" MUSS unterstützt werden:
Beispiele:
GET [base]/DocumentReference?patient=Patient/AmandaAlzheimer
Anwendungshinweise: Weitere Informationen zur Suche nach "patient" finden sich in der FHIR-Basisspezifikation - Abschnitt "Reference Search".
Der Suchparameter "relation" MUSS unterstützt werden:
Beispiele:
GET [base]/DocumentReference?relation=http://hl7.org/fhir/document-relationship-type|transforms
Anwendungshinweise: Weitere Informationen zur Suche nach "relation" finden sich in der FHIR-Basisspezifikation - Abschnitt "Token Search".
Der Suchparameter "relatesto" MUSS unterstützt werden:
Beispiele:
GET [base]/DocumentReference?relatesto=DocumentReference/AmandaAlzheimerOriginalDokument
Anwendungshinweise: Weitere Informationen zur Suche nach "relatesto" finden sich in der FHIR-Basisspezifikation - Abschnitt "Reference Search".
Der Suchparameter "relationship" MUSS unterstützt werden:
Beispiele:
GET [base]/DocumentReference?relationship=http://hl7.org/fhir/document-relationship-type|transforms$DocumentReference/AmandaAlzheimerOriginalDokument
Anwendungshinweise: Weitere Informationen zur Suche nach "relationship" finden sich in der FHIR-Basisspezifikation - Abschnitt "Composite Search".
Der Suchparameter "description" MUSS unterstützt werden:
Beispiele:
GET [base]/DocumentReference?description:contains=Bericht
Anwendungshinweise: Weitere Informationen zur Suche nach "description" finden sich in der FHIR-Basisspezifikation - Abschnitt "String Search".
Der Suchparameter "security-label" MUSS unterstützt werden:
Beispiele:
GET [base]/DocumentReference?security-label=http://terminology.hl7.org/CodeSystem/v3-Confidentiality|L
Anwendungshinweise: Weitere Informationen zur Suche nach "security-label" finden sich in der FHIR-Basisspezifikation - Abschnitt "Token Search".
Der Suchparameter "contenttype" MUSS unterstützt werden:
Beispiele:
GET [base]/DocumentReference?contenttype=urn:ietf:bcp:13|text/plain
Anwendungshinweise: Weitere Informationen zur Suche nach "contenttype" finden sich in der FHIR-Basisspezifikation - Abschnitt "Token Search".
Der Suchparameter "language" MUSS unterstützt werden:
Beispiele:
GET [base]/DocumentReference?language=urn:ietf:bcp:47|de-AT
Anwendungshinweise: Weitere Informationen zur Suche nach "language" finden sich in der FHIR-Basisspezifikation - Abschnitt "Token Search".
Der Suchparameter "location" MUSS unterstützt werden:
Beispiele:
GET [base]/DocumentReference?location=below:http://uk-musterstadt.de/document-management-system
Anwendungshinweise: Weitere Informationen zur Suche nach "location" finden sich in der FHIR-Basisspezifikation - Abschnitt "URI Search".
Der Suchparameter "creation" MUSS unterstützt werden:
Beispiele:
GET [base]/DocumentReference?creation=eq2025-06-23
Anwendungshinweise: Weitere Informationen zur Suche nach "creation" finden sich in der FHIR-Basisspezifikation - Abschnitt "Date Search".
Der Suchparameter "format" MUSS unterstützt werden:
Beispiele:
GET [base]/DocumentReference?format=http://ihe.net/fhir/ihe.formatcode.fhir/CodeSystem/formatcode|urn:ihe:iti:xds:2017:mimeTypeSufficient
Anwendungshinweise: Weitere Informationen zur Suche nach "format" finden sich in der FHIR-Basisspezifikation - Abschnitt "Token Search".
Der Suchparameter "encounter" MUSS unterstützt werden:
Beispiele:
GET [base]/DocumentReference?encounter=Encounter/AmandaAlzheimerEinrichtungskontakt
Anwendungshinweise: Weitere Informationen zur Suche nach "encounter" finden sich in der FHIR-Basisspezifikation - Abschnitt "Reference Search".
Der Suchparameter "event" MUSS unterstützt werden:
Beispiele:
GET [base]/DocumentReference?event=http://ihe-d.de/CodeSystems/FallkontextBeiDokumentenerstellung|E234
Anwendungshinweise: Weitere Informationen zur Suche nach "event" finden sich in der FHIR-Basisspezifikation - Abschnitt "Token Search".
Der Suchparameter "period" MUSS unterstützt werden:
Beispiele:
GET [base]/DocumentReference?period=ge2028-01-24&period=le2028-02-06
Anwendungshinweise: Weitere Informationen zur Suche nach "period" finden sich in der FHIR-Basisspezifikation - Abschnitt "Date Search".
Der Suchparameter "facility" MUSS unterstützt werden:
Beispiele:
GET [base]/DocumentReference?facility=http://ihe-d.de/CodeSystems/PatientBezogenenGesundheitsversorgung|KHS
Anwendungshinweise: Weitere Informationen zur Suche nach "facility" finden sich in der FHIR-Basisspezifikation - Abschnitt "Token Search".
Der Suchparameter "setting" MUSS unterstützt werden:
Beispiele:
GET [base]/DocumentReference?setting=http://ihe-d.de/CodeSystems/AerztlicheFachrichtungen|INTZ
Anwendungshinweise: Weitere Informationen zur Suche nach "setting" finden sich in der FHIR-Basisspezifikation - Abschnitt "Token Search".
Der Suchparameter "nlp-processing-status" MUSS unterstützt werden:
Beispiele:
GET [base]/DocumentReference?nlp-processing-status=https://www.medizininformatik-initiative.de/fhir/ext/modul-dokument/CodeSystem/mii-cs-dokument-nlp-processing-status|unprocessed
Anwendungshinweise: Weitere Informationen zur Suche nach "nlp-processing-status" finden sich in der FHIR-Basisspezifikation - Abschnitt "Token Search".
Umfangreiche Beispiele, die das Profil und die Erweiterung gemeinsam veranschaulichen, sind auf Seite der Erweiterung zu finden (NLP Processing Status: Extension).