Patient Access API usage reports count members and applications over a reporting period. Each Patient Access API request produces one FHIR_REQUEST transaction log event, which carries the data needed to build these counts.
| Data Point | Transaction Log Field | Source |
|---|---|---|
| Request date and time | initialTimestamp |
Recorded by Smile CDR for every event. |
| Patient Access API request | endpointModuleId |
The module ID of the dedicated Patient Access API FHIR endpoint. |
| Request type and outcome | subType, outcome |
Recorded by Smile CDR for every event (for example, FHIR_READ and SUCCESS). |
| Member Patient ID | additionalJson.patient_id |
The patient claim of the access token. |
| Requesting application | additionalJson.client_id |
The client ID claim of the access token (client_id, or azp for IdPs such as Keycloak). |
| Member user identifier | additionalJson.subject |
The sub claim of the access token. |
The additionalJson values are added by an interceptor and depend on the claims your IdP includes in its access tokens. See Usage Event Format for a complete event.
A reporting consumer can derive the CMS metrics from the events for a reporting period:
patient_id values across successful events.patient_id values with more than one transfer. Smile CDR does not define what counts as a separate transfer; for example, you might count requests made on different days.client_id for operational reporting.patient_id may count that member more than once. Use the IdP's sub value or an enterprise member identifier to deduplicate where needed.additionalJson values.You are about to leave the Smile Digital Health documentation and navigate to the Open Source HAPI-FHIR Documentation.