GoalAssignment

Represents the goals that are part of a care plan.

Special Access Rules

In Health Cloud, this object is available in API version 57.0 and later.

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

Fields

AssignedById

Type: Polymorphic lookup
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: References the person who assigned the goal.

This field is a polymorphic relationship field.
Relationship Name: AssignedBy
Relationship Type: Lookup
Refers To: Account, CarePerformer, Contact, HealthcarePractitionerFacility, HealthcareProvider

CompletionDate

Type: date
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The date when the goal is completed.

CompletionPercentage

Type: percent
Properties: Create, Defaulted on create, Filter, Nillable, Sort, Update
Description: Records the progress of the goal with a percentage value.

Description

Type: textarea
Properties: Create, Nillable, Update
Description: The description of the goal.

DescriptionCodeId

Type: Polymorphic lookup
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The system-defined code that represents the description of a standardized goal.

This field is available only in Health Cloud with the Customer Engagement feature.
Relationship Name: DescriptionCode
Relationship Type: Lookup
Refers To:
- CodeSet
- CodeSetBundle

ExtlGoalDefIdentifier

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The ID of the goal in an external source system.

GoalAssigneeId

Type: Polymorphic lookup
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The person to whom the goal is assigned.

This field is a polymorphic relationship field.
Relationship Name: GoalAssignee
Relationship Type: Lookup
Refers To: Account, Contact

GoalDefinitionId

Type: Lookup
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: References the goal definition in the PGI library that defines the details of the goal.

This field is a relationship field.
Relationship Name: GoalDefinition
Refers To: GoalDefinition

GoalType

Type: String
Properties: Filter, Group, Nillable, Sort
Description: Specifies the type of the goal.

IsContinuousGoal

Type: Boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates whether the goal is a continuous goal (true) or not (false). For instance, setting a goal to quit smoking.
Default value: false

LastReferencedDate

Type: DateTime
Properties: Filter, Nillable, Sort
Description: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record.

LastViewedDate

Type: DateTime
Properties: Filter, Nillable, Sort
Description: The date and time when the record was last viewed.

Name

Type: String
Properties: Autonumber, Defaulted on create, Filter, idLookup, Sort
Description: The name of the goal assignment record.

OwnerId

Type: Polymorphic lookup
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: The ID of the owner of this goal assignment record.
Relationship Name: Owner
Refers To: Group, User

ParentRecordId

Type: Polymorphic lookup
Properties: Create, Filter, Group, Sort, Update
Description: The parent record that the goal is associated with.

This field is a polymorphic relationship field.
Relationship Name: ParentRecord
Refers To:
Account
CarePlan
CarePlanActivity
GoalAssignment

Priority

Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: Specifies the priority of the goal.
Possible values:
- High
- Low
- Medium

ProgressionStatus

Type: picklist
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: Specifies the progression status of the goal.
Possible values:
- Achieved
- Improved
- In Progress
- No Change
- Sustained
- Unachieved
- Unattainable
- Worsened

SortOrder

Type: double
Properties: Create, Filter, Nillable, Sort, Update
Description: Determines the spot of the goal in the list of all goals in a care plan.

SourceSystemIdentifier

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The identifier of the record in its source system.

SourceSystemModifiedDateTime

Type: dateTime
Properties: Create, Filter, Nillable, Sort, Update
Description: The date on which this item was last changed on the source system.

SourceSystemName

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The name of the system this record came from.

StartDate

Type: date
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The date when the goal is intended to start.

StartEventCodeId

Type: Polymorphic lookup
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The system-defined code that represents the event that initiates progression towards the goal.

This field is a polymorphic relationship field.
Relationship Name: StartEventCode
Refers To:
- CodeSet
- CodeSetBundle

Status

Type: picklist
Properties: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: Specifies the status of the goal.
Default value: Not Started
Possible values:
- Canceled
- Completed
- In Progress
- Not Started

StatusDate

Type: dateTime
Properties: Create, Filter, Nillable, Sort, Update
Description: Records the date and time when the current status was set.

StatusReason

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: Describes the reason for the current status.

TargetCompletionDate

Type: date
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The date when the goal is targeted to be completed.

TaskJobStatus

Type: picklist
Properties: Filter, Group, Nillable, Restricted picklist, Sort
Description: This field is not used in Integrated Care Management.

TaskJobStatusMessage

Type: textarea
Properties: Nillable
Description: This field is not used in Integrated Care Management.

Associated Objects

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.

GoalAssignmentFeed: Feed tracking is available for the object.
GoalAssignmentHistory: History is available for tracked fields of the object.
GoalAssignmentOwnerSharingRule: Sharing rules are available for the object.
GoalAssignmentShare: Sharing is available for the object.