Salesforce Health Cloud Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Health Cloud Developer Guide
Health Cloud Data Model
Advanced Therapy Management
Adverse Events
Assessment Generation
Benefits Verification
Care Program Management
Claims
Clinical Data Model
Predecessors to Code Sets and Code Set Bundles in Health Cloud
Coverage Requirement Discovery
Crisis Support Center Management
Documentation Templates and Rules
Disease Surveillance
Electronic Signatures
Engagement Interaction
FHIR Subscription
Financial Assistance Program
Health Assessments
Health Insurance
Home Health
Integrated Care Management
ActionPlanTemplateAssignment
AsmtQstnRespRecommendation
CareEpisode
CareEpisodeDetail
CarePlan
CarePlanActivity
CarePlanActivityDetail
CarePlanDetail
CarePlanTemplate
CarePlanTemplateGoal
CarePlanTemplateProblem
GoalAssignment
GoalAssignmentDetail
GoalDefinition
ProblemDefinition
ProblemGoalDefinition
CareGap
ClinicalMeasure
ClinicalMeasureCriteria
ClinicalMeasureCriteriaGrp
CareGapCriteriaResult
CareTask
CareTaskDetail
Intelligent Appointment Management
Intelligent Document Automation
Intelligent Sales
Medication Management
Patient Program Outcome Management
Participant Management
Patient Segmentation
Pharmacy Benefits Verification
Provider Network Management
Provider Relationship Management
Remote Monitoring and Device Registration
Social Determinants
Timeline
Unified Health Scoring
Utilization Management
Health Cloud Associated Objects
Health Cloud Fields on Standard Objects
Working With Electronic Health Records
Emergency Response Management
Apex Reference
Health Cloud Business APIs
Health Cloud Tooling API Objects
Health Cloud Standard Invocable Actions
Metadata Types
API End-of-Life Policy
PDF

ClinicalMeasure

Represents a structured and computable definition of a health-related measure for identifying care gaps. 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()

Fields

Field Details
ApplicationName
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The application used for calculating the measure.
ApplicationType
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The type of application used for calculating the measure.
Possible values are:
  • Apex
  • Custom
  • ExpressionSet—Expression Set
  • Flow
  • IntegrationProcedure—Integration Procedure
Author
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The individual or organization that primarily authored the measure.
ClinicalRcmdSummary
Type
textarea
Properties
Create, Nillable, Update
Description
A summary of relevant clinical guidelines or other clinical recommendations supporting the measure.
ClinicalUsage
Type
textarea
Properties
Create, Nillable, Update
Description
The description of how the measure is used.
CompositeScoringType
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The scoring method used to combine the component measures to determine the composite score.
Possible values are:
  • All-Or-Nothing
  • Linear
  • Opportunity
  • Weighted
CopyrightLabel
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The copyright label of a measure.
CopyrightStatement
Type
textarea
Properties
Create, Nillable, Update
Description
A copyright statement of the measure and/or its contents.
Description
Type
textarea
Properties
Create, Nillable, Update
Description
The description of the measure.
Disclaimer
Type
textarea
Properties
Create, Nillable, Update
Description
A disclaimer for the use of the measure or its referenced content.
Editor
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The individual or organization responsible for editing the measure.
EffectiveEndDate
Type
dateTime
Properties
Create, Filter, Sort, Update
Description
The end date of a measure evaluation period.
EffectiveStartDate
Type
dateTime
Properties
Create, Filter, Sort, Update
Description
The start date of a measure evaluation period.
Endorser
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The individual or organization responsible for endorsing the measure.
IntendedJurisdictionCodeId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The legal or geographic region where the measure is intended to be used.
This field is a polymorphic relationship field.
Relationship Name
IntendedJurisdictionCode
Relationship Type
Lookup
Refers To
CodeSet, CodeSetBundle
IsExperimental
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether a measure was authored for experimental purposes (true) or not (false).
The default value is false.
LastReferencedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The most recent date on which a user referenced the record.
LastReviewedDate
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The date the measure was last reviewed.
LastViewedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The most recent date on which a user viewed the record.
MeasureCategory
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Specifies the high-level category that the measure belongs to, such as Assessment or Treatment.
Possible values are:
  • Assessment
  • Education
  • Treatment
MeasureType
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Specifies the measure type based on what the measure calculates.
Possible values are:
  • Composite
  • Outcome
  • Patient-Reported-Outcome
  • Process
  • Structure
Name
Type
string
Properties
Create, Filter, Group, idLookup, Sort, Update
Description
A human-friendly name for a measure.
OwnerId
Type
reference
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
ID of the record owner.
This field is a polymorphic relationship field.
Relationship Name
Owner
Relationship Type
Lookup
Refers To
Group, User
PopulationBasisTypeCodeId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Specifies the population basis type for a measure when the basis is different from the subject.
This field is a relationship field.
Relationship Name
PopulationBasisTypeCode
Relationship Type
Lookup
Refers To
CodeSet
ProblemDefinitionId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The problem definition associated with the measure.
This field is a relationship field.
Relationship Name
ProblemDefinition
Relationship Type
Lookup
Refers To
ProblemDefinition
PublisherApprovalDate
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The date the measure was approved by the publisher.
PublisherContact
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The contact details of the publisher.
PublisherName
Type
string
Properties
Create, Filter, Group, Sort, Update
Description
The individual or organization that publishes and maintains the measure.
Purpose
Type
textarea
Properties
Create, Nillable, Update
Description
A short explanation of why a measure is needed.
Rationale
Type
textarea
Properties
Create, Nillable, Update
Description
A detailed reason for why the measure exists, inlcuding its objective and impact.
RelatedResources
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Supplementary resources or materials supporting a measure, such as additional documentation and citations.
Reviewer
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The individual or organization responsible for reviewing the measure.
RiskAdjustmentMethod
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
A description of the adjustment method for risks, such as clinical severity and conditions present at the start of care that may influence measure scores.
ScoreAggregationMethod
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
A description of the method used to combine the different measure scores of each population into one aggregated result.
ScoreImprovementIndication
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Specifies whether an increase or decrease in score is the preferred result for a measure.
Possible values are:
  • Decrease
  • Increase
ScoringType
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The scoring type used for calculating the measure.
Possible values are:
  • Cohort
  • Continuous Variable
  • Proportion
  • Ratio
ScoringUnitId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Specifes the expected unit of measure for the measure score when the unit can't be inferred from the measure logic.
This field is a relationship field.
Relationship Name
ScoringUnit
Relationship Type
Lookup
Refers To
UnitOfMeasure
SourceSystem
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The external system of record.
SourceSystemIdentifier
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ID of the record in the source system.
SourceSystemModified
Type
dateTime
Properties
Create, Filter, Nillable, Sort, Update
Description
The date and time when the record was last modified in the source system.
Status
Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort, Update
Description
Specifies the status of a measure, such as draft, active, retired, or unknown.
Possible values are:
  • Active
  • Draft
  • Retired
  • Unknown
SubjectCategory
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Specifies the subject category that the measure is intended for.
Possible values are:
  • Device
  • Location
  • Organization
  • Patient
  • Practitioner
  • RelatedPerson
Subtitle
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
A subtitle for a measure, adding additonal context.
SupportedContext
Type
textarea
Properties
Create, Nillable, Update
Description
The context that the measure is intended to support.
SystemReadableName
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
A computer-friendly name for a measure.
TermCodeId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Specifies description of an individual term used within the measure.
This field is a relationship field.
Relationship Name
TermCode
Relationship Type
Lookup
Refers To
CodeSet
VersionNumber
Type
string
Properties
Create, Filter, Group, Sort, Update
Description
The version of a measure that is managed by the author.

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.

ClinicalMeasureFeed
Feed tracking is available for the object.
ClinicalMeasureHistory
History is available for tracked fields of the object.
ClinicalMeasureOwnerSharingRule
Sharing rules are available for the object.
ClinicalMeasureShare
Sharing is available for the object.