Salesforce Health Cloud Developer Guide

Health Cloud Developer Guide
Health Cloud Data Model
Health Cloud Associated Objects
Health Cloud Fields on Standard Objects
Health Cloud Platform Events
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
Address Input
Appointed Representative Input
Assessment Details Input
Assessment Links Input
Assessment Reasons Input
Assessment Responses Input
Asset Search Criteria 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
Common Search Criteria 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
Previous Assessment Responses Input
Process Definition Input
Process Detail Input
Program Enrollment Input
Provider Search Criteria Input
Referral Management Input
Slot Input
Guest Referral Input
Record Fields Input
Referral Detail Input
Reopened By Input
Requesting Practitioner Input
Resources 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
Health Cloud Tooling API Objects
Health Cloud Standard Invocable Actions
Metadata Types
Health Cloud FHIR APIs
MuleSoft Direct Integrations
API End-of-Life Policy
PDF

Newer Version Available

This content describes an older version of this product. View Latest

Guest Referral Input

Input representation of the request to create a patient referral record based on a guest user’s input.
JSON example

Here’s an example request to create a patient referral from the OOTB web form filled by a guest user.

1{
2   "captchaToken":{
3      "type":"ReCaptcha",
4      "token":"09APYnBZUChiG3s985dvsz9eHvoAMIoa6lB0qeDvL-pZjNvZ3Qg9HgZVRo4rAxebgl_7H1ZqavwGwecshDuL0K1K9rfv0eI_dn7pqyGA",
5      "siteKeyDeveloperName":"GoogleSiteKey"
6   },
7   "patient":{
8      "fields":{
9         "FirstName":"Charles",
10         "LastName":"Green",
11         "Phone":"8012345678"
12      }
13   },
14   "referralDetails":[
15      {
16         "detailType":"Insurance",
17         "detailRecordType":"Member Plan",
18         "fields":{
19            "Name":"Aetna PPO",
20            "MemberNumber":"2345678"
21         }
22      },
23      {
24         "detailType":"Based On",
25         "detailRecordType":"Health Condition",
26         "fields":{
27            "Condition Status":"Condition",
28            "Diagnostic Status":"Status"
29         }
30      }
31   ],
32   "referralNotes":"This is an urgent request",
33   "referral":{
34      "fields":{
35         "PatientInstruction":"Need Appointment ASAP.",
36         "Priority":"Urgent"
37      }
38   }
39}

Here’s an example request to create a patient referral with the provided performers and requesters in the OOTB guest web form.

1{
2   "captchaToken": {
3        "type": "ReCaptcha",
4        "token": "09APYnBZUChiG3s985dvsz9eHvoAMIoa6lB0qeDvL-pZjNvZ3Qg9HgZVRo4rAxebgl_7H1ZqavwGwecshDuL0K1K9rfv0eI_dn7pqyGA",
5        "siteKeyDeveloperName": "GoogleSiteKey"
6    },
7  "patient": {
8    "fields": {
9      "FirstName": "Joe",
10      "LastName": "Clark",
11      "Phone": "801XXXXX89"
12    }
13  },
14  "referralDetails": [
15    {
16      "detailType": "Insurance",
17      "detailRecordType": "Member Plan",
18      "fields": {
19        "Name": "Aetna PPO",
20        "MemberNumber": "2345678"
21      }
22    },
23    {
24      "detailType": "Insurance",
25      "detailRecordType": "Member Plan",
26      "detailRecordId": "0SqRM0000004F2z0AE"
27    },
28    {
29      "detailType": "Body Site",
30      "detailRecordType": "Health Condition",
31      "detailCodeId": "0hsRM000000043aYAA"
32    },
33    {
34      "detailType": "Reason Reference",
35      "detailRecordId": "0j4RM0000004MunYAE"
36    }
37  ],
38  "requester": {
39    "id": "0cmRM0000004nAgYAI"
40  },
41  "performers": [
42    {
43      "id": "0cmRM0000000l2JYAQ"
44    },
45    {
46      "id": "0cmRM0000000tnoYAA"
47    }
48  ],
49  "referralNotes": "This is an urgent request",
50  "referral": {
51    "fields": {
52      "Priority": "Routine",
53      "Status": "Draft",
54      "Type": "Plan"
55    }
56  }
57}
Properties
Name Type Description Required or Optional Available Version
captchaToken Captcha Token Input Google captcha verification token.

Because the referral information comes from a web form, this API expects a captcha token for security reasons. The guest referral API calls the Google API to verify the provided captcha.

A Google captcha token is valid only for 2 minutes.

 Required 60.0
patient Record Fields Input[] Account details of the patient being referred. Required 60.0
performer Record Fields Input[] List of healthcare providers who perform the service.

You can provide a maximum of 5 provider IDs in a request.

 Optional 60.0
referral Record Fields Input[] Referral information. Required 60.0
referralDetails Referral Detail Input[] Patient details, such as, insurance, and health condition. Optional 60.0
referralNotes String Referral notes. Optional 60.0
requester Record Fields Input[] Information about the provider requesting the service. A requester can be an Account, Asset, Healthcare Provider, or a CareRegisteredDevice object.

If the requester is new, provide information to create an account.

 Optional 60.0