The Patient Access API lets members use a third-party application of their choice to retrieve their own health data from a payer. The application authenticates the member with the payer's identity provider, receives an access token scoped to that member, and then reads the member's records from the payer's FHIR server.
The CMS Interoperability and Patient Access Final Rule (CMS-9115-F) requires impacted payers to make member data available through a Patient Access API. The CMS Interoperability and Prior Authorization Final Rule CMS-0057-F adds prior authorization data to the API and requires payers to report Patient Access API usage metrics to CMS each year, including:
To produce these metrics, each Patient Access API request must be attributable to a member and to the application that made it. By default, the Smile CDR transaction log records the authenticated user, but not the member's Patient ID or the requesting application's client ID as they appear in the access token.
Smile CDR captures this information with standard product features:
onAuthenticateSuccess callback script copies the member and application claims into the user session.See Usage Reporting for details.
The API is built on HL7 FHIR R4. Members authorize applications using SMART App Launch and OAuth 2.0.
You are about to leave the Smile Digital Health documentation and navigate to the Open Source HAPI-FHIR Documentation.