Patients

Patients are the clients your agency provides care to, including prospective clients you have not yet admitted.

Endpoints

The Patient object

object
stringread-only

String representing the object's type. Always patient.

id
stringread-only

Unique identifier of the patient.

firstName
string | nullmax length 100

Given name.

middleName
string | nullmax length 100

Middle name.

lastName
string | nullmax length 100

Family name.

goesByName
string | nullmax length 100

The name the patient prefers to be called.

dateOfBirth
string · date | null

Date of birth.

gender
string | nullmax length 50

Gender as recorded by the agency.

primaryLanguage
string | nullmax length 50

Language the patient is most comfortable speaking.

email
string · email | nullmax length 320

Contact email address.

active
boolean | null

Whether the patient is an active client. Only active clients are scheduled and billed. A prospective client is always inactive. If you leave it out on create, it is false for a prospect or an Inactive or Discharged status and true otherwise.

status
string | null

The client's status as shown in AveeCare. Inactive and Discharged mean the person is no longer receiving care. A prospective client (lifecycleStage: Prospect) reads Prospect even if you send Active. Creating a patient with Prospect makes them a prospective client. Defaults to Active. Usually one of Active, Inactive, Prospect, Discharged; records imported from another system can hold other values.

lifecycleStage
string | null

Whether this person is a prospective client or an admitted client. null means client. Prospects appear in the prospective-patient pool in AveeCare, not on the patient roster.

One ofProspectClientnull
serviceType
string | null

The main type of service the patient receives.

One ofSkilledNursingPhysicalTherapyHospiceStandardCarenull
address
string | nullmax length 200

Street address where care is delivered.

city
string | nullmax length 100

City of the service address.

state
string | nullmax length 50

State of the service address, as a two-letter code.

zipCode
string | nullmax length 20

ZIP code of the service address.

officeId
string | nullmax length 64

The office (branch) that serves this patient.

referralSourceId
string | nullmax length 64

The referral source that sent this patient to you.

primaryDiagnosisDescription
string | nullmax length 20000

Primary diagnosis, in plain words.

fallRisk
boolean | null

Whether the patient is a fall risk.

preferredCaregiverGender
string | nullmax length 50

Caregiver gender the patient prefers, if any.

schedulingNotes
string | nullmax length 20000

Notes schedulers see when booking visits for this patient.

responsiblePartyName
string | nullmax length 200

Person legally responsible for the patient, if not the patient.

medicaidId
string | nullmax length 50

Medicaid member ID.

medicareId
string | nullmax length 50

Medicare beneficiary identifier.

insuranceProvider
string | nullmax length 200

Primary insurance company name.

insuranceId
string | nullmax length 50

Member ID with the primary insurance.

insuranceGroupNumber
string | nullmax length 50

Group number with the primary insurance.

billingContactName
string | nullmax length 200

Who receives the bills.

billingContactEmail
string · email | nullmax length 320

Email address bills are sent to.

billingContactPhone
string | nullmax length 30

Phone number of the billing contact.

statementDelivery
string | null

How statements are delivered.

One ofEmailMailEmailAndMailNoStatementnull
paymentMethodPreference
string | null

How the patient usually pays.

One ofACHCardCheckCashPayerOnlyOthernull
outstandingBalanceCents
integer | nullread-only

Balance the patient currently owes. In cents.

createdAt
string · date-time | nullread-only

When the patient was created.

updatedAt
string · date-time | nullread-only

When the patient was last changed.