EU Imaging Report R4
1.0.0-ballot - ci-build
150
EU Imaging Report R4
1.0.0-ballot - ci-build
150
EU Imaging Report R4, published by HL7 Europe. This guide is not an authorized publication; it is the continuous build for version 1.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-eu/imaging-r4/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.eu/fhir/imaging/StructureDefinition/DocumentReferenceImagingReport | Version: 1.0.0-ballot | ||||
| Standards status: Draft | Maturity Level: 1 | Computable Name: DocumentReferenceImagingReport | |||
Copyright/Legal: Copyright HL7 Europe. Licensed under Creative Commons public domain (CC0 1.0). |
|||||
Profile for DocumentReference resources used in the EEHRxF context, based on the IHE MHD Minimal DocumentReference profile. This profile is used for the DocumentReference resources that represent imaging reports in the EEHRxF context. It includes additional constraints and extensions specific to imaging reports, such as the type of report, the clinical specialty, the anatomical region of interest and the profile of the imaging report.
Usages:
You can also check for usages in the FHIR IG Statistics
Description Differentials, Snapshots, and other representations.
| Name | Flags | Card. | Type | Description & Constraints Filter:  | ||||
|---|---|---|---|---|---|---|---|---|
  DocumentReference |
0..* | EehrxfMhdDocumentReference | A reference to a document | |||||
  implicitRules |
0..1 | uri | A set of rules under which this content was created | |||||
  Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
   extension:version |
0..1 | string | Version of the document referenced by this DocumentReference. URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.version Constraints: ext-1 | |||||
 extension:bodysite |
0..* | (Complex) | The anatomical region of the patient that is the focus of the imaging manifest, concept field is required. URL: https://profiles.ihe.net/RAD/MADO/StructureDefinition/ext-R5-DocumentReference.bodySite | |||||
  extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
| url |
1..1 | uri | "https://profiles.ihe.net/RAD/MADO/StructureDefinition/ext-R5-DocumentReference.bodySite" | |||||
  value[x] |
0..1 | CodeableConcept | Value of extension Binding: ValueSet: Anatomical Region (extensible) | |||||
 extension:modality |
1..* | CodeableConcept | Extension: DocumentReference.modality (R5 cross-version) URL: https://profiles.ihe.net/RAD/MADO/StructureDefinition/ext-R5-DocumentReference.modality | |||||
| masterIdentifier |
1..1 | UniqueIdIdentifier  |
Master Version Specific Identifier | |||||
 Slices for identifier |
0..* | Identifier | Other identifiers for the document Slice: Unordered, Open by value:use Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| identifier:entryUUID |
0..* | EntryUUIDIdentifier |
Other identifiers for the document | |||||
| status |
1..1 | code | current | superseded | entered-in-error Binding: MHD DocumentReference status codes (required) | |||||
| type |
1..1 | CodeableConcept | Type of Imaging Diagnostic Report Binding: EEHRxF Document Type ValueSet (preferred) | |||||
 Slices for coding |
1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
  coding:imaging-report |
1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
 system |
1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 85430-7 | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| category |
1..1 | CodeableConcept | Categorization of document Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level. | |||||
| Slices for coding |
1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| coding:priority-area |
1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.eu/fhir/health-data-api/CodeSystem/eehrxf-document-priority-category-cs | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: Medical-Imaging | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
 subject |
1..1 | Reference(Patient (EU core)) | Who/what is the subject of the document | |||||
| date |
1..1 | instant | When this document reference was created | |||||
| author |
0..* | Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) | Who and/or what authored the document | |||||
| custodian |
1..1 | Reference(Organization (EU core)) | Organization that manages the Imaging Report | |||||
| relatesTo |
0..* | BackboneElement | Relationships to other documents | |||||
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| code |
1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. | |||||
 target |
1..1 | Reference(DocumentReference) | Target of the relationship | |||||
| securityLabel |
0..* | CodeableConcept | Document security-tags Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | |||||
| content |
1..1 | BackboneElement | Document referenced | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| extension:profile |
1..* | canonical() | Contains the profile of the referred report URL: http://hl7.eu/fhir/imaging/StructureDefinition/im-documentreference-content-profile | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| attachment |
1..1 | Attachment | Where to access the document | |||||
| contentType |
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. Example General: text/plain; charset=UTF-8, image/png | |||||
| language |
0..1 | code | Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language.
Example General: en-AU | |||||
| url |
1..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png | |||||
| creation |
0..1 | dateTime | Date attachment was first created | |||||
| format |
0..1 | Coding | Format/content rules for the document Binding: IHE ValueSet of Format Codes for use with Document Sharing (preferred) | |||||
| context |
0..1 | BackboneElement | Clinical context of document | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| period |
0..1 | Period | Time of service that is being documented | |||||
| facilityType |
0..1 | CodeableConcept | Kind of facility where patient was seen Binding: FacilityTypeCodeValueSet (example): XDS Facility Type. | |||||
| practiceSetting |
0..1 | CodeableConcept | Clinical specialty (e.g., radiology, laboratory) - SHOULD be used for lab vs imaging differentiation Binding: PracticeSettingCodeValueSet (example): Additional details about where the content was created (e.g. clinical specialty). | |||||
| sourcePatientInfo |
0..1 | Reference(Patient) | Patient demographics from source | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| DocumentReference.extension:bodysite.value[x] | Base | extensible | ValueSet: Anatomical Region | 📦1.0.0-ballot | This IG |
| DocumentReference.status | Base | required | MHD DocumentReference status codes | 📦4.2.3 | Mobile access to Health Documents v4.2 |
| DocumentReference.type | Base | preferred | EEHRxF Document Type ValueSet | 📦1.0.0-ballot | EU Health Data API v1.0 |
| DocumentReference.category | Base | example | Document Class Value Set | 📍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 | IHE ValueSet of Format Codes for use with Document Sharing | 📦1.5.0 | IHE FormatCode Vocabulary v1.5 |
| 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. |
| Id | Grade | Path(s) | Description | Expression |
| 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()
|
This structure is derived from EehrxfMhdDocumentReference
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| DocumentReference |
0..* | EehrxfMhdDocumentReference | A reference to a document | |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| extension:version |
0..1 | string | Version of the document referenced by this DocumentReference. URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.version | |
| extension:bodysite |
0..* | (Complex) | The anatomical region of the patient that is the focus of the imaging manifest, concept field is required. URL: https://profiles.ihe.net/RAD/MADO/StructureDefinition/ext-R5-DocumentReference.bodySite | |
 value[x] |
0..1 | CodeableConcept | Value of extension Binding: ValueSet: Anatomical Region (extensible) | |
| extension:modality |
1..* | CodeableConcept | Extension: DocumentReference.modality (R5 cross-version) URL: https://profiles.ihe.net/RAD/MADO/StructureDefinition/ext-R5-DocumentReference.modality | |
| type |
1..1 | CodeableConcept | Type of Imaging Diagnostic Report | |
| Slices for coding |
1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| coding:imaging-report |
1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 85430-7 | |
| category |
1..1 | CodeableConcept | Categorization of document | |
| Slices for coding |
1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| coding:priority-area |
1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.eu/fhir/health-data-api/CodeSystem/eehrxf-document-priority-category-cs | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: Medical-Imaging | |
| custodian |
1..1 | Reference(Organization (EU core)) | Organization that manages the Imaging Report | |
| content |
||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| extension:profile |
1..* | canonical() | Contains the profile of the referred report URL: http://hl7.eu/fhir/imaging/StructureDefinition/im-documentreference-content-profile | |
| context |
||||
| practiceSetting |
0..1 | CodeableConcept | Clinical specialty (e.g., radiology, laboratory) - SHOULD be used for lab vs imaging differentiation | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| DocumentReference.extension:bodysite.value[x] | Base | extensible | ValueSet: Anatomical Region | 📦1.0.0-ballot | This IG |
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| DocumentReference |
0..* | EehrxfMhdDocumentReference | A reference to a document | |||||
| id |
0..1 | id | Logical id of this artifact | |||||
| meta |
0..1 | Meta | Metadata about the resource | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| versionId |
0..1 | id | Version specific identifier | |||||
| lastUpdated |
0..1 | instant | When the resource version last changed | |||||
| source |
0..1 | uri | Identifies where the resource comes from | |||||
| profile |
0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | |||||
| security |
0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | |||||
| tag |
0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | |||||
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |||||
| 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 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 |
1..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| extension:version |
0..1 | string | Version of the document referenced by this DocumentReference. URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.version Constraints: ext-1 | |||||
| extension:bodysite |
0..* | (Complex) | The anatomical region of the patient that is the focus of the imaging manifest, concept field is required. URL: https://profiles.ihe.net/RAD/MADO/StructureDefinition/ext-R5-DocumentReference.bodySite | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
| url |
1..1 | uri | "https://profiles.ihe.net/RAD/MADO/StructureDefinition/ext-R5-DocumentReference.bodySite" | |||||
| value[x] |
0..1 | CodeableConcept | Value of extension Binding: ValueSet: Anatomical Region (extensible) | |||||
| extension:modality |
1..* | CodeableConcept | Extension: DocumentReference.modality (R5 cross-version) URL: https://profiles.ihe.net/RAD/MADO/StructureDefinition/ext-R5-DocumentReference.modality | |||||
| masterIdentifier |
1..1 | UniqueIdIdentifier |
Master Version Specific Identifier | |||||
| Slices for identifier |
0..* | Identifier | Other identifiers for the document Slice: Unordered, Open by value:use Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| identifier:entryUUID |
0..* | EntryUUIDIdentifier |
Other identifiers for the document | |||||
| status |
1..1 | code | current | superseded | entered-in-error Binding: MHD DocumentReference status codes (required) | |||||
| type |
1..1 | CodeableConcept | Type of Imaging Diagnostic Report Binding: EEHRxF Document Type ValueSet (preferred) | |||||
| 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 |
1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| coding:imaging-report |
1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 85430-7 | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| category |
1..1 | 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 |
1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| coding:priority-area |
1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.eu/fhir/health-data-api/CodeSystem/eehrxf-document-priority-category-cs | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: Medical-Imaging | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| subject |
1..1 | Reference(Patient (EU core)) | Who/what is the subject of the document | |||||
| date |
1..1 | instant | When this document reference was created | |||||
| author |
0..* | Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) | Who and/or what authored the document | |||||
| authenticator |
0..1 | Reference(Practitioner | PractitionerRole | Organization) | Who/what authenticated the document | |||||
| custodian |
1..1 | Reference(Organization (EU core)) | Organization that manages the Imaging Report | |||||
| 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(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..1 | BackboneElement | Document referenced | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| extension:profile |
1..* | canonical() | Contains the profile of the referred report URL: http://hl7.eu/fhir/imaging/StructureDefinition/im-documentreference-content-profile | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| attachment |
1..1 | Attachment | Where to access the 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 | |||||
| contentType |
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. Example General: text/plain; charset=UTF-8, image/png | |||||
| language |
0..1 | code | Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language.
Example General: en-AU | |||||
| url |
1..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png | |||||
| size |
0..1 | unsignedInt | Number of bytes of content (if url provided) | |||||
| hash |
0..1 | base64Binary | Hash of the data (sha-1, base64ed) | |||||
| title |
0..1 | string | Label to display in place of the data Example General: Official Corporate Logo | |||||
| creation |
0..1 | dateTime | Date attachment was first created | |||||
| format |
0..1 | Coding | Format/content rules for the document Binding: IHE ValueSet of Format Codes for use with Document Sharing (preferred) | |||||
| 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: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented. | |||||
| period |
0..1 | Period | Time of service that is being documented | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| start |
C | 0..1 | dateTime | Starting time with inclusive boundary | ||||
| end |
C | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
| facilityType |
0..1 | CodeableConcept | Kind of facility where patient was seen Binding: FacilityTypeCodeValueSet (example): XDS Facility Type. | |||||
| practiceSetting |
0..1 | CodeableConcept | Clinical specialty (e.g., radiology, laboratory) - SHOULD be used for lab vs imaging differentiation Binding: PracticeSettingCodeValueSet (example): Additional details about where the content was created (e.g. clinical specialty). | |||||
| sourcePatientInfo |
0..1 | Reference(Patient) | Patient demographics from source | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | |||||
| identifier |
0..1 | Identifier | Logical reference, when literal reference is not known | |||||
| display |
0..1 | string | Text alternative for the resource | |||||
| related |
0..* | Reference(Resource) | Related identifiers or resources | |||||
| Documentation for this format | ||||||||
| 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.extension:bodysite.value[x] | Base | extensible | ValueSet: Anatomical Region | 📦1.0.0-ballot | This IG |
| DocumentReference.status | Base | required | MHD DocumentReference status codes | 📦4.2.3 | Mobile access to Health Documents v4.2 |
| DocumentReference.type | Base | preferred | EEHRxF Document Type ValueSet | 📦1.0.0-ballot | EU Health Data API v1.0 |
| DocumentReference.category | Base | example | Document Class Value Set | 📍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 | IHE ValueSet of Format Codes for use with Document Sharing | 📦1.5.0 | IHE FormatCode Vocabulary v1.5 |
| 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. |
| DocumentReference.context.sourcePatientInfo.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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()
|
This structure is derived from EehrxfMhdDocumentReference
Summary
Mandatory: 10 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Maturity: 1
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| DocumentReference |
0..* | EehrxfMhdDocumentReference | A reference to a document | |||||
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| extension:version |
0..1 | string | Version of the document referenced by this DocumentReference. URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.version Constraints: ext-1 | |||||
| extension:bodysite |
0..* | (Complex) | The anatomical region of the patient that is the focus of the imaging manifest, concept field is required. URL: https://profiles.ihe.net/RAD/MADO/StructureDefinition/ext-R5-DocumentReference.bodySite | |||||
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
| url |
1..1 | uri | "https://profiles.ihe.net/RAD/MADO/StructureDefinition/ext-R5-DocumentReference.bodySite" | |||||
| value[x] |
0..1 | CodeableConcept | Value of extension Binding: ValueSet: Anatomical Region (extensible) | |||||
| extension:modality |
1..* | CodeableConcept | Extension: DocumentReference.modality (R5 cross-version) URL: https://profiles.ihe.net/RAD/MADO/StructureDefinition/ext-R5-DocumentReference.modality | |||||
| masterIdentifier |
1..1 | UniqueIdIdentifier |
Master Version Specific Identifier | |||||
| Slices for identifier |
0..* | Identifier | Other identifiers for the document Slice: Unordered, Open by value:use Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| identifier:entryUUID |
0..* | EntryUUIDIdentifier |
Other identifiers for the document | |||||
| status |
1..1 | code | current | superseded | entered-in-error Binding: MHD DocumentReference status codes (required) | |||||
| type |
1..1 | CodeableConcept | Type of Imaging Diagnostic Report Binding: EEHRxF Document Type ValueSet (preferred) | |||||
| Slices for coding |
1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| coding:imaging-report |
1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 85430-7 | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| category |
1..1 | CodeableConcept | Categorization of document Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level. | |||||
| Slices for coding |
1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| coding:priority-area |
1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.eu/fhir/health-data-api/CodeSystem/eehrxf-document-priority-category-cs | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: Medical-Imaging | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| subject |
1..1 | Reference(Patient (EU core)) | Who/what is the subject of the document | |||||
| date |
1..1 | instant | When this document reference was created | |||||
| author |
0..* | Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) | Who and/or what authored the document | |||||
| custodian |
1..1 | Reference(Organization (EU core)) | Organization that manages the Imaging Report | |||||
| relatesTo |
0..* | BackboneElement | Relationships to other documents | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| code |
1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. | |||||
| target |
1..1 | Reference(DocumentReference) | Target of the relationship | |||||
| securityLabel |
0..* | CodeableConcept | Document security-tags Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | |||||
| content |
1..1 | BackboneElement | Document referenced | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| extension:profile |
1..* | canonical() | Contains the profile of the referred report URL: http://hl7.eu/fhir/imaging/StructureDefinition/im-documentreference-content-profile | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| attachment |
1..1 | Attachment | Where to access the document | |||||
| contentType |
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. Example General: text/plain; charset=UTF-8, image/png | |||||
| language |
0..1 | code | Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language.
Example General: en-AU | |||||
| url |
1..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png | |||||
| creation |
0..1 | dateTime | Date attachment was first created | |||||
| format |
0..1 | Coding | Format/content rules for the document Binding: IHE ValueSet of Format Codes for use with Document Sharing (preferred) | |||||
| context |
0..1 | BackboneElement | Clinical context of document | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| period |
0..1 | Period | Time of service that is being documented | |||||
| facilityType |
0..1 | CodeableConcept | Kind of facility where patient was seen Binding: FacilityTypeCodeValueSet (example): XDS Facility Type. | |||||
| practiceSetting |
0..1 | CodeableConcept | Clinical specialty (e.g., radiology, laboratory) - SHOULD be used for lab vs imaging differentiation Binding: PracticeSettingCodeValueSet (example): Additional details about where the content was created (e.g. clinical specialty). | |||||
| sourcePatientInfo |
0..1 | Reference(Patient) | Patient demographics from source | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| DocumentReference.extension:bodysite.value[x] | Base | extensible | ValueSet: Anatomical Region | 📦1.0.0-ballot | This IG |
| DocumentReference.status | Base | required | MHD DocumentReference status codes | 📦4.2.3 | Mobile access to Health Documents v4.2 |
| DocumentReference.type | Base | preferred | EEHRxF Document Type ValueSet | 📦1.0.0-ballot | EU Health Data API v1.0 |
| DocumentReference.category | Base | example | Document Class Value Set | 📍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 | IHE ValueSet of Format Codes for use with Document Sharing | 📦1.5.0 | IHE FormatCode Vocabulary v1.5 |
| 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. |
| Id | Grade | Path(s) | Description | Expression |
| 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()
|
Differential View
This structure is derived from EehrxfMhdDocumentReference
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| DocumentReference |
0..* | EehrxfMhdDocumentReference | A reference to a document | |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| extension:version |
0..1 | string | Version of the document referenced by this DocumentReference. URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.version | |
| extension:bodysite |
0..* | (Complex) | The anatomical region of the patient that is the focus of the imaging manifest, concept field is required. URL: https://profiles.ihe.net/RAD/MADO/StructureDefinition/ext-R5-DocumentReference.bodySite | |
| value[x] |
0..1 | CodeableConcept | Value of extension Binding: ValueSet: Anatomical Region (extensible) | |
| extension:modality |
1..* | CodeableConcept | Extension: DocumentReference.modality (R5 cross-version) URL: https://profiles.ihe.net/RAD/MADO/StructureDefinition/ext-R5-DocumentReference.modality | |
| type |
1..1 | CodeableConcept | Type of Imaging Diagnostic Report | |
| Slices for coding |
1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| coding:imaging-report |
1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 85430-7 | |
| category |
1..1 | CodeableConcept | Categorization of document | |
| Slices for coding |
1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| coding:priority-area |
1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.eu/fhir/health-data-api/CodeSystem/eehrxf-document-priority-category-cs | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: Medical-Imaging | |
| custodian |
1..1 | Reference(Organization (EU core)) | Organization that manages the Imaging Report | |
| content |
||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| extension:profile |
1..* | canonical() | Contains the profile of the referred report URL: http://hl7.eu/fhir/imaging/StructureDefinition/im-documentreference-content-profile | |
| context |
||||
| practiceSetting |
0..1 | CodeableConcept | Clinical specialty (e.g., radiology, laboratory) - SHOULD be used for lab vs imaging differentiation | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| DocumentReference.extension:bodysite.value[x] | Base | extensible | ValueSet: Anatomical Region | 📦1.0.0-ballot | This IG |
Snapshot ViewView
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| DocumentReference |
0..* | EehrxfMhdDocumentReference | A reference to a document | |||||
| id |
0..1 | id | Logical id of this artifact | |||||
| meta |
0..1 | Meta | Metadata about the resource | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| versionId |
0..1 | id | Version specific identifier | |||||
| lastUpdated |
0..1 | instant | When the resource version last changed | |||||
| source |
0..1 | uri | Identifies where the resource comes from | |||||
| profile |
0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | |||||
| security |
0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | |||||
| tag |
0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | |||||
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |||||
| 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 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 |
1..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| extension:version |
0..1 | string | Version of the document referenced by this DocumentReference. URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.version Constraints: ext-1 | |||||
| extension:bodysite |
0..* | (Complex) | The anatomical region of the patient that is the focus of the imaging manifest, concept field is required. URL: https://profiles.ihe.net/RAD/MADO/StructureDefinition/ext-R5-DocumentReference.bodySite | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
| url |
1..1 | uri | "https://profiles.ihe.net/RAD/MADO/StructureDefinition/ext-R5-DocumentReference.bodySite" | |||||
| value[x] |
0..1 | CodeableConcept | Value of extension Binding: ValueSet: Anatomical Region (extensible) | |||||
| extension:modality |
1..* | CodeableConcept | Extension: DocumentReference.modality (R5 cross-version) URL: https://profiles.ihe.net/RAD/MADO/StructureDefinition/ext-R5-DocumentReference.modality | |||||
| masterIdentifier |
1..1 | UniqueIdIdentifier |
Master Version Specific Identifier | |||||
| Slices for identifier |
0..* | Identifier | Other identifiers for the document Slice: Unordered, Open by value:use Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| identifier:entryUUID |
0..* | EntryUUIDIdentifier |
Other identifiers for the document | |||||
| status |
1..1 | code | current | superseded | entered-in-error Binding: MHD DocumentReference status codes (required) | |||||
| type |
1..1 | CodeableConcept | Type of Imaging Diagnostic Report Binding: EEHRxF Document Type ValueSet (preferred) | |||||
| 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 |
1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| coding:imaging-report |
1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 85430-7 | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| category |
1..1 | 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 |
1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| coding:priority-area |
1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.eu/fhir/health-data-api/CodeSystem/eehrxf-document-priority-category-cs | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: Medical-Imaging | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| subject |
1..1 | Reference(Patient (EU core)) | Who/what is the subject of the document | |||||
| date |
1..1 | instant | When this document reference was created | |||||
| author |
0..* | Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) | Who and/or what authored the document | |||||
| authenticator |
0..1 | Reference(Practitioner | PractitionerRole | Organization) | Who/what authenticated the document | |||||
| custodian |
1..1 | Reference(Organization (EU core)) | Organization that manages the Imaging Report | |||||
| 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(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..1 | BackboneElement | Document referenced | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| extension:profile |
1..* | canonical() | Contains the profile of the referred report URL: http://hl7.eu/fhir/imaging/StructureDefinition/im-documentreference-content-profile | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| attachment |
1..1 | Attachment | Where to access the 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 | |||||
| contentType |
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. Example General: text/plain; charset=UTF-8, image/png | |||||
| language |
0..1 | code | Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language.
Example General: en-AU | |||||
| url |
1..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png | |||||
| size |
0..1 | unsignedInt | Number of bytes of content (if url provided) | |||||
| hash |
0..1 | base64Binary | Hash of the data (sha-1, base64ed) | |||||
| title |
0..1 | string | Label to display in place of the data Example General: Official Corporate Logo | |||||
| creation |
0..1 | dateTime | Date attachment was first created | |||||
| format |
0..1 | Coding | Format/content rules for the document Binding: IHE ValueSet of Format Codes for use with Document Sharing (preferred) | |||||
| 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: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented. | |||||
| period |
0..1 | Period | Time of service that is being documented | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| start |
C | 0..1 | dateTime | Starting time with inclusive boundary | ||||
| end |
C | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
| facilityType |
0..1 | CodeableConcept | Kind of facility where patient was seen Binding: FacilityTypeCodeValueSet (example): XDS Facility Type. | |||||
| practiceSetting |
0..1 | CodeableConcept | Clinical specialty (e.g., radiology, laboratory) - SHOULD be used for lab vs imaging differentiation Binding: PracticeSettingCodeValueSet (example): Additional details about where the content was created (e.g. clinical specialty). | |||||
| sourcePatientInfo |
0..1 | Reference(Patient) | Patient demographics from source | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | |||||
| identifier |
0..1 | Identifier | Logical reference, when literal reference is not known | |||||
| display |
0..1 | string | Text alternative for the resource | |||||
| related |
0..* | Reference(Resource) | Related identifiers or resources | |||||
| Documentation for this format | ||||||||
| 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.extension:bodysite.value[x] | Base | extensible | ValueSet: Anatomical Region | 📦1.0.0-ballot | This IG |
| DocumentReference.status | Base | required | MHD DocumentReference status codes | 📦4.2.3 | Mobile access to Health Documents v4.2 |
| DocumentReference.type | Base | preferred | EEHRxF Document Type ValueSet | 📦1.0.0-ballot | EU Health Data API v1.0 |
| DocumentReference.category | Base | example | Document Class Value Set | 📍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 | IHE ValueSet of Format Codes for use with Document Sharing | 📦1.5.0 | IHE FormatCode Vocabulary v1.5 |
| 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. |
| DocumentReference.context.sourcePatientInfo.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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()
|
This structure is derived from EehrxfMhdDocumentReference
Summary
Mandatory: 10 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Maturity: 1
Other representations of profile: CSV, Excel, Schematron
IG © 2025+ HL7 Europe.
Package hl7.fhir.eu.imaging#1.0.0-ballot based on FHIR 4.0.1.
Generated
2026-10-13
