Data Model Libraries
    Preparing search index...

    ImagingSelectionInstanceComponent Class

    FHIR Specification

    • Short: The selected instances
    • Definition: Each imaging selection includes one or more selected DICOM SOP instances.
    • Requirements: Required if the the selection does not include all instances in the specified series.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    uid: null | IdType

    ImagingSelection.instance.uid Element

    FHIR Specification

    • Short: DICOM SOP Instance UID
    • Definition: The SOP Instance UID for the selected DICOM instance.
    • Comment: See DICOM PS3.3 C.12.1.
    • Requirements: DICOM SOP Instance UID.
    • FHIR Type: id
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true

    ImagingSelection.instance.number Element

    FHIR Specification

    • Short: DICOM Instance Number
    • Definition: The Instance Number for the selected DICOM instance.
    • Comment: 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.
    • FHIR Type: unsignedInt
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    sopClass?: Coding

    ImagingSelection.instance.sopClass Element

    FHIR Specification

    • Short: DICOM SOP Class UID
    • Definition: The SOP Class UID for the selected DICOM instance.
    • Comment: See DICOM PS3.3 C.12.1.
    • Requirements: DICOM SOP Class UID.
    • FHIR Type: Coding
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    subset?: StringType[]

    ImagingSelection.instance.subset Element

    FHIR Specification

    • Short: The selected subset of the SOP Instance
    • 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.
    • FHIR Type: string
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    ImagingSelection.instance.imageRegion2D Element

    FHIR Specification

    • Short: A specific 2D region in a DICOM image / frame
    • 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.
    • Requirements: Shall not be present if the parent imagingSelection.instance is not an image.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    ImagingSelection.instance.imageRegion3D Element

    FHIR Specification

    • Short: A specific 3D region in a DICOM frame of reference
    • Definition: Each imaging selection might includes a 3D image region, specified by a region type and a set of 3D coordinates.
    • Requirements: Requires that the ImagingSelection.frameOfReferenceUid element is present.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

    • Parse the provided ImagingSelectionInstanceComponent JSON to instantiate the ImagingSelectionInstanceComponent data model.

      Parameters

      • sourceJson: Value

        JSON representing FHIR ImagingSelectionInstanceComponent

      • OptionaloptSourceField: string

        Optional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to ImagingSelectionInstanceComponent

      Returns undefined | ImagingSelectionInstanceComponent

      ImagingSelectionInstanceComponent data model or undefined for ImagingSelectionInstanceComponent

      JsonError if the provided JSON is not a valid JSON object

    • Determines if the modifierExtension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url; false otherwise

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the modifierExtension property exists and has any values.

      AssertionError for invalid url

    • Returns undefined | string

      the id property value

    • Assigns the provided value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid value

    • Returns boolean

      true if id exists and has a value; false otherwise

    • Determines if the extension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url; false otherwise

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

      AssertionError for invalid url

    • Determines if the extension property exists.

      Parameters

      • url: string

        the url that identifies a specific Extension

      Returns undefined | IExtension

      an Extension having the provided url

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

      AssertionError for invalid url

    • Adds the provided Extension to the extension property array.

      Parameters

      • extension: undefined | IExtension

        the Extension value to add to the extension property array

      Returns this

      this

    • Removes the Extension having the provided url from the extension property array.

      Parameters

      • url: string

        the url that identifies a specific Extension to remove

      Returns void

      AssertionError for invalid url

    • Returns boolean

      true if the instance is a FHIR complex or primitive datatype; false otherwise