This
page
is
part
of
the
FHIR
Specification
(v3.0.2:
STU
3).
The
current
version
which
supercedes
this
version
is
5.0.0
.
For
a
full
list
Continuous
Integration
Build
of
available
versions,
see
FHIR
(will
be
incorrect/inconsistent
at
times).
See
the
Directory
of
published
versions
.
Page
versions:
R5
R4B
R4
R3
R2
Responsible
Owner:
Imaging
Integration
Work
Group
|
Normative
|
|
Compartments : Group , Patient |
Representation
of
the
content
produced
in
a
DICOM
imaging
study.
A
study
comprises
a
set
of
series,
each
of
which
includes
a
set
of
Service-Object
Pair
Instances
(SOP
Instances
-
images
or
other
data)
acquired
or
produced
in
a
common
context.
A
series
is
of
only
one
modality
(e.g.
X-ray,
CT,
MR,
ultrasound),
but
a
study
may
can
have
multiple
series
of
different
modalities.
modality
values.
The ImagingStudy resource provides information on available imaging data.
An
ImagingStudy
provides
information
on
a
single
DICOM
imaging
study,
and
the
series
and
imaging
objects
in
that
study.
It
also
provides
information
on
how
to
retrieve
that
information
(in
a
native
DICOM
format,
or
in
a
rendered
format,
such
as
JPEG).
ImagingStudy
is
used
to
make
available
information
about
all
parts
of
a
single
DICOM
study.
This
resource
provides
mappings
of
its
elements
to
DICOM
attributes.
DICOM
attributes
are
identified
by
a
32-bit
tag,
presented
in
canonical
form
as
two
four-digit
hexadecimal
values
within
parentheses
and
separated
by
a
comma,
e.g.
(0008,103E).
The
name
and
value
representation
(data
type)
of
each
attribute
can
be
found
in
DICOM
Part
6
Data
Dictionary
.
The
use
of
the
attributes
in
the
context
of
information
objects,
including
detailed
description
of
use,
can
be
found
in
DICOM
Part
3
Information
Object
Definitions
.
Attributes
used
in
the
DICOM
query
information
models,
such
as
"Number
"Number
of
Instances
in
Study",
Study",
can
be
found
in
DICOM
Part
4
Annex
C
.
ImagingStudy
provides
access
to
significant
DICOM
information,
information
but
will
only
eliminate
the
need
for
DICOM
query
(e.g.,
QIDO-RS)
a
DICOMweb
search
transaction)
in
the
simplest
cases.
The
DICOM
instances
are
not
stored
in
the
ImagingStudy
resource;
use
of
a
DICOM
WADO-RS
server
or
other
storage
mechanism
service
is
needed.
needed
(e.g.,
a
DICOMweb
retrieve
transaction).
Only
a
single
DICOM
study
may
be
referenced
from
one
ImagingStudy.
In
many
cases,
only
one
One
ImagingStudy
will
SHALL
reference
a
particular
one
DICOM
study,
but
this
Study.
This
resource
can
change
as
additional
information
is
not
required.
added
to
the
related
DICOM
Study.
See notes for guidance on how imaging study element values can be populated and when imaging studies are typically created and updated .
In
contrast
The
ImagingStudy
resource
is
used
to
ImagingManifest
store
details
of
an
entire
DICOM
Study
and
its
relationships
to
other
resources,
such
as
Patient
,
this
ServiceRequest
,
and
Encounter
.
The
ImagingSelection
resource
represents
all
is
used
to
reference
to
a
subset
of
the
known
imaging
objects
from
a
single
study.
Imaging
Manifest
represents
selected
instances
from
multiple
studies
Instances
of
this
resource
are
created
for
one
patient.
specific
clinical
purposes
and
are
unlikely
to
change
once
created.
An Observation typically relates to a set of images in the following ways.
The
DocumentReference
resource
is
used
to
track
store
non-DICOM
images,
video,
or
audio.
Binary
can
be
used
to
store
arbitrary
content.
audio
with
relevant
metadata.
The
DocumentReference
allow
indexing
resource
might
be
appropriate
for
including
a
rendered
DICOM
image
in
cases
where
only
the
image
is
needed
and
retrieval
of
clinical
“documents”
with
relevant
metadata.
not
the
full
image
context.
Structure
| Name | Flags | Card. | Type |
Description
&
Constraints
Filter:
|
|---|---|---|---|---|
|
N | DomainResource |
A
set
of
images
or
image-related
data
produced
in
single
study
+ Rule: series SHALL only be present if an identifier is present with a system of + Rule: At most, a single identifier SHALL be present with a system of urn:dicom:uid + Rule: If numberOfSeries and series are both present, the numberOfSeries value SHALL match the number of series elements + Rule: If numberOfInstances and series.instance are both present, the numberOfInstances value SHALL match the total number of series.instance elements + Rule: If numberOfInstances and series.numberOfInstances are both present, the numberOfInstances value SHALL be the sum of the series.numberOfInstance values. + Rule: For each series element, if numberOfInstances and instance are both present, the numberOfInstances value SHALL match the number of instance elements + Rule: If modality is present, modality SHALL equal all of the distinct values of series.modality Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension |
|
|
Σ
|
0..* | Identifier |
Business
identifier
for
|
|
?! Σ | 1..1 | code |
registered
|
|
|
Σ C | 0..* |
|
The
distinct
values
for
series'
modalities
(
Extensible
)
|
|
Σ | 1..1 | Reference ( Patient | Device | Group ) |
Who
or
what
is
the
|
|
Σ | 0..1 |
Reference
(
Encounter
|
Encounter
with
which
this
imaging
study
is
associated
|
|
Σ | 0..1 | dateTime |
When
the
study
was
started
|
|
Σ | 0..* |
Reference
(
|
Fulfills
plan
or
order
|
|
Σ | 0..* |
Reference
(
|
Imaging
performed
procedure(s)
|
|
Σ | 0..1 | Reference ( Practitioner | PractitionerRole ) |
Referring
physician
|
|
Σ | 0..* | Reference ( Endpoint ) |
Study
access
endpoint
|
|
Σ | 0..1 |
|
Where
imaging
study
occurred
|
|
Σ | 0..* |
|
Why
was
imaging
study
performed?
Binding: Procedure Reason Codes ( Example ) |
|
Σ | 0..* |
|
Comments
made
about
the
imaging
study
|
|
Σ | 0..1 |
|
Study
Description
or
Classification
|
|
Σ C | 0..1 |
|
Number
of
Study
Related
Series
|
|
Σ C | 0..1 |
|
Number
of
Study
Related
Instances
|
|
Σ C | 0..* | BackboneElement |
The
set
of
|
|
Σ | 1..1 |
|
DICOM
|
|
Σ | 0..1 | unsignedInt |
Numeric
identifier
of
this
series
|
|
Σ C | 1..1 |
|
The
modality
(
Extensible
)
|
|
Σ | 0..1 | string |
Series
Description
or
Classification
|
|
Σ C | 0..1 | unsignedInt |
Number
of
Series
Related
Instances
|
|
Σ | 0..* |
|
Series
access
endpoint
|
|
|
0..1 |
CodeableReference
(
|
Body
part
examined
Binding: SNOMED CT Body Structures ( Example ) |
|
Σ | 0..* |
Reference
(
|
Specimen
imaged
|
|
Σ | 0..1 |
|
When
the
series
started
|
|
Σ | 0..* |
|
Who
performed
the
series
|
|
Σ | 0..1 |
|
Type
of
performance
Binding: ImagingStudy series |
|
Σ | 1..1 | Reference ( Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson | HealthcareService ) |
Who
performed
|
|
C | 0..* | BackboneElement |
A
single
SOP
instance
from
the
series
|
|
1..1 |
|
DICOM
|
|
|
|
1..1 |
|
DICOM
class
type
|
|
|
0..1 |
|
The
number
of
this
instance
in
the
series
|
|
0..1 | string |
Name
or
title
of
the
instance
|
|
Documentation
for
this
format
|
||||
See the Extensions for this resource
UML Diagram ( Legend )
XML Template
<<ImagingStudy xmlns="http://hl7.org/fhir"><!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension -->
< <</accession> <</identifier> < <</modalityList> <</patient> <</context> < <</basedOn> <</referrer> <</interpreter> <</endpoint> < < <</procedureReference> <</procedureCode> <</reason> < < < < <</modality> < < < <</endpoint> <</bodySite> <</laterality> < <</performer> < < < < <<identifier><!-- I 0..* Identifier Business identifier for imaging study --></identifier> <status value="[code]"/><!-- 1..1 registered | available | cancelled | entered-in-error | unknown | inactive --> <modality><!-- I 0..* CodeableConcept The distinct values for series' modalities--></modality> <subject><!-- 1..1 Reference(Device|Group|Patient) Who or what is the subject of the study --></subject> <encounter><!-- 0..1 Reference(Encounter) Encounter with which this imaging study is associated --></encounter> <started value="[dateTime]"/><!-- 0..1 When the study was started --> <basedOn><!-- 0..* Reference(Appointment|CarePlan|ServiceRequest|Task) Fulfills plan or order --></basedOn> <procedure><!-- 0..* Reference(Procedure) Imaging performed procedure(s) --></procedure> <referrer><!-- 0..1 Reference(Practitioner|PractitionerRole) Referring physician --></referrer> <endpoint><!-- 0..* Reference(Endpoint) Study access endpoint --></endpoint> <location><!-- 0..1 Reference(Location) Where imaging study occurred --></location> <reason><!-- 0..* CodeableReference(Condition|DiagnosticReport|DocumentReference| Observation) Why was imaging study performed? --></reason> <note><!-- 0..* Annotation Comments made about the imaging study --></note> <description value="[string]"/><!-- 0..1 Study Description or Classification --> <numberOfSeries value="[unsignedInt]"/><!-- I 0..1 Number of Study Related Series --> <numberOfInstances value="[unsignedInt]"/><!-- I 0..1 Number of Study Related Instances --> <series> <!-- I 0..* The set of Series belonging to the study --> <uid value="[id]"/><!-- 1..1 DICOM Series Instance UID --> <number value="[unsignedInt]"/><!-- 0..1 Numeric identifier of this series --> <modality><!-- I 1..1 CodeableConcept The modality used for this series
--></modality> <description value="[string]"/><!-- 0..1 Series Description or Classification --> <numberOfInstances value="[unsignedInt]"/><!-- I 0..1 Number of Series Related Instances --> <endpoint><!-- 0..* Reference(Endpoint) Series access endpoint --></endpoint> <bodySite><!-- 0..1 CodeableReference(BodyStructure) Body part examined --></bodySite> <specimen><!-- 0..* Reference(Specimen) Specimen imaged --></specimen> <started value="[dateTime]"/><!-- 0..1 When the series started --> <performer> <!-- 0..* Who performed the series --> <function><!-- 0..1 CodeableConcept Type of performance --></function> <actor><!-- 1..1 Reference(CareTeam|Device|HealthcareService|Organization| Patient|Practitioner|PractitionerRole|RelatedPerson) Who performed imaging study --></actor> </performer> <instance> <!-- I 0..* A single SOP instance from the series --> <uid value="[id]"/><!-- 1..1 DICOM SOP Instance UID --> <sopClass value="[oid]"/><!-- 1..1 DICOM class type --> <number value="[unsignedInt]"/><!-- 0..1 The number of this instance in the series --> <title value="[string]"/><!-- 0..1 Name or title of the instance --> </instance> </series> </ImagingStudy>
JSON Template
{
"resourceType" : "",
"resourceType" : "ImagingStudy",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"identifier" : [{ Identifier }], // I Business identifier for imaging study
"status" : "<code>", // R! registered | available | cancelled | entered-in-error | unknown | inactive
"modality" : [{ CodeableConcept }], // I The distinct values for series' modalities
"subject" : { Reference(Device|Group|Patient) }, // R! Who or what is the subject of the study
"encounter" : { Reference(Encounter) }, // Encounter with which this imaging study is associated
"started" : "<dateTime>", // When the study was started
"basedOn" : [{ Reference(Appointment|CarePlan|ServiceRequest|Task) }], // Fulfills plan or order
"procedure" : [{ Reference(Procedure) }], // Imaging performed procedure(s)
"referrer" : { Reference(Practitioner|PractitionerRole) }, // Referring physician
"endpoint" : [{ Reference(Endpoint) }], // Study access endpoint
"location" : { Reference(Location) }, // Where imaging study occurred
"reason" : [{ CodeableReference(Condition|DiagnosticReport|DocumentReference|
Observation) }], // Why was imaging study performed?
"note" : [{ Annotation }], // Comments made about the imaging study
"description" : "<string>", // Study Description or Classification
"numberOfSeries" : "<unsignedInt>", // I Number of Study Related Series
"numberOfInstances" : "<unsignedInt>", // I Number of Study Related Instances
"series" : [{ // I The set of Series belonging to the study
"uid" : "<id>", // R! DICOM Series Instance UID
"number" : "<unsignedInt>", // Numeric identifier of this series
"modality" : { CodeableConcept }, // I R! The modality used for this series
"description" : "<string>", // Series Description or Classification
"numberOfInstances" : "<unsignedInt>", // I Number of Series Related Instances
"endpoint" : [{ Reference(Endpoint) }], // Series access endpoint
"bodySite" : { CodeableReference(BodyStructure) }, // Body part examined
"specimen" : [{ Reference(Specimen) }], // Specimen imaged
"started" : "<dateTime>", // When the series started
"performer" : [{ // Who performed the series
"function" : { CodeableConcept }, // Type of performance
"actor" : { Reference(CareTeam|Device|HealthcareService|Organization|
Patient|Practitioner|PractitionerRole|RelatedPerson) } // R! Who performed imaging study
}],
"instance" : [{ // I A single SOP instance from the series
"uid" : "<id>", // R! DICOM SOP Instance UID
"sopClass" : "<oid>", // R! DICOM class type
"number" : "<unsignedInt>", // The number of this instance in the series
"title" : "<string>" // Name or title of the instance
}]
}]
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .![]()
[ a fhir:;[ a fhir:ImagingStudy; fhir:nodeRole fhir:treeRoot; # if this is the parser root# from # from fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: 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..* I Business identifier for imaging study fhir:status [ code ] ; # 1..1 registered | available | cancelled | entered-in-error | unknown | inactive fhir:modality ( [ CodeableConcept ] ... ) ; # 0..* I The distinct values for series' modalities fhir:subject [ Reference(Device|Group|Patient) ] ; # 1..1 Who or what is the subject of the study fhir:encounter [ Reference(Encounter) ] ; # 0..1 Encounter with which this imaging study is associated fhir:started [ dateTime ] ; # 0..1 When the study was started fhir:basedOn ( [ Reference(Appointment|CarePlan|ServiceRequest|Task) ] ... ) ; # 0..* Fulfills plan or order fhir:procedure ( [ Reference(Procedure) ] ... ) ; # 0..* Imaging performed procedure(s) fhir:referrer [ Reference(Practitioner|PractitionerRole) ] ; # 0..1 Referring physician fhir:endpoint ( [ Reference(Endpoint) ] ... ) ; # 0..* Study access endpoint fhir:location [ Reference(Location) ] ; # 0..1 Where imaging study occurred fhir:reason ( [ CodeableReference(Condition|DiagnosticReport|DocumentReference|Observation) ] ... ) ; # 0..* Why was imaging study performed? fhir:note ( [ Annotation ] ... ) ; # 0..* Comments made about the imaging study fhir:description [ string ] ; # 0..1 Study Description or Classification fhir:numberOfSeries [ unsignedInt ] ; # 0..1 I Number of Study Related Series fhir:numberOfInstances [ unsignedInt ] ; # 0..1 I Number of Study Related Instances fhir:series ( [ # 0..* I The set of Series belonging to the study fhir:uid [ id ] ; # 1..1 DICOM Series Instance UID fhir:number [ unsignedInt ] ; # 0..1 Numeric identifier of this series fhir:modality [ CodeableConcept ] ; # 1..1 I The modality used for this series fhir:description [ string ] ; # 0..1 Series Description or Classification fhir:numberOfInstances [ unsignedInt ] ; # 0..1 I Number of Series Related Instances fhir:endpoint ( [ Reference(Endpoint) ] ... ) ; # 0..* Series access endpoint fhir:bodySite [ CodeableReference(BodyStructure) ] ; # 0..1 Body part examined fhir:specimen ( [ Reference(Specimen) ] ... ) ; # 0..* Specimen imaged fhir:started [ dateTime ] ; # 0..1 When the series started fhir:performer ( [ # 0..* Who performed the series fhir:function [ CodeableConcept ] ; # 0..1 Type of performance fhir:actor [ Reference(CareTeam|Device|HealthcareService|Organization|Patient|Practitioner| PractitionerRole|RelatedPerson) ] ; # 1..1 Who performed imaging study ] ... ) ; fhir:instance ( [ # 0..* I A single SOP instance from the series fhir:uid [ id ] ; # 1..1 DICOM SOP Instance UID fhir:sopClass [ oid ] ; # 1..1 DICOM class type fhir:number [ unsignedInt ] ; # 0..1 The number of this instance in the series fhir:title [ string ] ; # 0..1 Name or title of the instance ] ... ) ; ] ... ) ; ]
Changes
since
DSTU2
from
both
R4
and
R4B
| ImagingStudy | |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
See the Full Difference for further information
This
analysis
is
available
for
R4
as
XML
or
JSON
.
See
R2
<-->
R3
Conversion
Maps
(status
=
2
tests
that
all
execute
ok.
2
fail
round-trip
testing
and
1
r3
resources
are
invalid
(2
errors).
).
for
R4B
as
XML
or
JSON
.
Structure
| Name | Flags | Card. | Type |
Description
&
Constraints
Filter:
|
|---|---|---|---|---|
|
N | DomainResource |
A
set
of
images
or
image-related
data
produced
in
single
study
+ Rule: series SHALL only be present if an identifier is present with a system of + Rule: At most, a single identifier SHALL be present with a system of urn:dicom:uid + Rule: If numberOfSeries and series are both present, the numberOfSeries value SHALL match the number of series elements + Rule: If numberOfInstances and series.instance are both present, the numberOfInstances value SHALL match the total number of series.instance elements + Rule: If numberOfInstances and series.numberOfInstances are both present, the numberOfInstances value SHALL be the sum of the series.numberOfInstance values. + Rule: For each series element, if numberOfInstances and instance are both present, the numberOfInstances value SHALL match the number of instance elements + Rule: If modality is present, modality SHALL equal all of the distinct values of series.modality Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension |
|
|
Σ
|
0..* | Identifier |
Business
identifier
for
|
|
?! Σ | 1..1 | code |
registered
|
|
|
Σ C | 0..* |
|
The
distinct
values
for
series'
modalities
(
Extensible
)
|
|
Σ | 1..1 | Reference ( Patient | Device | Group ) |
Who
or
what
is
the
|
|
Σ | 0..1 |
Reference
(
Encounter
|
Encounter
with
which
this
imaging
study
is
associated
|
|
Σ | 0..1 | dateTime |
When
the
study
was
started
|
|
Σ | 0..* |
Reference
(
|
Fulfills
plan
or
order
|
|
Σ | 0..* |
Reference
(
|
Imaging
performed
procedure(s)
|
|
Σ | 0..1 | Reference ( Practitioner | PractitionerRole ) |
Referring
physician
|
|
Σ | 0..* | Reference ( Endpoint ) |
Study
access
endpoint
|
|
Σ | 0..1 |
|
Where
imaging
study
occurred
|
|
Σ | 0..* |
|
Why
was
imaging
study
performed?
Binding: Procedure Reason Codes ( Example ) |
|
Σ | 0..* |
|
Comments
made
about
the
imaging
study
|
|
Σ | 0..1 |
|
Study
Description
or
Classification
|
|
Σ C | 0..1 |
|
Number
of
Study
Related
Series
|
|
Σ C | 0..1 |
|
Number
of
Study
Related
Instances
|
|
Σ C | 0..* | BackboneElement |
The
set
of
|
|
Σ | 1..1 |
|
DICOM
|
|
Σ | 0..1 | unsignedInt |
Numeric
identifier
of
this
series
|
|
Σ C | 1..1 |
|
The
modality
(
Extensible
)
|
|
Σ | 0..1 | string |
Series
Description
or
Classification
|
|
Σ C | 0..1 | unsignedInt |
Number
of
Series
Related
Instances
|
|
Σ | 0..* |
|
Series
access
endpoint
|
|
|
0..1 |
CodeableReference
(
|
Body
part
examined
Binding: SNOMED CT Body Structures ( Example ) |
|
Σ | 0..* |
Reference
(
|
Specimen
imaged
|
|
Σ | 0..1 |
|
When
the
series
started
|
|
Σ | 0..* |
|
Who
performed
the
series
|
|
Σ | 0..1 |
|
Type
of
performance
Binding: ImagingStudy series |
|
Σ | 1..1 | Reference ( Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson | HealthcareService ) |
Who
performed
|
|
C | 0..* | BackboneElement |
A
single
SOP
instance
from
the
series
|
|
1..1 |
|
DICOM
|
|
|
|
1..1 |
|
DICOM
class
type
|
|
|
0..1 |
|
The
number
of
this
instance
in
the
series
|
|
0..1 | string |
Name
or
title
of
the
instance
|
|
Documentation
for
this
format
|
||||
See the Extensions for this resource
XML Template
<<ImagingStudy xmlns="http://hl7.org/fhir"><!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension -->
< <</accession> <</identifier> < <</modalityList> <</patient> <</context> < <</basedOn> <</referrer> <</interpreter> <</endpoint> < < <</procedureReference> <</procedureCode> <</reason> < < < < <</modality> < < < <</endpoint> <</bodySite> <</laterality> < <</performer> < < < < <<identifier><!-- I 0..* Identifier Business identifier for imaging study --></identifier> <status value="[code]"/><!-- 1..1 registered | available | cancelled | entered-in-error | unknown | inactive --> <modality><!-- I 0..* CodeableConcept The distinct values for series' modalities--></modality> <subject><!-- 1..1 Reference(Device|Group|Patient) Who or what is the subject of the study --></subject> <encounter><!-- 0..1 Reference(Encounter) Encounter with which this imaging study is associated --></encounter> <started value="[dateTime]"/><!-- 0..1 When the study was started --> <basedOn><!-- 0..* Reference(Appointment|CarePlan|ServiceRequest|Task) Fulfills plan or order --></basedOn> <procedure><!-- 0..* Reference(Procedure) Imaging performed procedure(s) --></procedure> <referrer><!-- 0..1 Reference(Practitioner|PractitionerRole) Referring physician --></referrer> <endpoint><!-- 0..* Reference(Endpoint) Study access endpoint --></endpoint> <location><!-- 0..1 Reference(Location) Where imaging study occurred --></location> <reason><!-- 0..* CodeableReference(Condition|DiagnosticReport|DocumentReference| Observation) Why was imaging study performed? --></reason> <note><!-- 0..* Annotation Comments made about the imaging study --></note> <description value="[string]"/><!-- 0..1 Study Description or Classification --> <numberOfSeries value="[unsignedInt]"/><!-- I 0..1 Number of Study Related Series --> <numberOfInstances value="[unsignedInt]"/><!-- I 0..1 Number of Study Related Instances --> <series> <!-- I 0..* The set of Series belonging to the study --> <uid value="[id]"/><!-- 1..1 DICOM Series Instance UID --> <number value="[unsignedInt]"/><!-- 0..1 Numeric identifier of this series --> <modality><!-- I 1..1 CodeableConcept The modality used for this series
--></modality> <description value="[string]"/><!-- 0..1 Series Description or Classification --> <numberOfInstances value="[unsignedInt]"/><!-- I 0..1 Number of Series Related Instances --> <endpoint><!-- 0..* Reference(Endpoint) Series access endpoint --></endpoint> <bodySite><!-- 0..1 CodeableReference(BodyStructure) Body part examined --></bodySite> <specimen><!-- 0..* Reference(Specimen) Specimen imaged --></specimen> <started value="[dateTime]"/><!-- 0..1 When the series started --> <performer> <!-- 0..* Who performed the series --> <function><!-- 0..1 CodeableConcept Type of performance --></function> <actor><!-- 1..1 Reference(CareTeam|Device|HealthcareService|Organization| Patient|Practitioner|PractitionerRole|RelatedPerson) Who performed imaging study --></actor> </performer> <instance> <!-- I 0..* A single SOP instance from the series --> <uid value="[id]"/><!-- 1..1 DICOM SOP Instance UID --> <sopClass value="[oid]"/><!-- 1..1 DICOM class type --> <number value="[unsignedInt]"/><!-- 0..1 The number of this instance in the series --> <title value="[string]"/><!-- 0..1 Name or title of the instance --> </instance> </series> </ImagingStudy>
JSON Template
{
"resourceType" : "",
"resourceType" : "ImagingStudy",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"identifier" : [{ Identifier }], // I Business identifier for imaging study
"status" : "<code>", // R! registered | available | cancelled | entered-in-error | unknown | inactive
"modality" : [{ CodeableConcept }], // I The distinct values for series' modalities
"subject" : { Reference(Device|Group|Patient) }, // R! Who or what is the subject of the study
"encounter" : { Reference(Encounter) }, // Encounter with which this imaging study is associated
"started" : "<dateTime>", // When the study was started
"basedOn" : [{ Reference(Appointment|CarePlan|ServiceRequest|Task) }], // Fulfills plan or order
"procedure" : [{ Reference(Procedure) }], // Imaging performed procedure(s)
"referrer" : { Reference(Practitioner|PractitionerRole) }, // Referring physician
"endpoint" : [{ Reference(Endpoint) }], // Study access endpoint
"location" : { Reference(Location) }, // Where imaging study occurred
"reason" : [{ CodeableReference(Condition|DiagnosticReport|DocumentReference|
Observation) }], // Why was imaging study performed?
"note" : [{ Annotation }], // Comments made about the imaging study
"description" : "<string>", // Study Description or Classification
"numberOfSeries" : "<unsignedInt>", // I Number of Study Related Series
"numberOfInstances" : "<unsignedInt>", // I Number of Study Related Instances
"series" : [{ // I The set of Series belonging to the study
"uid" : "<id>", // R! DICOM Series Instance UID
"number" : "<unsignedInt>", // Numeric identifier of this series
"modality" : { CodeableConcept }, // I R! The modality used for this series
"description" : "<string>", // Series Description or Classification
"numberOfInstances" : "<unsignedInt>", // I Number of Series Related Instances
"endpoint" : [{ Reference(Endpoint) }], // Series access endpoint
"bodySite" : { CodeableReference(BodyStructure) }, // Body part examined
"specimen" : [{ Reference(Specimen) }], // Specimen imaged
"started" : "<dateTime>", // When the series started
"performer" : [{ // Who performed the series
"function" : { CodeableConcept }, // Type of performance
"actor" : { Reference(CareTeam|Device|HealthcareService|Organization|
Patient|Practitioner|PractitionerRole|RelatedPerson) } // R! Who performed imaging study
}],
"instance" : [{ // I A single SOP instance from the series
"uid" : "<id>", // R! DICOM SOP Instance UID
"sopClass" : "<oid>", // R! DICOM class type
"number" : "<unsignedInt>", // The number of this instance in the series
"title" : "<string>" // Name or title of the instance
}]
}]
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .![]()
[ a fhir:;[ a fhir:ImagingStudy; fhir:nodeRole fhir:treeRoot; # if this is the parser root# from # from fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: 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..* I Business identifier for imaging study fhir:status [ code ] ; # 1..1 registered | available | cancelled | entered-in-error | unknown | inactive fhir:modality ( [ CodeableConcept ] ... ) ; # 0..* I The distinct values for series' modalities fhir:subject [ Reference(Device|Group|Patient) ] ; # 1..1 Who or what is the subject of the study fhir:encounter [ Reference(Encounter) ] ; # 0..1 Encounter with which this imaging study is associated fhir:started [ dateTime ] ; # 0..1 When the study was started fhir:basedOn ( [ Reference(Appointment|CarePlan|ServiceRequest|Task) ] ... ) ; # 0..* Fulfills plan or order fhir:procedure ( [ Reference(Procedure) ] ... ) ; # 0..* Imaging performed procedure(s) fhir:referrer [ Reference(Practitioner|PractitionerRole) ] ; # 0..1 Referring physician fhir:endpoint ( [ Reference(Endpoint) ] ... ) ; # 0..* Study access endpoint fhir:location [ Reference(Location) ] ; # 0..1 Where imaging study occurred fhir:reason ( [ CodeableReference(Condition|DiagnosticReport|DocumentReference|Observation) ] ... ) ; # 0..* Why was imaging study performed? fhir:note ( [ Annotation ] ... ) ; # 0..* Comments made about the imaging study fhir:description [ string ] ; # 0..1 Study Description or Classification fhir:numberOfSeries [ unsignedInt ] ; # 0..1 I Number of Study Related Series fhir:numberOfInstances [ unsignedInt ] ; # 0..1 I Number of Study Related Instances fhir:series ( [ # 0..* I The set of Series belonging to the study fhir:uid [ id ] ; # 1..1 DICOM Series Instance UID fhir:number [ unsignedInt ] ; # 0..1 Numeric identifier of this series fhir:modality [ CodeableConcept ] ; # 1..1 I The modality used for this series fhir:description [ string ] ; # 0..1 Series Description or Classification fhir:numberOfInstances [ unsignedInt ] ; # 0..1 I Number of Series Related Instances fhir:endpoint ( [ Reference(Endpoint) ] ... ) ; # 0..* Series access endpoint fhir:bodySite [ CodeableReference(BodyStructure) ] ; # 0..1 Body part examined fhir:specimen ( [ Reference(Specimen) ] ... ) ; # 0..* Specimen imaged fhir:started [ dateTime ] ; # 0..1 When the series started fhir:performer ( [ # 0..* Who performed the series fhir:function [ CodeableConcept ] ; # 0..1 Type of performance fhir:actor [ Reference(CareTeam|Device|HealthcareService|Organization|Patient|Practitioner| PractitionerRole|RelatedPerson) ] ; # 1..1 Who performed imaging study ] ... ) ; fhir:instance ( [ # 0..* I A single SOP instance from the series fhir:uid [ id ] ; # 1..1 DICOM SOP Instance UID fhir:sopClass [ oid ] ; # 1..1 DICOM class type fhir:number [ unsignedInt ] ; # 0..1 The number of this instance in the series fhir:title [ string ] ; # 0..1 Name or title of the instance ] ... ) ; ] ... ) ; ]
Changes
since
DSTU2
from
both
R4
and
R4B
| ImagingStudy | |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
See the Full Difference for further information
This
analysis
is
available
for
R4
as
XML
or
JSON
.
See
R2
<-->
R3
Conversion
Maps
(status
=
2
tests
that
all
execute
ok.
2
fail
round-trip
testing
and
1
r3
resources
are
invalid
(2
errors).
).
for
R4B
as
XML
or
JSON
.
Alternate
Additional
definitions:
Master
Definition
(
XML
,
+
JSON
),
,
XML
Schema
/
Schematron
(for
)
+
JSON
Schema
,
ShEx
(for
Turtle
)
+
see
the
extensions
,
the
spreadsheet
version
&
the
dependency
analysis
| Path |
|
Type |
|
|---|---|---|---|
| ImagingStudy.status |
|
Required |
The status of the ImagingStudy. |
| ImagingStudy.modality |
|
Extensible | Transitive closure of CID 33 Modality |
| ImagingStudy.reason | ProcedureReasonCodes | Example |
This
example
value
set
defines
the
|
| ImagingStudy.series.modality |
Modality
![]() |
Extensible |
Transitive
closure
of
CID
33
Modality
|
| ImagingStudy.series.bodySite |
|
Example |
This
value
set
includes
all
codes
from
SNOMED
CT
|
| ImagingStudy.series.performer.function | ImagingStudySeriesPerformerFunction | Extensible |
Performer function of an agent in an imaging study series |
| UniqueKey |
| Location | Description | Expression |
ist-1
| Rule | (base) | series SHALL only be present if an identifier is present with a system of urn:dicom:uid | series.exists() implies identifier.where(system = 'urn:dicom:uid').exists() |
ist-2
|
Rule | (base) | At most, a single identifier SHALL be present with a system of urn:dicom:uid | identifier.where(system = 'urn:dicom:uid').count() < 2 |
ist-3
| Rule | (base) | If numberOfSeries and series are both present, the numberOfSeries value SHALL match the number of series elements | numberOfSeries.exists() and series.exists() implies numberOfSeries = series.count() |
ist-4
| Rule | (base) | If numberOfInstances and series.instance are both present, the numberOfInstances value SHALL match the total number of series.instance elements | numberOfInstances.exists() and series.exists() implies numberOfInstances = series.instance.count() |
ist-5
|
Rule | (base) | If numberOfInstances and series.numberOfInstances are both present, the numberOfInstances value SHALL be the sum of the series.numberOfInstance values. | numberOfInstances.exists() and series.numberOfInstances.exists() implies numberOfInstances = series.numberOfInstances.aggregate($total + $this.toInteger(), 0) |
ist-6
| Rule | (base) | For each series element, if numberOfInstances and instance are both present, the numberOfInstances value SHALL match the number of instance elements | series.where(numberOfInstances.empty() or instance.empty() or numberOfInstances = instance.count()).count() = series.count() |
ist-7
| Rule | (base) | If modality is present, modality SHALL equal all of the distinct values of series.modality | modality.exists() implies modality.coding.select(system&'|'&code).trace('r').exclude(series.modality.coding.select(system&'|'&code).trace('c')).empty() and modality.text.exclude(series.modality.text).empty() and series.modality.coding.select(system&'|'&code).trace('r').exclude(modality.coding.select(system&'|'&code).trace('c')).empty() and series.modality.text.exclude(modality.text).empty() |
A referenced DICOM SOP instance could be:
DICOM
Series
Instance
UID
values
follow
and
SOP
Instance
UID
use
the
FHIR
convention
of
expressing
UIDs
as
URNs.
id
datatype
and
are
encoded
directly.
For
example,
an
image
with
SOP
Instance
UID
of
2.16.124.113543.1154777499.30246.19789.3503430045.1.1
is
encoded
in
ImagingStudy.series.instance.uid
as
“2.16.124.113543.1154777499.30246.19789.3503430045.1.1”
.
The
ImagingStudy's
DICOM
Study
Instance
UID
is
encoded
in
the
ImagingStudy.identifier
element,
which
is
of
the
Identifier
datatype.
When
encoding
a
DICOM
UID
in
an
Identifier
datatype,
use
the
Identifier
system
of
“urn:dicom:uid”
,
and
prefix
the
UID
value
with
“urn:oid:”
.
Therefore,
an
ImagingStudy
with
DICOM
Study
Instance
UID
of
is
1.2.250.1.59.40211.12345678.678910
2.16.124.113543.1154777499.30246.19789.3503430046
expressed
encoded
as:
"identifier":{
"system":"urn:dicom:uid",
"value":"urn:oid:2.16.124.113543.1154777499.30246.19789.3503430046"
}
The
study
accession
number
is
encoded
as
Reference.identifier
element
using
the
identifier
type,
e.g.:
“urn:oid:1.2.250.1.59.40211.12345678.678910”
.
ACSN
"basedOn": [
"reference": {
"identifier":{
"type" : {
"coding" : [
{
"system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
"code" : "ACSN"
}
]
},
"system":"http://ginormoushospital.org/accession",
"value":"GH334103"
}
}
]
The
ImagingManifest.study.endpoint
ImagingStudy.endpoint
elements
and
ImagingManifest.study.series.endpoint
ImagingStudy.series.endpoint
elements
indicate
network
services
that
can
be
used
to
access
the
studies,
series,
or
and
instances;
for
example,
a
DICOM
WADO-RS
server.
An
ImagingManifest.study.series.endpoint
ImagingStudy.series.endpoint
of
a
particular
Endpoint.connectionType
provides
that
service
for
that
series,
and
all
contained
instances.
An
ImagingManifest.study.endpoint
ImagingStudy.endpoint
of
a
particularconnection
particular
connection
type
provides
that
service
for
all
series
in
that
study
that
do
not
have
a
specified
Endpoint
of
that
type,
and
their
contained
instances.
That
is,
an
ImagingManifest.study.series.endpoint
ImagingStudy.series.endpoint
overrides
a
ImagingManifest.study.endpoint
an
ImagingStudy.endpoint
of
the
same
connection
type.
(Since
Systems
can
determine
if
a
particular
study,
series,
or
instance
is
available
or
offline
by
interacting
with
the
endpoint.
Since
each
study,
or
individual
series
of
a
study
can
be
stored
on
different
imaging
archive
servers,
per-series
endpoints
are
required.
For
the
identified
services
and
use
cases,
all
instances
within
a
series
would
be
stored
together,
and
thus
instance-level
endpoints
are
not
defined.)
defined.
Different
Endpoint
connection
types
may
can
have
different
capabilities,
protocols
or
requirements;
and
requirements.
Furthermore,
the
specified
Endpoint.url
may
require
manipulation.
For
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,
See
below
for
details.
types.
An
Endpoint.connectionType
of
code
,
system
dicom-wado-rsi
dicom-wado-rs
,
identifies
a
DICOM
WADO-RS
service.
http://hl7.org/fhir/endpoint-connection-type
http://terminology.hl7.org/CodeSystem/endpoint-connection-type
The
Endpoint.address
identifies
the
HTTP(S)
service
base
url.
That
is,
only
the
scheme,
authority
and
path
are
included.
Sub-services,
such
as
study,
shall
not
be
specified.
The
path
shall
not
contain
a
trailing
slash.
The
DICOM
WADO-RS
(Web
Access
to
DICOM
Objects,
RESTful
mode)
service
uses
a
RESTful
approach
to
study,
series,
and
instance
retrieval.
This
service
allows
for
retrieval
of
native
DICOM
SOP
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
"single
frame",
"multi-frame",
"video",
"text",
or
series
level
information.
"other".
The
path
to
retrieve
a
DICOM
instance
is
constructed
by
appending
the
appropriate
sub-resource
paths
to
the
Endpoint.address
value.
For
example,
a
native
DICOM
PS3.10
instance
file
can
be
retrieved
(if
consistent
with
using
the
Accept
header)
by
performing
a
GET
on
following
information
in
a
fictional
ImagingStudy
resource:
Endpoint.address
https://pacs.hospital.org/wado-rs
“https://pacs.hospital.org/wado-rs”
ImagingStudy.endpoint.address
,
“urn:oid:1.2.250.1.59.40211.12345678.678910”
1.2.250.1.59.40211.12345678.678910
found
in
an
ImagingStudy.identifier
having
Identifier.system
of
“urn:dicom:uid”
,
“urn:oid:1.2.250.1.59.40211.789001276.14556172.67789”
1.2.250.1.59.40211.789001276.14556172.67789
found
in
ImagingStudy.series.uid
,
and
“urn:oid:1.2.250.1.59.40211.2678810.87991027.899772.2”
:
1.2.250.1.59.40211.2678810.87991027.899772.2
found
in
ImagingStudy.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
Query
parameters
on
the
"rendered"
"rendered"
sub-resource
can
control
other
aspects
of
the
rendering
including:
the
rendered
dimensions,
the
quality
(compression
ratio),
the
region
of
interest
to
render,
the
brightness/contrast
(window
center/width)
adjustments,
and
whether
to
“burn”
patient
or
study
demographics
into
the
rendered
result.
Specific
frames
of
a
multi-frame
instance
may
can
be
retrieved
using
the
frames
sub-resource.
For
example,
provided
the
Accept
header
indicates
a
preference
for
image/jpeg,
the
example
above
can
be
extended
with
parameters
that
cause
a
JPEG
thumbnail
(100
(rendered
to
a
size
of
400
columns
by
100
400
rows)
of
a
region
extending
from
the
top-left
corner
of
the
original
image,
across
image
to
1000
pixels
across
and
down
3000
pixels,
pixels
right,
to
be
retrieved
(additional
sub-resource
and
parameters
emphasized):
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.2https://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/rendered?viewport=400,400,0,0,1000,3000
If the specified WADO-RS service supports the DICOMweb thumbnail resource, a representative image of the study can be requested, for example, to display alongside the study. The URL would look as follows:
https://pacs.hospital.org/wado-rs/studies/1.2.250.1.59.40211.12345678.678910/thumbnail
For
further
details
on
DICOM
WADO-RS
capabilities
including
additional
rendering
parameters,
see
DICOM
PS
3.18
Section
10.4
.
An
Endpoint.connectionType
of
code
dicom-wado-uri
,
system
,
identifies
a
DICOM
WADO-URI
service.
http://hl7.org/fhir/endpoint-connection-type
http://terminology.hl7.org/CodeSystem/endpoint-connection-type
The
Endpoint.address
identifies
the
HTTP(S)
service
base
url.
That
is,
only
the
scheme,
authority
and
path
are
included.
Neither
a
quetstion
mark
(?)
nor
any
query
parameters
shall
be
included.
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,”
"single
frame",
"multi-frame",
"video",
"text",
or
“other.”
"other."
The
query
to
retrieve
a
DICOM
instance
is
constructed
by
appending
the
appropriate
query
parameters
to
the
value.
Endpoint.address.url
.
Endpoint.address
For
example,
a
native
DICOM
PS3.10
instance
file
can
be
retrieved
(if
consistent
with
using
the
Accept
header)
by
performing
a
GET
on
following
information
in
a
fictional
ImagingStudy
resource:
Endpoint.address.url
https://pacs.hospital.org/wado-uri
“https://pacs.hospital.org/wado-uri”
ImagingStudy.endpoint.address
,
“urn:oid:1.2.250.1.59.40211.12345678.678910”
1.2.250.1.59.40211.12345678.678910
found
in
an
ImagingStudy.identifier
having
Identifier.system
of
urn:dicom:uid
,
“urn:oid:1.2.250.1.59.40211.789001276.14556172.67789”
1.2.250.1.59.40211.789001276.14556172.67789
found
in
ImagingStudy.series.uid
,
and
“urn:oid:1.2.250.1.59.40211.2678810.87991027.899772.2”
:
1.2.250.1.59.40211.2678810.87991027.899772.2
found
in
ImagingStudy.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
Additional query parameters can control other aspects of the rendering including rendered dimensions, quality (compression ratio), the region of interest within the image to render, brightness/contrast (window center/width) adjustments, whether to “burn” patient or study demographics into the rendered result, and which frame of a multi-frame instance to retrieve.
For example, provided the Accept header indicates a preference for image/jpeg, the example above can be extended with parameters that cause a JPEG thumbnail (100 columns by 100 rows) of the left half of the image to be retrieved (additional parameters emphasized):
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&rows=100&columns=100®ion=0,0,0.5,1
For
further
details
on
DICOM
WADO-URI
capabilities
including
additional
rendering
parameters,
see
DICOM
PS
3.18
Chapter
9
.
An
Endpoint.connectionType
of
code
ihe-iid
,
system
http://hl7.org/fhir/endpoint-connection-type
,
identifies
Some
imaging
uses
might
require
information
beyond
what
is
present
in
an
IHE
Invoke
Image
Display
(IID)
service.
The
Endpoint.address
identifies
the
HTTP(S)
service
base
url.
That
is,
only
ImagingStudy
resource.
Many
of
the
scheme,
authority
DICOM
patient
and
path
study
level
attributes
are
included.
Neither
found
in
the
question
mark
(“?”)
nor
any
query
parameters
shall
FHIR
Patient,
Procedure,
or
other
resources
which
are
referenced
from
an
ImagingStudy
instance.
Other
DICOM
content
might
be
included.
transformed
into
other
FHIR
resources,
such
as
DiagnosticReports
or
Observations,
which
are
not
directly
referenced,
but
can
be
easily
found.
The
IHE
Invoke
Image
Display
(IID)
service
provides
a
standardized
mechanism
Although
many
ImagingStudy
consumers
are
expected
to
launch
a
viewer
need
only
the
DICOM
information
contained
in
a
particular
study
context.
(IID
also
supports
invoking
a
particular
patient
context,
but
that
FHIR
resources,
some
might
need
additional
DICOM
attributes.
For
these
cases,
which
by
their
nature
involve
more
imaging-aware
consumers,
the
most
flexible
solution
is
not
profiled
here.)
An
IID-type
Endpoint
should
be
used
only
at
to
leverage
the
study
level.
As
well
as
invoking
DICOM
WADO-RS
metadata-only
endpoint
to
retrieve
an
XML
or
JSON
representation
of
the
viewer
on
a
particular
DICOM
study,
query
parameters
can
request
particular
viewer
capabilities,
image
quality,
and
more.
series,
instance,
or
frame
information.
To
launch
a
viewer,
append
A
benefit
of
using
the
appropriate
query
parameters
metadata
endpoint
in
this
way
is
that
the
ImagingStudy
creator
does
not
need
to
Endpoint.address
value.
For
example,
given
an
Endpoint.address
know
each
of
https://pacs.hospital.org/IHEInvokeImageDisplay
,
to
invoke
a
diagnostic
quality
viewer
on
the
study
with
study.uid
value
attributes
that
each
of
“urn:uri:1.2.250.1.59.40211.12345678.678910”
,
the
(current
or
future)
ImagingStudy
consumers
is
(or
will
be)
interested
in.
A
client
retrieves
the
following
URL
would
be
constructed:
ImagingStudy:
https://pacs.hospital.org/IHEInvokeImageDisplay?requestType=STUDY&studyUID=1.2.250.1.59.40211.12345678.678910&diagnosticQuality=true{ "resourceType": "ImagingStudy", "id": "example-xr", "identifier": [ { "use": "official", "system": "urn:dicom:uid", "value": "urn:oid:2.16.124.113543.6003.1154777499.30246.19789.3503430046" } ], ... "series": [ { "uid": "2.16.124.113543.6003.1154777499.30246.19789.3503430045.1", ... "endpoint": [ { "reference": "Endpoint/example-wadors" } ] ... } ... ] }
For
further
details
on
IHE
Invoke
Image
Display
capabilities
including
additional
parameters,
see
the
IHE
Technical
Frameworks
(See
Example
XR
for
full
example)
The
client
retrieves
the
introduction
on
referenced
Endpoint
(see
Example
WADO-RS
)
and
extracts
the
IHE
IID
Profile
Wiki
WADO-RS
URL:
https://pacs.hospital.org/wado-rs.
The client uses the WADO-RS URL, the identifier.value and the series.uid to construct a WADO-RS metadata request:
GET https://pacs.hospital.org/wado-rs/studies/2.16.124.113543.6003.1154777499.30246.19789.3503430046/series/2.16.124.113543.6003.1154777499.30246.19789.3503430045.1/metadata HTTP/1.1 Accept: application/dicom+json
The WADO-RS server then returns the complete DICOM metadata for the requested series.
Amy,
a
family
physician,
would
like
to
see
Note:
reporting
workflow
is
not
described
in
this
use
case.
subject
is
current
Patient
basedOn
includes
current
ServiceRequest
identifier
is
Study
Instance
UID
endpoint
points
to
image
archive
WADO-RS
service
modality
is
US
modality
is
now
US,KOS
Joe
Angina
complains
of
shortness
of
breath
status=available
subject.identifier=[identifier
for
selected
patient]
ImagingStudy.identifier
)
ImagingStudy.basedOn.identifier
)
ImagingStudy.procedure
)
ImagingStudy.modality
)
ImagingStudy.endpoint
)
pointing
to
image
archive
hosting
DICOM
study
Depending
on
the
workflow,
with
modality
and
procedure
type,
a
link
DICOM
study
can
range
from
having
one
or
two
instances
(as
in
many
X-ray
procedures)
to
a
ProcedureRequest
resource
with
the
details
several
thousand
instances
(for
some
CT
exams)
or
even
tens
of
the
request.
thousands
(for
functional
MRI
studies).
The
order
number
of
series
within
a
study
has
far
less
variability,
and
is
scheduled
usually
under
twenty,
although
post-processing,
computer-aided
detection,
and
assigned
to
cardiologist
Dr.
Art
Skann,
also
at
Local
MultiClinic.
AI
applications
could
cause
modest
increases.
An
ImagingStudy
resource
describing
a
large
DICOM
study
would
itself
be
of
significant
size.
On
the
scheduled
day
of
the
exam,
Joe
arrives
at
the
echo
lab
Issuing
narrowly
tailored
queries
can
help
a
client
avoid
search
results
containing
many
ImagingStudy
resources.
The
_summary=true
query
parameter
will
omit
several
resource
elements,
including
all
instance-level
elements;
this
can
be
used
to
meet
with
Dr.
Skann
and
have
examine
search
results
before
retrieving
the
study
done.
Dr.
Skann’s
workstation
shows
full
instances.
If
a
server
limits
the
daily
list
byte
size
of
Task
,
and
he
follows
search
bundle,
this
can
impact
the
link
number
of
ImagingStudy
resources
returned
per
search
result
page;
a
client
can
use
the
_count
query
parameter
to
retrieve
influence
the
ProcedureRequest
.
(He
may
follow
number
of
resources
per
search
result
page.
Although
not
reflected
in
the
links
through
ImagingStudy
resource,
the
size
of
an
individual
referenced
Patient
resource
instance
can
be
anywhere
from
a
few
kilobytes
(a
compressed
256x256
pixel
MR
or
640x480
pixel
ultrasound
image)
to
access
Joe’s
electronic
medical
record,
but
that
is
not
a
gigabyte
or
more
(for
digital
breast
tomography
imaging).
When
retrieving
the
concern
referenced
content
of
this
storyboard.)
an
ImagingStudy,
applications
can
consider
methods
to
reduce
transfer
time,
such
as:
The
ImagingStudy
resource
can
be
hosted
by
an
image
archive
application
—
such
as
a
DICOM
Modality
Worklist
Scheduled
Procedure
Step,
and
PACS
or
Vendor-Neutral
Archive
—
or
a
more
general
healthcare
informatics
application
such
as
an
EMR.
In
some
cases,
it
could
be
hosted
in
both
locations.
However,
the
echo
lab
image
archive
is
typically
the
equipment
has
downloaded
source
of
truth
for
the
Modality
Worklist.
The
study
is
performed,
and
content
of
the
acquired
images
and
sonographer’s
preliminary
measurements
are
stored
in
ImagingStudy.
Depending
on
where
the
Local
MultiClinic
Picture
Archiving
and
Communication
System
(PACS).
The
PACS
creates
an
ImagingStudy
resource
is
hosted,
there
are
several
available
mechanisms
for
each
study
it
manages.
keeping
the
two
applications
consistent.
Dr.
Skann
interprets
In
this
scenario,
the
study
on
a
PACS
workstation,
image
archive:
The
image
frames
to
be
included
in
the
diagnostic
report;
this
selection
is
stored
back
to
archive
could
share
ImagingStudy
information
by:
GET
http://example.org/fhir/ImagingStudy?basedOn=ServiceRequest/123&status=available
In
this
scenario,
the
title
"For
Report
Attachment",
image
archive:
while
the
report
using
a
structured
data
entry
report
writing
program,
including
a
recommendation
for
a
cardiac
catheterization
procedure,
EMR:
The
report
writing
program
formats
the
report
as
image
archive
could
share
ImagingStudy
information
by:
In this scenario, the image archive:
while
the
referenced
EMR:
Mechanisms
for
ensuring
consistency
between
two
systems
holding
representations
of
the
report.
same
data
are
still
in
development.
Dr.
Down
meets
again
with
Joe,
and
they
review
As
the
results
image
archive
is
the
"source
of
truth,"
the
stress
test.
Joe
has
above
methods
might
still
be
applicable.
See
Provenance
resource.
Typically,
an
ImagingStudy
is
a
question
about
the
findings
FHIR
representation
of
imaging
data
that
the
key
images
is
stored
in
a
DICOM
device,
such
as
an
image
archive
(e.g.,
PACS).
The
value
of
the
report
do
status
element
reflects
the
status
of
this
representation
and
does
not
show,
so
Dr.
Down
uses
necessarily
reflect
the
Local
MultiClinic
EMR
to
query
status
of
either
the
PACS
for
underlying
imaging
data
or
any
ServiceRequest
or
Task
resources
that
resulted
in
the
full
ImagingStudy
resource,
and
uses
being
created.
In
some
cases,
the
references
there
to
open
an
image
display
for
ImagingStudy
could
be
created
before
any
images
have
been
acquired.
In
this
case,
the
full
study.
Joe
agrees
to
proceed
to
catheterization,
and
Dr.
Down
sends
.status
will
have
a
referral
to
the
Ginormous
University
Hospital
cath
department,
value
of
registered
.
After
at
least
some
images
have
been
acquired
and
triggers
the
PACS
ImagingStudy
has
been
updated
to
share
reflect
that,
the
echo
study
through
ImagingStudy
will
have
a
status
of
available
.
At
this
stage
the
Metropolitan
Health
Information
Exchange.
ImagingStudy
can
be
presented
to
viewing
applications.
The
PACS
creates
a
manifest
of
If
the
study
as
an
ImagingManifest
resource,
which
includes
all
ImagingStudy
is
canceled
before
images
are
acquired
its
status
SHOULD
be
set
to
cancelled
.
If
the
ImagingStudy
is
incorrect
-
e.g.,
due
to
images
but
excludes
being
acquired
with
the
sonographer’s
preliminary
measurements
(which
as
wrong
modality
worklist
entry
selected
—
it
might
be
corrected
with
an
update
operation
or
set
to
entered-in-error
and
replaced
with
a
matter
new
ImagingStudy.
Additional
DICOM
images,
key
object
notes,
etc.
could
be
created
later,
so
a
status
of
policy
are
complete
is
not
shared
outside
the
Local
MultiClinic).
The
manifest
meaningful
for
an
ImagingStudy.
For
this
reason,
this
status
is
published
not
defined
for
an
ImagingStudy.
Any applications waiting for the completion of an imaging-related ServiceRequest or Task SHOULD track the progress of those resources directly.
An
ImagingStudy
might
be
created
to
represent
the
Metro
HIE.
(In
accordance
with
content
of:
The set of ImagingStudy elements is broadly aligned with these three information models.
In DICOM, a Study can be related to two types of "procedures": requested procedures and performed procedures.
In
the
images
themselves
FHIR
model,
"requested
procedures"
are
not
directly
published
to
represented
by
the
HIE,
but
available
for
on-demand
retrieval
from
ServiceRequest
resource
while
"performed
procedures"
are
represented
by
the
PACS.)
Procedure
resource.
At
Ginormous
Hospital,
Dr.
Cora
Plummer
receives
Therefore,
the
cath
referral,
and
looks
up
requested
procedure
associated
with
a
particular
imaging
study
would
typically
be
encoded
as
the
ServiceRequest
that
the
imaging
study
in
is
basedOn.
Similarly,
the
Metro
HIE
registry.
She
retrieves
performed
procedure
would
be
encoded
as
the
ImagingStudy.procedure
that
the
imaging
study
manifest
ImagingManifest
,
is
part
of.
Searching
for
an
imaging
study
by
its
requested
procedure
can
be
done
by
including
based-on
as
a
search
parameter,
and
uses
it
to
access
by
its
performed
procedure
by
including
procedure
as
a
search
parameter.
The
series.bodySite
element
can
include
the
shared
images,
which
she
uses
to
prepare
for
laterality
of
the
cath
procedure.
(possibly
paired)
anatomic
structures
examined
–
e.g.
left
knee,
bilateral
lungs,
etc.
This
can
be
conveyed
in
several
ways:
series.bodySite
contains
an
anatomic
code
that
includes
laterality,
e.g.
"bodySite": {
"concept": {
"coding": [{
"system": "http://snomed.info/sct",
"code": "5951000",
"display": "Left wrist"
}]
}
}
series.bodySite
contains
a
reference
to
a
BodyStructure
resource
whose
includedStructure.structure
element
contains
an
anatomic
code
that
includes
laterality
series.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 |
|
|
reference | The order for the image such as Accession Number |
ImagingStudy.basedOn
( |
|
|
body-site
|
token | The body site code studied |
|
|
|
|
reference |
The
|
|
|
| dicom-class | uri | The type of the instance | ImagingStudy.series.instance.sopClass | |
| encounter | reference | The context of the study |
ImagingStudy.encounter
( Encounter ) | 27 Resources |
| endpoint | reference |
The
endpoint
for
|
ImagingStudy.endpoint
|
ImagingStudy.series.endpoint
( Endpoint ) |
|
| identifier | token |
|
ImagingStudy.identifier |
|
| instance | token | SOP Instance UID for an instance | ImagingStudy.series.instance.uid | |
| modality | token | The modality of the series | ImagingStudy.series.modality | |
| patient | reference | Who the study is about |
( Patient ) |
|
| performer | reference | The person who performed the study |
( Practitioner , Organization , CareTeam , Device , Patient , HealthcareService , PractitionerRole , RelatedPerson ) |
|
| procedure |
reference
|
The performed procedure for the study |
ImagingStudy.procedure
( Procedure ) | |
| reason-concept | token | The reason code for the study |
|
|
|
|
reference | The resource reference describing the reason for the study | ImagingStudy.reason.reference |
|
| referrer | reference |
The
|
ImagingStudy.referrer
( Practitioner , PractitionerRole ) | |
|
series
|
token | DICOM Series Instance UID for a series | ImagingStudy.series.uid | |
| started | date | When the study was started | ImagingStudy.started | |
|
|
|
The
|
|
|
|
subject
|
|
|
( Group , Device , Patient ) |