For the complete documentation index, see llms.txt. This page is also available as Markdown.

Contacts

Manage contacts associated with patients, such as family members and caregivers.

Contacts are non-patient individuals associated with a patient record — such as family members, caregivers, emergency contacts, or referring providers.

Base path: /{tenantName}/{instanceName}/patients/{patientId}/contacts


Endpoints

GET Get All Contacts

GET /{tenantName}/{instanceName}/patients/{patientId}/contacts

Returns all contacts associated with a patient.

Query Parameters

Parameter
Type
Default
Description

page

integer

0

Page number

size

integer

20

Results per page

Example Response 200 OK

{
  "data": [
    {
      "id": "contact-uuid",
      "patientId": "a1b2c3d4",
      "firstName": "Robert",
      "lastName": "Smith",
      "relationship": "SPOUSE",
      "phone": "+14155550001",
      "email": "robert.smith@example.com",
      "isPrimary": true
    }
  ]
}

GET Get Contact by ID

GET /{tenantName}/{instanceName}/patients/{patientId}/contacts/{contactId}

Returns a single contact record.


POST Create Contact

POST /{tenantName}/{instanceName}/patients/{patientId}/contacts

Creates a new contact for a patient.

Request Body

Field
Type
Required
Description

firstName

string

Yes

Contact's first name

lastName

string

Yes

Contact's last name

relationship

string

Yes

Relationship type (e.g., SPOUSE, PARENT, CAREGIVER)

phone

string

No

Contact phone number

email

string

No

Contact email address

isPrimary

boolean

No

Whether this is the primary contact


PATCH Update Contact

PATCH /{tenantName}/{instanceName}/patients/{patientId}/contacts/{contactId}

Partially updates a contact record.

Last updated

Was this helpful?