Salesforce Health Cloud Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Health Cloud Developer Guide
Health Cloud Data Model
Health Cloud Associated Objects
Health Cloud Fields on Standard Objects
Working With Electronic Health Records
Emergency Response Management
Apex Reference
Health Cloud Business APIs
Health Cloud Tooling API Objects
Health Cloud Standard Invocable Actions
Metadata Types
CareBenefitVerifySettings
CareLimitType
CareRequestConfiguration
CareSystemFieldMapping
CareProviderSearchConfig
Flow for Health Cloud
Icon
IdentityVerificationProcDef
IdentityVerificationProcDtl
IdentityVerificationProcFld
IndustriesSettings
ScoreCategory
TimelineObjectDefinition
UIObjectRelationConfig
VirtualVisitConfig
API End-of-Life Policy
PDF

VirtualVisitConfig

Represents an external video provider configuration, which relays events from Salesforce to the provider.

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

VirtualVisitConfig components have the suffix .virtualVisitConfig and are stored in the VirtualVisitConfigs folder.

Version

VirtualVisitConfig components are available in API version 54.0 and later.

Special Access Rules

Access to this metadata type requires at least one of these preferences:

  • Video Calls: Org Pref (VideoVisits) Org preference
  • Industries Einstein: Intelligent Form Reader (EinsteinDocReader)
  • Industries Einstein: Sentiment Insights Account (IESentimentAnalysis)
  • Natural Language Processing: Key phrase extraction and entity detection (NLPServiceEnabled) Org Preference and the NLP: Key phrase extraction (KeyPhrasePrefEnabled) Org Preference
  • Natural Language Processing (NLPServicePrefEnabled) Org Preference

Fields

Field Name Description
comprehendServiceType
Field Type
VirtualVisitComprehendServiceType (enumeration of type string)
Description
Specifies the type of service used to convert speech into text or to analyze the converted speech text.

Valid values are:

  • ComprehendMedicalService
  • ComprehendService
developerName
Type
string
Properties
Filter, Group, Sort
Description
The unique name of the object in the API. This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. In managed packages, this field prevents naming conflicts on package installations. With this field, a developer can change the object’s name in a managed package and the changes are reflected in a subscriber’s organization. Label is Record Type Name. This field is automatically generated, but you can supply your own value if you create the record using the API.
experienceCloudSiteUrl
Field Type
string
Description
The URL of the Digital Experience site where the Video Call component is available to portal or guest users.
externalMsgServiceIdentifier
Field Type
string
Description
For internal use only.
externalRoleIdentifier
Field Type
string
Description
The ID of the role that's used to allow users to join a video call and to grant them temporary access to certain functions needed to participate in the call.
externalUserIdentifier
Field Type
string
Description
For internal use only.
fullName
Type
string
Properties
Create, Group, Nillable
Description
The full name of the VirtualVisitConfig type in Metadata API. The full name can include a namespace prefix. Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance.
isProtected
Field Type
boolean
Description
An auto-generated value that doesn’t currently impact the behavior of the metadata type.
masterLabel
Field Type
string
Description

Required.

A user-friendly name for VirtualVisitConfig, which is defined when the VirtualVisitConfig is created.
messagingRegion
Field Type
string
Description
The region where the waiting room and messaging channel data is processed and stored. Available in API version 57.0 and later.
namedCredential
Field Type
string
Description
The named credential record used to authenticate and authorize a video call vendor’s account.
storageBucketName
Field Type
string
Description
The name of the storage bucket that stores the meeting transcript.
usageType
Field Type
VirtualVisitUsageType (enumeration of type string)
Description
The name of the Salesforce feature for which the video call configuration record is created.

Valid values are:

  • CHIME
  • ENTITY_DETECTION
  • INTELLIGENT_FORM_READER
  • KEY_PHRASE_EXTRACTION
  • SENTIMENT_ANALYSIS
videoCallApptTypeValue
Field Type
string
Description
The default Appointment Type picklist values from the Service Appointment object that represent a video appointment type. Use semicolons to separate multiple values.
videoControlRegion
Field Type
string
Description
The region where API calls related to Video Calls are made. Available in API version 57.0 and later.
visitRegion
Field Type
VirtualVisitVisitRegion (enumeration of type string)
Description
The region where the Video Call audio and video data is processed.

Valid values are:

  • af-south-1
  • ap-east-1
  • ap-northeast-1
  • ap-northeast-2
  • ap-northeast-3
  • ap-south-1
  • ap-southeast-1
  • ap-southeast-2
  • ca-central-1
  • eu-central-1
  • eu-north-1
  • eu-south-1
  • eu-west-1
  • eu-west-2
  • eu-west-3
  • me-south-1
  • sa-east-1
  • us-east-1
  • us-east-2
  • us-west-1
  • us-west-2

Declarative Metadata Sample Definition

This is an example of a VirtualVisitConfig component.

<?xml version="1.0" encoding="UTF-8"?>
 <VirtualVisitConfig xmlns="http://soap.sforce.com/2006/04/metadata">
     <usageType>CHIME</usageType>
     <visitRegion>us-east-1</visitRegion>
     <masterLabel>vvconfig1</masterLabel>
     <experienceCloudSiteUrl>videocall_c@testcloudurl.com</experienceCloudSiteUrl>
     <namedCredential>SampleNamedCredential</namedCredential>
     <comprehendServiceType>ComprehendService</comprehendServiceType>
     <storageBucketName>comprehendbucket</storageBucketName>
     <isProtected>false</isProtected>
 </VirtualVisitConfig>

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">
     <namespacePrefix>[namespacePrefix]</namespacePrefix>
     <fullName>deployPackage</fullName>
     <types>
         <members>*</members>
         <name>VirtualVisitConfig</name>
     </types>
     <types>
         <members>*</members>
         <name>NamedCredential</name>
     </types>
     <version>55.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.