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 the Metadata metadata type and inherits its fullName field.

File Suffix and Directory Location

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

Version

CareBenefitVerifySettings components are available in API version 52.0 and later.

Fields

Field Name Description
codeSetType
Field Type
string
Description
Specifies the code set type for the benefits verification service type codes.
defaultNpi
Field Type
string
Description
Default National Provider Identifier to be used in the benefits verification request.
generalPlanServiceTypeCode
Field Type
string
Description
Service type code for the plan benefits as a whole.
isDefault
Field Type
boolean
Description
Indicates whether this record is the default verification service (true) or not (false).
masterLabel
Field Type
string
Description

Required.

Name of the benefits verification service.
organizationName
Field Type
string
Description
Specifies the organization name for the benefits verification request service.
serviceApexClass
Field Type
string
Description
Apex class used to access the benefits verification service.
serviceNamedCredential
Field Type
string
Description
Credential used to access the benefits verification service.
serviceTypeSourceSystem
Field Type
string
Description
Service type code for the plan benefits as a whole.
uriPath
Field Type
string
Description
Link to payer endpoint.

Declarative Metadata Sample Definition

This is an example of a CareBenefitVerifySettings component.

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

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

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types>
        <members>*</members>
        <name>CareBenefitVerifySettings</name>
    </types>
    <types>
        <members>*</members>
        <name>ApexClass</name>
    </types>
    <types>
        <members>*</members>
        <name>NamedCredential</name>
    </types>
    <version>52.0</version>
</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.