Data Model Libraries
    Preparing search index...

    Class GoalTargetComponent

    GoalTargetComponent Class

    FHIR Specification

    • Short: Target outcome for the goal
    • Definition: Indicates what should be done by when.
    • Comment: When multiple targets are present for a single goal instance, all targets must be met for the overall goal to be met.
    • Requirements: Allows the progress of the goal to be monitored against an observation or due date. Target is 0..* to support Observations with multiple components, such as blood pressure goals with both a systolic and diastolic target.

    FHIR Goal

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    measure? detail? due?

    Methods

    parse getMeasure setMeasure hasMeasure getDetail setDetail hasDetail getDetailQuantity hasDetailQuantity getDetailRange hasDetailRange getDetailCodeableConcept hasDetailCodeableConcept getDetailStringType hasDetailStringType getDetailBooleanType hasDetailBooleanType getDetailIntegerType hasDetailIntegerType getDetailRatio hasDetailRatio getDue setDue hasDue getDueDateType hasDueDateType getDueDuration hasDueDuration 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

    Constructors

    Properties

    measure?: CodeableConcept

    Goal.target.measure Element

    FHIR Specification

    • Short: The parameter whose value is being tracked
    • Definition: The parameter whose value is being tracked, e.g. body weight, blood pressure, or hemoglobin A1c level.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    detail?: IDataType

    Goal.target.detail[x] Element

    @ChoiceDataTypesMeta('Goal.target.detail[x]', ['Quantity','Range','CodeableConcept','string','boolean','integer','Ratio',]

    FHIR Specification

    • Short: The target value to be achieved
    • Definition: The target value of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any focus value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any focus value at or above the low value.
    • Comment: A CodeableConcept with just a text would be used instead of a string if the field was usually coded, or if the type associated with the Goal.target.measure defines a coded value.
    • FHIR Types: 'Quantity', 'Range', 'CodeableConcept', 'string', 'boolean', 'integer', 'Ratio',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    due?: IDataType

    Goal.target.due[x] Element

    @ChoiceDataTypesMeta('Goal.target.due[x]', ['date','Duration',]

    FHIR Specification

    • Short: Reach goal on or before
    • Definition: Indicates either the date or the duration after start by which the goal should be met.
    • Requirements: Identifies when the goal should be evaluated.
    • FHIR Types: 'date', 'Duration',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR GoalTargetComponent

      • OptionaloptSourceField: string

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

      Returns undefined | GoalTargetComponent

      GoalTargetComponent data model or undefined for GoalTargetComponent

      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
    parsegetMeasuresetMeasurehasMeasuregetDetailsetDetailhasDetailgetDetailQuantityhasDetailQuantitygetDetailRangehasDetailRangegetDetailCodeableConcepthasDetailCodeableConceptgetDetailStringTypehasDetailStringTypegetDetailBooleanTypehasDetailBooleanTypegetDetailIntegerTypehasDetailIntegerTypegetDetailRatiohasDetailRatiogetDuesetDuehasDuegetDueDateTypehasDueDateTypegetDueDurationhasDueDurationfhirTypeisEmptycopytoJSONgetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensiongetIdsetIdhasIdgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensionisRequiredFieldsEmptyisResourceisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValues