CareRequestConfiguration

Represents the details for a record type such as service request, drug request, or admission request. One or more record types can be associated with a care request.

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 

CareRequestConfiguration components have the suffix .careRequestConfiguration and are stored in the careRequestConfigurations folder.

Version 

Introduced in API version 44.0.

Fields 

careRequestRecords 

  • Type: CareRequestRecords[]
  • Required: No
  • Description: The list of objects you can select to configure the care request.

careRequestRecordType 

  • Type: string

  • Required: Yes

  • Description: Required.

    The record type for the care request.

careRequestType 

  • Type: string

  • Required: Yes

  • Description: Required.

    The type of care request. For example, an appeal, a service request, or an admission.

isActive 

  • Type: boolean
  • Required: No
  • Description: Indicates whether the care request is active (true) or not (false).

isDefaultRecordType 

  • Type: boolean
  • Required: No

masterLabel 

  • Type: string
  • Required: Yes
  • Description: The master label for this component. This display value is the internal label that isn’t translated.

CareRequestRecords Type 

Displays a list of objects to customize the care request.

Fields 

careRequestRecord 

  • Type: string

  • Required: Yes

  • Description: Required.

    The object selected to configure the care request.

Declarative Metadata Sample Definition 

This is an example of a CareRequestConfiguration component.

1<?xml version="1.0" encoding="UTF-8"?>
2<CareRequestConfiguration xmlns="http://soap.sforce.com/2006/04/metadata">
3    <careRequestRecordType>DrugRequest</careRequestRecordType>
4    <careRequestRecords>
5        <careRequestRecord>CareRequestItem</careRequestRecord>
6    </careRequestRecords>
7    <careRequestRecords>
8        <careRequestRecord>CareRequestDrug</careRequestRecord>
9    </careRequestRecords>
10    <careRequestType>Drug Request</careRequestType>
11    <isActive>false</isActive>
12    <isDefaultRecordType>false</isDefaultRecordType>
13    <masterLabel>DrugRequest</masterLabel>
14</CareRequestConfiguration>

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>Case.DrugRequest</members>
5        <name>BusinessProcess</name>
6    </types>
7    <types>
8        <members>*</members>
9        <name>CareRequestConfiguration</name>
10    </types>
11    <types>
12        <members>CareRequest.DrugRequest</members>
13        <members>CareRequestDrug.DrugRequest</members>
14        <members>CareRequestItem.DrugRequest</members>
15        <members>Case.DrugRequest</members>
16        <name>RecordType</name>
17    </types>
18    <version>44.0</version>
19</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.