Data Model Libraries
    Preparing search index...

    Class ImagingSelectionInstanceImageRegion2DComponent

    ImagingSelectionInstanceImageRegion2DComponent Class

    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.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    imagingselection2DgraphictypeEnum: Imagingselection2DgraphictypeEnum

    FHIR CodeSystem: Imagingselection2Dgraphictype

    regionType: null | EnumCodeType

    ImagingSelection.instance.imageRegion2D.regionType Element

    FHIR Specification

    • Short: point | polyline | interpolated | circle | ellipse
    • Definition: Specifies the type of image region.
    • Comment: See DICOM PS3.3 C.10.5.1.2.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false

    CodeSystem Enumeration: Imagingselection2DgraphictypeEnum

    coordinate: null | DecimalType[]

    ImagingSelection.instance.imageRegion2D.coordinate Element

    FHIR Specification

    • Short: Specifies the coordinates that define the image region
    • 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.
    • Comment: For a description of how 2D coordinates are encoded, see DICOM PS3.3 C.18.6.
    • Requirements: The number of values must be a multiple of two.
    • FHIR Type: decimal
    • Cardinality: 1..*
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR ImagingSelectionInstanceImageRegion2DComponent

      • OptionaloptSourceField: string

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

      Returns undefined | ImagingSelectionInstanceImageRegion2DComponent

      ImagingSelectionInstanceImageRegion2DComponent data model or undefined for ImagingSelectionInstanceImageRegion2DComponent

      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