About the Zus API
Use the Zus API to read, write, and analyze patient data programmatically. Zus is a FHIR-native platform. Our core APIs implement the FHIR R4 standard, and additional APIs support common workflows on top of FHIR data.
Environments
Zus has separate sandbox and production environments, and each API has its own base URL. Use the base URL that matches both the environment and the API you are calling. See Environments & Base URLs for the full list.
How our APIs are organized
Read and write patient data
- FHIR REST API: Store and retrieve most FHIR R4 resources, following the FHIR standard.
- GraphQL API: Query patient data with GraphQL.
- Bulk FHIR Export: Export a patient's FHIR data in bulk.
- Document upload (Data Transformer API): Upload clinical documents for Zus to convert into FHIR.
Get network data for patients
- Patient enrollment (ZAP Data Subscriptions): Enroll patients so Zus keeps their Zus Aggregated Profile current with data from our network partners.
- Chart builds (Patient History API): Run a one-time query to populate a patient's Zus Aggregated Profile from our network partners.
Authentication and access (Auth Service APIs)
- User and app client management: Create and manage users, app clients, and their access.
- OAuth for SSO and app client tokens: Sign users in and request access tokens.