This
page
is
part
of
the
FHIR
Specification
(v5.0.0:
R5
-
STU
v6.0.0-ballot3:
Release
6
Ballot
(3rd
Draft)
(see
Ballot
Notes
).
This
is
the
The
current
published
version
in
it's
permanent
home
(it
will
always
be
available
at
this
URL).
is
5.0.0
.
For
a
full
list
of
available
versions,
see
the
Directory
of
published
versions
Imaging
Integration
Work
Group
|
Maturity Level : 1 | Trial Use | Security Category : Patient | Compartments : Group , Patient |
A selection of DICOM SOP instances and/or frames within a single Study and Series. This might include additional specifics such as an image region, an Observation UID or a Segmentation Number, allowing linkage to an Observation Resource or transferring this information along with the ImagingStudy Resource.
This resource is an event resource from a FHIR workflow perspective - see Workflow .
A
selection
of
data
from
an
ImagingStudy.
The
selection
may
MAY
be:
May
also
represent
regions
within
the
ImagingStudy
frame
of
reference,
,
including:
Uses for ImagingSelection resources include:
All
DICOM
SOP
Instances
referenced
in
a
single
ImagingSelection
resource
shall
SHALL
be
part
of
the
same
DICOM
Series
(and
therefore
also
the
same
DICOM
Study).
In
order
to
reference
SOP
Instances
in
multiple
Studies
or
Series
it
is
necessary
to
create
multiple
ImagingSelection
resources.
An
Observation
The
ImagingStudy
references
resource
is
used
to
store
details
of
an
entire
DICOM
Study
and
associated
information,
including
its
relationship
to
other
resources,
such
as
ServiceRequest
and
Encounter
.
The
ImagingSelection
resource
is
used
to
specify
the
reference
to
a
specific
set
of
specific
set
of
DICOM
images,
frames,
waveforms
or
documents
used
image
regions.
Instances
of
this
resource
are
created
for
specific
clinical
purposes
and
are
unlikely
to
make
the
change
once
created.
An
Observation
.
By
contrast,
MAY
be
related
to
a
set
of
images
in
the
following
ways.
The
DocumentReference
has
limited
ability
resource
is
used
to
reference
multiple
images
to
store
non-DICOM
images,
video,
or
frames
and
can
only
specify
the
Study,
Series
and
SOP
Instance
UIDs
implicitly
via
the
URL.
audio
with
relevant
metadata.
The
DocumentReference
resource
might
be
appropriate
for
including
a
rendered
DICOM
image
in
cases
where
only
the
full
image
context
is
needed
and
not
important.
the
full
image
context.
The Binary resource to store arbitrary content.
Structure
| Name | Flags | Card. | Type |
Description
&
Constraints
|
|---|---|---|---|---|
|
TU | DomainResource |
A
selection
of
DICOM
SOP
instances
and/or
frames
+ Rule: At least one of seriesUid or imageRegion3D shall be present + Rule: seriesUid SHALL only be present if studyUid is present + Rule: seriesNumber SHALL only be present if seriesUid is present + Rule: instance SHALL only be present if seriesUid is present + Rule: imageRegion3D SHALL only be present if frameOfReferenceUid is present + Rule: imageRegion3D SHALL only be present if instance.imageRegion2D is not present Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension |
|
|
Σ | 0..* | Identifier |
Business
|
|
?! Σ | 1..1 | code |
available
|
entered-in-error
|
inactive
|
unknown
Binding: Imaging Selection Status ( Required ) |
| Σ | 0..* | CodeableConcept |
Classifies
the
imaging
selection
Binding: KeyObjectSelectionDocumentTitle
(
Preferred
)
|
![]() ![]() | Σ | 1..1 | CodeableConcept |
Imaging
Selection
purpose
text
or
code
Binding: KeyObjectSelectionDocumentTitle
(
Example
)
|
|
Σ | 0..1 |
Reference
(
Patient
|
Group
|
Device
|
|
Subject
of
the
selected
instances
|
|
Σ | 0..1 | instant |
Date
/
Time
when
this
imaging
selection
was
created
|
|
Σ | 0..* | BackboneElement |
|
|
Σ | 0..1 | CodeableConcept |
Type
of
performer
Binding: ImagingStudy series performer function ( Extensible ) |
|
Σ | 0..1 | Reference ( Practitioner | PractitionerRole | Device | Organization | CareTeam | Patient | RelatedPerson | HealthcareService ) |
Author
(human
or
machine)
|
|
Σ | 0..* |
Reference
(
CarePlan
|
ServiceRequest
|
Appointment
|
|
Associated
|
|
Σ | 0..1 |
|
The
imaging
study
from
which
the
imaging
selection
is
derived
|
|
Σ
C
|
0..1 |
|
DICOM
Study
Instance
UID
|
|
Σ C | 0..1 | id |
DICOM
Series
Instance
UID
|
|
Σ C | 0..1 | unsignedInt |
DICOM
Series
Number
|
|
Σ C | 0..1 | id |
The
Frame
of
Reference
UID
for
the
selected
images
|
|
Σ | 0..* | CodeableReference ( BodyStructure ) |
Body
part
examined
Binding: SNOMED CT Body Structures ( Example ) |
|
Σ | 0..* | Reference ( ImagingSelection ) |
Related
|
| Σ | 0..* | Reference ( Endpoint ) |
The
network
services
providing
retrieval
for
the
images
referenced
in
the
imaging
selection
|
![]()
|
Σ C | 0..* | BackboneElement |
The
selected
instances
|
|
Σ | 1..1 | id |
DICOM
SOP
Instance
UID
|
|
Σ | 0..1 | unsignedInt |
DICOM
Instance
Number
|
|
0..1 |
|
DICOM
SOP
Class
UID
|
|
|
0..* | string |
The
selected
subset
of
the
SOP
Instance
|
|
|
C | 0..* | BackboneElement |
A
specific
2D
region
in
a
DICOM
image
/
frame
|
|
1..1 | code |
point
|
polyline
|
Binding: Imaging |
|
|
1..* | decimal |
Specifies
the
coordinates
that
define
the
image
region
This repeating element order: The values are an ordered set of (x, y) coordinates. |
|
|
C | 0..* | BackboneElement |
A
specific
3D
region
in
a
DICOM
frame
of
reference
|
|
1..1 | code |
point
|
multipoint
|
polyline
|
polygon
|
ellipse
|
ellipsoid
Binding: Imaging |
|
|
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
|
||||
See the Extensions for this resource
UML Diagram ( Legend )
XML Template
<ImagingSelection xmlns="http://hl7.org/fhir"><!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension -->
<</identifier> < <| </subject><identifier><!-- 0..* Identifier Business Identifiers for Imaging Selection --></identifier> <status value="[code]"/><!-- 1..1 available | entered-in-error | inactive | unknown --> <category><!-- 0..* CodeableConcept Classifies the imaging selection--></category> <code><!-- 1..1 CodeableConcept Imaging Selection purpose text or code
--></code> <subject><!-- 0..1 Reference(Device|Group|Medication|Patient|Practitioner| Procedure|Specimen|Substance) Subject of the selected instances --></subject> <issued value="[instant]"/><!-- 0..1 Date / Time when this imaging selection was created -->
<<performer> <!-- 0..* Selectors of the instances (human or machine) --> <function><!-- 0..1 CodeableConcept Type of performer --></function><|<actor><!-- 0..1 Reference(CareTeam|Device|HealthcareService|Organization| Patient|Practitioner|PractitionerRole|RelatedPerson) Author (human or machine) --></actor> </performer><| </basedOn> <</category> <</code> < <</derivedFrom> <</endpoint> < < < <</bodySite> <</focus> <<basedOn><!-- 0..* Reference(Appointment|CarePlan|ServiceRequest|Task) Associated requests --></basedOn> <derivedFrom><!-- 0..1 Reference(DocumentReference|ImagingStudy) The imaging study from which the imaging selection is derived --></derivedFrom> <studyUid value="[id]"/><!-- I 0..1 DICOM Study Instance UID --> <seriesUid value="[id]"/><!-- I 0..1 DICOM Series Instance UID --> <seriesNumber value="[unsignedInt]"/><!-- I 0..1 DICOM Series Number --> <frameOfReferenceUid value="[id]"/><!-- I 0..1 The Frame of Reference UID for the selected images --> <bodySite><!-- 0..* CodeableReference(BodyStructure) Body part examined --></bodySite> <focus><!-- 0..* Reference(ImagingSelection) Related resources that are the focus for the imaging selection --></focus> <endpoint><!-- 0..* Reference(Endpoint) The network services providing retrieval for the images referenced in the imaging selection --></endpoint> <instance> <!-- I 0..* The selected instances --> <uid value="[id]"/><!-- 1..1 DICOM SOP Instance UID --> <number value="[unsignedInt]"/><!-- 0..1 DICOM Instance Number --><</sopClass> <<a href="imagingselection-definitions.html#ImagingSelection.instance.subset" title="Selected subset of the SOP Instance. The content and format of the subset item is determined by the SOP Class of the selected instance. May be one of: - A list of frame numbers selected from a multiframe SOP Instance. - A list of Content Item Observation UID values selected from a DICOM SR or other structured document SOP Instance. - A list of segment numbers selected from a segmentation SOP Instance. - A list of Region of Interest (ROI) numbers selected from a radiotherapy structure set SOP Instance." class="dict"> <<a href="imagingselection-definitions.html#ImagingSelection.instance.imageRegion2D" title="Each imaging selection instance or frame list might includes an image region, specified by a region type and a set of 2D coordinates. If the parent imagingSelection.instance contains a subset element of type frame, the image region applies to all frames in the subset list." class="dict"> <<sopClass value="[oid]"/><!-- 0..1 DICOM SOP Class UID --> <subset value="[string]"/><!-- 0..* The selected subset of the SOP Instance --> <imageRegion2D> <!-- I 0..* A specific 2D region in a DICOM image / frame --> <regionType value="[code]"/><!-- 1..1 point | polyline | multipoint | circle | ellipse --> < The origin at the TLHC of the TLHC pixel is 0.0\0.0, the BRHC of the TLHC pixel is 1.0\1.0, and the BRHC of the BRHC pixel is the number of columns\rows in the image / frames. The values must be within the range 0\0 to the number of columns\rows in the image / frames." class="dict"> The origin at the TLHC of the TLHC pixel is 0.0\0.0, the BRHC of the TLHC pixel is 1.0\1.0, and the BRHC of the BRHC pixel is the number of columns\rows in the image / frames. The values SHALL be within the range 0\0 to the number of columns\rows in the image / frames." class="dict">coordinate value="[decimal]"/><!-- 1..* Specifies the coordinates that define the image region --> </imageRegion2D>< < < </imageRegion3D></instance> <imageRegion3D> <!-- I 0..* A specific 3D region in a DICOM frame of reference --> <regionType value="[code]"/><!-- 1..1 point | multipoint | polyline | polygon | ellipse | ellipsoid --> <coordinate value="[decimal]"/><!-- 1..* Specifies the coordinates that define the image region --> </imageRegion3D> </ImagingSelection>
JSON Template
{
"resourceType" : "ImagingSelection",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"
"
"|
"identifier" : [{ Identifier }], // Business Identifiers for Imaging Selection
"status" : "<code>", // R! available | entered-in-error | inactive | unknown
"category" : [{ CodeableConcept }], // Classifies the imaging selection
"code" : { CodeableConcept }, // R! Imaging Selection purpose text or code
"subject" : { Reference(Device|Group|Medication|Patient|Practitioner|
Procedure|Specimen|Substance) }, // Subject of the selected instances
"issued" : "<instant>", // Date / Time when this imaging selection was created
"
"performer" : [{ // Selectors of the instances (human or machine)
"function" : { CodeableConcept }, // Type of performer
"|
"actor" : { Reference(CareTeam|Device|HealthcareService|Organization|
Patient|Practitioner|PractitionerRole|RelatedPerson) } // Author (human or machine)
}],
"|
"
"
"
"
"
"
"
"
"
"
"
"basedOn" : [{ Reference(Appointment|CarePlan|ServiceRequest|Task) }], // Associated requests
"derivedFrom" : { Reference(DocumentReference|ImagingStudy) }, // The imaging study from which the imaging selection is derived
"studyUid" : "<id>", // I DICOM Study Instance UID
"seriesUid" : "<id>", // I DICOM Series Instance UID
"seriesNumber" : "<unsignedInt>", // I DICOM Series Number
"frameOfReferenceUid" : "<id>", // I The Frame of Reference UID for the selected images
"bodySite" : [{ CodeableReference(BodyStructure) }], // Body part examined
"focus" : [{ Reference(ImagingSelection) }], // Related resources that are the focus for the imaging selection
"endpoint" : [{ Reference(Endpoint) }], // The network services providing retrieval for the images referenced in the imaging selection
"instance" : [{ // I The selected instances
"uid" : "<id>", // R! DICOM SOP Instance UID
"number" : "<unsignedInt>", // DICOM Instance Number
"
"<a href="imagingselection-definitions.html#ImagingSelection.instance.subset" title="Selected subset of the SOP Instance. The content and format of the subset item is determined by the SOP Class of the selected instance.
May be one of:
- A list of frame numbers selected from a multiframe SOP Instance.
- A list of Content Item Observation UID values selected from a DICOM SR or other structured document SOP Instance.
- A list of segment numbers selected from a segmentation SOP Instance.
- A list of Region of Interest (ROI) numbers selected from a radiotherapy structure set SOP Instance." class="dict">subset
"<a href="imagingselection-definitions.html#ImagingSelection.instance.imageRegion2D" title="Each imaging selection instance or frame list might includes an image region, specified by a region type and a set of 2D coordinates.
If the parent imagingSelection.instance contains a subset element of type frame, the image region applies to all frames in the subset list." class="dict">imageRegion2D
"
"sopClass" : "<oid>", // DICOM SOP Class UID
"subset" : ["<string>"], // The selected subset of the SOP Instance
"imageRegion2D" : [{ // I A specific 2D region in a DICOM image / frame
"regionType" : "<code>", // R! point | polyline | multipoint | circle | ellipse
" The origin at the TLHC of the TLHC pixel is 0.0\0.0, the BRHC of the TLHC pixel is 1.0\1.0, and the BRHC of the BRHC pixel is the number of columns\rows in the image / frames. The values must be within the range 0\0 to the number of columns\rows in the image / frames." class="dict">coordinate
}],
"
"
"
The origin at the TLHC of the TLHC pixel is 0.0\0.0, the BRHC of the TLHC pixel is 1.0\1.0, and the BRHC of the BRHC pixel is the number of columns\rows in the image / frames. The values SHALL be within the range 0\0 to the number of columns\rows in the image / frames." class="dict">coordinate" : [<decimal>] // R! Specifies the coordinates that define the image region
}]
}],
"imageRegion3D" : [{ // I A specific 3D region in a DICOM frame of reference
"regionType" : "<code>", // R! point | multipoint | polyline | polygon | ellipse | ellipsoid
"coordinate" : [<decimal>] // R! Specifies the coordinates that define the image region
}]
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .[ a fhir:ImagingSelection; fhir:nodeRole fhir:treeRoot; # if this is the parser root # from Resource: .id, .meta, .implicitRules, and .language # from DomainResource: .text, .contained, .extension, and .modifierExtension
fhir: fhir: fhir:|fhir:identifier ( [ Identifier ] ... ) ; # 0..* Business Identifiers for Imaging Selection fhir:status [ code ] ; # 1..1 available | entered-in-error | inactive | unknown fhir:category ( [ CodeableConcept ] ... ) ; # 0..* Classifies the imaging selection fhir:code [ CodeableConcept ] ; # 1..1 Imaging Selection purpose text or code fhir:subject [ Reference(Device|Group|Medication|Patient|Practitioner|Procedure|Specimen|Substance) ] ; # 0..1 Subject of the selected instances fhir:issued [ instant ] ; # 0..1 Date / Time when this imaging selection was createdfhir:fhir:performer ( [ # 0..* Selectors of the instances (human or machine) fhir:function [ CodeableConcept ] ; # 0..1 Type of performerfhir:|fhir:actor [ Reference(CareTeam|Device|HealthcareService|Organization|Patient|Practitioner| PractitionerRole|RelatedPerson) ] ; # 0..1 Author (human or machine) ] ... ) ;fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir:fhir:basedOn ( [ Reference(Appointment|CarePlan|ServiceRequest|Task) ] ... ) ; # 0..* Associated requests fhir:derivedFrom [ Reference(DocumentReference|ImagingStudy) ] ; # 0..1 The imaging study from which the imaging selection is derived fhir:studyUid [ id ] ; # 0..1 I DICOM Study Instance UID fhir:seriesUid [ id ] ; # 0..1 I DICOM Series Instance UID fhir:seriesNumber [ unsignedInt ] ; # 0..1 I DICOM Series Number fhir:frameOfReferenceUid [ id ] ; # 0..1 I The Frame of Reference UID for the selected images fhir:bodySite ( [ CodeableReference(BodyStructure) ] ... ) ; # 0..* Body part examined fhir:focus ( [ Reference(ImagingSelection) ] ... ) ; # 0..* Related resources that are the focus for the imaging selection fhir:endpoint ( [ Reference(Endpoint) ] ... ) ; # 0..* The network services providing retrieval for the images referenced in the imaging selection fhir:instance ( [ # 0..* I The selected instances fhir:uid [ id ] ; # 1..1 DICOM SOP Instance UID fhir:number [ unsignedInt ] ; # 0..1 DICOM Instance Numberfhir: fhir:<a href="imagingselection-definitions.html#ImagingSelection.instance.subset" title="Selected subset of the SOP Instance. The content and format of the subset item is determined by the SOP Class of the selected instance. May be one of: - A list of frame numbers selected from a multiframe SOP Instance. - A list of Content Item Observation UID values selected from a DICOM SR or other structured document SOP Instance. - A list of segment numbers selected from a segmentation SOP Instance. - A list of Region of Interest (ROI) numbers selected from a radiotherapy structure set SOP Instance." class="dict">subset fhir:<a href="imagingselection-definitions.html#ImagingSelection.instance.imageRegion2D" title="Each imaging selection instance or frame list might includes an image region, specified by a region type and a set of 2D coordinates. If the parent imagingSelection.instance contains a subset element of type frame, the image region applies to all frames in the subset list." class="dict">imageRegion2D fhir:fhir:sopClass [ oid ] ; # 0..1 DICOM SOP Class UID fhir:subset ( [ string ] ... ) ; # 0..* The selected subset of the SOP Instance fhir:imageRegion2D ( [ # 0..* I A specific 2D region in a DICOM image / frame fhir:regionType [ code ] ; # 1..1 point | polyline | multipoint | circle | ellipse fhir: The origin at the TLHC of the TLHC pixel is 0.0\0.0, the BRHC of the TLHC pixel is 1.0\1.0, and the BRHC of the BRHC pixel is the number of columns\rows in the image / frames. The values must be within the range 0\0 to the number of columns\rows in the image / frames." class="dict">coordinate ] ... ) ; fhir: fhir: fhir: The origin at the TLHC of the TLHC pixel is 0.0\0.0, the BRHC of the TLHC pixel is 1.0\1.0, and the BRHC of the BRHC pixel is the number of columns\rows in the image / frames. The values SHALL be within the range 0\0 to the number of columns\rows in the image / frames." class="dict">coordinate ( [ decimal ] ... ) ; # 1..* Specifies the coordinates that define the image region ] ... ) ; ] ... ) ; fhir:imageRegion3D ( [ # 0..* I A specific 3D region in a DICOM frame of reference fhir:regionType [ code ] ; # 1..1 point | multipoint | polyline | polygon | ellipse | ellipsoid fhir:coordinate ( [ decimal ] ... ) ; # 1..* Specifies the coordinates that define the image region ] ... ) ; ]
Changes from both R4 and R4B
This resource did not exist in Release R4
See the Full Difference for further information
This analysis is available for R4 as XML or JSON and for R4B as XML or JSON .
Structure
| Name | Flags | Card. | Type |
Description
&
Constraints
|
|---|---|---|---|---|
|
TU | DomainResource |
A
selection
of
DICOM
SOP
instances
and/or
frames
+ Rule: At least one of seriesUid or imageRegion3D shall be present + Rule: seriesUid SHALL only be present if studyUid is present + Rule: seriesNumber SHALL only be present if seriesUid is present + Rule: instance SHALL only be present if seriesUid is present + Rule: imageRegion3D SHALL only be present if frameOfReferenceUid is present + Rule: imageRegion3D SHALL only be present if instance.imageRegion2D is not present Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension |
|
|
Σ | 0..* | Identifier |
Business
|
|
?! Σ | 1..1 | code |
available
|
entered-in-error
|
inactive
|
unknown
Binding: Imaging Selection Status ( Required ) |
| Σ | 0..* | CodeableConcept |
Classifies
the
imaging
selection
Binding: KeyObjectSelectionDocumentTitle
(
Preferred
)
|
![]() ![]() | Σ | 1..1 | CodeableConcept |
Imaging
Selection
purpose
text
or
code
Binding: KeyObjectSelectionDocumentTitle
(
Example
)
|
|
Σ | 0..1 |
Reference
(
Patient
|
Group
|
Device
|
|
Subject
of
the
selected
instances
|
|
Σ | 0..1 | instant |
Date
/
Time
when
this
imaging
selection
was
created
|
|
Σ | 0..* | BackboneElement |
|
|
Σ | 0..1 | CodeableConcept |
Type
of
performer
Binding: ImagingStudy series performer function ( Extensible ) |
|
Σ | 0..1 | Reference ( Practitioner | PractitionerRole | Device | Organization | CareTeam | Patient | RelatedPerson | HealthcareService ) |
Author
(human
or
machine)
|
|
Σ | 0..* |
Reference
(
CarePlan
|
ServiceRequest
|
Appointment
|
|
Associated
|
|
Σ | 0..1 |
|
The
imaging
study
from
which
the
imaging
selection
is
derived
|
|
Σ
C
|
0..1 |
|
DICOM
Study
Instance
UID
|
|
Σ C | 0..1 | id |
DICOM
Series
Instance
UID
|
|
Σ C | 0..1 | unsignedInt |
DICOM
Series
Number
|
|
Σ C | 0..1 | id |
The
Frame
of
Reference
UID
for
the
selected
images
|
|
Σ | 0..* | CodeableReference ( BodyStructure ) |
Body
part
examined
Binding: SNOMED CT Body Structures ( Example ) |
|
Σ | 0..* | Reference ( ImagingSelection ) |
Related
|
| Σ | 0..* | Reference ( Endpoint ) |
The
network
services
providing
retrieval
for
the
images
referenced
in
the
imaging
selection
|
![]()
|
Σ C | 0..* | BackboneElement |
The
selected
instances
|
|
Σ | 1..1 | id |
DICOM
SOP
Instance
UID
|
|
Σ | 0..1 | unsignedInt |
DICOM
Instance
Number
|
|
0..1 |
|
DICOM
SOP
Class
UID
|
|
|
0..* | string |
The
selected
subset
of
the
SOP
Instance
|
|
|
C | 0..* | BackboneElement |
A
specific
2D
region
in
a
DICOM
image
/
frame
|
|
1..1 | code |
point
|
polyline
|
Binding: Imaging |
|
|
1..* | decimal |
Specifies
the
coordinates
that
define
the
image
region
This repeating element order: The values are an ordered set of (x, y) coordinates. |
|
|
C | 0..* | BackboneElement |
A
specific
3D
region
in
a
DICOM
frame
of
reference
|
|
1..1 | code |
point
|
multipoint
|
polyline
|
polygon
|
ellipse
|
ellipsoid
Binding: Imaging |
|
|
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
|
||||
See the Extensions for this resource
XML Template
<ImagingSelection xmlns="http://hl7.org/fhir"><!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension -->
<</identifier> < <| </subject><identifier><!-- 0..* Identifier Business Identifiers for Imaging Selection --></identifier> <status value="[code]"/><!-- 1..1 available | entered-in-error | inactive | unknown --> <category><!-- 0..* CodeableConcept Classifies the imaging selection--></category> <code><!-- 1..1 CodeableConcept Imaging Selection purpose text or code
--></code> <subject><!-- 0..1 Reference(Device|Group|Medication|Patient|Practitioner| Procedure|Specimen|Substance) Subject of the selected instances --></subject> <issued value="[instant]"/><!-- 0..1 Date / Time when this imaging selection was created -->
<<performer> <!-- 0..* Selectors of the instances (human or machine) --> <function><!-- 0..1 CodeableConcept Type of performer --></function><|<actor><!-- 0..1 Reference(CareTeam|Device|HealthcareService|Organization| Patient|Practitioner|PractitionerRole|RelatedPerson) Author (human or machine) --></actor> </performer><| </basedOn> <</category> <</code> < <</derivedFrom> <</endpoint> < < < <</bodySite> <</focus> <<basedOn><!-- 0..* Reference(Appointment|CarePlan|ServiceRequest|Task) Associated requests --></basedOn> <derivedFrom><!-- 0..1 Reference(DocumentReference|ImagingStudy) The imaging study from which the imaging selection is derived --></derivedFrom> <studyUid value="[id]"/><!-- I 0..1 DICOM Study Instance UID --> <seriesUid value="[id]"/><!-- I 0..1 DICOM Series Instance UID --> <seriesNumber value="[unsignedInt]"/><!-- I 0..1 DICOM Series Number --> <frameOfReferenceUid value="[id]"/><!-- I 0..1 The Frame of Reference UID for the selected images --> <bodySite><!-- 0..* CodeableReference(BodyStructure) Body part examined --></bodySite> <focus><!-- 0..* Reference(ImagingSelection) Related resources that are the focus for the imaging selection --></focus> <endpoint><!-- 0..* Reference(Endpoint) The network services providing retrieval for the images referenced in the imaging selection --></endpoint> <instance> <!-- I 0..* The selected instances --> <uid value="[id]"/><!-- 1..1 DICOM SOP Instance UID --> <number value="[unsignedInt]"/><!-- 0..1 DICOM Instance Number --><</sopClass> <<a href="imagingselection-definitions.html#ImagingSelection.instance.subset" title="Selected subset of the SOP Instance. The content and format of the subset item is determined by the SOP Class of the selected instance. May be one of: - A list of frame numbers selected from a multiframe SOP Instance. - A list of Content Item Observation UID values selected from a DICOM SR or other structured document SOP Instance. - A list of segment numbers selected from a segmentation SOP Instance. - A list of Region of Interest (ROI) numbers selected from a radiotherapy structure set SOP Instance." class="dict"> <<a href="imagingselection-definitions.html#ImagingSelection.instance.imageRegion2D" title="Each imaging selection instance or frame list might includes an image region, specified by a region type and a set of 2D coordinates. If the parent imagingSelection.instance contains a subset element of type frame, the image region applies to all frames in the subset list." class="dict"> <<sopClass value="[oid]"/><!-- 0..1 DICOM SOP Class UID --> <subset value="[string]"/><!-- 0..* The selected subset of the SOP Instance --> <imageRegion2D> <!-- I 0..* A specific 2D region in a DICOM image / frame --> <regionType value="[code]"/><!-- 1..1 point | polyline | multipoint | circle | ellipse --> < The origin at the TLHC of the TLHC pixel is 0.0\0.0, the BRHC of the TLHC pixel is 1.0\1.0, and the BRHC of the BRHC pixel is the number of columns\rows in the image / frames. The values must be within the range 0\0 to the number of columns\rows in the image / frames." class="dict"> The origin at the TLHC of the TLHC pixel is 0.0\0.0, the BRHC of the TLHC pixel is 1.0\1.0, and the BRHC of the BRHC pixel is the number of columns\rows in the image / frames. The values SHALL be within the range 0\0 to the number of columns\rows in the image / frames." class="dict">coordinate value="[decimal]"/><!-- 1..* Specifies the coordinates that define the image region --> </imageRegion2D>< < < </imageRegion3D></instance> <imageRegion3D> <!-- I 0..* A specific 3D region in a DICOM frame of reference --> <regionType value="[code]"/><!-- 1..1 point | multipoint | polyline | polygon | ellipse | ellipsoid --> <coordinate value="[decimal]"/><!-- 1..* Specifies the coordinates that define the image region --> </imageRegion3D> </ImagingSelection>
JSON Template
{
"resourceType" : "ImagingSelection",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"
"
"|
"identifier" : [{ Identifier }], // Business Identifiers for Imaging Selection
"status" : "<code>", // R! available | entered-in-error | inactive | unknown
"category" : [{ CodeableConcept }], // Classifies the imaging selection
"code" : { CodeableConcept }, // R! Imaging Selection purpose text or code
"subject" : { Reference(Device|Group|Medication|Patient|Practitioner|
Procedure|Specimen|Substance) }, // Subject of the selected instances
"issued" : "<instant>", // Date / Time when this imaging selection was created
"
"performer" : [{ // Selectors of the instances (human or machine)
"function" : { CodeableConcept }, // Type of performer
"|
"actor" : { Reference(CareTeam|Device|HealthcareService|Organization|
Patient|Practitioner|PractitionerRole|RelatedPerson) } // Author (human or machine)
}],
"|
"
"
"
"
"
"
"
"
"
"
"
"basedOn" : [{ Reference(Appointment|CarePlan|ServiceRequest|Task) }], // Associated requests
"derivedFrom" : { Reference(DocumentReference|ImagingStudy) }, // The imaging study from which the imaging selection is derived
"studyUid" : "<id>", // I DICOM Study Instance UID
"seriesUid" : "<id>", // I DICOM Series Instance UID
"seriesNumber" : "<unsignedInt>", // I DICOM Series Number
"frameOfReferenceUid" : "<id>", // I The Frame of Reference UID for the selected images
"bodySite" : [{ CodeableReference(BodyStructure) }], // Body part examined
"focus" : [{ Reference(ImagingSelection) }], // Related resources that are the focus for the imaging selection
"endpoint" : [{ Reference(Endpoint) }], // The network services providing retrieval for the images referenced in the imaging selection
"instance" : [{ // I The selected instances
"uid" : "<id>", // R! DICOM SOP Instance UID
"number" : "<unsignedInt>", // DICOM Instance Number
"
"<a href="imagingselection-definitions.html#ImagingSelection.instance.subset" title="Selected subset of the SOP Instance. The content and format of the subset item is determined by the SOP Class of the selected instance.
May be one of:
- A list of frame numbers selected from a multiframe SOP Instance.
- A list of Content Item Observation UID values selected from a DICOM SR or other structured document SOP Instance.
- A list of segment numbers selected from a segmentation SOP Instance.
- A list of Region of Interest (ROI) numbers selected from a radiotherapy structure set SOP Instance." class="dict">subset
"<a href="imagingselection-definitions.html#ImagingSelection.instance.imageRegion2D" title="Each imaging selection instance or frame list might includes an image region, specified by a region type and a set of 2D coordinates.
If the parent imagingSelection.instance contains a subset element of type frame, the image region applies to all frames in the subset list." class="dict">imageRegion2D
"
"sopClass" : "<oid>", // DICOM SOP Class UID
"subset" : ["<string>"], // The selected subset of the SOP Instance
"imageRegion2D" : [{ // I A specific 2D region in a DICOM image / frame
"regionType" : "<code>", // R! point | polyline | multipoint | circle | ellipse
" The origin at the TLHC of the TLHC pixel is 0.0\0.0, the BRHC of the TLHC pixel is 1.0\1.0, and the BRHC of the BRHC pixel is the number of columns\rows in the image / frames. The values must be within the range 0\0 to the number of columns\rows in the image / frames." class="dict">coordinate
}],
"
"
"
The origin at the TLHC of the TLHC pixel is 0.0\0.0, the BRHC of the TLHC pixel is 1.0\1.0, and the BRHC of the BRHC pixel is the number of columns\rows in the image / frames. The values SHALL be within the range 0\0 to the number of columns\rows in the image / frames." class="dict">coordinate" : [<decimal>] // R! Specifies the coordinates that define the image region
}]
}],
"imageRegion3D" : [{ // I A specific 3D region in a DICOM frame of reference
"regionType" : "<code>", // R! point | multipoint | polyline | polygon | ellipse | ellipsoid
"coordinate" : [<decimal>] // R! Specifies the coordinates that define the image region
}]
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .[ a fhir:ImagingSelection; fhir:nodeRole fhir:treeRoot; # if this is the parser root # from Resource: .id, .meta, .implicitRules, and .language # from DomainResource: .text, .contained, .extension, and .modifierExtension
fhir: fhir: fhir:|fhir:identifier ( [ Identifier ] ... ) ; # 0..* Business Identifiers for Imaging Selection fhir:status [ code ] ; # 1..1 available | entered-in-error | inactive | unknown fhir:category ( [ CodeableConcept ] ... ) ; # 0..* Classifies the imaging selection fhir:code [ CodeableConcept ] ; # 1..1 Imaging Selection purpose text or code fhir:subject [ Reference(Device|Group|Medication|Patient|Practitioner|Procedure|Specimen|Substance) ] ; # 0..1 Subject of the selected instances fhir:issued [ instant ] ; # 0..1 Date / Time when this imaging selection was createdfhir:fhir:performer ( [ # 0..* Selectors of the instances (human or machine) fhir:function [ CodeableConcept ] ; # 0..1 Type of performerfhir:|fhir:actor [ Reference(CareTeam|Device|HealthcareService|Organization|Patient|Practitioner| PractitionerRole|RelatedPerson) ] ; # 0..1 Author (human or machine) ] ... ) ;fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir:fhir:basedOn ( [ Reference(Appointment|CarePlan|ServiceRequest|Task) ] ... ) ; # 0..* Associated requests fhir:derivedFrom [ Reference(DocumentReference|ImagingStudy) ] ; # 0..1 The imaging study from which the imaging selection is derived fhir:studyUid [ id ] ; # 0..1 I DICOM Study Instance UID fhir:seriesUid [ id ] ; # 0..1 I DICOM Series Instance UID fhir:seriesNumber [ unsignedInt ] ; # 0..1 I DICOM Series Number fhir:frameOfReferenceUid [ id ] ; # 0..1 I The Frame of Reference UID for the selected images fhir:bodySite ( [ CodeableReference(BodyStructure) ] ... ) ; # 0..* Body part examined fhir:focus ( [ Reference(ImagingSelection) ] ... ) ; # 0..* Related resources that are the focus for the imaging selection fhir:endpoint ( [ Reference(Endpoint) ] ... ) ; # 0..* The network services providing retrieval for the images referenced in the imaging selection fhir:instance ( [ # 0..* I The selected instances fhir:uid [ id ] ; # 1..1 DICOM SOP Instance UID fhir:number [ unsignedInt ] ; # 0..1 DICOM Instance Numberfhir: fhir:<a href="imagingselection-definitions.html#ImagingSelection.instance.subset" title="Selected subset of the SOP Instance. The content and format of the subset item is determined by the SOP Class of the selected instance. May be one of: - A list of frame numbers selected from a multiframe SOP Instance. - A list of Content Item Observation UID values selected from a DICOM SR or other structured document SOP Instance. - A list of segment numbers selected from a segmentation SOP Instance. - A list of Region of Interest (ROI) numbers selected from a radiotherapy structure set SOP Instance." class="dict">subset fhir:<a href="imagingselection-definitions.html#ImagingSelection.instance.imageRegion2D" title="Each imaging selection instance or frame list might includes an image region, specified by a region type and a set of 2D coordinates. If the parent imagingSelection.instance contains a subset element of type frame, the image region applies to all frames in the subset list." class="dict">imageRegion2D fhir:fhir:sopClass [ oid ] ; # 0..1 DICOM SOP Class UID fhir:subset ( [ string ] ... ) ; # 0..* The selected subset of the SOP Instance fhir:imageRegion2D ( [ # 0..* I A specific 2D region in a DICOM image / frame fhir:regionType [ code ] ; # 1..1 point | polyline | multipoint | circle | ellipse fhir: The origin at the TLHC of the TLHC pixel is 0.0\0.0, the BRHC of the TLHC pixel is 1.0\1.0, and the BRHC of the BRHC pixel is the number of columns\rows in the image / frames. The values must be within the range 0\0 to the number of columns\rows in the image / frames." class="dict">coordinate ] ... ) ; fhir: fhir: fhir: The origin at the TLHC of the TLHC pixel is 0.0\0.0, the BRHC of the TLHC pixel is 1.0\1.0, and the BRHC of the BRHC pixel is the number of columns\rows in the image / frames. The values SHALL be within the range 0\0 to the number of columns\rows in the image / frames." class="dict">coordinate ( [ decimal ] ... ) ; # 1..* Specifies the coordinates that define the image region ] ... ) ; ] ... ) ; fhir:imageRegion3D ( [ # 0..* I A specific 3D region in a DICOM frame of reference fhir:regionType [ code ] ; # 1..1 point | multipoint | polyline | polygon | ellipse | ellipsoid fhir:coordinate ( [ decimal ] ... ) ; # 1..* Specifies the coordinates that define the image region ] ... ) ; ]
Changes from both R4 and R4B
This resource did not exist in Release R4
See the Full Difference for further information
This analysis is available for R4 as XML or JSON and for R4B as XML or JSON .
Additional definitions: Master Definition XML + JSON , XML Schema / Schematron + JSON Schema , ShEx (for Turtle ) + see the extensions , the spreadsheet version & the dependency analysis
| Path | ValueSet | Type | Documentation |
|---|---|---|---|
| ImagingSelection.status | ImagingSelectionStatus | Required |
The status of the ImagingSelection. |
| ImagingSelection.category |
|
|
|
|
|
KeyObjectSelectionDocumentTitle
|
Example |
Transitive closure of CID 7010 KeyObjectSelectionDocumentTitle |
| ImagingSelection.performer.function |
|
|
|
| ImagingSelection.bodySite | SNOMEDCTBodyStructures | Example |
This
value
set
includes
all
codes
from
SNOMED
CT
|
| ImagingSelection.instance.imageRegion2D.regionType | ImagingSelection2DGraphicType | Required |
The type of 2D coordinates describing a 2D image region. |
| ImagingSelection.imageRegion3D.regionType | ImagingSelection3DGraphicType | Required |
The type of coordinates describing a 3D image region. |
| UniqueKey | Level | Location | Description | Expression |
isl-1
| Rule | (base) | At least one of seriesUid or imageRegion3D shall be present | seriesUid.exists() or imageRegion3D.exists() |
isl-2
| Rule | (base) | seriesUid SHALL only be present if studyUid is present | seriesUid.empty() or studyUid.exists() |
isl-3
| Rule | (base) | seriesNumber SHALL only be present if seriesUid is present | seriesNumber.empty() or seriesUid.exists() |
isl-4
| Rule | (base) | instance SHALL only be present if seriesUid is present | instance.empty() or seriesUid.exists() |
isl-5
| Rule | (base) | imageRegion3D SHALL only be present if frameOfReferenceUid is present | imageRegion3D.empty() or frameOfReferenceUid.exists() |
isl-6
| Rule | (base) | imageRegion3D SHALL only be present if instance.imageRegion2D is not present | imageRegion3D.empty() or instance.imageRegion2D.empty() |
Some DICOM SOP Instances contain multiple sub-resources, such as frames, segments, etc.
An
Imaging
Selection
resource
may
MAY
specify
the
subset
of
these
that
are
included
in
the
selection
using
the
instance.subset
element.
The defined types of subsets are:
The type of subset is determined by the SOP Class of the parent instance.
Subsets can only reference sub-resources that are already defined within the selected DICOM SOP Instance.
The code and category element can be used to provide information relevant for applications that want to identify specific types of ImagingSelection resources.
For
example,
if
an
ImagingSelection
is
used
to
identify
a
set
of
images
that
make
up
a
volume
rendered
view,
the
code
could
contain
a
code
indicating
Volume
Rendering
-
such
as
RadLex
RID35862
-
and
the
category
could
contain
values
of
the
DICOM
Image
Type
(0008,0008)
attribute
-
such
as
DERVIED
and
SECONDARY.
{
"resource": {
"resourceType": "ImagingSelection",
"id": "fa8e0948175f3117a3b8c4be2ff972ec",
"subject": {
"reference": "Patient/acb045960122378999c97cd7ca532f8b"
},
"code": {
"coding": [
{
"system": "http://radlex.org/",
"code": "RID12769",
"display": "volume rendering"
}
]
},
"category": [
{
"text": "DERIVED"
},
{
"text": "SECONDARY"
}
]
}
}
Search parameters for this resource. See also the full list of search parameters for this resource , and check the Extensions registry for search parameters on extensions related to this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.
| Name | Type | Description | Expression | In Common |
| based-on | reference | The request associated with an imaging selection |
ImagingSelection.basedOn
( Appointment , |
|
| body-site | token | The body site code associated with the imaging selection | ImagingSelection.bodySite.concept | |
| body-structure | reference | The body structure associated with the imaging selection | ImagingSelection.bodySite.reference | |
| category | token | The imaging selection category | ImagingSelection.category | |
| code | token |
The
imaging
selection
|
|
|
| derived-from | reference | The imaging study from which the imaging selection was derived |
ImagingSelection.derivedFrom
( ImagingStudy , DocumentReference ) |
|
| identifier | token | Identifiers for the imaging selection | ImagingSelection.identifier |
|
| issued | date | The date / time the imaging selection was created | ImagingSelection.issued | |
| patient | reference | Who the study is about |
ImagingSelection.subject.where(resolve()
is
Patient)
( Patient ) |
|
| status | token | The status of the imaging selection | ImagingSelection.status | |
| study-uid | token | The DICOM Study Instance UID from which the images were selected | ImagingSelection.studyUid | |
| subject | reference | The subject of the Imaging Selection, such as the associated Patient |
ImagingSelection.subject
( Practitioner , Group , Specimen , |