latestOpenAPI 3.0.02026-08-232861531.0 MB
d3c75c2a2f1d
referrals
Get a referral by id
get/referrals/{referralId}
Path parameters
referralIdstring required
Response
A referral
_idstring
Luma's internal ID of an object.
userstring
The ID of the root account user.
deleted0 | 1
Flag for logical deletion where 1 means deleted.
createdBystring
The ID of the user who created this object.
updatedBystring
The ID of the user who updated this object.
createdAtstring date-time
The date/time when this object was created.
updatedAtstring date-time
The date/time when this object was updated.
namestring
facilitystring
providerstring
patientstring
referringProviderIdstring
referringProviderstring
durationnumber
statusReason'patient-cancelled' | 'invalid-insurance' | 'missing-data' | 'other'
statusReasonDescriptionstring
source'upload' | 'patient-referral-form' | 'ui' | 'integrator' | 'followup' | 'manual'
status'active' | 'called' | 'called-late' | 'scheduled' | 'scheduled-late' | 'incomplete' | 'expired' | 'cancelled' | 'pending' | 'closed'
startOnstring date-time
expireAtstring date-time
attemptnumber
lastAttemptSentAtstring date-time
calledAtstring date-time
acceptedAtstring date-time
scheduledAtstring date-time
notesstring
customerNotesstring
appointmentTypestring
reasonstring
departmentOrFacilitystring
scheduledByAppointmentstring
scheduledByOfferstring
processedReferralFollowup'pending' | 'skipped' | 'failed' | 'success'
uploadstring
faxUploadstring
faxSentAtstring date-time
scheduleStartOnstring date-time
referringProviderFaxNumberOverridestring