API Reference
API Reference Overview
What client.api offers, how reads and writes differ, and where each part is documented
client.api is the typed surface of the Backend SDK: one namespace per record type
(client.api.patient, client.api.qualityGap, …), each with the operations the account can grant
your app. These pages are generated from the same release as the SDK's types and are republished
with every Backend SDK release.
client.ehr, which runs operations in the account's EHR, Live or Replica, is documented on
EHR access.
Reads and writes
Every operation is labelled Read or Write.
| Read | Write | |
|---|---|---|
| Operations | get, lookup, getInsights, and queries that answer a page of records | create, update |
| PHI | protected fields arrive as vault references and the SDK reveals them in your process | the SDK tokenizes protected fields in your process before the request is sent |
| Retries | retried on transient failures (see Configuration) | never re-sent, so a lost response cannot write twice |
A lookup answers with an id and a status, never the record. Reading the record is a get with
that id, under its own grant. See PHI and the vault for how
tokenizing works.
Sections
- Operations: every
client.apioperation with its inputs, what it returns and an example response - Entity Types: the records operations read and write, with their protected fields
- Shared Types: the types record fields are built
from, such as
AddressandDemographics