FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

10.6 Resource ImagingSelection - Content

Imaging Integration icon Work GroupMaturity Level: 1 Trial UseSecurity Category: Patient Compartments: Group, Patient

A selection of DICOM SOP instances and/or frames within a single Study and Series. This might include additional specifics such as an image region, an Observation UID or a Segmentation Number, allowing linkage to an Observation Resource or transferring this information along with the ImagingStudy Resource.

This resource is an event resource from a FHIR workflow perspective - see Workflow.

A selection of data from an ImagingStudy. The selection MAY be:

  • All DICOM SOP Instances in a single DICOM Series
  • A set of DICOM SOP Instances within a single DICOM Series
  • A set of frames within one or more DICOM multiframe image SOP Instances
  • A set of segments within one or more DICOM segmentation SOP Instances
  • A set of content items within one or more DICOM Structured Report SOP Instances
  • ...

May also represent regions within the ImagingStudy, including:

  • A 2D region within one or more DICOM image SOP Instances
  • A 3D region within a DICOM frame of reference

Uses for ImagingSelection resources include:

  • Identifying a specific set of images or frames that an Observation is derived from
  • Identifying a spatial region or volume that an Observation is derived from
  • Identifying the set of image coordinates as the focus of a measurement represented by an Observation
  • Identifying a node in a DICOM Structured Report SOP Instance from which an Observation is derived
  • Identifying images, frames or presentation states selected as part of shared application context in a context-sharing environment
  • Identifying a specific set of images, frames or presentation states to be presented

All DICOM SOP Instances referenced in a single ImagingSelection resource SHALL be part of the same DICOM Series (and therefore also the same DICOM Study). In order to reference SOP Instances in multiple Studies or Series it is necessary to create multiple ImagingSelection resources.

The ImagingStudy resource is used to store details of an entire DICOM Study and associated information, including its relationship to other resources, such as ServiceRequest and Encounter.

The ImagingSelection resource is used to reference to a specific set of specific set of images, frames, waveforms or image regions. Instances of this resource are created for specific clinical purposes and are unlikely to change once created.

An Observation MAY be related to a set of images in the following ways.

The DocumentReference resource is used to to store non-DICOM images, video, or audio with relevant metadata. The DocumentReference resource might be appropriate for including a rendered DICOM image in cases where only the image is needed and not the full image context.

The Binary resource to store arbitrary content.

Structure

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ImagingSelection TU DomainResource A selection of DICOM SOP instances and/or frames
+ Rule: At least one of seriesUid or imageRegion3D shall be present
+ Rule: seriesUid SHALL only be present if studyUid is present
+ Rule: seriesNumber SHALL only be present if seriesUid is present
+ Rule: instance SHALL only be present if seriesUid is present
+ Rule: imageRegion3D SHALL only be present if frameOfReferenceUid is present
+ Rule: imageRegion3D SHALL only be present if instance.imageRegion2D is not present
+ Rule: if present, instance.imageRegion2D.coordinate shall have a value count that is a multiple of 2
+ Rule: if present, imageRegion3D.coordinate shall have a value count that is a multiple of 3
+ Rule: modality SHALL only be present if seriesUid is present

Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier Σ 0..* Identifier Business Identifiers for Imaging Selection

... status ?!Σ 1..1 code available | entered-in-error | inactive | unknown
Binding: Imaging Selection Status (Required)
... category Σ 0..* CodeableConcept Classifies the imaging selection
Binding: KeyObjectSelectionDocumentTitle icon (Preferred)

... code Σ 1..1 CodeableConcept Imaging Selection purpose text or code
Binding: KeyObjectSelectionDocumentTitle icon (Example)
... subject Σ 0..1 Reference(Patient | Group | Device | Procedure | Practitioner | Medication | Substance | Specimen) Subject of the selected instances
... issued Σ 0..1 instant Date / Time when this imaging selection was created
... performer Σ 0..* BackboneElement Selectors of the instances (human or machine)

.... function Σ 0..1 CodeableConcept Type of performer
Binding: ImagingStudy series performer function (Extensible)
.... actor Σ 0..1 Reference(Practitioner | PractitionerRole | Device | Organization | CareTeam | Patient | RelatedPerson | HealthcareService) Author (human or machine)
... basedOn Σ 0..* Reference(CarePlan | ServiceRequest | Appointment | Task) Associated requests

... derivedFrom Σ 0..1 Reference(ImagingStudy | DocumentReference) The imaging study from which the imaging selection is derived
... studyUid ΣC 0..1 id DICOM Study Instance UID
... seriesUid ΣC 0..1 id DICOM Series Instance UID
... seriesNumber ΣC 0..1 unsignedInt DICOM Series Number
... frameOfReferenceUid ΣC 0..1 id The Frame of Reference UID for the selected images
... bodySite Σ 0..* CodeableReference(BodyStructure) Body part examined
Binding: SNOMED CT Body Structures (Example)

... focus Σ 0..* Reference(ImagingSelection) Related resources that are the focus for the imaging selection

... endpoint Σ 0..* Reference(Endpoint) The network services providing access for the images referenced in the imaging selection

... instance ΣC 0..* BackboneElement The selected instances

.... uid Σ 1..1 id DICOM SOP Instance UID
.... number Σ 0..1 unsignedInt DICOM Instance Number
.... sopClass 0..1 oid DICOM SOP Class UID
.... subset 0..* string The selected subset of the SOP Instance

.... imageRegion2D C 0..* BackboneElement A specific 2D region in a DICOM image / frame

..... regionType 1..1 code point | polyline | multipoint | circle | ellipse
Binding: Imaging Selection 2D Graphic Type (Required)
..... coordinate C 1..* decimal Specifies the coordinates that define the image region
This repeating element order: The values are an ordered set of (x, y) coordinates.
... imageRegion3D C 0..* BackboneElement A specific 3D region in a DICOM frame of reference

.... regionType 1..1 code point | multipoint | polyline | polygon | ellipse | ellipsoid
Binding: Imaging Selection 3D Graphic Type (Required)
.... coordinate C 1..* decimal Specifies the coordinates that define the image region
This repeating element order: The values are an ordered set of (x, y, z) coordinates.

doco Documentation for this format icon

See the Extensions for this resource

UML Diagram (Legend)

ImagingSelection (DomainResource)Unique identifiers assigned to this imaging selectionidentifier : Identifier [0..*]The current state of the imaging selection. This is distinct from the status of any imaging study, service request, or task associated with the imaging selection (this element modifies the meaning of other elements)status : code [1..1] « null (Strength=Required)ImagingSelectionStatus! »Classifies the general purpose of the imaging selectioncategory : CodeableConcept [0..*] « null (Strength=Preferred)KeyObjectSelectionDocumentTit...? »The distinct modality for this selected series. This may be either an acquisition modality (e.g. CT, MR) or a non-acquisition modality (e.g. segmentation, presentation state)modality : CodeableConcept [0..1] « null (Strength=Extensible)Modality+ » « This element has or is affected by some invariantsC »Identifies the type of imaging selectioncode : CodeableConcept [1..1] « null (Strength=Example)KeyObjectSelectionDocumentTit...?? »The patient, or group of patients, location, device, organization, procedure or practitioner this imaging selection is about and into whose or what record the imaging selection is placedsubject : Reference [0..1] « Patient|Group|Device|Procedure| Practitioner|Medication|Substance|Specimen »The date and time this imaging selection was createdissued : instant [0..1]A list of the diagnostic requests that resulted in this imaging selection being performedbasedOn : Reference [0..*] « CarePlan|ServiceRequest|Appointment| Task »The imaging study from which the imaging selection is madederivedFrom : Reference [0..1] « ImagingStudy|DocumentReference »The Study Instance UID for the DICOM Study from which the images were selectedstudyUid : id [0..1] « This element has or is affected by some invariantsC »The Series Instance UID for the DICOM Series from which the images were selectedseriesUid : id [0..1] « This element has or is affected by some invariantsC »The Series Number for the DICOM Series from which the images were selectedseriesNumber : unsignedInt [0..1] « This element has or is affected by some invariantsC »Uniquely identifies groups of composite instances that have the same coordinate system that conveys spatial and/or temporal informationframeOfReferenceUid : id [0..1] « This element has or is affected by some invariantsC »The anatomic structures examined. See [DICOM Part 16 Annex L](http://dicom.nema.org/medical/dicom/current/output/chtml/part16/chapter_L.html) for DICOM to SNOMED-CT mappingsbodySite : CodeableReference [0..*] « BodyStructure; Codes describing anatomical locations. May include laterality. (Strength=Example) SNOMEDCTBodyStructures?? »The actual focus of an imaging selection when it is another imaging selection resource and not the patient of recordfocus : Reference [0..*] « ImagingSelection »The network services providing access to the selected images, frames, etc. See implementation notes for information about using DICOM endpointsendpoint : Reference [0..*] « Endpoint »PerformerDistinguishes the type of involvement of the performerfunction : CodeableConcept [0..1] « null (Strength=Extensible)ImagingStudySeriesPerformerFu...+ »Author - human or machineactor : Reference [0..1] « Practitioner|PractitionerRole|Device| Organization|CareTeam|Patient|RelatedPerson|HealthcareService »InstanceThe SOP Instance UID for the selected DICOM instanceuid : id [1..1]The Instance Number for the selected DICOM instancenumber : unsignedInt [0..1]The SOP Class UID for the selected DICOM instancesopClass : oid [0..1]Selected subset of the SOP Instance. The type of the subset item is determined by the `instance.sopClass` value. May be one of: - A list of frame numbers selected from a multiframe SOP Instance (See [DICOM PS 3.3 Table 10.3](https://dicom.nema.org/medical/dicom/current/output/chtml/part03/sect_10.3.html#table_10-3)). - A list of Referenced Content Item Identifier values selected from a DICOM SR or other structured document SOP Instance (See [DICOM PS 3.3 C.17.3.2.5](https://dicom.nema.org/medical/dicom/current/output/chtml/part03/sect_C.17.3.2.5.html)). - A list of segment numbers selected from a segmentation SOP Instance (See [DICOM PS 3.3 Table C.8.20-4](https://dicom.nema.org/medical/dicom/current/output/chtml/part03/sect_C.8.20.4.html#table_C.8.20-4)). - A list of Region of Interest (ROI) numbers selected from a radiotherapy structure set SOP Instance (See [DICOM PS 3.3 C.8.8.5](https://dicom.nema.org/medical/dicom/current/output/chtml/part03/sect_C.8.8.5.html))subset : string [0..*]ImageRegion2DSpecifies the type of image regionregionType : code [1..1] « null (Strength=Required)ImagingSelection2DGraphicType! »The coordinates describing the image region. Encoded as a set of (column, row) pairs that denote positions in the selected image / frames specified with sub-pixel resolution. The origin at the TLHC of the TLHC pixel is 0.0\0.0, the BRHC of the TLHC pixel is 1.0\1.0, and the BRHC of the BRHC pixel is the number of columns\rows in the image / frames. The values SHALL be within the range 0\0 to the number of columns\rows in the image / framescoordinate : decimal [1..*] « This element has or is affected by some invariantsC »ImageRegion3DSpecifies the type of image regionregionType : code [1..1] « null (Strength=Required)ImagingSelection3DGraphicType! »The coordinates describing the image region. Encoded as an ordered set of (x,y,z) triplets (in mm and MAY be negative) that define a region of interest in the patient-relative Reference Coordinate System defined by ImagingSelection.frameOfReferenceUid elementcoordinate : decimal [1..*] « This element has or is affected by some invariantsC »Selectors of the instances – human or machineperformer[0..*]Each imaging selection instance or frame list might includes an image region, specified by a region type and a set of 2D coordinatesimageRegion2D[0..*]Each imaging selection includes one or more selected DICOM SOP instancesinstance[0..*]Each imaging selection might includes a 3D image region, specified by a region type and a set of 3D coordinatesimageRegion3D[0..*]

XML Template

<ImagingSelection xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier Business Identifiers for Imaging Selection --></identifier>
 <status value="[code]"/><!-- 1..1 available | entered-in-error | inactive | unknown -->
 <category><!-- 0..* CodeableConcept Classifies the imaging selection icon --></category>
 <modality><!-- I 0..1 CodeableConcept The distinct modality icon --></modality>
 <code><!-- 1..1 CodeableConcept Imaging Selection purpose text or code icon --></code>
 <subject><!-- 0..1 Reference(Device|Group|Medication|Patient|Practitioner|
   Procedure|Specimen|Substance) Subject of the selected instances --></subject>
 <issued value="[instant]"/><!-- 0..1 Date / Time when this imaging selection was created -->
 <performer>  <!-- 0..* Selectors of the instances (human or machine) -->
  <function><!-- 0..1 CodeableConcept Type of performer --></function>
  <actor><!-- 0..1 Reference(CareTeam|Device|HealthcareService|Organization|
    Patient|Practitioner|PractitionerRole|RelatedPerson) Author (human or machine) --></actor>
 </performer>
 <basedOn><!-- 0..* Reference(Appointment|CarePlan|ServiceRequest|Task) Associated requests --></basedOn>
 <derivedFrom><!-- 0..1 Reference(DocumentReference|ImagingStudy) The imaging study from which the imaging selection is derived --></derivedFrom>
 <studyUid value="[id]"/><!-- I 0..1 DICOM Study Instance UID -->
 <seriesUid value="[id]"/><!-- I 0..1 DICOM Series Instance UID -->
 <seriesNumber value="[unsignedInt]"/><!-- I 0..1 DICOM Series Number -->
 <frameOfReferenceUid value="[id]"/><!-- I 0..1 The Frame of Reference UID for the selected images -->
 <bodySite><!-- 0..* CodeableReference(BodyStructure) Body part examined --></bodySite>
 <focus><!-- 0..* Reference(ImagingSelection) Related resources that are the focus for the imaging selection --></focus>
 <endpoint><!-- 0..* Reference(Endpoint) The network services providing access for the images referenced in the imaging selection --></endpoint>
 <instance>  <!-- I 0..* The selected instances -->
  <uid value="[id]"/><!-- 1..1 DICOM SOP Instance UID -->
  <number value="[unsignedInt]"/><!-- 0..1 DICOM Instance Number -->
  <sopClass value="[oid]"/><!-- 0..1 DICOM SOP Class UID -->
  <subset value="[string]"/><!-- 0..* The selected subset of the SOP Instance -->
  <imageRegion2D>  <!-- I 0..* A specific 2D region in a DICOM image / frame -->
   <regionType value="[code]"/><!-- 1..1 point | polyline | multipoint | circle | ellipse -->
   <coordinate value="[decimal]"/><!-- I 1..* Specifies the coordinates that define the image region -->
  </imageRegion2D>
 </instance>
 <imageRegion3D>  <!-- I 0..* A specific 3D region in a DICOM frame of reference -->
  <regionType value="[code]"/><!-- 1..1 point | multipoint | polyline | polygon | ellipse | ellipsoid -->
  <coordinate value="[decimal]"/><!-- I 1..* Specifies the coordinates that define the image region -->
 </imageRegion3D>
</ImagingSelection>

JSON Template

{doco
  "resourceType" : "ImagingSelection",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // Business Identifiers for Imaging Selection
  "status" : "<code>", // R!  available | entered-in-error | inactive | unknown
  "category" : [{ CodeableConcept }], // Classifies the imaging selection icon
  "modality" : { CodeableConcept }, // I The distinct modality icon
  "code" : { CodeableConcept }, // R!  Imaging Selection purpose text or code icon
  "subject" : { Reference(Device|Group|Medication|Patient|Practitioner|
   Procedure|Specimen|Substance) }, // Subject of the selected instances
  "issued" : "<instant>", // Date / Time when this imaging selection was created
  "performer" : [{ // Selectors of the instances (human or machine)
    "function" : { CodeableConcept }, // Type of performer
    "actor" : { Reference(CareTeam|Device|HealthcareService|Organization|
    Patient|Practitioner|PractitionerRole|RelatedPerson) } // Author (human or machine)
  }],
  "basedOn" : [{ Reference(Appointment|CarePlan|ServiceRequest|Task) }], // Associated requests
  "derivedFrom" : { Reference(DocumentReference|ImagingStudy) }, // The imaging study from which the imaging selection is derived
  "studyUid" : "<id>", // I DICOM Study Instance UID
  "seriesUid" : "<id>", // I DICOM Series Instance UID
  "seriesNumber" : "<unsignedInt>", // I DICOM Series Number
  "frameOfReferenceUid" : "<id>", // I The Frame of Reference UID for the selected images
  "bodySite" : [{ CodeableReference(BodyStructure) }], // Body part examined
  "focus" : [{ Reference(ImagingSelection) }], // Related resources that are the focus for the imaging selection
  "endpoint" : [{ Reference(Endpoint) }], // The network services providing access for the images referenced in the imaging selection
  "instance" : [{ // I The selected instances
    "uid" : "<id>", // R!  DICOM SOP Instance UID
    "number" : "<unsignedInt>", // DICOM Instance Number
    "sopClass" : "<oid>", // DICOM SOP Class UID
    "subset" : ["<string>"], // The selected subset of the SOP Instance
    "imageRegion2D" : [{ // I A specific 2D region in a DICOM image / frame
      "regionType" : "<code>", // R!  point | polyline | multipoint | circle | ellipse
      "coordinate" : [<decimal>] // I R!  Specifies the coordinates that define the image region
    }]
  }],
  "imageRegion3D" : [{ // I A specific 3D region in a DICOM frame of reference
    "regionType" : "<code>", // R!  point | multipoint | polyline | polygon | ellipse | ellipsoid
    "coordinate" : [<decimal>] // I R!  Specifies the coordinates that define the image region
  }]
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:ImagingSelection;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:identifier  ( [ Identifier ] ... ) ; # 0..* Business Identifiers for Imaging Selection
  fhir:status [ code ] ; # 1..1 available | entered-in-error | inactive | unknown
  fhir:category  ( [ CodeableConcept ] ... ) ; # 0..* Classifies the imaging selection
  fhir:modality [ CodeableConcept ] ; # 0..1 I The distinct modality
  fhir:code [ CodeableConcept ] ; # 1..1 Imaging Selection purpose text or code
  fhir:subject [ Reference(Device|Group|Medication|Patient|Practitioner|Procedure|Specimen|Substance) ] ; # 0..1 Subject of the selected instances
  fhir:issued [ instant ] ; # 0..1 Date / Time when this imaging selection was created
  fhir:performer ( [ # 0..* Selectors of the instances (human or machine)
    fhir:function [ CodeableConcept ] ; # 0..1 Type of performer
    fhir:actor [ Reference(CareTeam|Device|HealthcareService|Organization|Patient|Practitioner|
  PractitionerRole|RelatedPerson) ] ; # 0..1 Author (human or machine)
  ] ... ) ;
  fhir:basedOn  ( [ Reference(Appointment|CarePlan|ServiceRequest|Task) ] ... ) ; # 0..* Associated requests
  fhir:derivedFrom [ Reference(DocumentReference|ImagingStudy) ] ; # 0..1 The imaging study from which the imaging selection is derived
  fhir:studyUid [ id ] ; # 0..1 I DICOM Study Instance UID
  fhir:seriesUid [ id ] ; # 0..1 I DICOM Series Instance UID
  fhir:seriesNumber [ unsignedInt ] ; # 0..1 I DICOM Series Number
  fhir:frameOfReferenceUid [ id ] ; # 0..1 I The Frame of Reference UID for the selected images
  fhir:bodySite  ( [ CodeableReference(BodyStructure) ] ... ) ; # 0..* Body part examined
  fhir:focus  ( [ Reference(ImagingSelection) ] ... ) ; # 0..* Related resources that are the focus for the imaging selection
  fhir:endpoint  ( [ Reference(Endpoint) ] ... ) ; # 0..* The network services providing access for the images referenced in the imaging selection
  fhir:instance ( [ # 0..* I The selected instances
    fhir:uid [ id ] ; # 1..1 DICOM SOP Instance UID
    fhir:number [ unsignedInt ] ; # 0..1 DICOM Instance Number
    fhir:sopClass [ oid ] ; # 0..1 DICOM SOP Class UID
    fhir:subset  ( [ string ] ... ) ; # 0..* The selected subset of the SOP Instance
    fhir:imageRegion2D ( [ # 0..* I A specific 2D region in a DICOM image / frame
      fhir:regionType [ code ] ; # 1..1 point | polyline | multipoint | circle | ellipse
      fhir:coordinate  ( [ decimal ] ... ) ; # 1..* I Specifies the coordinates that define the image region
    ] ... ) ;
  ] ... ) ;
  fhir:imageRegion3D ( [ # 0..* I A specific 3D region in a DICOM frame of reference
    fhir:regionType [ code ] ; # 1..1 point | multipoint | polyline | polygon | ellipse | ellipsoid
    fhir:coordinate  ( [ decimal ] ... ) ; # 1..* I Specifies the coordinates that define the image region
  ] ... ) ;
]

Changes from both R4 and R4B

This resource did not exist in Release R4

See the Full Difference for further information

This analysis is available for R4 as XML or JSON and for R4B as XML or JSON.

Structure

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ImagingSelection TU DomainResource A selection of DICOM SOP instances and/or frames
+ Rule: At least one of seriesUid or imageRegion3D shall be present
+ Rule: seriesUid SHALL only be present if studyUid is present
+ Rule: seriesNumber SHALL only be present if seriesUid is present
+ Rule: instance SHALL only be present if seriesUid is present
+ Rule: imageRegion3D SHALL only be present if frameOfReferenceUid is present
+ Rule: imageRegion3D SHALL only be present if instance.imageRegion2D is not present
+ Rule: if present, instance.imageRegion2D.coordinate shall have a value count that is a multiple of 2
+ Rule: if present, imageRegion3D.coordinate shall have a value count that is a multiple of 3
+ Rule: modality SHALL only be present if seriesUid is present

Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier Σ 0..* Identifier Business Identifiers for Imaging Selection

... status ?!Σ 1..1 code available | entered-in-error | inactive | unknown
Binding: Imaging Selection Status (Required)
... category Σ 0..* CodeableConcept Classifies the imaging selection
Binding: KeyObjectSelectionDocumentTitle icon (Preferred)

... code Σ 1..1 CodeableConcept Imaging Selection purpose text or code
Binding: KeyObjectSelectionDocumentTitle icon (Example)
... subject Σ 0..1 Reference(Patient | Group | Device | Procedure | Practitioner | Medication | Substance | Specimen) Subject of the selected instances
... issued Σ 0..1 instant Date / Time when this imaging selection was created
... performer Σ 0..* BackboneElement Selectors of the instances (human or machine)

.... function Σ 0..1 CodeableConcept Type of performer
Binding: ImagingStudy series performer function (Extensible)
.... actor Σ 0..1 Reference(Practitioner | PractitionerRole | Device | Organization | CareTeam | Patient | RelatedPerson | HealthcareService) Author (human or machine)
... basedOn Σ 0..* Reference(CarePlan | ServiceRequest | Appointment | Task) Associated requests

... derivedFrom Σ 0..1 Reference(ImagingStudy | DocumentReference) The imaging study from which the imaging selection is derived
... studyUid ΣC 0..1 id DICOM Study Instance UID
... seriesUid ΣC 0..1 id DICOM Series Instance UID
... seriesNumber ΣC 0..1 unsignedInt DICOM Series Number
... frameOfReferenceUid ΣC 0..1 id The Frame of Reference UID for the selected images
... bodySite Σ 0..* CodeableReference(BodyStructure) Body part examined
Binding: SNOMED CT Body Structures (Example)

... focus Σ 0..* Reference(ImagingSelection) Related resources that are the focus for the imaging selection

... endpoint Σ 0..* Reference(Endpoint) The network services providing access for the images referenced in the imaging selection

... instance ΣC 0..* BackboneElement The selected instances

.... uid Σ 1..1 id DICOM SOP Instance UID
.... number Σ 0..1 unsignedInt DICOM Instance Number
.... sopClass 0..1 oid DICOM SOP Class UID
.... subset 0..* string The selected subset of the SOP Instance

.... imageRegion2D C 0..* BackboneElement A specific 2D region in a DICOM image / frame

..... regionType 1..1 code point | polyline | multipoint | circle | ellipse
Binding: Imaging Selection 2D Graphic Type (Required)
..... coordinate C 1..* decimal Specifies the coordinates that define the image region
This repeating element order: The values are an ordered set of (x, y) coordinates.
... imageRegion3D C 0..* BackboneElement A specific 3D region in a DICOM frame of reference

.... regionType 1..1 code point | multipoint | polyline | polygon | ellipse | ellipsoid
Binding: Imaging Selection 3D Graphic Type (Required)
.... coordinate C 1..* decimal Specifies the coordinates that define the image region
This repeating element order: The values are an ordered set of (x, y, z) coordinates.

doco Documentation for this format icon

See the Extensions for this resource

UML Diagram (Legend)

ImagingSelection (DomainResource)Unique identifiers assigned to this imaging selectionidentifier : Identifier [0..*]The current state of the imaging selection. This is distinct from the status of any imaging study, service request, or task associated with the imaging selection (this element modifies the meaning of other elements)status : code [1..1] « null (Strength=Required)ImagingSelectionStatus! »Classifies the general purpose of the imaging selectioncategory : CodeableConcept [0..*] « null (Strength=Preferred)KeyObjectSelectionDocumentTit...? »The distinct modality for this selected series. This may be either an acquisition modality (e.g. CT, MR) or a non-acquisition modality (e.g. segmentation, presentation state)modality : CodeableConcept [0..1] « null (Strength=Extensible)Modality+ » « This element has or is affected by some invariantsC »Identifies the type of imaging selectioncode : CodeableConcept [1..1] « null (Strength=Example)KeyObjectSelectionDocumentTit...?? »The patient, or group of patients, location, device, organization, procedure or practitioner this imaging selection is about and into whose or what record the imaging selection is placedsubject : Reference [0..1] « Patient|Group|Device|Procedure| Practitioner|Medication|Substance|Specimen »The date and time this imaging selection was createdissued : instant [0..1]A list of the diagnostic requests that resulted in this imaging selection being performedbasedOn : Reference [0..*] « CarePlan|ServiceRequest|Appointment| Task »The imaging study from which the imaging selection is madederivedFrom : Reference [0..1] « ImagingStudy|DocumentReference »The Study Instance UID for the DICOM Study from which the images were selectedstudyUid : id [0..1] « This element has or is affected by some invariantsC »The Series Instance UID for the DICOM Series from which the images were selectedseriesUid : id [0..1] « This element has or is affected by some invariantsC »The Series Number for the DICOM Series from which the images were selectedseriesNumber : unsignedInt [0..1] « This element has or is affected by some invariantsC »Uniquely identifies groups of composite instances that have the same coordinate system that conveys spatial and/or temporal informationframeOfReferenceUid : id [0..1] « This element has or is affected by some invariantsC »The anatomic structures examined. See [DICOM Part 16 Annex L](http://dicom.nema.org/medical/dicom/current/output/chtml/part16/chapter_L.html) for DICOM to SNOMED-CT mappingsbodySite : CodeableReference [0..*] « BodyStructure; Codes describing anatomical locations. May include laterality. (Strength=Example) SNOMEDCTBodyStructures?? »The actual focus of an imaging selection when it is another imaging selection resource and not the patient of recordfocus : Reference [0..*] « ImagingSelection »The network services providing access to the selected images, frames, etc. See implementation notes for information about using DICOM endpointsendpoint : Reference [0..*] « Endpoint »PerformerDistinguishes the type of involvement of the performerfunction : CodeableConcept [0..1] « null (Strength=Extensible)ImagingStudySeriesPerformerFu...+ »Author - human or machineactor : Reference [0..1] « Practitioner|PractitionerRole|Device| Organization|CareTeam|Patient|RelatedPerson|HealthcareService »InstanceThe SOP Instance UID for the selected DICOM instanceuid : id [1..1]The Instance Number for the selected DICOM instancenumber : unsignedInt [0..1]The SOP Class UID for the selected DICOM instancesopClass : oid [0..1]Selected subset of the SOP Instance. The type of the subset item is determined by the `instance.sopClass` value. May be one of: - A list of frame numbers selected from a multiframe SOP Instance (See [DICOM PS 3.3 Table 10.3](https://dicom.nema.org/medical/dicom/current/output/chtml/part03/sect_10.3.html#table_10-3)). - A list of Referenced Content Item Identifier values selected from a DICOM SR or other structured document SOP Instance (See [DICOM PS 3.3 C.17.3.2.5](https://dicom.nema.org/medical/dicom/current/output/chtml/part03/sect_C.17.3.2.5.html)). - A list of segment numbers selected from a segmentation SOP Instance (See [DICOM PS 3.3 Table C.8.20-4](https://dicom.nema.org/medical/dicom/current/output/chtml/part03/sect_C.8.20.4.html#table_C.8.20-4)). - A list of Region of Interest (ROI) numbers selected from a radiotherapy structure set SOP Instance (See [DICOM PS 3.3 C.8.8.5](https://dicom.nema.org/medical/dicom/current/output/chtml/part03/sect_C.8.8.5.html))subset : string [0..*]ImageRegion2DSpecifies the type of image regionregionType : code [1..1] « null (Strength=Required)ImagingSelection2DGraphicType! »The coordinates describing the image region. Encoded as a set of (column, row) pairs that denote positions in the selected image / frames specified with sub-pixel resolution. The origin at the TLHC of the TLHC pixel is 0.0\0.0, the BRHC of the TLHC pixel is 1.0\1.0, and the BRHC of the BRHC pixel is the number of columns\rows in the image / frames. The values SHALL be within the range 0\0 to the number of columns\rows in the image / framescoordinate : decimal [1..*] « This element has or is affected by some invariantsC »ImageRegion3DSpecifies the type of image regionregionType : code [1..1] « null (Strength=Required)ImagingSelection3DGraphicType! »The coordinates describing the image region. Encoded as an ordered set of (x,y,z) triplets (in mm and MAY be negative) that define a region of interest in the patient-relative Reference Coordinate System defined by ImagingSelection.frameOfReferenceUid elementcoordinate : decimal [1..*] « This element has or is affected by some invariantsC »Selectors of the instances – human or machineperformer[0..*]Each imaging selection instance or frame list might includes an image region, specified by a region type and a set of 2D coordinatesimageRegion2D[0..*]Each imaging selection includes one or more selected DICOM SOP instancesinstance[0..*]Each imaging selection might includes a 3D image region, specified by a region type and a set of 3D coordinatesimageRegion3D[0..*]

XML Template

<ImagingSelection xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier Business Identifiers for Imaging Selection --></identifier>
 <status value="[code]"/><!-- 1..1 available | entered-in-error | inactive | unknown -->
 <category><!-- 0..* CodeableConcept Classifies the imaging selection icon --></category>
 <modality><!-- I 0..1 CodeableConcept The distinct modality icon --></modality>
 <code><!-- 1..1 CodeableConcept Imaging Selection purpose text or code icon --></code>
 <subject><!-- 0..1 Reference(Device|Group|Medication|Patient|Practitioner|
   Procedure|Specimen|Substance) Subject of the selected instances --></subject>
 <issued value="[instant]"/><!-- 0..1 Date / Time when this imaging selection was created -->
 <performer>  <!-- 0..* Selectors of the instances (human or machine) -->
  <function><!-- 0..1 CodeableConcept Type of performer --></function>
  <actor><!-- 0..1 Reference(CareTeam|Device|HealthcareService|Organization|
    Patient|Practitioner|PractitionerRole|RelatedPerson) Author (human or machine) --></actor>
 </performer>
 <basedOn><!-- 0..* Reference(Appointment|CarePlan|ServiceRequest|Task) Associated requests --></basedOn>
 <derivedFrom><!-- 0..1 Reference(DocumentReference|ImagingStudy) The imaging study from which the imaging selection is derived --></derivedFrom>
 <studyUid value="[id]"/><!-- I 0..1 DICOM Study Instance UID -->
 <seriesUid value="[id]"/><!-- I 0..1 DICOM Series Instance UID -->
 <seriesNumber value="[unsignedInt]"/><!-- I 0..1 DICOM Series Number -->
 <frameOfReferenceUid value="[id]"/><!-- I 0..1 The Frame of Reference UID for the selected images -->
 <bodySite><!-- 0..* CodeableReference(BodyStructure) Body part examined --></bodySite>
 <focus><!-- 0..* Reference(ImagingSelection) Related resources that are the focus for the imaging selection --></focus>
 <endpoint><!-- 0..* Reference(Endpoint) The network services providing access for the images referenced in the imaging selection --></endpoint>
 <instance>  <!-- I 0..* The selected instances -->
  <uid value="[id]"/><!-- 1..1 DICOM SOP Instance UID -->
  <number value="[unsignedInt]"/><!-- 0..1 DICOM Instance Number -->
  <sopClass value="[oid]"/><!-- 0..1 DICOM SOP Class UID -->
  <subset value="[string]"/><!-- 0..* The selected subset of the SOP Instance -->
  <imageRegion2D>  <!-- I 0..* A specific 2D region in a DICOM image / frame -->
   <regionType value="[code]"/><!-- 1..1 point | polyline | multipoint | circle | ellipse -->
   <coordinate value="[decimal]"/><!-- I 1..* Specifies the coordinates that define the image region -->
  </imageRegion2D>
 </instance>
 <imageRegion3D>  <!-- I 0..* A specific 3D region in a DICOM frame of reference -->
  <regionType value="[code]"/><!-- 1..1 point | multipoint | polyline | polygon | ellipse | ellipsoid -->
  <coordinate value="[decimal]"/><!-- I 1..* Specifies the coordinates that define the image region -->
 </imageRegion3D>
</ImagingSelection>

JSON Template

{doco
  "resourceType" : "ImagingSelection",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // Business Identifiers for Imaging Selection
  "status" : "<code>", // R!  available | entered-in-error | inactive | unknown
  "category" : [{ CodeableConcept }], // Classifies the imaging selection icon
  "modality" : { CodeableConcept }, // I The distinct modality icon
  "code" : { CodeableConcept }, // R!  Imaging Selection purpose text or code icon
  "subject" : { Reference(Device|Group|Medication|Patient|Practitioner|
   Procedure|Specimen|Substance) }, // Subject of the selected instances
  "issued" : "<instant>", // Date / Time when this imaging selection was created
  "performer" : [{ // Selectors of the instances (human or machine)
    "function" : { CodeableConcept }, // Type of performer
    "actor" : { Reference(CareTeam|Device|HealthcareService|Organization|
    Patient|Practitioner|PractitionerRole|RelatedPerson) } // Author (human or machine)
  }],
  "basedOn" : [{ Reference(Appointment|CarePlan|ServiceRequest|Task) }], // Associated requests
  "derivedFrom" : { Reference(DocumentReference|ImagingStudy) }, // The imaging study from which the imaging selection is derived
  "studyUid" : "<id>", // I DICOM Study Instance UID
  "seriesUid" : "<id>", // I DICOM Series Instance UID
  "seriesNumber" : "<unsignedInt>", // I DICOM Series Number
  "frameOfReferenceUid" : "<id>", // I The Frame of Reference UID for the selected images
  "bodySite" : [{ CodeableReference(BodyStructure) }], // Body part examined
  "focus" : [{ Reference(ImagingSelection) }], // Related resources that are the focus for the imaging selection
  "endpoint" : [{ Reference(Endpoint) }], // The network services providing access for the images referenced in the imaging selection
  "instance" : [{ // I The selected instances
    "uid" : "<id>", // R!  DICOM SOP Instance UID
    "number" : "<unsignedInt>", // DICOM Instance Number
    "sopClass" : "<oid>", // DICOM SOP Class UID
    "subset" : ["<string>"], // The selected subset of the SOP Instance
    "imageRegion2D" : [{ // I A specific 2D region in a DICOM image / frame
      "regionType" : "<code>", // R!  point | polyline | multipoint | circle | ellipse
      "coordinate" : [<decimal>] // I R!  Specifies the coordinates that define the image region
    }]
  }],
  "imageRegion3D" : [{ // I A specific 3D region in a DICOM frame of reference
    "regionType" : "<code>", // R!  point | multipoint | polyline | polygon | ellipse | ellipsoid
    "coordinate" : [<decimal>] // I R!  Specifies the coordinates that define the image region
  }]
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:ImagingSelection;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:identifier  ( [ Identifier ] ... ) ; # 0..* Business Identifiers for Imaging Selection
  fhir:status [ code ] ; # 1..1 available | entered-in-error | inactive | unknown
  fhir:category  ( [ CodeableConcept ] ... ) ; # 0..* Classifies the imaging selection
  fhir:modality [ CodeableConcept ] ; # 0..1 I The distinct modality
  fhir:code [ CodeableConcept ] ; # 1..1 Imaging Selection purpose text or code
  fhir:subject [ Reference(Device|Group|Medication|Patient|Practitioner|Procedure|Specimen|Substance) ] ; # 0..1 Subject of the selected instances
  fhir:issued [ instant ] ; # 0..1 Date / Time when this imaging selection was created
  fhir:performer ( [ # 0..* Selectors of the instances (human or machine)
    fhir:function [ CodeableConcept ] ; # 0..1 Type of performer
    fhir:actor [ Reference(CareTeam|Device|HealthcareService|Organization|Patient|Practitioner|
  PractitionerRole|RelatedPerson) ] ; # 0..1 Author (human or machine)
  ] ... ) ;
  fhir:basedOn  ( [ Reference(Appointment|CarePlan|ServiceRequest|Task) ] ... ) ; # 0..* Associated requests
  fhir:derivedFrom [ Reference(DocumentReference|ImagingStudy) ] ; # 0..1 The imaging study from which the imaging selection is derived
  fhir:studyUid [ id ] ; # 0..1 I DICOM Study Instance UID
  fhir:seriesUid [ id ] ; # 0..1 I DICOM Series Instance UID
  fhir:seriesNumber [ unsignedInt ] ; # 0..1 I DICOM Series Number
  fhir:frameOfReferenceUid [ id ] ; # 0..1 I The Frame of Reference UID for the selected images
  fhir:bodySite  ( [ CodeableReference(BodyStructure) ] ... ) ; # 0..* Body part examined
  fhir:focus  ( [ Reference(ImagingSelection) ] ... ) ; # 0..* Related resources that are the focus for the imaging selection
  fhir:endpoint  ( [ Reference(Endpoint) ] ... ) ; # 0..* The network services providing access for the images referenced in the imaging selection
  fhir:instance ( [ # 0..* I The selected instances
    fhir:uid [ id ] ; # 1..1 DICOM SOP Instance UID
    fhir:number [ unsignedInt ] ; # 0..1 DICOM Instance Number
    fhir:sopClass [ oid ] ; # 0..1 DICOM SOP Class UID
    fhir:subset  ( [ string ] ... ) ; # 0..* The selected subset of the SOP Instance
    fhir:imageRegion2D ( [ # 0..* I A specific 2D region in a DICOM image / frame
      fhir:regionType [ code ] ; # 1..1 point | polyline | multipoint | circle | ellipse
      fhir:coordinate  ( [ decimal ] ... ) ; # 1..* I Specifies the coordinates that define the image region
    ] ... ) ;
  ] ... ) ;
  fhir:imageRegion3D ( [ # 0..* I A specific 3D region in a DICOM frame of reference
    fhir:regionType [ code ] ; # 1..1 point | multipoint | polyline | polygon | ellipse | ellipsoid
    fhir:coordinate  ( [ decimal ] ... ) ; # 1..* I Specifies the coordinates that define the image region
  ] ... ) ;
]

Changes from both R4 and R4B

This resource did not exist in Release R4

See the Full Difference for further information

This analysis is available for R4 as XML or JSON and for R4B as XML or JSON.

 

Additional definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) + see the extensions, the spreadsheet version & the dependency analysis

Path ValueSet Type Documentation
ImagingSelection.status ImagingSelectionStatus Required

The status of the ImagingSelection.

ImagingSelection.category KeyObjectSelectionDocumentTitle icon Preferred

Transitive closure of CID 7010 KeyObjectSelectionDocumentTitle

ImagingSelection.modality Modality icon Extensible

Transitive closure of CID 33 Modality

ImagingSelection.code KeyObjectSelectionDocumentTitle icon Example

Transitive closure of CID 7010 KeyObjectSelectionDocumentTitle

ImagingSelection.performer.function ImagingStudySeriesPerformerFunction Extensible

Performer function of an agent in an imaging study series

ImagingSelection.bodySite SNOMEDCTBodyStructures Example

This value set includes all codes from SNOMED CT icon where concept is-a 442083009 (Anatomical or acquired body site (body structure)).

ImagingSelection.instance.imageRegion2D.regionType ImagingSelection2DGraphicType Required

The type of 2D coordinates describing a 2D image region.

ImagingSelection.imageRegion3D.regionType ImagingSelection3DGraphicType Required

The type of coordinates describing a 3D image region.

UniqueKeyLevelLocationDescriptionExpression
img isl-1Rule (base)At least one of seriesUid or imageRegion3D shall be presentseriesUid.exists() or imageRegion3D.exists()
img isl-2Rule (base)seriesUid SHALL only be present if studyUid is presentseriesUid.exists() implies studyUid.exists()
img isl-3Rule (base)seriesNumber SHALL only be present if seriesUid is presentseriesNumber.exists() implies seriesUid.exists()
img isl-4Rule (base)instance SHALL only be present if seriesUid is presentinstance.exists() implies seriesUid.exists()
img isl-5Rule (base)imageRegion3D SHALL only be present if frameOfReferenceUid is presentimageRegion3D.exists() implies frameOfReferenceUid.exists()
img isl-6Rule (base)imageRegion3D SHALL only be present if instance.imageRegion2D is not presentimageRegion3D.exists() implies instance.imageRegion2D.empty()
img isl-7Rule (base)if present, instance.imageRegion2D.coordinate shall have a value count that is a multiple of 2instance.imageRegion2D.coordinate.exists() implies instance.imageRegion2D.coordinate.count() mod 2 = 0
img isl-8Rule (base) if present, imageRegion3D.coordinate shall have a value count that is a multiple of 3imageRegion3D.coordinate.exists() implies imageRegion3D.coordinate.count() mod 3 = 0
img isl-9Rule (base)modality SHALL only be present if seriesUid is presentmodality.exists() implies seriesUid.exists()

Some DICOM SOP Instances contain multiple sub-resources, such as frames, segments, etc.

An Imaging Selection resource MAY specify the subset of these that are included in the selection using the instance.subset element.

The defined types of subsets are:

  • Frames selected from a multiframe SOP Instance
    • Corresponds to the value of DICOM Referenced Frame Number (0008,1160)
    • Each value specifies a frame included in the selection
    • Note: Frame number is implicit and the first frame is denoted as frame 1
  • Referenced Content Item Identifiers selected from a DICOM SR or other structured document SOP Instance
    • Corresponds to the value of DICOM Referenced Content Item Identifier (0040,DB73)
    • Each value specifies the node in the DICOM SR tree that is selected at each level
    • See DICOM PS 3.3 C.17.3.2.5
  • Segments selected from a segmentation SOP Instance
    • Corresponds to the value of DICOM Referenced Segment Number (0062,000B)
    • Each value specifies a segment included in the selection
  • Regions of interest selected from a radiotherapy structure set SOP Instance
    • Corresponds to the value of DICOM Referenced ROI Number (0002,000E)
    • Each value specifies a region of interest included in the selection

The type of subset is determined by the SOP Class UID of the parent instance, which is specified by the instance.sopClass element.

For example:

  • If instance.sopClass has a value of urn:oid:1.2.840.10008.5.1.4.1.1.2.1, this indicates that the instance is Enhanced CT, which is a multiframe image instance and therefore instance.subset contains a list of frames
  • If instance.sopClass has a value of urn:oid:1.2.840.10008.5.1.4.1.1.88.22, this indicates that the instance is Enhanced SR and therefore instance.subset contains a list of content item identifiers

Note: Because an imaging selection instance is limited to a single DICOM Series and each DICOM Series can contain only one type of instance - image, SR document, radiotherapy object, etc. - each imaging selection instance can only contain one type of subset.

The code and category element can be used to provide information relevant for applications that want to identify specific types of ImagingSelection resources.

For example, if an ImagingSelection is used to identify a set of images that make up a volume rendered view, the code could contain a code indicating Volume Rendering - such as RadLex RID35862 - and the category could contain values of the DICOM Image Type (0008,0008) attribute - such as DERVIED and SECONDARY.

  {
    "resource": {
      "resourceType": "ImagingSelection",
      "id": "fa8e0948175f3117a3b8c4be2ff972ec",
      "subject": {
        "reference": "Patient/acb045960122378999c97cd7ca532f8b"
      },
      "code": {
        "coding": [
          {
            "system": "http://radlex.org/",
            "code": "RID12769",
            "display": "volume rendering"
          }
        ]
      },
      "category": [
        {
          "text": "DERIVED"
        },
        {
          "text": "SECONDARY"
        }
      ]
    }
  }

This section outlines several imaging selection types, each listing a set of resource elements that are required and/or typically present in the selection. Some types require only a minimal set of elements, while others require a comprehensive list to ensure clarity.

An imaging selection that points to one single-frame image requires:

  • studyUid to identify the DICOM Study that contains the image
  • seriesUid to identify the Series within the Study that contains the image
  • instance containing a single entry that specifies:
    • uid to identify the SOP Instance UID of the selected image

While not required, this type of selection typically includes:

  • frameOfReferenceUid to identify the coordinate system of the image
  • instance.sopClass to specify the SOP Class UID of the selected image

See Single-Frame Image Selection example.

An imaging selection that points to frames in a multiframe image requires:

  • studyUid to identify the DICOM Study that contains the image
  • seriesUid to identify the Series within the Study that contains the image
  • instance containing a single entry that specifies:
    • uid to identify the SOP Instance UID of the selected image
    • subset to identify the list of frames includes in the selection

While not required, this type of selection typically includes:

  • frameOfReferenceUid to identify the coordinate system of the image
  • instance.sopClass to specify the SOP Class UID of the selected image

See Multiframe Image Selection example.

An imaging selection that points to a 2D region on an image requires:

  • studyUid to identify the DICOM Study that contains the image
  • seriesUid to identify the Series within the Study that contains the image
  • instance containing a single entry that specifies:
    • uid to identify the SOP Instance UID of the selected image
    • imageRegion2D containing
      • regionType specifying the type of image region
      • coordinate specifying the x and y coordinates that define the image region in image pixel space

While not required, this type of selection typically includes:

  • frameOfReferenceUid to identify the coordinate system of the image
  • instance.sopClass to specify the SOP Class UID of the selected image

See 2D Image Region Selection example.

An imaging selection that points to a 3D region requires:

  • frameOfReferenceUid to identify the coordinate system that includes the specified coordinates
  • imageRegion3D containing
    • regionType specifying the type of image region
    • coordinate specifying the x, y and z coordinates that define the 3D region

This type of selection may also specify a set of images but this is not required. The 3D region selection can be applied to any images that share the same Frame of Reference UID.

See 3D Image Region Selection example.

The ImagingSelection.endpoint elements indicate network services that can be used to access the imaging data referenced by the imaging selection; for example, a DICOM WADO-RS server. Systems can determine if the relevant imaging data is available or offline by interacting with the endpoint.

Different Endpoint connection types MAY have different capabilities, protocols or requirements. Furthermore, the specified Endpoint.address identifies the DICOM Web Service Base URI (see DICOM PS 3.18 Section 8.2 icon ). The URL needed to retrieve image data may need to be constructed from this base URL. See below for the details on use of imaging-related Endpoint connection types.

An Endpoint.connectionType of code dicom-wado-rs, system http://terminology.hl7.org/CodeSystem/endpoint-connection-type, identifies a DICOM WADO-RS service.

The DICOM WADO-RS (Web Access to DICOM Objects, RESTful mode) service uses a RESTful approach to instance retrieval. This service allows for retrieval of native DICOM SOP instances, or instances “rendered” into other formats, including JPEG and MPEG. The media type of a response is specified by the request Accept header (preferred); or, by the accept query parameters. Supported media types depend on the capabilities of the WADO-RS server and the classification of the instance as "single frame", "multi-frame", "video", "text", or "other". The WADO-RS service also allows retrieval of study or series level information.

The path to retrieve a DICOM instance is constructed by appending the appropriate sub-resource paths to the Endpoint.address value.

For example, using the following information in a fictional ImagingSelection resource:

  • the WADO-RS service base url of https://pacs.hospital.org/wado-rs found in an ImagingSelection.endpoint.address,
  • the DICOM Study Instance UID of 1.2.250.1.59.40211.12345678.678910 found in an ImagingSelection.identifier having Identifier.system of “urn:dicom:uid”,
  • the DICOM Series Instance UID of 1.2.250.1.59.40211.789001276.14556172.67789 found in ImagingSelection.series.uid, and
  • the DICOM SOP Instance UID of 1.2.250.1.59.40211.2678810.87991027.899772.2 found in ImagingSelection.series.instance.uid
we can construct the WADO-RS URL to issue an HTTP GET for a native DICOM PS3.10 instance file (if consistent with the Accept header):


https://pacs.hospital.org/wado-rs/studies/1.2.250.1.59.40211.12345678.678910/series/1.2.250.1.59.40211.789001276.14556172.67789/instances/1.2.250.1.59.40211.2678810.87991027.899772.2

An Endpoint.connectionType of code dicom-wado-uri, system http://terminology.hl7.org/CodeSystem/endpoint-connection-type, identifies a DICOM WADO-URI service.

The DICOM WADO-URI (Web Access to DICOM Objects, URI mode) service uses HTTP query parameter syntax. This service allows for retrieval of native DICOM instances, or instances “rendered” into other formats, including JPEG and MPEG. The media type of a response is specified by the request Accept header (preferred); or, by the contentType query parameter. Supported media types depend on the classification of the instance as "single frame", "multi-frame", "video", "text", or "other."

The query to retrieve a DICOM instance is constructed by appending the appropriate query parameters to the Endpoint.address value.

For example, using the following information in a fictional ImagingSelection resource:

  • the WADO-URI service base url of https://pacs.hospital.org/wado-uri found in an ImagingSelection.endpoint.address,
  • the DICOM Study Instance UID of 1.2.250.1.59.40211.12345678.678910 found in an ImagingSelection.identifier having Identifier.system of urn:dicom:uid,
  • the DICOM Series Instance UID of 1.2.250.1.59.40211.789001276.14556172.67789 found in ImagingSelection.series.uid, and
  • the DICOM SOP Instance UID of 1.2.250.1.59.40211.2678810.87991027.899772.2 found in ImagingSelection.series.instance.uid
we can construct the WADO-URI URL to issue an HTTP GET for a native DICOM PS3.10 instance file (if consistent with the Accept header):


https://pacs.hospital.org/wado-uri?requestType=WADO&studyUID=1.2.250.1.59.40211.12345678.678910&seriesUID=1.2.250.1.59.40211.789001276.14556172.67789&objectUID=1.2.250.1.59.40211.2678810.87991027.899772.2

Search parameters for this resource. See also the full list of search parameters for this resource, and check the Extensions registry for search parameters on extensions related to this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

Name Type Description Expression In Common
based-on reference The request associated with an imaging selection ImagingSelection.basedOn
(Appointment, CarePlan, Task, ServiceRequest)
body-site token The body site code associated with the imaging selection ImagingSelection.bodySite.concept
body-structure reference The body structure associated with the imaging selection ImagingSelection.bodySite.reference
category token The imaging selection category ImagingSelection.category
code token The imaging selection description text or code ImagingSelection.code 21 Resources
derived-from reference The imaging study from which the imaging selection was derived ImagingSelection.derivedFrom
(ImagingStudy, DocumentReference)
identifier token Identifiers for the imaging selection ImagingSelection.identifier 65 Resources
issued date The date / time the imaging selection was created ImagingSelection.issued
modality token The modality of the selection ImagingSelection.modality
patient reference Who the study is about ImagingSelection.subject.where(resolve() is Patient)
(Patient)
65 Resources
status token The status of the imaging selection ImagingSelection.status
study-uid token The DICOM Study Instance UID from which the images were selected ImagingSelection.studyUid
subject reference The subject of the Imaging Selection, such as the associated Patient ImagingSelection.subject
(Practitioner, Group, Specimen, Device, Medication, Patient, Procedure, Substance)