Scopes

Complete reference for SMART on FHIR scopes supported by eClinicalWorks.

Scope Categories

patient/*.read
30 resources

Access data for a specific patient in context. Requires the patient to be selected during authorization.

user/*.read
30 resources

Access data the logged-in user can see based on their role and permissions in the EHR.

system/*.read
33 resources

Backend access to all data without user context. Used for server-to-server workflows and bulk data.

Special Scopes

launchLaunch

Retrieve permission to obtain launch context when an app is launched from an EHR.

EHR Launch
launch/patientLaunch

When launching outside the EHR (Standalone Launch), ask for a patient to be selected at launch time.

Standalone Launch
openid fhirUserIdentity

Retrieve information about the current logged-in user. Also accepted as 'openid profile'.

EHR LaunchStandalone Launch
offline_accessAccess

Request a refresh_token to obtain new access tokens even after the end-user is no longer online. Similar to background refresh of app data. Token valid for 90 days.

EHR LaunchStandalone Launch
online_accessAccess

Request a refresh_token that is usable only while the end-user remains online. Background refresh of data will not happen with this type of access.

EHR LaunchStandalone Launch

Scope Selection Tips

  • Request only the scopes your app actually needs - fewer scopes means easier approval.
  • Use offline_access for apps that need to refresh tokens when the user is not active.
  • system/Group.read is required for bulk data export operations.