GoalDefinition

The definition of a care plan goal in the reusable PGI library that’s a part of Integrated Care Management. When instantiated, GoalDefinition records create GoalAssignment records that serve as goals in care plans. 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

Field Details
Category
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The category that the defined goal belongs to.
Description
Type
textarea
Properties
Create, Nillable, Update
Description
The description of the defined goal.
IsCustomGoalNameRequired
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether a custom goal name is required for a goal assignment related to the goal definition.
The default value is false.
This field is available from API version 63.0 and later.
LastReferencedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The date and time when the record was last referenced.
LastViewedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The date and time when the record was last viewed.
Name
Type
string
Properties
Create, Filter, Group, idLookup, Sort, Update
Description
The name of the record.
OwnerId
Type
Polymorphic lookup
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
The owner of the record.
This field is a polymorphic relationship field.
Relationship Name
Owner
Refers To
  • Group
  • User
ParentGoalId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
This field is not used in Integrated Care Management.
Relationship Name
ParentGoal
Relationship Type
Lookup
Refers To
GoalDefinition
Status
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The status of the goal defintion. This value indicates whether the defintion is active or not,.
Possible values are:
  • Active
  • Inactive
The default value is Active.
Type
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Specifies the type of the defined goal.
Possible values are:
  • Individual—Intermediate Goal
  • Strategic—Top Goal
The default value is Individual.
UsageType
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
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.

GoalDefinitionFeed
Feed tracking is available for the object.
GoalDefinitionHistory
History is available for tracked fields of the object.
GoalDefinitionShare
Sharing is available for the object.