type: resource-definitionsresource: ImagingSelection

ImagingSelection Definitions

ImagingSelection

A selection of DICOM SOP instances

Definition: A selection of DICOM SOP instances within a single Study and Series. This might include additional specifics such as a set of frames or an image region, allowing linkage to an Observation Resource.

Cardinality: 0..*

Constraints: isl-1 | error | At least one of seriesUid or imageRegion3D SHALL be present | seriesUid.exists() or imageRegion3D.exists(); isl-2 | error | seriesUid SHALL only be present if studyUid is present | seriesUid.exists() implies studyUid.exists(); isl-3 | error | seriesNumber SHALL only be present if seriesUid is present | seriesNumber.exists() implies seriesUid.exists(); isl-4 | error | instance SHALL only be present if seriesUid is present | instance.exists() implies seriesUid.exists(); isl-5 | error | imageRegion3D SHALL only be present if frameOfReferenceUid is present | imageRegion3D.exists() implies frameOfReferenceUid.exists(); isl-6 | error | imageRegion3D SHALL only be present if instance.imageRegion2D is not present | imageRegion3D.exists() implies instance.imageRegion2D.empty(); isl-7 | error | if present, instance.imageRegion2D.coordinate SHALL have a value count that is a multiple of 2 | instance.imageRegion2D.coordinate.exists() implies instance.imageRegion2D.coordinate.count() mod 2 = 0; isl-8 | error | if present, imageRegion3D.coordinate SHALL have a value count that is a multiple of 3 | imageRegion3D.coordinate.exists() implies imageRegion3D.coordinate.count() mod 3 = 0; isl-9 | error | modality SHALL only be present if seriesUid is present | modality.exists() implies seriesUid.exists(); isl-10 | error | only one of instance.frameNumber, instance.referencedContentItemIdentifier, instance.segmentNumber, instance.regionOfInterest and instance.waveFormChannel SHALL be present | (instance.frameNumber.exists() implies (instance.referencedContentItemIdentifier.exists() or instance.segmentNumber.exists() or instance.regionOfInterest.exists() or instance.waveFormChannel.exists()).not()) and (instance.referencedContentItemIdentifier.exists() implies (instance.frameNumber.exists() or instance.segmentNumber.exists() or instance.regionOfInterest.exists() or instance.waveFormChannel.exists()).not()) and (instance.segmentNumber.exists() implies (instance.frameNumber.exists() or instance.referencedContentItemIdentifier.exists() or instance.regionOfInterest.exists() or instance.waveFormChannel.exists()).not()) and (instance.regionOfInterest.exists() implies (instance.frameNumber.exists() or instance.referencedContentItemIdentifier.exists() or instance.segmentNumber.exists() or instance.waveFormChannel.exists()).not()) and (instance.waveFormChannel.exists() implies (instance.frameNumber.exists() or instance.referencedContentItemIdentifier.exists() or instance.segmentNumber.exists() or instance.regionOfInterest.exists()).not()); isl-11 | error | if present, instance.waveFormChannel SHALL have a value count that is a multiple of 2 | instance.waveFormChannel.exists() implies instance.waveFormChannel.count() mod 2 = 0

Mappings: workflow=Event; dicom=DICOM Tag Mapping; w5=clinical.diagnostics

ImagingSelection.identifier

Business identifier for imaging selection

Definition: Business identifiers assigned to this imaging selection by the performer and/or other systems. These identifiers remain constant as the resource is updated and propagates from server to server.

Comments: Note: This is a business identifier, not a resource identifier (see discussion). It is best practice for the identifier to only appear on a single resource instance, however business practices MAY occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.

Requirements: Allows identification of the imaging selection as it is known by various participating systems and in a way that remains consistent across servers.

Cardinality: 0..*

Type: Identifier

Summary: true

Mappings: workflow=Event.identifier; w5=FiveWs.identifier

ImagingSelection.status

available | entered-in-error | inactive | unknown

Definition: 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.

Comments: Unknown does not represent "other" - one of the defined statuses must apply. Unknown is used when the authoring system is not sure what the current status is.

Cardinality: 1..1

Type: code

Binding: required:imagingselection-status

Summary: true

Is Modifier: true (Reason: This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource SHOULD NOT be treated as valid)

Mappings: workflow=Event.status; w5=FiveWs.status

ImagingSelection.category

Classifies the imaging selection

Definition: Classifies the general purpose of the imaging selection.

Requirements: Used for filtering what imaging selections are retrieved and displayed.

Cardinality: 0..*

Type: CodeableConcept

Binding: preferred:sect_CID_7010.html

Summary: true

Mappings: workflow=Event.category; w5=FiveWs.class

ImagingSelection.modality

The distinct modality

Definition: 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).

Conditions: isl-9

Cardinality: 0..1

Type: CodeableConcept

Binding: extensible:sect_CID_33.html

Summary: true

Mappings: dicom=Modality (0008,0060)

ImagingSelection.code

Imaging Selection purpose text or code

Definition: Identifies the type of imaging selection.

Requirements: Identifies the type of content and the structure of the imaging selection.

Aliases: Description

Cardinality: 1..1

Type: CodeableConcept

Binding: preferred:image-reference-type

Summary: true

Mappings: workflow=Event.code; w5=FiveWs.what[x]; dicom=Concept Name Code Sequence (0040,A043)

ImagingSelection.subject

Who or what is the subject of the imaging selection

Definition: The subject, typically a patient, of the imaging selection.

Cardinality: 0..1

Type: Reference(Patient, Group, Device, Procedure, Practitioner, Medication, Substance, Specimen)

Summary: true

Mappings: workflow=Event.subject; w5=FiveWs.subject; dicom=Patient ID (0010,0020) and Issuer of Patient ID (0010,0021) and / or Issuer of Patient ID Qualifiers Sequence (0010,0024) and / or Patient Name (0010,0010)

ImagingSelection.issued

When the imaging selection was created

Definition: Date and time the imaging selection was created.

Cardinality: 0..1

Type: instant

Summary: true

Mappings: w5=FiveWs.recorded

ImagingSelection.performer

Who performed imaging selection and what they did

Definition: Indicates who or what performed the imaging selection and how they were involved.

Cardinality: 0..*

Type: BackboneElement

Summary: true

Mappings: dicom=One or more of: Performing Physician's Name (0008,1050) and Performing Physician Identification Sequence (0008,1052); Operators' Name (0008,1070) and Operator Identification Sequence (0008,1072); Manufacturer (0008,0070) and Manufacturer's Model Name (0008,1090); or Institution Name (0008,0080); workflow=Event.performer; w5=FiveWs.actor

ImagingSelection.performer.function

Type of performance

Definition: Distinguishes the type of involvement of the performer in the imaging selection.

Requirements: Allows disambiguation of the types of involvement of different performers.

Cardinality: 0..1

Type: CodeableConcept

Binding: extensible:series-performer-function

Summary: true

Mappings: workflow=Event.performer.function; dicom=PRF (Performing Physician's Name); SPRF (Operator's Name); DEV (Manufacturer / Manufacturer's Model Name); or LOC (Institution Name)

ImagingSelection.performer.actor

Who performed the imaging selection

Definition: Indicates who or what performed the imaging selection.

Cardinality: 1..1

Type: Reference(Practitioner, PractitionerRole, Device, Organization, CareTeam, Patient, RelatedPerson, HealthcareService)

Summary: true

Mappings: workflow=Event.performer.actor; dicom=Practitioner (Performing Physician's Name); Practitioner (Operator's Name); Device (Manufacturer / Manufacturer's Model Name); or Organization (Institution Name)

ImagingSelection.basedOn

Fulfills plan or order

Definition: A plan or order that is fulfilled in whole or in part by this imaging selection.

Requirements: Allows tracing of authorization for the imaging selection and tracking whether proposals/recommendations were acted upon. If the imaging selection is associated with an Accession Number, this field SHOULD include a reference to that value in the form: identifier.value = (Accession Number Value) identifier.type = ACSN. A reference value pointing to a ServiceRequest resource is allowed but is not required.

Aliases: AccessionNumber

Cardinality: 0..*

Type: Reference(CarePlan, ServiceRequest, Appointment, Task)

Summary: true

Mappings: workflow=Event.basedOn; w5=FiveWs.cause; dicom=Accession Number (0080,0050) and Issuer of Accession Number Sequence (0080,0051)

ImagingSelection.derivedFrom

The imaging study from which the imaging selection is derived

Definition: The imaging study from which the imaging selection is made.

Cardinality: 0..1

Type: Reference(ImagingStudy, DocumentReference)

Summary: true

ImagingSelection.studyUid

DICOM Study Instance UID

Definition: The Study Instance UID for the DICOM Study from which the images were selected.

Comments: See DICOM PS3.3 C.7.2.

Aliases: StudyInstanceUID

Conditions: isl-2

Cardinality: 0..1

Type: id

Summary: true

Mappings: dicom=Study Instance UID (0020,000D)

ImagingSelection.seriesUid

DICOM Series Instance UID

Definition: The DICOM Series Instance UID of the selected series.

Comments: See DICOM PS3.3 C.7.3.

Requirements: Must correspond to a Series that is part of the DICOM study identified by the studyUid element.

Aliases: SeriesInstanceUID

Conditions: isl-1, isl-2, isl-3, isl-4, isl-9

Cardinality: 0..1

Type: id

Summary: true

Mappings: dicom=Series Instance UID (0020,000E)

ImagingSelection.seriesNumber

Numeric identifier of the selected series

Definition: The numeric identifier of the selected series in the study.

Comments: See DICOM PS3.3 C.7.3.

Requirements: Must correspond to the series identified by the seriesUid element.

Aliases: SeriesNumber

Conditions: isl-3

Cardinality: 0..1

Type: unsignedInt

Summary: true

Mappings: dicom=Series Number (0020,0011)

ImagingSelection.frameOfReferenceUid

The Frame of Reference UID for the selected images

Definition: Identifier used to group composite instances that have the same coordinate system that conveys spatial and/or temporal information.

Comments: See DICOM PS3.3 C.7.4.1.

Aliases: FrameOfReferenceUID

Conditions: isl-5

Cardinality: 0..1

Type: id

Summary: true

Mappings: dicom=Frame of Reference UID (0020,0052)

ImagingSelection.bodySite

Selected anatomic structure

Definition: The anatomic structures selected. See DICOM Part 16 Annex L for DICOM to SNOMED-CT mappings. The bodySite MAY include the laterality of body part imaged.

Aliases: BodyPartExamined, AnatomicRegionSequence

Cardinality: 0..*

Type: CodeableReference

Binding: example:body-site

Summary: true

Mappings: dicom=Body Part Examined (0018,0015) or Anatomic Region Sequence (0008,2218) and Laterality (0020,0060)

ImagingSelection.focus

Related resources that are the focus for the imaging selection

Definition: The actual focus of an imaging selection when it is another imaging selection resource and not the patient of record.

Comments: An imaging selection MAY reference a DICOM resource that itself references other DICOM resources. e.g. a presentation state references a set of source images or frames.

Cardinality: 0..*

Type: Reference(ImagingSelection)

Summary: true

ImagingSelection.endpoint

The network services providing access for the subset of the study

Definition: The network services providing access to the selected images, frames, etc. See implementation notes for information about using DICOM endpoints.

Cardinality: 0..*

Type: Reference(Endpoint)

Summary: true

ImagingSelection.instance

The selected instances

Definition: Each imaging selection includes one or more selected DICOM SOP instances.

Requirements: If this element is not present and ImagingSelection.seriesUid is present, all instances in the specified series are included in the selection.

Conditions: isl-6, isl-4, isl-7, isl-10, isl-11

Cardinality: 0..*

Type: BackboneElement

Summary: true

ImagingSelection.instance.uid

DICOM SOP Instance UID

Definition: The SOP Instance UID for the selected DICOM this image or other DICOM content.

Comments: See DICOM PS3.3 C.12.1.

Requirements: DICOM SOP Instance UID. Must correspond to a SOP Instance that is part of the DICOM series identified by the seriesUID element.

Aliases: SOPInstanceUID

Cardinality: 1..1

Type: id

Summary: true

Mappings: dicom=SOP Instance UID (0008,0018)

ImagingSelection.instance.number

The number of this instance in the series

Definition: TThe number of the instance assigned by the creator of the series. MAY or MAY NOT correspond to intended display order.

Comments: See DICOM PS3.3 C.7.6.1. Note: A multiframe instance has a single instance number with each frame identified by a frame number.

Requirements: DICOM Instance Number. Must correspond to the SOP Instance identified by the uid element.

Aliases: InstanceNumber

Cardinality: 0..1

Type: unsignedInt

Summary: true

Mappings: dicom=Instance Number (0020,0011)

ImagingSelection.instance.sopClass

DICOM class type

Definition: DICOM instance type.

Comments: See DICOM PS3.3 C.12.1.

Aliases: SOPClassUID

Cardinality: 0..1

Type: oid

Mappings: dicom=SOP Class UID (0008,0016)

ImagingSelection.instance.frameNumber

Selected frames

Definition: A list of frame numbers selected from a multiframe SOP Instance (See DICOM PS 3.3 Table 10.3).

Requirements: Only allowed if the value of instance.sopClass corresponds to a multiframe SOP Class.

Conditions: isl-10

Cardinality: 0..*

Type: positiveInt

Summary: false

ImagingSelection.instance.referencedContentItemIdentifier

Selected content items

Definition: 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).

Requirements: Only allowed if the value of instance.sopClass corresponds to a DICOM SR or other structured document SOP Class.

Conditions: isl-10

Cardinality: 0..*

Type: positiveInt

Summary: false

ImagingSelection.instance.segmentNumber

Selected segments

Definition: A list of segment numbers selected from a segmentation SOP Instance (See DICOM PS 3.3 Table C.8.20-4).

Requirements: Only allowed if the value of instance.sopClass corresponds to a segmentation SOP Class.

Conditions: isl-10

Cardinality: 0..*

Type: positiveInt

Summary: false

ImagingSelection.instance.regionOfInterest

Selected regions of interest

Definition: 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).

Requirements: Only allowed if the value of instance.sopClass corresponds to a radiotherapy structure set SOP Class.

Conditions: isl-10

Cardinality: 0..*

Type: positiveInt

Summary: false

ImagingSelection.instance.waveFormChannel

Selected waveform channel

Definition: A list of channels in a Waveform selected from an instance of a waveform SOP Class. Each channel is specified as a pair of values where the first value is the Multiplex Group Number, and the second value is the Channel Number within the multiplex group (See DICOM PS 3.3 C.18.5.1.1).

Requirements: Only allowed if the value of instance.sopClass corresponds to a waveform structure set SOP Class.

Conditions: isl-10, isl-11

Cardinality: 0..*

Type: positiveInt

Summary: false

ImagingSelection.instance.imageRegion2D

A 2D region in an image

Definition: Specifies an image region, defined by a region type and a set of 2D coordinates in pixel space.

Requirements: SHALL NOT be present if the parent imagingSelection.instance is not an image. If the parent imagingSelection.instance contains a subset element of type frame, the image region applies to all frames in the subset list.

Conditions: isl-6, isl-7

Cardinality: 0..*

Type: BackboneElement

ImagingSelection.instance.imageRegion2D.regionType

point | polyline | multipoint | circle | ellipse

Definition: The type of image region.

Comments: See DICOM PS3.3 C.10.5.1.2.

Aliases: GraphicType

Cardinality: 1..1

Type: code

Binding: required:imagingselection-2dgraphictype

Mappings: dicom=Graphic Type (0070,0023)

ImagingSelection.instance.imageRegion2D.coordinate

The coordinates that define the image region

Definition: The coordinates defining 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 / frames.

Comments: For a description of how 2D coordinates are encoded, see DICOM PS 3.3 C.18.6.

Requirements: The number of values SHALL be a multiple of two.

Aliases: GraphicData

Conditions: isl-7

Cardinality: 1..*

Type: decimal

Mappings: dicom=Graphic Data (0070,0022)

ImagingSelection.imageRegion3D

A 3D region in a DICOM frame of reference

Definition: Specifies a 3D image region, defined by a region type and a set of 3D coordinates.

Requirements: The referenced 3D image region must be in the coordinate system identified by the frameOfReferenceUid element

Conditions: isl-1, isl-5, isl-6, isl-8

Cardinality: 0..*

Type: BackboneElement

ImagingSelection.imageRegion3D.regionType

Definition: Specifies the type of image region.

Comments: See DICOM PS3.3 C.18.9.1.2.

Aliases: GraphicType

Cardinality: 1..1

Type: code

Binding: required:imagingselection-3dgraphictype

Mappings: dicom=Graphic Type (0070,0023)

ImagingSelection.imageRegion3D.coordinate

Specifies the coordinates that define the image region

Definition: The coordinates defining 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 element.

Comments: For a description of how 3D coordinates are encoded, see DICOM PS3.3 C.18.9.

Requirements: The number of values SHALL be a multiple of three.

Aliases: GraphicData

Conditions: isl-8

Cardinality: 1..*

Type: decimal

Mappings: dicom=Graphic Data (0070,0022)