Patient

A patient is a user that is receiving care.

The patient model

Properties

Name
id
Type
string
Description
Unique identifier for the patient.
Name
object
Type
string
Description
Always 'patient'.
Name
mrn
Type
boolean
Description
Unique external identifier for the patient.
Name
first_name
Type
string
Description
Patient's first name.
Name
middle_name
Type
string
Description
Patient's middle name.
Name
last_name
Type
string
Description
Patient's last name.
Name
gender
Type
string
Description
Patient's gender. Can be 'Female,' 'Male,' or any custom entry.
Name
email
Type
string
Description
Patient's email address.
Name
phone
Type
string
Description
Patient's phone number.
Name
date_of_birth
Type
number
Description
Timestamp of patient's date of birth. Timestamp is in Unix epoch time in milliseconds.
Name
medical_centers
Type
array of strings
Description
Medical centers that the patient belongs to.
Name
addresses
Type
array of objects
Description
Addresses of the patient.
Name
timezone
Type
string
Description
Patient's timezone.
Name
status_history
Type
array of objects
Description
Status history of the patient.
Name
custom_data
Type
array of objects
Description
Name
change_log
Type
string
Description
Change log containing a record of all the changes to the patient object.
Name
created_by
Type
string
Description
Creator of the patient.
Name
created_at
Type
number
Description
Timestamp (in Unix epoch time in milliseconds) of when the patient was created.
Name
last_updated_at
Type
number
Description
Timestamp (in Unix epoch time in milliseconds) of when the patient was last updated.

Response

{
    "id": "user_Z1zXZKvqrpwxbznuW6lJ",
    "object": "patient",
    "mrn": "8942726",
    "first_name": "Sally",
    "middle_name": "",
    "last_name": "Chen",
    "gender": "Female",
    "email": "sally@demo.com",
    "phone": "(408)872-5892",
    "date_of_birth": 770755581,
    "medical_centers": [
        "clnc_XbvBirnEb1Mli1OLwqnM"
    ],
    "addresses": [{
        "nickname": "Home",
        "line1": "60 W Main St",
        "city": "Avon",
        "state": "CT",
        "postal_code": "06001",
        "country": "US",
        "special_instructions": "Has a loud dog"
    }],
    "timezone": "America/New_York",
    "status_history": [
        {
            "status": "active",
            "changed_by": "user_Z1zXZKvqrpwxbznuW6lJ",
            "changed_at": 1653798303
        }
    ],
    "custom_data": [
        {
        "key": "cfld_FZR6ioEDTkHKn62oknLF",
        "type": "string",
        "value": "Routine Care"
        }
    ],
    "change_log": "clog_lZ0kd5CsLw8rgYPlz43r",
    "created_by": "user_Z1zXZKvqrpwxbznuW6lJ",
    "created_at": 1653798303000,
    "last_updated_at": 1653798303000
}