This page is part of the FHIR Specification (v0.0.82: DSTU 1). The current version which supercedes this version is 5.0.0 . For a full list of available versions, see the Directory of published versions

4.25 Resource ImagingObjectSelection - Content

This resource maintained by the Imaging Integration Work Group

A set of DICOM SOP Instances of a patient, selected for some application purpose, e.g., quality assurance, teaching, conference, consulting, etc. Objects selected can be from different studies, but must be of the same patient.

Manifest of a set of DICOM objects (images or other data types) from one or more studies, with an intended purpose. The referenced objects may include every image in a study to be shared through a health information exchange, a list of key images for a referring or treating physician, a set of images to be included in a teaching file, or similar purposes.

4.25.1 Scope and Usage

This resource summarizes a set of images or other instances gathered for some specified purpose, and provides references to where the images are available using WADO-RS. This resource is used to make available information concerning images etc. that are intended to be exchanged into other clinical contexts such as diagnostic reports, Care Plans, etc.

4.25.2 Resource Content

Structure

Name Flags Card. Type Description & Constraints doco
. . ImagingObjectSelection DomainResource Key Object Selection
. . . uid 1..1 oid Instance UID
. . . patient 1..1 Patient Patient of the selected objects
. . . title 1..1 CodeableConcept Reason for selection
KOStitle ( Example )
. . . description 0..1 string Description text
. . . author 0..1 Practitioner | Device | Organization | Patient | RelatedPerson Author (human or machine)
. . . authoringTime 0..1 dateTime Authoring time of the selection
. . . study 1..* Element Study identity of the selected instances
. . . . uid 1..1 oid Study instance uid
. . . . url 0..1 uri Retrieve URL
. . . . series 1..* Element Series identity of the selected instances
. . . . . uid 0..1 oid Series instance uid
. . . . . url 0..1 uri Retrieve URL
. . . . . instance 1..* Element The selected instance
. . . . . . sopClass 1..1 oid SOP class uid of instance
. . . . . . uid 1..1 oid Uid of the selected instance
. . . . . . url 1..1 uri Retrieve URL
. . . . . . frames 0..* Element The frame set
. . . . . . . frameNumbers 1..* integer Frame numbers
. . . . . . . url 1..1 uri Retrieve URL

UML Diagram

ImagingObjectSelection ( DomainResource ) Instance UID of the DICOM KOS SOP Instances represenetd in this resource uid : oid 1..1 A patient resource reference which is the patient subject of all DICOM SOP Instances in this key object selection patient : Reference ( Patient ) 1..1 The reason for, or significance of, the selection of objects referenced in the resource title : CodeableConcept 1..1 « ( The document title code of key object selection KOStitle ) » Text description of the DICOM SOP instances selected in the key object selection. This should be aligned with the content of the title element, and can provide further explanation of the SOP instances in the selection description : string 0..1 Author of key object selection. It can be a human authtor or a device which made the decision of the SOP instances selected. For example, a radiologist selected a set of imaging SOP instances to attached in a diagnostic report, and a CAD application may author a selection to describe SOP instances it used to generate a detection conclusion author : Reference ( Practitioner | Device | Organization | Patient | RelatedPerson ) 0..1 Date and time when the key object selection was authored. Note that this is the date and time the DICOM SOP instances in the selection were selected (selection decision making). It is different from the creation date and time of the selection resource authoringTime : dateTime 0..1 Study Study instance uid of the SOP instances in the selection uid : oid 1..1 WADO-RS URL to retrieve the study. Note that this URL retrieves all SOP instances of the study, not only those in the selection url : uri 0..1 Series Series instance uid of the SOP instances in the selection uid : oid 0..1 WADO-RS URL to retrieve the series Note that this URL retrieves all SOP instances of the series not only those in the selection url : uri 0..1 Instance SOP class uid of the selected instance sopClass : oid 1..1 SOP Instance uid of the selected instance uid : oid 1..1 WADO-RS URL to retrieve the DICOM SOP Instance url : uri 1..1 Frames The frame numbers in the frame set frameNumbers : integer 1..* WADO-RS URL to retrieve the DICOM frames url : uri 1..1 Identity and location information of the frames in the selected instance frames 0..* Identity and locating information of the selected DICOM SOP instances instance 1..* Series indetity and locating information of the DICOM SOP instances in the selection series 1..* Study identity and locating information of the DICOM SOP instances in the selection study 1..*

XML Template 

<ImagingObjectSelection xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <uid value="[oid]"/><!-- 1..1 Instance UID -->
 <patient><!-- 1..1 Reference(Patient) Patient of the selected objects --></patient>
 <title><!-- 1..1 CodeableConcept Reason for selection --></title>
 <description value="[string]"/><!-- 0..1 Description text -->
 <author><!-- 0..1 Reference(Practitioner|Device|Organization|Patient|
   RelatedPerson) Author (human or machine) --></author>
 <authoringTime value="[dateTime]"/><!-- 0..1 Authoring time of the selection -->
 <study>  <!-- 1..* Study identity of the selected instances -->
  <uid value="[oid]"/><!-- 1..1 Study instance uid -->
  <url value="[uri]"/><!-- 0..1 Retrieve URL -->
  <series>  <!-- 1..* Series identity of the selected instances -->
   <uid value="[oid]"/><!-- 0..1 Series instance uid -->
   <url value="[uri]"/><!-- 0..1 Retrieve URL -->
   <instance>  <!-- 1..* The selected instance -->
    <sopClass value="[oid]"/><!-- 1..1 SOP class uid of instance -->
    <uid value="[oid]"/><!-- 1..1 Uid of the selected instance -->
    <url value="[uri]"/><!-- 1..1 Retrieve URL -->
    <frames>  <!-- 0..* The frame set -->
     <frameNumbers value="[integer]"/><!-- 1..* Frame numbers -->
     <url value="[uri]"/><!-- 1..1 Retrieve URL -->
    </frames>
   </instance>
  </series>
 </study>
</ImagingObjectSelection>

JSON Template 

{doco
  "resourceType" : "ImagingObjectSelection",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "uid" : "<oid>", // R!  Instance UID
  "patient" : { Reference(Patient) }, // R!  Patient of the selected objects
  "title" : { CodeableConcept }, // R!  Reason for selection
  "description" : "<string>", // Description text
  "author" : { Reference(Practitioner|Device|Organization|Patient|
   RelatedPerson) }, // Author (human or machine)
  "authoringTime" : "<dateTime>", // Authoring time of the selection
  "study" : [{ // R!  Study identity of the selected instances
    "uid" : "<oid>", // R!  Study instance uid
    "url" : "<uri>", // Retrieve URL
    "series" : [{ // R!  Series identity of the selected instances
      "uid" : "<oid>", // Series instance uid
      "url" : "<uri>", // Retrieve URL
      "instance" : [{ // R!  The selected instance
        "sopClass" : "<oid>", // R!  SOP class uid of instance
        "uid" : "<oid>", // R!  Uid of the selected instance
        "url" : "<uri>", // R!  Retrieve URL
        "frames" : [{ // The frame set
          "frameNumbers" : [<integer>], // R!  Frame numbers
          "url" : "<uri>" // R!  Retrieve URL
        }]
      }]
    }]
  }]
}

Structure

Name Flags Card. Type Description & Constraints doco
. . ImagingObjectSelection DomainResource Key Object Selection
. . . uid 1..1 oid Instance UID
. . . patient 1..1 Patient Patient of the selected objects
. . . title 1..1 CodeableConcept Reason for selection
KOStitle ( Example )
. . . description 0..1 string Description text
. . . author 0..1 Practitioner | Device | Organization | Patient | RelatedPerson Author (human or machine)
. . . authoringTime 0..1 dateTime Authoring time of the selection
. . . study 1..* Element Study identity of the selected instances
. . . . uid 1..1 oid Study instance uid
. . . . url 0..1 uri Retrieve URL
. . . . series 1..* Element Series identity of the selected instances
. . . . . uid 0..1 oid Series instance uid
. . . . . url 0..1 uri Retrieve URL
. . . . . instance 1..* Element The selected instance
. . . . . . sopClass 1..1 oid SOP class uid of instance
. . . . . . uid 1..1 oid Uid of the selected instance
. . . . . . url 1..1 uri Retrieve URL
. . . . . . frames 0..* Element The frame set
. . . . . . . frameNumbers 1..* integer Frame numbers
. . . . . . . url 1..1 uri Retrieve URL

UML Diagram

ImagingObjectSelection ( DomainResource ) Instance UID of the DICOM KOS SOP Instances represenetd in this resource uid : oid 1..1 A patient resource reference which is the patient subject of all DICOM SOP Instances in this key object selection patient : Reference ( Patient ) 1..1 The reason for, or significance of, the selection of objects referenced in the resource title : CodeableConcept 1..1 « ( The document title code of key object selection KOStitle ) » Text description of the DICOM SOP instances selected in the key object selection. This should be aligned with the content of the title element, and can provide further explanation of the SOP instances in the selection description : string 0..1 Author of key object selection. It can be a human authtor or a device which made the decision of the SOP instances selected. For example, a radiologist selected a set of imaging SOP instances to attached in a diagnostic report, and a CAD application may author a selection to describe SOP instances it used to generate a detection conclusion author : Reference ( Practitioner | Device | Organization | Patient | RelatedPerson ) 0..1 Date and time when the key object selection was authored. Note that this is the date and time the DICOM SOP instances in the selection were selected (selection decision making). It is different from the creation date and time of the selection resource authoringTime : dateTime 0..1 Study Study instance uid of the SOP instances in the selection uid : oid 1..1 WADO-RS URL to retrieve the study. Note that this URL retrieves all SOP instances of the study, not only those in the selection url : uri 0..1 Series Series instance uid of the SOP instances in the selection uid : oid 0..1 WADO-RS URL to retrieve the series Note that this URL retrieves all SOP instances of the series not only those in the selection url : uri 0..1 Instance SOP class uid of the selected instance sopClass : oid 1..1 SOP Instance uid of the selected instance uid : oid 1..1 WADO-RS URL to retrieve the DICOM SOP Instance url : uri 1..1 Frames The frame numbers in the frame set frameNumbers : integer 1..* WADO-RS URL to retrieve the DICOM frames url : uri 1..1 Identity and location information of the frames in the selected instance frames 0..* Identity and locating information of the selected DICOM SOP instances instance 1..* Series indetity and locating information of the DICOM SOP instances in the selection series 1..* Study identity and locating information of the DICOM SOP instances in the selection study 1..*

XML Template 

<ImagingObjectSelection xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <uid value="[oid]"/><!-- 1..1 Instance UID -->
 <patient><!-- 1..1 Reference(Patient) Patient of the selected objects --></patient>
 <title><!-- 1..1 CodeableConcept Reason for selection --></title>
 <description value="[string]"/><!-- 0..1 Description text -->
 <author><!-- 0..1 Reference(Practitioner|Device|Organization|Patient|
   RelatedPerson) Author (human or machine) --></author>
 <authoringTime value="[dateTime]"/><!-- 0..1 Authoring time of the selection -->
 <study>  <!-- 1..* Study identity of the selected instances -->
  <uid value="[oid]"/><!-- 1..1 Study instance uid -->
  <url value="[uri]"/><!-- 0..1 Retrieve URL -->
  <series>  <!-- 1..* Series identity of the selected instances -->
   <uid value="[oid]"/><!-- 0..1 Series instance uid -->
   <url value="[uri]"/><!-- 0..1 Retrieve URL -->
   <instance>  <!-- 1..* The selected instance -->
    <sopClass value="[oid]"/><!-- 1..1 SOP class uid of instance -->
    <uid value="[oid]"/><!-- 1..1 Uid of the selected instance -->
    <url value="[uri]"/><!-- 1..1 Retrieve URL -->
    <frames>  <!-- 0..* The frame set -->
     <frameNumbers value="[integer]"/><!-- 1..* Frame numbers -->
     <url value="[uri]"/><!-- 1..1 Retrieve URL -->
    </frames>
   </instance>
  </series>
 </study>
</ImagingObjectSelection>

JSON Template 

{doco
  "resourceType" : "ImagingObjectSelection",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "uid" : "<oid>", // R!  Instance UID
  "patient" : { Reference(Patient) }, // R!  Patient of the selected objects
  "title" : { CodeableConcept }, // R!  Reason for selection
  "description" : "<string>", // Description text
  "author" : { Reference(Practitioner|Device|Organization|Patient|
   RelatedPerson) }, // Author (human or machine)
  "authoringTime" : "<dateTime>", // Authoring time of the selection
  "study" : [{ // R!  Study identity of the selected instances
    "uid" : "<oid>", // R!  Study instance uid
    "url" : "<uri>", // Retrieve URL
    "series" : [{ // R!  Series identity of the selected instances
      "uid" : "<oid>", // Series instance uid
      "url" : "<uri>", // Retrieve URL
      "instance" : [{ // R!  The selected instance
        "sopClass" : "<oid>", // R!  SOP class uid of instance
        "uid" : "<oid>", // R!  Uid of the selected instance
        "url" : "<uri>", // R!  Retrieve URL
        "frames" : [{ // The frame set
          "frameNumbers" : [<integer>], // R!  Frame numbers
          "url" : "<uri>" // R!  Retrieve URL
        }]
      }]
    }]
  }]
}

 

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

4.25.2.1 Terminology Bindings

Path Definition Type Reference
ImagingObjectSelection.title The document title code of key object selection Example http://hl7.org/fhir/kos-title

4.25.3 Search Parameters

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
author reference Author of key DICOM object selection ImagingObjectSelection.author
( Device , Patient , Organization , Practitioner , RelatedPerson )
authoring-time date Time of key DICOM object selection authoring ImagingObjectSelection.authoringTime
identifier token UID of key DICOM object selection ImagingObjectSelection.uid
patient reference Subject of key DICOM object selection ImagingObjectSelection.patient
( Patient )
selected-study token Study selected in key DICOM object selection ImagingObjectSelection.study.uid
title token Title of key DICOM object selection ImagingObjectSelection.title