IndicatorAssignment

Represents the assignment of an indicator definition that's used to measure the performance of an outcome or a related activity. This object is available in API version 59.0 and later.

Supported Calls

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

Special Access Rules

This object is available in products where the Health Cloud Foundation (for Health Cloud) or Health Cloud Starter (for Life Sciences Cloud), and Patient Program Outcome Management permission sets are assigned to users.

Fields

CareProgramId

  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The care program associated with the indicator assignment.

    This field is a relationship field.

    This field is available in API version 61.0 and later with the Patient Program Outcome Management permission set.

  • Relationship Name: CareProgram
  • Relationship Type: Lookup
  • Refers To: CareProgram

IndicatorAssignmentType

  • Type: picklist
  • Properties: Create, Filter, Group, Sort, Update
  • Description: Specifies the object that the indicator assignment measures.
  • Possible values:
    • Outcome
    • Care Program —This value is available from API version 61.0 and later.

IndicatorDefinitionId

  • Type: reference
  • Properties: Create, Filter, Group, Sort
  • Description: The indicator definition that's associated with the indicator assignment.

    This field is a relationship field.

  • Relationship Name: IndicatorDefinition
  • Relationship Type: Master-Detail
  • Refers To: IndicatorDefinition

IndicatorImprvGuideline

  • Type: textarea
  • Properties: Create,Nillable, Update
  • Description: The guidelines to improve the indicator score.

    This field is available in API version 62.0 and later with the Patient Program Outcome Management permission set.

IntendedDirection

  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Description: Specifies the intended direction of change in the behavior, knowledge, skills, status, or level of functioning that's detailed in the parent indicator definition.
  • Possible values:
    • Decrease
    • Increase
    • Maintain

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 timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly.

Name

  • Type: string
  • Properties: Create, Filter, Group, idLookup, Sort, Update
  • Description: The name of the indicator assignment.

OutcomeId

  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The outcome that the indicator assignment measures.

    This field is a relationship field.

  • Relationship Name: Outcome
  • Relationship Type: Lookup
  • Refers To: Outcome

OwnerId

  • Type: reference
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: The owner of this indicator assignment.

    This field is a polymorphic relationship field.

  • Relationship Name: Owner
  • Relationship Type: Lookup
  • Refers To: Group, User

Status

  • Type: picklist
  • Properties: Create, Filter, Group, Sort, Update
  • Description: Specifies the status of the indicator assignment.
  • Possible values:
    • Active
    • Canceled
    • Completed
    • Planned

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.

IndicatorAssignmentFeed
Feed tracking is available for the object.
IndicatorAssignmentHistory
History is available for tracked fields of the object.
IndicatorAssignmentOwnerSharingRule
Sharing rules are available for the object.
IndicatorAssignmentShare
Sharing is available for the object.