CareMetricTarget

Represents the expected care metrics at an org level and patient level. This object is available in API version 49.0 and later.

Supported Calls

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

Fields

CodeId

Type: reference
Properties: Create, Filter, Group, Sort, Update
Description: The CodeSet ID related to the care metric target.

DetailRatioDenominator

Type: double
Properties: Create, Filter, Nillable, Sort, Update
Description: The lower value of the care metric target detail ratio.

DetailRatioNumerator

Type: double
Properties: Create, Filter, Nillable, Sort, Update
Description: The higher value of the care metric target detail ratio.

DetailRatioUnitId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The unit of measurement for the care metric target detail ratio.

This field is a relationship field.
Relationship Name: DetailRatioUnit
Relationship Type: Lookup
Refers To: UnitOfMeasure

DetailString

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: A sequence of Unicode characters.

DueDuration

Type: double
Properties: Create, Filter, Nillable, Sort, Update
Description: The time it takes to reach the care metric target.

DueDurationUnitId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The unit of measurement for the time it takes to reach the care metric target.

This field is a relationship field.
Relationship Name: DueDurationUnit
Relationship Type: Lookup
Refers To: UnitOfMeasure

EndDate

Type: date
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The date when the care metric target value ceases to take effect.

GoalAssignmentId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The associated goal assignment record.

This field is a relationship field.
Relationship Name: GoalAssignment
Relationship Type: Lookup
Refers To: GoalAssignment

IsOutcomePositive

Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates the expected boolean value.
Default value: false

LastReferencedDate

Type: dateTime
Properties: Filter, Nillable, Sort
Description: The timestamp for when the current user last viewed a record related to this record.

LastViewedDate

Type: dateTime
Properties: Filter, Nillable, Sort
Description: The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed.

LowerLimit

Type: double
Properties: Create, Filter, Nillable, Sort, Update
Description: The lower limit for the care metric target range. Used when Type is set to RANGE.

MeasureCodeId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The ID of the related measure code.

This field is a polymorphic relationship field.
Relationship Name: MeasureCode
Relationship Type: Lookup
Refers To: CodeSet, CodeSetBundle

Name

Type: string
Properties: Create, Filter, Group, idLookup, Sort, Update
Description: The name of this care metric target.

NumericValue

Type: double
Properties: Create, Filter, Nillable, Sort, Update
Description: The numeric value of the care metric target (6 decimal places). Used when Type is set to MIN, MAX, or EXACT.

OwnerId

Type: reference
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: The ID of the user who owns this record.

PatientId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The account ID of the patient for whom the care metric target is applicable.

StartDate

Type: date
Properties: Create, Filter, Group, Sort, Update
Description: The date when the care metric target value takes effect.

TargetedOutcome

Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: Specifies if the targeted outcome value is false (negative outcome is desired) or true (positive outcome is desired).
Possible values:
- Negative
- Positive

Type

Type: picklist
Properties: Create, Filter, Group, Restricted picklist, Sort, Update
Description: The care metric value type.
Possible values:
- BOOLEAN
- EXACT
- MAX
- MIN
- RANGE

UnitOfMeasureId

Type: reference
Properties: Create, Filter, Group, Sort, Update
Description: The ID of the unit of measure for the care metric target.

UpperLimit

Type: double
Properties: Create, Filter, Nillable, Sort, Update
Description: The upper limit for the care metric target range. Used when Type is set to RANGE.

Associated Objects

This object has the following associated objects. Unless noted, they are available in the same API version as this object.

CareMetricTargetChangeEvent (API Version 62.0): Change events are available for the object.
CareMetricTargetFeed: Feed tracking is available for the object.
CareMetricTargetHistory: History is available for tracked fields of the object.
CareMetricTargetOwnerSharingRule: Sharing rules are available for the object.
CareMetricTargetShare: Sharing is available for the object.