Application access — §170.315(g)(7) and (g)(9)
How patient selection and the all-data request are served, and where each documentation requirement is answered.
Maximus EHR is certified for three API criteria. All three are served by the same HL7 FHIR R4 (4.0.1) API documented on this site — there is no second API to integrate with, and no separate credential to obtain.
| Criterion | Name | Served by |
|---|---|---|
§170.315(g)(7) | Application access — patient selection | SMART App Launch patient context, and Patient search |
§170.315(g)(9) | Application access — all data request | DocumentReference search and Binary retrieval, returning a C-CDA summary document |
§170.315(g)(10) | Standardized API for patient and population services | The full FHIR API — see the API reference |
§170.315(g)(7) — Patient selection
This criterion requires that an application be able to obtain an identifier for a single patient, and that the identifier be usable in subsequent data requests. Maximus returns that identifier through the SMART App Launch flow rather than through a separate selection endpoint, so the patient an application may act on is decided by the authorization server, not asserted by the application.
| Launch type | How the patient is selected | Where the identifier is returned |
|---|---|---|
| Standalone launch | The application requests the launch/patient scope. Maximus authenticates the user and presents a patient selection screen. | The patient field of the token response |
| EHR launch | The user selects the patient inside Maximus EHR and launches the application from that context. The application passes the opaque launch parameter back on its authorization request. | The patient field of the token response |
{
"access_token": "eyJhbGciOi...",
"token_type": "Bearer",
"patient": "example-patient",
"scope": "launch/patient patient/*.rs"
}
That patient value is the identifier used in every subsequent request, as the
patient search parameter:
curl "https://fhir.maximus.care/api/r4/Condition?patient=example-patient" \
-H "Authorization: Bearer <access_token>"
A token carrying a patient launch context is bound to that
patient. Supplying a different patient value returns 403 Forbidden. An
application cannot widen its own access by changing the parameter.
Where an application holds a user/ scope rather than a patient context — a
provider-facing application, for example — patients are located with Patient search,
bounded by what that user is permitted to see. See the
Patient resource for its search parameters.
§170.315(g)(9) — All data request
This criterion requires that an application be able to request all of a patient's
data in one request, as a summary record, and to request it for a specified date range. Maximus
serves this through DocumentReference, which indexes the C-CDA summary documents held
for a patient, and Binary, which returns the document itself.
Step 1 — find the documents
curl "https://fhir.maximus.care/api/r4/DocumentReference?patient=example-patient" \
-H "Authorization: Bearer <access_token>" \
-H "Accept: application/fhir+json"
The response is a Bundle. Each entry's
content.attachment.url addresses the document.
Step 2 — narrow by date range
The date search parameter accepts comparator prefixes, so a range is expressed as two
bounds on the same parameter:
GET https://fhir.maximus.care/api/r4/DocumentReference?patient=example-patient&date=ge2026-01-01&date=le2026-12-31
Step 3 — retrieve the document
Follow the attachment.url from step 1. The response is the C-CDA document, conforming
to HL7 CDA R2 Consolidated CDA Release 2.1 and covering the
USCDI v3 data classes.
A C-CDA is large, and DocumentReference search may return many of
them. Returning each document inline would make a search response unusable. The two-step pattern is
the one US Core specifies, and it lets an application list what exists before deciding what to
fetch.
Documentation requirements
Each of these criteria requires API documentation covering the same points. Because one API serves all three, the documentation is shared. This table says where each point is answered.
| Required | Where |
|---|---|
| API syntax | API reference — API syntax |
| Function names | API reference — per resource |
| Required and optional parameters, and their data types | API reference — search parameter tables |
| Return variables and their types and structures | API reference — return structures, with worked examples |
| Exceptions and exception handling methods, and their returns | Errors and exceptions |
| Mandatory software components | Overview — mandatory software components |
| Mandatory software configurations | Overview — mandatory software configurations |
| Terms of use | API terms and conditions |
This documentation is published at a publicly accessible hyperlink with no preconditions, no fee and no agreement required to read it.