Implementation Guide
ePA MHD Service
Version 1.1.0 - release

Resource Profile: EPA MHD DocumentReference

Official URL: https://gematik.de/fhir/epa-mhd/StructureDefinition/epa-mhd-document-reference Version: 1.1.0
Active as of 2025-12-15 Computable Name: EPAMHDDocumentReference

Copyright/Legal: gematik GmbH / Dieses Artefakt ist lizenziert unter Apache License, Version 2.0.

Dieses Profil erweitert die IHE MHD Minimal DocumentReference-Ressource mit ePA 3.0 Metadaten-Einschränkungen.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentReference 0..* MinimalDocumentReference A reference to a document
Constraints: dom-2, dom-3, dom-4, dom-5, dom-6
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..0 Extensions that cannot be ignored
Slice: Unordered, Open by value:url
... masterIdentifier Σ 1..1 UniqueIdIdentifier An identifier intended for computation
.... identifier:entryUUID SΣ 0..* EntryUUIDIdentifier An identifier intended for computation
... status ?!SΣ 1..1 code Status des Dokuments
Binding: MHD DocumentReference status codes (required): The status of the document reference.
... type SΣ 1..1 CodeableConcept Art des Dokuments
Binding: DocumentTypeValueSet (preferred): Precise type of clinical document.
.... coding SΣ 0..* Coding Code defined by a terminology system
Binding: IHE XDS Type Code ValueSet für ePA (required)
..... system SΣ 1..1 uri Identity of the terminology system
..... code SΣ 1..1 code Symbol in syntax defined by the system
..... display SΣ 1..1 string Representation defined by the system
... category SΣ 1..1 CodeableConcept Grobe Klassifizierung des Dokuments
Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.
.... coding SΣ 0..* Coding Code defined by a terminology system
Binding: IHE XDS Class Code ValueSet für ePA (required)
..... system SΣ 1..1 uri Identity of the terminology system
..... code SΣ 1..1 code Symbol in syntax defined by the system
..... display SΣ 1..1 string Representation defined by the system
... subject SΣC 1..1 Reference(Patient) Systemweit eindeutige Kennung des Patienten
Constraints: ref-1
.... identifier SΣ 1..1 IdentifierKvid10 Logical reference, when literal reference is not known
... date SΣ 0..1 instant Das Erzeugungsdatum wird in content.attachment.creation abgebildet.
... author SΣC 0..* Reference(Patient | Practitioner | Organization) Person oder System, welche(s) das Dokument erstellt hat
Constraints: ref-1
.... identifier SΣ 0..1 IdentifierKvid10, IdentifierTelematikId, IdentifierLanr, IdentifierZanr Logical reference, when literal reference is not known
.... display SΣ 1..1 string Text alternative for the resource
... authenticator SC 0..1 Reference(Practitioner | Organization) Rechtlich Verantwortlicher für das Dokument
Constraints: ref-1
.... identifier SΣ 1..1 IdentifierTelematikId Logical reference, when literal reference is not known
... relatesTo SΣ 0..* BackboneElement Relationships to other documents
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code Σ 1..1 code replaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.
.... target ΣC 1..1 Reference(DocumentReference) Target of the relationship
Constraints: ref-1
... description SΣ 0..1 string Ergänzende Hinweise in Freitext
... securityLabel SΣ 0..* CodeableConcept Vertraulichkeitskennzeichnung und Datenkategorie des Dokuments
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... coding SΣ 0..* Coding Code defined by a terminology system
Binding: MHD Security Label Value Set for ePA (required)
..... system SΣ 1..1 uri Identity of the terminology system
..... code SΣ 1..1 code Symbol in syntax defined by the system
..... display SΣ 1..1 string Representation defined by the system
... content Σ 1..1 BackboneElement Document referenced
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... attachment ΣC 1..1 Attachment Where to access the document
Constraints: att-1
..... contentType SΣ 1..1 code Mime type of the content, with charset etc.
Binding: IHE XDS MIME Type ValueSet for ePA (required)
Example General: text/plain; charset=UTF-8, image/png
..... language SΣ 1..1 code Sprache, in der das Dokument abgefasst ist
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding

Example General: en-AU
..... url SΣ 1..1 url URI für das Dokument
Example General: http://www.acme.com/logo-small.png
..... size SΣ 0..1 unsignedInt Größe des Dokuments in Bytes
..... hash SΣ 0..1 base64Binary Kryptographische Prüfsumme des Dokuments
..... title SΣ 1..1 string Titel des Dokuments
Example General: Official Corporate Logo
..... creation SΣ 1..1 dateTime Erstellungszeitpunkt des Dokuments
.... format SΣ 1..1 Coding Global eindeutiger Code für das Dokumentenformat
Binding: IHE XDS Format Code ValueSet für ePA (required)
... context Σ 0..1 BackboneElement Clinical context of document
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... event S 0..* CodeableConcept Ereignisse, die zur Erstellung des Dokuments geführt haben
Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented.
..... coding SΣ 0..* Coding Code defined by a terminology system
Binding: IHE XDS Event Code ValueSet für ePA (required)
...... system SΣ 1..1 uri Identity of the terminology system
...... code SΣ 1..1 code Symbol in syntax defined by the system
...... display SΣ 1..1 string Representation defined by the system
.... period SΣC 0..1 Period Time of service that is being documented
Constraints: per-1
..... start SΣC 0..1 dateTime Zeitpunkt, an dem das im Dokument dokumentierte (Behandlungs-)Ereignis begonnen wurde
..... end SΣC 0..1 dateTime Zeitpunkt, an dem das im Dokument dokumentierte (Behandlungs-)Ereignis beendet wurde
.... facilityType S 1..1 CodeableConcept Art der Einrichtung, in der das dokumentierte Ereignis stattgefunden hat
Binding: FacilityTypeCodeValueSet (example): XDS Facility Type.
..... coding SΣ 0..* Coding Code defined by a terminology system
Binding: IHE XDS Healthcare Facility Type Code ValueSet für ePA (required)
...... system SΣ 1..1 uri Identity of the terminology system
...... code SΣ 1..1 code Symbol in syntax defined by the system
...... display SΣ 1..1 string Representation defined by the system
.... practiceSetting S 0..1 CodeableConcept Art der Fachrichtung der erstellenden Einrichtung, in der das dokumentiere Ereignis stattgefunden hat
Binding: PracticeSettingCodeValueSet (example): Additional details about where the content was created (e.g. clinical specialty).
..... coding SΣ 0..* Coding Code defined by a terminology system
Binding: IHE XDS Practice Setting Code ValueSet für ePA (required)
...... system SΣ 1..1 uri Identity of the terminology system
...... code SΣ 1..1 code Symbol in syntax defined by the system
...... display SΣ 1..1 string Representation defined by the system
.... sourcePatientInfo SC 0..1 Reference(Patient) Patient demographics from source
Constraints: ref-1
..... reference SΣC 0..1 string Demographische Daten zum Patienten im Quellsystem
..... identifier SΣ 0..1 Identifier Kennung des Patienten im Quellsystem
.... related SC 0..* Reference(Resource) Liste von IDs, mit denen das Dokument assoziiert wird
Constraints: ref-1

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DocumentReference.status Base required MHD DocumentReference status codes 📦4.2.3 Mobile access to Health Documents v4.2
DocumentReference.type Base preferred Document Type Value Set 📦4.0.1 FHIR Std.
DocumentReference.type.​coding Base required IHE XDS Type Code ValueSet für ePA 📦1.0.7 TI Terminology v1.0
DocumentReference.category Base example Document Class Value Set 📦4.0.1 FHIR Std.
DocumentReference.category.​coding Base required IHE XDS Class Code ValueSet für ePA 📦1.0.7 TI Terminology v1.0
DocumentReference.relatesTo.​code Base required DocumentRelationshipType 📍4.0.1 FHIR Std.
DocumentReference.securityLabel Base extensible SecurityLabels 📦4.0.1 FHIR Std.
DocumentReference.securityLabel.​coding Base required MHD Security Label Value Set for ePA 📦1.0.7 TI Terminology v1.0
DocumentReference.content.​attachment.contentType Base required IHE XDS MIME Type ValueSet for ePA 📦1.0.7 TI Terminology v1.0
DocumentReference.content.​attachment.language Base preferred Common Languages 📦4.0.1 FHIR Std.
DocumentReference.content.​format Base required IHE XDS Format Code ValueSet für ePA 📦1.0.7 TI Terminology v1.0
DocumentReference.context.​event Base example v3 Code System ActCode 📦3.0.0 THO v7.0
DocumentReference.context.​event.coding Base required IHE XDS Event Code ValueSet für ePA 📦1.0.8 TI Terminology v1.0
DocumentReference.context.​facilityType Base example Facility Type Code Value Set 📦4.0.1 FHIR Std.
DocumentReference.context.​facilityType.coding Base required IHE XDS Healthcare Facility Type Code ValueSet für ePA 📦1.0.7 TI Terminology v1.0
DocumentReference.context.​practiceSetting Base example Practice Setting Code Value Set 📦4.0.1 FHIR Std.
DocumentReference.context.​practiceSetting.coding Base required IHE XDS Practice Setting Code ValueSet für ePA 📦1.0.8 TI Terminology v1.0

Constraints

Id Grade Path(s) Description Expression
att-1 error DocumentReference.content.attachment If the Attachment has data, it SHALL have a contentType data.empty() or contentType.exists()
dom-2 error DocumentReference If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error DocumentReference If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error DocumentReference If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error DocumentReference If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice DocumentReference A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
per-1 error DocumentReference.context.period If present, start SHALL have a lower value than end start.hasValue().not() or end.hasValue().not() or (start <= end)
ref-1 error DocumentReference.subject, DocumentReference.author, DocumentReference.authenticator, DocumentReference.relatesTo.target, DocumentReference.context.sourcePatientInfo, DocumentReference.context.related SHALL have a contained resource if a local reference is provided reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

This structure is derived from MinimalDocumentReference

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentReference 0..* MinimalDocumentReference A reference to a document
... meta
.... profile 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
... masterIdentifier 1..1 UniqueIdIdentifier An identifier intended for computation
... identifier 0..* Identifier Other identifiers for the document
... docStatus 0..0 code n/a
... type 1..1 CodeableConcept Art des Dokuments
.... coding S 0..* Coding Code defined by a terminology system
Binding: IHE XDS Type Code ValueSet für ePA (required)
..... system S 1..1 uri Identity of the terminology system
..... code S 1..1 code Symbol in syntax defined by the system
..... display S 1..1 string Representation defined by the system
... category 1..1 CodeableConcept Grobe Klassifizierung des Dokuments
.... coding S 0..* Coding Code defined by a terminology system
Binding: IHE XDS Class Code ValueSet für ePA (required)
..... system S 1..1 uri Identity of the terminology system
..... code S 1..1 code Symbol in syntax defined by the system
..... display S 1..1 string Representation defined by the system
... subject 1..1 Reference(Patient) Systemweit eindeutige Kennung des Patienten
.... identifier S 1..1 IdentifierKvid10 Logical reference, when literal reference is not known
... date 0..1 instant Das Erzeugungsdatum wird in content.attachment.creation abgebildet.
... author 0..* Reference(Patient | Practitioner | Organization) Person oder System, welche(s) das Dokument erstellt hat
.... identifier S 0..1 IdentifierKvid10, IdentifierTelematikId, IdentifierLanr, IdentifierZanr Logical reference, when literal reference is not known
.... display S 1..1 string Text alternative for the resource
... authenticator S 0..1 Reference(Practitioner | Organization) Rechtlich Verantwortlicher für das Dokument
.... identifier S 1..1 IdentifierTelematikId Logical reference, when literal reference is not known
... custodian 0..0 n/a
... relatesTo 0..* BackboneElement Relationships to other documents
... description S 0..1 string Ergänzende Hinweise in Freitext
... securityLabel 0..* CodeableConcept Vertraulichkeitskennzeichnung und Datenkategorie des Dokuments
.... coding S 0..* Coding Code defined by a terminology system
Binding: MHD Security Label Value Set for ePA (required)
..... system S 1..1 uri Identity of the terminology system
..... code S 1..1 code Symbol in syntax defined by the system
..... display S 1..1 string Representation defined by the system
... content
.... attachment
..... contentType S 1..1 code Mime type of the content, with charset etc.
Binding: IHE XDS MIME Type ValueSet for ePA (required)
..... language 1..1 code Sprache, in der das Dokument abgefasst ist
..... url S 1..1 url URI für das Dokument
..... size S 0..1 unsignedInt Größe des Dokuments in Bytes
..... hash S 0..1 base64Binary Kryptographische Prüfsumme des Dokuments
..... title S 1..1 string Titel des Dokuments
..... creation 1..1 dateTime Erstellungszeitpunkt des Dokuments
.... format 1..1 Coding Global eindeutiger Code für das Dokumentenformat
Binding: IHE XDS Format Code ValueSet für ePA (required)
... context
.... encounter 0..0 Context of the document content
.... event S 0..* CodeableConcept Ereignisse, die zur Erstellung des Dokuments geführt haben
..... coding S 0..* Coding Code defined by a terminology system
Binding: IHE XDS Event Code ValueSet für ePA (required)
...... system S 1..1 uri Identity of the terminology system
...... code S 1..1 code Symbol in syntax defined by the system
...... display S 1..1 string Representation defined by the system
.... period
..... start S 0..1 dateTime Zeitpunkt, an dem das im Dokument dokumentierte (Behandlungs-)Ereignis begonnen wurde
..... end S 0..1 dateTime Zeitpunkt, an dem das im Dokument dokumentierte (Behandlungs-)Ereignis beendet wurde
.... facilityType 1..1 CodeableConcept Art der Einrichtung, in der das dokumentierte Ereignis stattgefunden hat
..... coding S 0..* Coding Code defined by a terminology system
Binding: IHE XDS Healthcare Facility Type Code ValueSet für ePA (required)
...... system S 1..1 uri Identity of the terminology system
...... code S 1..1 code Symbol in syntax defined by the system
...... display S 1..1 string Representation defined by the system
.... practiceSetting 0..1 CodeableConcept Art der Fachrichtung der erstellenden Einrichtung, in der das dokumentiere Ereignis stattgefunden hat
..... coding S 0..* Coding Code defined by a terminology system
Binding: IHE XDS Practice Setting Code ValueSet für ePA (required)
...... system S 1..1 uri Identity of the terminology system
...... code S 1..1 code Symbol in syntax defined by the system
...... display S 1..1 string Representation defined by the system
.... sourcePatientInfo
..... reference S 0..1 string Demographische Daten zum Patienten im Quellsystem
..... identifier S 0..1 Identifier Kennung des Patienten im Quellsystem
.... related S 0..* Reference(Resource) Liste von IDs, mit denen das Dokument assoziiert wird

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
DocumentReference.type.​coding Base required IHE XDS Type Code ValueSet für ePA 📦1.0.7 TI Terminology v1.0
DocumentReference.category.​coding Base required IHE XDS Class Code ValueSet für ePA 📦1.0.7 TI Terminology v1.0
DocumentReference.securityLabel.​coding Base required MHD Security Label Value Set for ePA 📦1.0.7 TI Terminology v1.0
DocumentReference.content.​attachment.contentType Base required IHE XDS MIME Type ValueSet for ePA 📦1.0.7 TI Terminology v1.0
DocumentReference.content.​format Base required IHE XDS Format Code ValueSet für ePA 📦1.0.7 TI Terminology v1.0
DocumentReference.context.​event.coding Base required IHE XDS Event Code ValueSet für ePA 📦1.0.8 TI Terminology v1.0
DocumentReference.context.​facilityType.coding Base required IHE XDS Healthcare Facility Type Code ValueSet für ePA 📦1.0.7 TI Terminology v1.0
DocumentReference.context.​practiceSetting.coding Base required IHE XDS Practice Setting Code ValueSet für ePA 📦1.0.8 TI Terminology v1.0
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentReference 0..* MinimalDocumentReference A reference to a document
Constraints: dom-2, dom-3, dom-4, dom-5, dom-6
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
... modifierExtension ?! 0..0 Extensions that cannot be ignored
Slice: Unordered, Open by value:url
... masterIdentifier Σ 1..1 UniqueIdIdentifier An identifier intended for computation
... Slices for identifier SΣ 0..* Identifier Other identifiers for the document
Slice: Unordered, Open by value:use
.... identifier:entryUUID SΣ 0..* EntryUUIDIdentifier An identifier intended for computation
... status ?!SΣ 1..1 code Status des Dokuments
Binding: MHD DocumentReference status codes (required): The status of the document reference.
... type SΣ 1..1 CodeableConcept Art des Dokuments
Binding: DocumentTypeValueSet (preferred): Precise type of clinical document.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding SΣ 0..* Coding Code defined by a terminology system
Binding: IHE XDS Type Code ValueSet für ePA (required)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣ 1..1 uri Identity of the terminology system
..... version Σ 0..1 string Version of the system - if relevant
..... code SΣ 1..1 code Symbol in syntax defined by the system
..... display SΣ 1..1 string Representation defined by the system
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... category SΣ 1..1 CodeableConcept Grobe Klassifizierung des Dokuments
Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding SΣ 0..* Coding Code defined by a terminology system
Binding: IHE XDS Class Code ValueSet für ePA (required)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣ 1..1 uri Identity of the terminology system
..... version Σ 0..1 string Version of the system - if relevant
..... code SΣ 1..1 code Symbol in syntax defined by the system
..... display SΣ 1..1 string Representation defined by the system
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... subject SΣC 1..1 Reference(Patient) Systemweit eindeutige Kennung des Patienten
Constraints: ref-1
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier SΣ 1..1 IdentifierKvid10 Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... date SΣ 0..1 instant Das Erzeugungsdatum wird in content.attachment.creation abgebildet.
... author SΣC 0..* Reference(Patient | Practitioner | Organization) Person oder System, welche(s) das Dokument erstellt hat
Constraints: ref-1
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier SΣ 0..1 IdentifierKvid10, IdentifierTelematikId, IdentifierLanr, IdentifierZanr Logical reference, when literal reference is not known
.... display SΣ 1..1 string Text alternative for the resource
... authenticator SC 0..1 Reference(Practitioner | Organization) Rechtlich Verantwortlicher für das Dokument
Constraints: ref-1
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier SΣ 1..1 IdentifierTelematikId Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... relatesTo SΣ 0..* BackboneElement Relationships to other documents
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code Σ 1..1 code replaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.
.... target ΣC 1..1 Reference(DocumentReference) Target of the relationship
Constraints: ref-1
... description SΣ 0..1 string Ergänzende Hinweise in Freitext
... securityLabel SΣ 0..* CodeableConcept Vertraulichkeitskennzeichnung und Datenkategorie des Dokuments
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding SΣ 0..* Coding Code defined by a terminology system
Binding: MHD Security Label Value Set for ePA (required)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣ 1..1 uri Identity of the terminology system
..... version Σ 0..1 string Version of the system - if relevant
..... code SΣ 1..1 code Symbol in syntax defined by the system
..... display SΣ 1..1 string Representation defined by the system
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... content Σ 1..1 BackboneElement Document referenced
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... attachment ΣC 1..1 Attachment Where to access the document
Constraints: att-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... contentType SΣ 1..1 code Mime type of the content, with charset etc.
Binding: IHE XDS MIME Type ValueSet for ePA (required)
Example General: text/plain; charset=UTF-8, image/png
..... language SΣ 1..1 code Sprache, in der das Dokument abgefasst ist
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding

Example General: en-AU
..... url SΣ 1..1 url URI für das Dokument
Example General: http://www.acme.com/logo-small.png
..... size SΣ 0..1 unsignedInt Größe des Dokuments in Bytes
..... hash SΣ 0..1 base64Binary Kryptographische Prüfsumme des Dokuments
..... title SΣ 1..1 string Titel des Dokuments
Example General: Official Corporate Logo
..... creation SΣ 1..1 dateTime Erstellungszeitpunkt des Dokuments
.... format SΣ 1..1 Coding Global eindeutiger Code für das Dokumentenformat
Binding: IHE XDS Format Code ValueSet für ePA (required)
... context Σ 0..1 BackboneElement Clinical context of document
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... event S 0..* CodeableConcept Ereignisse, die zur Erstellung des Dokuments geführt haben
Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented.
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding SΣ 0..* Coding Code defined by a terminology system
Binding: IHE XDS Event Code ValueSet für ePA (required)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣ 1..1 uri Identity of the terminology system
...... version Σ 0..1 string Version of the system - if relevant
...... code SΣ 1..1 code Symbol in syntax defined by the system
...... display SΣ 1..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... text Σ 0..1 string Plain text representation of the concept
.... period SΣC 0..1 Period Time of service that is being documented
Constraints: per-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... start SΣC 0..1 dateTime Zeitpunkt, an dem das im Dokument dokumentierte (Behandlungs-)Ereignis begonnen wurde
..... end SΣC 0..1 dateTime Zeitpunkt, an dem das im Dokument dokumentierte (Behandlungs-)Ereignis beendet wurde
.... facilityType S 1..1 CodeableConcept Art der Einrichtung, in der das dokumentierte Ereignis stattgefunden hat
Binding: FacilityTypeCodeValueSet (example): XDS Facility Type.
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding SΣ 0..* Coding Code defined by a terminology system
Binding: IHE XDS Healthcare Facility Type Code ValueSet für ePA (required)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣ 1..1 uri Identity of the terminology system
...... version Σ 0..1 string Version of the system - if relevant
...... code SΣ 1..1 code Symbol in syntax defined by the system
...... display SΣ 1..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... text Σ 0..1 string Plain text representation of the concept
.... practiceSetting S 0..1 CodeableConcept Art der Fachrichtung der erstellenden Einrichtung, in der das dokumentiere Ereignis stattgefunden hat
Binding: PracticeSettingCodeValueSet (example): Additional details about where the content was created (e.g. clinical specialty).
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding SΣ 0..* Coding Code defined by a terminology system
Binding: IHE XDS Practice Setting Code ValueSet für ePA (required)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣ 1..1 uri Identity of the terminology system
...... version Σ 0..1 string Version of the system - if relevant
...... code SΣ 1..1 code Symbol in syntax defined by the system
...... display SΣ 1..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... text Σ 0..1 string Plain text representation of the concept
.... sourcePatientInfo SC 0..1 Reference(Patient) Patient demographics from source
Constraints: ref-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... reference SΣC 0..1 string Demographische Daten zum Patienten im Quellsystem
..... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
..... identifier SΣ 0..1 Identifier Kennung des Patienten im Quellsystem
..... display Σ 0..1 string Text alternative for the resource
.... related SC 0..* Reference(Resource) Liste von IDs, mit denen das Dokument assoziiert wird
Constraints: ref-1

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DocumentReference.meta.​security Base extensible SecurityLabels 📦4.0.1 FHIR Std.
DocumentReference.meta.​tag Base example Common Tags 📦4.0.1 FHIR Std.
DocumentReference.language Base preferred Common Languages 📦4.0.1 FHIR Std.
DocumentReference.status Base required MHD DocumentReference status codes 📦4.2.3 Mobile access to Health Documents v4.2
DocumentReference.type Base preferred Document Type Value Set 📦4.0.1 FHIR Std.
DocumentReference.type.​coding Base required IHE XDS Type Code ValueSet für ePA 📦1.0.7 TI Terminology v1.0
DocumentReference.category Base example Document Class Value Set 📦4.0.1 FHIR Std.
DocumentReference.category.​coding Base required IHE XDS Class Code ValueSet für ePA 📦1.0.7 TI Terminology v1.0
DocumentReference.subject.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
DocumentReference.author.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
DocumentReference.authenticator.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
DocumentReference.relatesTo.​code Base required DocumentRelationshipType 📍4.0.1 FHIR Std.
DocumentReference.securityLabel Base extensible SecurityLabels 📦4.0.1 FHIR Std.
DocumentReference.securityLabel.​coding Base required MHD Security Label Value Set for ePA 📦1.0.7 TI Terminology v1.0
DocumentReference.content.​attachment.contentType Base required IHE XDS MIME Type ValueSet for ePA 📦1.0.7 TI Terminology v1.0
DocumentReference.content.​attachment.language Base preferred Common Languages 📦4.0.1 FHIR Std.
DocumentReference.content.​format Base required IHE XDS Format Code ValueSet für ePA 📦1.0.7 TI Terminology v1.0
DocumentReference.context.​event Base example v3 Code System ActCode 📦3.0.0 THO v7.0
DocumentReference.context.​event.coding Base required IHE XDS Event Code ValueSet für ePA 📦1.0.8 TI Terminology v1.0
DocumentReference.context.​facilityType Base example Facility Type Code Value Set 📦4.0.1 FHIR Std.
DocumentReference.context.​facilityType.coding Base required IHE XDS Healthcare Facility Type Code ValueSet für ePA 📦1.0.7 TI Terminology v1.0
DocumentReference.context.​practiceSetting Base example Practice Setting Code Value Set 📦4.0.1 FHIR Std.
DocumentReference.context.​practiceSetting.coding Base required IHE XDS Practice Setting Code ValueSet für ePA 📦1.0.8 TI Terminology v1.0
DocumentReference.context.​sourcePatientInfo.type Base extensible ResourceType 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
att-1 error DocumentReference.content.attachment If the Attachment has data, it SHALL have a contentType data.empty() or contentType.exists()
dom-2 error DocumentReference If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error DocumentReference If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error DocumentReference If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error DocumentReference If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice DocumentReference A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
per-1 error DocumentReference.context.period If present, start SHALL have a lower value than end start.hasValue().not() or end.hasValue().not() or (start <= end)
ref-1 error DocumentReference.subject, DocumentReference.author, DocumentReference.authenticator, DocumentReference.relatesTo.target, DocumentReference.context.sourcePatientInfo, DocumentReference.context.related SHALL have a contained resource if a local reference is provided reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentReference 0..* MinimalDocumentReference A reference to a document
Constraints: dom-2, dom-3, dom-4, dom-5, dom-6
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..0 Extensions that cannot be ignored
Slice: Unordered, Open by value:url
... masterIdentifier Σ 1..1 UniqueIdIdentifier An identifier intended for computation
.... identifier:entryUUID SΣ 0..* EntryUUIDIdentifier An identifier intended for computation
... status ?!SΣ 1..1 code Status des Dokuments
Binding: MHD DocumentReference status codes (required): The status of the document reference.
... type SΣ 1..1 CodeableConcept Art des Dokuments
Binding: DocumentTypeValueSet (preferred): Precise type of clinical document.
.... coding SΣ 0..* Coding Code defined by a terminology system
Binding: IHE XDS Type Code ValueSet für ePA (required)
..... system SΣ 1..1 uri Identity of the terminology system
..... code SΣ 1..1 code Symbol in syntax defined by the system
..... display SΣ 1..1 string Representation defined by the system
... category SΣ 1..1 CodeableConcept Grobe Klassifizierung des Dokuments
Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.
.... coding SΣ 0..* Coding Code defined by a terminology system
Binding: IHE XDS Class Code ValueSet für ePA (required)
..... system SΣ 1..1 uri Identity of the terminology system
..... code SΣ 1..1 code Symbol in syntax defined by the system
..... display SΣ 1..1 string Representation defined by the system
... subject SΣC 1..1 Reference(Patient) Systemweit eindeutige Kennung des Patienten
Constraints: ref-1
.... identifier SΣ 1..1 IdentifierKvid10 Logical reference, when literal reference is not known
... date SΣ 0..1 instant Das Erzeugungsdatum wird in content.attachment.creation abgebildet.
... author SΣC 0..* Reference(Patient | Practitioner | Organization) Person oder System, welche(s) das Dokument erstellt hat
Constraints: ref-1
.... identifier SΣ 0..1 IdentifierKvid10, IdentifierTelematikId, IdentifierLanr, IdentifierZanr Logical reference, when literal reference is not known
.... display SΣ 1..1 string Text alternative for the resource
... authenticator SC 0..1 Reference(Practitioner | Organization) Rechtlich Verantwortlicher für das Dokument
Constraints: ref-1
.... identifier SΣ 1..1 IdentifierTelematikId Logical reference, when literal reference is not known
... relatesTo SΣ 0..* BackboneElement Relationships to other documents
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code Σ 1..1 code replaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.
.... target ΣC 1..1 Reference(DocumentReference) Target of the relationship
Constraints: ref-1
... description SΣ 0..1 string Ergänzende Hinweise in Freitext
... securityLabel SΣ 0..* CodeableConcept Vertraulichkeitskennzeichnung und Datenkategorie des Dokuments
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... coding SΣ 0..* Coding Code defined by a terminology system
Binding: MHD Security Label Value Set for ePA (required)
..... system SΣ 1..1 uri Identity of the terminology system
..... code SΣ 1..1 code Symbol in syntax defined by the system
..... display SΣ 1..1 string Representation defined by the system
... content Σ 1..1 BackboneElement Document referenced
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... attachment ΣC 1..1 Attachment Where to access the document
Constraints: att-1
..... contentType SΣ 1..1 code Mime type of the content, with charset etc.
Binding: IHE XDS MIME Type ValueSet for ePA (required)
Example General: text/plain; charset=UTF-8, image/png
..... language SΣ 1..1 code Sprache, in der das Dokument abgefasst ist
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding

Example General: en-AU
..... url SΣ 1..1 url URI für das Dokument
Example General: http://www.acme.com/logo-small.png
..... size SΣ 0..1 unsignedInt Größe des Dokuments in Bytes
..... hash SΣ 0..1 base64Binary Kryptographische Prüfsumme des Dokuments
..... title SΣ 1..1 string Titel des Dokuments
Example General: Official Corporate Logo
..... creation SΣ 1..1 dateTime Erstellungszeitpunkt des Dokuments
.... format SΣ 1..1 Coding Global eindeutiger Code für das Dokumentenformat
Binding: IHE XDS Format Code ValueSet für ePA (required)
... context Σ 0..1 BackboneElement Clinical context of document
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... event S 0..* CodeableConcept Ereignisse, die zur Erstellung des Dokuments geführt haben
Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented.
..... coding SΣ 0..* Coding Code defined by a terminology system
Binding: IHE XDS Event Code ValueSet für ePA (required)
...... system SΣ 1..1 uri Identity of the terminology system
...... code SΣ 1..1 code Symbol in syntax defined by the system
...... display SΣ 1..1 string Representation defined by the system
.... period SΣC 0..1 Period Time of service that is being documented
Constraints: per-1
..... start SΣC 0..1 dateTime Zeitpunkt, an dem das im Dokument dokumentierte (Behandlungs-)Ereignis begonnen wurde
..... end SΣC 0..1 dateTime Zeitpunkt, an dem das im Dokument dokumentierte (Behandlungs-)Ereignis beendet wurde
.... facilityType S 1..1 CodeableConcept Art der Einrichtung, in der das dokumentierte Ereignis stattgefunden hat
Binding: FacilityTypeCodeValueSet (example): XDS Facility Type.
..... coding SΣ 0..* Coding Code defined by a terminology system
Binding: IHE XDS Healthcare Facility Type Code ValueSet für ePA (required)
...... system SΣ 1..1 uri Identity of the terminology system
...... code SΣ 1..1 code Symbol in syntax defined by the system
...... display SΣ 1..1 string Representation defined by the system
.... practiceSetting S 0..1 CodeableConcept Art der Fachrichtung der erstellenden Einrichtung, in der das dokumentiere Ereignis stattgefunden hat
Binding: PracticeSettingCodeValueSet (example): Additional details about where the content was created (e.g. clinical specialty).
..... coding SΣ 0..* Coding Code defined by a terminology system
Binding: IHE XDS Practice Setting Code ValueSet für ePA (required)
...... system SΣ 1..1 uri Identity of the terminology system
...... code SΣ 1..1 code Symbol in syntax defined by the system
...... display SΣ 1..1 string Representation defined by the system
.... sourcePatientInfo SC 0..1 Reference(Patient) Patient demographics from source
Constraints: ref-1
..... reference SΣC 0..1 string Demographische Daten zum Patienten im Quellsystem
..... identifier SΣ 0..1 Identifier Kennung des Patienten im Quellsystem
.... related SC 0..* Reference(Resource) Liste von IDs, mit denen das Dokument assoziiert wird
Constraints: ref-1

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DocumentReference.status Base required MHD DocumentReference status codes 📦4.2.3 Mobile access to Health Documents v4.2
DocumentReference.type Base preferred Document Type Value Set 📦4.0.1 FHIR Std.
DocumentReference.type.​coding Base required IHE XDS Type Code ValueSet für ePA 📦1.0.7 TI Terminology v1.0
DocumentReference.category Base example Document Class Value Set 📦4.0.1 FHIR Std.
DocumentReference.category.​coding Base required IHE XDS Class Code ValueSet für ePA 📦1.0.7 TI Terminology v1.0
DocumentReference.relatesTo.​code Base required DocumentRelationshipType 📍4.0.1 FHIR Std.
DocumentReference.securityLabel Base extensible SecurityLabels 📦4.0.1 FHIR Std.
DocumentReference.securityLabel.​coding Base required MHD Security Label Value Set for ePA 📦1.0.7 TI Terminology v1.0
DocumentReference.content.​attachment.contentType Base required IHE XDS MIME Type ValueSet for ePA 📦1.0.7 TI Terminology v1.0
DocumentReference.content.​attachment.language Base preferred Common Languages 📦4.0.1 FHIR Std.
DocumentReference.content.​format Base required IHE XDS Format Code ValueSet für ePA 📦1.0.7 TI Terminology v1.0
DocumentReference.context.​event Base example v3 Code System ActCode 📦3.0.0 THO v7.0
DocumentReference.context.​event.coding Base required IHE XDS Event Code ValueSet für ePA 📦1.0.8 TI Terminology v1.0
DocumentReference.context.​facilityType Base example Facility Type Code Value Set 📦4.0.1 FHIR Std.
DocumentReference.context.​facilityType.coding Base required IHE XDS Healthcare Facility Type Code ValueSet für ePA 📦1.0.7 TI Terminology v1.0
DocumentReference.context.​practiceSetting Base example Practice Setting Code Value Set 📦4.0.1 FHIR Std.
DocumentReference.context.​practiceSetting.coding Base required IHE XDS Practice Setting Code ValueSet für ePA 📦1.0.8 TI Terminology v1.0

Constraints

Id Grade Path(s) Description Expression
att-1 error DocumentReference.content.attachment If the Attachment has data, it SHALL have a contentType data.empty() or contentType.exists()
dom-2 error DocumentReference If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error DocumentReference If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error DocumentReference If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error DocumentReference If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice DocumentReference A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
per-1 error DocumentReference.context.period If present, start SHALL have a lower value than end start.hasValue().not() or end.hasValue().not() or (start <= end)
ref-1 error DocumentReference.subject, DocumentReference.author, DocumentReference.authenticator, DocumentReference.relatesTo.target, DocumentReference.context.sourcePatientInfo, DocumentReference.context.related SHALL have a contained resource if a local reference is provided reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Differential View

This structure is derived from MinimalDocumentReference

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentReference 0..* MinimalDocumentReference A reference to a document
... meta
.... profile 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
... masterIdentifier 1..1 UniqueIdIdentifier An identifier intended for computation
... identifier 0..* Identifier Other identifiers for the document
... docStatus 0..0 code n/a
... type 1..1 CodeableConcept Art des Dokuments
.... coding S 0..* Coding Code defined by a terminology system
Binding: IHE XDS Type Code ValueSet für ePA (required)
..... system S 1..1 uri Identity of the terminology system
..... code S 1..1 code Symbol in syntax defined by the system
..... display S 1..1 string Representation defined by the system
... category 1..1 CodeableConcept Grobe Klassifizierung des Dokuments
.... coding S 0..* Coding Code defined by a terminology system
Binding: IHE XDS Class Code ValueSet für ePA (required)
..... system S 1..1 uri Identity of the terminology system
..... code S 1..1 code Symbol in syntax defined by the system
..... display S 1..1 string Representation defined by the system
... subject 1..1 Reference(Patient) Systemweit eindeutige Kennung des Patienten
.... identifier S 1..1 IdentifierKvid10 Logical reference, when literal reference is not known
... date 0..1 instant Das Erzeugungsdatum wird in content.attachment.creation abgebildet.
... author 0..* Reference(Patient | Practitioner | Organization) Person oder System, welche(s) das Dokument erstellt hat
.... identifier S 0..1 IdentifierKvid10, IdentifierTelematikId, IdentifierLanr, IdentifierZanr Logical reference, when literal reference is not known
.... display S 1..1 string Text alternative for the resource
... authenticator S 0..1 Reference(Practitioner | Organization) Rechtlich Verantwortlicher für das Dokument
.... identifier S 1..1 IdentifierTelematikId Logical reference, when literal reference is not known
... custodian 0..0 n/a
... relatesTo 0..* BackboneElement Relationships to other documents
... description S 0..1 string Ergänzende Hinweise in Freitext
... securityLabel 0..* CodeableConcept Vertraulichkeitskennzeichnung und Datenkategorie des Dokuments
.... coding S 0..* Coding Code defined by a terminology system
Binding: MHD Security Label Value Set for ePA (required)
..... system S 1..1 uri Identity of the terminology system
..... code S 1..1 code Symbol in syntax defined by the system
..... display S 1..1 string Representation defined by the system
... content
.... attachment
..... contentType S 1..1 code Mime type of the content, with charset etc.
Binding: IHE XDS MIME Type ValueSet for ePA (required)
..... language 1..1 code Sprache, in der das Dokument abgefasst ist
..... url S 1..1 url URI für das Dokument
..... size S 0..1 unsignedInt Größe des Dokuments in Bytes
..... hash S 0..1 base64Binary Kryptographische Prüfsumme des Dokuments
..... title S 1..1 string Titel des Dokuments
..... creation 1..1 dateTime Erstellungszeitpunkt des Dokuments
.... format 1..1 Coding Global eindeutiger Code für das Dokumentenformat
Binding: IHE XDS Format Code ValueSet für ePA (required)
... context
.... encounter 0..0 Context of the document content
.... event S 0..* CodeableConcept Ereignisse, die zur Erstellung des Dokuments geführt haben
..... coding S 0..* Coding Code defined by a terminology system
Binding: IHE XDS Event Code ValueSet für ePA (required)
...... system S 1..1 uri Identity of the terminology system
...... code S 1..1 code Symbol in syntax defined by the system
...... display S 1..1 string Representation defined by the system
.... period
..... start S 0..1 dateTime Zeitpunkt, an dem das im Dokument dokumentierte (Behandlungs-)Ereignis begonnen wurde
..... end S 0..1 dateTime Zeitpunkt, an dem das im Dokument dokumentierte (Behandlungs-)Ereignis beendet wurde
.... facilityType 1..1 CodeableConcept Art der Einrichtung, in der das dokumentierte Ereignis stattgefunden hat
..... coding S 0..* Coding Code defined by a terminology system
Binding: IHE XDS Healthcare Facility Type Code ValueSet für ePA (required)
...... system S 1..1 uri Identity of the terminology system
...... code S 1..1 code Symbol in syntax defined by the system
...... display S 1..1 string Representation defined by the system
.... practiceSetting 0..1 CodeableConcept Art der Fachrichtung der erstellenden Einrichtung, in der das dokumentiere Ereignis stattgefunden hat
..... coding S 0..* Coding Code defined by a terminology system
Binding: IHE XDS Practice Setting Code ValueSet für ePA (required)
...... system S 1..1 uri Identity of the terminology system
...... code S 1..1 code Symbol in syntax defined by the system
...... display S 1..1 string Representation defined by the system
.... sourcePatientInfo
..... reference S 0..1 string Demographische Daten zum Patienten im Quellsystem
..... identifier S 0..1 Identifier Kennung des Patienten im Quellsystem
.... related S 0..* Reference(Resource) Liste von IDs, mit denen das Dokument assoziiert wird

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
DocumentReference.type.​coding Base required IHE XDS Type Code ValueSet für ePA 📦1.0.7 TI Terminology v1.0
DocumentReference.category.​coding Base required IHE XDS Class Code ValueSet für ePA 📦1.0.7 TI Terminology v1.0
DocumentReference.securityLabel.​coding Base required MHD Security Label Value Set for ePA 📦1.0.7 TI Terminology v1.0
DocumentReference.content.​attachment.contentType Base required IHE XDS MIME Type ValueSet for ePA 📦1.0.7 TI Terminology v1.0
DocumentReference.content.​format Base required IHE XDS Format Code ValueSet für ePA 📦1.0.7 TI Terminology v1.0
DocumentReference.context.​event.coding Base required IHE XDS Event Code ValueSet für ePA 📦1.0.8 TI Terminology v1.0
DocumentReference.context.​facilityType.coding Base required IHE XDS Healthcare Facility Type Code ValueSet für ePA 📦1.0.7 TI Terminology v1.0
DocumentReference.context.​practiceSetting.coding Base required IHE XDS Practice Setting Code ValueSet für ePA 📦1.0.8 TI Terminology v1.0

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentReference 0..* MinimalDocumentReference A reference to a document
Constraints: dom-2, dom-3, dom-4, dom-5, dom-6
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
... modifierExtension ?! 0..0 Extensions that cannot be ignored
Slice: Unordered, Open by value:url
... masterIdentifier Σ 1..1 UniqueIdIdentifier An identifier intended for computation
... Slices for identifier SΣ 0..* Identifier Other identifiers for the document
Slice: Unordered, Open by value:use
.... identifier:entryUUID SΣ 0..* EntryUUIDIdentifier An identifier intended for computation
... status ?!SΣ 1..1 code Status des Dokuments
Binding: MHD DocumentReference status codes (required): The status of the document reference.
... type SΣ 1..1 CodeableConcept Art des Dokuments
Binding: DocumentTypeValueSet (preferred): Precise type of clinical document.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding SΣ 0..* Coding Code defined by a terminology system
Binding: IHE XDS Type Code ValueSet für ePA (required)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣ 1..1 uri Identity of the terminology system
..... version Σ 0..1 string Version of the system - if relevant
..... code SΣ 1..1 code Symbol in syntax defined by the system
..... display SΣ 1..1 string Representation defined by the system
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... category SΣ 1..1 CodeableConcept Grobe Klassifizierung des Dokuments
Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding SΣ 0..* Coding Code defined by a terminology system
Binding: IHE XDS Class Code ValueSet für ePA (required)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣ 1..1 uri Identity of the terminology system
..... version Σ 0..1 string Version of the system - if relevant
..... code SΣ 1..1 code Symbol in syntax defined by the system
..... display SΣ 1..1 string Representation defined by the system
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... subject SΣC 1..1 Reference(Patient) Systemweit eindeutige Kennung des Patienten
Constraints: ref-1
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier SΣ 1..1 IdentifierKvid10 Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... date SΣ 0..1 instant Das Erzeugungsdatum wird in content.attachment.creation abgebildet.
... author SΣC 0..* Reference(Patient | Practitioner | Organization) Person oder System, welche(s) das Dokument erstellt hat
Constraints: ref-1
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier SΣ 0..1 IdentifierKvid10, IdentifierTelematikId, IdentifierLanr, IdentifierZanr Logical reference, when literal reference is not known
.... display SΣ 1..1 string Text alternative for the resource
... authenticator SC 0..1 Reference(Practitioner | Organization) Rechtlich Verantwortlicher für das Dokument
Constraints: ref-1
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier SΣ 1..1 IdentifierTelematikId Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... relatesTo SΣ 0..* BackboneElement Relationships to other documents
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code Σ 1..1 code replaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.
.... target ΣC 1..1 Reference(DocumentReference) Target of the relationship
Constraints: ref-1
... description SΣ 0..1 string Ergänzende Hinweise in Freitext
... securityLabel SΣ 0..* CodeableConcept Vertraulichkeitskennzeichnung und Datenkategorie des Dokuments
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding SΣ 0..* Coding Code defined by a terminology system
Binding: MHD Security Label Value Set for ePA (required)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣ 1..1 uri Identity of the terminology system
..... version Σ 0..1 string Version of the system - if relevant
..... code SΣ 1..1 code Symbol in syntax defined by the system
..... display SΣ 1..1 string Representation defined by the system
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... content Σ 1..1 BackboneElement Document referenced
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... attachment ΣC 1..1 Attachment Where to access the document
Constraints: att-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... contentType SΣ 1..1 code Mime type of the content, with charset etc.
Binding: IHE XDS MIME Type ValueSet for ePA (required)
Example General: text/plain; charset=UTF-8, image/png
..... language SΣ 1..1 code Sprache, in der das Dokument abgefasst ist
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding

Example General: en-AU
..... url SΣ 1..1 url URI für das Dokument
Example General: http://www.acme.com/logo-small.png
..... size SΣ 0..1 unsignedInt Größe des Dokuments in Bytes
..... hash SΣ 0..1 base64Binary Kryptographische Prüfsumme des Dokuments
..... title SΣ 1..1 string Titel des Dokuments
Example General: Official Corporate Logo
..... creation SΣ 1..1 dateTime Erstellungszeitpunkt des Dokuments
.... format SΣ 1..1 Coding Global eindeutiger Code für das Dokumentenformat
Binding: IHE XDS Format Code ValueSet für ePA (required)
... context Σ 0..1 BackboneElement Clinical context of document
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... event S 0..* CodeableConcept Ereignisse, die zur Erstellung des Dokuments geführt haben
Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented.
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding SΣ 0..* Coding Code defined by a terminology system
Binding: IHE XDS Event Code ValueSet für ePA (required)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣ 1..1 uri Identity of the terminology system
...... version Σ 0..1 string Version of the system - if relevant
...... code SΣ 1..1 code Symbol in syntax defined by the system
...... display SΣ 1..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... text Σ 0..1 string Plain text representation of the concept
.... period SΣC 0..1 Period Time of service that is being documented
Constraints: per-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... start SΣC 0..1 dateTime Zeitpunkt, an dem das im Dokument dokumentierte (Behandlungs-)Ereignis begonnen wurde
..... end SΣC 0..1 dateTime Zeitpunkt, an dem das im Dokument dokumentierte (Behandlungs-)Ereignis beendet wurde
.... facilityType S 1..1 CodeableConcept Art der Einrichtung, in der das dokumentierte Ereignis stattgefunden hat
Binding: FacilityTypeCodeValueSet (example): XDS Facility Type.
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding SΣ 0..* Coding Code defined by a terminology system
Binding: IHE XDS Healthcare Facility Type Code ValueSet für ePA (required)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣ 1..1 uri Identity of the terminology system
...... version Σ 0..1 string Version of the system - if relevant
...... code SΣ 1..1 code Symbol in syntax defined by the system
...... display SΣ 1..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... text Σ 0..1 string Plain text representation of the concept
.... practiceSetting S 0..1 CodeableConcept Art der Fachrichtung der erstellenden Einrichtung, in der das dokumentiere Ereignis stattgefunden hat
Binding: PracticeSettingCodeValueSet (example): Additional details about where the content was created (e.g. clinical specialty).
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding SΣ 0..* Coding Code defined by a terminology system
Binding: IHE XDS Practice Setting Code ValueSet für ePA (required)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣ 1..1 uri Identity of the terminology system
...... version Σ 0..1 string Version of the system - if relevant
...... code SΣ 1..1 code Symbol in syntax defined by the system
...... display SΣ 1..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... text Σ 0..1 string Plain text representation of the concept
.... sourcePatientInfo SC 0..1 Reference(Patient) Patient demographics from source
Constraints: ref-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... reference SΣC 0..1 string Demographische Daten zum Patienten im Quellsystem
..... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
..... identifier SΣ 0..1 Identifier Kennung des Patienten im Quellsystem
..... display Σ 0..1 string Text alternative for the resource
.... related SC 0..* Reference(Resource) Liste von IDs, mit denen das Dokument assoziiert wird
Constraints: ref-1

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DocumentReference.meta.​security Base extensible SecurityLabels 📦4.0.1 FHIR Std.
DocumentReference.meta.​tag Base example Common Tags 📦4.0.1 FHIR Std.
DocumentReference.language Base preferred Common Languages 📦4.0.1 FHIR Std.
DocumentReference.status Base required MHD DocumentReference status codes 📦4.2.3 Mobile access to Health Documents v4.2
DocumentReference.type Base preferred Document Type Value Set 📦4.0.1 FHIR Std.
DocumentReference.type.​coding Base required IHE XDS Type Code ValueSet für ePA 📦1.0.7 TI Terminology v1.0
DocumentReference.category Base example Document Class Value Set 📦4.0.1 FHIR Std.
DocumentReference.category.​coding Base required IHE XDS Class Code ValueSet für ePA 📦1.0.7 TI Terminology v1.0
DocumentReference.subject.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
DocumentReference.author.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
DocumentReference.authenticator.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
DocumentReference.relatesTo.​code Base required DocumentRelationshipType 📍4.0.1 FHIR Std.
DocumentReference.securityLabel Base extensible SecurityLabels 📦4.0.1 FHIR Std.
DocumentReference.securityLabel.​coding Base required MHD Security Label Value Set for ePA 📦1.0.7 TI Terminology v1.0
DocumentReference.content.​attachment.contentType Base required IHE XDS MIME Type ValueSet for ePA 📦1.0.7 TI Terminology v1.0
DocumentReference.content.​attachment.language Base preferred Common Languages 📦4.0.1 FHIR Std.
DocumentReference.content.​format Base required IHE XDS Format Code ValueSet für ePA 📦1.0.7 TI Terminology v1.0
DocumentReference.context.​event Base example v3 Code System ActCode 📦3.0.0 THO v7.0
DocumentReference.context.​event.coding Base required IHE XDS Event Code ValueSet für ePA 📦1.0.8 TI Terminology v1.0
DocumentReference.context.​facilityType Base example Facility Type Code Value Set 📦4.0.1 FHIR Std.
DocumentReference.context.​facilityType.coding Base required IHE XDS Healthcare Facility Type Code ValueSet für ePA 📦1.0.7 TI Terminology v1.0
DocumentReference.context.​practiceSetting Base example Practice Setting Code Value Set 📦4.0.1 FHIR Std.
DocumentReference.context.​practiceSetting.coding Base required IHE XDS Practice Setting Code ValueSet für ePA 📦1.0.8 TI Terminology v1.0
DocumentReference.context.​sourcePatientInfo.type Base extensible ResourceType 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
att-1 error DocumentReference.content.attachment If the Attachment has data, it SHALL have a contentType data.empty() or contentType.exists()
dom-2 error DocumentReference If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error DocumentReference If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error DocumentReference If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error DocumentReference If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice DocumentReference A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
per-1 error DocumentReference.context.period If present, start SHALL have a lower value than end start.hasValue().not() or end.hasValue().not() or (start <= end)
ref-1 error DocumentReference.subject, DocumentReference.author, DocumentReference.authenticator, DocumentReference.relatesTo.target, DocumentReference.context.sourcePatientInfo, DocumentReference.context.related SHALL have a contained resource if a local reference is provided reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

 

Other representations of profile: CSV, Excel, Schematron