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

Resource example

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.

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

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