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
REST Reference
Resources
Request Bodies
Action Plan Context Filters Input
Action Plan Template Input
Action Plan Template Item Filters Input
Appointed Representative Input
Assessment Details Input
Assessment Links Input
Assessment Reasons Input
Assessment Responses Input
Assessment Values Input
Book Slot Chain Input
Build Identity Verification Context Input
Captcha Token Input
Care Request Case Input
Care Request Patient Input
Care Authorization Request Input
Care Diagnosis Input
Care Request Drug Input
Care Request Input
Care Request Item Input
Care Requests List Input
Care Request Reviewer Input
Care Request Subscriber Input
Care Requests Update List Input
Content Document Input
Create Visit Request Input
Custom Field Value Input
Digital Verification Input
Digital Verification Input Fields Map
Dispenser Address Input
Document Management Input
Document Process Input
Enrollee Product Input
Fields Without Conflict Input
Field Value Input
FHIR Address Input
FHIR Codeable Concept Input
FHIR Codeable Concept Or ID Input
FHIR Coding Input
FHIR Contact Point Input
FHIR Dispense Input
FHIR Dosage Input
FHIR Dose
FHIR Dose And Rate
FHIR Human Name Input
FHIR Identifier Input
FHIR Medication Statement
FHIR Medication Resource Input
FHIR Patient Input
FHIR Rate
FHIR Reference Input
FHIR Request
First Reviewer Input
FHIR Unit Of Measure
FHIR Unit Of Measure Or ID
General Practitioner Input
HPI Score Sync Input
Med Statement Input Payload
Medical Director Input
Original Denial Medical Director Input
Patient Contact Party Input
Page Specification Input
Page Specification List Input
Patient Communication Language Input
Patient Input
Product Required Attributes Input
Process Definition Input
Process Detail Input
Program Enrollment Input
Referral Management Input
Slot Input
Guest Referral Input
Record Fields Input
Referral Detail Input
Reopened By Input
Requesting Practitioner Input
Servicing Facility Input
Servicing Practitioner Input
Search Input
Selected Search Result Input
Transport Location Input
User Credentials Input
Verification Context Input
Verified Result Input
Verifier Input
Verification Process Field Input
Visited Party Attributes Input
Visitor Attributes Input
Work Type Lead Time Input
Quotas and Allocation Input
Question Responses Input
Response Bodies
Intelligent Appointment Management Operations
Health Cloud Tooling API Objects
Health Cloud Standard Invocable Actions
Metadata Types
API End-of-Life Policy
PDF

Create Visit Request Input

Input representation of the create visit request.
Root XML tag
<CreateVisitInput>
JSON example
{
"visitType": "08qSG00000017VhYAI",
"place": "131SG0000006yazYAA",
"plannedVisitStartTime": "2023-12-28T09:07:21.205-07:00",
"status": "Planned",
"account": "001SG00000Cq7T8YAJ",
"visitor": [
{
"user": "005SG000003Z0p9YAC",
"primary": true
}
],
"productRequired": [
{
"productId": "01tSG000000KOxRYAW",
"quantity": 1
}
]
}
Properties
Name Type Description Required or Optional Available Version
account String ID of the account that is associated with a visit. Required 55.0
actionPlanTemplate Action Plan Template Input Represents the details of an action plan template. Action plan templates define the sets of tasks that your sales reps perform during visits. Optional 55.0
context String Purpose of the visit, such as claim or work type. Optional 55.0
place String Indicates the place that sales representatives visit. Required 55.0
plannedVisitEndTime String Date and time when the visit is expected to end. Optional 55.0
plannedVisitStartTime String Date and time when the visit is expected to start. Required 55.0
productRequired Product Required Attributes Input[] Represents the products required for the visit. Required 55.0
status String Indicates the status of the visit.
Valid values are:
  • Abondoned
  • Completed
  • InProgress
  • Planned
 Optional 55.0
statusRemarks String Additional remarks or comments provided by the sales representatives. Optional 55.0
visitPriority String Priority of the visit.
Valid values are:
  • High
  • Low
  • Medium
 Optional 55.0
visitType String ID of the visit type. This field is a lookup to the Worktype object. Optional 55.0
visitedParty Visited Party Attributes Input[] Represents the contacts from the customer organization who are being visited. Optional 55.0
visitor Visitor Attributes Input[] Represents the service resources from the organization who are executing the visit. Required 55.0