Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
DocumentReference		0..*	DocumentReference	A reference to a document Constraints: dom-2, dom-3, dom-4, dom-5, dom-6
meta	SΣ	0..1	Meta	Metadata about the resource
versionId	SΣ	0..1	id	Version specific identifier
lastUpdated	SΣ	0..1	instant	When the resource version last changed
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored Slice: Unordered, Open by value:url
masterIdentifier	SΣ	0..1	Identifier	Master Version Specific Identifier
status	?!SΣ	1..1	code	current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference.
type	SΣ	0..1	CodeableConcept	Kind of document (LOINC if possible) Binding: DocumentTypeValueSet (preferred): Precise type of clinical document.
Slices for coding	SΣ	0..*	Coding	Code defined by a terminology system Slice: Unordered, Open by value:$this
coding:xds	SΣ	0..1	Coding	Code defined by a terminology system Binding: https://gematik.de/fhir/terminology/ValueSet/epa-xds-type-code-vs (required)
system	SΣ	1..1	uri	Identity of the terminology system
version	SΣ	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
text	SΣ	0..1	string	Plain text representation of the concept
category	SΣ	0..*	CodeableConcept	Categorization of document Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.
Slices for coding	SΣ	0..*	Coding	Code defined by a terminology system Slice: Unordered, Open by value:$this
coding:xds	SΣ	0..1	Coding	Code defined by a terminology system Binding: https://gematik.de/fhir/terminology/ValueSet/epa-xds-class-code-vs (required)
system	SΣ	1..1	uri	Identity of the terminology system
version	SΣ	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
text	SΣ	0..1	string	Plain text representation of the concept
subject	SΣC	1..1	Reference(TI Patient)	Who/what is the subject of the document Constraints: ref-1
reference	SΣC	0..1	string	Literal reference, Relative, internal or absolute URL
identifier	SΣ	0..1	Identifier	Logical reference, when literal reference is not known
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	SΣ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	0..1	string	The value that is unique Example General: 123456
display	SΣ	0..1	string	Text alternative for the resource
author	SΣC	0..*	Reference(TI Practitioner | TI PractitionerRole | TI Organization | Device | TI Patient | TI Related Person)	Who and/or what authored the document Constraints: ref-1
reference	SΣC	0..1	string	Literal reference, Relative, internal or absolute URL
display	SΣ	0..1	string	Text alternative for the resource
description	SΣ	0..1	string	Human-readable description
content	SΣ	1..*	BackboneElement	Document referenced
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
attachment	SΣ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: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Required Pattern: application/pdf
data	S	1..1	base64Binary	Data inline, base64ed
title	SΣ	1..1	string	Label to display in place of the data Example General: Official Corporate Logo
creation	SΣ	0..1	dateTime	Date attachment was first created
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
DocumentReference.status	Base	required	DocumentReferenceStatus	📍4.0.1	FHIR Std.
DocumentReference.type	Base	preferred	Document Type Value Set	📍4.0.1	FHIR Std.
DocumentReference.type.​coding:xds	Base	required	https://gematik.de/fhir/terminology/ValueSet/epa-xds-type-code-vs	Not State	Unknown
DocumentReference.category	Base	example	Document Class Value Set	📍4.0.1	FHIR Std.
DocumentReference.category.​coding:xds	Base	required	https://gematik.de/fhir/terminology/ValueSet/epa-xds-class-code-vs	Not State	Unknown
DocumentReference.subject.​identifier.use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
DocumentReference.content.​attachment.contentType	Base	required	MimeType	📍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()
ref-1	error	DocumentReference.subject, DocumentReference.author	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'))

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
DocumentReference		0..*	DocumentReference	A reference to a document
meta	S	0..1	Meta	Metadata about the resource
versionId	S	0..1	id	Version specific identifier
lastUpdated	S	0..1	instant	When the resource version last changed
masterIdentifier	S	0..1	Identifier	Master Version Specific Identifier
status	S	1..1	code	current | superseded | entered-in-error
type	S	0..1	CodeableConcept	Kind of document (LOINC if possible)
Slices for coding	S	0..*	Coding	Code defined by a terminology system Slice: Unordered, Open by value:$this
coding:xds	S	0..1	Coding	Code defined by a terminology system Binding: https://gematik.de/fhir/terminology/ValueSet/epa-xds-type-code-vs (required)
system	S	1..1	uri	Identity of the terminology system
version	S	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
text	S	0..1	string	Plain text representation of the concept
category	S	0..*	CodeableConcept	Categorization of document
Slices for coding	S	0..*	Coding	Code defined by a terminology system Slice: Unordered, Open by value:$this
coding:xds	S	0..1	Coding	Code defined by a terminology system Binding: https://gematik.de/fhir/terminology/ValueSet/epa-xds-class-code-vs (required)
system	S	1..1	uri	Identity of the terminology system
version	S	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
text	S	0..1	string	Plain text representation of the concept
subject	S	1..1	Reference(TI Patient)	Who/what is the subject of the document
reference	S	0..1	string	Literal reference, Relative, internal or absolute URL
identifier	S	0..1	Identifier	Logical reference, when literal reference is not known
system	S	0..1	uri	The namespace for the identifier value
value	S	0..1	string	The value that is unique
display	S	0..1	string	Text alternative for the resource
author	S	0..*	Reference(TI Practitioner | TI PractitionerRole | TI Organization | Device | TI Patient | TI Related Person)	Who and/or what authored the document
reference	S	0..1	string	Literal reference, Relative, internal or absolute URL
display	S	0..1	string	Text alternative for the resource
description	S	0..1	string	Human-readable description
content	S	1..*	BackboneElement	Document referenced
attachment	S	1..1	Attachment	Where to access the document
contentType	S	1..1	code	Mime type of the content, with charset etc. Required Pattern: application/pdf
data	S	1..1	base64Binary	Data inline, base64ed
url		0..0		Uri where the data can be found
title	S	1..1	string	Label to display in place of the data
creation	S	0..1	dateTime	Date attachment was first created
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
DocumentReference.type.​coding:xds	Base	required	https://gematik.de/fhir/terminology/ValueSet/epa-xds-type-code-vs	Not State	Unknown
DocumentReference.category.​coding:xds	Base	required	https://gematik.de/fhir/terminology/ValueSet/epa-xds-class-code-vs	Not State	Unknown

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
DocumentReference		0..*	DocumentReference	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	SΣ	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	SΣ	0..1	id	Version specific identifier
lastUpdated	SΣ	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
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
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..*	Extension	Extensions that cannot be ignored Slice: Unordered, Open by value:url
masterIdentifier	SΣ	0..1	Identifier	Master Version Specific Identifier
identifier	Σ	0..*	Identifier	Other identifiers for the document
status	?!SΣ	1..1	code	current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference.
docStatus	Σ	0..1	code	preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): Status of the underlying document.
type	SΣ	0..1	CodeableConcept	Kind of document (LOINC if possible) 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
Slices for coding	SΣ	0..*	Coding	Code defined by a terminology system Slice: Unordered, Open by value:$this
coding:xds	SΣ	0..1	Coding	Code defined by a terminology system Binding: https://gematik.de/fhir/terminology/ValueSet/epa-xds-type-code-vs (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	SΣ	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	SΣ	0..1	string	Plain text representation of the concept
category	SΣ	0..*	CodeableConcept	Categorization of document 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
Slices for coding	SΣ	0..*	Coding	Code defined by a terminology system Slice: Unordered, Open by value:$this
coding:xds	SΣ	0..1	Coding	Code defined by a terminology system Binding: https://gematik.de/fhir/terminology/ValueSet/epa-xds-class-code-vs (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	SΣ	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	SΣ	0..1	string	Plain text representation of the concept
subject	SΣC	1..1	Reference(TI Patient)	Who/what is the subject of the document 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	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	Identifier	Logical reference, when literal reference is not known
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	SΣ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	0..1	string	The value that is unique Example General: 123456
period	ΣC	0..1	Period	Time period when id is/was valid for use Constraints: per-1
assigner	ΣC	0..1	Reference(Organization)	Organization that issued id (may be just text) Constraints: ref-1
display	SΣ	0..1	string	Text alternative for the resource
date	Σ	0..1	instant	When this document reference was created
author	SΣC	0..*	Reference(TI Practitioner | TI PractitionerRole | TI Organization | Device | TI Patient | TI Related Person)	Who and/or what authored the document 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	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	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	SΣ	0..1	string	Text alternative for the resource
authenticator	C	0..1	Reference(Practitioner | PractitionerRole | Organization)	Who/what authenticated the document Constraints: ref-1
custodian	C	0..1	Reference(Organization)	Organization which maintains the document Constraints: ref-1
relatesTo	Σ	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	Human-readable description
securityLabel	Σ	0..*	CodeableConcept	Document security-tags Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
content	SΣ	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	SΣ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: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Required Pattern: application/pdf
language	Σ	0..1	code	Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding Example General: en-AU
data	S	1..1	base64Binary	Data inline, base64ed
size	Σ	0..1	unsignedInt	Number of bytes of content (if url provided)
hash	Σ	0..1	base64Binary	Hash of the data (sha-1, base64ed)
title	SΣ	1..1	string	Label to display in place of the data Example General: Official Corporate Logo
creation	SΣ	0..1	dateTime	Date attachment was first created
format	Σ	0..1	Coding	Format/content rules for the document Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes.
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
encounter	C	0..*	Reference(Encounter | EpisodeOfCare)	Context of the document content Constraints: ref-1
event		0..*	CodeableConcept	Main clinical acts documented Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented.
period	ΣC	0..1	Period	Time of service that is being documented Constraints: per-1
facilityType		0..1	CodeableConcept	Kind of facility where patient was seen Binding: FacilityTypeCodeValueSet (example): XDS Facility Type.
practiceSetting		0..1	CodeableConcept	Additional details about where the content was created (e.g. clinical specialty) Binding: PracticeSettingCodeValueSet (example): Additional details about where the content was created (e.g. clinical specialty).
sourcePatientInfo	C	0..1	Reference(Patient)	Patient demographics from source Constraints: ref-1
related	C	0..*	Reference(Resource)	Related identifiers or resources Constraints: ref-1
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	DocumentReferenceStatus	📍4.0.1	FHIR Std.
DocumentReference.docStatus	Base	required	CompositionStatus	📍4.0.1	FHIR Std.
DocumentReference.type	Base	preferred	Document Type Value Set	📍4.0.1	FHIR Std.
DocumentReference.type.​coding:xds	Base	required	https://gematik.de/fhir/terminology/ValueSet/epa-xds-type-code-vs	Not State	Unknown
DocumentReference.category	Base	example	Document Class Value Set	📍4.0.1	FHIR Std.
DocumentReference.category.​coding:xds	Base	required	https://gematik.de/fhir/terminology/ValueSet/epa-xds-class-code-vs	Not State	Unknown
DocumentReference.subject.​type	Base	extensible	ResourceType	📍4.0.1	FHIR Std.
DocumentReference.subject.​identifier.use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
DocumentReference.subject.​identifier.type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
DocumentReference.author.​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.content.​attachment.contentType	Base	required	MimeType	📍4.0.1	FHIR Std.
DocumentReference.content.​attachment.language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
DocumentReference.content.​format	Base	preferred	DocumentReference Format Code Set	📍4.0.1	FHIR Std.
DocumentReference.context.​event	Base	example	v3 Code System ActCode	📦3.0.0	THO v7.3
DocumentReference.context.​facilityType	Base	example	Facility Type Code Value Set	📍4.0.1	FHIR Std.
DocumentReference.context.​practiceSetting	Base	example	Practice Setting Code Value Set	📍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.subject.identifier.period, 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.subject.identifier.assigner, DocumentReference.author, DocumentReference.authenticator, DocumentReference.custodian, DocumentReference.relatesTo.target, DocumentReference.context.encounter, 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'))

Summary

Mandatory: 4 elements(6 nested mandatory elements)
Must-Support: 37 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

• TI Patient (https://gematik.de/fhir/ti/StructureDefinition/ti-patient)
• TI Practitioner (https://gematik.de/fhir/ti/StructureDefinition/ti-practitioner)
• TI PractitionerRole (https://gematik.de/fhir/ti/StructureDefinition/ti-practitioner-role)
• TI Organization (https://gematik.de/fhir/ti/StructureDefinition/ti-organization)
• TI Related Person (https://gematik.de/fhir/ti/StructureDefinition/ti-related-person)

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of DocumentReference.type.coding
• The element 1 is sliced based on the value of DocumentReference.category.coding

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
DocumentReference		0..*	DocumentReference	A reference to a document Constraints: dom-2, dom-3, dom-4, dom-5, dom-6
meta	SΣ	0..1	Meta	Metadata about the resource
versionId	SΣ	0..1	id	Version specific identifier
lastUpdated	SΣ	0..1	instant	When the resource version last changed
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored Slice: Unordered, Open by value:url
masterIdentifier	SΣ	0..1	Identifier	Master Version Specific Identifier
status	?!SΣ	1..1	code	current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference.
type	SΣ	0..1	CodeableConcept	Kind of document (LOINC if possible) Binding: DocumentTypeValueSet (preferred): Precise type of clinical document.
Slices for coding	SΣ	0..*	Coding	Code defined by a terminology system Slice: Unordered, Open by value:$this
coding:xds	SΣ	0..1	Coding	Code defined by a terminology system Binding: https://gematik.de/fhir/terminology/ValueSet/epa-xds-type-code-vs (required)
system	SΣ	1..1	uri	Identity of the terminology system
version	SΣ	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
text	SΣ	0..1	string	Plain text representation of the concept
category	SΣ	0..*	CodeableConcept	Categorization of document Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.
Slices for coding	SΣ	0..*	Coding	Code defined by a terminology system Slice: Unordered, Open by value:$this
coding:xds	SΣ	0..1	Coding	Code defined by a terminology system Binding: https://gematik.de/fhir/terminology/ValueSet/epa-xds-class-code-vs (required)
system	SΣ	1..1	uri	Identity of the terminology system
version	SΣ	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
text	SΣ	0..1	string	Plain text representation of the concept
subject	SΣC	1..1	Reference(TI Patient)	Who/what is the subject of the document Constraints: ref-1
reference	SΣC	0..1	string	Literal reference, Relative, internal or absolute URL
identifier	SΣ	0..1	Identifier	Logical reference, when literal reference is not known
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	SΣ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	0..1	string	The value that is unique Example General: 123456
display	SΣ	0..1	string	Text alternative for the resource
author	SΣC	0..*	Reference(TI Practitioner | TI PractitionerRole | TI Organization | Device | TI Patient | TI Related Person)	Who and/or what authored the document Constraints: ref-1
reference	SΣC	0..1	string	Literal reference, Relative, internal or absolute URL
display	SΣ	0..1	string	Text alternative for the resource
description	SΣ	0..1	string	Human-readable description
content	SΣ	1..*	BackboneElement	Document referenced
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
attachment	SΣ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: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Required Pattern: application/pdf
data	S	1..1	base64Binary	Data inline, base64ed
title	SΣ	1..1	string	Label to display in place of the data Example General: Official Corporate Logo
creation	SΣ	0..1	dateTime	Date attachment was first created
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
DocumentReference.status	Base	required	DocumentReferenceStatus	📍4.0.1	FHIR Std.
DocumentReference.type	Base	preferred	Document Type Value Set	📍4.0.1	FHIR Std.
DocumentReference.type.​coding:xds	Base	required	https://gematik.de/fhir/terminology/ValueSet/epa-xds-type-code-vs	Not State	Unknown
DocumentReference.category	Base	example	Document Class Value Set	📍4.0.1	FHIR Std.
DocumentReference.category.​coding:xds	Base	required	https://gematik.de/fhir/terminology/ValueSet/epa-xds-class-code-vs	Not State	Unknown
DocumentReference.subject.​identifier.use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
DocumentReference.content.​attachment.contentType	Base	required	MimeType	📍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()
ref-1	error	DocumentReference.subject, DocumentReference.author	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'))

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
DocumentReference		0..*	DocumentReference	A reference to a document
meta	S	0..1	Meta	Metadata about the resource
versionId	S	0..1	id	Version specific identifier
lastUpdated	S	0..1	instant	When the resource version last changed
masterIdentifier	S	0..1	Identifier	Master Version Specific Identifier
status	S	1..1	code	current | superseded | entered-in-error
type	S	0..1	CodeableConcept	Kind of document (LOINC if possible)
Slices for coding	S	0..*	Coding	Code defined by a terminology system Slice: Unordered, Open by value:$this
coding:xds	S	0..1	Coding	Code defined by a terminology system Binding: https://gematik.de/fhir/terminology/ValueSet/epa-xds-type-code-vs (required)
system	S	1..1	uri	Identity of the terminology system
version	S	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
text	S	0..1	string	Plain text representation of the concept
category	S	0..*	CodeableConcept	Categorization of document
Slices for coding	S	0..*	Coding	Code defined by a terminology system Slice: Unordered, Open by value:$this
coding:xds	S	0..1	Coding	Code defined by a terminology system Binding: https://gematik.de/fhir/terminology/ValueSet/epa-xds-class-code-vs (required)
system	S	1..1	uri	Identity of the terminology system
version	S	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
text	S	0..1	string	Plain text representation of the concept
subject	S	1..1	Reference(TI Patient)	Who/what is the subject of the document
reference	S	0..1	string	Literal reference, Relative, internal or absolute URL
identifier	S	0..1	Identifier	Logical reference, when literal reference is not known
system	S	0..1	uri	The namespace for the identifier value
value	S	0..1	string	The value that is unique
display	S	0..1	string	Text alternative for the resource
author	S	0..*	Reference(TI Practitioner | TI PractitionerRole | TI Organization | Device | TI Patient | TI Related Person)	Who and/or what authored the document
reference	S	0..1	string	Literal reference, Relative, internal or absolute URL
display	S	0..1	string	Text alternative for the resource
description	S	0..1	string	Human-readable description
content	S	1..*	BackboneElement	Document referenced
attachment	S	1..1	Attachment	Where to access the document
contentType	S	1..1	code	Mime type of the content, with charset etc. Required Pattern: application/pdf
data	S	1..1	base64Binary	Data inline, base64ed
url		0..0		Uri where the data can be found
title	S	1..1	string	Label to display in place of the data
creation	S	0..1	dateTime	Date attachment was first created
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
DocumentReference.type.​coding:xds	Base	required	https://gematik.de/fhir/terminology/ValueSet/epa-xds-type-code-vs	Not State	Unknown
DocumentReference.category.​coding:xds	Base	required	https://gematik.de/fhir/terminology/ValueSet/epa-xds-class-code-vs	Not State	Unknown

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
DocumentReference		0..*	DocumentReference	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	SΣ	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	SΣ	0..1	id	Version specific identifier
lastUpdated	SΣ	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
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
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..*	Extension	Extensions that cannot be ignored Slice: Unordered, Open by value:url
masterIdentifier	SΣ	0..1	Identifier	Master Version Specific Identifier
identifier	Σ	0..*	Identifier	Other identifiers for the document
status	?!SΣ	1..1	code	current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference.
docStatus	Σ	0..1	code	preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): Status of the underlying document.
type	SΣ	0..1	CodeableConcept	Kind of document (LOINC if possible) 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
Slices for coding	SΣ	0..*	Coding	Code defined by a terminology system Slice: Unordered, Open by value:$this
coding:xds	SΣ	0..1	Coding	Code defined by a terminology system Binding: https://gematik.de/fhir/terminology/ValueSet/epa-xds-type-code-vs (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	SΣ	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	SΣ	0..1	string	Plain text representation of the concept
category	SΣ	0..*	CodeableConcept	Categorization of document 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
Slices for coding	SΣ	0..*	Coding	Code defined by a terminology system Slice: Unordered, Open by value:$this
coding:xds	SΣ	0..1	Coding	Code defined by a terminology system Binding: https://gematik.de/fhir/terminology/ValueSet/epa-xds-class-code-vs (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	SΣ	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	SΣ	0..1	string	Plain text representation of the concept
subject	SΣC	1..1	Reference(TI Patient)	Who/what is the subject of the document 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	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	Identifier	Logical reference, when literal reference is not known
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	SΣ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	0..1	string	The value that is unique Example General: 123456
period	ΣC	0..1	Period	Time period when id is/was valid for use Constraints: per-1
assigner	ΣC	0..1	Reference(Organization)	Organization that issued id (may be just text) Constraints: ref-1
display	SΣ	0..1	string	Text alternative for the resource
date	Σ	0..1	instant	When this document reference was created
author	SΣC	0..*	Reference(TI Practitioner | TI PractitionerRole | TI Organization | Device | TI Patient | TI Related Person)	Who and/or what authored the document 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	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	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	SΣ	0..1	string	Text alternative for the resource
authenticator	C	0..1	Reference(Practitioner | PractitionerRole | Organization)	Who/what authenticated the document Constraints: ref-1
custodian	C	0..1	Reference(Organization)	Organization which maintains the document Constraints: ref-1
relatesTo	Σ	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	Human-readable description
securityLabel	Σ	0..*	CodeableConcept	Document security-tags Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
content	SΣ	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	SΣ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: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Required Pattern: application/pdf
language	Σ	0..1	code	Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding Example General: en-AU
data	S	1..1	base64Binary	Data inline, base64ed
size	Σ	0..1	unsignedInt	Number of bytes of content (if url provided)
hash	Σ	0..1	base64Binary	Hash of the data (sha-1, base64ed)
title	SΣ	1..1	string	Label to display in place of the data Example General: Official Corporate Logo
creation	SΣ	0..1	dateTime	Date attachment was first created
format	Σ	0..1	Coding	Format/content rules for the document Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes.
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
encounter	C	0..*	Reference(Encounter | EpisodeOfCare)	Context of the document content Constraints: ref-1
event		0..*	CodeableConcept	Main clinical acts documented Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented.
period	ΣC	0..1	Period	Time of service that is being documented Constraints: per-1
facilityType		0..1	CodeableConcept	Kind of facility where patient was seen Binding: FacilityTypeCodeValueSet (example): XDS Facility Type.
practiceSetting		0..1	CodeableConcept	Additional details about where the content was created (e.g. clinical specialty) Binding: PracticeSettingCodeValueSet (example): Additional details about where the content was created (e.g. clinical specialty).
sourcePatientInfo	C	0..1	Reference(Patient)	Patient demographics from source Constraints: ref-1
related	C	0..*	Reference(Resource)	Related identifiers or resources Constraints: ref-1
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	DocumentReferenceStatus	📍4.0.1	FHIR Std.
DocumentReference.docStatus	Base	required	CompositionStatus	📍4.0.1	FHIR Std.
DocumentReference.type	Base	preferred	Document Type Value Set	📍4.0.1	FHIR Std.
DocumentReference.type.​coding:xds	Base	required	https://gematik.de/fhir/terminology/ValueSet/epa-xds-type-code-vs	Not State	Unknown
DocumentReference.category	Base	example	Document Class Value Set	📍4.0.1	FHIR Std.
DocumentReference.category.​coding:xds	Base	required	https://gematik.de/fhir/terminology/ValueSet/epa-xds-class-code-vs	Not State	Unknown
DocumentReference.subject.​type	Base	extensible	ResourceType	📍4.0.1	FHIR Std.
DocumentReference.subject.​identifier.use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
DocumentReference.subject.​identifier.type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
DocumentReference.author.​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.content.​attachment.contentType	Base	required	MimeType	📍4.0.1	FHIR Std.
DocumentReference.content.​attachment.language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
DocumentReference.content.​format	Base	preferred	DocumentReference Format Code Set	📍4.0.1	FHIR Std.
DocumentReference.context.​event	Base	example	v3 Code System ActCode	📦3.0.0	THO v7.3
DocumentReference.context.​facilityType	Base	example	Facility Type Code Value Set	📍4.0.1	FHIR Std.
DocumentReference.context.​practiceSetting	Base	example	Practice Setting Code Value Set	📍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.subject.identifier.period, 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.subject.identifier.assigner, DocumentReference.author, DocumentReference.authenticator, DocumentReference.custodian, DocumentReference.relatesTo.target, DocumentReference.context.encounter, 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'))