CareLimitType

Defines the characteristics of limits on benefit provision.

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

Parent Type 

This type extends Metadata and inherits its fields.

File Suffix and Directory Location 

CareLimitType components have the suffix .careLimitType and are stored in the careLimitTypes folder.

Version 

Introduced in API version 52.0.

Fields 

isProtected 

  • Type: boolean
  • Required: No
  • Description: An auto-generated value that doesn’t impact the behavior of the metadata type.

limitType 

  • Type: string
  • Required: No
  • Description: Source of limit on benefit provision, such as a co-insurance requirement.

masterLabel 

  • Type: string

  • Required: Yes

  • Description: Required.

    Name of the limit type.

metricType 

  • Type: CareLimitTypeMetricType (enumeration of type string)
  • Required: No
  • Description: Metric to be used for calculating and displaying the benefit limit, such as number of visits, amount spent, or percentage of allowed expenditure.
  • Possible values:
    • Amount
    • Money
    • Percentage
    • Text

Declarative Metadata Sample Definition 

This is an example of a CareLimitType component.

1<?xml version="1.0" encoding="UTF-8"?>
2<CareLimitType xmlns="http://soap.sforce.com/2006/04/metadata">
3    <limitType>test</limitType>
4    <masterLabel>test</masterLabel>
5    <metricType>Money</metricType>
6    <isProtected>false</isProtected>
7</CareLimitType>

This is an example package.xml that references the previous definition.

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3    <types>
4        <members>*</members>
5        <name>CareLimitType</name>
6    </types>
7    <version>52.0</version>
8</Package>

Wildcard Support in the Manifest File 

This metadata type supports the wildcard character * (asterisk) in the package.xml manifest file. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.