eHealth Infrastructure
3.6.0 - release Denmark flag

eHealth Infrastructure, published by Den telemedicinske infrastruktur (eHealth Infrastructure). This guide is not an authorized publication; it is the continuous build for version 3.6.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/fut-infrastructure/implementation-guide/ and changes regularly. See the Directory of published versions

Resource Profile: ehealth-documentreference

Official URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-documentreference Version: 3.6.0
Active as of 2025-09-25 Computable Name: ehealth-documentreference

Introduction

A DocumentReference resource is used to describe a document that is made available to a healthcare system. A document is some sequence of bytes that is identifiable, establishes its own context (e.g., what subject, author, etc. can be displayed to the user), and has defined update management. The DocumentReference resource can be used with any document format that has a recognized mime type and that conforms to this definition.

Typically, DocumentReference resources are used in document indexing systems, such as IHE XDS , and are used to refer to:

  • CDA documents in FHIR systems
  • FHIR documents stored elsewhere (i.e. registry/repository following the XDS model)
  • PDF documents , and even digital records of faxes where sufficient information is available
  • Other kinds of documents, such as records of prescriptions

Scope and Usage

In scope of the eHealth infrastructure the primary use of the DocumentReference resource is to contain or refer to information material used in relation to PlanDefinition and Questionnaire. This information material can be in the form of embedded material (of limited size) or references to videos, PDF-files or printed material.

See eHealth-plandefinition for further details.

The eHealth profile of DocumentReference has the following extensions:

  • ehealth-manuallydeprecated-type
  • ehealth-useContext which defines the context that the content is intended to support

UseContext

The element useContext.code has binding to the ValueSet http://hl7.org/fhir/ValueSet/use-context (see https://hl7.org/fhir/R4/valueset-use-context.html). It is, however, validated against the eHealth ValueSet http://ehealth.sundhed.dk/vs/ehealth-usage-context-type (see https://ehealth.sundhed.dk/fhir/ValueSet-ehealth-usage-context-type.html). This validation includes that the value in useContext.valueCodeableConcept is acceptable in the ValueSet described for useContext.code.

Document sharing states

For the purpose of sharing documents to the XDS repository, the DocumentReference has a collection of tags to express where in the document-sharing process the document is and why it is there.

There are 4 overall states expressing where in the sharing process the document is, and a further 11 sub-states to express th reason why the document is in the given state.

The states are contained in DocumentReference.meta.tag using the system http://ehealth.sundhed.dk/cs/document-sharing-state.

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 C 0..* DocumentReference A reference to a document
Constraints: modifierRole-required-for-material-registration
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:useContext 0..* UsageContext The context that the content is intended to support
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-useContext
.... extension:modifierRole 0..* (Complex) Modifier role
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-modifier-role
.... extension:intendedOrganization 0..* Reference(ehealth-organization) {r} The organization intended to use this resource.
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-intendedOrganization
.... extension:artifactDate 0..1 dateTime Date last changed.
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-artifact-date
.... extension:participant 0..* (Complex) Who or what is participating
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-participant
..... Slices for extension Content/Rules for all slices
...... extension:function 0..1 Extension Extension
....... extension 0..0
....... url 1..1 uri "function"
....... value[x] 0..1 Coding Value of extension
Binding: Material Registration Participant Function (required)
...... extension:actor 0..1 Extension The participant
....... extension 0..0
....... url 1..1 uri "actor"
...... extension:actorref 0..1 Extension The participant ref (string)
....... extension 0..0
....... url 1..1 uri "actorref"
..... url 1..1 uri "http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-participant"
.... extension:usage 0..1 string usage
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-usage
.... extension:version 0..1 string The current version
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-version
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... type Σ 0..1 CodeableConcept Kind of document (LOINC if possible)
Binding: EHealthDocumentReference Type (required)
... category Σ 0..1 CodeableConcept Categorization of document
Binding: Document Category (required)
... subject Σ 0..1 Reference(ehealth-patient | ehealth-practitioner | Group | ehealth-device) {r} Who/what is the subject of the document
... author Σ 0..* Reference(ehealth-practitioner | ehealth-organization | ehealth-device | ehealth-patient | ehealth-relatedperson) {r} Who and/or what authored the document
... authenticator 0..1 Reference(ehealth-practitioner | ehealth-organization) {r} Who/what authenticated the document
... custodian 0..1 Reference(ehealth-organization) {r} Organization which maintains the document
... content Σ 1..* BackboneElement Document referenced
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... attachment Σ 1..1 Attachment Where to access the document

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
DocumentReference.extension:participant.extension:function.value[x]requiredMaterialRegistrationParticipantFunction
http://ehealth.sundhed.dk/vs/material-registration-participant-function
From this IG
DocumentReference.statusrequiredDocumentReferenceStatus
http://hl7.org/fhir/ValueSet/document-reference-status|4.0.1
From the FHIR Standard
DocumentReference.typerequiredEHealthDocumentReferenceType
http://ehealth.sundhed.dk/vs/ehealth-document-reference-type
From this IG
DocumentReference.categoryrequiredDocumentCategory(a valid code from Material Category)
http://ehealth.sundhed.dk/vs/document-category
From this IG

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorDocumentReferenceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorDocumentReferenceIf 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-4errorDocumentReferenceIf 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-5errorDocumentReferenceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceDocumentReferenceA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
modifierRole-required-for-material-registrationerrorDocumentReference'ehealth-modifier-role' extension is required when category code is 'general-material' or 'patient-specific-material'
: category.coding.exists(system = 'http://ehealth.sundhed.dk/cs/material-category' and (code = 'general-material' or code = 'patient-specific-material')) implies extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-modifier-role').exists()

This structure is derived from DocumentReference

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentReference C 0..* DocumentReference A reference to a document
Constraints: modifierRole-required-for-material-registration
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:useContext 0..* UsageContext The context that the content is intended to support
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-useContext
.... extension:modifierRole 0..* (Complex) Modifier role
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-modifier-role
.... extension:intendedOrganization 0..* Reference(ehealth-organization) {r} The organization intended to use this resource.
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-intendedOrganization
.... extension:artifactDate 0..1 dateTime Date last changed.
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-artifact-date
.... extension:participant 0..* (Complex) Who or what is participating
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-participant
..... Slices for extension Content/Rules for all slices
...... extension:function 0..1 Extension Extension
....... value[x] 0..1 Coding Value of extension
Binding: Material Registration Participant Function (required)
.... extension:usage 0..1 string usage
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-usage
.... extension:version 0..1 string The current version
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-version
... type 0..1 CodeableConcept Kind of document (LOINC if possible)
Binding: EHealthDocumentReference Type (required)
... category 0..1 CodeableConcept Categorization of document
Binding: Document Category (required)
... author 0..* Reference(ehealth-practitioner | ehealth-organization | ehealth-device | ehealth-patient | ehealth-relatedperson) {r} Who and/or what authored the document
... authenticator 0..1 Reference(ehealth-practitioner | ehealth-organization) {r} Who/what authenticated the document
... custodian 0..1 Reference(ehealth-organization) {r} Organization which maintains the document
... relatesTo
.... target 1..1 Reference(ehealth-documentreference) Target of the relationship
... context
.... encounter 0..* Reference(ehealth-episodeofcare) Context of the document content
.... event 0..0
.... facilityType 0..0
.... practiceSetting 0..0
.... sourcePatientInfo 0..1 Reference(ehealth-patient) Patient demographics from source

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
DocumentReference.extension:participant.extension:function.value[x]requiredMaterialRegistrationParticipantFunction
http://ehealth.sundhed.dk/vs/material-registration-participant-function
From this IG
DocumentReference.typerequiredEHealthDocumentReferenceType
http://ehealth.sundhed.dk/vs/ehealth-document-reference-type
From this IG
DocumentReference.categoryrequiredDocumentCategory(a valid code from Material Category)
http://ehealth.sundhed.dk/vs/document-category
From this IG

Constraints

IdGradePath(s)DetailsRequirements
modifierRole-required-for-material-registrationerrorDocumentReference'ehealth-modifier-role' extension is required when category code is 'general-material' or 'patient-specific-material'
: category.coding.exists(system = 'http://ehealth.sundhed.dk/cs/material-category' and (code = 'general-material' or code = 'patient-specific-material')) implies extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-modifier-role').exists()
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentReference C 0..* DocumentReference A reference to a document
Constraints: modifierRole-required-for-material-registration
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... 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
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:useContext 0..* UsageContext The context that the content is intended to support
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-useContext
.... extension:modifierRole 0..* (Complex) Modifier role
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-modifier-role
.... extension:intendedOrganization 0..* Reference(ehealth-organization) {r} The organization intended to use this resource.
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-intendedOrganization
.... extension:artifactDate 0..1 dateTime Date last changed.
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-artifact-date
.... extension:participant 0..* (Complex) Who or what is participating
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-participant
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:function 0..1 Extension Extension
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "function"
....... value[x] 0..1 Coding Value of extension
Binding: Material Registration Participant Function (required)
...... extension:actor 0..1 Extension The participant
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "actor"
....... value[x] 0..1 Reference(CareTeam | Practitioner) {r} Value of extension
...... extension:actorref 0..1 Extension The participant ref (string)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "actorref"
....... value[x] 0..1 string Value of extension
..... url 1..1 uri "http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-participant"
.... extension:usage 0..1 string usage
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-usage
.... extension:version 0..1 string The current version
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-version
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... masterIdentifier Σ 0..1 Identifier Master Version Specific Identifier
... identifier Σ 0..* Identifier Other identifiers for the document
... status ?!Σ 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 Σ 0..1 CodeableConcept Kind of document (LOINC if possible)
Binding: EHealthDocumentReference Type (required)
... category Σ 0..1 CodeableConcept Categorization of document
Binding: Document Category (required)
... subject Σ 0..1 Reference(ehealth-patient | ehealth-practitioner | Group | ehealth-device) {r} Who/what is the subject of the document
... date Σ 0..1 instant When this document reference was created
... author Σ 0..* Reference(ehealth-practitioner | ehealth-organization | ehealth-device | ehealth-patient | ehealth-relatedperson) {r} Who and/or what authored the document
... authenticator 0..1 Reference(ehealth-practitioner | ehealth-organization) {r} Who/what authenticated the document
... custodian 0..1 Reference(ehealth-organization) {r} Organization which maintains the document
... 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
.... 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 Σ 1..1 Reference(ehealth-documentreference) Target of the relationship
... description Σ 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 Σ 1..* BackboneElement Document referenced
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... attachment Σ 1..1 Attachment Where to access the document
.... 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
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... encounter 0..* Reference(ehealth-episodeofcare) Context of the document content
.... period Σ 0..1 Period Time of service that is being documented
.... sourcePatientInfo 0..1 Reference(ehealth-patient) Patient demographics from source
.... related 0..* Reference(Resource) Related identifiers or resources

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
DocumentReference.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages|4.0.1
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
DocumentReference.extension:participant.extension:function.value[x]requiredMaterialRegistrationParticipantFunction
http://ehealth.sundhed.dk/vs/material-registration-participant-function
From this IG
DocumentReference.statusrequiredDocumentReferenceStatus
http://hl7.org/fhir/ValueSet/document-reference-status|4.0.1
From the FHIR Standard
DocumentReference.docStatusrequiredCompositionStatus
http://hl7.org/fhir/ValueSet/composition-status|4.0.1
From the FHIR Standard
DocumentReference.typerequiredEHealthDocumentReferenceType
http://ehealth.sundhed.dk/vs/ehealth-document-reference-type
From this IG
DocumentReference.categoryrequiredDocumentCategory(a valid code from Material Category)
http://ehealth.sundhed.dk/vs/document-category
From this IG
DocumentReference.relatesTo.coderequiredDocumentRelationshipType
http://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1
From the FHIR Standard
DocumentReference.securityLabelextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels|4.0.1
From the FHIR Standard
DocumentReference.content.formatpreferredDocumentReferenceFormatCodeSet(a valid code from http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem)
http://hl7.org/fhir/ValueSet/formatcodes|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorDocumentReferenceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorDocumentReferenceIf 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-4errorDocumentReferenceIf 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-5errorDocumentReferenceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceDocumentReferenceA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
modifierRole-required-for-material-registrationerrorDocumentReference'ehealth-modifier-role' extension is required when category code is 'general-material' or 'patient-specific-material'
: category.coding.exists(system = 'http://ehealth.sundhed.dk/cs/material-category' and (code = 'general-material' or code = 'patient-specific-material')) implies extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-modifier-role').exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentReference C 0..* DocumentReference A reference to a document
Constraints: modifierRole-required-for-material-registration
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:useContext 0..* UsageContext The context that the content is intended to support
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-useContext
.... extension:modifierRole 0..* (Complex) Modifier role
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-modifier-role
.... extension:intendedOrganization 0..* Reference(ehealth-organization) {r} The organization intended to use this resource.
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-intendedOrganization
.... extension:artifactDate 0..1 dateTime Date last changed.
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-artifact-date
.... extension:participant 0..* (Complex) Who or what is participating
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-participant
..... Slices for extension Content/Rules for all slices
...... extension:function 0..1 Extension Extension
....... extension 0..0
....... url 1..1 uri "function"
....... value[x] 0..1 Coding Value of extension
Binding: Material Registration Participant Function (required)
...... extension:actor 0..1 Extension The participant
....... extension 0..0
....... url 1..1 uri "actor"
...... extension:actorref 0..1 Extension The participant ref (string)
....... extension 0..0
....... url 1..1 uri "actorref"
..... url 1..1 uri "http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-participant"
.... extension:usage 0..1 string usage
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-usage
.... extension:version 0..1 string The current version
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-version
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... type Σ 0..1 CodeableConcept Kind of document (LOINC if possible)
Binding: EHealthDocumentReference Type (required)
... category Σ 0..1 CodeableConcept Categorization of document
Binding: Document Category (required)
... subject Σ 0..1 Reference(ehealth-patient | ehealth-practitioner | Group | ehealth-device) {r} Who/what is the subject of the document
... author Σ 0..* Reference(ehealth-practitioner | ehealth-organization | ehealth-device | ehealth-patient | ehealth-relatedperson) {r} Who and/or what authored the document
... authenticator 0..1 Reference(ehealth-practitioner | ehealth-organization) {r} Who/what authenticated the document
... custodian 0..1 Reference(ehealth-organization) {r} Organization which maintains the document
... content Σ 1..* BackboneElement Document referenced
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... attachment Σ 1..1 Attachment Where to access the document

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
DocumentReference.extension:participant.extension:function.value[x]requiredMaterialRegistrationParticipantFunction
http://ehealth.sundhed.dk/vs/material-registration-participant-function
From this IG
DocumentReference.statusrequiredDocumentReferenceStatus
http://hl7.org/fhir/ValueSet/document-reference-status|4.0.1
From the FHIR Standard
DocumentReference.typerequiredEHealthDocumentReferenceType
http://ehealth.sundhed.dk/vs/ehealth-document-reference-type
From this IG
DocumentReference.categoryrequiredDocumentCategory(a valid code from Material Category)
http://ehealth.sundhed.dk/vs/document-category
From this IG

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorDocumentReferenceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorDocumentReferenceIf 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-4errorDocumentReferenceIf 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-5errorDocumentReferenceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceDocumentReferenceA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
modifierRole-required-for-material-registrationerrorDocumentReference'ehealth-modifier-role' extension is required when category code is 'general-material' or 'patient-specific-material'
: category.coding.exists(system = 'http://ehealth.sundhed.dk/cs/material-category' and (code = 'general-material' or code = 'patient-specific-material')) implies extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-modifier-role').exists()

Differential View

This structure is derived from DocumentReference

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentReference C 0..* DocumentReference A reference to a document
Constraints: modifierRole-required-for-material-registration
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:useContext 0..* UsageContext The context that the content is intended to support
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-useContext
.... extension:modifierRole 0..* (Complex) Modifier role
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-modifier-role
.... extension:intendedOrganization 0..* Reference(ehealth-organization) {r} The organization intended to use this resource.
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-intendedOrganization
.... extension:artifactDate 0..1 dateTime Date last changed.
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-artifact-date
.... extension:participant 0..* (Complex) Who or what is participating
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-participant
..... Slices for extension Content/Rules for all slices
...... extension:function 0..1 Extension Extension
....... value[x] 0..1 Coding Value of extension
Binding: Material Registration Participant Function (required)
.... extension:usage 0..1 string usage
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-usage
.... extension:version 0..1 string The current version
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-version
... type 0..1 CodeableConcept Kind of document (LOINC if possible)
Binding: EHealthDocumentReference Type (required)
... category 0..1 CodeableConcept Categorization of document
Binding: Document Category (required)
... author 0..* Reference(ehealth-practitioner | ehealth-organization | ehealth-device | ehealth-patient | ehealth-relatedperson) {r} Who and/or what authored the document
... authenticator 0..1 Reference(ehealth-practitioner | ehealth-organization) {r} Who/what authenticated the document
... custodian 0..1 Reference(ehealth-organization) {r} Organization which maintains the document
... relatesTo
.... target 1..1 Reference(ehealth-documentreference) Target of the relationship
... context
.... encounter 0..* Reference(ehealth-episodeofcare) Context of the document content
.... event 0..0
.... facilityType 0..0
.... practiceSetting 0..0
.... sourcePatientInfo 0..1 Reference(ehealth-patient) Patient demographics from source

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
DocumentReference.extension:participant.extension:function.value[x]requiredMaterialRegistrationParticipantFunction
http://ehealth.sundhed.dk/vs/material-registration-participant-function
From this IG
DocumentReference.typerequiredEHealthDocumentReferenceType
http://ehealth.sundhed.dk/vs/ehealth-document-reference-type
From this IG
DocumentReference.categoryrequiredDocumentCategory(a valid code from Material Category)
http://ehealth.sundhed.dk/vs/document-category
From this IG

Constraints

IdGradePath(s)DetailsRequirements
modifierRole-required-for-material-registrationerrorDocumentReference'ehealth-modifier-role' extension is required when category code is 'general-material' or 'patient-specific-material'
: category.coding.exists(system = 'http://ehealth.sundhed.dk/cs/material-category' and (code = 'general-material' or code = 'patient-specific-material')) implies extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-modifier-role').exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentReference C 0..* DocumentReference A reference to a document
Constraints: modifierRole-required-for-material-registration
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... 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
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:useContext 0..* UsageContext The context that the content is intended to support
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-useContext
.... extension:modifierRole 0..* (Complex) Modifier role
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-modifier-role
.... extension:intendedOrganization 0..* Reference(ehealth-organization) {r} The organization intended to use this resource.
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-intendedOrganization
.... extension:artifactDate 0..1 dateTime Date last changed.
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-artifact-date
.... extension:participant 0..* (Complex) Who or what is participating
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-participant
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:function 0..1 Extension Extension
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "function"
....... value[x] 0..1 Coding Value of extension
Binding: Material Registration Participant Function (required)
...... extension:actor 0..1 Extension The participant
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "actor"
....... value[x] 0..1 Reference(CareTeam | Practitioner) {r} Value of extension
...... extension:actorref 0..1 Extension The participant ref (string)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "actorref"
....... value[x] 0..1 string Value of extension
..... url 1..1 uri "http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-participant"
.... extension:usage 0..1 string usage
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-usage
.... extension:version 0..1 string The current version
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-version
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... masterIdentifier Σ 0..1 Identifier Master Version Specific Identifier
... identifier Σ 0..* Identifier Other identifiers for the document
... status ?!Σ 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 Σ 0..1 CodeableConcept Kind of document (LOINC if possible)
Binding: EHealthDocumentReference Type (required)
... category Σ 0..1 CodeableConcept Categorization of document
Binding: Document Category (required)
... subject Σ 0..1 Reference(ehealth-patient | ehealth-practitioner | Group | ehealth-device) {r} Who/what is the subject of the document
... date Σ 0..1 instant When this document reference was created
... author Σ 0..* Reference(ehealth-practitioner | ehealth-organization | ehealth-device | ehealth-patient | ehealth-relatedperson) {r} Who and/or what authored the document
... authenticator 0..1 Reference(ehealth-practitioner | ehealth-organization) {r} Who/what authenticated the document
... custodian 0..1 Reference(ehealth-organization) {r} Organization which maintains the document
... 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
.... 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 Σ 1..1 Reference(ehealth-documentreference) Target of the relationship
... description Σ 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 Σ 1..* BackboneElement Document referenced
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... attachment Σ 1..1 Attachment Where to access the document
.... 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
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... encounter 0..* Reference(ehealth-episodeofcare) Context of the document content
.... period Σ 0..1 Period Time of service that is being documented
.... sourcePatientInfo 0..1 Reference(ehealth-patient) Patient demographics from source
.... related 0..* Reference(Resource) Related identifiers or resources

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
DocumentReference.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages|4.0.1
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
DocumentReference.extension:participant.extension:function.value[x]requiredMaterialRegistrationParticipantFunction
http://ehealth.sundhed.dk/vs/material-registration-participant-function
From this IG
DocumentReference.statusrequiredDocumentReferenceStatus
http://hl7.org/fhir/ValueSet/document-reference-status|4.0.1
From the FHIR Standard
DocumentReference.docStatusrequiredCompositionStatus
http://hl7.org/fhir/ValueSet/composition-status|4.0.1
From the FHIR Standard
DocumentReference.typerequiredEHealthDocumentReferenceType
http://ehealth.sundhed.dk/vs/ehealth-document-reference-type
From this IG
DocumentReference.categoryrequiredDocumentCategory(a valid code from Material Category)
http://ehealth.sundhed.dk/vs/document-category
From this IG
DocumentReference.relatesTo.coderequiredDocumentRelationshipType
http://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1
From the FHIR Standard
DocumentReference.securityLabelextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels|4.0.1
From the FHIR Standard
DocumentReference.content.formatpreferredDocumentReferenceFormatCodeSet(a valid code from http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem)
http://hl7.org/fhir/ValueSet/formatcodes|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorDocumentReferenceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorDocumentReferenceIf 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-4errorDocumentReferenceIf 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-5errorDocumentReferenceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceDocumentReferenceA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
modifierRole-required-for-material-registrationerrorDocumentReference'ehealth-modifier-role' extension is required when category code is 'general-material' or 'patient-specific-material'
: category.coding.exists(system = 'http://ehealth.sundhed.dk/cs/material-category' and (code = 'general-material' or code = 'patient-specific-material')) implies extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-modifier-role').exists()

 

Other representations of profile: CSV, Excel, Schematron