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 |
Detailed Descriptions for the elements in the ImagingStudy resource.
| ImagingStudy | |
| Element Id | ImagingStudy |
| Definition |
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
|
| Short Display |
A
set
of
images
or
image-related
data
produced
in
single
study
|
| Cardinality | 0..* |
| Type | DomainResource |
| Summary | false |
| ImagingStudy.identifier | |
| Element Id | ImagingStudy.identifier |
| Definition |
|
| Short Display |
|
| Note | This is a business identifier, not a resource identifier (see discussion ) |
| Cardinality | 0..* |
| Type | Identifier |
| Requirements |
|
| Alternate Names | StudyInstanceUID |
| Summary | true |
| Comments |
Note: This is a business identifier, not a resource identifier (see discussion ). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number, or an accession number may be used to relate a Task, an ImagingStudy and a DiagnosticReport. See discussion under Imaging Study Implementation Notes for encoding of DICOM Study Instance UID. |
| ImagingStudy.status | |
| Element Id | ImagingStudy.status |
| Definition |
The
current
state
of
the
|
| Short Display | registered | available | cancelled | entered-in-error | unknown | inactive |
| Cardinality | 1..1 |
| Terminology Binding | Imaging Study Status ( Required ) |
| Type | code |
| Is Modifier |
true
(Reason:
This
element
is
labeled
as
a
modifier
because
it
is
a
status
element
that
contains
status
entered-in-error
which
means
that
the
resource
|
| Summary | true |
| Comments |
Unknown does not represent "other" - one of the defined statuses must apply. Unknown is used when the authoring system is not sure what the current status is. |
| ImagingStudy.modality | |
| Element Id | ImagingStudy.modality |
| Definition |
|
| Short Display |
|
| Cardinality | 0..* |
| Terminology Binding |
Modality
(
Extensible
)
|
| Type | CodeableConcept |
| Alternate Names | ModalitiesInStudy |
| Summary | true |
| ImagingStudy.subject | |
| Element Id | ImagingStudy.subject |
| Definition |
The subject, typically a patient, of the imaging study. |
| Short Display | Who or what is the subject of the study |
| Cardinality | 1..1 |
| Type | Reference ( Patient | Device | Group ) |
| Summary | true |
| Comments |
QA phantoms can be recorded with a Device; multiple subjects (such as mice) can be recorded with a Group. |
| ImagingStudy.encounter | |
| Element Id | ImagingStudy.encounter |
| Definition |
The healthcare event (e.g. a patient and healthcare provider interaction) during which this ImagingStudy is made. |
| Short Display | Encounter with which this imaging study is associated |
| Cardinality | 0..1 |
| Type | Reference ( Encounter ) |
| Summary | true |
| Comments |
This
will
typically
be
the
encounter
the
event
occurred
within,
but
some
events
|
| ImagingStudy.started | |
| Element Id | ImagingStudy.started |
| Definition |
Date and time the study started. |
| Short Display | When the study was started |
| Cardinality | 0..1 |
| Type | dateTime |
| Alternate Names | StudyDate; StudyTime |
| Summary | true |
| ImagingStudy.basedOn | |
| Element Id | ImagingStudy.basedOn |
| Definition |
A
|
| Short Display |
|
| Cardinality | 0..* |
| Type |
Reference
(
CarePlan
|
ServiceRequest
|
Appointment
|
|
| Requirements |
|
| Alternate Names | AccessionNumber |
| Summary | true |
| Comments | One imaging study MAY support multiple ordered procedures, e.g. chest/abdomen/pelvis CT orders being fulfilled by a single imaging study. |
| ImagingStudy.partOf | |
| Element Id | ImagingStudy.partOf |
| Definition |
A larger event of which this particular ImagingStudy is a component or step. For example, an ImagingStudy as part of a procedure. |
| Short Display | Part of referenced event |
| Cardinality | 0..* |
| Type | Reference ( Procedure ) |
| Summary | true |
| Comments |
To
link
an
ImagingStudy
to
an
Encounter
use
|
| ImagingStudy.referrer | |
| Element Id | ImagingStudy.referrer |
| Definition |
The
|
| Short Display | Referring physician |
| Cardinality | 0..1 |
| Type | Reference ( Practitioner | PractitionerRole ) |
| Alternate Names | ReferringPhysiciansName |
| Summary | true |
| ImagingStudy.endpoint | |
| Element Id | ImagingStudy.endpoint |
| Definition |
The network service providing access (e.g., query, view, or retrieval) for the study. See implementation notes for information about using DICOM endpoints. A study-level endpoint applies to each series in the study, unless overridden by a series-level endpoint with the same Endpoint.connectionType. |
| Short Display | Study access endpoint |
| Cardinality | 0..* |
| Type | Reference ( Endpoint ) |
| Requirements |
Access
methods
for
viewing
(e.g.,
|
| Summary | true |
| Comments |
Typical endpoint types include DICOM WADO-RS, which is used to retrieve DICOM instances in native or rendered (e.g., JPG, PNG), formats using a RESTful API; DICOM WADO-URI, which can similarly retrieve native or rendered instances, except using an HTTP query-based approach; DICOM QIDO-RS, which allows RESTful query for DICOM information without retrieving the actual instances; or IHE Invoke Image Display (IID), which provides standard invocation of an imaging web viewer. See Imaging Study Implementation Notes on Endpoints . |
|
|
|
| Element Id |
|
| Definition |
|
| Short Display |
|
| Cardinality |
|
|
|
:
|
| Type |
|
| Summary | true |
|
|
|
| Element Id |
|
| Definition |
|
| Short Display |
|
| Cardinality | 0..1 |
| Type |
|
| Requirements |
Ties the event to where the records are likely kept and provides context around the event occurrence (e.g. if it occurred inside or outside a dedicated healthcare setting). |
| Summary | true |
|
|
|
| Element Id |
|
| Definition |
|
| Short Display |
|
| Cardinality | 0..* |
| Terminology Binding |
|
| Type |
CodeableReference
(
|
| Summary | true |
|
|
|
| Element Id |
|
| Definition |
|
| Short Display |
|
| Cardinality |
|
| Type |
|
| Summary | true |
|
|
|
| Element Id |
|
| Definition |
Description
or
classification
of
|
| Short Display |
|
| Cardinality |
|
|
|
|
| Alternate Names |
|
| Summary | true |
|
|
|
| Element Id |
|
| Definition |
|
| Short Display |
|
| Cardinality |
|
| Type |
|
| Alternate Names | NumberOfStudyRelatedSeries |
| Summary | true |
|
|
|
| Element Id |
|
| Definition |
|
| Short Display |
|
| Cardinality | 0..1 |
| Type |
|
| Alternate Names |
|
| Summary | true |
| ImagingStudy.series | |
| Element Id | ImagingStudy.series |
| Definition |
The
set
of
Series
belonging
to
the
study.
Each
|
| Short Display |
|
| Cardinality | 0..* |
| Summary | true |
| ImagingStudy.series.uid | |
| Element Id | ImagingStudy.series.uid |
| Definition |
The
DICOM
Series
Instance
UID
|
| Short Display |
DICOM
Series
Instance
UID
|
| Cardinality | 1..1 |
| Type | id |
| Requirements |
DICOM Series Instance UID. |
| Alternate Names | SeriesInstanceUID |
| Summary | true |
| Comments |
See
DICOM
PS3.3
C.7.3
|
| ImagingStudy.series.number | |
| Element Id | ImagingStudy.series.number |
| Definition |
The numeric identifier of this series in the study. |
| Short Display | Numeric identifier of this series |
| Cardinality | 0..1 |
| Type | unsignedInt |
| Alternate Names | SeriesNumber |
| Summary | true |
| ImagingStudy.series.modality | |
| Element Id | ImagingStudy.series.modality |
| Definition |
The
distinct
modality
for
this
series.
This
|
| Short Display | The modality used for this series |
| Cardinality | 1..1 |
| Terminology Binding |
Modality
(
Extensible
)
|
| Type | CodeableConcept |
| Alternate Names | Modality |
| Summary | true |
| ImagingStudy.series.description | |
| Element Id | ImagingStudy.series.description |
| Definition |
|
| Short Display |
|
| Cardinality | 0..1 |
| Type | string |
| Alternate Names | SeriesDescription |
| Summary | true |
| ImagingStudy.series.numberOfInstances | |
| Element Id | ImagingStudy.series.numberOfInstances |
| Definition |
Number
of
SOP
Instances
in
the
Study.
The
value
given
|
| Short Display | Number of Series Related Instances |
| Cardinality | 0..1 |
| Type | unsignedInt |
| Alternate Names | NumberOfSeriesRelatedInstances |
| Summary | true |
| ImagingStudy.series.endpoint | |
| Element Id | ImagingStudy.series.endpoint |
| Definition |
The
network
service
providing
access
|
| Short Display | Series access endpoint |
| Cardinality | 0..* |
| Type | Reference ( Endpoint ) |
|
|
true |
| ImagingStudy.series.bodySite | |
| Element Id | ImagingStudy.series.bodySite |
| Definition |
The
anatomic
structures
examined.
See
DICOM
Part
16
Annex
L
|
| Short Display | Body part examined |
| Cardinality | 0..1 |
| Terminology Binding | SNOMED CT Body Structures ( Example ) |
| Type | CodeableReference ( BodyStructure ) |
| Alternate Names | BodyPartExamined |
| Summary | true |
| ImagingStudy.series.laterality | |
| Element Id | ImagingStudy.series.laterality |
| Definition |
The
laterality
of
the
(possibly
paired)
anatomic
structures
examined.
E.g.,
the
left
knee,
both
lungs,
or
unpaired
abdomen.
If
present,
|
| Short Display | Body part laterality |
| Cardinality | 0..1 |
| Terminology Binding |
Laterality
(
Example
)
|
| Type | CodeableConcept |
| Summary | true |
| ImagingStudy.series.specimen | |
| Element Id | ImagingStudy.series.specimen |
| Definition |
The specimen imaged, e.g., for whole slide imaging of a biopsy. |
| Short Display | Specimen imaged |
| Cardinality | 0..* |
| Type | Reference ( Specimen ) |
| Summary | true |
| ImagingStudy.series.started | |
| Element Id | ImagingStudy.series.started |
| Definition |
The date and time the series was started. |
| Short Display | When the series started |
| Cardinality | 0..1 |
| Type | dateTime |
| Summary | true |
| ImagingStudy.series.performer | |
| Element Id | ImagingStudy.series.performer |
| Definition |
Indicates who or what performed the series and how they were involved. |
| Short Display | Who performed the series |
| Cardinality | 0..* |
| Requirements |
The
performer
is
recorded
at
the
series
level,
since
each
series
in
a
study
|
| Alternate Names | PerformingPhysicianName; OperatorName |
| Summary | true |
| Comments |
If
the
person
who
performed
the
series
is
not
known,
their
Organization
|
| ImagingStudy.series.performer.function | |
| Element Id | ImagingStudy.series.performer.function |
| Definition |
Distinguishes the type of involvement of the performer in the series. |
| Short Display | Type of performance |
| Cardinality | 0..1 |
| Terminology Binding | ImagingStudy series performer function ( Extensible ) |
| Type | CodeableConcept |
| Requirements |
Allows disambiguation of the types of involvement of different performers. |
| Summary | true |
| ImagingStudy.series.performer.actor | |
| Element Id | ImagingStudy.series.performer.actor |
| Definition |
Indicates who or what performed the series. |
| Short Display | Who performed the series |
| Cardinality | 1..1 |
| Type | Reference ( Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson | HealthcareService ) |
| Summary | true |
| ImagingStudy.series.instance | |
| Element Id | ImagingStudy.series.instance |
| Definition |
A single SOP instance within the series, e.g. an image, or presentation state. |
| Short Display | A single SOP instance from the series |
| Cardinality | 0..* |
| Summary | false |
| ImagingStudy.series.instance.uid | |
| Element Id | ImagingStudy.series.instance.uid |
| Definition |
The DICOM SOP Instance UID for this image or other DICOM content. |
| Short Display | DICOM SOP Instance UID |
| Cardinality | 1..1 |
| Type | id |
| Requirements |
DICOM SOP Instance UID. |
| Alternate Names | SOPInstanceUID |
| Summary | false |
| Comments |
See
DICOM
PS3.3
C.12.1
|
| ImagingStudy.series.instance.sopClass | |
| Element Id | ImagingStudy.series.instance.sopClass |
| Definition |
DICOM instance type. |
| Short Display | DICOM class type |
| Cardinality | 1..1 |
|
|
|
| Alternate Names | SOPClassUID |
| Summary | false |
| ImagingStudy.series.instance.number | |
| Element Id | ImagingStudy.series.instance.number |
| Definition |
The number of instance in the series. |
| Short Display | The number of this instance in the series |
| Cardinality | 0..1 |
| Type | unsignedInt |
| Alternate Names | InstanceNumber |
| Summary | false |
| ImagingStudy.series.instance.title | |
| Element Id | ImagingStudy.series.instance.title |
| Definition |
The description of the instance. |
| Short Display | Description of instance |
| Cardinality | 0..1 |
| Type | string |
| Summary | false |
| Comments |
Particularly for post-acquisition analytic objects, such as SR, presentation states, value mapping, etc. |