--- schema_version: "1" id: 1120df7d5010694edc25fa83730c442eec0a64afe34eeaa8a82fc1ec4b88f99c title: CareMetricTarget collection: legacydeveloper version: current locale: en-us portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/health_cloud_object_reference/sforce_api_objects_caremetrictarget.md canonical_url: https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_caremetrictarget.htm source_site: developer.salesforce.com content_type: documentation content_hash: 6748a40f818945fcfd656bc4b69d8011beed9ad40e0388375e94f9bf16991e13 description: Represents the expected care metrics at an org level and patient level. This object is available in API version 49.0 and later. --- # 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](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API Version 62.0) Change events are available for the object. [CareMetricTargetFeed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [CareMetricTargetHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [CareMetricTargetOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_associated_objects_ownersharingrule.htm "StandardObjectNameOwnerSharingRule is the model for all owner sharing rule objects associated with standard objects. These objects represent a rule for sharing a standard object with users other than the owner.") Sharing rules are available for the object. [CareMetricTargetShare](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object.