HealthScore

Represents a subject’s score for a specific score category. This object is available in API version 55.0 and later.

Supported Calls

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

Special Access Rules

Fields

Age

Type: int
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: Age of the patient at the time of computation.

AgeBand

Type: picklist
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: Patient’s age calculated into age bands.

AssessmentYear

Type: int
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: Indicates the year the risk score is applicable to.

CareProgramEnrolleeId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: Care Program Enrollee for which this score is computed.

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

ConditionCategoryCount

Type: int
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: Specifies the number of applicable condition categories.

ConditionCategoryList

Type: textarea
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: A comma separated list of condition categories that apply to the specified condition codes.

CurrentScore

Type: double
Properties: Create, Filter, Sort, Update
Description: The patient’s current score for the score category.

CurrentScoreDate

Type: dateTime
Properties: Create, Filter, Sort, Update
Description: The date when the current score was derived.

Gender

Type: picklist
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: Gender of the patient at the time of computation.

HierCondCategoryCodeList

Type: textarea
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The final HCC Codes that are applicable to the patient after applying the overriding logic.

IsSubjectDisabled

Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: CMS disability status of the patient at the time of computation.
Default value: false

IsSubjectInstitutionalized

Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates whether the patient is in an institution.
Default value: false

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: Autonumber, Defaulted on create, Filter, idLookup, Sort
Description: The name of the HealthScore record.

PreviousScore

Type: double
Properties: Filter, Nillable, Sort
Description: The previous score of the subject for the specified category. This field is automatically updated when with the previous value of the CurrentScore field when the score is updated.

PreviousScoreDate

Type: dateTime
Properties: Filter, Nillable, Sort
Description: The date when the previous score was calculated. This field is automatically updated with the previous value of the CurrentScoreDate field when the score is updated.

ScoreAndDate

Type: string
Properties: Filter, Group, Nillable, Sort
Description: For internal use.

ScoreCategoryId

Type: Lookup
Properties: Create, Filter, Group, Sort
Description: The score category that the score belongs to.
Refers To: ScoreCategory

ScoreChangePercent

Type: percent
Properties: Filter, Nillable, Sort
Description: The degree of change between the current score and the previous score.

This field is a calculated field.

ScoredAccountId

Type: Lookup
Properties: Filter, Group, Nillable, Sort
Description: The account that is the subject of the score.
Refers To: Account

ScoredContactId

Type: Lookup
Properties: Filter, Group, Nillable, Sort
Description: The contact that is the subject of the score.

This field is a relationship field.
Refers To: Contact

ScoredLeadId

Type: Lookup
Properties: Filter, Group, Nillable, Sort
Description: The lead that is the subject of the score.

This field is a relationship field.
Refers To: Lead

SubjectId

Type: Polymorphic Master-detail
Properties: Create, Filter, Group, Sort
Description: The subject of the score.
Refers To: Account, Contact, Lead

Usage

We recommend automating scores for this object using Data Cloud or another data processing solution. However, if you choose to manually enter data for records, just use the CurrentScore, CurrentScoreDate, ScoreCategoryId, and SubjectId fields. The other fields are automatically updated as required when you create or update a record.

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.

HealthScoreChangeEvent (API Version 62.0): Change events are available for the object.
HealthScoreFeed: Feed tracking is available for the object.
HealthScoreHistory: History is available for tracked fields of the object.
HealthScoreShare: Sharing is available for the object.