Referral

Represents the information on client referrals in an organization. This object is available in API version 56.0 and later.

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

Fields

Field	Details
AuthorizationStatus	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Specifies the authorization status of the referral for the associated provider. Available in API version 61.0 and later. Possible values are: `Authorized` `In Review` `Rejected` `Submitted`
CaseId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The case associated with the referral. This field is a relationship field. Relationship Name Case Relationship Type Lookup Refers To Case
Category	Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The category of referral.
ClientEmail	Type email Properties Create, Filter, Group, Nillable, Sort, Update Description The email address of the referred client.
ClientId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The account associated with the referred client. This field is a relationship field. Relationship Name Client Relationship Type Lookup Refers To Account
ClientLanguage	Type multipicklist Properties Create, Filter, Nillable, Update Description The languages that the referred client speaks. Possible values are: `Arabic` `Chinese` `Dutch` `English` `French` `German` `Hindi` `Portuguese` `Russian` `Spanish`
ClientName	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The name of the referred client.
ClientPhone	Type phone Properties Create, Filter, Group, Nillable, Sort, Update Description The phone number of the referred client.
Comments	Type textarea Properties Create, Nillable, Update Description Additional details about the referral.
Description	Type textarea Properties Create, Nillable, Update Description The description of the referral.
IsSelfReferred	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the referral is made by the client. The default value is `false`.
LastReferencedDate	Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record, a record related to this record, or a list view.
LastViewedDate	Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, the user might have only accessed this record or list view (<parmname>LastReferencedDate</parmname>) but not viewed it.
Name	Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description Name of the referral.
OutboundSourceId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The source of an outbound referral. This field is a polymorphic relationship field. Relationship Name OutboundSource Relationship Type Lookup Refers To Benefit Assignment, Case, Referral
OwnerId	Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the owner of this object. This field is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User
Priority	Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Indicates the priority of the referral. Possible values are: `Critical` `High` `Low` `Medium`
ProgramId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The program that's associated with the referral. This field is a relationship field. Relationship Name Program Relationship Type Lookup Refers To Program
ProviderEmail	Type email Properties Create, Filter, Group, Nillable, Sort, Update Description The email address of the person or the organization that the client is being referred to.
ProviderFacilityId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The practitioner or provider facility associated with the referral. Available in API version 59.0 and later. This field is a polymorphic relationship field. Relationship Name ProviderFacility Relationship Type Lookup Refers To CareProviderFacilitySpecialty, HealthcarePractitionerFacility
ProviderId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The account or contact associated with the person or the organization that the client is being referred to. This field is a polymorphic relationship field. Relationship Name Provider Relationship Type Lookup Refers To Account, Contact, HealthcareProvider
ProviderName	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The name of the person or the organization that the client is being referred to.
ProviderOrg	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The organization that the client is being referred to.
ProviderPhone	Type phone Properties Create, Filter, Group, Nillable, Sort, Update Description The phone number of the person or the organization that the client is being referred to.
RecordTypeId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description This field is a relationship field. Relationship Name RecordType Relationship Type Lookup Refers To RecordType
ReferralDate	Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The date on which the referral is received.
ReferralType	Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Specifies whether the referral is inbound or outbound. Possible values are: `INBOUND`—Inbound `OUTBOUND`—Outbound
ReferrerEmail	Type email Properties Create, Filter, Group, Nillable, Sort, Update Description The email address of the person or the organization that referred the client.
ReferrerId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The account or contact associated with the person or the organization that referred the client. This field is a polymorphic relationship field. Relationship Name Referrer Relationship Type Lookup Refers To Account, Contact
ReferrerName	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The name of the person or the organization that referred the client.
ReferrerOrg	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The organization that referred the client.
ReferrerPhone	Type phone Properties Create, Filter, Group, Nillable, Sort, Update Description The phone number of the person or the organization that referred the client.
Result	Type textarea Properties Create, Filter, Nillable, Sort, Update Description The outcome of the referral.
ResultCategory	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Specifies the category of the referral result. Possible values are: `Approved` `Client Declined Services` `Pending` `Referred Elsewhere` `Rejected`
Source	Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The source of the referral. Possible values are: `Application` `Email` `Message` `Other` `Phone` `Social Media` `Walk-In`
Status	Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Specifies the status of the referral. Possible values are: `Approved` `Enrolled` `In Review` `New` `Rejected`
Title	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The title of the referral.
UsageType	Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Specifies the usage of the referral.

Associated Objects

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.

ReferralFeed: Feed tracking is available for the object.
ReferralHistory: History is available for tracked fields of the object.
ReferralOwnerSharingRule: Sharing rules are available for the object.
ReferralShare: Sharing is available for the object.

Public Sector Solutions Developer Guide

Referral

Supported Calls

Fields

Associated Objects