Sign in
latestOpenAPI 3.0.02026-08-232861531.0 MB

d3c75c2a2f1d

referrals

List referrals

get/referrals

Query parameters

_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.

pageinteger
limitinteger

How many items to fetch per page

_populatestring

Response properties which will be replaced by the referenced objects, separated by commas.

_selectstring

Response properties that should be returned, separated by commas.

facilitystring
providerstring
patientstring
referringProviderIdstring
referringProviderstring

The name of the referring provider

durationnumber

Optional duration for how long the patient should be seen for

statusReason'patient-cancelled' | 'invalid-insurance' | 'missing-data' | 'other'

Reason why there's a status update to this referral

statusReasonDescriptionstring

Free text explaining more details about closing chat activities

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

When the costumer has multiple departments/facilities, this field makes it easier to handle where the referral should go

scheduledByAppointmentstring
scheduledByOfferstring
processedReferralFollowup'pending' | 'skipped' | 'failed' | 'success'
uploadstring
faxUploadstring
faxSentAtstring date-time
scheduleStartOnstring date-time
referringProviderFaxNumberOverridestring

If set, the fax sent back to the referring provider will be sent to this value instead of the fax contact on the referring provider record.

Response

List of referrals

pageinteger required
sizeinteger required