Skip to main content
GET
Find an instance's charts by date of birth and name, active or not

Authorizations

Authorization
string
header
required

Marketplace API key

Headers

x-session-token
string
required
X-Organization-Id
string
required

Target clinic organization ID

Query Parameters

instanceId
string
required

EHR instance (ins_…) of the caller's organization.

dateOfBirth
string
required

Date of birth (YYYY-MM-DD). A chart matches only on this exact date.

firstName
string

First name; a chart matches on either name. At least one name is required.

lastName
string

Last name; compared case-insensitively, exact otherwise.

Response

Success

code
string
required

Response code

Example:

"success"

data
object
required

The read's payload (named by the route, e.g. appointments) plus meta.