STU 3 Candidate

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

4.35.5 Resource ImagingObjectSelection - Detailed Descriptions

Detailed Descriptions for the elements in the ImagingObjectSelection resource.

ImagingObjectSelection
Definition

A manifest of a set of DICOM Service-Object Pair Instances (SOP Instances). The referenced SOP Instances (images or other content) are for a single patient, and may be from one or more studies. The referenced SOP Instances have been selected for a purpose, such as quality assurance, conference, or consult. Reflecting that range of purposes, typical ImagingObjectSelection resources may include all SOP Instances in a study (perhaps for sharing through a Health Information Exchange); key images from multiple studies (for reference by a referring or treating physician); a multi-frame ultrasound instance ("cine" video clip) and a set of measurements taken from that instance (for inclusion in a teaching file); and so on.

Control1..1
Requirements

A FHIR representation of DICOM Key Object Selection (KOS) SOP Instances enables access to a set of selected DICOM SOP Instances.

Alternate NamesManifest; XDS-I summary; Key Images; KOS
Summarytrue
ImagingObjectSelection.uid
Definition

Instance UID of the DICOM KOS SOP Instances represented in this resource.

Control1..1
Typeoid
Requirements

DICOM SOP Instance is always assigned with a unique identifier (UID).

Alternate NamesSOPInstanceUID
Summarytrue
ImagingObjectSelection.patient
Definition

A patient resource reference which is the patient subject of all DICOM SOP Instances in this ImagingObjectSelection.

Control1..1
TypeReference(Patient)
Requirements

SOP Instances in ImagingObjectSelection must be from the same patient.

Summarytrue
Comments

SOP instances selected in the ImagingObjectSelection can be from different studies, but must be of the same patient.

ImagingObjectSelection.authoringTime
Definition

Date and time when the selection of the referenced instances were made. It is (typically) different from the creation date of the selection resource, and from dates associated with the referenced instances (e.g. capture time of the referenced image).

Control0..1
TypedateTime
Requirements

Date and time when the selection was made can be important to understand the content of selection.

Alternate NamesObservationDateTime
Summarytrue
ImagingObjectSelection.author
Definition

Author of ImagingObjectSelection. It can be a human author or a device which made the decision of the SOP instances selected. For example, a radiologist selected a set of imaging SOP instances to attach in a diagnostic report, and a CAD application may author a selection to describe SOP instances it used to generate a detection conclusion.

Control0..1
TypeReference(Practitioner | Device | Organization | Patient | RelatedPerson)
Requirements

Track the selection decision maker.

Summarytrue
ImagingObjectSelection.title
Definition

The reason for, or significance of, the selection of objects referenced in the resource.

Control1..1
BindingKOStitle: The document title code of key object selection (Required)
TypeCodeableConcept
Requirements

Need to represent the application purpose that the SOP instances in ImagingObjectSelection are selected for.

Summarytrue
Comments

Coded concept of kind of the ImagingObjectSelection. Value set is defined in the DICOM standard Part 16, CID-7010.

ImagingObjectSelection.description
Definition

Text description of the DICOM SOP instances selected in the ImagingObjectSelection. This should be aligned with the content of the title element, and can provide further explanation of the SOP instances in the selection.

Control0..1
Typestring
Requirements

Need to provide a narrative description of the SOP instances in the selection.

Alternate NamesTextValue
Summarytrue
Comments

Free text narrative description of the ImagingObjectSelection.

ImagingObjectSelection.study
Definition

Study identity and locating information of the DICOM SOP instances in the selection.

Control1..*
Requirements

DICOM SOP instances are identified through the UIDs of the study - series - instance hierarchy. In addition, the locator at the study level provide a means of retrieving the entire study.

Summarytrue
Comments

Study component represents the study level identity and locator information of the DICOM SOP instances in the selection. It is the top level identity of the hierachical identification of the instances.

ImagingObjectSelection.study.uid
Definition

Study instance UID of the SOP instances in the selection.

Control1..1
Typeoid
Requirements

Study instance UID is required to fully identify the DICOM SOP instances in the selection.

Alternate NamesStudyInstanceUID; Referenced study instance UID
Summarytrue
ImagingObjectSelection.study.url
Definition

WADO-RS URL to retrieve the study. Note that this URL retrieves all SOP instances of the study, not only those in the selection.

Control0..1
Typeuri
Requirements

WADO-RS URL enables retrieval of the entire study using DICOM WADO-RS API.

Alternate NamesRetrieveURL
Summarytrue
Comments

Study level locator information is optional. If provided, this is the URL to retrieve the entire study with WADO-RS interaction, though only a subset of these are selected in the selection.

ImagingObjectSelection.study.imagingStudy
Definition

Reference to the Imaging Study in FHIR form.

Control0..1
TypeReference(ImagingStudy)
Requirements

Used to retrieve the ImagingStudy that contain the images referenced in the Imaging ObjectSelection.study.

Summarytrue
ImagingObjectSelection.study.series
Definition

Series identity and locating information of the DICOM SOP instances in the selection.

Control1..*
Requirements

DICOM SOP instances are identified through the UIDs of the study - series - instance hierarchy. In addition, the locator at the series level provide a means of retrieving the entire series.

Summarytrue
Comments

Series component represents the series level identity and locator information of the DICOM SOP instances in the selection.

ImagingObjectSelection.study.series.uid
Definition

Series instance UID of the SOP instances in the selection.

Control1..1
Typeoid
Requirements

Series instance UID is required to fully identify the DICOM SOP instances in the selection.

Alternate NamesSeriesInstanceUID; Referenced series instance UID
Summarytrue
ImagingObjectSelection.study.series.url
Definition

WADO-RS URL to retrieve the series. Note that this URL retrieves all SOP instances of the series not only those in the selection.

Control0..1
Typeuri
Requirements

WADO-RS URL enables retrieval of the entire series using DICOM WADO-RS API.

Alternate NamesRetrieveURL
Summarytrue
Comments

Series level locator information is optional. If provided, this is the URL to retrieve the entire series with WADO-RS interaction, though only a subset of these are selected in the selection.

ImagingObjectSelection.study.series.instance
Definition

Identity and locating information of the selected DICOM SOP instances.

Control1..*
Requirements

DICOM SOP instances are identified through the UIDs of the study - series - instance hierarchy. This is the instance level identity of the instance in the selection.

Summarytrue
Comments

SOP Instance component identify the instance selected, along with the study and series identities to form the DICOM identity hierachy.

ImagingObjectSelection.study.series.instance.sopClass
Definition

SOP class UID of the selected instance.

Control1..1
Typeoid
Requirements

DICOM SOP instances can be an image or other data object. The SOP class UID provide the accurate information about what type the instance is.

Alternate NamesSOPClassUID
Summarytrue
Comments

SOP class UID identifies the type of the selected instances, e.g. CT image, Gray scale softcopy presentation state, ECG waveform, etc.

ImagingObjectSelection.study.series.instance.uid
Definition

SOP Instance UID of the selected instance.

Control1..1
Typeoid
Requirements

SOP instance UID is required to fully identify the DICOM SOP instance in the selection.

Alternate NamesSOPInstanceUID; Referenced SOP instance UID
Summarytrue
Comments

SOP instance UID identifies the instance.

ImagingObjectSelection.study.series.instance.url
Definition

WADO-RS URL to retrieve the DICOM SOP Instance.

Control1..1
Typeuri
Requirements

WADO-RS URL enables retrieval of the SOP instance using DICOM WADO-RS API.

Alternate NamesRetrieveURL
Summarytrue
Comments

Instance level locator information is required.

ImagingObjectSelection.study.series.instance.frame
Definition

Identity and location information of the frames in the selected instance.

Control0..*
Requirements

The specific set of frames referenced in this imaging object selection. The URL retrieves the pixel data, and is encapsulated in a multipart MIME response.

Summarytrue
Comments

This component may be used if the referenced image SOP Instance is a multi-frame image.

ImagingObjectSelection.study.series.instance.frame.number
Definition

The specific frame reference within a multi-frame object.

Control1..*
TypeunsignedInt
Requirements

One or more non-duplicate frame numbers in the selected instance.

Alternate NamesFrameNumber
Summarytrue
ImagingObjectSelection.study.series.instance.frame.url
Definition

WADO-RS URL to retrieve the DICOM frames.

Control1..1
Typeuri
Requirements

WADO-RS URL enables retrieval of the frames using DICOM WADO-RS API.

Summarytrue
Comments

Frame level locator information is required.