Referrals
Individual referrals of a prospective client, tracked from first contact to admission.
Endpoints
The Referral object
object
stringread-only
String representing the object's type. Always referral.
id
stringread-only
Unique identifier of the referral.
referralSourceId
string | nullmax length 64
Who made the referral.
patientId
string | nullmax length 64
The patient record, once one exists.
patientName
string | nullmax length 200
Name of the person referred.
contactPhone
string | nullmax length 30
Phone number to reach the person or their family.
contactEmail
string · email | nullmax length 320
Email address to reach the person or their family.
referralDate
string · date-time | null
When the referral arrived.
status
string | null
Where the referral stands.
One of
NewContactedAssessmentScheduledAssessmentCompletedServiceAgreementSentAdmittedDeclinedLostnullestimatedCareNeeds
string | nullmax length 20000
Care the person is expected to need.
estimatedWeeklyHours
number | nullmin 0
Expected hours of care per week.
urgencyLevel
string | nullmax length 50
How soon care is needed.
declineReason
string | nullmax length 20000
Why the referral was declined or lost.
notes
string | nullmax length 20000
Notes.
convertedDate
string · date-time | nullread-only
When the person was admitted as a client.
createdAt
string · date-time | nullread-only
When the referral was created.
updatedAt
string · date-time | nullread-only
When the referral was last changed.