Data Model Libraries
    Preparing search index...

    Class BodyStructureIncludedStructureBodyLandmarkOrientationComponent

    BodyStructureIncludedStructureBodyLandmarkOrientationComponent Class

    FHIR Specification

    • Short: Landmark relative location
    • Definition: Body locations in relation to a specific body landmark (tatoo, scar, other body structure).

    FHIR BodyStructure

    Hierarchy (View Summary)

    • BackboneElement
      • BodyStructureIncludedStructureBodyLandmarkOrientationComponent

    Implements

    Index

    Constructors

    constructor

    Properties

    landmarkDescription? clockFacePosition? distanceFromLandmark? surfaceOrientation?

    Methods

    parse getLandmarkDescription setLandmarkDescription addLandmarkDescription hasLandmarkDescription getClockFacePosition setClockFacePosition addClockFacePosition hasClockFacePosition getDistanceFromLandmark setDistanceFromLandmark addDistanceFromLandmark hasDistanceFromLandmark getSurfaceOrientation setSurfaceOrientation addSurfaceOrientation hasSurfaceOrientation fhirType isEmpty copy toJSON getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension getId setId hasId getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension isRequiredFieldsEmpty isResource isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initLandmarkDescription initClockFacePosition initDistanceFromLandmark initSurfaceOrientation

    Constructors

    Properties

    landmarkDescription?: CodeableConcept[]

    BodyStructure.includedStructure.bodyLandmarkOrientation.landmarkDescription Element

    FHIR Specification

    • Short: Body ]andmark description
    • Definition: A description of a landmark on the body used as a reference to locate something else.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    clockFacePosition?: CodeableConcept[]

    BodyStructure.includedStructure.bodyLandmarkOrientation.clockFacePosition Element

    FHIR Specification

    • Short: Clockface orientation
    • Definition: An description of the direction away from a landmark something is located based on a radial clock dial.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    distanceFromLandmark?: BodyStructureIncludedStructureBodyLandmarkOrientationDistanceFromLandmarkComponent[]

    BodyStructure.includedStructure.bodyLandmarkOrientation.distanceFromLandmark Element

    FHIR Specification

    • Short: Landmark relative location
    • Definition: The distance in centimeters a certain observation is made from a body landmark.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    surfaceOrientation?: CodeableConcept[]

    BodyStructure.includedStructure.bodyLandmarkOrientation.surfaceOrientation Element

    FHIR Specification

    • Short: Relative landmark surface orientation
    • Definition: The surface area a body location is in relation to a landmark.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR BodyStructureIncludedStructureBodyLandmarkOrientationComponent

      • OptionaloptSourceField: string

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

      Returns undefined | BodyStructureIncludedStructureBodyLandmarkOrientationComponent

      BodyStructureIncludedStructureBodyLandmarkOrientationComponent data model or undefined for BodyStructureIncludedStructureBodyLandmarkOrientationComponent

      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 and only if the data model has required fields (min cardinality > 0) and at least one of those required fields in the instance is empty; false otherwise

    • Returns boolean

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

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    parsegetLandmarkDescriptionsetLandmarkDescriptionaddLandmarkDescriptionhasLandmarkDescriptiongetClockFacePositionsetClockFacePositionaddClockFacePositionhasClockFacePositiongetDistanceFromLandmarksetDistanceFromLandmarkaddDistanceFromLandmarkhasDistanceFromLandmarkgetSurfaceOrientationsetSurfaceOrientationaddSurfaceOrientationhasSurfaceOrientationfhirTypeisEmptycopytoJSONgetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensiongetIdsetIdhasIdgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensionisRequiredFieldsEmptyisResourceisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitLandmarkDescriptioninitClockFacePositioninitDistanceFromLandmarkinitSurfaceOrientation