Data Model Libraries
    Preparing search index...

    Class ImagingSelectionInstanceImageRegion3DComponent

    ImagingSelectionInstanceImageRegion3DComponent Class

    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.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    imagingselection3DgraphictypeEnum: Imagingselection3DgraphictypeEnum

    FHIR CodeSystem: Imagingselection3Dgraphictype

    regionType: null | EnumCodeType

    ImagingSelection.instance.imageRegion3D.regionType Element

    FHIR Specification

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

    CodeSystem Enumeration: Imagingselection3DgraphictypeEnum

    coordinate: null | DecimalType[]

    ImagingSelection.instance.imageRegion3D.coordinate Element

    FHIR Specification

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

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR ImagingSelectionInstanceImageRegion3DComponent

      • OptionaloptSourceField: string

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

      Returns undefined | ImagingSelectionInstanceImageRegion3DComponent

      ImagingSelectionInstanceImageRegion3DComponent data model or undefined for ImagingSelectionInstanceImageRegion3DComponent

      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