ScoreCategory | Salesforce Health Cloud Developer Guide

Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.

Important

Supported SOAP API Calls

create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()

Supported REST API Methods

DELETE, GET, HEAD, PATCH, POST, Query

Special Access Rules

Requires the Unified Health Scoring license.

Fields

Field	Details
CategoryName	Type string Properties Create, Filter, Group, Sort, Update Description The name of the scored category in a unified health profile.
Description	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The description of the category.
DeveloperName	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. This unique name prevents conflicts with rules from other packages that have the same masterLabel.
IconUrl	Type url Properties Create, Filter, Group, Nillable, Sort, Update Description The URL for the image used as the icon of the score category.
Language	Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The language of ScoreCategory. Possible values are: `da`—Danish `de`—German `en_US`—English `es`—Spanish `es_MX`—Spanish (Mexico) `fi`—Finnish `fr`—French `it`—Italian `ja`—Japanese `ko`—Korean `nl_NL`—Dutch `no`—Norwegian `pt_BR`—Portuguese (Brazil) `ru`—Russian `sv`—Swedish `th`—Thai `zh_CN`—Chinese (Simplified) `zh_TW`—Chinese (Traditional)
MasterLabel	Type string Properties Create, Filter, Group, idLookup, Nillable, Sort, Update Description Label that identifies the ScoreCategory throughout the Salesforce user interface.
NamespacePrefix	Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the `namespacePrefix__componentName` notation. The namespace prefix can have one of the following values. In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer. In orgs that are not Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix.
ParentCategoryId	Type Master-Detail Properties Create, Filter, Group, Nillable, Sort, Update Description The category that the score category is a part of. Don’t use this field if you’re defining a top-level score category to represent the a unified health profile. This field is a relationship field. Refers To ScoreCategory

Usage

Define a unified health profile by creating a score category to represent it. Further define this category by classifying its score ranges and add subcategories.