CareProviderSearchConfig

Represents the information about the fields that appear in care provider search results.

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 

CareProviderSearchConfig components have the suffix .careProviderSearchConfig and are stored in the careProviderSearchConfigs folder.

Version 

Introduced in API version 48.0.

Fields 

isActive 

  • Type: boolean
  • Required: No
  • Description: Indicates whether this configuration is active (true) or not (false).

isProtected 

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

mappedObject 

  • Type: ProviderSearchObjectMapping (enumeration of type string)

  • Required: Yes

  • Description: Required. Indicates mapped objects.

    Possible values are;

    • HealthCarePractitionerFacility
    • HealthCareProvider

masterLabel 

  • Type: string
  • Required: Yes
  • Description: Required. Name of the care provider.

sourceField 

  • Type: string
  • Required: No
  • Description: API name of the field that is copied to the target object.

targetField 

  • Type: string
  • Required: No
  • Description: API name of the field to copy the data to.

Declarative Metadata Sample Definition 

The following is an example of a CareProviderSearchConfig component.

1<?xml version="1.0" encoding="UTF-8"?>
2<CareProviderSearchConfig xmlns="http://soap.sforce.com/2006/04/metadata">
3    <sourceField>Test1__c</sourceField>
4    <targetField>Test1__c</targetField>
5    <mappedObject>HealthcareProvider</mappedObject>
6    <isProtected>false</isProtected>
7    <isActive>true</isActive>
8    <masterLabel>testlabel</masterLabel>
9</CareProviderSearchConfig>

The following 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>HealthcareProvider.Test1__c</members>
5        <name>CustomField</name>
6    </types>
7    <types>
8        <members>CareProviderSearchableField.Test1__c</members>
9        <name>CustomField</name>
10    </types>
11    <types>
12        <members>Test</members>
13        <name>CareProviderSearchConfig</name>
14    </types>
15    <version>48.0</version>
16</Package>