Maximus FHIR API
A standards-based, read-only HL7 FHIR R4 (4.0.1) API for patient and population health data, secured with SMART App Launch 2.0.0.
Register an application →
What you must supply to obtain a client ID, and the attributes the authorization server needs.
Authorize a user →
SMART App Launch 2.0.0 standalone and EHR launch, step by step.
Call the API →
Every function, parameter, data type and return structure.
Supported scopes →
The complete scope list, including SMART 2.0.0 granular scopes.
Who this is for
This documentation is written for software developers building applications that read patient data from Maximus EHR. It assumes familiarity with HTTP, OAuth 2.0 and HL7 FHIR. It is published as the API documentation required by ONC certification criterion §170.315(g)(10) and is freely and publicly accessible — no account, registration, fee or agreement is required to read it.
Adopted standards
These are the standard versions this Health IT Module implements. Each link goes to the published specification for the version in use.
| Standard | Version | Specification |
|---|---|---|
| HL7 FHIR | R4 (4.0.1) | Read |
| HL7 FHIR US Core Implementation Guide | 6.1.0 | Read |
| USCDI | v3 | Read |
| SMART App Launch Implementation Guide | 2.0.0 | Read |
| FHIR Bulk Data Access (Flat FHIR) | 2.0.0 | Read |
| OAuth 2.0 Authorization Framework | RFC 6749 | Read |
| PKCE for OAuth 2.0 Public Clients | RFC 7636 | Read |
| OpenID Connect Core | 1.0 | Read |
| OAuth 2.0 Token Introspection | RFC 7662 | Read |
| OAuth 2.0 for Native Apps | RFC 8252 | Read |
This documentation was revised in November 2026 to reflect the standards adopted by the HTI-1 final rule. Earlier versions of these pages referenced US Core STU 3.1.1, USCDI v1 and SMART App Launch 1.0.0. Those references are superseded by the versions in the table above.
Endpoints
| Purpose | URL |
|---|---|
| FHIR service base URL | https://fhir.maximus.care/api/r4 |
| Capability statement | https://fhir.maximus.care/api/r4/metadata |
| SMART discovery | https://fhir.maximus.care/api/r4/.well-known/smart-configuration |
| Service base URL list | https://fhir.maximus.care/api/r4/service_based_url |
| Authorization endpoint | https://apiauth.maximus.care/connect/authorize |
| Token endpoint | https://apiauth.maximus.care/connect/token |
| Token introspection | https://apiauth.maximus.care/connect/introspect |
| Token revocation | https://apiauth.maximus.care/connect/revocation |
| JSON Web Key Set | https://apiauth.maximus.care/.well-known/openid-configuration/jwks |
The capability statement, SMART discovery document and service base URL list are available without authentication. Everything else requires an access token.
Quick start
Four steps take an application from nothing to reading patient data.
1. Register
Submit the registration request. You receive a
client_id, and a client_secret if your application is confidential.
2. Discover
Fetch the SMART configuration rather than hard-coding endpoints.
curl "https://fhir.maximus.care/api/r4/.well-known/smart-configuration"
3. Authorize
Send the user to the authorization endpoint with PKCE, and exchange the returned code for an access token. See SMART App Launch for the full flow.
4. Call the API
curl "https://fhir.maximus.care/api/r4/Patient/example-patient" \
-H "Authorization: Bearer <access_token>" \
-H "Accept: application/fhir+json"
Mandatory software components
An application needs no Maximus-supplied SDK, library or component. Everything required is a public standard. The components your application must provide are:
| Component | Requirement |
|---|---|
| TLS 1.2 client | Required — the server refuses TLS 1.0 and 1.1. See security and TLS. |
| OAuth 2.0 client with PKCE | Required — RFC 7636, S256 method. plain is not accepted. |
| HTTP client | Required — must follow redirects and set request headers. |
| FHIR R4 parser | Recommended — responses are standard FHIR R4 (4.0.1) JSON. Any conformant library, or plain JSON parsing, will work. |
| JWT library | Conditional — required only if you use private_key_jwt client authentication or need to read the id_token. |
| Secure credential storage | Required for confidential clients — a client secret must never ship inside a native app or browser bundle. |
Mandatory software configurations
| Configuration | Required value |
|---|---|
| Transport | HTTPS only, TLS 1.2 or above |
| Redirect URI | Registered in advance and matched exactly, including scheme, host, port and path |
code_challenge_method | S256 |
aud parameter | The FHIR service base URL, https://fhir.maximus.care/api/r4, on every authorization request |
state parameter | A cryptographically random, single-use value, verified on return |
Accept header | application/fhir+json |
Authorization header | Bearer <access_token> on every API call |
| Client authentication | client_secret_basic, client_secret_post or private_key_jwt for confidential clients; none for public clients |
Certification
Maximus EHR is certified to ONC criterion §170.315(g)(10), Standardized API for patient and population services. This documentation, the service base URL list and the API terms and conditions are published in satisfaction of the API Conditions and Maintenance of Certification at 45 CFR 170.404.
| Item | Value |
|---|---|
| Developer | MaxRemind Inc. |
| Product | Maximus EHR |
| Certification number | 15.05.05.3173.MAXR.01.00.1.231031 |
| Certification body | SLI Compliance |
| Criterion | §170.315(g)(10) Standardized API for patient and population services |
Certification details are published on the ONC Certified Health IT Product List (CHPL). Where this page and the CHPL listing differ, the CHPL listing governs.