Contacts

Contacts are family members and other people connected to a patient, such as an emergency contact.

Endpoints

The Contact object

object
stringread-only

String representing the object's type. Always contact.

id
stringread-only

Unique identifier of the contact.

patientId
string | nullmax length 64

The patient this contact belongs to.

name
string | nullmax length 200

Full name.

relationship
string | nullmax length 100

Relationship to the patient.

phoneNumber
string | nullmax length 30

Phone number.

email
string · email | nullmax length 320

Email address.

preferEmail
boolean | null

Whether the contact prefers email over phone.

emergencyContact
boolean | null

Whether this person is an emergency contact.

notificationPolicy
string | null

Which updates the contact is notified about.

One ofAllEmergenciesnull
createdAt
string · date-time | nullread-only

When the contact was created.

updatedAt
string · date-time | nullread-only

When the contact was last changed.