Particle Health supports a RESTful web service based on the FHIR and C-CDA standards. We expose APIs by which verified customers (data seekers) may access health records for over 250M unique patients across the US.
The docs available here will help you get started as a developer using the Particle Health platform. They assume familiarity with web communication tools and protocols, such as HTTP/S. Please reach out to your Particle Health representative to create a service account and retrieve credentials before you begin.
To start, it's a good idea to familiarize yourself with our guides to Authentication and Handling Errors.
Next, you can read about the endpoints and domain-specific concepts we work with, such as Files, Patients, and Documents.
Global Conventions
- IDs: Wherever a path accepts “Patient ID or Particle Patient ID,” the system queries both with OR logic and returns a match if either resolves.
- Auth: OAuth2 Client‑Credentials → Bearer token (sent as
Authorization: Bearer…). - Pagination: Endpoints using continuation_token or page_token return the next token in the response; pass it back verbatim.
- Rate limits: Standard bucket/TTL middleware is enforced. Limits vary by tenant.
- Time formats: Unless stated, timestamps are ISO‑8601 / RFC3339.