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 |
|
performers |
|
referralDetailsRecords |
|
referralNotes |
|
referralRecord |
|
requesterId |
|
subjectRecord |
|
Outputs
Output | Details |
---|---|
referralIds |
|
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"
]
}
}