Data Model Libraries
    Preparing search index...

    Class BodyStructureIncludedStructureComponent

    BodyStructureIncludedStructureComponent Class

    FHIR Specification

    • Short: Included anatomic location(s)
    • Definition: The anatomical location(s) or region(s) of the specimen, lesion, or body structure.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    structure: null | CodeableConcept

    BodyStructure.includedStructure.structure Element

    FHIR Specification

    • Short: Code that represents the included structure
    • Definition: Code that represents the included structure.
    • FHIR Type: CodeableConcept
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    laterality?: CodeableConcept

    BodyStructure.includedStructure.laterality Element

    FHIR Specification

    • Short: Code that represents the included structure laterality
    • Definition: Code that represents the included structure laterality.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    BodyStructure.includedStructure.bodyLandmarkOrientation Element

    FHIR Specification

    • Short: Landmark relative location
    • Definition: Body locations in relation to a specific body landmark (tatoo, scar, other body structure).
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    spatialReference?: Reference[]

    BodyStructure.includedStructure.spatialReference Element

    FHIR Specification

    qualifier?: CodeableConcept[]

    BodyStructure.includedStructure.qualifier Element

    FHIR Specification

    • Short: Code that represents the included structure qualifier
    • Definition: Code that represents the included structure qualifier.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR BodyStructureIncludedStructureComponent

      • OptionaloptSourceField: string

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

      Returns undefined | BodyStructureIncludedStructureComponent

      BodyStructureIncludedStructureComponent data model or undefined for BodyStructureIncludedStructureComponent

      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