Skip to main content
GET
List a patient's chart documents

Authorizations

Authorization
string
header
required

Marketplace API key

Headers

X-Organization-Id
string
required

Target clinic organization ID

Path Parameters

id
string
required

Patient ID

Query Parameters

kind
enum<string>

Filter to a single document kind.

Available options:
insurance_card,
identification,
prior_auth,
clinical,
other
Example:

"insurance_card"

updatedSince
string

Delta sync: only documents whose record changed at or after this instant (ISO 8601). Compared against updatedAt. Pair with includeDeleted=true to also learn about documents removed from the chart since the cursor — without it a delta poll reports additions and changes only.

Example:

"2026-08-01T00:00:00.000Z"

includeDeleted
boolean
default:false

Include documents that have since been removed from the EHR chart (they carry deletedFromEhrAt). Defaults to false: a removed document is normally noise, and because removal is the newest thing that happened to it, it would otherwise sort to the top of the list.

Example:

false

category
enum<string>

Only documents whose category is this one (see category on the document). Applied before paging, so totalCount counts the filtered set.

Available options:
referral,
pathology,
lab,
imaging,
prior_authorization,
medical_records,
records_request,
correspondence,
prescription,
forms,
insurance,
billing,
audit,
disclosure
Example:

"pathology"

dateFrom
string

Only documents created in the EHR at or after this point (createdAt). A date (2026-08-01, the start of that UTC day) or a date-time with an offset. Documents the EHR did not date are excluded whenever dateFrom or dateTo is set.

Example:

"2026-08-01"

dateTo
string

Only documents created in the EHR at or before this point (createdAt). A date includes that whole UTC day. Must not be before dateFrom (400).

Example:

"2026-08-31"

Response

Success

code
string
required

Response code

Example:

"success"

data
object
required