This
page
is
part
of
the
FHIR
Specification
(v5.0.0:
R5
-
STU
v6.0.0-ballot3:
Release
6
Ballot
(3rd
Draft)
(see
Ballot
Notes
).
This
is
the
The
current
published
version
in
it's
permanent
home
(it
will
always
be
available
at
this
URL).
is
5.0.0
.
For
a
full
list
of
available
versions,
see
the
Directory
of
published
versions
.
Page
versions:
R5
R4B
R4
R3
R2
Imaging
Integration
Work
Group
|
Maturity Level : 4 | Trial Use | Security Category : Patient | 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
have
multiple
series
of
different
modalities.
modality
values.
The ImagingStudy resource provides information on available imaging data.
An
ImagingStudy
provides
information
on
a
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.
study
available.
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
of
Instances
in
Study",
can
be
found
in
DICOM
Part
4
Annex
C
.
ImagingStudy
provides
access
to
significant
DICOM
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).
An
ImagingStudy
SHALL
reference
one
DICOM
Study,
and
MAY
reference
a
subset
of
that
Study.
More
than
one
ImagingStudy
MAY
reference
the
same
DICOM
Study
or
different
subsets
of
This
resource
may
change
as
additional
information
is
added
to
the
same
related
DICOM
Study.
Use
the
The
ImagingStudy
resource
is
used
to
store
details
of
an
entire
DICOM
Study
and
associated
information.
information,
including
its
relationship
to
other
resources,
such
as
ServiceRequest
and
Encounter
.
Use
The
ImagingSelection
resource
is
used
to
reference
to
a
specific
set
of
specific
set
of
images,
frames,
waveforms
or
image
regions.
Instances
of
this
resource
are
created
for
specific
clinical
purposes
and
are
unlikely
to
change
once
created.
An Observation MAY be related to a set of images in the following ways.
The DocumentReference resource is used to to store non-DICOM images, video, or audio with relevant metadata. The DocumentReference resource might be appropriate for including a rendered DICOM image in cases where only the image is needed and not the full image context.
Use
the
The
Binary
resource
to
store
arbitrary
content.
Structure
| Name | Flags | Card. | Type |
Description
&
Constraints
|
|---|---|---|---|---|
|
TU | DomainResource |
A
set
of
images
or
image-related
data
produced
in
single
study
Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension |
|
|
Σ | 0..* | Identifier |
|
|
?! Σ | 1..1 | code |
registered
|
available
|
cancelled
|
entered-in-error
|
unknown
|
inactive
Binding: Imaging Study Status ( Required ) |
|
Σ | 0..* | CodeableConcept |
Binding: Modality
(
Extensible
)
|
|
Σ | 1..1 | Reference ( Patient | Device | Group ) |
Who
or
what
is
the
subject
of
the
study
|
|
Σ | 0..1 | Reference ( Encounter ) |
Encounter
with
which
this
imaging
study
is
associated
|
|
Σ | 0..1 | dateTime |
When
the
study
was
started
|
|
Σ | 0..* |
Reference
(
CarePlan
|
ServiceRequest
|
Appointment
|
|
|
|
Σ | 0..* | Reference ( Procedure ) |
Part
of
referenced
event
|
|
Σ | 0..1 | Reference ( Practitioner | PractitionerRole ) |
Referring
physician
|
|
Σ | 0..* | Reference ( Endpoint ) |
Study
access
endpoint
|
|
Σ | 0..* | CodeableReference ( PlanDefinition | ActivityDefinition ) |
Binding: ImagingProcedureCode
(
Preferred
)
|
|
Σ | 0..1 | Reference ( Location ) |
Where
|
|
Σ | 0..* | CodeableReference ( Condition | Observation | DiagnosticReport | DocumentReference ) |
Why
Binding: Procedure Reason Codes ( Example ) |
|
Σ | 0..* | Annotation |
|
|
Σ | 0..1 | string |
Study
Description
or
Classification
|
| Σ | 0..1 | unsignedInt |
Number
of
Study
Related
Series
|
![]() ![]() |
| 0..1 | unsignedInt |
Number
of
Study
Related
Instances
|
|
Σ | 0..* | BackboneElement |
|
|
Σ | 1..1 | id |
DICOM
Series
Instance
UID
|
|
Σ | 0..1 | unsignedInt |
Numeric
identifier
of
this
series
|
|
Σ | 1..1 | CodeableConcept |
The
modality
used
for
this
series
Binding: Modality
(
Extensible
)
|
|
Σ | 0..1 | string |
|
|
Σ | 0..1 | unsignedInt |
Number
of
Series
Related
Instances
|
|
Σ | 0..* | Reference ( Endpoint ) |
Series
access
endpoint
|
|
Σ | 0..1 | CodeableReference ( BodyStructure ) |
Body
part
examined
Binding: SNOMED CT Body Structures ( Example ) |
|
Σ | 0..1 | CodeableConcept |
Body
part
laterality
Binding: Laterality
(
Example
)
|
|
Σ | 0..* | Reference ( Specimen ) |
Specimen
imaged
|
|
Σ | 0..1 | dateTime |
When
the
series
started
|
|
Σ | 0..* | BackboneElement |
Who
performed
the
series
|
|
Σ | 0..1 | CodeableConcept |
Type
of
performance
Binding: ImagingStudy series performer function ( Extensible ) |
|
Σ | 1..1 | Reference ( Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson | HealthcareService ) |
Who
performed
the
series
|
|
0..* | BackboneElement |
A
single
SOP
instance
from
the
series
|
|
|
1..1 | id |
DICOM
SOP
Instance
UID
|
|
|
1..1 |
|
DICOM
class
type
|
|
|
0..1 | unsignedInt |
The
number
of
this
instance
in
the
series
|
|
|
0..1 | string |
Description
of
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 -->
<</identifier> < <</modality><identifier><!-- 0..* Identifier Business identifier for imaging study --></identifier> <status value="[code]"/><!-- 1..1 registered | available | cancelled | entered-in-error | unknown | inactive --> <modality><!-- 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><basedOn><!-- 0..* Reference(Appointment|CarePlan|ServiceRequest|Task) Fulfills plan or order --></basedOn> <partOf><!-- 0..* Reference(Procedure) Part of referenced event --></partOf><</referrer><referrer><!-- 0..1 Reference(Practitioner|PractitionerRole) Referring physician --></referrer> <endpoint><!-- 0..* Reference(Endpoint) Study access endpoint --></endpoint>< < <</procedure> <</location> <| </reason> <</note> < < <<procedure><!-- 0..* CodeableReference(ActivityDefinition|PlanDefinition) Associated procedure(s)--></procedure> <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]"/><!-- 0..1 Number of Study Related Series --> <numberOfInstances value="[unsignedInt]"/><!-- 0..1 Number of Study Related Instances --> <series> <!-- 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> < < <</endpoint> <</bodySite> <</laterality><modality><!-- 1..1 CodeableConcept The modality used for this series--></modality> <description value="[string]"/><!-- 0..1 Series Description or Classification --> <numberOfInstances value="[unsignedInt]"/><!-- 0..1 Number of Series Related Instances --> <endpoint><!-- 0..* Reference(Endpoint) Series access endpoint --></endpoint> <bodySite><!-- 0..1 CodeableReference(BodyStructure) Body part examined --></bodySite> <laterality><!-- 0..1 CodeableConcept Body part laterality
--></laterality> <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 the series --></actor> </performer> <instance> <!-- 0..* A single SOP instance from the series --> <uid value="[id]"/><!-- 1..1 DICOM SOP Instance UID -->
<</sopClass><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 Description of 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 }], // Business identifier for imaging study
"status" : "<code>", // R! registered | available | cancelled | entered-in-error | unknown | inactive
"modality" : [{ CodeableConcept }], // 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
"partOf" : [{ Reference(Procedure) }], // Part of referenced event
"
"referrer" : { Reference(Practitioner|PractitionerRole) }, // Referring physician
"endpoint" : [{ Reference(Endpoint) }], // Study access endpoint
"
"
"
"
"|
"
"
"
"
"procedure" : [{ CodeableReference(ActivityDefinition|PlanDefinition) }], // Associated procedure(s)
"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>", // Number of Study Related Series
"numberOfInstances" : "<unsignedInt>", // Number of Study Related Instances
"series" : [{ // The set of Series belonging to the study
"uid" : "<id>", // R! DICOM Series Instance UID
"number" : "<unsignedInt>", // Numeric identifier of this series
"
"
"
"
"
"
"modality" : { CodeableConcept }, // R! The modality used for this series
"description" : "<string>", // Series Description or Classification
"numberOfInstances" : "<unsignedInt>", // Number of Series Related Instances
"endpoint" : [{ Reference(Endpoint) }], // Series access endpoint
"bodySite" : { CodeableReference(BodyStructure) }, // Body part examined
"laterality" : { CodeableConcept }, // Body part laterality
"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 the series
}],
"instance" : [{ // 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>" // Description of 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 Resource: .id, .meta, .implicitRules, and .language # from DomainResource: .text, .contained, .extension, and .modifierExtensionfhir: fhir: fhir:fhir:identifier ( [ Identifier ] ... ) ; # 0..* Business identifier for imaging study fhir:status [ code ] ; # 1..1 registered | available | cancelled | entered-in-error | unknown | inactive fhir:modality ( [ CodeableConcept ] ... ) ; # 0..* 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 startedfhir:fhir:basedOn ( [ Reference(Appointment|CarePlan|ServiceRequest|Task) ] ... ) ; # 0..* Fulfills plan or order fhir:partOf ( [ Reference(Procedure) ] ... ) ; # 0..* Part of referenced eventfhir:fhir:referrer [ Reference(Practitioner|PractitionerRole) ] ; # 0..1 Referring physician fhir:endpoint ( [ Reference(Endpoint) ] ... ) ; # 0..* Study access endpointfhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir:fhir:procedure ( [ CodeableReference(ActivityDefinition|PlanDefinition) ] ... ) ; # 0..* Associated procedure(s) 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 Number of Study Related Series fhir:numberOfInstances [ unsignedInt ] ; # 0..1 Number of Study Related Instances fhir:series ( [ # 0..* 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 seriesfhir: fhir: fhir: fhir: fhir: fhir:fhir:modality [ CodeableConcept ] ; # 1..1 The modality used for this series fhir:description [ string ] ; # 0..1 Series Description or Classification fhir:numberOfInstances [ unsignedInt ] ; # 0..1 Number of Series Related Instances fhir:endpoint ( [ Reference(Endpoint) ] ... ) ; # 0..* Series access endpoint fhir:bodySite [ CodeableReference(BodyStructure) ] ; # 0..1 Body part examined fhir:laterality [ CodeableConcept ] ; # 0..1 Body part laterality 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 the series ] ... ) ; fhir:instance ( [ # 0..* A single SOP instance from the series fhir:uid [ id ] ; # 1..1 DICOM SOP Instance UIDfhir: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 Description of instance ] ... ) ; ] ... ) ; ]
Changes from both R4 and R4B
| ImagingStudy | |
| ImagingStudy.status |
|
| ImagingStudy.modality |
|
| ImagingStudy.basedOn |
|
| ImagingStudy.partOf |
|
| ImagingStudy.procedure |
|
| ImagingStudy.reason |
|
| ImagingStudy.series.modality |
|
| ImagingStudy.series.bodySite |
|
| ImagingStudy.series.laterality |
|
| ImagingStudy.series.performer.actor |
|
| ImagingStudy.series.instance.sopClass |
|
| ImagingStudy.interpreter |
|
| ImagingStudy.procedureReference |
|
| ImagingStudy.procedureCode |
|
| ImagingStudy.reasonCode |
|
| ImagingStudy.reasonReference |
|
See the Full Difference for further information
This analysis is available for R4 as XML or JSON and for R4B as XML or JSON .
Structure
| Name | Flags | Card. | Type |
Description
&
Constraints
|
|---|---|---|---|---|
|
TU | DomainResource |
A
set
of
images
or
image-related
data
produced
in
single
study
Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension |
|
|
Σ | 0..* | Identifier |
|
|
?! Σ | 1..1 | code |
registered
|
available
|
cancelled
|
entered-in-error
|
unknown
|
inactive
Binding: Imaging Study Status ( Required ) |
|
Σ | 0..* | CodeableConcept |
Binding: Modality
(
Extensible
)
|
|
Σ | 1..1 | Reference ( Patient | Device | Group ) |
Who
or
what
is
the
subject
of
the
study
|
|
Σ | 0..1 | Reference ( Encounter ) |
Encounter
with
which
this
imaging
study
is
associated
|
|
Σ | 0..1 | dateTime |
When
the
study
was
started
|
|
Σ | 0..* |
Reference
(
CarePlan
|
ServiceRequest
|
Appointment
|
|
|
|
Σ | 0..* | Reference ( Procedure ) |
Part
of
referenced
event
|
|
Σ | 0..1 | Reference ( Practitioner | PractitionerRole ) |
Referring
physician
|
|
Σ | 0..* | Reference ( Endpoint ) |
Study
access
endpoint
|
|
Σ | 0..* | CodeableReference ( PlanDefinition | ActivityDefinition ) |
Binding: ImagingProcedureCode
(
Preferred
)
|
|
Σ | 0..1 | Reference ( Location ) |
Where
|
|
Σ | 0..* | CodeableReference ( Condition | Observation | DiagnosticReport | DocumentReference ) |
Why
Binding: Procedure Reason Codes ( Example ) |
|
Σ | 0..* | Annotation |
|
|
Σ | 0..1 | string |
Study
Description
or
Classification
|
![]() ![]() | Σ | 0..1 | unsignedInt |
Number
of
Study
Related
Series
|
![]() ![]() |
| 0..1 | unsignedInt |
Number
of
Study
Related
Instances
|
|
Σ | 0..* | BackboneElement |
|
|
Σ | 1..1 | id |
DICOM
Series
Instance
UID
|
|
Σ | 0..1 | unsignedInt |
Numeric
identifier
of
this
series
|
|
Σ | 1..1 | CodeableConcept |
The
modality
used
for
this
series
Binding: Modality
(
Extensible
)
|
|
Σ | 0..1 | string |
|
|
Σ | 0..1 | unsignedInt |
Number
of
Series
Related
Instances
|
|
Σ | 0..* | Reference ( Endpoint ) |
Series
access
endpoint
|
|
Σ | 0..1 | CodeableReference ( BodyStructure ) |
Body
part
examined
Binding: SNOMED CT Body Structures ( Example ) |
|
Σ | 0..1 | CodeableConcept |
Body
part
laterality
Binding: Laterality
(
Example
)
|
|
Σ | 0..* | Reference ( Specimen ) |
Specimen
imaged
|
|
Σ | 0..1 | dateTime |
When
the
series
started
|
|
Σ | 0..* | BackboneElement |
Who
performed
the
series
|
|
Σ | 0..1 | CodeableConcept |
Type
of
performance
Binding: ImagingStudy series performer function ( Extensible ) |
|
Σ | 1..1 | Reference ( Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson | HealthcareService ) |
Who
performed
the
series
|
|
0..* | BackboneElement |
A
single
SOP
instance
from
the
series
|
|
|
1..1 | id |
DICOM
SOP
Instance
UID
|
|
|
1..1 |
|
DICOM
class
type
|
|
|
0..1 | unsignedInt |
The
number
of
this
instance
in
the
series
|
|
|
0..1 | string |
Description
of
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 -->
<</identifier> < <</modality><identifier><!-- 0..* Identifier Business identifier for imaging study --></identifier> <status value="[code]"/><!-- 1..1 registered | available | cancelled | entered-in-error | unknown | inactive --> <modality><!-- 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><basedOn><!-- 0..* Reference(Appointment|CarePlan|ServiceRequest|Task) Fulfills plan or order --></basedOn> <partOf><!-- 0..* Reference(Procedure) Part of referenced event --></partOf><</referrer><referrer><!-- 0..1 Reference(Practitioner|PractitionerRole) Referring physician --></referrer> <endpoint><!-- 0..* Reference(Endpoint) Study access endpoint --></endpoint>< < <</procedure> <</location> <| </reason> <</note> < < <<procedure><!-- 0..* CodeableReference(ActivityDefinition|PlanDefinition) Associated procedure(s)--></procedure> <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]"/><!-- 0..1 Number of Study Related Series --> <numberOfInstances value="[unsignedInt]"/><!-- 0..1 Number of Study Related Instances --> <series> <!-- 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> < < <</endpoint> <</bodySite> <</laterality><modality><!-- 1..1 CodeableConcept The modality used for this series--></modality> <description value="[string]"/><!-- 0..1 Series Description or Classification --> <numberOfInstances value="[unsignedInt]"/><!-- 0..1 Number of Series Related Instances --> <endpoint><!-- 0..* Reference(Endpoint) Series access endpoint --></endpoint> <bodySite><!-- 0..1 CodeableReference(BodyStructure) Body part examined --></bodySite> <laterality><!-- 0..1 CodeableConcept Body part laterality
--></laterality> <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 the series --></actor> </performer> <instance> <!-- 0..* A single SOP instance from the series --> <uid value="[id]"/><!-- 1..1 DICOM SOP Instance UID -->
<</sopClass><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 Description of 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 }], // Business identifier for imaging study
"status" : "<code>", // R! registered | available | cancelled | entered-in-error | unknown | inactive
"modality" : [{ CodeableConcept }], // 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
"partOf" : [{ Reference(Procedure) }], // Part of referenced event
"
"referrer" : { Reference(Practitioner|PractitionerRole) }, // Referring physician
"endpoint" : [{ Reference(Endpoint) }], // Study access endpoint
"
"
"
"
"|
"
"
"
"
"procedure" : [{ CodeableReference(ActivityDefinition|PlanDefinition) }], // Associated procedure(s)
"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>", // Number of Study Related Series
"numberOfInstances" : "<unsignedInt>", // Number of Study Related Instances
"series" : [{ // The set of Series belonging to the study
"uid" : "<id>", // R! DICOM Series Instance UID
"number" : "<unsignedInt>", // Numeric identifier of this series
"
"
"
"
"
"
"modality" : { CodeableConcept }, // R! The modality used for this series
"description" : "<string>", // Series Description or Classification
"numberOfInstances" : "<unsignedInt>", // Number of Series Related Instances
"endpoint" : [{ Reference(Endpoint) }], // Series access endpoint
"bodySite" : { CodeableReference(BodyStructure) }, // Body part examined
"laterality" : { CodeableConcept }, // Body part laterality
"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 the series
}],
"instance" : [{ // 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>" // Description of 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 Resource: .id, .meta, .implicitRules, and .language # from DomainResource: .text, .contained, .extension, and .modifierExtensionfhir: fhir: fhir:fhir:identifier ( [ Identifier ] ... ) ; # 0..* Business identifier for imaging study fhir:status [ code ] ; # 1..1 registered | available | cancelled | entered-in-error | unknown | inactive fhir:modality ( [ CodeableConcept ] ... ) ; # 0..* 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 startedfhir:fhir:basedOn ( [ Reference(Appointment|CarePlan|ServiceRequest|Task) ] ... ) ; # 0..* Fulfills plan or order fhir:partOf ( [ Reference(Procedure) ] ... ) ; # 0..* Part of referenced eventfhir:fhir:referrer [ Reference(Practitioner|PractitionerRole) ] ; # 0..1 Referring physician fhir:endpoint ( [ Reference(Endpoint) ] ... ) ; # 0..* Study access endpointfhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir:fhir:procedure ( [ CodeableReference(ActivityDefinition|PlanDefinition) ] ... ) ; # 0..* Associated procedure(s) 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 Number of Study Related Series fhir:numberOfInstances [ unsignedInt ] ; # 0..1 Number of Study Related Instances fhir:series ( [ # 0..* 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 seriesfhir: fhir: fhir: fhir: fhir: fhir:fhir:modality [ CodeableConcept ] ; # 1..1 The modality used for this series fhir:description [ string ] ; # 0..1 Series Description or Classification fhir:numberOfInstances [ unsignedInt ] ; # 0..1 Number of Series Related Instances fhir:endpoint ( [ Reference(Endpoint) ] ... ) ; # 0..* Series access endpoint fhir:bodySite [ CodeableReference(BodyStructure) ] ; # 0..1 Body part examined fhir:laterality [ CodeableConcept ] ; # 0..1 Body part laterality 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 the series ] ... ) ; fhir:instance ( [ # 0..* A single SOP instance from the series fhir:uid [ id ] ; # 1..1 DICOM SOP Instance UIDfhir: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 Description of instance ] ... ) ; ] ... ) ; ]
Changes from both R4 and R4B
| ImagingStudy | |
| ImagingStudy.status |
|
| ImagingStudy.modality |
|
| ImagingStudy.basedOn |
|
| ImagingStudy.partOf |
|
| ImagingStudy.procedure |
|
| ImagingStudy.reason |
|
| ImagingStudy.series.modality |
|
| ImagingStudy.series.bodySite |
|
| ImagingStudy.series.laterality |
|
| ImagingStudy.series.performer.actor |
|
| ImagingStudy.series.instance.sopClass |
|
| ImagingStudy.interpreter |
|
| ImagingStudy.procedureReference |
|
| ImagingStudy.procedureCode |
|
| ImagingStudy.reasonCode |
|
| ImagingStudy.reasonReference |
|
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 |
|---|---|---|---|
| ImagingStudy.status | ImagingStudyStatus | Required |
The status of the ImagingStudy. |
| ImagingStudy.modality |
Modality
|
Extensible |
Transitive closure of CID 33 Modality |
| ImagingStudy.procedure |
http://loinc.org/vs/loinc-rsna-radiology-playbook
|
Preferred | The performed procedure type. |
| ImagingStudy.reason | ProcedureReasonCodes | Example |
This example value set defines the set of codes that can be used to indicate a reason for a procedure. |
| ImagingStudy.series.modality |
Modality
|
Extensible |
Transitive closure of CID 33 Modality |
| ImagingStudy.series.bodySite | SNOMEDCTBodyStructures | Example |
This
value
set
includes
all
codes
from
SNOMED
CT
|
| ImagingStudy.series.laterality |
Laterality
|
Example |
Transitive closure of CID 244 Laterality |
| ImagingStudy.series.performer.function | ImagingStudySeriesPerformerFunction | Extensible |
Performer function of an agent in an imaging study series |
A referenced DICOM SOP instance could be:
DICOM
Series
Instance
UID
and
SOP
Instance
UID
use
the
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
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
2.16.124.113543.1154777499.30246.19789.3503430046
is
encoded
as:
"identifier":{
"system":"urn:dicom:uid",
"value":"urn:oid:2.16.124.113543.1154777499.30246.19789.3503430046"
}
The
study
accession
number
can
also
be
is
encoded
as
an
Reference.Identifier
Reference.identifier
element
using
the
ServiceRequest
Reference
type
and
the
identifier
type,
“ACSN”
ACSN
as
follows:
e.g.:
"basedOn": ["reference": { "type": "ServiceRequest", "identifier":{ "type" : { "coding" : [ { "system" : "http://terminology.hl7.org/CodeSystem/v2-0203", "code" : "ACSN" } ] }, "system":"http://ginormoushospital.org/accession", "value":"GH334103" }"reference": { "identifier":{ "type" : { "coding" : [ { "system" : "http://terminology.hl7.org/CodeSystem/v2-0203", "code" : "ACSN" } ] }, "system":"http://ginormoushospital.org/accession", "value":"GH334103" } } ]
The ImagingStudy.endpoint elements and ImagingStudy.series.endpoint elements indicate network services that can be used to access the studies, series, or instances; for example, a DICOM WADO-RS server. An ImagingStudy.series.endpoint of a particular Endpoint.connectionType provides that service for that series, and all contained instances. An ImagingStudy.endpoint of a 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 ImagingStudy.series.endpoint overrides an ImagingStudy.endpoint of the same connection type. 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.
Different
Endpoint
connection
types
may
MAY
have
different
capabilities,
protocols
or
requirements;
and
the
specified
Endpoint.address
may
MAY
require
manipulation.
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
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
SHALL
NOT
be
specified.
The
path
shall
not
SHALL
NOT
contain
a
trailing
slash.
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
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 ImagingStudy resource:
“https://pacs.hospital.org/wado-rs”
found
in
an
ImagingStudy.endpoint.address
,
“1.2.250.1.59.40211.12345678.678910”
found
in
an
ImagingStudy.identifier
having
Identifier.system
of
“urn:dicom:uid”
,
“1.2.250.1.59.40211.789001276.14556172.67789”
found
in
ImagingStudy.series.uid
,
and
“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"
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
MAY
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 (rendered to a size of 400 columns by 400 rows) of a region extending from the top-left corner of the original image to 1000 pixels across and 3000 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.2/rendered?viewport=400,400,0,0,1000,3000
If the WADO-RS service supports the DICOMweb thumbnail resource, a representative image 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
http://terminology.hl7.org/CodeSystem/endpoint-connection-type
,
identifies
a
DICOM
WADO-URI
service.
The
Endpoint.address
identifies
the
HTTP(S)
service
base
url.
That
is,
only
the
scheme,
authority
and
path
are
included.
Neither
a
question
mark
(“?”)
nor
any
query
parameters
shall
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,” 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 ImagingStudy resource:
“https://pacs.hospital.org/wado-uri”
found
in
an
ImagingStudy.endpoint.address
,
1.2.250.1.59.40211.12345678.678910”
found
in
an
ImagingStudy.identifier
having
Identifier.system
of
“urn:dicom:uid”
,
“1.2.250.1.59.40211.789001276.14556172.67789”
found
in
ImagingStudy.series.uid
,
and
“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://terminology.hl7.org/CodeSystem/endpoint-connection-type
,
identifies
an
IHE
Invoke
Image
Display
(IID)
service.
The
Endpoint.address
identifies
the
HTTP(S)
service
base
url.
That
is,
only
the
scheme,
authority
and
path
are
included.
Neither
a
question
mark
(“?”)
nor
any
query
parameters
shall
SHALL
be
included.
The
IHE
Invoke
Image
Display
(IID)
service
provides
a
standardized
mechanism
to
launch
a
viewer
in
a
particular
study
context.
(IID
also
supports
invoking
a
particular
patient
context,
but
that
is
not
profiled
here.)
An
IID-type
Endpoint
should
SHOULD
be
used
only
at
the
study
level.
As
well
as
invoking
the
viewer
on
a
particular
study,
query
parameters
can
request
particular
viewer
capabilities,
image
quality,
and
more.
To
launch
a
viewer,
append
the
appropriate
query
parameters
to
Endpoint.address
value.
For example, using the following information in a fictional ImagingStudy resource:
“https://pacs.hospital.org/IHEInvokeImageDisplay”
found
in
an
ImagingStudy.endpoint.address
,
“urn:oid:1.2.250.1.59.40211.12345678.678910”
found
in
an
ImagingStudy.identifier
having
Identifier.system
of
“urn:dicom:uid”
,
https://pacs.hospital.org/IHEInvokeImageDisplay?requestType=STUDY&studyUID=1.2.250.1.59.40211.12345678.678910&diagnosticQuality=true
For
further
details
on
IHE
Invoke
Image
Display
capabilities
including
additional
parameters,
see
the
IHE
Technical
Frameworks
,
or
the
introduction
on
the
IHE
IID
Profile
Wiki
.
Some
imaging
uses
may
MAY
require
information
beyond
what
is
present
in
an
ImagingStudy
resource.
Many
of
the
DICOM
patient
and
study
level
attributes
are
found
in
the
FHIR
Patient,
Procedure,
or
other
resources
which
are
referenced
from
an
ImagingStudy
instance.
Other
DICOM
content
may
MAY
be
transformed
into
other
FHIR
resources,
such
as
DiagnosticReports
or
Observations,
which
are
not
directly
referenced,
but
may
MAY
be
easily
found.
Although
many
ImagingStudy
consumers
are
expected
to
need
only
the
DICOM
information
contained
in
FHIR
resources,
some
may
MAY
need
additional
DICOM
attributes.
For
these
cases,
which
by
their
nature
involve
more
imaging-aware
consumers,
the
most
flexible
solution
is
to
leverage
the
DICOM
WADO-RS
metadata-only
endpoint
to
retrieve
an
XML
or
JSON
representation
of
the
DICOM
study,
series,
instance,
or
frame
information.
A benefit of using the metadata endpoint in this way is that the ImagingStudy creator does not need to know each of the attributes that each of the (current or future) ImagingStudy consumers is (or will be) interested in.
A client retrieves the following ImagingStudy:
{
"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"
}
]
...
}
...
]
}
(See Example XR for full example)
The client retrieves the referenced Endpoint (see Example WADO-RS ) and extracts the 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
a
list
of
available
studies
for
her
patient,
Alex,
filtered
by
ImagingStudy.status=available
to
exclude
studies
without
images.
Her
EHR
client
makes
a
FHIR
call
for
all
ImagingStudy
objects
available
for
Alex.
In
the
response,
she
is
able
to
see
the
study
date,
procedure,
modality,
and
accession
number,
for
each
study
returned.
There
is
enough
information
provided
in
the
response
to
obtain
a
thumbnail
via
a
WADO-RS
call,
or
to
launch
a
viewer
using
an
IHE
Radiology
-
Invoke
Image
Display
(IID)
profile
call
using
the
url
elements
found
in
the
ImagingStudy
.
Joe Angina complains of shortness of breath and occasional chest pain to his primary care physician, Dr. Pat Down at Local MultiClinic, who orders a stress echocardiogram; the order is created as a FHIR Task resource to manage the workflow, with a link to a ServiceRequest resource with the details of the request. The order is scheduled and assigned to cardiologist Dr. Art Skann, also at Local MultiClinic.
On the scheduled day of the exam, Joe arrives at the echo lab to meet with Dr. Skann and have the study done. Dr. Skann’s workstation shows the daily list of Task , and he follows the link to retrieve the ServiceRequest . (He may follow the links through the referenced Patient resource to access Joe’s electronic medical record, but that is not the concern of this storyboard.)
The Task and ServiceRequest has been transcoded to a DICOM Modality Worklist Scheduled Procedure Step, and in the echo lab the equipment has downloaded the Modality Worklist. The study is performed, and the acquired images and sonographer’s preliminary measurements are stored in the Local MultiClinic Picture Archiving and Communication System (PACS). The PACS creates an ImagingStudy resource for each study it manages.
Dr.
Skann
interprets
the
study
on
a
PACS
workstation,
and
he
selects
two
key
image
frames
to
be
included
in
the
diagnostic
report;
this
selection
is
stored
back
to
the
PACS
as
a
DICOM
Key
Object
Selection
with
the
title
"For
Report
Attachment",
and
the
PACS
makes
it
available
(transcodes
it)
as
a
FHIR
ImagingStudy
resource.
Dr.
Skann
dictates
the
report
using
a
structured
data
entry
report
writing
program,
including
a
recommendation
for
a
cardiac
catheterization
procedure,
and
signs
it.
The
report
writing
program
formats
the
report
as
a
CDA
document,
retrieves
the
ImagingStudy
resource,
and
inserts
the
referenced
key
images
into
the
report.
Dr. Down meets again with Joe, and they review the results of the stress test. Joe has a question about the findings that the key images in the report do not show, so Dr. Down uses the Local MultiClinic EMR to query the PACS for the full ImagingStudy resource and uses the references there to open an image display for the full study. Joe agrees to proceed to catheterization, and Dr. Down sends a referral to the Ginormous University Hospital cath department and triggers the PACS to share the echo study through the Metropolitan Health Information Exchange.
The
PACS
creates
an
imaging
study
as
an
ImagingStudy
resource,
which
includes
all
the
images
but
excludes
the
sonographer’s
preliminary
measurements
(which
as
a
matter
of
policy
are
not
shared
outside
the
Local
MultiClinic).
The
imaging
study
is
published
to
the
Metro
HIE.
(In
accordance
with
IHE
XDS-I
,
the
images
themselves
are
not
directly
published
to
the
HIE,
but
available
for
on-demand
retrieval
from
the
PACS.)
At Ginormous Hospital, Dr. Cora Plummer receives the cath referral, and looks up the study in the Metro HIE registry. She retrieves the study ImagingStudy , and uses it to access the shared images, which she uses to prepare for the cath procedure.
Depending
on
the
modality
and
procedure
type,
a
DICOM
study
can
range
from
having
one
or
two
instances
instance
(as
in
many
X-ray
procedures)
to
several
thousand
instances
(for
some
CT
exams).
The
number
of
series
within
a
study
has
far
less
variability,
and
is
usually
under
twenty,
although
post-processing,
computer-aided
detection,
and
AI
applications
may
MAY
cause
modest
increases.
An
ImagingStudy
resource
describing
a
large
DICOM
study
would
itself
be
of
significant
size.
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
examine
search
results
before
retrieving
the
full
instances.
If
a
server
limits
the
byte
size
of
search
bundle,
this
may
MAY
impact
the
number
of
ImagingStudy
resources
returned
per
search
result
page;
a
client
can
use
the
_count
query
parameter
to
influence
the
number
of
resources
per
search
result
page.
When
populating
an
ImagingStudy
resource,
storing
an
update
for
each
DICOM
instance
in
the
study
could
result
in
sending
previously
sent
information
repeatedly--an
issue
that
grows
as
the
study
size
increases.
It
might
also
result
in
a
server
maintaining
thousands
of
versions
of
the
resource.
Repeated,
rapid
updates
of
an
ImagingStudy
may
MAY
lead
to
resource
contention.
Although
not
reflected
in
the
ImagingStudy
resource,
the
size
of
an
individual
referenced
instance
may
MAY
be
anywhere
from
a
few
kilobytes
(a
compressed
256x256
pixel
MR
or
640x480
pixel
ultrasound
image)
to
a
gigabyte
or
more
(for
digital
breast
tomography
imaging).
When
retrieving
the
referenced
content
of
an
ImagingStudy,
consider
whether
all
DICOM
instances
are
needed,
whether
DICOM
instances
are
used
concurrently
or
sequentially,
and
what
rendering
or
Transfer
Syntax
is
appropriate
for
the
use
case.
The ImagingStudy resource can be hosted by an image archive application - such as a PACS or Vendor-Neutral Archive - or a more general healthcare informatics application such as an EMR. In some cases it MAY be hosted in both locations.
However, the image archive is typically the source of truth for the content of the ImagingStudy.
Depending on where the ImagingStudy resource is hosted, there are several available mechanisms for keeping the two applications consistent.
In this scenario, the image archive:
The image archive could share ImagingStudy information by:
GET
http://example.org/fhir/ImagingStudy?basedOn=ServiceRequest/123&status=available
In this scenario, the image archive:
while the EMR:
The image archive could share ImagingStudy information by:
In this scenario, the image archive:
while the EMR:
Mechanisms for ensuring consistency between two systems holding representations of the same data are still in development.
As the image archive is the "source of truth", the above methods MAY still be applicable. See Provenance resource.
Typically, an ImagingStudy is a FHIR representation of imaging data that is stored in a DICOM device, such as an image archive (e.g. PACS). The value of the status element reflects the status of this representation and does not necessarily reflect the status of either the underlying imaging data or any ServiceRequest or Task resources that resulted in the ImagingStudy being created.
In
some
cases,
the
ImagingStudy
MAY
be
created
before
any
images
have
been
acquired.
In
this
case,
the
.status
will
have
a
value
of
registered
.
A
registered
ImagingStudy
SHOULD
NOT
be
used
to
load
images.
After
images
have
been
acquired,
the
ImagingStudy
will
have
a
status
of
available
.
At
this
stage
the
ImagingStudy
MAY
be
presented
to
viewing
applications.
If
the
ImagingStudy
is
cancelled
before
images
are
acquired
its
status
SHOULD
be
set
to
cancelled
.
If
the
ImagingStudy
is
incorrect
it
MAY
be
corrected
with
an
update
operation
or
set
to
entered-in-error
and
replaced
with
a
new
ImagingStudy.
Additional
DICOM
images,
key
object
notes,
etc.
MAY
be
created
at
a
later
time
so
a
status
of
complete
is
not
meaningful
for
an
ImagingStudy.
For
this
reason,
this
status
is
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.
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
order
for
the
|
ImagingStudy.basedOn
( Appointment , |
|
| body-site | token | The body site code studied | ImagingStudy.series.bodySite.concept | |
| body-structure | reference | The body structure resource associated with the ImagingStudy | ImagingStudy.series.bodySite.reference | |
| dicom-class |
|
The type of the instance | ImagingStudy.series.instance.sopClass | |
| encounter | reference | The context of the study |
ImagingStudy.encounter
( Encounter ) |
|
| endpoint | reference | The endpoint for the study or series |
ImagingStudy.endpoint
|
ImagingStudy.series.endpoint
( Endpoint ) |
|
| identifier | token | Identifiers for the Study, such as DICOM Study Instance UID | 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 |
ImagingStudy.subject.where(resolve()
is
Patient)
( Patient ) |
|
| performer | reference | The person who performed the study |
ImagingStudy.series.performer.actor
( Practitioner , Organization , CareTeam , Device , Patient , HealthcareService , PractitionerRole , RelatedPerson ) |
|
|
|
token | The reason code for the study | ImagingStudy.reason.concept | |
| reason-reference D | reference | The resource reference describing the reason for the study | ImagingStudy.reason.reference | |
| referrer | reference | The referring physician |
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 | |
| status | token | The status of the study | ImagingStudy.status | |
| subject | reference | Who the study is about |
ImagingStudy.subject
( Group , Device , Patient ) |