IndicatorDefinition

Represents information about the indicator assignment and the process of measuring and calculating the indicator results. 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

Description

Type: textarea
Properties: Create, Filter, Nillable, Sort, Update
Description: The description of the indicator definition.

FlowDefinitionApiName

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The API name of the flow definition associated with the indicator definition. This field is available from API version 60.0 and later.

LastReferencedDate

Type: dateTime
Properties: Filter, Nillable, Sort
Description: Date and time when a user last referenced this indicator definition.

LastViewedDate

Type: dateTime
Properties: Filter, Nillable, Sort
Description: Date and time when a user last viewed this indicator definition.

Name

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

OwnerId

Type: reference
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: The ID of the user who owns the outcome. 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 definition.
Possible values:
- Active
- Canceled
- Completed
- Planned

UnitOfMeasureId

Type: reference
Properties: Create, Filter, Group, Sort, Update
Description: The unit of measure for the target, baseline, and result values that are associated with this indicator definition. This field is a relationship field.
Relationship Name: UnitOfMeasure
Relationship Type: Lookup
Refers To: UnitOfMeasure

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.

IndicatorDefinitionFeed: Feed tracking is available for the object.
IndicatorDefinitionHistory: History is available for tracked fields of the object.
IndicatorDefinitionOwnerSharingRule: Sharing rules are available for the object.
IndicatorDefinitionShare: Sharing is available for the object.