Create Referral Action

Create a patient referral record. A patient referral consists of multiple objects, such as an account, clinical service request, and clinical service request detail.

This action is available in API version 59.0 and later for users with the Health Cloud license.

Supported REST HTTP Methods

URI
/services/data/vXX.X/actions/standard/createReferral
Formats
JSON, XML
HTTP Methods
POST
Authentication
Authorization: Bearer token

Inputs

Input Details
matchDuplicates
Type
Boolean
Description
Indicates whether to match a duplicate record that has the highest matching confidence (true) or not (false).
performers
Type
String[]
Description
Required. Comma-separated list of IDs of the organizations or practitioners who perform the service.
referralDetailsRecords
Type
Reference
Description
Collection of ClinicalServiceRequestDetails records that contain the referral information.
referralNotes
Type
String
Description
Referral notes.
referralRecord
Type
Reference
Description
Required. ClinicalServiceRequest record that contains referral information.
requesterId
Type
String
Description
Required. ID of the provider requesting the service.
subjectRecord
Type
Reference
Description
Required. Account details of the patient being referred.

Outputs

Output Details
referralIds
Type
String[]
Description
List of IDs of the new referral records.

Example

Sample Request

{
   "inputs":[
      {
         "subjectRecord":{
            "Id":"001RM000005bZVvYAM",
            "FirstName":"Joe",
            "LastName":"Clark"
         },
         "requesterId":"001RM000005bZW0YAM",
         "performers":[
            "001RM000005bZW5YAM"
         ],
         "referralRecord":{
            "Priority":"Routine",
            "Status":"Draft",
            "Type":"Plan"
         },
         "matchDuplicates":false,
         "referralNotes":"This is an urgent request",
         "referralDetails":[
            {
               "detailType":"Insurance",
               "detailRecordType":"Member Plan",
               "detailRecordId":"0SqRM00000000N10AI"
            }
         ]
      }
   ]
}

Sample Response

{
  "errors": null,
  "isSuccess": true,
  "outputValues": {
    "referralIds": [
      "0lvxx00004000001AAB"
    ]
  }
}