---
schema_version: "1"
id: 3c87159db3343c3d9f66be178596932dd59cd206f595d1463a88441c9dc04de1
title: Referral Management
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/health_cloud_object_reference/connect_resources_referal_management.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/connect_resources_referal_management.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 310f305eb156fdd677cf224f950ba8aae18ed831e4d0dcc58e2e920e486deaf8
description: Create a patient referral in a Salesforce org from an external data source.
---
# Referral Management

Create a patient referral in a Salesforce org from an external data source.

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

/connect/health/referral-management/referrals

## Resource Example

Replace {yourInstance} with the My Domain name of your Salesforce org.

https://{yourInstance}.salesforce.com/services/data/v68.0/connect/health/referral-management/referrals

## Available Version

59.0

## Requires Chatter

No

## HTTP Methods

POST

## JSON example

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

{
  "patient": {
    "id": "005S7000001xLk1IAE"
  },
  "referralDetails": \[
    {
      "detailType": "Insurance",
      "detailRecordType": "Member Plan",
      "fields": {
        "Name": "Aetna PPO",
        "MemberNumber": "2345678"
      }
    },
    {
      "detailType": "Insurance",
      "detailRecordType": "Member Plan",
      "detailRecordId": "0SqRM0000004F2z0AE"
    }
  \],
  "requester": {
    "id": "0cmS70000004CAuIAM"
  },
  "referralNotes": "This is an urgent request",
  "performers": \[
    {
      "id": "0cmRM0000004nAgYAI"
    },
    {
      "id": "0cmRM0000004nAgDZc"
    }
  \],
  "referral": {
    "fields": {
      "PatientInstruction": "Need Appointment ASAP.",
      "Priority": "Urgent"
    }
  },
  "shouldUseHighConfidenceMatch": true
}

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

{
  "patient": {
    "fields": {
      "FirstName": "Joe",
      "LastName": "Clark",
      "Phone": "801XXXXX89"
    }
  },
  "referralDetails": \[
    {
      "detailType": "Insurance",
      "detailRecordType": "Member Plan",
      "fields": {
        "Name": "Aetna PPO",
        "MemberNumber": "2345678"
      }
    },
    {
      "detailType": "Insurance",
      "detailRecordType": "Member Plan",
      "detailRecordId": "0SqRM0000004F2z0AE"
    },
    {
      "detailType": "Body Site",
      "detailRecordType": "Health Condition",
      "detailCodeId": "0hsRM000000043aYAA"
    },
    {
      "detailType": "Reason Reference",
      "detailRecordId": "0j4RM0000004MunYAE"
    }
  \],
  "requester": {
    "id": "0cmRM0000004nAgYAI"
  },
  "performers": \[
    {
      "id": "0cmRM0000000l2JYAQ"
    },
    {
      "id": "0cmRM0000000tnoYAA"
    }
  \],
  "referralNotes": "This is an urgent request",
  "referral": {
    "fields": {
      "Priority": "Routine",
      "Status": "Draft",
      "Type": "Plan"
    }
  }
}

## Properties

<table class="featureTable sort_table" summary="">





          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader vertical-align-top " id="d630442e136">Name</th>

              <th class="featureTableHeader vertical-align-top " id="d630442e139">Type</th>

              <th class="featureTableHeader vertical-align-top " id="d630442e142">Description</th>

              <th class="featureTableHeader vertical-align-top " id="d630442e145">Required or Optional</th>

              <th class="featureTableHeader vertical-align-top " id="d630442e148">Available Version</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d630442e136" data-title="Name"><samp class="codeph nolang">patient</samp></td>

              <td class="entry" headers="d630442e139" data-title="Type">
                <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/connect_requests_record_fields_input.htm" title="Input representation of the request to create a generic object, such as an account, or referral details.">Record Fields Input</a>[]
              </td>

              <td class="entry" headers="d630442e142" data-title="Description">Account details of the patient being referred.</td>

              <td class="entry" headers="d630442e145" data-title="Required or Optional">Required</td>

              <td class="entry" headers="d630442e148" data-title="Available Version">59.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d630442e136" data-title="Name"><samp class="codeph nolang">performers</samp></td>

              <td class="entry" headers="d630442e139" data-title="Type">
                <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/connect_requests_record_fields_input.htm" title="Input representation of the request to create a generic object, such as an account, or referral details.">Record Fields Input</a>[]
              </td>

              <td class="entry" headers="d630442e142" data-title="Description">List of healthcare providers who perform the service. <p class="p">You can provide
                  a maximum of 5 provider IDs in a request.</p>
              </td>

              <td class="entry" headers="d630442e145" data-title="Required or Optional">Optional</td>

              <td class="entry" headers="d630442e148" data-title="Available Version">59.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d630442e136" data-title="Name"><samp class="codeph nolang">referral</samp></td>

              <td class="entry" headers="d630442e139" data-title="Type">
                <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/connect_requests_record_fields_input.htm" title="Input representation of the request to create a generic object, such as an account, or referral details.">Record Fields Input</a>[]
              </td>

              <td class="entry" headers="d630442e142" data-title="Description">Referral information.</td>

              <td class="entry" headers="d630442e145" data-title="Required or Optional">Required</td>

              <td class="entry" headers="d630442e148" data-title="Available Version">59.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d630442e136" data-title="Name"><samp class="codeph nolang">referralDetails</samp></td>

              <td class="entry" headers="d630442e139" data-title="Type">
                <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/connect_requests_referral_detail_input.htm" title="Input representation of the request to create patient referral details.">Referral Detail Input</a>[]
              </td>

              <td class="entry" headers="d630442e142" data-title="Description">Patient details, such as, insurance, and health condition.</td>

              <td class="entry" headers="d630442e145" data-title="Required or Optional">Optional</td>

              <td class="entry" headers="d630442e148" data-title="Available Version">59.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d630442e136" data-title="Name"><samp class="codeph nolang">referralNotes</samp></td>

              <td class="entry" headers="d630442e139" data-title="Type">String</td>

              <td class="entry" headers="d630442e142" data-title="Description">Referral notes.</td>

              <td class="entry" headers="d630442e145" data-title="Required or Optional">Optional</td>

              <td class="entry" headers="d630442e148" data-title="Available Version">59.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d630442e136" data-title="Name"><samp class="codeph nolang">requester</samp></td>

              <td class="entry" headers="d630442e139" data-title="Type">
                <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/connect_requests_record_fields_input.htm" title="Input representation of the request to create a generic object, such as an account, or referral details.">Record Fields Input</a>[]
              </td>

              <td class="entry" headers="d630442e142" data-title="Description">Information about the provider requesting the service. A requester can be
                an Account, Asset, Healthcare Provider, or a CareRegisteredDevice object.
                <p class="p">If the requester is new, provide information to create an
                  account.</p>
              </td>

              <td class="entry" headers="d630442e145" data-title="Required or Optional">Optional</td>

              <td class="entry" headers="d630442e148" data-title="Available Version">59.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d630442e136" data-title="Name"><samp class="codeph nolang">shouldUseHighConfidenceMatch</samp></td>

              <td class="entry" headers="d630442e139" data-title="Type">Boolean</td>

              <td class="entry" headers="d630442e142" data-title="Description">Indicates whether to match a duplicate record that has the highest
                matching confidence (<samp class="codeph nolang">true</samp>) or not
                (<samp class="codeph nolang">false</samp>).</td>

              <td class="entry" headers="d630442e145" data-title="Required or Optional">Optional</td>

              <td class="entry" headers="d630442e148" data-title="Available Version">59.0</td>

            </tr>

          </tbody>

        </table>

## Response Body for POST

[Referral Management Output](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/connect_responses_referral_management_output.htm "Output representation of the request to create a patient referral.")