EU Imaging Report R5
1.0.0-ballot - ci-build
150
EU Imaging Report R5
1.0.0-ballot - ci-build
150
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/ImagingSelectionKeyImageEuImaging | Version: 1.0.0-ballot | ||||
| Standards status: Draft | Maturity Level: 1 | Computable Name: ImagingSelectionKeyImageEuImaging | |||
Copyright/Legal: Copyright HL7 Europe. Licensed under Creative Commons public domain (CC0 1.0). |
|||||
Represents a key image by identifying DICOM selection data (study, series and instance). Use this profile when the key image is a reference to DICOM content rather than image content represented in a DocumentReference.
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.
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:  |
|---|---|---|---|---|
  ImagingSelection |
0..* | ImagingSelectionEuImaging | A selection of DICOM SOP instances and/or frames | |
  implicitRules |
0..1 | uri | A set of rules under which this content was created | |
| contained |
0..* | Resource | Contained, inline Resources | |
  Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
   extension:title |
0..1 | markdown | Natural language description of the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-description | |
 extension:description |
0..1 | string | Name for this artifact (human friendly) URL: http://hl7.org/fhir/StructureDefinition/artifact-title | |
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
| status |
1..1 | code | available | entered-in-error | unknown Binding: ImagingSelectionStatus (required): The status of the ImagingSelection. | |
 Slices for performer |
0..* | BackboneElement | Selector of the instances (human or machine) Slice: Unordered, Open by value:function Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
  performer:All Slices |
Content/Rules for all slices | |||
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
 function |
0..1 | CodeableConcept | Type of performer Binding: ValueSet: Imaging Study Performer Type Value Set (extensible) | |
| performer:pracRole |
0..1 | BackboneElement | Selector of the instances (human or machine) | |
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
 function |
1..1 | CodeableConcept | Type of performer Binding: ImagingStudySeriesPerformerFunction (extensible): The type of involvement of the performer. Required Pattern: At least the following | |
 id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
 coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: PRF | |
| display |
0..1 | string | Representation defined by the system | |
 userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
| text |
0..1 | string | Plain text representation of the concept | |
  actor |
0..1 | Reference(PractitionerRole (EU core)) | Author (human or machine) | |
 performer:device |
0..1 | BackboneElement | Selector of the instances (human or machine) | |
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| function |
1..1 | CodeableConcept | Type of performer Binding: ImagingStudySeriesPerformerFunction (extensible): The type of involvement of the performer. Required Pattern: At least the following | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: DEV | |
| display |
0..1 | string | Representation defined by the system | |
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
| text |
0..1 | string | Plain text representation of the concept | |
| actor |
0..1 | Reference(Device: Imaging Device) | Author (human or machine) | |
| code |
1..1 | CodeableConcept | Imaging Selection purpose text or code Binding: KeyObjectSelectionDocumentTitle (example): Key Object Selection Document Title. | |
 Slices for derivedFrom |
1..* | Reference(ImagingStudy | DocumentReference) | The imaging study from which the imaging selection is derived 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 | |
| derivedFrom:study |
1..1 | Reference(ImagingStudy: Reported Study) | The imaging study from which the imaging selection is derived | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| ImagingSelection.status | Base | required | Imaging Selection Status | 📍5.0.0 | FHIR Std. |
| ImagingSelection.performer.function | Base | extensible | ValueSet: Imaging Study Performer Type Value Set | 📦1.0.0-ballot | This IG |
| ImagingSelection.performer:pracRole.function | Base | extensible | ImagingStudy series performer function | 📍5.0.0 | FHIR Std. |
| ImagingSelection.performer:device.function | Base | extensible | ImagingStudy series performer function | 📍5.0.0 | FHIR Std. |
| ImagingSelection.code | Base | example | KeyObjectSelectionDocumentTitle | 📦2025.3.20250714 | DICOM v2025c |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | ImagingSelection | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | ImagingSelection | 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 | ImagingSelection | 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 | ImagingSelection | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | ImagingSelection | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from ImagingSelectionEuImaging
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ImagingSelection |
ImagingSelectionEuImaging | |||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| extension:title |
0..1 | markdown | Natural language description of the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-description | |
| extension:description |
0..1 | string | Name for this artifact (human friendly) URL: http://hl7.org/fhir/StructureDefinition/artifact-title | |
| Slices for performer |
0..* | BackboneElement | Selector of the instances (human or machine) Slice: Unordered, Open by value:function Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| performer:All Slices |
Content/Rules for all slices | |||
| function |
0..1 | CodeableConcept | Type of performer Binding: ValueSet: Imaging Study Performer Type Value Set (extensible) | |
| performer:pracRole |
0..1 | BackboneElement | Selector of the instances (human or machine) | |
| function |
1..1 | CodeableConcept | Type of performer Required Pattern: At least the following | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: PRF | |
| actor |
0..1 | Reference(PractitionerRole (EU core)) | Author (human or machine) | |
| performer:device |
0..1 | BackboneElement | Selector of the instances (human or machine) | |
| function |
1..1 | CodeableConcept | Type of performer Required Pattern: At least the following | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: DEV | |
| actor |
0..1 | Reference(Device: Imaging Device) | Author (human or machine) | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| ImagingSelection.performer.function | Base | extensible | ValueSet: Imaging Study Performer Type Value Set | 📦1.0.0-ballot | This IG |
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| ImagingSelection |
0..* | ImagingSelectionEuImaging | A selection of DICOM SOP instances and/or frames | |||||
| id |
0..1 | id | Logical id of this artifact | |||||
| meta |
0..1 | Meta | Metadata about the resource | |||||
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |||||
| language |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| extension:title |
0..1 | markdown | Natural language description of the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-description | |||||
| extension:description |
0..1 | string | Name for this artifact (human friendly) URL: http://hl7.org/fhir/StructureDefinition/artifact-title | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| identifier |
0..* | Identifier | Business Identifier for Imaging Selection | |||||
| status |
1..1 | code | available | entered-in-error | unknown Binding: ImagingSelectionStatus (required): The status of the ImagingSelection. | |||||
| subject |
0..1 | Reference(Patient (EU core)) | Subject of the selected instances | |||||
| issued |
0..1 | instant | Date / Time when this imaging selection was created | |||||
| Slices for performer |
0..* | BackboneElement | Selector of the instances (human or machine) Slice: Unordered, Open by value:function Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| performer:All Slices |
Content/Rules for all slices | |||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| function |
0..1 | CodeableConcept | Type of performer Binding: ValueSet: Imaging Study Performer Type Value Set (extensible) | |||||
| actor |
0..1 | Reference(Practitioner | PractitionerRole | Device | Organization | CareTeam | Patient | RelatedPerson | HealthcareService) | Author (human or machine) | |||||
| performer:pracRole |
0..1 | BackboneElement | Selector of the instances (human or machine) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| function |
1..1 | CodeableConcept | Type of performer Binding: ImagingStudySeriesPerformerFunction (extensible): The type of involvement of the performer. Required Pattern: At least the following | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: PRF | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| actor |
0..1 | Reference(PractitionerRole (EU core)) | Author (human or machine) | |||||
| performer:device |
0..1 | BackboneElement | Selector of the instances (human or machine) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| function |
1..1 | CodeableConcept | Type of performer Binding: ImagingStudySeriesPerformerFunction (extensible): The type of involvement of the performer. Required Pattern: At least the following | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: DEV | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| actor |
0..1 | Reference(Device: Imaging Device) | Author (human or machine) | |||||
| basedOn |
0..* | Reference(CarePlan | ServiceRequest | Appointment | AppointmentResponse | Task) | Associated request | |||||
| category |
0..* | CodeableConcept | Classifies the imaging selection Binding: KeyObjectSelectionDocumentTitle (example): Key Object Selection Document Title. | |||||
| code |
1..1 | CodeableConcept | Imaging Selection purpose text or code Binding: KeyObjectSelectionDocumentTitle (example): Key Object Selection Document Title. | |||||
| studyUid |
0..1 | id | DICOM Study Instance UID Example General: 1.2.840.113747.20080222.12753225430534207565993148475333748793 | |||||
| Slices for derivedFrom |
1..* | Reference(ImagingStudy | DocumentReference) | The imaging study from which the imaging selection is derived 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 | |||||
| derivedFrom:study |
1..1 | Reference(ImagingStudy: Reported Study) | The imaging study from which the imaging selection is derived | |||||
| endpoint |
0..* | Reference(Endpoint) | The network service providing retrieval for the images referenced in the imaging selection | |||||
| seriesUid |
0..1 | id | DICOM Series Instance UID Example General: 1.2.840.113747.20080222.12753225430534207565993148475333748793.1 | |||||
| seriesNumber |
0..1 | unsignedInt | DICOM Series Number | |||||
| frameOfReferenceUid |
0..1 | id | The Frame of Reference UID for the selected images Example General: 1.2.840.113747.20080222.12753225430534207565993148475333748793.2 | |||||
| bodySite |
0..1 | CodeableReference(BodyStructure) | Body part examined Binding: SNOMEDCTBodyStructures (example): SNOMED CT Body site concepts | |||||
| focus |
0..* | Reference(ImagingSelection) | Related resource that is the focus for the imaging selection | |||||
| instance |
0..* | BackboneElement | The selected instances | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| uid |
1..1 | id | DICOM SOP Instance UID Example General: 1.2.840.113747.20080222.12753225430534207568475333748793.1.1 | |||||
| number |
0..1 | unsignedInt | DICOM Instance Number | |||||
| sopClass |
0..1 | Coding | DICOM SOP Class UID Binding: http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1 (extensible): DICOM SOP Classes. Example General: 1.2.840.10008.5.1.4.1.1.2 | |||||
| subset |
0..* | string | The selected subset of the SOP Instance Example General: 6 | |||||
| imageRegion2D |
0..* | BackboneElement | A specific 2D region in a DICOM image / frame | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| regionType |
1..1 | code | point | polyline | interpolated | circle | ellipse Binding: ImagingSelection2DGraphicType (required): The type of image region. | |||||
| coordinate |
1..* | decimal | Specifies the coordinates that define the image region This repeating element order: The values are an ordered set of (x, y) coordinates. | |||||
| imageRegion3D |
0..* | BackboneElement | A specific 3D region in a DICOM frame of reference | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| regionType |
1..1 | code | point | multipoint | polyline | polygon | ellipse | ellipsoid Binding: ImagingSelection3DGraphicType (required): The type of image region. | |||||
| coordinate |
1..* | decimal | Specifies the coordinates that define the image region This repeating element order: The values are an ordered set of (x, y, z) coordinates. | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| ImagingSelection.language | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
| ImagingSelection.status | Base | required | Imaging Selection Status | 📍5.0.0 | FHIR Std. |
| ImagingSelection.performer.function | Base | extensible | ValueSet: Imaging Study Performer Type Value Set | 📦1.0.0-ballot | This IG |
| ImagingSelection.performer:pracRole.function | Base | extensible | ImagingStudy series performer function | 📍5.0.0 | FHIR Std. |
| ImagingSelection.performer:device.function | Base | extensible | ImagingStudy series performer function | 📍5.0.0 | FHIR Std. |
| ImagingSelection.category | Base | example | KeyObjectSelectionDocumentTitle | 📦2025.3.20250714 | DICOM v2025c |
| ImagingSelection.code | Base | example | KeyObjectSelectionDocumentTitle | 📦2025.3.20250714 | DICOM v2025c |
| ImagingSelection.bodySite | Base | example | SNOMED CT Body Structures | 📍5.0.0 | FHIR Std. |
| ImagingSelection.instance.sopClass | Base | extensible | http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1 | Not State | Unknown |
| ImagingSelection.instance.imageRegion2D.regionType | Base | required | Imaging Selection2 D Graphic Type | 📍5.0.0 | FHIR Std. |
| ImagingSelection.instance.imageRegion3D.regionType | Base | required | Imaging Selection3 D Graphic Type | 📍5.0.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | ImagingSelection | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | ImagingSelection | 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 | ImagingSelection | 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 | ImagingSelection | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | ImagingSelection | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from ImagingSelectionEuImaging
Summary
Mandatory: 0 element(2 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: |
|---|---|---|---|---|
| ImagingSelection |
0..* | ImagingSelectionEuImaging | A selection of DICOM SOP instances and/or frames | |
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |
| contained |
0..* | Resource | Contained, inline Resources | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| extension:title |
0..1 | markdown | Natural language description of the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-description | |
| extension:description |
0..1 | string | Name for this artifact (human friendly) URL: http://hl7.org/fhir/StructureDefinition/artifact-title | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
| status |
1..1 | code | available | entered-in-error | unknown Binding: ImagingSelectionStatus (required): The status of the ImagingSelection. | |
| Slices for performer |
0..* | BackboneElement | Selector of the instances (human or machine) Slice: Unordered, Open by value:function Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| performer:All Slices |
Content/Rules for all slices | |||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| function |
0..1 | CodeableConcept | Type of performer Binding: ValueSet: Imaging Study Performer Type Value Set (extensible) | |
| performer:pracRole |
0..1 | BackboneElement | Selector of the instances (human or machine) | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| function |
1..1 | CodeableConcept | Type of performer Binding: ImagingStudySeriesPerformerFunction (extensible): The type of involvement of the performer. Required Pattern: At least the following | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: PRF | |
| display |
0..1 | string | Representation defined by the system | |
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
| text |
0..1 | string | Plain text representation of the concept | |
| actor |
0..1 | Reference(PractitionerRole (EU core)) | Author (human or machine) | |
| performer:device |
0..1 | BackboneElement | Selector of the instances (human or machine) | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| function |
1..1 | CodeableConcept | Type of performer Binding: ImagingStudySeriesPerformerFunction (extensible): The type of involvement of the performer. Required Pattern: At least the following | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: DEV | |
| display |
0..1 | string | Representation defined by the system | |
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
| text |
0..1 | string | Plain text representation of the concept | |
| actor |
0..1 | Reference(Device: Imaging Device) | Author (human or machine) | |
| code |
1..1 | CodeableConcept | Imaging Selection purpose text or code Binding: KeyObjectSelectionDocumentTitle (example): Key Object Selection Document Title. | |
| Slices for derivedFrom |
1..* | Reference(ImagingStudy | DocumentReference) | The imaging study from which the imaging selection is derived 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 | |
| derivedFrom:study |
1..1 | Reference(ImagingStudy: Reported Study) | The imaging study from which the imaging selection is derived | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| ImagingSelection.status | Base | required | Imaging Selection Status | 📍5.0.0 | FHIR Std. |
| ImagingSelection.performer.function | Base | extensible | ValueSet: Imaging Study Performer Type Value Set | 📦1.0.0-ballot | This IG |
| ImagingSelection.performer:pracRole.function | Base | extensible | ImagingStudy series performer function | 📍5.0.0 | FHIR Std. |
| ImagingSelection.performer:device.function | Base | extensible | ImagingStudy series performer function | 📍5.0.0 | FHIR Std. |
| ImagingSelection.code | Base | example | KeyObjectSelectionDocumentTitle | 📦2025.3.20250714 | DICOM v2025c |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | ImagingSelection | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | ImagingSelection | 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 | ImagingSelection | 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 | ImagingSelection | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | ImagingSelection | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Differential View
This structure is derived from ImagingSelectionEuImaging
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ImagingSelection |
ImagingSelectionEuImaging | |||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| extension:title |
0..1 | markdown | Natural language description of the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-description | |
| extension:description |
0..1 | string | Name for this artifact (human friendly) URL: http://hl7.org/fhir/StructureDefinition/artifact-title | |
| Slices for performer |
0..* | BackboneElement | Selector of the instances (human or machine) Slice: Unordered, Open by value:function Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| performer:All Slices |
Content/Rules for all slices | |||
| function |
0..1 | CodeableConcept | Type of performer Binding: ValueSet: Imaging Study Performer Type Value Set (extensible) | |
| performer:pracRole |
0..1 | BackboneElement | Selector of the instances (human or machine) | |
| function |
1..1 | CodeableConcept | Type of performer Required Pattern: At least the following | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: PRF | |
| actor |
0..1 | Reference(PractitionerRole (EU core)) | Author (human or machine) | |
| performer:device |
0..1 | BackboneElement | Selector of the instances (human or machine) | |
| function |
1..1 | CodeableConcept | Type of performer Required Pattern: At least the following | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: DEV | |
| actor |
0..1 | Reference(Device: Imaging Device) | Author (human or machine) | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| ImagingSelection.performer.function | Base | extensible | ValueSet: Imaging Study Performer Type Value Set | 📦1.0.0-ballot | This IG |
Snapshot ViewView
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| ImagingSelection |
0..* | ImagingSelectionEuImaging | A selection of DICOM SOP instances and/or frames | |||||
| id |
0..1 | id | Logical id of this artifact | |||||
| meta |
0..1 | Meta | Metadata about the resource | |||||
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |||||
| language |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| extension:title |
0..1 | markdown | Natural language description of the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-description | |||||
| extension:description |
0..1 | string | Name for this artifact (human friendly) URL: http://hl7.org/fhir/StructureDefinition/artifact-title | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| identifier |
0..* | Identifier | Business Identifier for Imaging Selection | |||||
| status |
1..1 | code | available | entered-in-error | unknown Binding: ImagingSelectionStatus (required): The status of the ImagingSelection. | |||||
| subject |
0..1 | Reference(Patient (EU core)) | Subject of the selected instances | |||||
| issued |
0..1 | instant | Date / Time when this imaging selection was created | |||||
| Slices for performer |
0..* | BackboneElement | Selector of the instances (human or machine) Slice: Unordered, Open by value:function Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| performer:All Slices |
Content/Rules for all slices | |||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| function |
0..1 | CodeableConcept | Type of performer Binding: ValueSet: Imaging Study Performer Type Value Set (extensible) | |||||
| actor |
0..1 | Reference(Practitioner | PractitionerRole | Device | Organization | CareTeam | Patient | RelatedPerson | HealthcareService) | Author (human or machine) | |||||
| performer:pracRole |
0..1 | BackboneElement | Selector of the instances (human or machine) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| function |
1..1 | CodeableConcept | Type of performer Binding: ImagingStudySeriesPerformerFunction (extensible): The type of involvement of the performer. Required Pattern: At least the following | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: PRF | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| actor |
0..1 | Reference(PractitionerRole (EU core)) | Author (human or machine) | |||||
| performer:device |
0..1 | BackboneElement | Selector of the instances (human or machine) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| function |
1..1 | CodeableConcept | Type of performer Binding: ImagingStudySeriesPerformerFunction (extensible): The type of involvement of the performer. Required Pattern: At least the following | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: DEV | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| actor |
0..1 | Reference(Device: Imaging Device) | Author (human or machine) | |||||
| basedOn |
0..* | Reference(CarePlan | ServiceRequest | Appointment | AppointmentResponse | Task) | Associated request | |||||
| category |
0..* | CodeableConcept | Classifies the imaging selection Binding: KeyObjectSelectionDocumentTitle (example): Key Object Selection Document Title. | |||||
| code |
1..1 | CodeableConcept | Imaging Selection purpose text or code Binding: KeyObjectSelectionDocumentTitle (example): Key Object Selection Document Title. | |||||
| studyUid |
0..1 | id | DICOM Study Instance UID Example General: 1.2.840.113747.20080222.12753225430534207565993148475333748793 | |||||
| Slices for derivedFrom |
1..* | Reference(ImagingStudy | DocumentReference) | The imaging study from which the imaging selection is derived 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 | |||||
| derivedFrom:study |
1..1 | Reference(ImagingStudy: Reported Study) | The imaging study from which the imaging selection is derived | |||||
| endpoint |
0..* | Reference(Endpoint) | The network service providing retrieval for the images referenced in the imaging selection | |||||
| seriesUid |
0..1 | id | DICOM Series Instance UID Example General: 1.2.840.113747.20080222.12753225430534207565993148475333748793.1 | |||||
| seriesNumber |
0..1 | unsignedInt | DICOM Series Number | |||||
| frameOfReferenceUid |
0..1 | id | The Frame of Reference UID for the selected images Example General: 1.2.840.113747.20080222.12753225430534207565993148475333748793.2 | |||||
| bodySite |
0..1 | CodeableReference(BodyStructure) | Body part examined Binding: SNOMEDCTBodyStructures (example): SNOMED CT Body site concepts | |||||
| focus |
0..* | Reference(ImagingSelection) | Related resource that is the focus for the imaging selection | |||||
| instance |
0..* | BackboneElement | The selected instances | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| uid |
1..1 | id | DICOM SOP Instance UID Example General: 1.2.840.113747.20080222.12753225430534207568475333748793.1.1 | |||||
| number |
0..1 | unsignedInt | DICOM Instance Number | |||||
| sopClass |
0..1 | Coding | DICOM SOP Class UID Binding: http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1 (extensible): DICOM SOP Classes. Example General: 1.2.840.10008.5.1.4.1.1.2 | |||||
| subset |
0..* | string | The selected subset of the SOP Instance Example General: 6 | |||||
| imageRegion2D |
0..* | BackboneElement | A specific 2D region in a DICOM image / frame | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| regionType |
1..1 | code | point | polyline | interpolated | circle | ellipse Binding: ImagingSelection2DGraphicType (required): The type of image region. | |||||
| coordinate |
1..* | decimal | Specifies the coordinates that define the image region This repeating element order: The values are an ordered set of (x, y) coordinates. | |||||
| imageRegion3D |
0..* | BackboneElement | A specific 3D region in a DICOM frame of reference | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| regionType |
1..1 | code | point | multipoint | polyline | polygon | ellipse | ellipsoid Binding: ImagingSelection3DGraphicType (required): The type of image region. | |||||
| coordinate |
1..* | decimal | Specifies the coordinates that define the image region This repeating element order: The values are an ordered set of (x, y, z) coordinates. | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| ImagingSelection.language | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
| ImagingSelection.status | Base | required | Imaging Selection Status | 📍5.0.0 | FHIR Std. |
| ImagingSelection.performer.function | Base | extensible | ValueSet: Imaging Study Performer Type Value Set | 📦1.0.0-ballot | This IG |
| ImagingSelection.performer:pracRole.function | Base | extensible | ImagingStudy series performer function | 📍5.0.0 | FHIR Std. |
| ImagingSelection.performer:device.function | Base | extensible | ImagingStudy series performer function | 📍5.0.0 | FHIR Std. |
| ImagingSelection.category | Base | example | KeyObjectSelectionDocumentTitle | 📦2025.3.20250714 | DICOM v2025c |
| ImagingSelection.code | Base | example | KeyObjectSelectionDocumentTitle | 📦2025.3.20250714 | DICOM v2025c |
| ImagingSelection.bodySite | Base | example | SNOMED CT Body Structures | 📍5.0.0 | FHIR Std. |
| ImagingSelection.instance.sopClass | Base | extensible | http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1 | Not State | Unknown |
| ImagingSelection.instance.imageRegion2D.regionType | Base | required | Imaging Selection2 D Graphic Type | 📍5.0.0 | FHIR Std. |
| ImagingSelection.instance.imageRegion3D.regionType | Base | required | Imaging Selection3 D Graphic Type | 📍5.0.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | ImagingSelection | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | ImagingSelection | 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 | ImagingSelection | 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 | ImagingSelection | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | ImagingSelection | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from ImagingSelectionEuImaging
Summary
Mandatory: 0 element(2 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
IG © 2025+ HL7 Europe.
Package hl7.fhir.eu.imaging-r5#1.0.0-ballot based on FHIR 5.0.0.
Generated
2026-10-13
