Sign in
latestOpenAPI 3.0.02026-08-232861531.0 MB

d3c75c2a2f1d

patients

Show a list of patients

get/patients

Query parameters

culture'cn' | 'hk'
birthSex'M' | 'F' | 'UNK'
race'american-indian-or-alaska-native' | 'asian' | 'black-or-african-american' | 'native-hawaiian-or-other-pacific-islander' | 'white' | 'other-race'
ethnicityGroup'hispanic-or-latino' | 'not-hispanic-or-latino'
suffix'II' | 'III' | 'IV' | 'Jr.' | 'Sr.'
previousAddressstring
lastProcessedAtstring date-time
source'widget' | 'integrator' | 'ui' | 'referring-provider' | 'hub'
widget'lumabot'
mergedIntostring
createdBystring
updatedBystring
deletedBystring
deletedAtstring date-time
primaryCareProviderstring
balancenumber
balanceUpdatedAtstring date-time
searchIdsstring[]
randomNameboolean
_idstring
namestring
normalizedNamestring
firstnamestring
lastnamestring
middlenamestring
displayPhonestring
displayStatus'active' | 'pending' | 'suspended'
emailstring
safeIdstring
type'doctor' | 'staff' | 'patient' | 'guest'
rolesstring[]
organizationstring
doNotContactboolean
doNotContactMessagestring
groupsstring[]
stripeCustomerIdstring
stripeSubscriptionIdstring
salesforceIdstring
deletednumber
createdAtstring date-time
updatedAtstring date-time
lastLoginstring date-time
activenumber
masterboolean
languagestring
userstring
settingstring
{"stackTrail":"paths:/patients:get:parameters:47:schema","oasType":"schema","type":"unknown"}
addressstring
citystring
statestring
countrystring
postcodestring
gender'male' | 'female' | 'unknown' | 'nonbinary'
allowedIpsstring[]
avatarstring
publicKeystring
directMessagingEmailstring
websitestring
patientGlobalSearchstring

Search for a patient within the resource using the current parameters Luma Patient ID (patient._id), MRN (patient.medicalRecordNumber), Name combos(patient.firstname, patient.lastname) OR (patient.lastname,patient.firstname), All contact method (phone number and email - active OR not), ExternalID (patient.externalId.value), Date of Birth.

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.

searchByNameOrDobOrPhoneNumberstring

If this parameter is passed, we perform a search by name or DOB or Phone Number, limited by parameter 'limit' and ignoring all other parameters.

Response

Returns a list of patients

pageinteger required
sizeinteger required