Use this class to create an outbound referral record.
This Apex class is available to use with the Provider Management and Provider Search features enabled in your Salesforce org.
The CreateOutboundReferral class uses the default call(String action, Map<String, Object> args) method of the Callable interface. For more information on the Callable interface and its methods, see Callable Interface.
Specify the implemented CreateOutboundReferral class name in the CreateReferrals Remote Actions section of the Create Outbound Referral OmniScript page. A Remote Action calls the specified Apex class and its method to create the outbound referral records. This Apex class can create a maximum of up to three outbound referral records.
This screenshot shows how the Apex class name and its method are specified in Omniscript Remote Action:
The CreateOutboundReferral remote action accepts a JSON object with the following format as an input:
1{
2 "$schema": "http://json-schema.org/draft-04/schema#",
3 "type": "object",
4 "properties": {
5 "ReferralInformation": {
6 "type": "object",
7 "properties": {
8 "ReferrerName": {
9 "type": "string | name of the User creating Referral"
10 },
11 "ReferrerEmail": {
12 "type": "string | email of the user creating Referral"
13 },
14 "ClientId": {
15 "type": "string | AccountId of the client"
16 },
17 "ClientPhone": {
18 "type": "string | Phone number of the client"
19 },
20 "ClientName": {
21 "type": "string | Client name"
22 },
23 "IsSelfReferred": {
24 "type": "boolean | True if Referral referring to own provider"
25 },
26 "ResultCategory": {
27 "type": "string | Referral.ResultCategory picklist option"
28 },
29 "UsageType": {
30 "type": "string | Referral.UsageType picklist option"
31 },
32 "ReferrerOrg": {
33 "type": "string | Current Organization nickname, autofilled by omniscript"
34 },
35 "Title": {
36 "type": "string | Title of the Referral"
37 },
38 "ReferralType": {
39 "type": "string | Referral.ReferralType picklist option"
40 },
41 "Priority": {
42 "type": "string | Referral.Priority picklist option"
43 },
44 "Description": {
45 "type": "string | Referral.Description"
46 },
47 "Category": {
48 "type": "string | Referral.Category picklist option"
49 },
50 "ReferralDate": {
51 "type": "string | Referral.ReferralDate value"
52 },
53 "Status": {
54 "type": "string | Referral.Status picklist option"
55 }
56 }
57 },
58 "ProviderInfoForReferral": {
59 "type": "array",
60 "items": [
61 {
62 "type": "object",
63 "properties": {
64 "ProviderFacilityId": {
65 "type": "string | Selected Healthcare Practitioner Facility record id"
66 },
67 "ProviderPhone": {
68 "type": "string | Provider phone in case unregistered provider is referred"
69 },
70 "ProviderId": {
71 "type": "string | Selected Healthcare Provider record id"
72 },
73 "ProviderEmail": {
74 "type": "string | Provider email in case unregistered provider is referred"
75 }
76 }
77 }
78 ]
79 },
80 "ReferralDetails": {
81 "type": "object",
82 "properties": {
83 "ReferralTitle": {
84 "type": "string | Title of the Referral"
85 },
86 "Priority": {
87 "type": "string | Referral.Priority picklist option"
88 },
89 "Status": {
90 "type": "string | Referral.Status picklist option"
91 },
92 "Category": {
93 "type": "string | Referral.Category picklist option"
94 },
95 "Date": {
96 "type": "string | Referral.ReferralDate value"
97 },
98 "ReferralDescription": {
99 "type": "string | Referral.Description value"
100 },
101 "File1": {
102 "type": "array",
103 "items": [
104 {
105 "type": "object",
106 "properties": {
107 "data": {
108 "type": "string | ContentDocument record id for uploaded file"
109 },
110 "deleteLabel": {
111 "type": "string"
112 },
113 "filename": {
114 "type": "string | filename of uploaded file"
115 },
116 "size": {
117 "type": "string | size of uploaded file"
118 },
119 "vId": {
120 "type": "string | ContentDocument Version record Id"
121 }
122 }
123 }
124 ]
125 }
126 }
127 },
128 "SourceDocuments": {
129 "type": "array",
130 "items": [
131 {
132 "type": "object",
133 "properties": {
134 "Id": {
135 "type": "string | ContentDocument record id for attached file"
136 },
137 "Title": {
138 "type": "string | ContentDocument Title record id for attached file"
139 },
140 "FileExtension": {
141 "type": "string | ContentDocument file extension for attached file"
142 },
143 "DocumentFullName": {
144 "type": "string | ContentDocument filename for attached file."
145 }
146 }
147 }
148 ]
149 }
150 },
151 "required": [
152 "ReferralInformation",
153 "ProviderInfoForReferral",
154 "ReferralDetails",
155 "SourceDocuments"
156 ]
157}Here’s an example of the JSON object that the CreateOutboundReferral Apex class receives as input.
1{
2 "ReferralInformation": {
3 "ReferrerName": "Admin User",
4 "ReferrerEmail": "robert.l@xyz.com",
5 "ClientId": "001B000001UFMjcIAH",
6 "ClientPhone": "4159017000",
7 "ClientName": "Glen Marshal",
8 "IsSelfReferred": false,
9 "ResultCategory": "Pending",
10 "UsageType": "PublicSectorSolutions",
11 "ReferrerOrg": "pssdevgs0",
12 "Title": "Referral Title",
13 "ReferralType": "Outbound",
14 "Priority": "Critical",
15 "Description": "Referral Description",
16 "Category": "Child Abuse",
17 "ReferralDate": "2024-01-15",
18 "Status": "In Review"
19 },
20 "ProviderInfoForReferral": [
21 {
22 "ProviderFacilityId": "0bSB00000009L8rMAE",
23 "ProviderPhone": "practitioner-phone",
24 "ProviderId": "0cmB0000000DxpxIAC"
25 },
26 {
27 "ProviderFacilityId": "0bSB00000009Q2mMAE",
28 "ProviderPhone": "practitioner-phone",
29 "ProviderId": "0cmB0000000E64nIAC"
30 },
31 {
32 "ProviderEmail": "provilder@email.test.com",
33 "ProviderPhone": "1111111111"
34 }
35 ],
36 "ReferralDetails": {
37 "ReferralTitle": "Referral Title",
38 "Priority": "Critical",
39 "Status": "In Review",
40 "Category": "Child Abuse",
41 "Date": "2024-01-15",
42 "ReferralDescription": "Referral Description",
43 "File1": [
44 {
45 "data": "069xx0000004C92AAE",
46 "deleteLabel": "Delete TestPDF_For_Upload.pdf",
47 "filename": "TestPDF_For_Upload.pdf",
48 "size": "103266",
49 "vId": "068xx0000004C92AAE"
50 },
51 {
52 "data": "069xx0000004CAeAAM",
53 "deleteLabel": "Delete SchemeInfo.pdf",
54 "filename": "SchemeInfo.pdf",
55 "size": "555524",
56 "vId": "068xx0000004CAeAAM"
57 }
58 ]
59 },
60 "SourceDocuments": [
61 {
62 "Id": "0691Q00000YWEmUQAX",
63 "Title": "TestPDF_For_Upload",
64 "FileExtension": "pdf",
65 "DocumentFullName": "TestPDF_For_Upload.pdf"
66 }
67 ]
68}Here’s an example of the JSON object that the CreateOutboundReferral Apex class response returns, which contain an array of referral IDs.
1{
2 "referralIds": [
3 "0wi1Q0000008VraQAE",
4 "0wi1Q0000008VrbQAE",
5 "0wi1Q0000008VrcQAE"
6 ]
7}
j