The Patient object
Patient records, always found by patient ID, phone number, or MRN. Patient API: an API key, or an org admin’s OAuth token.
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 the patient replied STOP to texts. Secure-link messages by email still work.
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 |
Last updated on