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

Where XX.X is the latest API version.

Formats: JSON, XML

HTTP Methods: POST

Authentication: Authorization: Bearer TOKEN

Where TOKEN is your OAuth access token.

Inputs

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

Outputs

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

Example

Sample Request

1{
2   "inputs":[
3      {
4         "subjectRecord":{
5            "Id":"001RM000005bZVvYAM",
6            "FirstName":"Joe",
7            "LastName":"Clark"
8         },
9         "requesterId":"001RM000005bZW0YAM",
10         "performers":[
11            "001RM000005bZW5YAM"
12         ],
13         "referralRecord":{
14            "Priority":"Routine",
15            "Status":"Draft",
16            "Type":"Plan"
17         },
18         "matchDuplicates":false,
19         "referralNotes":"This is an urgent request",
20         "referralDetails":[
21            {
22               "detailType":"Insurance",
23               "detailRecordType":"Member Plan",
24               "detailRecordId":"0SqRM00000000N10AI"
25            }
26         ]
27      }
28   ]
29}

Sample Response

1{
2  "errors": null,
3  "isSuccess": true,
4  "outputValues": {
5    "referralIds": [
6      "0lvxx00004000001AAB"
7    ]
8  }
9}