DSTU2 Ballot Source

This page is part of the FHIR Specification (v0.5.0: DSTU 2 Ballot 2). 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.24 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.24.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.24.2 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. ImagingObjectSelection DomainResourceKey Object Selection
... uid 1..1oidInstance UID
... patient 1..1PatientPatient of the selected objects
... title 1..1CodeableConceptReason for selection
KOStitle (Example)
... description 0..1stringDescription text
... author 0..1Practitioner | Device | Organization | Patient | RelatedPersonAuthor (human or machine)
... authoringTime 0..1dateTimeAuthoring time of the selection
... study 1..*ElementStudy identity of the selected instances
.... uid 1..1oidStudy instance uid
.... url 0..1uriRetrieve URL
.... series 1..*ElementSeries identity of the selected instances
..... uid 0..1oidSeries instance uid
..... url 0..1uriRetrieve URL
..... instance 1..*ElementThe selected instance
...... sopClass 1..1oidSOP class uid of instance
...... uid 1..1oidUid of the selected instance
...... url 1..1uriRetrieve URL
...... frames 0..*ElementThe frame set
....... frameNumbers 1..*unsignedIntFrame numbers
....... url 1..1uriRetrieve URL

UML Diagram

ImagingObjectSelection (DomainResource)Instance UID of the DICOM KOS SOP Instances represenetd in this resourceuid : oid 1..1A patient resource reference which is the patient subject of all DICOM SOP Instances in this key object selectionpatient : Reference(Patient) 1..1The reason for, or significance of, the selection of objects referenced in the resourcetitle : CodeableConcept 1..1 « (The document title code of key object selectionKOStitle) »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 selectiondescription : string 0..1Author 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 conclusionauthor : Reference(Practitioner|Device| Organization|Patient|RelatedPerson) 0..1Date 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 resourceauthoringTime : dateTime 0..1StudyStudy instance uid of the SOP instances in the selectionuid : oid 1..1WADO-RS URL to retrieve the study. Note that this URL retrieves all SOP instances of the study, not only those in the selectionurl : uri 0..1SeriesSeries instance uid of the SOP instances in the selectionuid : oid 0..1WADO-RS URL to retrieve the series Note that this URL retrieves all SOP instances of the series not only those in the selectionurl : uri 0..1InstanceSOP class uid of the selected instancesopClass : oid 1..1SOP Instance uid of the selected instanceuid : oid 1..1WADO-RS URL to retrieve the DICOM SOP Instanceurl : uri 1..1FramesThe frame numbers in the frame setframeNumbers : unsignedInt 1..*WADO-RS URL to retrieve the DICOM framesurl : uri 1..1Identity and location information of the frames in the selected instanceframes0..*Identity and locating information of the selected DICOM SOP instancesinstance1..*Series indetity and locating information of the DICOM SOP instances in the selectionseries1..*Study identity and locating information of the DICOM SOP instances in the selectionstudy1..*

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="[unsignedInt]"/><!-- 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" : ["<unsignedInt>"], // R!  Frame numbers
          "url" : "<uri>" // R!  Retrieve URL
        }]
      }]
    }]
  }]
}

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. ImagingObjectSelection DomainResourceKey Object Selection
... uid 1..1oidInstance UID
... patient 1..1PatientPatient of the selected objects
... title 1..1CodeableConceptReason for selection
KOStitle (Example)
... description 0..1stringDescription text
... author 0..1Practitioner | Device | Organization | Patient | RelatedPersonAuthor (human or machine)
... authoringTime 0..1dateTimeAuthoring time of the selection
... study 1..*ElementStudy identity of the selected instances
.... uid 1..1oidStudy instance uid
.... url 0..1uriRetrieve URL
.... series 1..*ElementSeries identity of the selected instances
..... uid 0..1oidSeries instance uid
..... url 0..1uriRetrieve URL
..... instance 1..*ElementThe selected instance
...... sopClass 1..1oidSOP class uid of instance
...... uid 1..1oidUid of the selected instance
...... url 1..1uriRetrieve URL
...... frames 0..*ElementThe frame set
....... frameNumbers 1..*unsignedIntFrame numbers
....... url 1..1uriRetrieve URL

UML Diagram

ImagingObjectSelection (DomainResource)Instance UID of the DICOM KOS SOP Instances represenetd in this resourceuid : oid 1..1A patient resource reference which is the patient subject of all DICOM SOP Instances in this key object selectionpatient : Reference(Patient) 1..1The reason for, or significance of, the selection of objects referenced in the resourcetitle : CodeableConcept 1..1 « (The document title code of key object selectionKOStitle) »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 selectiondescription : string 0..1Author 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 conclusionauthor : Reference(Practitioner|Device| Organization|Patient|RelatedPerson) 0..1Date 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 resourceauthoringTime : dateTime 0..1StudyStudy instance uid of the SOP instances in the selectionuid : oid 1..1WADO-RS URL to retrieve the study. Note that this URL retrieves all SOP instances of the study, not only those in the selectionurl : uri 0..1SeriesSeries instance uid of the SOP instances in the selectionuid : oid 0..1WADO-RS URL to retrieve the series Note that this URL retrieves all SOP instances of the series not only those in the selectionurl : uri 0..1InstanceSOP class uid of the selected instancesopClass : oid 1..1SOP Instance uid of the selected instanceuid : oid 1..1WADO-RS URL to retrieve the DICOM SOP Instanceurl : uri 1..1FramesThe frame numbers in the frame setframeNumbers : unsignedInt 1..*WADO-RS URL to retrieve the DICOM framesurl : uri 1..1Identity and location information of the frames in the selected instanceframes0..*Identity and locating information of the selected DICOM SOP instancesinstance1..*Series indetity and locating information of the DICOM SOP instances in the selectionseries1..*Study identity and locating information of the DICOM SOP instances in the selectionstudy1..*

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="[unsignedInt]"/><!-- 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" : ["<unsignedInt>"], // R!  Frame numbers
          "url" : "<uri>" // R!  Retrieve URL
        }]
      }]
    }]
  }]
}

 

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

4.24.2.1 Terminology Bindings

PathDefinitionTypeReference
ImagingObjectSelection.title The document title code of key object selectionExamplehttp://hl7.org/fhir/kos-title

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

NameTypeDescriptionPaths
authorreferenceAuthor of key DICOM object selectionImagingObjectSelection.author
(Device, Patient, Organization, Practitioner, RelatedPerson)
authoring-timedateTime of key DICOM object selection authoringImagingObjectSelection.authoringTime
identifiertokenUID of key DICOM object selectionImagingObjectSelection.uid
patientreferenceSubject of key DICOM object selectionImagingObjectSelection.patient
(Patient)
selected-studytokenStudy selected in key DICOM object selectionImagingObjectSelection.study.uid
titletokenTitle of key DICOM object selectionImagingObjectSelection.title