Guest Referral

When you send a request to create a patient referral, the API creates records in multiple objects, such as PersonAccount, ClinicalServiceRequest, and ClinicalServiceRequestDetail to store the patient referral information.

Resource

/connect/health/referral-management/guest-referrals

Resource Example

Replace {yourInstance} with the My Domain name of your Salesforce org.

https://{yourInstance}.salesforce.com/services/data/v68.0/connect/health/referral-management/guest-referrals

Available Version

60.0

HTTP Methods

POST

JSON example

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

{
   "captchaToken":{
      "type":"ReCaptcha",
      "token":"09APYnBZUChiG3s985dvsz9eHvoAMIoa6lB0qeDvL-pZjNvZ3Qg9HgZVRo4rAxebgl_7H1ZqavwGwecshDuL0K1K9rfv0eI_dn7pqyGA",
      "siteKeyDeveloperName":"GoogleSiteKey"
   },
   "patient":{
      "fields":{
         "FirstName":"Charles",
         "LastName":"Green",
         "Phone":"8012345678"
      }
   },
   "referralDetails":[
      {
         "detailType":"Insurance",
         "detailRecordType":"Member Plan",
         "fields":{
            "Name":"Aetna PPO",
            "MemberNumber":"2345678"
         }
      },
      {
         "detailType":"Based On",
         "detailRecordType":"Health Condition",
         "fields":{
            "Condition Status":"Condition",
            "Diagnostic Status":"Status"
         }
      }
   ],
   "referralNotes":"This is an urgent request",
   "referral":{
      "fields":{
         "PatientInstruction":"Need Appointment ASAP.",
         "Priority":"Urgent"
      }
   }
}

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

{
   "captchaToken": {
        "type": "ReCaptcha",
        "token": "09APYnBZUChiG3s985dvsz9eHvoAMIoa6lB0qeDvL-pZjNvZ3Qg9HgZVRo4rAxebgl_7H1ZqavwGwecshDuL0K1K9rfv0eI_dn7pqyGA",
        "siteKeyDeveloperName": "GoogleSiteKey"
    },
  "patient": {
    "fields": {
      "FirstName": "Joe",
      "LastName": "Clark",
      "Phone": "801XXXXX89"
    }
  },
  "referralDetails": [
    {
      "detailType": "Insurance",
      "detailRecordType": "Member Plan",
      "fields": {
        "Name": "Aetna PPO",
        "MemberNumber": "2345678"
      }
    },
    {
      "detailType": "Insurance",
      "detailRecordType": "Member Plan",
      "detailRecordId": "0SqRM0000004F2z0AE"
    },
    {
      "detailType": "Body Site",
      "detailRecordType": "Health Condition",
      "detailCodeId": "0hsRM000000043aYAA"
    },
    {
      "detailType": "Reason Reference",
      "detailRecordId": "0j4RM0000004MunYAE"
    }
  ],
  "requester": {
    "id": "0cmRM0000004nAgYAI"
  },
  "performers": [
    {
      "id": "0cmRM0000000l2JYAQ"
    },
    {
      "id": "0cmRM0000000tnoYAA"
    }
  ],
  "referralNotes": "This is an urgent request",
  "referral": {
    "fields": {
      "Priority": "Routine",
      "Status": "Draft",
      "Type": "Plan"
    }
  }
}

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

Response Body for POST

Guest Referral Output