Referral Management

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

Resource

1/connect/health/referral-management/referrals

Resource example

1https://yourInstance.salesforce.com/services/data/v67.0/connect/health/referral-management/referrals

Available version

59.0

Requires Chatter

No

HTTP methods

POST

Request body for POST

JSON example

Here’s an example request to create an existing patient referral.

1{
2  "patient": {
3    "id": "005S7000001xLk1IAE"
4  },
5  "referralDetails": [
6    {
7      "detailType": "Insurance",
8      "detailRecordType": "Member Plan",
9      "fields": {
10        "Name": "Aetna PPO",
11        "MemberNumber": "2345678"
12      }
13    },
14    {
15      "detailType": "Insurance",
16      "detailRecordType": "Member Plan",
17      "detailRecordId": "0SqRM0000004F2z0AE"
18    }
19  ],
20  "requester": {
21    "id": "0cmS70000004CAuIAM"
22  },
23  "referralNotes": "This is an urgent request",
24  "performers": [
25    {
26      "id": "0cmRM0000004nAgYAI"
27    },
28    {
29      "id": "0cmRM0000004nAgDZc"
30    }
31  ],
32  "referral": {
33    "fields": {
34      "PatientInstruction": "Need Appointment ASAP.",
35      "Priority": "Urgent"
36    }
37  },
38  "shouldUseHighConfidenceMatch": true
39}

Here’s an example request to create a new patient referral.

1{
2  "patient": {
3    "fields": {
4      "FirstName": "Joe",
5      "LastName": "Clark",
6      "Phone": "801XXXXX89"
7    }
8  },
9  "referralDetails": [
10    {
11      "detailType": "Insurance",
12      "detailRecordType": "Member Plan",
13      "fields": {
14        "Name": "Aetna PPO",
15        "MemberNumber": "2345678"
16      }
17    },
18    {
19      "detailType": "Insurance",
20      "detailRecordType": "Member Plan",
21      "detailRecordId": "0SqRM0000004F2z0AE"
22    },
23    {
24      "detailType": "Body Site",
25      "detailRecordType": "Health Condition",
26      "detailCodeId": "0hsRM000000043aYAA"
27    },
28    {
29      "detailType": "Reason Reference",
30      "detailRecordId": "0j4RM0000004MunYAE"
31    }
32  ],
33  "requester": {
34    "id": "0cmRM0000004nAgYAI"
35  },
36  "performers": [
37    {
38      "id": "0cmRM0000000l2JYAQ"
39    },
40    {
41      "id": "0cmRM0000000tnoYAA"
42    }
43  ],
44  "referralNotes": "This is an urgent request",
45  "referral": {
46    "fields": {
47      "Priority": "Routine",
48      "Status": "Draft",
49      "Type": "Plan"
50    }
51  }
52}

Properties

Name	Type	Description	Required or Optional	Available Version
patient	Record Fields Input[]	Account details of the patient being referred.	Required	59.0
performers	Record Fields Input[]	List of healthcare providers who perform the service. You can provide a maximum of 5 provider IDs in a request.	Optional	59.0
referral	Record Fields Input[]	Referral information.	Required	59.0
referralDetails	Referral Detail Input[]	Patient details, such as, insurance, and health condition.	Optional	59.0
referralNotes	String	Referral notes.	Optional	59.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	59.0
shouldUseHighConfidenceMatch	Boolean	Indicates whether to match a duplicate record that has the highest matching confidence (true) or not (false).	Optional	59.0

Response body for POST

Referral Management Output