CareBenefitVerifySettings

Represents the configuration settings for benefit verification requests.

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 

CareBenefitVerifySettings components have the suffix .careBenefitVerifySettings and are stored in the careBenefitVerifySettings folder.

Version 

Introduced in API version 52.0.

Fields 

codeSetType 

  • Type: string
  • Required: No
  • Description: Specifies the code set type for the benefits verification service type codes.

defaultNpi 

  • Type: string
  • Required: No
  • Description: Default National Provider Identifier to be used in the benefits verification request.

generalPlanServiceTypeCode 

  • Type: string
  • Required: No
  • Description: Service type code for the plan benefits as a whole.

isDefault 

  • Type: boolean
  • Required: No
  • Description: Indicates whether this record is the default verification service (true) or not (false).

masterLabel 

  • Type: string

  • Required: Yes

  • Description: Required.

    Name of the benefits verification service.

organizationName 

  • Type: string
  • Required: No
  • Description: Specifies the organization name for the benefits verification request service.

serviceApexClass 

  • Type: string
  • Required: No
  • Description: Apex class used to access the benefits verification service.

serviceNamedCredential 

  • Type: string
  • Required: No
  • Description: Credential used to access the benefits verification service.

serviceTypeSourceSystem 

  • Type: string
  • Required: No
  • Description: Service type code for the plan benefits as a whole.

uriPath 

  • Type: string
  • Required: No
  • Description: Link to payer endpoint.

Declarative Metadata Sample Definition 

This is an example of a CareBenefitVerifySettings component.

1<?xml version="1.0" encoding="UTF-8"?>
2<CareBenefitVerifySettings xmlns="http://soap.sforce.com/2006/04/metadata">
3    <generalPlanServiceTypeCode>abc</generalPlanServiceTypeCode>
4    <isDefault>true</isDefault>
5    <masterLabel>test</masterLabel>
6    <serviceApexClass>TestApexClass</serviceApexClass>
7    <serviceNamedCredential>test</serviceNamedCredential>
8    <uriPath>efgh</uriPath>
9    <serviceTypeSourceSystem>Lorem ipsum dolor</serviceTypeSourceSystem>
10    <codeSetType>Code set</codeSetType>
11    <defaultNpi>Npi info</defaultNpi>
12    <organizationName>Organization name</organizationName>
13</CareBenefitVerifySettings>

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>CareBenefitVerifySettings</name>
6    </types>
7    <types>
8        <members>*</members>
9        <name>ApexClass</name>
10    </types>
11    <types>
12        <members>*</members>
13        <name>NamedCredential</name>
14    </types>
15    <version>52.0</version>
16</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.