Data Model Libraries
    Preparing search index...

    Class Goal

    Goal Class

    Describes the intended objective(s) for a patient, group or organization care, for example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, etc.

    FHIR Specification

    • Short: Describes the intended objective(s) for a patient, group or organization
    • Definition: Describes the intended objective(s) for a patient, group or organization care, for example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, etc.
    • Comment: Goal can be achieving a particular change or merely maintaining a current state or even slowing a decline.
    • FHIR Version: 5.0.0

    FHIR Goal

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    identifier? goalStatusEnum lifecycleStatus achievementStatus? category? continuous? priority? description subject start? target? statusDate? statusReason? source? addresses? note? outcome?

    Methods

    parse getIdentifier setIdentifier addIdentifier hasIdentifier getLifecycleStatusEnumType setLifecycleStatusEnumType hasLifecycleStatusEnumType getLifecycleStatusElement setLifecycleStatusElement hasLifecycleStatusElement getLifecycleStatus setLifecycleStatus hasLifecycleStatus getAchievementStatus setAchievementStatus hasAchievementStatus getCategory setCategory addCategory hasCategory getContinuousElement setContinuousElement hasContinuousElement getContinuous setContinuous hasContinuous getPriority setPriority hasPriority getDescription setDescription hasDescription getSubject setSubject hasSubject getStart setStart hasStart getStartDateType hasStartDateType getStartCodeableConcept hasStartCodeableConcept getTarget setTarget addTarget hasTarget getStatusDateElement setStatusDateElement hasStatusDateElement getStatusDate setStatusDate hasStatusDate getStatusReasonElement setStatusReasonElement hasStatusReasonElement getStatusReason setStatusReason hasStatusReason getSource setSource hasSource getAddresses setAddresses addAddresses hasAddresses getNote setNote addNote hasNote getOutcome setOutcome addOutcome hasOutcome fhirType isEmpty isRequiredFieldsEmpty copy toJSON getText setText hasText getContained setContained addContained hasContained getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension resourceType getIdElement setIdElement hasIdElement getId setId hasId getMeta setMeta hasMeta getImplicitRulesElement setImplicitRulesElement hasImplicitRulesElement getImplicitRules setImplicitRules hasImplicitRules getLanguageElement setLanguageElement hasLanguageElement getLanguage setLanguage hasLanguage isResource isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initIdentifier initCategory initTarget initAddresses initNote initOutcome

    Constructors

    Properties

    identifier?: Identifier[]

    Goal.identifier Element

    FHIR Specification

    • Short: External Ids for this goal
    • Definition: Business identifiers assigned to this goal by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
    • Comment: This is a business identifier, not a resource identifier (see discussion). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.
    • Requirements: Allows identification of the goal as it is known by various participating systems and in a way that remains consistent across servers.
    • FHIR Type: Identifier
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    goalStatusEnum: GoalStatusEnum

    FHIR CodeSystem: GoalStatus

    GoalStatusEnum

    lifecycleStatus: null | EnumCodeType

    Goal.lifecycleStatus Element

    FHIR Specification

    • Short: proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected
    • Definition: The state of the goal throughout its lifecycle.
    • Comment: This element is labeled as a modifier because the lifecycleStatus contains codes that mark the resource as not currently valid.
    • Requirements: Allows knowing whether goal needs to be further tracked.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: true
    • isModifierReason: This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
    • isSummary: true

    CodeSystem Enumeration: GoalStatusEnum

    achievementStatus?: CodeableConcept

    Goal.achievementStatus Element

    FHIR Specification

    • Short: in-progress | improving | worsening | no-change | achieved | sustaining | not-achieved | no-progress | not-attainable
    • Definition: Describes the progression, or lack thereof, towards the goal against the target.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    category?: CodeableConcept[]

    Goal.category Element

    FHIR Specification

    • Short: E.g. Treatment, dietary, behavioral, etc
    • Definition: Indicates a category the goal falls within.
    • Requirements: Allows goals to be filtered and sorted.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    continuous?: BooleanType

    Goal.continuous Element

    FHIR Specification

    • Short: After meeting the goal, ongoing activity is needed to sustain the goal objective
    • Definition: After meeting the goal, ongoing activity is needed to sustain the goal objective.
    • Comment: For example, getting a yellow fever vaccination for a planned trip is a goal that is designed to be completed (continuous = false). A goal to sustain HbA1c levels would not be a one-time goal (continuous = true).
    • Requirements: Allows for a system to programmatically update achievementStatus upon finding evidence the goal has been met.
    • FHIR Type: boolean
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    priority?: CodeableConcept

    Goal.priority Element

    FHIR Specification

    • Short: high-priority | medium-priority | low-priority
    • Definition: Identifies the mutually agreed level of importance associated with reaching/sustaining the goal.
    • Comment: Extensions are available to track priorities as established by each participant (i.e. Priority from the patient's perspective, different practitioners' perspectives, family member's perspectives) The ordinal extension on Coding can be used to convey a numerically comparable ranking to priority. (Keep in mind that different coding systems may use a "low value=important".
    • Requirements: Used for sorting and presenting goals.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    description: null | CodeableConcept

    Goal.description Element

    FHIR Specification

    • Short: Code or text describing goal
    • Definition: Human-readable and/or coded description of a specific desired objective of care, such as "control blood pressure" or "negotiate an obstacle course" or "dance with child at wedding".
    • Comment: If no code is available, use CodeableConcept.text.
    • Requirements: Without a description of what's trying to be achieved, element has no purpose.
    • FHIR Type: CodeableConcept
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    subject: null | Reference

    Goal.subject Element

    FHIR Specification

    start?: IDataType

    Goal.start[x] Element

    @ChoiceDataTypesMeta('Goal.start[x]', ['date','CodeableConcept',]

    FHIR Specification

    • Short: When goal pursuit begins
    • Definition: The date or event after which the goal should begin being pursued.
    • Requirements: Goals can be established prior to there being an intention to start pursuing them; e.g. Goals for post-surgical recovery established prior to surgery.
    • FHIR Types: 'date', 'CodeableConcept',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    target?: GoalTargetComponent[]

    Goal.target Element

    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 Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    statusDate?: DateType

    Goal.statusDate Element

    FHIR Specification

    • Short: When goal status took effect
    • Definition: Identifies when the current status. I.e. When initially created, when achieved, when cancelled, etc.
    • Comment: To see the date for past statuses, query history.
    • FHIR Type: date
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    statusReason?: StringType

    Goal.statusReason Element

    FHIR Specification

    • Short: Reason for current status
    • Definition: Captures the reason for the current status.
    • Comment: This will typically be captured for statuses such as rejected, on-hold or cancelled, but could be present for others.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    source?: Reference

    Goal.source Element

    FHIR Specification

    addresses?: Reference[]

    Goal.addresses Element

    FHIR Specification

    note?: Annotation[]

    Goal.note Element

    FHIR Specification

    • Short: Comments about the goal
    • Definition: Any comments related to the goal.
    • Comment: May be used for progress notes, concerns or other related information that doesn't actually describe the goal itself.
    • Requirements: There's a need to capture information about the goal that doesn't actually describe the goal.
    • FHIR Type: Annotation
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    outcome?: CodeableReference[]

    Goal.outcome Element

    FHIR Specification

    • Short: What result was achieved regarding the goal?
    • Definition: Identifies the change (or lack of change) at the point when the status of the goal is assessed.
    • Comment: Note that this should not duplicate the goal status; The goal outcome is independent of the outcome of the related activities. For example, if the Goal is to achieve a target body weight of 150 lb and a care plan activity is defined to diet, then the care plan's activity outcome could be calories consumed whereas goal outcome is an observation for the actual body weight measured.
    • Requirements: Outcome tracking is a key aspect of care planning.
    • FHIR Type: CodeableReference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR Goal

      • OptionaloptSourceField: string

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

      Returns undefined | Goal

      Goal data model or undefined for Goal

      JsonError if the provided JSON is not a valid JSON object

    • Assigns the provided Source object value to the source property.

      Parameters

      • value: undefined | Reference

        the source object value

      Returns this

      this

      @ReferenceTargets('Goal.source', ['Patient','Practitioner','PractitionerRole','RelatedPerson','CareTeam',])

      InvalidTypeError for invalid data type or reference value

    • Assigns the provided Reference array value to the addresses property.

      Parameters

      • value: undefined | Reference[]

        the addresses array value

      Returns this

      this

      @ReferenceTargets('Goal.addresses', ['Condition','Observation','MedicationStatement','MedicationRequest','NutritionOrder','ServiceRequest','RiskAssessment','Procedure',])

      InvalidTypeError for invalid data type or reference value

    • Add the provided Reference value to the addresses array property.

      Parameters

      • value: undefined | Reference

        the addresses value

      Returns this

      this

      @ReferenceTargets('Goal.addresses', ['Condition','Observation','MedicationStatement','MedicationRequest','NutritionOrder','ServiceRequest','RiskAssessment','Procedure',])

      InvalidTypeError for invalid data type or reference value

    • Assigns the provided value to the text property.

      Parameters

      Returns this

      this

    • Returns boolean

      true if the text property exists and has a value; false otherwise

    • Assigns the provided Resource array value to the contained property.

      Parameters

      • value: undefined | IResource[]

        the contained array value

      Returns this

      this

    • Returns boolean

      true if the contained property exists and has a value; false otherwise

    • Assigns the provided array of Extension values to the extension property.

      Parameters

      • extension: undefined | IExtension[]

        array of Extensions

      Returns this

      this

    • 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

    • 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

    • 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

      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

    • Assigns the provided PrimitiveType value to the id property.

      Parameters

      • element: undefined | IdType

        the id value

      Returns this

      this

    • Returns undefined | string

      the id property value as a primitive value

    • Assigns the provided primitive value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the id property exists and has a value; false otherwise

    • Assigns the provided value to the meta property.

      Parameters

      • value: undefined | Meta

        the meta value

      Returns this

      this

    • Returns boolean

      true if the meta property exists and has a value; false otherwise

    • Assigns the provided primitive value to the implicitRules property.

      Parameters

      • value: undefined | string

        the implicitRules value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns undefined | string

      the language property value as a primitive value

    • Assigns the provided primitive value to the language property.

      Parameters

      • value: undefined | string

        the language value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the language property exists and has a value; 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
    parsegetIdentifiersetIdentifieraddIdentifierhasIdentifiergetLifecycleStatusEnumTypesetLifecycleStatusEnumTypehasLifecycleStatusEnumTypegetLifecycleStatusElementsetLifecycleStatusElementhasLifecycleStatusElementgetLifecycleStatussetLifecycleStatushasLifecycleStatusgetAchievementStatussetAchievementStatushasAchievementStatusgetCategorysetCategoryaddCategoryhasCategorygetContinuousElementsetContinuousElementhasContinuousElementgetContinuoussetContinuoushasContinuousgetPrioritysetPriorityhasPrioritygetDescriptionsetDescriptionhasDescriptiongetSubjectsetSubjecthasSubjectgetStartsetStarthasStartgetStartDateTypehasStartDateTypegetStartCodeableConcepthasStartCodeableConceptgetTargetsetTargetaddTargethasTargetgetStatusDateElementsetStatusDateElementhasStatusDateElementgetStatusDatesetStatusDatehasStatusDategetStatusReasonElementsetStatusReasonElementhasStatusReasonElementgetStatusReasonsetStatusReasonhasStatusReasongetSourcesetSourcehasSourcegetAddressessetAddressesaddAddresseshasAddressesgetNotesetNoteaddNotehasNotegetOutcomesetOutcomeaddOutcomehasOutcomefhirTypeisEmptyisRequiredFieldsEmptycopytoJSONgetTextsetTexthasTextgetContainedsetContainedaddContainedhasContainedgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensiongetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensionresourceTypegetIdElementsetIdElementhasIdElementgetIdsetIdhasIdgetMetasetMetahasMetagetImplicitRulesElementsetImplicitRulesElementhasImplicitRulesElementgetImplicitRulessetImplicitRuleshasImplicitRulesgetLanguageElementsetLanguageElementhasLanguageElementgetLanguagesetLanguagehasLanguageisResourceisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitIdentifierinitCategoryinitTargetinitAddressesinitNoteinitOutcome