| Term | Definition |
|---|---|
| Access Token | A token issued by the IdP that the application presents with each API request. Its claims identify the member and the application. |
| additionalJson | A property of a transaction log event that holds custom key/value pairs added by interceptors. |
| Claim | A named value in an access token, such as sub, patient, or client_id. |
| Client ID | The identifier the IdP assigns to a registered application. Carried in the client_id claim, or the azp (authorized party) claim for some IdPs. |
| CMS-0057-F | The CMS Interoperability and Prior Authorization Final Rule, which includes the Patient Access API usage reporting requirement. |
| CMS-9115-F | The CMS Interoperability and Patient Access Final Rule, which established the Patient Access API. |
| Identity Provider (IdP) | The payer's OAuth 2.0 / OpenID Connect server that authenticates members and issues access tokens. |
| Member (Patient) | The individual whose health data is being accessed through the API. |
| Patient Compartment | The set of FHIR resources that belong to a single Patient. Patient Access API sessions are limited to the member's compartment. |
| SMART on FHIR | A set of standards that use OAuth 2.0 to let applications access FHIR data with the user's authorization. |
| Third-Party Application | A health app chosen by the member that retrieves the member's data through the Patient Access API. |
| Transaction Log | The Smile CDR log of requests processed by endpoint modules. Each request produces one event. |
| User Data | Custom key/value pairs stored on a user session, typically set by an authentication callback script. |
You are about to leave the Smile Digital Health documentation and navigate to the Open Source HAPI-FHIR Documentation.