The Patient object
Patient records, always found by patient ID, phone number, or MRN. Patient API.
Attributes
idUUIDRequiredUnique ID of the patient.
first_namestring or nullRequiredFirst name. Null for a patient created from an unknown phone number.
last_namestring or nullRequiredLast name.
date_of_birthdate or nullRequiredDate of birth.
phonestring or nullRequiredMobile number in E.164 format.
emailstring or nullRequiredEmail address.
mrnstring or nullRequiredThe patient’s ID in your system, such as an MRN. Up to 36 characters, unique in the organization.
sms_opted_outbooleanRequiredWhether your organization’s numbers can’t text the patient, for any reason: true exactly when sms_undeliverable_reasons isn’t empty. Secure-link messages by email still work.
sms_undeliverable_reasonsarray of opted_out, carrier_blocked, admin_blocked, unreachableRequiredWhy your organization’s numbers can’t text the patient, most important first: opted_out (the patient replied STOP to one of your numbers, or staff recorded their opt-out; the patient lifts it by texting START), carrier_blocked (the carrier refused a text because the patient replied STOP to that number; they lift it by texting START to one of your numbers), admin_blocked (an admin blocked the number; only an admin can unblock it), unreachable (an earlier text failed because the number is a landline or its carrier can’t be reached; it clears when the patient texts one of your numbers, their phone number is changed, or an admin clears it). Each reason blocks every one of your numbers. Empty when the patient can be texted.
conversation_countintegerRequiredHow many conversations the patient has in the organization, on any phone number.
created_attimestampRequiredWhen the patient was created.
matched_bymrn, phone, email, nullOn Create a patient: which field matched an existing patient. Null when the patient was just created.
Endpoints
| Method | Path | Endpoint |
|---|---|---|
| GET | /patients | Find patients |
| POST | /patients | Create a patient |
| GET | /patients/{patientId} | Retrieve a patient |
| PATCH | /patients/{patientId} | Update a patient |
| DELETE | /patients/{patientId} | Delete a patient |