DSTU2 STU 3 Candidate
This page is part of the FHIR Specification (v1.0.2: DSTU 2). The current version which supercedes this version is

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 . For a full list of available versions, see the Directory of published versions . Page versions: . Page versions: R5 R4B R4 R3 R2

4.23 4.34 Resource ImagingStudy - Content Resource ImagingStudy - Content

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.
Imaging Integration Imaging Integration Work Group Work Group Maturity Level : 2 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.

4.23.1 Scope and Usage 4.34.1 Scope and Usage 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

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 .

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 .

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 .

This resource is referenced by DiagnosticReport and , ImagingExcerpt and ImagingObjectSelection

4.23.2 Resource Content 4.34.2 Resource Content

Structure

Name Flags Card. Type Description & Constraints Description & Constraints doco
. . ImagingStudy Σ DomainResource A set of images produced in single study (one or more series of references images) A set of images produced in single study (one or more series of references images)
. . started . uid Σ 0..1 1..1 dateTime oid When the study was started Formal identifier for the study
. . patient . accession Σ 1..1 0..1 Reference ( Patient Identifier ) Who the images are of Related workflow identifier ("Accession Number")
. . uid . identifier Σ 1..1 0..* oid Identifier Formal identifier for the study Other identifiers for the study
. . accession . availability Σ 0..1 Identifier code Related workflow identifier ("Accession Number") ONLINE | OFFLINE | NEARLINE | UNAVAILABLE (0008,0056)
InstanceAvailability ( Required )
. . identifier . modalityList Σ 0..* Identifier Coding Other identifiers for the study All series modality if actual acquisition modalities
Acquisition Modality Codes ( Extensible )
. . order . patient Σ 0..* 1..1 Reference ( DiagnosticOrder Patient ) Order(s) that caused this study to be performed Who the images are of
. . modalityList . started Σ 0..* 0..1 Coding dateTime All series modality if actual acquisition modalities Acquisition Modality Codes ( Extensible ) When the study was started
. . referrer . order Σ 0..1 0..* Reference ( Practitioner DiagnosticOrder ) Referring physician (0008,0090) Order(s) that caused this study to be performed
. . availability . referrer Σ 0..1 code ONLINE | OFFLINE | NEARLINE | UNAVAILABLE (0008,0056) InstanceAvailability Reference ( Required Practitioner ) Referring physician (0008,0090)
. . url . interpreter Σ 0..1 uri Reference ( Practitioner ) Retrieve URI Who interpreted images
. . numberOfSeries . url Σ 1..1 0..1 unsignedInt uri Number of Study Related Series Retrieve URI
. . numberOfInstances . numberOfSeries Σ 1..1 unsignedInt Number of Study Related Instances Number of Study Related Series
. . procedure . numberOfInstances Σ 0..* 1..1 Reference ( Procedure unsignedInt ) Type of procedure performed Number of Study Related Instances
. . interpreter . procedure Σ 0..1 0..* Reference ( Practitioner Procedure ) Who interpreted images Type of procedure performed
. . . description Σ 0..1 string Institution-generated description Institution-generated description
. . . series Σ 0..* BackboneElement Each study has one or more series of instances Each study has one or more series of instances
. . . number . uid Σ 0..1 1..1 unsignedInt oid Numeric identifier of this series Formal identifier for this series
. . . modality . number Σ 1..1 0..1 Coding unsignedInt The modality of the instances in the series Acquisition Modality Codes ( Extensible ) Numeric identifier of this series
. . . uid . modality Σ 1..1 oid Coding Formal identifier for this series The modality of the instances in the series
Acquisition Modality Codes ( Extensible )
. . . . description Σ 0..1 string A description of the series A short human readable summary of the series
. . . . numberOfInstances Σ 1..1 unsignedInt Number of Series Related Instances Number of Series Related Instances
. . . . availability Σ 0..1 code ONLINE | OFFLINE | NEARLINE | UNAVAILABLE ONLINE | OFFLINE | NEARLINE | UNAVAILABLE
InstanceAvailability ( ( Required )
. . . . url Σ 0..1 uri Location of the referenced instance(s) Location of the referenced instance(s)
. . . . bodySite Σ 0..1 Coding Body part examined Body part examined
SNOMED CT Body Structures ( SNOMED CT Body Structures ( Example )
. . . . laterality Σ 0..1 Coding Body part laterality Body part laterality
Laterality ( ( Example )
. . . . started Σ 0..1 dateTime When the series started When the series started
. . . . instance Σ 0..* BackboneElement A single SOP instance from the series A single SOP instance from the series
. . . . number . uid Σ 0..1 1..1 unsignedInt oid The number of this instance in the series Formal identifier for this instance
. . . . uid . number Σ 1..1 0..1 oid unsignedInt Formal identifier for this instance The number of this instance in the series
. . . . . sopClass Σ 1..1 oid DICOM class type DICOM class type
. . . . . type Σ 0..1 string Type of instance (image etc.) Type of instance (image etc.)
. . . . . title Σ 0..1 string Description of instance Description of instance
. . . . . content Σ 0..* Attachment Content of the instance The instance payload, such as the image binary data or URL to it

Documentation for this format doco Documentation for this format

UML Diagram UML Diagram

ImagingStudy ( ( DomainResource ) Date and Time the study started Formal identifier for the study started : dateTime [0..1] uid : oid [1..1] The patient imaged in the study Accession Number is an identifier related to some aspect of imaging workflow and data management. Usage may vary across different institutions. See for instance [IHE Radiology Technical Framework Volume 1 Appendix A](http://www.ihe.net/uploadedFiles/Documents/Radiology/IHE_RAD_TF_Rev13.0_Vol1_FT_2014-07-30.pdf) patient : Reference [1..1] « Patient » accession : Identifier [0..1] Formal identifier for the study Other identifiers for the study uid : oid [1..1] identifier : Identifier [0..*] Accession Number is an identifier related to some aspect of imaging workflow and data management. Usage may vary across different institutions. See for instance [IHE Radiology Technical Framework Volume 1 Appendix A](http://www.ihe.net/uploadedFiles/Documents/Radiology/IHE_RAD_TF_Rev13.0_Vol1_FT_2014-07-30.pdf) Availability of study (online, offline or nearline) accession : Identifier [0..1] availability : code [0..1] « Availability of the resource (Strength=Required) InstanceAvailability ! » Other identifiers for the study A list of all the Series.ImageModality values that are actual acquisition modalities, i.e. those in the DICOM Context Group 29 (value set OID 1.2.840.10008.6.1.19) identifier : Identifier [0..*] modalityList : Coding [0..*] « Type of acquired data in the instance (Strength=Extensible) Acquisition Modality + » A list of the diagnostic orders that resulted in this imaging study being performed The patient imaged in the study order : patient : Reference [0..*] « DiagnosticOrder » [1..1] « Patient » A list of all the Series.ImageModality values that are actual acquisition modalities, i.e. those in the DICOM Context Group 29 (value set OID 1.2.840.10008.6.1.19) Date and Time the study started modalityList : Coding [0..*] « started : dateTime [0..1] Type of acquired data in the instance (Strength=Extensible) A list of the diagnostic orders that resulted in this imaging study being performed Acquisition Modality + » order : Reference [0..*] « DiagnosticOrder » The requesting/referring physician The requesting/referring physician referrer : : Reference [0..1] « [0..1] « Practitioner » » Availability of study (online, offline or nearline) availability : code [0..1] « Availability of the resource (Strength=Required) Who read the study and interpreted the images or other content InstanceAvailability ! » interpreter : Reference [0..1] « Practitioner » WADO-RS resource where Study is available WADO-RS resource where Study is available url : : uri [0..1] [0..1] Number of Series in Study Number of Series in Study numberOfSeries : : unsignedInt [1..1] [1..1] Number of SOP Instances in Study Number of SOP Instances in Study numberOfInstances : : unsignedInt [1..1] [1..1] Type of procedure performed Type of procedure performed procedure : : Reference [0..*] « [0..*] « Procedure » Who read the study and interpreted the images or other content interpreter : Reference [0..1] « Practitioner » » Institution-generated description or classification of the Study performed Institution-generated description or classification of the Study performed description : : string [0..1] [0..1] Series Formal identifier for this series uid : oid [1..1] The Numeric identifier of this series in the study The Numeric identifier of this series in the study number : : unsignedInt [0..1] [0..1] The modality of this series sequence The modality of this series sequence modality : : Coding [1..1] « Type of acquired data in the instance (Strength=Extensible) Acquisition Modality + » [1..1] « Formal identifier for this series Type of acquired data in the instance (Strength=Extensible) uid : oid [1..1] Acquisition Modality + » A description of the series A description of the series description : : string [0..1] [0..1] Number of SOP Instances in Series Number of SOP Instances in Series numberOfInstances : : unsignedInt [1..1] [1..1] Availability of series (online, offline or nearline) Availability of series (online, offline or nearline) availability : : code [0..1] « [0..1] « Availability of the resource (Strength=Required) Availability of the resource (Strength=Required) InstanceAvailability ! » ! » URI/URL specifying the location of the referenced series using WADO-RS URI/URL specifying the location of the referenced series using WADO-RS url : : uri [0..1] [0..1] Body part examined. See DICOM Part 16 Annex L for the mapping from DICOM to Snomed CT Body part examined. See DICOM Part 16 Annex L for the mapping from DICOM to Snomed CT bodySite : : Coding [0..1] « [0..1] « Codes describing anatomical locations. May include laterality. (Strength=Example) Codes describing anatomical locations. May include laterality. (Strength=Example) SNOMED CT Body Structures SNOMED CT Body Structures ?? » ?? » Laterality if body site is paired anatomic structure and laterality is not pre-coordinated in body site code Laterality if body site is paired anatomic structure and laterality is not pre-coordinated in body site code laterality : : Coding [0..1] « [0..1] « Codes describing body site laterality (left, right, etc.). (Strength=Example) Codes describing body site laterality (left, right, etc.). (Strength=Example) Laterality ?? » ?? » The date and time the series was started The date and time the series was started started : : dateTime [0..1] [0..1] Instance The number of instance in the series Formal identifier for this image or other content number : unsignedInt [0..1] uid : oid [1..1] Formal identifier for this image or other content The number of instance in the series uid : oid [1..1] number : unsignedInt [0..1] DICOM instance type DICOM instance type sopClass : : oid [1..1] [1..1] A human-friendly SOP Class name A human-friendly SOP Class name type : : string [0..1] [0..1] The description of the instance The description of the instance title : : string [0..1] [0..1] Content of the instance or a rendering thereof (e.g. a JPEG of an image, or an XML of a structured report). May be represented for example by inline encoding; by a URL reference to a WADO-RS service that makes the instance available; or to a FHIR Resource (e.g. Media, Document, etc.). Multiple content attachments may be used for alternate representations of the instance Content of the instance or a rendering thereof (e.g. a JPEG of an image, or an XML of a structured report). May be represented for example by inline encoding; by a URL reference to a WADO-RS service that makes the instance available; or to a FHIR Resource (e.g. Media, Document, etc.). Multiple content attachments may be used for alternate representations of the instance content : : Attachment [0..*] [0..*] A single SOP Instance within the series, e.g. an image, or presentation state A single SOP Instance within the series, e.g. an image, or presentation state instance [0..*] Each study has one or more series of images or other content Each study has one or more series of images or other content series [0..*]

XML Template XML Template

<ImagingStudy xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <
 <</patient>

 <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>
 <</order>

 <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>
 <</interpreter>

 <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>

   <content><!-- 0..* Attachment The instance payload, such as the image binary data or URL to it --></content>

  </instance>
 </series>
</ImagingStudy>

JSON Template JSON Template

{doco
  "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 Description & Constraints doco
. . ImagingStudy Σ DomainResource A set of images produced in single study (one or more series of references images) A set of images produced in single study (one or more series of references images)
. . started . uid Σ 0..1 1..1 dateTime oid When the study was started Formal identifier for the study
. . patient . accession Σ 1..1 0..1 Reference ( Patient Identifier ) Who the images are of Related workflow identifier ("Accession Number")
. . uid . identifier Σ 1..1 0..* oid Identifier Formal identifier for the study Other identifiers for the study
. . accession . availability Σ 0..1 Identifier code Related workflow identifier ("Accession Number") ONLINE | OFFLINE | NEARLINE | UNAVAILABLE (0008,0056)
InstanceAvailability ( Required )
. . identifier . modalityList Σ 0..* Identifier Coding Other identifiers for the study All series modality if actual acquisition modalities
Acquisition Modality Codes ( Extensible )
. . order . patient Σ 0..* 1..1 Reference ( DiagnosticOrder Patient ) Order(s) that caused this study to be performed Who the images are of
. . modalityList . started Σ 0..* 0..1 Coding dateTime All series modality if actual acquisition modalities Acquisition Modality Codes ( Extensible ) When the study was started
. . referrer . order Σ 0..1 0..* Reference ( Practitioner DiagnosticOrder ) Referring physician (0008,0090) Order(s) that caused this study to be performed
. . availability . referrer Σ 0..1 code ONLINE | OFFLINE | NEARLINE | UNAVAILABLE (0008,0056) InstanceAvailability Reference ( Required Practitioner ) Referring physician (0008,0090)
. . url . interpreter Σ 0..1 uri Reference ( Practitioner ) Retrieve URI Who interpreted images
. . numberOfSeries . url Σ 1..1 0..1 unsignedInt uri Number of Study Related Series Retrieve URI
. . numberOfInstances . numberOfSeries Σ 1..1 unsignedInt Number of Study Related Instances Number of Study Related Series
. . procedure . numberOfInstances Σ 0..* 1..1 Reference ( Procedure unsignedInt ) Type of procedure performed Number of Study Related Instances
. . interpreter . procedure Σ 0..1 0..* Reference ( Practitioner Procedure ) Who interpreted images Type of procedure performed
. . . description Σ 0..1 string Institution-generated description Institution-generated description
. . . series Σ 0..* BackboneElement Each study has one or more series of instances Each study has one or more series of instances
. . . number . uid Σ 0..1 1..1 unsignedInt oid Numeric identifier of this series Formal identifier for this series
. . . modality . number Σ 1..1 0..1 Coding unsignedInt The modality of the instances in the series Acquisition Modality Codes ( Extensible ) Numeric identifier of this series
. . . uid . modality Σ 1..1 oid Coding Formal identifier for this series The modality of the instances in the series
Acquisition Modality Codes ( Extensible )
. . . . description Σ 0..1 string A description of the series A short human readable summary of the series
. . . . numberOfInstances Σ 1..1 unsignedInt Number of Series Related Instances Number of Series Related Instances
. . . . availability Σ 0..1 code ONLINE | OFFLINE | NEARLINE | UNAVAILABLE ONLINE | OFFLINE | NEARLINE | UNAVAILABLE
InstanceAvailability ( ( Required )
. . . . url Σ 0..1 uri Location of the referenced instance(s) Location of the referenced instance(s)
. . . . bodySite Σ 0..1 Coding Body part examined Body part examined
SNOMED CT Body Structures ( SNOMED CT Body Structures ( Example )
. . . . laterality Σ 0..1 Coding Body part laterality Body part laterality
Laterality ( ( Example )
. . . . started Σ 0..1 dateTime When the series started When the series started
. . . . instance Σ 0..* BackboneElement A single SOP instance from the series A single SOP instance from the series
. . . . number . uid Σ 0..1 1..1 unsignedInt oid The number of this instance in the series Formal identifier for this instance
. . . . uid . number Σ 1..1 0..1 oid unsignedInt Formal identifier for this instance The number of this instance in the series
. . . . . sopClass Σ 1..1 oid DICOM class type DICOM class type
. . . . . type Σ 0..1 string Type of instance (image etc.) Type of instance (image etc.)
. . . . . title Σ 0..1 string Description of instance Description of instance
. . . . . content Σ 0..* Attachment Content of the instance The instance payload, such as the image binary data or URL to it

Documentation for this format doco Documentation for this format

UML Diagram UML Diagram

ImagingStudy ( ( DomainResource ) Date and Time the study started Formal identifier for the study started : dateTime [0..1] uid : oid [1..1] The patient imaged in the study Accession Number is an identifier related to some aspect of imaging workflow and data management. Usage may vary across different institutions. See for instance [IHE Radiology Technical Framework Volume 1 Appendix A](http://www.ihe.net/uploadedFiles/Documents/Radiology/IHE_RAD_TF_Rev13.0_Vol1_FT_2014-07-30.pdf) patient : Reference [1..1] « Patient » accession : Identifier [0..1] Formal identifier for the study Other identifiers for the study uid : oid [1..1] identifier : Identifier [0..*] Accession Number is an identifier related to some aspect of imaging workflow and data management. Usage may vary across different institutions. See for instance [IHE Radiology Technical Framework Volume 1 Appendix A](http://www.ihe.net/uploadedFiles/Documents/Radiology/IHE_RAD_TF_Rev13.0_Vol1_FT_2014-07-30.pdf) Availability of study (online, offline or nearline) accession : Identifier [0..1] availability : code [0..1] « Availability of the resource (Strength=Required) InstanceAvailability ! » Other identifiers for the study A list of all the Series.ImageModality values that are actual acquisition modalities, i.e. those in the DICOM Context Group 29 (value set OID 1.2.840.10008.6.1.19) identifier : Identifier [0..*] modalityList : Coding [0..*] « Type of acquired data in the instance (Strength=Extensible) Acquisition Modality + » A list of the diagnostic orders that resulted in this imaging study being performed The patient imaged in the study order : patient : Reference [0..*] « DiagnosticOrder » [1..1] « Patient » A list of all the Series.ImageModality values that are actual acquisition modalities, i.e. those in the DICOM Context Group 29 (value set OID 1.2.840.10008.6.1.19) Date and Time the study started modalityList : Coding [0..*] « started : dateTime [0..1] Type of acquired data in the instance (Strength=Extensible) A list of the diagnostic orders that resulted in this imaging study being performed Acquisition Modality + » order : Reference [0..*] « DiagnosticOrder » The requesting/referring physician The requesting/referring physician referrer : : Reference [0..1] « [0..1] « Practitioner » » Availability of study (online, offline or nearline) availability : code [0..1] « Availability of the resource (Strength=Required) Who read the study and interpreted the images or other content InstanceAvailability ! » interpreter : Reference [0..1] « Practitioner » WADO-RS resource where Study is available WADO-RS resource where Study is available url : : uri [0..1] [0..1] Number of Series in Study Number of Series in Study numberOfSeries : : unsignedInt [1..1] [1..1] Number of SOP Instances in Study Number of SOP Instances in Study numberOfInstances : : unsignedInt [1..1] [1..1] Type of procedure performed Type of procedure performed procedure : : Reference [0..*] « [0..*] « Procedure » Who read the study and interpreted the images or other content interpreter : Reference [0..1] « Practitioner » » Institution-generated description or classification of the Study performed Institution-generated description or classification of the Study performed description : : string [0..1] [0..1] Series Formal identifier for this series uid : oid [1..1] The Numeric identifier of this series in the study The Numeric identifier of this series in the study number : : unsignedInt [0..1] [0..1] The modality of this series sequence The modality of this series sequence modality : : Coding [1..1] « Type of acquired data in the instance (Strength=Extensible) Acquisition Modality + » [1..1] « Formal identifier for this series Type of acquired data in the instance (Strength=Extensible) uid : oid [1..1] Acquisition Modality + » A description of the series A description of the series description : : string [0..1] [0..1] Number of SOP Instances in Series Number of SOP Instances in Series numberOfInstances : : unsignedInt [1..1] [1..1] Availability of series (online, offline or nearline) Availability of series (online, offline or nearline) availability : : code [0..1] « [0..1] « Availability of the resource (Strength=Required) Availability of the resource (Strength=Required) InstanceAvailability ! » ! » URI/URL specifying the location of the referenced series using WADO-RS URI/URL specifying the location of the referenced series using WADO-RS url : : uri [0..1] [0..1] Body part examined. See DICOM Part 16 Annex L for the mapping from DICOM to Snomed CT Body part examined. See DICOM Part 16 Annex L for the mapping from DICOM to Snomed CT bodySite : : Coding [0..1] « [0..1] « Codes describing anatomical locations. May include laterality. (Strength=Example) Codes describing anatomical locations. May include laterality. (Strength=Example) SNOMED CT Body Structures SNOMED CT Body Structures ?? » ?? » Laterality if body site is paired anatomic structure and laterality is not pre-coordinated in body site code Laterality if body site is paired anatomic structure and laterality is not pre-coordinated in body site code laterality : : Coding [0..1] « [0..1] « Codes describing body site laterality (left, right, etc.). (Strength=Example) Codes describing body site laterality (left, right, etc.). (Strength=Example) Laterality ?? » ?? » The date and time the series was started The date and time the series was started started : : dateTime [0..1] [0..1] Instance The number of instance in the series Formal identifier for this image or other content number : unsignedInt [0..1] uid : oid [1..1] Formal identifier for this image or other content The number of instance in the series uid : oid [1..1] number : unsignedInt [0..1] DICOM instance type DICOM instance type sopClass : : oid [1..1] [1..1] A human-friendly SOP Class name A human-friendly SOP Class name type : : string [0..1] [0..1] The description of the instance The description of the instance title : : string [0..1] [0..1] Content of the instance or a rendering thereof (e.g. a JPEG of an image, or an XML of a structured report). May be represented for example by inline encoding; by a URL reference to a WADO-RS service that makes the instance available; or to a FHIR Resource (e.g. Media, Document, etc.). Multiple content attachments may be used for alternate representations of the instance Content of the instance or a rendering thereof (e.g. a JPEG of an image, or an XML of a structured report). May be represented for example by inline encoding; by a URL reference to a WADO-RS service that makes the instance available; or to a FHIR Resource (e.g. Media, Document, etc.). Multiple content attachments may be used for alternate representations of the instance content : : Attachment [0..*] [0..*] A single SOP Instance within the series, e.g. an image, or presentation state A single SOP Instance within the series, e.g. an image, or presentation state instance [0..*] Each study has one or more series of images or other content Each study has one or more series of images or other content series [0..*]

XML Template XML Template

<ImagingStudy xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <
 <</patient>

 <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>
 <</order>

 <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>
 <</interpreter>

 <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>

   <content><!-- 0..* Attachment The instance payload, such as the image binary data or URL to it --></content>

  </instance>
 </series>
</ImagingStudy>

JSON Template JSON Template

{doco
  "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:

Alternate definitions: Schema / Schematron , Resource Profile ( , Resource Profile ( XML , , JSON ), ), Questionnaire

4.23.2.1 Terminology Bindings 4.34.2.1 Terminology Bindings

ImagingStudy.modalityList ImagingStudy.availability
Path Definition Type Reference
ImagingStudy.availability
ImagingStudy.series.modality ImagingStudy.series.availability
Type of acquired data in the instance Availability of the resource Extensible Required Acquisition Modality Codes InstanceAvailability
ImagingStudy.modalityList
ImagingStudy.series.availability ImagingStudy.series.modality
Availability of the resource Type of acquired data in the instance Required Extensible InstanceAvailability Acquisition Modality Codes
ImagingStudy.series.bodySite ImagingStudy.series.bodySite Codes describing anatomical locations. May include laterality. Codes describing anatomical locations. May include laterality. Example SNOMED CT Body Structures SNOMED CT Body Structures
ImagingStudy.series.laterality ImagingStudy.series.laterality Codes describing body site laterality (left, right, etc.). Codes describing body site laterality (left, right, etc.). Example Laterality

4.23.2.2 4.34.2.2 Implementation Notes Implementation Notes Instances can be images, but they can also be DICOM structured documents or other DICOM classes. This resource follows DICOM practice in using OIDs for elements such as instance type rather than codes. Each instance has an Attachment. Multiple Attachments can represent the same information, but using different approaches. The ImagingStudy.content.url could be a reference to a WADO-RS service that makes the instance available. The ImagingStudy.content.url could be a reference to a FHIR resource (

  • Instances can be images, but they can also be DICOM structured documents or other DICOM classes.
  • This resource follows DICOM practice in using OIDs for elements such as instance type rather than codes.
  • Each instance has an Attachment. Multiple Attachments can represent the same information, but using different approaches. The ImagingStudy.content.url could be a reference to a WADO-RS service that makes the instance available. The ImagingStudy.content.url could be a reference to a FHIR resource ( Media , , Composition , etc.). The use of ImagingStudy.content.data is discouraged with preference of url. , etc.).
  • The use of ImagingStudy.content.data is discouraged with preference of url.

4.23.2.3 4.34.2.3 Use Case Use Case

4.34.2.3.1 EHR access to imaging studies 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

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 .

4.34.2.3.2 Comprehensive Imaging Scheduled Workflow

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 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 Orders, and he follows the link to retrieve the DiagnosticOrder. (He may follow the links through the referenced 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/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 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 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 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 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 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 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. 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.

4.23.3 Search Parameters 4.34.3 Search Parameters Search parameters for this resource. The common parameters also apply. See

Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services. for more information about searching in REST, messaging, and services.

© HL7.org 2011+. FHIR DSTU2 (v1.0.2-7202) generated on Sat, Oct 24, 2015 07:43+1100. Links: Search
Name Type Description Paths
accession token The accession identifier for the study The accession identifier for the study ImagingStudy.accession
bodysite token The body site studied The body site studied ImagingStudy.series.bodySite
dicom-class uri The type of the instance The type of the instance ImagingStudy.series.instance.sopClass
modality identifier token The Other identifiers for the Study ImagingStudy.identifier
modality of the series token The modality of the series ImagingStudy.series.modality
order reference The order for the image The order for the image ImagingStudy.order
( DiagnosticOrder )
patient reference Who the study is about Who the study is about ImagingStudy.patient
( Patient )
series uri The identifier of the series of images The identifier of the series of images ImagingStudy.series.uid
started date When the study was started When the study was started ImagingStudy.started
study uri The study identifier for the image The study identifier for the image ImagingStudy.uid
uid uri The instance unique identifier The instance unique identifier ImagingStudy.series.instance.uid