This page is part of the FHIR Specification (v1.4.0: STU 3 Ballot 3). 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
Imaging Integration Work Group | Maturity Level: 2 | Compartments: 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.
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 .
This resource is referenced by DiagnosticReport, ImagingExcerpt and ImagingObjectSelection
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ImagingStudy | Σ | DomainResource | A set of images produced in single study (one or more series of references images) | |
uid | Σ | 1..1 | oid | Formal identifier for the study |
accession | Σ | 0..1 | Identifier | Related workflow identifier ("Accession Number") |
identifier | Σ | 0..* | Identifier | Other identifiers for the study |
availability | Σ | 0..1 | code | ONLINE | OFFLINE | NEARLINE | UNAVAILABLE (0008,0056) InstanceAvailability (Required) |
modalityList | Σ | 0..* | Coding | All series modality if actual acquisition modalities Acquisition Modality Codes (Extensible) |
patient | Σ | 1..1 | Reference(Patient) | Who the images are of |
started | Σ | 0..1 | dateTime | When the study was started |
order | Σ | 0..* | Reference(DiagnosticOrder) | Order(s) that caused this study to be performed |
referrer | Σ | 0..1 | Reference(Practitioner) | Referring physician (0008,0090) |
interpreter | Σ | 0..1 | Reference(Practitioner) | Who interpreted images |
url | Σ | 0..1 | uri | Retrieve URI |
numberOfSeries | Σ | 1..1 | unsignedInt | Number of Study Related Series |
numberOfInstances | Σ | 1..1 | unsignedInt | Number of Study Related Instances |
procedure | Σ | 0..* | Reference(Procedure) | Type of procedure performed |
description | Σ | 0..1 | string | Institution-generated description |
series | Σ | 0..* | BackboneElement | Each study has one or more series of instances |
uid | Σ | 1..1 | oid | Formal identifier for this series |
number | Σ | 0..1 | unsignedInt | Numeric identifier of this series |
modality | Σ | 1..1 | Coding | The modality of the instances in the series Acquisition Modality Codes (Extensible) |
description | Σ | 0..1 | string | A short human readable summary of the series |
numberOfInstances | Σ | 1..1 | unsignedInt | Number of Series Related Instances |
availability | Σ | 0..1 | code | ONLINE | OFFLINE | NEARLINE | UNAVAILABLE InstanceAvailability (Required) |
url | Σ | 0..1 | uri | Location of the referenced instance(s) |
bodySite | Σ | 0..1 | Coding | Body part examined SNOMED CT Body Structures (Example) |
laterality | Σ | 0..1 | Coding | Body part laterality Laterality (Example) |
started | Σ | 0..1 | dateTime | When the series started |
instance | Σ | 0..* | BackboneElement | A single SOP instance from the series |
uid | Σ | 1..1 | oid | Formal identifier for this instance |
number | Σ | 0..1 | unsignedInt | The number of this instance in the series |
sopClass | Σ | 1..1 | oid | DICOM class type |
type | Σ | 0..1 | string | Type of instance (image etc.) |
title | Σ | 0..1 | string | Description of instance |
content | Σ | 0..* | Attachment | The instance payload, such as the image binary data or URL to it |
Documentation for this format |
UML Diagram
XML Template
<ImagingStudy xmlns="http://hl7.org/fhir"> <!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <uid value="[oid]"/><!-- 1..1 Formal identifier for the study --> <accession><!-- 0..1 Identifier Related workflow identifier ("Accession Number") --></accession> <identifier><!-- 0..* Identifier Other identifiers for the study --></identifier> <availability value="[code]"/><!-- 0..1 ONLINE | OFFLINE | NEARLINE | UNAVAILABLE (0008,0056) --> <modalityList><!-- 0..* Coding All series modality if actual acquisition modalities --></modalityList> <patient><!-- 1..1 Reference(Patient) Who the images are of --></patient> <started value="[dateTime]"/><!-- 0..1 When the study was started --> <order><!-- 0..* Reference(DiagnosticOrder) Order(s) that caused this study to be performed --></order> <referrer><!-- 0..1 Reference(Practitioner) Referring physician (0008,0090) --></referrer> <interpreter><!-- 0..1 Reference(Practitioner) Who interpreted images --></interpreter> <url value="[uri]"/><!-- 0..1 Retrieve URI --> <numberOfSeries value="[unsignedInt]"/><!-- 1..1 Number of Study Related Series --> <numberOfInstances value="[unsignedInt]"/><!-- 1..1 Number of Study Related Instances --> <procedure><!-- 0..* Reference(Procedure) Type of procedure performed --></procedure> <description value="[string]"/><!-- 0..1 Institution-generated description --> <series> <!-- 0..* Each study has one or more series of instances --> <uid value="[oid]"/><!-- 1..1 Formal identifier for this series --> <number value="[unsignedInt]"/><!-- 0..1 Numeric identifier of this series --> <modality><!-- 1..1 Coding The modality of the instances in the series --></modality> <description value="[string]"/><!-- 0..1 A short human readable summary of the series --> <numberOfInstances value="[unsignedInt]"/><!-- 1..1 Number of Series Related Instances --> <availability value="[code]"/><!-- 0..1 ONLINE | OFFLINE | NEARLINE | UNAVAILABLE --> <url value="[uri]"/><!-- 0..1 Location of the referenced instance(s) --> <bodySite><!-- 0..1 Coding Body part examined --></bodySite> <laterality><!-- 0..1 Coding Body part laterality --></laterality> <started value="[dateTime]"/><!-- 0..1 When the series started --> <instance> <!-- 0..* A single SOP instance from the series --> <uid value="[oid]"/><!-- 1..1 Formal identifier for this instance --> <number value="[unsignedInt]"/><!-- 0..1 The number of this instance in the series --> <sopClass value="[oid]"/><!-- 1..1 DICOM class type --> <type value="[string]"/><!-- 0..1 Type of instance (image etc.) --> <title value="[string]"/><!-- 0..1 Description of instance --> <content><!-- 0..* Attachment The instance payload, such as the image binary data or URL to it --></content> </instance> </series> </ImagingStudy>
JSON Template
{ "resourceType" : "ImagingStudy", // from Resource: id, meta, implicitRules, and language // from DomainResource: text, contained, extension, and modifierExtension "uid" : "<oid>", // R! Formal identifier for the study "accession" : { Identifier }, // Related workflow identifier ("Accession Number") "identifier" : [{ Identifier }], // Other identifiers for the study "availability" : "<code>", // ONLINE | OFFLINE | NEARLINE | UNAVAILABLE (0008,0056) "modalityList" : [{ Coding }], // All series modality if actual acquisition modalities "patient" : { Reference(Patient) }, // R! Who the images are of "started" : "<dateTime>", // When the study was started "order" : [{ Reference(DiagnosticOrder) }], // Order(s) that caused this study to be performed "referrer" : { Reference(Practitioner) }, // Referring physician (0008,0090) "interpreter" : { Reference(Practitioner) }, // Who interpreted images "url" : "<uri>", // Retrieve URI "numberOfSeries" : "<unsignedInt>", // R! Number of Study Related Series "numberOfInstances" : "<unsignedInt>", // R! Number of Study Related Instances "procedure" : [{ Reference(Procedure) }], // Type of procedure performed "description" : "<string>", // Institution-generated description "series" : [{ // Each study has one or more series of instances "uid" : "<oid>", // R! Formal identifier for this series "number" : "<unsignedInt>", // Numeric identifier of this series "modality" : { Coding }, // R! The modality of the instances in the series "description" : "<string>", // A short human readable summary of the series "numberOfInstances" : "<unsignedInt>", // R! Number of Series Related Instances "availability" : "<code>", // ONLINE | OFFLINE | NEARLINE | UNAVAILABLE "url" : "<uri>", // Location of the referenced instance(s) "bodySite" : { Coding }, // Body part examined "laterality" : { Coding }, // Body part laterality "started" : "<dateTime>", // When the series started "instance" : [{ // A single SOP instance from the series "uid" : "<oid>", // R! Formal identifier for this instance "number" : "<unsignedInt>", // The number of this instance in the series "sopClass" : "<oid>", // R! DICOM class type "type" : "<string>", // Type of instance (image etc.) "title" : "<string>", // Description of instance "content" : [{ Attachment }] // The instance payload, such as the image binary data or URL to it }] }] }
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ImagingStudy | Σ | DomainResource | A set of images produced in single study (one or more series of references images) | |
uid | Σ | 1..1 | oid | Formal identifier for the study |
accession | Σ | 0..1 | Identifier | Related workflow identifier ("Accession Number") |
identifier | Σ | 0..* | Identifier | Other identifiers for the study |
availability | Σ | 0..1 | code | ONLINE | OFFLINE | NEARLINE | UNAVAILABLE (0008,0056) InstanceAvailability (Required) |
modalityList | Σ | 0..* | Coding | All series modality if actual acquisition modalities Acquisition Modality Codes (Extensible) |
patient | Σ | 1..1 | Reference(Patient) | Who the images are of |
started | Σ | 0..1 | dateTime | When the study was started |
order | Σ | 0..* | Reference(DiagnosticOrder) | Order(s) that caused this study to be performed |
referrer | Σ | 0..1 | Reference(Practitioner) | Referring physician (0008,0090) |
interpreter | Σ | 0..1 | Reference(Practitioner) | Who interpreted images |
url | Σ | 0..1 | uri | Retrieve URI |
numberOfSeries | Σ | 1..1 | unsignedInt | Number of Study Related Series |
numberOfInstances | Σ | 1..1 | unsignedInt | Number of Study Related Instances |
procedure | Σ | 0..* | Reference(Procedure) | Type of procedure performed |
description | Σ | 0..1 | string | Institution-generated description |
series | Σ | 0..* | BackboneElement | Each study has one or more series of instances |
uid | Σ | 1..1 | oid | Formal identifier for this series |
number | Σ | 0..1 | unsignedInt | Numeric identifier of this series |
modality | Σ | 1..1 | Coding | The modality of the instances in the series Acquisition Modality Codes (Extensible) |
description | Σ | 0..1 | string | A short human readable summary of the series |
numberOfInstances | Σ | 1..1 | unsignedInt | Number of Series Related Instances |
availability | Σ | 0..1 | code | ONLINE | OFFLINE | NEARLINE | UNAVAILABLE InstanceAvailability (Required) |
url | Σ | 0..1 | uri | Location of the referenced instance(s) |
bodySite | Σ | 0..1 | Coding | Body part examined SNOMED CT Body Structures (Example) |
laterality | Σ | 0..1 | Coding | Body part laterality Laterality (Example) |
started | Σ | 0..1 | dateTime | When the series started |
instance | Σ | 0..* | BackboneElement | A single SOP instance from the series |
uid | Σ | 1..1 | oid | Formal identifier for this instance |
number | Σ | 0..1 | unsignedInt | The number of this instance in the series |
sopClass | Σ | 1..1 | oid | DICOM class type |
type | Σ | 0..1 | string | Type of instance (image etc.) |
title | Σ | 0..1 | string | Description of instance |
content | Σ | 0..* | Attachment | The instance payload, such as the image binary data or URL to it |
Documentation for this format |
XML Template
<ImagingStudy xmlns="http://hl7.org/fhir"> <!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <uid value="[oid]"/><!-- 1..1 Formal identifier for the study --> <accession><!-- 0..1 Identifier Related workflow identifier ("Accession Number") --></accession> <identifier><!-- 0..* Identifier Other identifiers for the study --></identifier> <availability value="[code]"/><!-- 0..1 ONLINE | OFFLINE | NEARLINE | UNAVAILABLE (0008,0056) --> <modalityList><!-- 0..* Coding All series modality if actual acquisition modalities --></modalityList> <patient><!-- 1..1 Reference(Patient) Who the images are of --></patient> <started value="[dateTime]"/><!-- 0..1 When the study was started --> <order><!-- 0..* Reference(DiagnosticOrder) Order(s) that caused this study to be performed --></order> <referrer><!-- 0..1 Reference(Practitioner) Referring physician (0008,0090) --></referrer> <interpreter><!-- 0..1 Reference(Practitioner) Who interpreted images --></interpreter> <url value="[uri]"/><!-- 0..1 Retrieve URI --> <numberOfSeries value="[unsignedInt]"/><!-- 1..1 Number of Study Related Series --> <numberOfInstances value="[unsignedInt]"/><!-- 1..1 Number of Study Related Instances --> <procedure><!-- 0..* Reference(Procedure) Type of procedure performed --></procedure> <description value="[string]"/><!-- 0..1 Institution-generated description --> <series> <!-- 0..* Each study has one or more series of instances --> <uid value="[oid]"/><!-- 1..1 Formal identifier for this series --> <number value="[unsignedInt]"/><!-- 0..1 Numeric identifier of this series --> <modality><!-- 1..1 Coding The modality of the instances in the series --></modality> <description value="[string]"/><!-- 0..1 A short human readable summary of the series --> <numberOfInstances value="[unsignedInt]"/><!-- 1..1 Number of Series Related Instances --> <availability value="[code]"/><!-- 0..1 ONLINE | OFFLINE | NEARLINE | UNAVAILABLE --> <url value="[uri]"/><!-- 0..1 Location of the referenced instance(s) --> <bodySite><!-- 0..1 Coding Body part examined --></bodySite> <laterality><!-- 0..1 Coding Body part laterality --></laterality> <started value="[dateTime]"/><!-- 0..1 When the series started --> <instance> <!-- 0..* A single SOP instance from the series --> <uid value="[oid]"/><!-- 1..1 Formal identifier for this instance --> <number value="[unsignedInt]"/><!-- 0..1 The number of this instance in the series --> <sopClass value="[oid]"/><!-- 1..1 DICOM class type --> <type value="[string]"/><!-- 0..1 Type of instance (image etc.) --> <title value="[string]"/><!-- 0..1 Description of instance --> <content><!-- 0..* Attachment The instance payload, such as the image binary data or URL to it --></content> </instance> </series> </ImagingStudy>
JSON Template
{ "resourceType" : "ImagingStudy", // from Resource: id, meta, implicitRules, and language // from DomainResource: text, contained, extension, and modifierExtension "uid" : "<oid>", // R! Formal identifier for the study "accession" : { Identifier }, // Related workflow identifier ("Accession Number") "identifier" : [{ Identifier }], // Other identifiers for the study "availability" : "<code>", // ONLINE | OFFLINE | NEARLINE | UNAVAILABLE (0008,0056) "modalityList" : [{ Coding }], // All series modality if actual acquisition modalities "patient" : { Reference(Patient) }, // R! Who the images are of "started" : "<dateTime>", // When the study was started "order" : [{ Reference(DiagnosticOrder) }], // Order(s) that caused this study to be performed "referrer" : { Reference(Practitioner) }, // Referring physician (0008,0090) "interpreter" : { Reference(Practitioner) }, // Who interpreted images "url" : "<uri>", // Retrieve URI "numberOfSeries" : "<unsignedInt>", // R! Number of Study Related Series "numberOfInstances" : "<unsignedInt>", // R! Number of Study Related Instances "procedure" : [{ Reference(Procedure) }], // Type of procedure performed "description" : "<string>", // Institution-generated description "series" : [{ // Each study has one or more series of instances "uid" : "<oid>", // R! Formal identifier for this series "number" : "<unsignedInt>", // Numeric identifier of this series "modality" : { Coding }, // R! The modality of the instances in the series "description" : "<string>", // A short human readable summary of the series "numberOfInstances" : "<unsignedInt>", // R! Number of Series Related Instances "availability" : "<code>", // ONLINE | OFFLINE | NEARLINE | UNAVAILABLE "url" : "<uri>", // Location of the referenced instance(s) "bodySite" : { Coding }, // Body part examined "laterality" : { Coding }, // Body part laterality "started" : "<dateTime>", // When the series started "instance" : [{ // A single SOP instance from the series "uid" : "<oid>", // R! Formal identifier for this instance "number" : "<unsignedInt>", // The number of this instance in the series "sopClass" : "<oid>", // R! DICOM class type "type" : "<string>", // Type of instance (image etc.) "title" : "<string>", // Description of instance "content" : [{ Attachment }] // The instance payload, such as the image binary data or URL to it }] }] }
Alternate definitions: Schema/Schematron, Resource Profile (XML, JSON), Questionnaire
Path | Definition | Type | Reference |
---|---|---|---|
ImagingStudy.availability ImagingStudy.series.availability | Availability of the resource | Required | InstanceAvailability |
ImagingStudy.modalityList ImagingStudy.series.modality | Type of acquired data in the instance | Extensible | Acquisition Modality Codes |
ImagingStudy.series.bodySite | Codes describing anatomical locations. May include laterality. | Example | SNOMED CT Body Structures |
ImagingStudy.series.laterality | Codes describing body site laterality (left, right, etc.). | Example | Laterality |
Amy, a family physician, would like to see a list of available studies for her patient, Alex. 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 Order resource to manage the workflow, with a link to a DiagnosticOrder 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 Order, and he follows the link to retrieve the DiagnosticOrder. (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 Order and DiagnosticOrder 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 ImagingObjectSelection 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 ImagingObjectSelection 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 a manifest of the study as an ImagingObjectSelection 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 manifest 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 manifest ImagingObjectSelection, and uses it to access the shared images, which she uses to prepare for the cath procedure.
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 identifier for the study | ImagingStudy.accession |
bodysite | token | The body site studied | ImagingStudy.series.bodySite |
dicom-class | uri | The type of the instance | ImagingStudy.series.instance.sopClass |
identifier | token | Other identifiers for the Study | ImagingStudy.identifier |
modality | token | The modality of the series | ImagingStudy.series.modality |
order | reference | The order for the image | ImagingStudy.order (DiagnosticOrder) |
patient | reference | Who the study is about | ImagingStudy.patient (Patient) |
series | uri | The identifier of the series of images | ImagingStudy.series.uid |
started | date | When the study was started | ImagingStudy.started |
study | uri | The study identifier for the image | ImagingStudy.uid |
uid | uri | The instance unique identifier | ImagingStudy.series.instance.uid |