Diagnostics
This
page
is
part
of
the
Continuous
Integration
Build
of
FHIR
Specification
(v5.0.0:
R5
-
STU
).
This
is
the
current
published
version
in
it's
permanent
home
(it
will
always
(will
be
available
incorrect/inconsistent
at
this
URL).
For
a
full
list
of
available
versions,
see
times).
See
the
Directory
of
published
versions
|
Responsible
Owner:
Imaging
Integration
Work
Group
|
|
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
a
set
of
frames
or
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
might
be:
May
Can
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
be
are
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
an
ImagingSelection
resource
is
used
to
specify
the
set
store
details
of
an
entire
DICOM
images,
frames,
waveforms
or
documents
used
Study
and
its
relationship
to
make
the
Observation
other
resources,
such
as
Patient
.
By
contrast,
an
Observation
ServiceRequest
references
an
ImagingStudy
and
Encounter
.
The
ImagingSelection
if
it
does
not
depend
on
any
specific
set
resource
is
used
to
reference
a
subset
of
images,
frames,
waveforms
or
documents.
a
study.
Instances
of
this
resource
are
created
for
specific
clinical
purposes
and
are
unlikely
to
change
once
created.
An
Observation
references
an
ImagingSelection
to
specify
an
image
region
corresponding
typically
relates
to
the
measurement
value
expressed
a
set
of
images
in
the
Observation
.
following
ways.
The
DocumentReference
has
limited
ability
resource
is
used
to
reference
multiple
images
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.
Structure
| Name | Flags | Card. | Type |
Description
&
Constraints
Filter:
|
|---|---|---|---|---|
ImagingSelection
|
|
DomainResource |
A
selection
of
DICOM
SOP
instances
+ 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 + Rule: if present, instance.imageRegion2D.coordinate SHALL have a value count that is a multiple of 2 + Rule: if present, imageRegion3D.coordinate SHALL have a value count that is a multiple of 3 + Rule: modality SHALL only be present if seriesUid is present + Rule: only one of instance.frameNumber, instance.referencedContentItemIdentifier, instance.segmentNumber, instance.regionOfInterest and instance.waveFormChannel SHALL be present + Rule: if present, instance.waveFormChannel SHALL have a value count that is a multiple of 2 Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension |
|
identifier
|
Σ | 0..* | Identifier |
Business
|
status
|
?! Σ | 1..1 | code |
available
|
entered-in-error
|
inactive
|
unknown
Binding: Imaging Selection Status ( Required ) |
|
category
|
Σ | 0..* | CodeableConcept |
Classifies
the
imaging
selection
Binding: KeyObjectSelectionDocumentTitle
(
Preferred
)
|
|
modality
| Σ C | 0..1 | CodeableConcept |
The
distinct
modality
Binding: Modality
(
Extensible
)
|
|
code
| Σ | 1..1 | CodeableConcept |
Imaging
Selection
purpose
text
or
code
Binding: Image Reference Type
(
Preferred
)
|
subject
| Σ | 0..1 |
Reference
(
Patient
|
Group
|
Device
|
|
Who
or
what
is
the
subject
of
the
|
|
issued
|
Σ | 0..1 | instant |
When
the
imaging
selection
was
created
|
performer
|
Σ | 0..* | BackboneElement |
Who
performed
imaging
selection
and
what
they
did
|
function
|
Σ | 0..1 | CodeableConcept |
Type
of
Binding: ImagingStudy series performer function ( Extensible ) |
actor
|
Σ | 1..1 | Reference ( Practitioner | PractitionerRole | Device | Organization | CareTeam | Patient | RelatedPerson | HealthcareService ) |
Who
performed
the
imaging
selection
|
|
basedOn
|
Σ | 0..* |
Reference
(
CarePlan
|
ServiceRequest
|
Appointment
|
|
Fulfills
plan
or
|
|
derivedFrom
|
Σ | 0..1 | Reference ( ImagingStudy | DocumentReference ) |
The
imaging
study
from
which
the
imaging
selection
is
derived
|
|
studyUid
|
Σ
C
|
0..1 |
|
DICOM
Study
Instance
UID
|
|
seriesUid
|
Σ C | 0..1 | id |
DICOM
Series
Instance
UID
|
|
seriesNumber
|
Σ C | 0..1 | unsignedInt |
Numeric
identifier
of
the
selected
series
|
|
frameOfReferenceUid
|
Σ C | 0..1 | id |
The
Frame
of
Reference
UID
for
the
selected
images
|
|
bodySite
|
Σ | 0..* | CodeableReference ( BodyStructure ) |
Selected
anatomic
structure
Binding: SNOMED CT Body Structures ( Example ) |
|
focus
|
Σ | 0..* | Reference ( ImagingSelection ) |
Related
|
|
endpoint
| Σ | 0..* | Reference ( Endpoint ) |
The
network
services
providing
access
for
the
subset
of
the
study
|
|
instance
|
Σ C | 0..* | BackboneElement |
The
selected
instances
|
|
uid
|
Σ | 1..1 | id |
DICOM
SOP
Instance
UID
|
|
number
|
Σ | 0..1 | unsignedInt |
The
number
of
this
instance
in
the
series
|
|
sopClass
|
0..1 |
|
DICOM
|
|
|
frameNumber
|
C
|
0..* | positiveInt |
Selected
frames
|
|
|
C | 0..* |
positiveInt
|
Selected
content
items
|
|
segmentNumber
|
| 0..* | positiveInt |
Selected
segments
|
|
regionOfInterest
| C | 0..* | positiveInt |
Selected
regions
of
|
|
waveFormChannel
| C | 0..* | positiveInt |
Selected
waveform
channel
|
imageRegion2D
|
C | 0..* | BackboneElement |
A
|
regionType
|
1..1 | code |
point
|
polyline
|
Binding: Imaging |
|
|
coordinate
|
C | 1..* | decimal |
The
coordinates
that
define
the
image
region
This repeating element order: The values are an ordered set of (x, y) coordinates. |
|
imageRegion3D
|
C | 0..* | BackboneElement |
A
|
|
regionType
|
1..1 | code |
point
|
multipoint
|
polyline
|
polygon
|
ellipse
|
ellipsoid
Binding: Imaging |
|
|
coordinate
|
C | 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> < < <</function> <| </actor><identifier><!-- 0..* Identifier Business identifier for imaging selection --></identifier> <status value="[code]"/><!-- 1..1 available | entered-in-error | inactive | unknown --> <category><!-- 0..* CodeableConcept Classifies the imaging selection<| </basedOn> <</category> <</code> < <</derivedFrom> <</endpoint> < < < <</bodySite> <</focus> < < < <</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"> < <<a href="imagingselection-definitions.html#ImagingSelection.instance.imageRegion2D.coordinate" title="The coordinates describing the image region. Encoded as a set of (column, row) pairs that denote positions in the selected image / frames specified with sub-pixel resolution. 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"><basedOn><!-- 0..* Reference(Appointment|CarePlan|ServiceRequest|Task) Fulfills plan or order --></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 Numeric identifier of the selected series --> <frameOfReferenceUid value="[id]"/><!-- I 0..1 The Frame of Reference UID for the selected images --> <bodySite><!-- 0..* CodeableReference(BodyStructure) Selected anatomic structure --></bodySite> <focus><!-- 0..* Reference(ImagingSelection) Related resources that are the focus for the imaging selection --></focus> <endpoint><!-- 0..* Reference(Endpoint) The network services providing access for the subset of the study --></endpoint> <instance> <!-- I 0..* The selected instances --> <uid value="[id]"/><!-- 1..1 DICOM SOP Instance UID --> <number value="[unsignedInt]"/><!-- 0..1 The number of this instance in the series --> <sopClass value="[oid]"/><!-- 0..1 DICOM class type --> <frameNumber value="[positiveInt]"/><!-- I 0..* Selected frames --> <referencedContentItemIdentifier value="[positiveInt]"/><!-- I 0..* Selected content items --> <segmentNumber value="[positiveInt]"/><!-- I 0..* Selected segments --> <regionOfInterest value="[positiveInt]"/><!-- I 0..* Selected regions of interest --> <waveFormChannel value="[positiveInt]"/><!-- I 0..* Selected waveform channel --> <imageRegion2D> <!-- I 0..* A 2D region in an image --> <regionType value="[code]"/><!-- 1..1 point | polyline | multipoint | circle | ellipse --> <coordinate value="[decimal]"/><!-- I 1..* The coordinates that define the image region --> </imageRegion2D>< < < </imageRegion3D></instance> <imageRegion3D> <!-- I 0..* A 3D region in a DICOM frame of reference --> <regionType value="[code]"/><!-- 1..1 point | multipoint | polyline | polygon | ellipse | ellipsoid --> <coordinate value="[decimal]"/><!-- I 1..* Specifies the coordinates that define the image region --> </imageRegion3D> </ImagingSelection>
JSON Template
{
"resourceType" : "",
"resourceType" : "ImagingSelection",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"
"
"|
"
"
"
"|
"identifier" : [{ Identifier }], // Business identifier for imaging selection
"status" : "<code>", // R! available | entered-in-error | inactive | unknown
"category" : [{ CodeableConcept }], // Classifies the imaging selection
"modality" : { CodeableConcept }, // I The distinct modality
"code" : { CodeableConcept }, // R! Imaging Selection purpose text or code
"subject" : { Reference(Device|Group|Medication|Patient|Practitioner|
Procedure|Specimen|Substance) }, // Who or what is the subject of the imaging selection
"issued" : "<instant>", // When the imaging selection was created
"performer" : [{ // Who performed imaging selection and what they did
"function" : { CodeableConcept }, // Type of performance
"actor" : { Reference(CareTeam|Device|HealthcareService|Organization|
Patient|Practitioner|PractitionerRole|RelatedPerson) } // R! Who performed the imaging selection
}],
"|
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"<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
"
"<a href="imagingselection-definitions.html#ImagingSelection.instance.imageRegion2D.coordinate" title="The coordinates describing the image region. Encoded as a set of (column, row) pairs that denote positions in the selected image / frames specified with sub-pixel resolution.
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
}],
"
"
"
"basedOn" : [{ Reference(Appointment|CarePlan|ServiceRequest|Task) }], // Fulfills plan or order
"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 Numeric identifier of the selected series
"frameOfReferenceUid" : "<id>", // I The Frame of Reference UID for the selected images
"bodySite" : [{ CodeableReference(BodyStructure) }], // Selected anatomic structure
"focus" : [{ Reference(ImagingSelection) }], // Related resources that are the focus for the imaging selection
"endpoint" : [{ Reference(Endpoint) }], // The network services providing access for the subset of the study
"instance" : [{ // I The selected instances
"uid" : "<id>", // R! DICOM SOP Instance UID
"number" : "<unsignedInt>", // The number of this instance in the series
"sopClass" : "<oid>", // DICOM class type
"frameNumber" : ["<positiveInt>"], // I Selected frames
"referencedContentItemIdentifier" : ["<positiveInt>"], // I Selected content items
"segmentNumber" : ["<positiveInt>"], // I Selected segments
"regionOfInterest" : ["<positiveInt>"], // I Selected regions of interest
"waveFormChannel" : ["<positiveInt>"], // I Selected waveform channel
"imageRegion2D" : [{ // I A 2D region in an image
"regionType" : "<code>", // R! point | polyline | multipoint | circle | ellipse
"coordinate" : [<decimal>] // I R! The coordinates that define the image region
}]
}],
"imageRegion3D" : [{ // I A 3D region in a DICOM frame of reference
"regionType" : "<code>", // R! point | multipoint | polyline | polygon | ellipse | ellipsoid
"coordinate" : [<decimal>] // I R! Specifies the coordinates that define the image region
}]
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .[ a fhir:;[ a fhir:ImagingSelection; fhir:nodeRole fhir:treeRoot; # if this is the parser root# from # from fhir: fhir: fhir:| fhir: fhir: fhir: fhir:|# from Resource: fhir:id, fhir:meta, fhir:implicitRules, and fhir:language # from DomainResource: fhir:text, fhir:contained, fhir:extension, and fhir:modifierExtension fhir:identifier ( [ Identifier ] ... ) ; # 0..* Business identifier for imaging selection fhir:status [ code ] ; # 1..1 available | entered-in-error | inactive | unknown fhir:category ( [ CodeableConcept ] ... ) ; # 0..* Classifies the imaging selection fhir:modality [ CodeableConcept ] ; # 0..1 I The distinct modality fhir:code [ CodeableConcept ] ; # 1..1 Imaging Selection purpose text or code fhir:subject [ Reference(Device|Group|Medication|Patient|Practitioner|Procedure|Specimen|Substance) ] ; # 0..1 Who or what is the subject of the imaging selection fhir:issued [ instant ] ; # 0..1 When the imaging selection was created fhir:performer ( [ # 0..* Who performed imaging selection and what they did fhir:function [ CodeableConcept ] ; # 0..1 Type of performance fhir:actor [ Reference(CareTeam|Device|HealthcareService|Organization|Patient|Practitioner| PractitionerRole|RelatedPerson) ] ; # 1..1 Who performed the imaging selection ] ... ) ;fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: 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:<a href="imagingselection-definitions.html#ImagingSelection.instance.imageRegion2D.coordinate" title="The coordinates describing the image region. Encoded as a set of (column, row) pairs that denote positions in the selected image / frames specified with sub-pixel resolution. 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:fhir:basedOn ( [ Reference(Appointment|CarePlan|ServiceRequest|Task) ] ... ) ; # 0..* Fulfills plan or order 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 Numeric identifier of the selected series fhir:frameOfReferenceUid [ id ] ; # 0..1 I The Frame of Reference UID for the selected images fhir:bodySite ( [ CodeableReference(BodyStructure) ] ... ) ; # 0..* Selected anatomic structure fhir:focus ( [ Reference(ImagingSelection) ] ... ) ; # 0..* Related resources that are the focus for the imaging selection fhir:endpoint ( [ Reference(Endpoint) ] ... ) ; # 0..* The network services providing access for the subset of the study fhir:instance ( [ # 0..* I The selected instances fhir:uid [ id ] ; # 1..1 DICOM SOP Instance UID fhir:number [ unsignedInt ] ; # 0..1 The number of this instance in the series fhir:sopClass [ oid ] ; # 0..1 DICOM class type fhir:frameNumber ( [ positiveInt ] ... ) ; # 0..* I Selected frames fhir:referencedContentItemIdentifier ( [ positiveInt ] ... ) ; # 0..* I Selected content items fhir:segmentNumber ( [ positiveInt ] ... ) ; # 0..* I Selected segments fhir:regionOfInterest ( [ positiveInt ] ... ) ; # 0..* I Selected regions of interest fhir:waveFormChannel ( [ positiveInt ] ... ) ; # 0..* I Selected waveform channel fhir:imageRegion2D ( [ # 0..* I A 2D region in an image fhir:regionType [ code ] ; # 1..1 point | polyline | multipoint | circle | ellipse fhir:coordinate ( [ decimal ] ... ) ; # 1..* I The coordinates that define the image region ] ... ) ; ] ... ) ; fhir:imageRegion3D ( [ # 0..* I A 3D region in a DICOM frame of reference fhir:regionType [ code ] ; # 1..1 point | multipoint | polyline | polygon | ellipse | ellipsoid fhir:coordinate ( [ decimal ] ... ) ; # 1..* I 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
Filter:
|
|---|---|---|---|---|
|
ImagingSelection
|
|
DomainResource |
A
selection
of
DICOM
SOP
instances
+ 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 + Rule: if present, instance.imageRegion2D.coordinate SHALL have a value count that is a multiple of 2 + Rule: if present, imageRegion3D.coordinate SHALL have a value count that is a multiple of 3 + Rule: modality SHALL only be present if seriesUid is present + Rule: only one of instance.frameNumber, instance.referencedContentItemIdentifier, instance.segmentNumber, instance.regionOfInterest and instance.waveFormChannel SHALL be present + Rule: if present, instance.waveFormChannel SHALL have a value count that is a multiple of 2 Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension |
|
|
identifier
|
Σ | 0..* | Identifier |
Business
|
|
status
|
?! Σ | 1..1 | code |
available
|
entered-in-error
|
inactive
|
unknown
Binding: Imaging Selection Status ( Required ) |
|
category
|
Σ | 0..* | CodeableConcept |
Classifies
the
imaging
selection
Binding: KeyObjectSelectionDocumentTitle
(
Preferred
)
|
|
modality
| Σ C | 0..1 | CodeableConcept |
The
distinct
modality
Binding: Modality
(
Extensible
)
|
|
code
| Σ | 1..1 | CodeableConcept |
Imaging
Selection
purpose
text
or
code
Binding: Image Reference Type
(
Preferred
)
|
|
subject
| Σ | 0..1 |
Reference
(
Patient
|
Group
|
Device
|
|
Who
or
what
is
the
subject
of
the
|
|
issued
|
Σ | 0..1 | instant |
When
the
imaging
selection
was
created
|
|
performer
|
Σ | 0..* | BackboneElement |
Who
performed
imaging
selection
and
what
they
did
|
|
function
|
Σ | 0..1 | CodeableConcept |
Type
of
Binding: ImagingStudy series performer function ( Extensible ) |
|
actor
|
Σ | 1..1 | Reference ( Practitioner | PractitionerRole | Device | Organization | CareTeam | Patient | RelatedPerson | HealthcareService ) |
Who
performed
the
imaging
selection
|
|
basedOn
|
Σ | 0..* |
Reference
(
CarePlan
|
ServiceRequest
|
Appointment
|
|
Fulfills
plan
or
|
|
derivedFrom
|
Σ | 0..1 | Reference ( ImagingStudy | DocumentReference ) |
The
imaging
study
from
which
the
imaging
selection
is
derived
|
|
studyUid
|
Σ
C
|
0..1 |
|
DICOM
Study
Instance
UID
|
|
seriesUid
|
Σ C | 0..1 | id |
DICOM
Series
Instance
UID
|
|
seriesNumber
|
Σ C | 0..1 | unsignedInt |
Numeric
identifier
of
the
selected
series
|
|
frameOfReferenceUid
|
Σ C | 0..1 | id |
The
Frame
of
Reference
UID
for
the
selected
images
|
|
bodySite
|
Σ | 0..* | CodeableReference ( BodyStructure ) |
Selected
anatomic
structure
Binding: SNOMED CT Body Structures ( Example ) |
|
focus
|
Σ | 0..* | Reference ( ImagingSelection ) |
Related
|
|
endpoint
| Σ | 0..* | Reference ( Endpoint ) |
The
network
services
providing
access
for
the
subset
of
the
study
|
|
instance
|
Σ C | 0..* | BackboneElement |
The
selected
instances
|
|
uid
|
Σ | 1..1 | id |
DICOM
SOP
Instance
UID
|
|
number
|
Σ | 0..1 | unsignedInt |
The
number
of
this
instance
in
the
series
|
|
sopClass
|
0..1 |
|
DICOM
|
|
|
frameNumber
|
C | 0..* | positiveInt |
Selected
frames
|
|
|
C | 0..* |
positiveInt
|
Selected
content
items
|
|
segmentNumber
|
| 0..* | positiveInt |
Selected
segments
|
|
regionOfInterest
| C | 0..* | positiveInt |
Selected
regions
of
|
|
waveFormChannel
| C | 0..* | positiveInt |
Selected
waveform
channel
|
|
imageRegion2D
|
C | 0..* | BackboneElement |
A
|
|
regionType
|
1..1 | code |
point
|
polyline
|
Binding: Imaging |
|
|
coordinate
|
C | 1..* | decimal |
The
coordinates
that
define
the
image
region
This repeating element order: The values are an ordered set of (x, y) coordinates. |
|
imageRegion3D
|
C | 0..* | BackboneElement |
A
|
|
regionType
|
1..1 | code |
point
|
multipoint
|
polyline
|
polygon
|
ellipse
|
ellipsoid
Binding: Imaging |
|
|
coordinate
|
C | 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"><</identifier> < <| </subject> < < <</function> <| </actor><identifier><!-- 0..* Identifier Business identifier for imaging selection --></identifier> <status value="[code]"/><!-- 1..1 available | entered-in-error | inactive | unknown --> <category><!-- 0..* CodeableConcept Classifies the imaging selection<| </basedOn> <</category> <</code> < <</derivedFrom> <</endpoint> < < < <</bodySite> <</focus> < < < <</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"> < <<a href="imagingselection-definitions.html#ImagingSelection.instance.imageRegion2D.coordinate" title="The coordinates describing the image region. Encoded as a set of (column, row) pairs that denote positions in the selected image / frames specified with sub-pixel resolution. 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"><basedOn><!-- 0..* Reference(Appointment|CarePlan|ServiceRequest|Task) Fulfills plan or order --></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 Numeric identifier of the selected series --> <frameOfReferenceUid value="[id]"/><!-- I 0..1 The Frame of Reference UID for the selected images --> <bodySite><!-- 0..* CodeableReference(BodyStructure) Selected anatomic structure --></bodySite> <focus><!-- 0..* Reference(ImagingSelection) Related resources that are the focus for the imaging selection --></focus> <endpoint><!-- 0..* Reference(Endpoint) The network services providing access for the subset of the study --></endpoint> <instance> <!-- I 0..* The selected instances --> <uid value="[id]"/><!-- 1..1 DICOM SOP Instance UID --> <number value="[unsignedInt]"/><!-- 0..1 The number of this instance in the series --> <sopClass value="[oid]"/><!-- 0..1 DICOM class type --> <frameNumber value="[positiveInt]"/><!-- I 0..* Selected frames --> <referencedContentItemIdentifier value="[positiveInt]"/><!-- I 0..* Selected content items --> <segmentNumber value="[positiveInt]"/><!-- I 0..* Selected segments --> <regionOfInterest value="[positiveInt]"/><!-- I 0..* Selected regions of interest --> <waveFormChannel value="[positiveInt]"/><!-- I 0..* Selected waveform channel --> <imageRegion2D> <!-- I 0..* A 2D region in an image --> <regionType value="[code]"/><!-- 1..1 point | polyline | multipoint | circle | ellipse --> <coordinate value="[decimal]"/><!-- I 1..* The coordinates that define the image region --> </imageRegion2D>< < < </imageRegion3D></instance> <imageRegion3D> <!-- I 0..* A 3D region in a DICOM frame of reference --> <regionType value="[code]"/><!-- 1..1 point | multipoint | polyline | polygon | ellipse | ellipsoid --> <coordinate value="[decimal]"/><!-- I 1..* Specifies the coordinates that define the image region --> </imageRegion3D> </ImagingSelection>
JSON Template
{
"resourceType" : "",
"resourceType" : "ImagingSelection",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"
"
"|
"
"
"
"|
"identifier" : [{ Identifier }], // Business identifier for imaging selection
"status" : "<code>", // R! available | entered-in-error | inactive | unknown
"category" : [{ CodeableConcept }], // Classifies the imaging selection
"modality" : { CodeableConcept }, // I The distinct modality
"code" : { CodeableConcept }, // R! Imaging Selection purpose text or code
"subject" : { Reference(Device|Group|Medication|Patient|Practitioner|
Procedure|Specimen|Substance) }, // Who or what is the subject of the imaging selection
"issued" : "<instant>", // When the imaging selection was created
"performer" : [{ // Who performed imaging selection and what they did
"function" : { CodeableConcept }, // Type of performance
"actor" : { Reference(CareTeam|Device|HealthcareService|Organization|
Patient|Practitioner|PractitionerRole|RelatedPerson) } // R! Who performed the imaging selection
}],
"|
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"<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
"
"<a href="imagingselection-definitions.html#ImagingSelection.instance.imageRegion2D.coordinate" title="The coordinates describing the image region. Encoded as a set of (column, row) pairs that denote positions in the selected image / frames specified with sub-pixel resolution.
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
}],
"
"
"
"basedOn" : [{ Reference(Appointment|CarePlan|ServiceRequest|Task) }], // Fulfills plan or order
"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 Numeric identifier of the selected series
"frameOfReferenceUid" : "<id>", // I The Frame of Reference UID for the selected images
"bodySite" : [{ CodeableReference(BodyStructure) }], // Selected anatomic structure
"focus" : [{ Reference(ImagingSelection) }], // Related resources that are the focus for the imaging selection
"endpoint" : [{ Reference(Endpoint) }], // The network services providing access for the subset of the study
"instance" : [{ // I The selected instances
"uid" : "<id>", // R! DICOM SOP Instance UID
"number" : "<unsignedInt>", // The number of this instance in the series
"sopClass" : "<oid>", // DICOM class type
"frameNumber" : ["<positiveInt>"], // I Selected frames
"referencedContentItemIdentifier" : ["<positiveInt>"], // I Selected content items
"segmentNumber" : ["<positiveInt>"], // I Selected segments
"regionOfInterest" : ["<positiveInt>"], // I Selected regions of interest
"waveFormChannel" : ["<positiveInt>"], // I Selected waveform channel
"imageRegion2D" : [{ // I A 2D region in an image
"regionType" : "<code>", // R! point | polyline | multipoint | circle | ellipse
"coordinate" : [<decimal>] // I R! The coordinates that define the image region
}]
}],
"imageRegion3D" : [{ // I A 3D region in a DICOM frame of reference
"regionType" : "<code>", // R! point | multipoint | polyline | polygon | ellipse | ellipsoid
"coordinate" : [<decimal>] // I R! Specifies the coordinates that define the image region
}]
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .[ a fhir:;[ a fhir:ImagingSelection; fhir:nodeRole fhir:treeRoot; # if this is the parser root# from # from fhir: fhir: fhir:| fhir: fhir: fhir: fhir:|# from Resource: fhir:id, fhir:meta, fhir:implicitRules, and fhir:language # from DomainResource: fhir:text, fhir:contained, fhir:extension, and fhir:modifierExtension fhir:identifier ( [ Identifier ] ... ) ; # 0..* Business identifier for imaging selection fhir:status [ code ] ; # 1..1 available | entered-in-error | inactive | unknown fhir:category ( [ CodeableConcept ] ... ) ; # 0..* Classifies the imaging selection fhir:modality [ CodeableConcept ] ; # 0..1 I The distinct modality fhir:code [ CodeableConcept ] ; # 1..1 Imaging Selection purpose text or code fhir:subject [ Reference(Device|Group|Medication|Patient|Practitioner|Procedure|Specimen|Substance) ] ; # 0..1 Who or what is the subject of the imaging selection fhir:issued [ instant ] ; # 0..1 When the imaging selection was created fhir:performer ( [ # 0..* Who performed imaging selection and what they did fhir:function [ CodeableConcept ] ; # 0..1 Type of performance fhir:actor [ Reference(CareTeam|Device|HealthcareService|Organization|Patient|Practitioner| PractitionerRole|RelatedPerson) ] ; # 1..1 Who performed the imaging selection ] ... ) ;fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: 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:<a href="imagingselection-definitions.html#ImagingSelection.instance.imageRegion2D.coordinate" title="The coordinates describing the image region. Encoded as a set of (column, row) pairs that denote positions in the selected image / frames specified with sub-pixel resolution. 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:fhir:basedOn ( [ Reference(Appointment|CarePlan|ServiceRequest|Task) ] ... ) ; # 0..* Fulfills plan or order 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 Numeric identifier of the selected series fhir:frameOfReferenceUid [ id ] ; # 0..1 I The Frame of Reference UID for the selected images fhir:bodySite ( [ CodeableReference(BodyStructure) ] ... ) ; # 0..* Selected anatomic structure fhir:focus ( [ Reference(ImagingSelection) ] ... ) ; # 0..* Related resources that are the focus for the imaging selection fhir:endpoint ( [ Reference(Endpoint) ] ... ) ; # 0..* The network services providing access for the subset of the study fhir:instance ( [ # 0..* I The selected instances fhir:uid [ id ] ; # 1..1 DICOM SOP Instance UID fhir:number [ unsignedInt ] ; # 0..1 The number of this instance in the series fhir:sopClass [ oid ] ; # 0..1 DICOM class type fhir:frameNumber ( [ positiveInt ] ... ) ; # 0..* I Selected frames fhir:referencedContentItemIdentifier ( [ positiveInt ] ... ) ; # 0..* I Selected content items fhir:segmentNumber ( [ positiveInt ] ... ) ; # 0..* I Selected segments fhir:regionOfInterest ( [ positiveInt ] ... ) ; # 0..* I Selected regions of interest fhir:waveFormChannel ( [ positiveInt ] ... ) ; # 0..* I Selected waveform channel fhir:imageRegion2D ( [ # 0..* I A 2D region in an image fhir:regionType [ code ] ; # 1..1 point | polyline | multipoint | circle | ellipse fhir:coordinate ( [ decimal ] ... ) ; # 1..* I The coordinates that define the image region ] ... ) ; ] ... ) ; fhir:imageRegion3D ( [ # 0..* I A 3D region in a DICOM frame of reference fhir:regionType [ code ] ; # 1..1 point | multipoint | polyline | polygon | ellipse | ellipsoid fhir:coordinate ( [ decimal ] ... ) ; # 1..* I 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 |
|
|
|
| ImagingSelection.modality |
|
|
Transitive
closure
of
CID
|
| ImagingSelection.code |
|
|
The type of image reference specified by an imaging selection. |
| ImagingSelection.performer.function | ImagingStudySeriesPerformerFunction | Extensible |
|
| 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.exists() implies studyUid.exists() |
|
isl-3
| Rule | (base) | seriesNumber SHALL only be present if seriesUid is present | seriesNumber.exists() implies seriesUid.exists() |
|
isl-4
| Rule | (base) | instance SHALL only be present if seriesUid is present | instance.exists() implies seriesUid.exists() |
|
isl-5
| Rule | (base) | imageRegion3D SHALL only be present if frameOfReferenceUid is present | imageRegion3D.exists() implies frameOfReferenceUid.exists() |
|
isl-6
| Rule | (base) | imageRegion3D SHALL only be present if instance.imageRegion2D is not present | imageRegion3D.exists() implies instance.imageRegion2D.empty() |
|
isl-7
| Rule | (base) | if present, instance.imageRegion2D.coordinate SHALL have a value count that is a multiple of 2 | instance.imageRegion2D.coordinate.exists() implies instance.imageRegion2D.coordinate.count() mod 2 = 0 |
|
isl-8
| Rule | (base) | if present, imageRegion3D.coordinate SHALL have a value count that is a multiple of 3 | imageRegion3D.coordinate.exists() implies imageRegion3D.coordinate.count() mod 3 = 0 |
|
isl-9
| Rule | (base) | modality SHALL only be present if seriesUid is present | modality.exists() implies seriesUid.exists() |
|
isl-10
| Rule | (base) | only one of instance.frameNumber, instance.referencedContentItemIdentifier, instance.segmentNumber, instance.regionOfInterest and instance.waveFormChannel SHALL be present | (instance.frameNumber.exists() implies (instance.referencedContentItemIdentifier.exists() or instance.segmentNumber.exists() or instance.regionOfInterest.exists() or instance.waveFormChannel.exists()).not()) and (instance.referencedContentItemIdentifier.exists() implies (instance.frameNumber.exists() or instance.segmentNumber.exists() or instance.regionOfInterest.exists() or instance.waveFormChannel.exists()).not()) and (instance.segmentNumber.exists() implies (instance.frameNumber.exists() or instance.referencedContentItemIdentifier.exists() or instance.regionOfInterest.exists() or instance.waveFormChannel.exists()).not()) and (instance.regionOfInterest.exists() implies (instance.frameNumber.exists() or instance.referencedContentItemIdentifier.exists() or instance.segmentNumber.exists() or instance.waveFormChannel.exists()).not()) and (instance.waveFormChannel.exists() implies (instance.frameNumber.exists() or instance.referencedContentItemIdentifier.exists() or instance.segmentNumber.exists() or instance.regionOfInterest.exists()).not()) |
|
isl-11
| Rule | (base) | if present, instance.waveFormChannel SHALL have a value count that is a multiple of 2 | instance.waveFormChannel.exists() implies instance.waveFormChannel.count() mod 2 = 0 |
Some
DICOM
SOP
Instances
contain
multiple
sub-resources,
such
as
frames,
segments,
etc.
An
Imaging
Selection
resource
may
can
specify
the
subset
of
these
that
are
included
in
the
selection
using
the
instance.subset
element.
The
defined
types
of
subsets
are:
following
elements.
instance.frameNumber
-
Frames
selected
from
a
multiframe
SOP
Instance
instance.referencedContentItemIdentifier
-
Referenced
Content
Item
instance.segmentNumber
-
Segments
selected
from
a
segmentation
SOP
Instance
instance.regionOfInterest
-
Regions
of
interest
selected
from
a
radiotherapy
structure
set
SOP
Instance
instance.waveFormChannel
-
Channels
selected
from
a
waveform
SOP
Instance
The
value
of
the
instance.sopClass
element
determines
which
type
of
subset
can
be
present.
For example:
instance.sopClass
has
a
value
of
urn:oid:1.2.840.10008.5.1.4.1.1.2.1
,
this
indicates
that
the
instance
is
instance.frameNumber
can
be
included
to
specify
a
list
of
frames
instance.sopClass
has
a
value
of
urn:oid:1.2.840.10008.5.1.4.1.1.88.22
,
this
indicates
that
the
instance
is
Enhanced
SR
and
therefore
instance.referencedContentItemIdentifier
can
be
included
to
specify
a
list
of
content
item
identifiers
Note: Because an imaging selection instance is limited to a single DICOM Series and each DICOM Series can contain only one type of instance - image, SR document, radiotherapy object, etc. - each imaging selection instance can only contain one type of subset.
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"
}
]
}
}
This section outlines several imaging selection types, each listing a set of resource elements that are required and/or typically present in the selection. Some types require only a minimal set of elements, while others require a comprehensive list to ensure clarity.
An imaging selection that points to one single-frame image requires:
studyUid
to
identify
the
DICOM
Study
that
contains
the
image
seriesUid
to
identify
the
Series
within
the
Study
that
contains
the
image
instance
containing
a
single
entry
that
specifies:
uid
to
identify
the
SOP
Instance
UID
of
the
selected
image
While not required, this type of selection typically includes:
frameOfReferenceUid
to
identify
the
coordinate
system
of
the
image
instance.sopClass
to
specify
the
SOP
Class
UID
of
the
See Single-Frame Image Selection example .
Subsets
can
only
reference
sub-resources
An
imaging
selection
that
are
already
defined
points
to
frames
in
a
multiframe
image
requires:
studyUid
to
identify
the
DICOM
Study
that
contains
the
image
seriesUid
to
identify
the
Series
within
the
Study
that
contains
the
image
instance
containing
a
single
entry
that
specifies:
uid
to
identify
the
SOP
Instance
UID
of
the
selected
image
frameNumber
to
identify
the
list
of
frames
included
in
the
selection
While not required, this type of selection typically includes:
frameOfReferenceUid
to
identify
the
coordinate
system
of
the
image
instance.sopClass
to
specify
the
SOP
Class
UID
of
the
selected
image
See Multiframe Image Selection example .
An imaging selection that points to a 2D region on an image requires:
studyUid
to
identify
the
DICOM
Study
that
contains
the
image
seriesUid
to
identify
the
Series
within
the
Study
that
contains
the
image
instance
containing
a
single
entry
that
specifies:
uid
to
identify
the
SOP
Instance
UID
of
the
selected
image
imageRegion2D
containing
regionType
specifying
the
type
of
image
region
coordinate
specifying
the
x
and
y
coordinates
that
define
the
image
region
in
image
pixel
space
While not required, this type of selection typically includes:
frameOfReferenceUid
to
identify
the
coordinate
system
of
the
image
instance.sopClass
to
specify
the
SOP
Class
UID
of
the
selected
image
See 2D Image Region Selection example .
An imaging selection that points to a 3D region requires:
frameOfReferenceUid
to
identify
the
coordinate
system
that
includes
the
specified
coordinates
imageRegion3D
containing
regionType
specifying
the
type
of
image
region
coordinate
specifying
the
x,
y
and
z
coordinates
that
define
the
3D
region
This type of selection can also specify a set of images but this is not required. The 3D region selection can be applied to any images that share the same Frame of Reference UID.
See 3D Image Region Selection example .
The ImagingSelection.endpoint elements indicate network services that can be used to access the imaging data referenced by the imaging selection; for example, a DICOM WADO-RS server. Systems can determine if the relevant imaging data is available or offline by interacting with the endpoint.
Different
Endpoint
connection
types
can
have
different
capabilities,
protocols
or
requirements.
Furthermore,
the
specified
Endpoint.address
identifies
the
DICOM
Web
Service
Base
URI
(see
DICOM
PS
3.18
Section
8.2
).
The
URL
needed
to
retrieve
image
data
might
need
to
be
constructed
from
this
base
URL.
See
below
for
the
details
on
use
of
imaging-related
Endpoint
connection
types.
An
Endpoint.connectionType
of
code
dicom-wado-rs
,
system
http://terminology.hl7.org/CodeSystem/endpoint-connection-type
,
identifies
a
DICOM
WADO-RS
service.
The
DICOM
WADO-RS
(Web
Access
to
DICOM
Objects,
RESTful
mode)
service
uses
a
RESTful
approach
to
instance
retrieval.
This
service
allows
for
retrieval
of
native
DICOM
SOP
Instance.
instances,
or
instances
“rendered”
into
other
formats,
including
JPEG
and
MPEG.
The
media
type
of
a
response
is
specified
by
the
request
Accept
header
(preferred);
or,
by
the
accept
query
parameters.
Supported
media
types
depend
on
the
capabilities
of
the
WADO-RS
server
and
the
classification
of
the
instance
as
"single
frame",
"multi-frame",
"video",
"text",
or
"other".
The
WADO-RS
service
also
allows
retrieval
of
study
or
series
level
information.
The
path
to
retrieve
a
DICOM
instance
is
constructed
by
appending
the
appropriate
sub-resource
paths
to
the
Endpoint.address
value.
For example, using the following information in a fictional ImagingSelection resource:
https://pacs.hospital.org/wado-rs
found
in
an
ImagingSelection.endpoint.address
,
1.2.250.1.59.40211.12345678.678910
found
in
an
ImagingSelection.identifier
having
Identifier.system
of
“urn:dicom:uid”
,
1.2.250.1.59.40211.789001276.14556172.67789
found
in
ImagingSelection.series.uid
,
and
1.2.250.1.59.40211.2678810.87991027.899772.2
found
in
ImagingSelection.series.instance.uid
https://pacs.hospital.org/wado-rs/studies/1.2.250.1.59.40211.12345678.678910/series/1.2.250.1.59.40211.789001276.14556172.67789/instances/1.2.250.1.59.40211.2678810.87991027.899772.2
An
Endpoint.connectionType
of
code
dicom-wado-uri
,
system
http://terminology.hl7.org/CodeSystem/endpoint-connection-type
,
identifies
a
DICOM
WADO-URI
service.
The DICOM WADO-URI (Web Access to DICOM Objects, URI mode) service uses HTTP query parameter syntax. This service allows for retrieval of native DICOM instances, or instances “rendered” into other formats, including JPEG and MPEG. The media type of a response is specified by the request Accept header (preferred); or, by the contentType query parameter. Supported media types depend on the classification of the instance as "single frame", "multi-frame", "video", "text", or "other."
The
query
to
retrieve
a
DICOM
instance
is
constructed
by
appending
the
appropriate
query
parameters
to
the
Endpoint.address
value.
For example, using the following information in a fictional ImagingSelection resource:
https://pacs.hospital.org/wado-uri
found
in
an
ImagingSelection.endpoint.address
,
1.2.250.1.59.40211.12345678.678910
found
in
an
ImagingSelection.identifier
having
Identifier.system
of
urn:dicom:uid
,
1.2.250.1.59.40211.789001276.14556172.67789
found
in
ImagingSelection.series.uid
,
and
1.2.250.1.59.40211.2678810.87991027.899772.2
found
in
ImagingSelection.series.instance.uid
https://pacs.hospital.org/wado-uri?requestType=WADO&studyUID=1.2.250.1.59.40211.12345678.678910&seriesUID=1.2.250.1.59.40211.789001276.14556172.67789&objectUID=1.2.250.1.59.40211.2678810.87991027.899772.2
The
bodySite
element
can
include
the
laterality
of
the
(possibly
paired)
anatomic
structures
examined
–
e.g.
left
knee,
bilateral
lungs,
etc.
This
can
be
conveyed
in
several
ways:
bodySite
contains
an
anatomic
code
that
includes
laterality,
e.g.
"bodySite": {
"concept": {
"coding": [{
"system": "http://snomed.info/sct",
"code": "5951000",
"display": "Left wrist"
}]
}
}
bodySite
contains
a
reference
to
a
BodyStructure
resource
whose
includedStructure.structure
element
contains
an
anatomic
code
that
includes
laterality
bodySite
contains
a
reference
to
a
BodyStructure
resource
whose
includedStructure
element
includes
a
laterality
value.
See
this
example
BodyStructure
representation
of
the
Left
Wrist,
with
laterality
and
SNOMED
coding
for
anatomical
structure
.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 | |
| modality | token | The modality of the selection | ImagingSelection.modality | |
| 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 , |
FHIR
®©
HL7.org
2011+.
FHIR
R5
hl7.fhir.core#5.0.0
R6
hl7.fhir.core#6.0.0-ballot3
generated
on
Sun,
Mar
26,
2023
15:24+1100.
Thu,
Nov
27,
2025
16:53+0000.
Links:
Search
|
Version
History
|
Contents
|
Glossary
|
QA
|
Compare
to
R4
|
Compare
to
R4B
R5
|
Compare
to
Last
Ballot
|
|
Propose
a
change