PrevHealth Patient and Population Services API
Documentation for developers of applications that connect to PrevHealth's standardized FHIR API (ONC § 170.315(g)(10)).
| Product | PrevHealth |
| API | HL7 FHIR R4 (4.0.1), read and search only |
| Implementation guides | US Core 7.0.0 (USCDI v4), SMART App Launch 2.2.0, FHIR Bulk Data Access 2.0.0 |
| FHIR base URL | https://clinic.prevhealth.us/fhir/r4 (your organization's base URL is listed in the service base URL list) |
| Formats | application/fhir+json for requests and responses; application/fhir+ndjson for bulk data |
What the API provides
- Patient access. A patient authorizes an application to read their own chart.
- Clinician (EHR) launch. A clinician launches an application from PrevHealth with a patient and encounter already in context.
- Population access. A registered backend service exports data for a configured patient group.
The API is read-only: it supports read and search-type (plus the operations listed in
Resources and search parameters). It does not support create, update or delete.
Contents
| Page | What it covers |
|---|---|
| Authorization | Registering an application, the three launch types, scopes, tokens, refresh tokens (including native apps), revocation |
| Resources and search parameters | Every supported resource, profile, interaction and search parameter (generated from the server) |
| Operations and additional interactions | POST search, $docref, _revinclude, document attachments |
| Bulk data export | Group export for backend services |
| Errors and exceptions | HTTP status codes, OperationOutcome, and what to do about each |
| Implementation notes | Required software components and configuration, TLS, service base URLs, terms and conditions |
Discovery
An application should discover endpoints instead of hard-coding them:
| Document | URL |
|---|---|
| FHIR CapabilityStatement | GET <base>/metadata |
| SMART configuration | GET <base>/.well-known/smart-configuration |
| Authorization server metadata | GET https://clinic.prevhealth.us/.well-known/oauth-authorization-server and /.well-known/openid-configuration |
| Service base URLs | GET https://clinic.prevhealth.us/fhir/service-base-urls |
These are public and need no token.
Making a request
GET https://clinic.prevhealth.us/fhir/r4/Patient/<id> HTTP/1.1
Authorization: Bearer <access token>
Accept: application/fhir+json
Every request except discovery needs a bearer access token. Search results are FHIR Bundle
resources of type searchset; follow the next link to page through them. The server limits page
size, so do not assume a fixed number of results per page.