eHealth Infrastructure
3.4.1 - release
eHealth Infrastructure
3.4.1 - release
eHealth Infrastructure, published by Den telemedicinske infrastruktur (eHealth Infrastructure). This guide is not an authorized publication; it is the continuous build for version 3.4.1 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
| Official URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-documentreference | Version: 3.4.1 | |||
| Active as of 2025-03-14 | Computable Name: ehealth-documentreference | |||
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:
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-typeehealth-useContext which defines the context that the content is intended to supportThe 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.
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.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  DocumentReference |
0..* | DocumentReference | A reference to a document dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
  Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
   extension:manuallyDeprecated |
0..1 | boolean | Ehealth Document manually deprecated URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-manuallydeprecated-type ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
 extension:useContext |
0..* | UsageContext | The context that the content is intended to support URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-useContext ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| status |
?!Σ | 1..1 | code | current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference. ele-1: All FHIR elements must have a @value or children |
 type |
Σ | 0..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: Document Type (required) ele-1: All FHIR elements must have a @value or children |
| category |
Σ | 0..1 | CodeableConcept | Categorization of document Binding: Document Class (required) ele-1: All FHIR elements must have a @value or children |
 subject |
Σ | 0..1 | Reference(ehealth-patient | ehealth-practitioner | Group | ehealth-device) {r} | Who/what is the subject of the document ele-1: All FHIR elements must have a @value or children |
| author |
Σ | 0..* | Reference(ehealth-practitioner | ehealth-organization | ehealth-device | ehealth-patient | ehealth-relatedperson) {r} | Who and/or what authored the document ele-1: All FHIR elements must have a @value or children |
| authenticator |
0..1 | Reference(ehealth-practitioner | ehealth-organization) {r} | Who/what authenticated the document ele-1: All FHIR elements must have a @value or children | |
| custodian |
0..1 | Reference(ehealth-organization) {r} | Organization which maintains the document ele-1: All FHIR elements must have a @value or children | |
 content |
Σ | 1..* | BackboneElement | Document referenced ele-1: All FHIR elements must have a @value or children |
 modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| attachment |
Σ | 1..1 | Attachment | Where to access the document ele-1: All FHIR elements must have a @value or children |
 format |
Σ | 0..1 | Coding | Format/content rules for the document Binding: FormatCodes (required) ele-1: All FHIR elements must have a @value or children |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| DocumentReference.status | required | DocumentReferenceStatushttp://hl7.org/fhir/ValueSet/document-reference-status|4.0.1from the FHIR Standard | |
| DocumentReference.type | required | DocumentTypehttp://ehealth.sundhed.dk/vs/document-typefrom this IG | |
| DocumentReference.category | required | DocumentClasshttp://ehealth.sundhed.dk/vs/document-classfrom this IG | |
| DocumentReference.content.format | required | FormatCodeshttp://ehealth.sundhed.dk/vs/format-codesfrom this IG |
Other representations of profile: CSV, Excel, Schematron
IG © 2021+ Den telemedicinske infrastruktur (eHealth Infrastructure). Package dk.ehealth.sundhed.fhir.ig.core#3.4.1 based on FHIR 4.0.1. Generated 2025-03-14
