EU Imaging Report R5, 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-r5/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/DocumentReferenceKeyImageEuImaging | Version: 1.0.0-ballot | ||||
| Standards status: Draft | Maturity Level: 1 | Computable Name: DocumentReferenceKeyImageEuImaging | |||
Copyright/Legal: Copyright HL7 Europe. Licensed under Creative Commons public domain (CC0 1.0). |
|||||
Represents a key image for a patient as image content in a DocumentReference. Use this profile to include or directly link the image (DICOM or non-DICOM); use ImagingSelectionKeyImageEuImaging when the key image is identified using DICOM selection data.
When referring to a DICOM image, the DocumentReference.content.attachment.url should be a WADO-URI. When referring to a non-DICOM image, the DocumentReference.content.attachment.url should be a direct URL to the image.
When the resource represents a DICOM artifact it SHALL contain the applicable DICOM identifier in the identifier element: the SOP Instance UID for a DICOM instance, the Series Instance UID for a DICOM series, and/or the Study Instance UID for a DICOM study. Such a resource MAY also reference an ImagingSelectionKeyImageEuImaging to indicate the DICOM source.
A key image is an image, or a specific frame within an image, that the imaging clinician has selected as particularly relevant to the report — for example an image that best demonstrates a finding, supports the impression, or is useful for comparison and follow-up. In radiology a study can contain hundreds or thousands of instances, so flagging key images helps the referring physician and other readers quickly locate the most significant images. In DICOM, key images are typically captured using a Key Object Selection (KOS) document, described by Key Object Selection, TID 2010 in DICOM PS3.16.
Key images can be represented either as image content or as a reference to DICOM selection data:
DocumentReference (DocumentReferenceKeyImageEuImaging) — the key image as image content.ImagingSelection (ImagingSelectionKeyImageEuImaging) — the key image identified using DICOM selection data.ImagingSelection is more DICOM oriented and relates to DICOM identifiers. DocumentReference represents the image content and contains information such as its size, format and duration. The eHN Imaging Studies and Reports guidelines requires information on the size, format and duration; these data elements are provided by the Attachment in DocumentReference.content.attachment.
This IG uses DocumentReference in R5 for image content, and ImagingSelection when the key image is identified using DICOM selection data (for example, to state that an image can come from a Procedure Phase).
The ImagingSelection resource points to DICOM data. The DICOM instance data also holds the data required by the eHN Imaging Studies and Reports, so the client can retrieve the information from the DICOM source data. Access to the imaging data can be direct or through a web based image viewer; a scenario supported by ImagingSelection requires access to the DICOM identifiers and a WADO endpoint.
DocumentReference resources refer to the image data directly, either by including it in the Attachment or by linking to it. The report may also refer to key images such as charts or PDFs that are not stored in a DICOM PACS; DocumentReference supports this case.
Key images can be represented by ImagingSelection or DocumentReference resources. When using DocumentReference to represent a DICOM artifact, it carries an identifier corresponding to the SOP instance, series or study it represents. In the case of ImagingSelection these values are represented as fields in the resource.
|
|
One or more DICOM identifier codes used by this profile come from the temporary MissingDicomTerminology CodeSystem and must be replaced with the equivalents defined by the DICOM terminology IG once it is published. |
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: ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | DocumentReference | A reference to a document Constraints: docRef-1, docRef-2 |
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |
![]() ![]() |
0..* | Resource | Contained, inline Resources | |
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored | |
![]() ![]() |
0..* | Identifier | Business identifiers for the document Slice: Unordered, Open by value:type Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
![]() ![]() ![]() |
0..1 | Identifier | Business identifiers for the document | |
![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://dicom.nema.org/resources/ontology/DCM | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 112002 | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |
![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | |
![]() ![]() ![]() ![]() |
C | 1..1 | string | The value that is unique Example General: 123456 |
![]() ![]() ![]() |
0..1 | Identifier | Business identifiers for the document | |
![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.eu/fhir/imaging-r5/CodeSystem/codesystem-missing-dicom-terminology | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 00080018 | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |
![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Required Pattern: urn:ietf:rfc:3986 | |
![]() ![]() ![]() ![]() |
C | 1..1 | string | The value that is unique Example General: 123456 |
![]() ![]() ![]() |
0..1 | Identifier | Business identifiers for the document | |
![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://dicom.nema.org/resources/ontology/DCM | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 110180 | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |
![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | |
![]() ![]() ![]() ![]() |
C | 1..1 | string | The value that is unique Example General: 123456 |
![]() ![]() |
0..* | Reference(Appointment | AppointmentResponse | CarePlan | Claim | CommunicationRequest | Contract | CoverageEligibilityRequest | DeviceRequest | EnrollmentRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | RequestOrchestration | ServiceRequest | SupplyRequest | VisionPrescription) | Procedure that caused this media to be created Slice: Unordered, Open by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
![]() ![]() ![]() |
0..1 | Reference(ServiceRequest: Imaging Order) | Procedure that caused this media to be created | |
![]() ![]() ![]() ![]() |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() ![]() ![]() |
C | 0..1 | AccessionNumberIdentifierEuImaging | Logical reference, when literal reference is not known |
![]() ![]() |
1..1 | code | current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference. | |
![]() ![]() |
1..1 | CodeableConcept | Imaging modality used Binding: Modality (extensible): Type of acquired data in the instance. | |
![]() ![]() |
0..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: Image Reference Type (preferred) | |
![]() ![]() |
1..* | CodeableConcept | Categorization of document Slice: Unordered, Open by profile:$this Binding: ReferencedItemCategoryValueSet (example): High-level kind of document at a macro level. Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
![]() ![]() ![]() |
1..1 | CodeableConcept | Categorization of document Binding: ReferencedItemCategoryValueSet (example): High-level kind of document at a macro level. | |
![]() ![]() ![]() ![]() |
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 | |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 55113-5 | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |
![]() ![]() |
1..1 | Reference(Patient (EU core)) | Who/what is the subject of the document | |
![]() ![]() |
C | 0..* | Reference(Appointment | Encounter | EpisodeOfCare) | Context of the document content |
![]() ![]() |
0..* | Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson | CareTeam) | Who and/or what authored the document Slice: Unordered, Open by profile:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
![]() ![]() ![]() |
0..* | Reference(PractitionerRole (EU core)) | Who and/or what authored the document | |
![]() ![]() |
1..* | BackboneElement | Document referenced Slice: Unordered, Open by value:extension.value Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() ![]() |
1..1 | Attachment | Where to access the document | |
![]() ![]() ![]() |
0..1 | BackboneElement | Document referenced | |
![]() ![]() ![]() ![]() |
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 | |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
1..1 | (Complex) | Thumbnail state URL: http://hl7.org/fhir/StructureDefinition/documentreference-thumbnail | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/documentreference-thumbnail" | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | boolean | Value of extension Required Pattern: true | |
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() ![]() |
1..1 | Attachment | Where to access the document | |
![]() ![]() ![]() |
1..1 | BackboneElement | Document referenced | |
![]() ![]() ![]() ![]() |
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 | |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
1..1 | (Complex) | Thumbnail state URL: http://hl7.org/fhir/StructureDefinition/documentreference-thumbnail | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/documentreference-thumbnail" | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | boolean | Value of extension Required Pattern: false | |
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() ![]() |
1..1 | Attachment | Where to access the document | |
![]() ![]() ![]() ![]() ![]() |
1..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| DocumentReference.identifier:seriesInstanceUid.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| DocumentReference.identifier:seriesInstanceUid.type | Base | extensible | Identifier Type Codes | 📍5.0.0 | FHIR Std. |
| DocumentReference.identifier:sopClassInstanceUid.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| DocumentReference.identifier:sopClassInstanceUid.type | Base | extensible | Identifier Type Codes | 📍5.0.0 | FHIR Std. |
| DocumentReference.identifier:studyInstanceUid.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| DocumentReference.identifier:studyInstanceUid.type | Base | extensible | Identifier Type Codes | 📍5.0.0 | FHIR Std. |
| DocumentReference.status | Base | required | DocumentReferenceStatus | 📍5.0.0 | FHIR Std. |
| DocumentReference.modality | Base | extensible | Modality | 📦2025.3.20250714 | DICOM v2025c |
| DocumentReference.type | Base | preferred | Image Reference Type | 📦1.0.0 | THO v7.1 |
| DocumentReference.category | Base | example | Referenced Item Category Value Set | 📍5.0.0 | FHIR Std. |
| DocumentReference.category:imkeyimages | Base | example | Referenced Item Category Value Set | 📍5.0.0 | 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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()
|
| docRef-1 | warning | DocumentReference | facilityType SHALL only be present if context is not an encounter |
facilityType.empty() or context.where(resolve() is Encounter).empty()
|
| docRef-2 | warning | DocumentReference | practiceSetting SHALL only be present if context is not present |
practiceSetting.empty() or context.where(resolve() is Encounter).empty()
|
| 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 DocumentReference
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
0..* | DocumentReference | A reference to a document | |
![]() ![]() |
0..* | Identifier | Business identifiers for the document Slice: Unordered, Open by value:type Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
![]() ![]() ![]() |
0..1 | Identifier | Business identifiers for the document | |
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Description of identifier Required Pattern: At least the following | |
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://dicom.nema.org/resources/ontology/DCM | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 112002 | |
![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value | |
![]() ![]() ![]() ![]() |
1..1 | string | The value that is unique | |
![]() ![]() ![]() |
0..1 | Identifier | Business identifiers for the document | |
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Description of identifier Required Pattern: At least the following | |
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.eu/fhir/imaging-r5/CodeSystem/codesystem-missing-dicom-terminology | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 00080018 | |
![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Required Pattern: urn:ietf:rfc:3986 | |
![]() ![]() ![]() ![]() |
1..1 | string | The value that is unique | |
![]() ![]() ![]() |
0..1 | Identifier | Business identifiers for the document | |
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Description of identifier Required Pattern: At least the following | |
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://dicom.nema.org/resources/ontology/DCM | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 110180 | |
![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value | |
![]() ![]() ![]() ![]() |
1..1 | string | The value that is unique | |
![]() ![]() |
0..* | Reference(Appointment | AppointmentResponse | CarePlan | Claim | CommunicationRequest | Contract | CoverageEligibilityRequest | DeviceRequest | EnrollmentRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | RequestOrchestration | ServiceRequest | SupplyRequest | VisionPrescription) | Procedure that caused this media to be created Slice: Unordered, Open by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
![]() ![]() ![]() |
0..1 | Reference(ServiceRequest: Imaging Order) | Procedure that caused this media to be created | |
![]() ![]() ![]() ![]() |
0..1 | AccessionNumberIdentifierEuImaging | Logical reference, when literal reference is not known | |
![]() ![]() |
1..1 | CodeableConcept | Imaging modality used | |
![]() ![]() |
0..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: Image Reference Type (preferred) | |
![]() ![]() |
1..* | CodeableConcept | Categorization of document Slice: Unordered, Open by profile:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
![]() ![]() ![]() |
1..1 | CodeableConcept | Categorization of document | |
![]() ![]() ![]() ![]() |
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 | |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 55113-5 | |
![]() ![]() |
1..1 | Reference(Patient (EU core)) | Who/what is the subject of the document | |
![]() ![]() |
0..* | Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson | CareTeam) | Who and/or what authored the document Slice: Unordered, Open by profile:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
![]() ![]() ![]() |
0..* | Reference(PractitionerRole (EU core)) | Who and/or what authored the document | |
![]() ![]() |
1..* | BackboneElement | Document referenced Slice: Unordered, Open by value:extension.value Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
![]() ![]() ![]() |
0..1 | BackboneElement | Document referenced | |
![]() ![]() ![]() ![]() |
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 | |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
1..1 | (Complex) | Thumbnail state URL: http://hl7.org/fhir/StructureDefinition/documentreference-thumbnail | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | boolean | Value of extension Required Pattern: true | |
![]() ![]() ![]() |
1..1 | BackboneElement | Document referenced | |
![]() ![]() ![]() ![]() |
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 | |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
1..1 | (Complex) | Thumbnail state URL: http://hl7.org/fhir/StructureDefinition/documentreference-thumbnail | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | boolean | Value of extension Required Pattern: false | |
![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() |
1..1 | url | Uri where the data can be found | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| DocumentReference.type | Base | preferred | Image Reference Type | 📦1.0.0 | THO v7.1 |
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | DocumentReference | A reference to a document Constraints: docRef-1, docRef-2 | ||||
![]() ![]() |
0..1 | id | Logical id of this artifact | |||||
![]() ![]() |
0..1 | Meta | Metadata about the resource | |||||
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
![]() ![]() |
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 | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored | |||||
![]() ![]() |
0..* | Identifier | Business identifiers for the document Slice: Unordered, Open by value:type Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
![]() ![]() ![]() |
0..1 | Identifier | Business identifiers for the document | |||||
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |||||
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://dicom.nema.org/resources/ontology/DCM | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 112002 | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||
![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | |||||
![]() ![]() ![]() ![]() |
C | 1..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
0..1 | Period | Time period when id is/was valid for use | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
![]() ![]() ![]() |
0..1 | Identifier | Business identifiers for the document | |||||
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |||||
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.eu/fhir/imaging-r5/CodeSystem/codesystem-missing-dicom-terminology | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 00080018 | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||
![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Required Pattern: urn:ietf:rfc:3986 | |||||
![]() ![]() ![]() ![]() |
C | 1..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
0..1 | Period | Time period when id is/was valid for use | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
![]() ![]() ![]() |
0..1 | Identifier | Business identifiers for the document | |||||
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |||||
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://dicom.nema.org/resources/ontology/DCM | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 110180 | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||
![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | |||||
![]() ![]() ![]() ![]() |
C | 1..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
0..1 | Period | Time period when id is/was valid for use | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
![]() ![]() |
0..1 | string | An explicitly assigned identifer of a variation of the content in the DocumentReference | |||||
![]() ![]() |
0..* | Reference(Appointment | AppointmentResponse | CarePlan | Claim | CommunicationRequest | Contract | CoverageEligibilityRequest | DeviceRequest | EnrollmentRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | RequestOrchestration | ServiceRequest | SupplyRequest | VisionPrescription) | Procedure that caused this media to be created Slice: Unordered, Open by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
![]() ![]() ![]() |
0..1 | Reference(ServiceRequest: Imaging Order) | Procedure that caused this media to be created | |||||
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() ![]() |
0..1 | uri | Type the reference refers to (e.g. "Patient") - must be a resource in resources Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | |||||
![]() ![]() ![]() ![]() |
C | 0..1 | AccessionNumberIdentifierEuImaging | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() ![]() |
C | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() |
1..1 | code | current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference. | |||||
![]() ![]() |
0..1 | code | registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown Binding: CompositionStatus (required): Status of the underlying document. | |||||
![]() ![]() |
1..1 | CodeableConcept | Imaging modality used Binding: Modality (extensible): Type of acquired data in the instance. | |||||
![]() ![]() |
0..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: Image Reference Type (preferred) | |||||
![]() ![]() |
1..* | CodeableConcept | Categorization of document Slice: Unordered, Open by profile:$this Binding: ReferencedItemCategoryValueSet (example): High-level kind of document at a macro level. Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
![]() ![]() ![]() |
1..1 | CodeableConcept | Categorization of document Binding: ReferencedItemCategoryValueSet (example): High-level kind of document at a macro level. | |||||
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 55113-5 | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||
![]() ![]() |
1..1 | Reference(Patient (EU core)) | Who/what is the subject of the document | |||||
![]() ![]() |
C | 0..* | Reference(Appointment | Encounter | EpisodeOfCare) | Context of the document content | ||||
![]() ![]() |
0..* | CodeableReference() | Main clinical acts documented Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented. | |||||
![]() ![]() |
0..* | CodeableReference(BodyStructure) | Body part included Binding: SNOMEDCTBodyStructures (example): SNOMED CT Body site concepts | |||||
![]() ![]() |
C | 0..1 | CodeableConcept | Kind of facility where patient was seen Binding: FacilityTypeCodeValueSet (example): XDS Facility Type. | ||||
![]() ![]() |
C | 0..1 | CodeableConcept | Additional details about where the content was created (e.g. clinical specialty) Binding: PracticeSettingCodeValueSet (example): Additional details about where the content was created (e.g. clinical specialty). | ||||
![]() ![]() |
0..1 | Period | Time of service that is being documented | |||||
![]() ![]() |
0..1 | instant | When this document reference was created | |||||
![]() ![]() |
0..* | Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson | CareTeam) | Who and/or what authored the document Slice: Unordered, Open by profile:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
![]() ![]() ![]() |
0..* | Reference(PractitionerRole (EU core)) | Who and/or what authored the document | |||||
![]() ![]() |
0..* | BackboneElement | Attests to accuracy of the document | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() |
1..1 | CodeableConcept | personal | professional | legal | official Binding: CompositionAttestationMode (preferred): The way in which a person authenticated a document. | |||||
![]() ![]() ![]() |
0..1 | dateTime | When the document was attested | |||||
![]() ![]() ![]() |
0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization) | Who attested the document | |||||
![]() ![]() |
0..1 | Reference(Organization) | Organization which maintains the document | |||||
![]() ![]() |
0..* | BackboneElement | Relationships to other documents | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() |
1..1 | CodeableConcept | The relationship type with another document Binding: DocumentRelationshipType (extensible): The type of relationship between the documents. | |||||
![]() ![]() ![]() |
1..1 | Reference(DocumentReference) | Target of the relationship | |||||
![]() ![]() |
0..1 | markdown | Human-readable description | |||||
![]() ![]() |
0..* | CodeableConcept | Document security-tags Binding: SecurityLabelExamples (example): Example Security Labels from the Healthcare Privacy and Security Classification System. | |||||
![]() ![]() |
1..* | BackboneElement | Document referenced Slice: Unordered, Open by value:extension.value Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() ![]() |
1..1 | Attachment | Where to access the document | |||||
![]() ![]() ![]() ![]() |
0..* | BackboneElement | Content profile rules for the document | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | Code|uri|canonical Binding: HL7 ValueSet of Format Codes for use with Document Sharing (preferred): Document Format Codes. | ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Coding | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
uri | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
canonical(Any) | |||||||
![]() ![]() ![]() |
0..1 | BackboneElement | Document referenced | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | (Complex) | Thumbnail state URL: http://hl7.org/fhir/StructureDefinition/documentreference-thumbnail | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/documentreference-thumbnail" | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | boolean | Value of extension Required Pattern: true | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() ![]() |
1..1 | Attachment | Where to access the document | |||||
![]() ![]() ![]() ![]() |
0..* | BackboneElement | Content profile rules for the document | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | Code|uri|canonical Binding: HL7 ValueSet of Format Codes for use with Document Sharing (preferred): Document Format Codes. | ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Coding | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
uri | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
canonical(Any) | |||||||
![]() ![]() ![]() |
1..1 | BackboneElement | Document referenced | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | (Complex) | Thumbnail state URL: http://hl7.org/fhir/StructureDefinition/documentreference-thumbnail | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/documentreference-thumbnail" | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | boolean | Value of extension Required Pattern: false | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() ![]() |
1..1 | Attachment | Where to access the document | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
C | 0..1 | code | Mime type of the content, with charset etc. Binding: MimeTypes (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049) Example General: text/plain; charset=UTF-8, image/png | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | code | Human language of the content (BCP-47) Binding: AllLanguages (required): IETF language tag for a human language.
Example General: en-AU | |||||
![]() ![]() ![]() ![]() ![]() |
C | 0..1 | base64Binary | Data inline, base64ed | ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | integer64 | Number of bytes of content (if url provided) | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | base64Binary | Hash of the data (sha-1, base64ed) | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Label to display in place of the data Example General: Official Corporate Logo | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | dateTime | Date attachment was first created | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | positiveInt | Height of the image in pixels (photo/video) | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | positiveInt | Width of the image in pixels (photo/video) | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | positiveInt | Number of frames if > 1 (photo) | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | decimal | Length in seconds (audio / video) | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | positiveInt | Number of printed pages | |||||
![]() ![]() ![]() ![]() |
0..* | BackboneElement | Content profile rules for the document | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | Code|uri|canonical Binding: HL7 ValueSet of Format Codes for use with Document Sharing (preferred): Document Format Codes. | ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Coding | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
uri | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
canonical(Any) | |||||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| DocumentReference.language | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
| DocumentReference.identifier:seriesInstanceUid.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| DocumentReference.identifier:seriesInstanceUid.type | Base | extensible | Identifier Type Codes | 📍5.0.0 | FHIR Std. |
| DocumentReference.identifier:sopClassInstanceUid.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| DocumentReference.identifier:sopClassInstanceUid.type | Base | extensible | Identifier Type Codes | 📍5.0.0 | FHIR Std. |
| DocumentReference.identifier:studyInstanceUid.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| DocumentReference.identifier:studyInstanceUid.type | Base | extensible | Identifier Type Codes | 📍5.0.0 | FHIR Std. |
| DocumentReference.basedOn:ServiceRequestOrderEuImagingaccession.type | Base | extensible | Resource Types | 📍5.0.0 | FHIR Std. |
| DocumentReference.status | Base | required | DocumentReferenceStatus | 📍5.0.0 | FHIR Std. |
| DocumentReference.docStatus | Base | required | Composition Status | 📍5.0.0 | FHIR Std. |
| DocumentReference.modality | Base | extensible | Modality | 📦2025.3.20250714 | DICOM v2025c |
| DocumentReference.type | Base | preferred | Image Reference Type | 📦1.0.0 | THO v7.1 |
| DocumentReference.category | Base | example | Referenced Item Category Value Set | 📍5.0.0 | FHIR Std. |
| DocumentReference.category:imkeyimages | Base | example | Referenced Item Category Value Set | 📍5.0.0 | FHIR Std. |
| DocumentReference.event | Base | example | v3 Code System ActCode | 📦3.0.0 | THO v7.1 |
| DocumentReference.bodySite | Base | example | SNOMED CT Body Structures | 📍5.0.0 | FHIR Std. |
| DocumentReference.facilityType | Base | example | Facility Type Code Value Set | 📍5.0.0 | FHIR Std. |
| DocumentReference.practiceSetting | Base | example | Practice Setting Code Value Set | 📍5.0.0 | FHIR Std. |
| DocumentReference.attester.mode | Base | preferred | Composition Attestation Mode | 📍5.0.0 | FHIR Std. |
| DocumentReference.relatesTo.code | Base | extensible | Document Relationship Type | 📍5.0.0 | FHIR Std. |
| DocumentReference.securityLabel | Base | example | Example set of Security Labels | 📍5.0.0 | FHIR Std. |
| DocumentReference.content.profile.value[x] | Base | preferred | HL7 ValueSet of Format Codes for use with Document Sharing | 📦2.1.0 | THO v7.1 |
| DocumentReference.content:thumbnail.profile.value[x] | Base | preferred | HL7 ValueSet of Format Codes for use with Document Sharing | 📦2.1.0 | THO v7.1 |
| DocumentReference.content:content.attachment.contentType | Base | required | Mime Types | 📍5.0.0 | FHIR Std. |
| DocumentReference.content:content.attachment.language | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
| DocumentReference.content:content.profile.value[x] | Base | preferred | HL7 ValueSet of Format Codes for use with Document Sharing | 📦2.1.0 | THO v7.1 |
| 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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()
|
| docRef-1 | warning | DocumentReference | facilityType SHALL only be present if context is not an encounter |
facilityType.empty() or context.where(resolve() is Encounter).empty()
|
| docRef-2 | warning | DocumentReference | practiceSetting SHALL only be present if context is not present |
practiceSetting.empty() or context.where(resolve() is Encounter).empty()
|
| 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 DocumentReference
Summary
Mandatory: 10 elements(11 nested mandatory 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: ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | DocumentReference | A reference to a document Constraints: docRef-1, docRef-2 |
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |
![]() ![]() |
0..* | Resource | Contained, inline Resources | |
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored | |
![]() ![]() |
0..* | Identifier | Business identifiers for the document Slice: Unordered, Open by value:type Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
![]() ![]() ![]() |
0..1 | Identifier | Business identifiers for the document | |
![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://dicom.nema.org/resources/ontology/DCM | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 112002 | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |
![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | |
![]() ![]() ![]() ![]() |
C | 1..1 | string | The value that is unique Example General: 123456 |
![]() ![]() ![]() |
0..1 | Identifier | Business identifiers for the document | |
![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.eu/fhir/imaging-r5/CodeSystem/codesystem-missing-dicom-terminology | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 00080018 | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |
![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Required Pattern: urn:ietf:rfc:3986 | |
![]() ![]() ![]() ![]() |
C | 1..1 | string | The value that is unique Example General: 123456 |
![]() ![]() ![]() |
0..1 | Identifier | Business identifiers for the document | |
![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://dicom.nema.org/resources/ontology/DCM | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 110180 | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |
![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | |
![]() ![]() ![]() ![]() |
C | 1..1 | string | The value that is unique Example General: 123456 |
![]() ![]() |
0..* | Reference(Appointment | AppointmentResponse | CarePlan | Claim | CommunicationRequest | Contract | CoverageEligibilityRequest | DeviceRequest | EnrollmentRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | RequestOrchestration | ServiceRequest | SupplyRequest | VisionPrescription) | Procedure that caused this media to be created Slice: Unordered, Open by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
![]() ![]() ![]() |
0..1 | Reference(ServiceRequest: Imaging Order) | Procedure that caused this media to be created | |
![]() ![]() ![]() ![]() |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() ![]() ![]() |
C | 0..1 | AccessionNumberIdentifierEuImaging | Logical reference, when literal reference is not known |
![]() ![]() |
1..1 | code | current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference. | |
![]() ![]() |
1..1 | CodeableConcept | Imaging modality used Binding: Modality (extensible): Type of acquired data in the instance. | |
![]() ![]() |
0..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: Image Reference Type (preferred) | |
![]() ![]() |
1..* | CodeableConcept | Categorization of document Slice: Unordered, Open by profile:$this Binding: ReferencedItemCategoryValueSet (example): High-level kind of document at a macro level. Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
![]() ![]() ![]() |
1..1 | CodeableConcept | Categorization of document Binding: ReferencedItemCategoryValueSet (example): High-level kind of document at a macro level. | |
![]() ![]() ![]() ![]() |
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 | |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 55113-5 | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |
![]() ![]() |
1..1 | Reference(Patient (EU core)) | Who/what is the subject of the document | |
![]() ![]() |
C | 0..* | Reference(Appointment | Encounter | EpisodeOfCare) | Context of the document content |
![]() ![]() |
0..* | Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson | CareTeam) | Who and/or what authored the document Slice: Unordered, Open by profile:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
![]() ![]() ![]() |
0..* | Reference(PractitionerRole (EU core)) | Who and/or what authored the document | |
![]() ![]() |
1..* | BackboneElement | Document referenced Slice: Unordered, Open by value:extension.value Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() ![]() |
1..1 | Attachment | Where to access the document | |
![]() ![]() ![]() |
0..1 | BackboneElement | Document referenced | |
![]() ![]() ![]() ![]() |
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 | |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
1..1 | (Complex) | Thumbnail state URL: http://hl7.org/fhir/StructureDefinition/documentreference-thumbnail | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/documentreference-thumbnail" | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | boolean | Value of extension Required Pattern: true | |
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() ![]() |
1..1 | Attachment | Where to access the document | |
![]() ![]() ![]() |
1..1 | BackboneElement | Document referenced | |
![]() ![]() ![]() ![]() |
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 | |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
1..1 | (Complex) | Thumbnail state URL: http://hl7.org/fhir/StructureDefinition/documentreference-thumbnail | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/documentreference-thumbnail" | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | boolean | Value of extension Required Pattern: false | |
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() ![]() |
1..1 | Attachment | Where to access the document | |
![]() ![]() ![]() ![]() ![]() |
1..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| DocumentReference.identifier:seriesInstanceUid.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| DocumentReference.identifier:seriesInstanceUid.type | Base | extensible | Identifier Type Codes | 📍5.0.0 | FHIR Std. |
| DocumentReference.identifier:sopClassInstanceUid.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| DocumentReference.identifier:sopClassInstanceUid.type | Base | extensible | Identifier Type Codes | 📍5.0.0 | FHIR Std. |
| DocumentReference.identifier:studyInstanceUid.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| DocumentReference.identifier:studyInstanceUid.type | Base | extensible | Identifier Type Codes | 📍5.0.0 | FHIR Std. |
| DocumentReference.status | Base | required | DocumentReferenceStatus | 📍5.0.0 | FHIR Std. |
| DocumentReference.modality | Base | extensible | Modality | 📦2025.3.20250714 | DICOM v2025c |
| DocumentReference.type | Base | preferred | Image Reference Type | 📦1.0.0 | THO v7.1 |
| DocumentReference.category | Base | example | Referenced Item Category Value Set | 📍5.0.0 | FHIR Std. |
| DocumentReference.category:imkeyimages | Base | example | Referenced Item Category Value Set | 📍5.0.0 | 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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()
|
| docRef-1 | warning | DocumentReference | facilityType SHALL only be present if context is not an encounter |
facilityType.empty() or context.where(resolve() is Encounter).empty()
|
| docRef-2 | warning | DocumentReference | practiceSetting SHALL only be present if context is not present |
practiceSetting.empty() or context.where(resolve() is Encounter).empty()
|
| 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 DocumentReference
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
0..* | DocumentReference | A reference to a document | |
![]() ![]() |
0..* | Identifier | Business identifiers for the document Slice: Unordered, Open by value:type Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
![]() ![]() ![]() |
0..1 | Identifier | Business identifiers for the document | |
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Description of identifier Required Pattern: At least the following | |
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://dicom.nema.org/resources/ontology/DCM | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 112002 | |
![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value | |
![]() ![]() ![]() ![]() |
1..1 | string | The value that is unique | |
![]() ![]() ![]() |
0..1 | Identifier | Business identifiers for the document | |
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Description of identifier Required Pattern: At least the following | |
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.eu/fhir/imaging-r5/CodeSystem/codesystem-missing-dicom-terminology | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 00080018 | |
![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Required Pattern: urn:ietf:rfc:3986 | |
![]() ![]() ![]() ![]() |
1..1 | string | The value that is unique | |
![]() ![]() ![]() |
0..1 | Identifier | Business identifiers for the document | |
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Description of identifier Required Pattern: At least the following | |
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://dicom.nema.org/resources/ontology/DCM | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 110180 | |
![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value | |
![]() ![]() ![]() ![]() |
1..1 | string | The value that is unique | |
![]() ![]() |
0..* | Reference(Appointment | AppointmentResponse | CarePlan | Claim | CommunicationRequest | Contract | CoverageEligibilityRequest | DeviceRequest | EnrollmentRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | RequestOrchestration | ServiceRequest | SupplyRequest | VisionPrescription) | Procedure that caused this media to be created Slice: Unordered, Open by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
![]() ![]() ![]() |
0..1 | Reference(ServiceRequest: Imaging Order) | Procedure that caused this media to be created | |
![]() ![]() ![]() ![]() |
0..1 | AccessionNumberIdentifierEuImaging | Logical reference, when literal reference is not known | |
![]() ![]() |
1..1 | CodeableConcept | Imaging modality used | |
![]() ![]() |
0..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: Image Reference Type (preferred) | |
![]() ![]() |
1..* | CodeableConcept | Categorization of document Slice: Unordered, Open by profile:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
![]() ![]() ![]() |
1..1 | CodeableConcept | Categorization of document | |
![]() ![]() ![]() ![]() |
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 | |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 55113-5 | |
![]() ![]() |
1..1 | Reference(Patient (EU core)) | Who/what is the subject of the document | |
![]() ![]() |
0..* | Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson | CareTeam) | Who and/or what authored the document Slice: Unordered, Open by profile:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
![]() ![]() ![]() |
0..* | Reference(PractitionerRole (EU core)) | Who and/or what authored the document | |
![]() ![]() |
1..* | BackboneElement | Document referenced Slice: Unordered, Open by value:extension.value Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
![]() ![]() ![]() |
0..1 | BackboneElement | Document referenced | |
![]() ![]() ![]() ![]() |
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 | |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
1..1 | (Complex) | Thumbnail state URL: http://hl7.org/fhir/StructureDefinition/documentreference-thumbnail | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | boolean | Value of extension Required Pattern: true | |
![]() ![]() ![]() |
1..1 | BackboneElement | Document referenced | |
![]() ![]() ![]() ![]() |
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 | |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
1..1 | (Complex) | Thumbnail state URL: http://hl7.org/fhir/StructureDefinition/documentreference-thumbnail | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | boolean | Value of extension Required Pattern: false | |
![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() |
1..1 | url | Uri where the data can be found | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| DocumentReference.type | Base | preferred | Image Reference Type | 📦1.0.0 | THO v7.1 |
Snapshot ViewView
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | DocumentReference | A reference to a document Constraints: docRef-1, docRef-2 | ||||
![]() ![]() |
0..1 | id | Logical id of this artifact | |||||
![]() ![]() |
0..1 | Meta | Metadata about the resource | |||||
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
![]() ![]() |
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 | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored | |||||
![]() ![]() |
0..* | Identifier | Business identifiers for the document Slice: Unordered, Open by value:type Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
![]() ![]() ![]() |
0..1 | Identifier | Business identifiers for the document | |||||
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |||||
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://dicom.nema.org/resources/ontology/DCM | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 112002 | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||
![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | |||||
![]() ![]() ![]() ![]() |
C | 1..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
0..1 | Period | Time period when id is/was valid for use | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
![]() ![]() ![]() |
0..1 | Identifier | Business identifiers for the document | |||||
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |||||
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.eu/fhir/imaging-r5/CodeSystem/codesystem-missing-dicom-terminology | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 00080018 | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||
![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Required Pattern: urn:ietf:rfc:3986 | |||||
![]() ![]() ![]() ![]() |
C | 1..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
0..1 | Period | Time period when id is/was valid for use | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
![]() ![]() ![]() |
0..1 | Identifier | Business identifiers for the document | |||||
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |||||
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://dicom.nema.org/resources/ontology/DCM | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 110180 | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||
![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | |||||
![]() ![]() ![]() ![]() |
C | 1..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
0..1 | Period | Time period when id is/was valid for use | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
![]() ![]() |
0..1 | string | An explicitly assigned identifer of a variation of the content in the DocumentReference | |||||
![]() ![]() |
0..* | Reference(Appointment | AppointmentResponse | CarePlan | Claim | CommunicationRequest | Contract | CoverageEligibilityRequest | DeviceRequest | EnrollmentRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | RequestOrchestration | ServiceRequest | SupplyRequest | VisionPrescription) | Procedure that caused this media to be created Slice: Unordered, Open by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
![]() ![]() ![]() |
0..1 | Reference(ServiceRequest: Imaging Order) | Procedure that caused this media to be created | |||||
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() ![]() |
0..1 | uri | Type the reference refers to (e.g. "Patient") - must be a resource in resources Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | |||||
![]() ![]() ![]() ![]() |
C | 0..1 | AccessionNumberIdentifierEuImaging | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() ![]() |
C | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() |
1..1 | code | current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference. | |||||
![]() ![]() |
0..1 | code | registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown Binding: CompositionStatus (required): Status of the underlying document. | |||||
![]() ![]() |
1..1 | CodeableConcept | Imaging modality used Binding: Modality (extensible): Type of acquired data in the instance. | |||||
![]() ![]() |
0..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: Image Reference Type (preferred) | |||||
![]() ![]() |
1..* | CodeableConcept | Categorization of document Slice: Unordered, Open by profile:$this Binding: ReferencedItemCategoryValueSet (example): High-level kind of document at a macro level. Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
![]() ![]() ![]() |
1..1 | CodeableConcept | Categorization of document Binding: ReferencedItemCategoryValueSet (example): High-level kind of document at a macro level. | |||||
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 55113-5 | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||
![]() ![]() |
1..1 | Reference(Patient (EU core)) | Who/what is the subject of the document | |||||
![]() ![]() |
C | 0..* | Reference(Appointment | Encounter | EpisodeOfCare) | Context of the document content | ||||
![]() ![]() |
0..* | CodeableReference() | Main clinical acts documented Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented. | |||||
![]() ![]() |
0..* | CodeableReference(BodyStructure) | Body part included Binding: SNOMEDCTBodyStructures (example): SNOMED CT Body site concepts | |||||
![]() ![]() |
C | 0..1 | CodeableConcept | Kind of facility where patient was seen Binding: FacilityTypeCodeValueSet (example): XDS Facility Type. | ||||
![]() ![]() |
C | 0..1 | CodeableConcept | Additional details about where the content was created (e.g. clinical specialty) Binding: PracticeSettingCodeValueSet (example): Additional details about where the content was created (e.g. clinical specialty). | ||||
![]() ![]() |
0..1 | Period | Time of service that is being documented | |||||
![]() ![]() |
0..1 | instant | When this document reference was created | |||||
![]() ![]() |
0..* | Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson | CareTeam) | Who and/or what authored the document Slice: Unordered, Open by profile:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
![]() ![]() ![]() |
0..* | Reference(PractitionerRole (EU core)) | Who and/or what authored the document | |||||
![]() ![]() |
0..* | BackboneElement | Attests to accuracy of the document | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() |
1..1 | CodeableConcept | personal | professional | legal | official Binding: CompositionAttestationMode (preferred): The way in which a person authenticated a document. | |||||
![]() ![]() ![]() |
0..1 | dateTime | When the document was attested | |||||
![]() ![]() ![]() |
0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization) | Who attested the document | |||||
![]() ![]() |
0..1 | Reference(Organization) | Organization which maintains the document | |||||
![]() ![]() |
0..* | BackboneElement | Relationships to other documents | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() |
1..1 | CodeableConcept | The relationship type with another document Binding: DocumentRelationshipType (extensible): The type of relationship between the documents. | |||||
![]() ![]() ![]() |
1..1 | Reference(DocumentReference) | Target of the relationship | |||||
![]() ![]() |
0..1 | markdown | Human-readable description | |||||
![]() ![]() |
0..* | CodeableConcept | Document security-tags Binding: SecurityLabelExamples (example): Example Security Labels from the Healthcare Privacy and Security Classification System. | |||||
![]() ![]() |
1..* | BackboneElement | Document referenced Slice: Unordered, Open by value:extension.value Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() ![]() |
1..1 | Attachment | Where to access the document | |||||
![]() ![]() ![]() ![]() |
0..* | BackboneElement | Content profile rules for the document | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | Code|uri|canonical Binding: HL7 ValueSet of Format Codes for use with Document Sharing (preferred): Document Format Codes. | ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Coding | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
uri | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
canonical(Any) | |||||||
![]() ![]() ![]() |
0..1 | BackboneElement | Document referenced | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | (Complex) | Thumbnail state URL: http://hl7.org/fhir/StructureDefinition/documentreference-thumbnail | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/documentreference-thumbnail" | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | boolean | Value of extension Required Pattern: true | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() ![]() |
1..1 | Attachment | Where to access the document | |||||
![]() ![]() ![]() ![]() |
0..* | BackboneElement | Content profile rules for the document | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | Code|uri|canonical Binding: HL7 ValueSet of Format Codes for use with Document Sharing (preferred): Document Format Codes. | ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Coding | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
uri | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
canonical(Any) | |||||||
![]() ![]() ![]() |
1..1 | BackboneElement | Document referenced | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | (Complex) | Thumbnail state URL: http://hl7.org/fhir/StructureDefinition/documentreference-thumbnail | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/documentreference-thumbnail" | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | boolean | Value of extension Required Pattern: false | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() ![]() |
1..1 | Attachment | Where to access the document | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
C | 0..1 | code | Mime type of the content, with charset etc. Binding: MimeTypes (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049) Example General: text/plain; charset=UTF-8, image/png | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | code | Human language of the content (BCP-47) Binding: AllLanguages (required): IETF language tag for a human language.
Example General: en-AU | |||||
![]() ![]() ![]() ![]() ![]() |
C | 0..1 | base64Binary | Data inline, base64ed | ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | integer64 | Number of bytes of content (if url provided) | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | base64Binary | Hash of the data (sha-1, base64ed) | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Label to display in place of the data Example General: Official Corporate Logo | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | dateTime | Date attachment was first created | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | positiveInt | Height of the image in pixels (photo/video) | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | positiveInt | Width of the image in pixels (photo/video) | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | positiveInt | Number of frames if > 1 (photo) | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | decimal | Length in seconds (audio / video) | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | positiveInt | Number of printed pages | |||||
![]() ![]() ![]() ![]() |
0..* | BackboneElement | Content profile rules for the document | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | Code|uri|canonical Binding: HL7 ValueSet of Format Codes for use with Document Sharing (preferred): Document Format Codes. | ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Coding | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
uri | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
canonical(Any) | |||||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| DocumentReference.language | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
| DocumentReference.identifier:seriesInstanceUid.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| DocumentReference.identifier:seriesInstanceUid.type | Base | extensible | Identifier Type Codes | 📍5.0.0 | FHIR Std. |
| DocumentReference.identifier:sopClassInstanceUid.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| DocumentReference.identifier:sopClassInstanceUid.type | Base | extensible | Identifier Type Codes | 📍5.0.0 | FHIR Std. |
| DocumentReference.identifier:studyInstanceUid.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| DocumentReference.identifier:studyInstanceUid.type | Base | extensible | Identifier Type Codes | 📍5.0.0 | FHIR Std. |
| DocumentReference.basedOn:ServiceRequestOrderEuImagingaccession.type | Base | extensible | Resource Types | 📍5.0.0 | FHIR Std. |
| DocumentReference.status | Base | required | DocumentReferenceStatus | 📍5.0.0 | FHIR Std. |
| DocumentReference.docStatus | Base | required | Composition Status | 📍5.0.0 | FHIR Std. |
| DocumentReference.modality | Base | extensible | Modality | 📦2025.3.20250714 | DICOM v2025c |
| DocumentReference.type | Base | preferred | Image Reference Type | 📦1.0.0 | THO v7.1 |
| DocumentReference.category | Base | example | Referenced Item Category Value Set | 📍5.0.0 | FHIR Std. |
| DocumentReference.category:imkeyimages | Base | example | Referenced Item Category Value Set | 📍5.0.0 | FHIR Std. |
| DocumentReference.event | Base | example | v3 Code System ActCode | 📦3.0.0 | THO v7.1 |
| DocumentReference.bodySite | Base | example | SNOMED CT Body Structures | 📍5.0.0 | FHIR Std. |
| DocumentReference.facilityType | Base | example | Facility Type Code Value Set | 📍5.0.0 | FHIR Std. |
| DocumentReference.practiceSetting | Base | example | Practice Setting Code Value Set | 📍5.0.0 | FHIR Std. |
| DocumentReference.attester.mode | Base | preferred | Composition Attestation Mode | 📍5.0.0 | FHIR Std. |
| DocumentReference.relatesTo.code | Base | extensible | Document Relationship Type | 📍5.0.0 | FHIR Std. |
| DocumentReference.securityLabel | Base | example | Example set of Security Labels | 📍5.0.0 | FHIR Std. |
| DocumentReference.content.profile.value[x] | Base | preferred | HL7 ValueSet of Format Codes for use with Document Sharing | 📦2.1.0 | THO v7.1 |
| DocumentReference.content:thumbnail.profile.value[x] | Base | preferred | HL7 ValueSet of Format Codes for use with Document Sharing | 📦2.1.0 | THO v7.1 |
| DocumentReference.content:content.attachment.contentType | Base | required | Mime Types | 📍5.0.0 | FHIR Std. |
| DocumentReference.content:content.attachment.language | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
| DocumentReference.content:content.profile.value[x] | Base | preferred | HL7 ValueSet of Format Codes for use with Document Sharing | 📦2.1.0 | THO v7.1 |
| 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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()
|
| docRef-1 | warning | DocumentReference | facilityType SHALL only be present if context is not an encounter |
facilityType.empty() or context.where(resolve() is Encounter).empty()
|
| docRef-2 | warning | DocumentReference | practiceSetting SHALL only be present if context is not present |
practiceSetting.empty() or context.where(resolve() is Encounter).empty()
|
| 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 DocumentReference
Summary
Mandatory: 10 elements(11 nested mandatory 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