This page is part of the FHIR Specification (v0.4.0: DSTU 2 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2
This resource maintained by the Imaging Integration Work Group
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.
This resource summarizes a series of images or other instances generated as part of an imaging study, and provides references to where the images are available using WADO-RS. This resource is used to make information available concerning images etc. that are referenced in other clinical contexts such as diagnostic reports, Care Plans, etc. Also, see the use case description below.
This resource has been specifically designed with use in DICOM contexts in mind. The content is closely based on the definitions of the equivalent DICOM constructs, and informed by usage patterns already established through DICOM implementation practices, including XDS-I. It is not, however, necessary to use DICOM infrastructure in order to use this resource.
This resource is referenced by DiagnosticReport and Procedure
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ImagingStudy | DomainResource | A set of images produced in single study (one or more series of references images) | ||
started | 0..1 | dateTime | When the study was started (0008,0020)+(0008,0030) | |
patient | 1..1 | Patient | Who the images are of | |
uid | 1..1 | oid | Formal identifier for the study (0020,000D) | |
accession | 0..1 | Identifier | Accession Number (0008,0050) | |
identifier | 0..* | Identifier | Other identifiers for the study (0020,0010) | |
order | 0..* | DiagnosticOrder | Order(s) that caused this study to be performed | |
modalityList | 0..* | code | All series.modality if actual acquisition modalities ImagingModality (Required) | |
referrer | 0..1 | Practitioner | Referring physician (0008,0090) | |
availability | 0..1 | code | ONLINE | OFFLINE | NEARLINE | UNAVAILABLE (0008,0056) InstanceAvailability (Required) | |
url | 0..1 | uri | Retrieve URI (0008,1190) | |
numberOfSeries | 1..1 | integer | Number of Study Related Series (0020,1206) | |
numberOfInstances | 1..1 | integer | Number of Study Related Instances (0020,1208) | |
clinicalInformation | 0..1 | string | Diagnoses etc with request (0040,1002) | |
procedure | 0..* | Coding | Type of procedure performed (0008,1032) | |
interpreter | 0..1 | Practitioner | Who interpreted images (0008,1060) | |
description | 0..1 | string | Institution-generated description (0008,1030) | |
series | 0..* | Element | Each study has one or more series of instances | |
number | 0..1 | integer | Numeric identifier of this series (0020,0011) | |
modality | 1..1 | code | The modality of the instances in the series (0008,0060) Modality (Required) | |
uid | 1..1 | oid | Formal identifier for this series (0020,000E) | |
description | 0..1 | string | A description of the series (0008,103E) | |
numberOfInstances | 1..1 | integer | Number of Series Related Instances (0020,1209) | |
availability | 0..1 | code | ONLINE | OFFLINE | NEARLINE | UNAVAILABLE (0008,0056) InstanceAvailability (Required) | |
url | 0..1 | uri | Retrieve URI (0008,1115 > 0008,1190) | |
bodySite | 0..1 | Coding | Body part examined (Map from 0018,0015) BodySite (Example) | |
dateTime | 0..1 | dateTime | When the series started | |
instance | 0..* | Element | A single instance taken from a patient (image or other) | |
number | 0..1 | integer | The number of this instance in the series (0020,0013) | |
uid | 1..1 | oid | Formal identifier for this instance (0008,0018) | |
sopclass | 1..1 | oid | DICOM class type (0008,0016) | |
type | 0..1 | string | Type of instance (image etc) (0004,1430) | |
title | 0..1 | string | Description (0070,0080 | 0040,A043 > 0008,0104 | 0042,0010 | 0008,0008) | |
url | 0..1 | uri | WADO-RS service where instance is available (0008,1199 > 0008,1190) | |
attachment | 0..1 | Any | Content for this instance |
UML Diagram
XML Template
<ImagingStudy xmlns="http://hl7.org/fhir"> <!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <started value="[dateTime]"/><!-- 0..1 When the study was started (0008,0020)+(0008,0030) --> <patient><!-- 1..1 Reference(Patient) Who the images are of --></patient> <uid value="[oid]"/><!-- 1..1 Formal identifier for the study (0020,000D) --> <accession><!-- 0..1 Identifier Accession Number (0008,0050) --></accession> <identifier><!-- 0..* Identifier Other identifiers for the study (0020,0010) --></identifier> <order><!-- 0..* Reference(DiagnosticOrder) Order(s) that caused this study to be performed --></order> <modalityList value="[code]"/><!-- 0..* All series.modality if actual acquisition modalities --> <referrer><!-- 0..1 Reference(Practitioner) Referring physician (0008,0090) --></referrer> <availability value="[code]"/><!-- 0..1 ONLINE | OFFLINE | NEARLINE | UNAVAILABLE (0008,0056) --> <url value="[uri]"/><!-- 0..1 Retrieve URI (0008,1190) --> <numberOfSeries value="[integer]"/><!-- 1..1 Number of Study Related Series (0020,1206) --> <numberOfInstances value="[integer]"/><!-- 1..1 Number of Study Related Instances (0020,1208) --> <clinicalInformation value="[string]"/><!-- 0..1 Diagnoses etc with request (0040,1002) --> <procedure><!-- 0..* Coding Type of procedure performed (0008,1032) --></procedure> <interpreter><!-- 0..1 Reference(Practitioner) Who interpreted images (0008,1060) --></interpreter> <description value="[string]"/><!-- 0..1 Institution-generated description (0008,1030) --> <series> <!-- 0..* Each study has one or more series of instances --> <number value="[integer]"/><!-- 0..1 Numeric identifier of this series (0020,0011) --> <modality value="[code]"/><!-- 1..1 The modality of the instances in the series (0008,0060) --> <uid value="[oid]"/><!-- 1..1 Formal identifier for this series (0020,000E) --> <description value="[string]"/><!-- 0..1 A description of the series (0008,103E) --> <numberOfInstances value="[integer]"/><!-- 1..1 Number of Series Related Instances (0020,1209) --> <availability value="[code]"/><!-- 0..1 ONLINE | OFFLINE | NEARLINE | UNAVAILABLE (0008,0056) --> <url value="[uri]"/><!-- 0..1 Retrieve URI (0008,1115 > 0008,1190) --> <bodySite><!-- 0..1 Coding Body part examined (Map from 0018,0015) --></bodySite> <dateTime value="[dateTime]"/><!-- 0..1 When the series started --> <instance> <!-- 0..* A single instance taken from a patient (image or other) --> <number value="[integer]"/><!-- 0..1 The number of this instance in the series (0020,0013) --> <uid value="[oid]"/><!-- 1..1 Formal identifier for this instance (0008,0018) --> <sopclass value="[oid]"/><!-- 1..1 DICOM class type (0008,0016) --> <type value="[string]"/><!-- 0..1 Type of instance (image etc) (0004,1430) --> <title value="[string]"/><!-- 0..1 Description (0070,0080 | 0040,A043 > 0008,0104 | 0042,0010 | 0008,0008) --> <url value="[uri]"/><!-- 0..1 WADO-RS service where instance is available (0008,1199 > 0008,1190) --> <attachment><!-- 0..1 Reference(Any) Content for this instance --></attachment> </instance> </series> </ImagingStudy>
JSON Template
{ "resourceType" : "ImagingStudy", // from Resource: id, meta, implicitRules, and language // from DomainResource: text, contained, extension, and modifierExtension "started" : "<dateTime>", // When the study was started (0008,0020)+(0008,0030) "patient" : { Reference(Patient) }, // R! Who the images are of "uid" : "<oid>", // R! Formal identifier for the study (0020,000D) "accession" : { Identifier }, // Accession Number (0008,0050) "identifier" : [{ Identifier }], // Other identifiers for the study (0020,0010) "order" : [{ Reference(DiagnosticOrder) }], // Order(s) that caused this study to be performed "modalityList" : ["<code>"], // All series.modality if actual acquisition modalities "referrer" : { Reference(Practitioner) }, // Referring physician (0008,0090) "availability" : "<code>", // ONLINE | OFFLINE | NEARLINE | UNAVAILABLE (0008,0056) "url" : "<uri>", // Retrieve URI (0008,1190) "numberOfSeries" : <integer>, // R! Number of Study Related Series (0020,1206) "numberOfInstances" : <integer>, // R! Number of Study Related Instances (0020,1208) "clinicalInformation" : "<string>", // Diagnoses etc with request (0040,1002) "procedure" : [{ Coding }], // Type of procedure performed (0008,1032) "interpreter" : { Reference(Practitioner) }, // Who interpreted images (0008,1060) "description" : "<string>", // Institution-generated description (0008,1030) "series" : [{ // Each study has one or more series of instances "number" : <integer>, // Numeric identifier of this series (0020,0011) "modality" : "<code>", // R! The modality of the instances in the series (0008,0060) "uid" : "<oid>", // R! Formal identifier for this series (0020,000E) "description" : "<string>", // A description of the series (0008,103E) "numberOfInstances" : <integer>, // R! Number of Series Related Instances (0020,1209) "availability" : "<code>", // ONLINE | OFFLINE | NEARLINE | UNAVAILABLE (0008,0056) "url" : "<uri>", // Retrieve URI (0008,1115 > 0008,1190) "bodySite" : { Coding }, // Body part examined (Map from 0018,0015) "dateTime" : "<dateTime>", // When the series started "instance" : [{ // A single instance taken from a patient (image or other) "number" : <integer>, // The number of this instance in the series (0020,0013) "uid" : "<oid>", // R! Formal identifier for this instance (0008,0018) "sopclass" : "<oid>", // R! DICOM class type (0008,0016) "type" : "<string>", // Type of instance (image etc) (0004,1430) "title" : "<string>", // Description (0070,0080 | 0040,A043 > 0008,0104 | 0042,0010 | 0008,0008) "url" : "<uri>", // WADO-RS service where instance is available (0008,1199 > 0008,1190) "attachment" : { Reference(Any) } // Content for this instance }] }] }
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ImagingStudy | DomainResource | A set of images produced in single study (one or more series of references images) | ||
started | 0..1 | dateTime | When the study was started (0008,0020)+(0008,0030) | |
patient | 1..1 | Patient | Who the images are of | |
uid | 1..1 | oid | Formal identifier for the study (0020,000D) | |
accession | 0..1 | Identifier | Accession Number (0008,0050) | |
identifier | 0..* | Identifier | Other identifiers for the study (0020,0010) | |
order | 0..* | DiagnosticOrder | Order(s) that caused this study to be performed | |
modalityList | 0..* | code | All series.modality if actual acquisition modalities ImagingModality (Required) | |
referrer | 0..1 | Practitioner | Referring physician (0008,0090) | |
availability | 0..1 | code | ONLINE | OFFLINE | NEARLINE | UNAVAILABLE (0008,0056) InstanceAvailability (Required) | |
url | 0..1 | uri | Retrieve URI (0008,1190) | |
numberOfSeries | 1..1 | integer | Number of Study Related Series (0020,1206) | |
numberOfInstances | 1..1 | integer | Number of Study Related Instances (0020,1208) | |
clinicalInformation | 0..1 | string | Diagnoses etc with request (0040,1002) | |
procedure | 0..* | Coding | Type of procedure performed (0008,1032) | |
interpreter | 0..1 | Practitioner | Who interpreted images (0008,1060) | |
description | 0..1 | string | Institution-generated description (0008,1030) | |
series | 0..* | Element | Each study has one or more series of instances | |
number | 0..1 | integer | Numeric identifier of this series (0020,0011) | |
modality | 1..1 | code | The modality of the instances in the series (0008,0060) Modality (Required) | |
uid | 1..1 | oid | Formal identifier for this series (0020,000E) | |
description | 0..1 | string | A description of the series (0008,103E) | |
numberOfInstances | 1..1 | integer | Number of Series Related Instances (0020,1209) | |
availability | 0..1 | code | ONLINE | OFFLINE | NEARLINE | UNAVAILABLE (0008,0056) InstanceAvailability (Required) | |
url | 0..1 | uri | Retrieve URI (0008,1115 > 0008,1190) | |
bodySite | 0..1 | Coding | Body part examined (Map from 0018,0015) BodySite (Example) | |
dateTime | 0..1 | dateTime | When the series started | |
instance | 0..* | Element | A single instance taken from a patient (image or other) | |
number | 0..1 | integer | The number of this instance in the series (0020,0013) | |
uid | 1..1 | oid | Formal identifier for this instance (0008,0018) | |
sopclass | 1..1 | oid | DICOM class type (0008,0016) | |
type | 0..1 | string | Type of instance (image etc) (0004,1430) | |
title | 0..1 | string | Description (0070,0080 | 0040,A043 > 0008,0104 | 0042,0010 | 0008,0008) | |
url | 0..1 | uri | WADO-RS service where instance is available (0008,1199 > 0008,1190) | |
attachment | 0..1 | Any | Content for this instance |
XML Template
<ImagingStudy xmlns="http://hl7.org/fhir"> <!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <started value="[dateTime]"/><!-- 0..1 When the study was started (0008,0020)+(0008,0030) --> <patient><!-- 1..1 Reference(Patient) Who the images are of --></patient> <uid value="[oid]"/><!-- 1..1 Formal identifier for the study (0020,000D) --> <accession><!-- 0..1 Identifier Accession Number (0008,0050) --></accession> <identifier><!-- 0..* Identifier Other identifiers for the study (0020,0010) --></identifier> <order><!-- 0..* Reference(DiagnosticOrder) Order(s) that caused this study to be performed --></order> <modalityList value="[code]"/><!-- 0..* All series.modality if actual acquisition modalities --> <referrer><!-- 0..1 Reference(Practitioner) Referring physician (0008,0090) --></referrer> <availability value="[code]"/><!-- 0..1 ONLINE | OFFLINE | NEARLINE | UNAVAILABLE (0008,0056) --> <url value="[uri]"/><!-- 0..1 Retrieve URI (0008,1190) --> <numberOfSeries value="[integer]"/><!-- 1..1 Number of Study Related Series (0020,1206) --> <numberOfInstances value="[integer]"/><!-- 1..1 Number of Study Related Instances (0020,1208) --> <clinicalInformation value="[string]"/><!-- 0..1 Diagnoses etc with request (0040,1002) --> <procedure><!-- 0..* Coding Type of procedure performed (0008,1032) --></procedure> <interpreter><!-- 0..1 Reference(Practitioner) Who interpreted images (0008,1060) --></interpreter> <description value="[string]"/><!-- 0..1 Institution-generated description (0008,1030) --> <series> <!-- 0..* Each study has one or more series of instances --> <number value="[integer]"/><!-- 0..1 Numeric identifier of this series (0020,0011) --> <modality value="[code]"/><!-- 1..1 The modality of the instances in the series (0008,0060) --> <uid value="[oid]"/><!-- 1..1 Formal identifier for this series (0020,000E) --> <description value="[string]"/><!-- 0..1 A description of the series (0008,103E) --> <numberOfInstances value="[integer]"/><!-- 1..1 Number of Series Related Instances (0020,1209) --> <availability value="[code]"/><!-- 0..1 ONLINE | OFFLINE | NEARLINE | UNAVAILABLE (0008,0056) --> <url value="[uri]"/><!-- 0..1 Retrieve URI (0008,1115 > 0008,1190) --> <bodySite><!-- 0..1 Coding Body part examined (Map from 0018,0015) --></bodySite> <dateTime value="[dateTime]"/><!-- 0..1 When the series started --> <instance> <!-- 0..* A single instance taken from a patient (image or other) --> <number value="[integer]"/><!-- 0..1 The number of this instance in the series (0020,0013) --> <uid value="[oid]"/><!-- 1..1 Formal identifier for this instance (0008,0018) --> <sopclass value="[oid]"/><!-- 1..1 DICOM class type (0008,0016) --> <type value="[string]"/><!-- 0..1 Type of instance (image etc) (0004,1430) --> <title value="[string]"/><!-- 0..1 Description (0070,0080 | 0040,A043 > 0008,0104 | 0042,0010 | 0008,0008) --> <url value="[uri]"/><!-- 0..1 WADO-RS service where instance is available (0008,1199 > 0008,1190) --> <attachment><!-- 0..1 Reference(Any) Content for this instance --></attachment> </instance> </series> </ImagingStudy>
JSON Template
{ "resourceType" : "ImagingStudy", // from Resource: id, meta, implicitRules, and language // from DomainResource: text, contained, extension, and modifierExtension "started" : "<dateTime>", // When the study was started (0008,0020)+(0008,0030) "patient" : { Reference(Patient) }, // R! Who the images are of "uid" : "<oid>", // R! Formal identifier for the study (0020,000D) "accession" : { Identifier }, // Accession Number (0008,0050) "identifier" : [{ Identifier }], // Other identifiers for the study (0020,0010) "order" : [{ Reference(DiagnosticOrder) }], // Order(s) that caused this study to be performed "modalityList" : ["<code>"], // All series.modality if actual acquisition modalities "referrer" : { Reference(Practitioner) }, // Referring physician (0008,0090) "availability" : "<code>", // ONLINE | OFFLINE | NEARLINE | UNAVAILABLE (0008,0056) "url" : "<uri>", // Retrieve URI (0008,1190) "numberOfSeries" : <integer>, // R! Number of Study Related Series (0020,1206) "numberOfInstances" : <integer>, // R! Number of Study Related Instances (0020,1208) "clinicalInformation" : "<string>", // Diagnoses etc with request (0040,1002) "procedure" : [{ Coding }], // Type of procedure performed (0008,1032) "interpreter" : { Reference(Practitioner) }, // Who interpreted images (0008,1060) "description" : "<string>", // Institution-generated description (0008,1030) "series" : [{ // Each study has one or more series of instances "number" : <integer>, // Numeric identifier of this series (0020,0011) "modality" : "<code>", // R! The modality of the instances in the series (0008,0060) "uid" : "<oid>", // R! Formal identifier for this series (0020,000E) "description" : "<string>", // A description of the series (0008,103E) "numberOfInstances" : <integer>, // R! Number of Series Related Instances (0020,1209) "availability" : "<code>", // ONLINE | OFFLINE | NEARLINE | UNAVAILABLE (0008,0056) "url" : "<uri>", // Retrieve URI (0008,1115 > 0008,1190) "bodySite" : { Coding }, // Body part examined (Map from 0018,0015) "dateTime" : "<dateTime>", // When the series started "instance" : [{ // A single instance taken from a patient (image or other) "number" : <integer>, // The number of this instance in the series (0020,0013) "uid" : "<oid>", // R! Formal identifier for this instance (0008,0018) "sopclass" : "<oid>", // R! DICOM class type (0008,0016) "type" : "<string>", // Type of instance (image etc) (0004,1430) "title" : "<string>", // Description (0070,0080 | 0040,A043 > 0008,0104 | 0042,0010 | 0008,0008) "url" : "<uri>", // WADO-RS service where instance is available (0008,1199 > 0008,1190) "attachment" : { Reference(Any) } // Content for this instance }] }] }
Alternate definitions: Schema/Schematron, Resource Profile (XML, JSON), Questionnaire
Path | Definition | Type | Reference |
---|---|---|---|
ImagingStudy.modalityList | Type of acquired image data in the instance | Fixed | http://hl7.org/fhir/imaging-modality |
ImagingStudy.availability ImagingStudy.series.availability | Availability of the resource | Fixed | http://hl7.org/fhir/instance-availability |
ImagingStudy.series.modality | Type of data in the instance | Fixed | http://hl7.org/fhir/modality |
ImagingStudy.series.bodySite | Codes describing anatomical locations. May include laterality | Example | http://hl7.org/fhir/vs/body-site |
The following storyboard illustrates the primary use case for this resource:
An oncologist, Karen, is seeing patients in her clinic, and would like background on the patients she is seeing today. Her first patient of the day, Alex. has arrived. She launches her Electronic Medical Record (EMR) software, and makes a Patient query on Alex using his last name. The EMR software makes a FHIR query on the Patient resource, to provide background demographic information for cover page rendering. The EMR software makes a subsequent FHIR query on the Condition resource, and reports that Alex is suspected to have prostate cancer. With this information, Karen decides to check for two further tests - the results of a Prostate-Specific Antigen (PSA) laboratory test, and of a CT exam performed at the local diagnostic facility. First, a FHIR query is made against the Observation resource to query for the most recent value of PSA (the EMR also queries previous values of PSA for trending). For the CT exam, the EMR software queries on the ImagingStudy resource to retrieve a list of available images with other relevant constraints (such as modality, body region etc.). This returns back the studies available, with relevant meta-data about each study, its series and images. This information will help Karen to select which study would like to review. Using the WADO-RS references provided, the artifacts Karen would like to review can be downloaded and viewed using capable DICOM viewing software.
Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.
Name | Type | Description | Paths |
accession | token | The accession id for the image | ImagingStudy.accession |
bodysite | token | Body part examined (Map from 0018,0015) | ImagingStudy.series.bodySite |
dicom-class | token | DICOM class type (0008,0016) | ImagingStudy.series.instance.sopclass |
modality | token | The modality of the image | ImagingStudy.series.modality |
patient | reference | Who the study is about | ImagingStudy.patient (Patient) |
series | token | The series id for the image | ImagingStudy.series.uid |
size | number | The size of the image in MB - may include > or < in the value | |
started | date | When the study was started | ImagingStudy.started |
study | token | The study id for the image | ImagingStudy.uid |
uid | token | Formal identifier for this instance (0008,0018) | ImagingStudy.series.instance.uid |