FHIR CI-Build

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

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

Detailed Descriptions for the elements in the ImagingSelection resource.

ImagingSelection
Element IdImagingSelection
Definition

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.

Short DisplayA selection of DICOM SOP instances and/or frames
Cardinality0..*
TypeDomainResource
Summaryfalse
ImagingSelection.identifier
Element IdImagingSelection.identifier
Definition

A unique identifier assigned to this imaging selection.

Short DisplayBusiness Identifier for Imaging Selection
NoteThis is a business identifier, not a resource identifier (see discussion)
Cardinality0..*
TypeIdentifier
Requirements

Allows imaging selections to be distinguished and referenced.

Summarytrue
Comments

This is a business identifier, not a resource identifier -- see discussion under Business Identifiers.

ImagingSelection.status
Element IdImagingSelection.status
Definition

The current state of the ImagingSelection resource. This is not the status of any ImagingStudy, ServiceRequest, or Task resources associated with the ImagingSelection.

Short Displayavailable | entered-in-error | unknown
Cardinality1..1
Terminology BindingImagingSelectionStatus (Required)
Typecode
Is Modifiertrue (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)
Summarytrue
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.

ImagingSelection.subject
Element IdImagingSelection.subject
Definition

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

Short DisplaySubject of the selected instances
Cardinality0..1
TypeReference(Patient | Group | Device | Location | Organization | Procedure | Practitioner | Medication | Substance | Specimen)
Summarytrue
ImagingSelection.issued
Element IdImagingSelection.issued
Definition

The date and time this imaging selection was created.

Short DisplayDate / Time when this imaging selection was created
Cardinality0..1
Typeinstant
Summarytrue
ImagingSelection.performer
Element IdImagingSelection.performer
Definition

Selector of the instances – human or machine.

Short DisplaySelector of the instances (human or machine)
Cardinality0..*
Summarytrue
ImagingSelection.performer.function
Element IdImagingSelection.performer.function
Definition

Distinguishes the type of involvement of the performer.

Short DisplayType of performer
Cardinality0..1
Terminology BindingImagingStudy series performer function (Extensible)
TypeCodeableConcept
Requirements

Allows disambiguation of the types and involvement of different performers.

Summarytrue
ImagingSelection.performer.actor
Element IdImagingSelection.performer.actor
Definition

Author – human or machine.

Short DisplayAuthor (human or machine)
Cardinality0..1
TypeReference(Practitioner | PractitionerRole | Device | Organization | CareTeam | Patient | RelatedPerson | HealthcareService)
Summarytrue
ImagingSelection.basedOn
Element IdImagingSelection.basedOn
Definition

A list of the diagnostic requests that resulted in this imaging selection being performed.

Short DisplayAssociated request
Cardinality0..*
TypeReference(CarePlan | ServiceRequest | Appointment | AppointmentResponse | Task)
Alternate NamesAccessionNumber
Summarytrue
ImagingSelection.category
Element IdImagingSelection.category
Definition

Classifies the imaging selection.

Short DisplayClassifies the imaging selection
Cardinality0..*
Terminology BindingKeyObjectSelectionDocumentTitle icon (Example)
TypeCodeableConcept
Requirements

Used for filtering what imaging selections are retrieved and displayed.

Summarytrue
ImagingSelection.code
Element IdImagingSelection.code
Definition

Reason for referencing the selected content.

Short DisplayImaging Selection purpose text or code
Cardinality1..1
Terminology BindingKeyObjectSelectionDocumentTitle icon (Example)
TypeCodeableConcept
Requirements

Knowing what kind of observation is being made is essential to understanding the observation.

Alternate NamesDescription
Summarytrue
Comments

All code-value and, if present, component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.

ImagingSelection.studyUid
Element IdImagingSelection.studyUid
Definition

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

Short DisplayDICOM Study Instance UID
Cardinality0..1
Typeid
Requirements

DICOM Study Instance UID. Required unless frameOfReferenceUid and imageRegion are present and instance is not present.

Alternate NamesStudyInstanceUID
Summarytrue
Comments

See DICOM PS3.3 C.7.2 icon.

ImagingSelection.derivedFrom
Element IdImagingSelection.derivedFrom
Definition

The imaging study from which the imaging selection is made.

Short DisplayThe imaging study from which the imaging selection is derived
Cardinality0..*
TypeReference(ImagingStudy | DocumentReference)
Summarytrue
ImagingSelection.endpoint
Element IdImagingSelection.endpoint
Definition

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

Short DisplayThe network service providing retrieval for the images referenced in the imaging selection
Cardinality0..*
TypeReference(Endpoint)
Requirements

Access methods for retrieving (e.g., DICOM’s WADO-URI and WADO-RS) the selected images, frames, etc.

Summarytrue
Comments

Typical endpoint types include DICOM WADO-RS, which is used to retrieve DICOM instances in native or rendered (e.g., JPG, PNG) formats using a RESTful API; DICOM WADO-URI, which can similarly retrieve native or rendered instances, except using an HTTP query-based approach.

ImagingSelection.seriesUid
Element IdImagingSelection.seriesUid
Definition

The Series Instance UID for the DICOM Series from which the images were selected.

Short DisplayDICOM Series Instance UID
Cardinality0..1
Typeid
Requirements

DICOM Series Instance UID. Required unless frameOfReferenceUid and imageRegion are present and instance is not present.

Alternate NamesSeriesInstanceUID
Summarytrue
Comments

See DICOM PS3.3 C.7.3 icon.

ImagingSelection.seriesNumber
Element IdImagingSelection.seriesNumber
Definition

The Series Number for the DICOM Series from which the images were selected.

Short DisplayDICOM Series Number
Cardinality0..1
TypeunsignedInt
Requirements

DICOM Series Number.

Alternate NamesSeriesNumber
Summarytrue
Comments

See DICOM PS3.3 C.7.3 icon.

ImagingSelection.frameOfReferenceUid
Element IdImagingSelection.frameOfReferenceUid
Definition

The Frame of Reference UID identifying the coordinate system that conveys spatial and/or temporal information for the selected images or frames.

Short DisplayThe Frame of Reference UID for the selected images
Cardinality0..1
Typeid
Requirements

DICOM Frame of Reference UID. Required if studyInstanceUid and seriesInstanceUid are not present.

Alternate NamesFrameOfReferenceUID
Summarytrue
Comments

See DICOM PS3.3 C.7.4.1 icon.

ImagingSelection.bodySite
Element IdImagingSelection.bodySite
Definition

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

Short DisplayBody part examined
Cardinality0..1
Terminology BindingSNOMED CT Body Structures (Example)
TypeCodeableReference(BodyStructure)
Alternate NamesBodyPartExamined
Summarytrue
ImagingSelection.focus
Element IdImagingSelection.focus
Definition

The actual focus of an observation when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor. For example, fetus observations in a mother's record. The focus of an observation could also be an existing condition, an intervention, the subject's diet, another observation of the subject, or a body structure such as tumor or implanted device. An example use case would be using the Observation resource to capture whether the mother is trained to change her child's tracheostomy tube. In this example, the child is the patient of record and the mother is the focus.

Short DisplayRelated resource that is the focus for the imaging selection
Cardinality0..*
TypeReference(ImagingSelection)
Summarytrue
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.

ImagingSelection.instance
Element IdImagingSelection.instance
Definition

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

Short DisplayThe selected instances
Cardinality0..*
Requirements

Required if the the selection does not include all instances in the specified series.

Summarytrue
ImagingSelection.instance.uid
Element IdImagingSelection.instance.uid
Definition

The SOP Instance UID for the selected DICOM instance.

Short DisplayDICOM SOP Instance UID
Cardinality1..1
Typeid
Requirements

DICOM SOP Instance UID.

Alternate NamesSOPInstanceUID
Summarytrue
Comments

See DICOM PS3.3 C.12.1 icon.

ImagingSelection.instance.number
Element IdImagingSelection.instance.number
Definition

The Instance Number for the selected DICOM instance.

Short DisplayDICOM Instance Number
Cardinality0..1
TypeunsignedInt
Requirements

DICOM Instance Number.

Alternate NamesInstanceNumber
Summarytrue
Comments

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

ImagingSelection.instance.sopClass
Element IdImagingSelection.instance.sopClass
Definition

The SOP Class UID for the selected DICOM instance.

Short DisplayDICOM SOP Class UID
Cardinality0..1
Terminology BindingsopClass icon:
TypeCoding
Requirements

DICOM SOP Class UID.

Alternate NamesSOPClassUID
Summaryfalse
Comments

See DICOM PS3.3 C.12.1 icon.

ImagingSelection.instance.subset
Element IdImagingSelection.instance.subset
Definition

Selected subset of the SOP Instance. The content and format of the subset item is determined by the SOP Class of the selected instance. May be one of: - A list of frame numbers selected from a multiframe SOP Instance. - A list of Content Item Observation UID values selected from a DICOM SR or other structured document SOP Instance. - A list of segment numbers selected from a segmentation SOP Instance. - A list of Region of Interest (ROI) numbers selected from a radiotherapy structure set SOP Instance.

Short DisplayThe selected subset of the SOP Instance
Cardinality0..*
Typestring
Summaryfalse
ImagingSelection.instance.imageRegion2D
Element IdImagingSelection.instance.imageRegion2D
Definition

Each imaging selection instance or frame list might includes an image region, specified by a region type and a set of 2D coordinates. If the parent imagingSelection.instance contains a subset element of type frame, the image region applies to all frames in the subset list.

Short DisplayA specific 2D region in a DICOM image / frame
Cardinality0..*
Requirements

Shall not be present if the parent imagingSelection.instance is not an image.

Summaryfalse
ImagingSelection.instance.imageRegion2D.regionType
Element IdImagingSelection.instance.imageRegion2D.regionType
Definition

Specifies the type of image region.

Short Displaypoint | polyline | interpolated | circle | ellipse
Cardinality1..1
Terminology BindingImagingSelection2DGraphicType (Required)
Typecode
Alternate NamesGraphicType
Summaryfalse
Comments

See DICOM PS3.3 C.10.5.1.2 icon.

ImagingSelection.instance.imageRegion2D.coordinate
Element IdImagingSelection.instance.imageRegion2D.coordinate
Definition

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 must be within the range 0\0 to the number of columns\rows in the image / frames.

Short DisplaySpecifies the coordinates that define the image region
Cardinality1..*
Typedecimal
Element Order MeaningThe values are an ordered set of (x, y) coordinates.
Requirements

The number of values must be a multiple of two.

Alternate NamesGraphicData
Summaryfalse
Comments

For a description of how 2D coordinates are encoded, see DICOM PS3.3 C.18.6 icon.

ImagingSelection.instance.imageRegion3D
Element IdImagingSelection.instance.imageRegion3D
Definition

Each imaging selection might includes a 3D image region, specified by a region type and a set of 3D coordinates.

Short DisplayA specific 3D region in a DICOM frame of reference
Cardinality0..*
Requirements

Requires that the ImagingSelection.frameOfReferenceUid element is present.

Summaryfalse
ImagingSelection.instance.imageRegion3D.regionType
Element IdImagingSelection.instance.imageRegion3D.regionType
Definition

Specifies the type of image region.

Short Displaypoint | multipoint | polyline | polygon | ellipse | ellipsoid
Cardinality1..1
Terminology BindingImagingSelection3DGraphicType (Required)
Typecode
Alternate NamesGraphicType
Summaryfalse
Comments

See DICOM PS3.3 C.18.9.1.2 icon.

ImagingSelection.instance.imageRegion3D.coordinate
Element IdImagingSelection.instance.imageRegion3D.coordinate
Definition

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

Short DisplaySpecifies the coordinates that define the image region
Cardinality1..*
Typedecimal
Element Order MeaningThe values are an ordered set of (x, y, z) coordinates.
Requirements

The number of values must be a multiple of three.

Alternate NamesGraphicData
Summaryfalse
Comments

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