eHealth Infrastructure
3.3.0 - ci-build
eHealth Infrastructure
3.3.0 - ci-build
eHealth Infrastructure, published by Den telemedicinske infrastruktur (eHealth Infrastructure). This guide is not an authorized publication; it is the continuous build for version 3.3.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
| Official URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-documentreference | Version: 3.3.0 | |||
| Active as of 2024-12-20 | 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.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from DocumentReference
| Path | Conformance | ValueSet | URI |
| 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 | |
| DocumentReference.context.event | required | EventTypeCodeshttp://ehealth.sundhed.dk/vs/event-type-codesfrom this IG | |
| DocumentReference.context.facilityType | required | FacilityTypeCodeshttp://ehealth.sundhed.dk/vs/facility-type-codesfrom this IG | |
| DocumentReference.context.practiceSetting | required | PracticeSettingCodeshttp://ehealth.sundhed.dk/vs/practice-setting-codesfrom this IG |
| 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 | |
   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 | |
 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 |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| DocumentReference |
0..* | DocumentReference | A reference to a document | |||||
| 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 | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| manuallyDeprecated |
0..1 | boolean | Ehealth Document manually deprecated URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-manuallydeprecated-type | |||||
| 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: Document Type (required) | ||||
| category |
Σ | 0..1 | CodeableConcept | Categorization of document Binding: Document Class (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: FormatCodes (required) | ||||
| context |
Σ | 0..1 | BackboneElement | Clinical context of document | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| encounter |
0..* | Reference(Encounter | EpisodeOfCare) | Context of the document content | |||||
| event |
0..* | CodeableConcept | Main clinical acts documented Binding: Event Type Codes (required) | |||||
| period |
Σ | 0..1 | Period | Time of service that is being documented | ||||
| facilityType |
0..1 | CodeableConcept | Kind of facility where patient was seen Binding: Facility Type Codes (required) | |||||
| practiceSetting |
0..1 | CodeableConcept | Additional details about where the content was created (e.g. clinical specialty) Binding: Practice Setting Codes (required) | |||||
| sourcePatientInfo |
0..1 | Reference(ehealth-patient) | Patient demographics from source | |||||
| related |
0..* | Reference(Resource) | Related identifiers or resources | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| DocumentReference.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| DocumentReference.status | required | DocumentReferenceStatushttp://hl7.org/fhir/ValueSet/document-reference-status|4.0.1from the FHIR Standard | ||||
| DocumentReference.docStatus | required | CompositionStatushttp://hl7.org/fhir/ValueSet/composition-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.relatesTo.code | required | DocumentRelationshipTypehttp://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1from the FHIR Standard | ||||
| DocumentReference.securityLabel | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard | ||||
| DocumentReference.content.format | required | FormatCodeshttp://ehealth.sundhed.dk/vs/format-codesfrom this IG | ||||
| DocumentReference.context.event | required | EventTypeCodeshttp://ehealth.sundhed.dk/vs/event-type-codesfrom this IG | ||||
| DocumentReference.context.facilityType | required | FacilityTypeCodeshttp://ehealth.sundhed.dk/vs/facility-type-codesfrom this IG | ||||
| DocumentReference.context.practiceSetting | required | PracticeSettingCodeshttp://ehealth.sundhed.dk/vs/practice-setting-codesfrom this IG |
This structure is derived from DocumentReference
Summary
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from DocumentReference
| Path | Conformance | ValueSet | URI |
| 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 | |
| DocumentReference.context.event | required | EventTypeCodeshttp://ehealth.sundhed.dk/vs/event-type-codesfrom this IG | |
| DocumentReference.context.facilityType | required | FacilityTypeCodeshttp://ehealth.sundhed.dk/vs/facility-type-codesfrom this IG | |
| DocumentReference.context.practiceSetting | required | PracticeSettingCodeshttp://ehealth.sundhed.dk/vs/practice-setting-codesfrom this IG |
Key Elements View
| 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 | |
| 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 | |
| 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 |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| DocumentReference |
0..* | DocumentReference | A reference to a document | |||||
| 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 | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| manuallyDeprecated |
0..1 | boolean | Ehealth Document manually deprecated URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-manuallydeprecated-type | |||||
| 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: Document Type (required) | ||||
| category |
Σ | 0..1 | CodeableConcept | Categorization of document Binding: Document Class (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: FormatCodes (required) | ||||
| context |
Σ | 0..1 | BackboneElement | Clinical context of document | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| encounter |
0..* | Reference(Encounter | EpisodeOfCare) | Context of the document content | |||||
| event |
0..* | CodeableConcept | Main clinical acts documented Binding: Event Type Codes (required) | |||||
| period |
Σ | 0..1 | Period | Time of service that is being documented | ||||
| facilityType |
0..1 | CodeableConcept | Kind of facility where patient was seen Binding: Facility Type Codes (required) | |||||
| practiceSetting |
0..1 | CodeableConcept | Additional details about where the content was created (e.g. clinical specialty) Binding: Practice Setting Codes (required) | |||||
| sourcePatientInfo |
0..1 | Reference(ehealth-patient) | Patient demographics from source | |||||
| related |
0..* | Reference(Resource) | Related identifiers or resources | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| DocumentReference.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| DocumentReference.status | required | DocumentReferenceStatushttp://hl7.org/fhir/ValueSet/document-reference-status|4.0.1from the FHIR Standard | ||||
| DocumentReference.docStatus | required | CompositionStatushttp://hl7.org/fhir/ValueSet/composition-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.relatesTo.code | required | DocumentRelationshipTypehttp://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1from the FHIR Standard | ||||
| DocumentReference.securityLabel | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard | ||||
| DocumentReference.content.format | required | FormatCodeshttp://ehealth.sundhed.dk/vs/format-codesfrom this IG | ||||
| DocumentReference.context.event | required | EventTypeCodeshttp://ehealth.sundhed.dk/vs/event-type-codesfrom this IG | ||||
| DocumentReference.context.facilityType | required | FacilityTypeCodeshttp://ehealth.sundhed.dk/vs/facility-type-codesfrom this IG | ||||
| DocumentReference.context.practiceSetting | required | PracticeSettingCodeshttp://ehealth.sundhed.dk/vs/practice-setting-codesfrom this IG |
This structure is derived from DocumentReference
Summary
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Other representations of profile: CSV, Excel, Schematron
IG © 2021+ Den telemedicinske infrastruktur (eHealth Infrastructure). Package dk.ehealth.sundhed.fhir.ig.core#3.3.0 based on FHIR 4.0.1. Generated 2024-12-20
