Supported scopes
Every scope the Maximus authorization server will grant, including SMART 2.0.0 granular scopes.
Maximus implements SMART App Launch 2.0.0 scopes, and continues to accept SMART v1 scope syntax for backwards compatibility. The authorization server advertises the complete, authoritative list at its discovery endpoint:
The server declares both permission-v1 and permission-v2
capabilities. A v1 request such as patient/Observation.read is honoured and is treated
as equivalent to patient/Observation.rs. New applications should use v2 syntax.
Scope syntax
A SMART v2 resource scope has three parts:
<context>/<Resource>.<permissions>[?<parameter>=<value>]
context patient | user | system
Resource a FHIR resource type, or * for all supported types
permissions any of c r u d s (create, read, update, delete, search)
parameter an optional filter that narrows the scope further
The Maximus FHIR API is read-only. Only the r (read) and
s (search) permissions are granted; .rs is therefore the widest permission
set any scope carries. Requests for c, u or d are not granted.
Identity and context scopes
| Scope | Purpose |
|---|---|
openid | Requests an OpenID Connect id_token. Pair with fhirUser. |
fhirUser | Adds a fhirUser claim to the id_token, referencing the FHIR resource for the logged-in user. |
launch | EHR launch. Requests the full launch context associated with the launch parameter. |
launch/patient | Standalone launch. Asks the authorization server to present a patient picker and return a patient context. |
offline_access | Requests a refresh token that remains valid after the user's session ends. See refresh tokens. |
Patient-level scopes
Granted to applications acting on behalf of a single patient. Access is confined to the patient in the token's launch context.
- patient/*.rs
- patient/AllergyIntolerance.rs
- patient/CarePlan.rs
- patient/CareTeam.rs
- patient/Condition.rs
- patient/Coverage.rs
- patient/Device.rs
- patient/DiagnosticReport.rs
- patient/DocumentReference.rs
- patient/Encounter.rs
- patient/Goal.rs
- patient/Immunization.rs
- patient/Location.rs
- patient/Medication.rs
- patient/MedicationDispense.rs
- patient/MedicationRequest.rs
- patient/Observation.rs
- patient/Organization.rs
- patient/Patient.rs
- patient/Practitioner.rs
- patient/PractitionerRole.rs
- patient/Procedure.rs
- patient/Provenance.rs
- patient/QuestionnaireResponse.rs
- patient/RelatedPerson.rs
- patient/ServiceRequest.rs
- patient/Specimen.rs
User-level scopes
Granted to applications acting on behalf of a logged-in user, confined to the patients that user is permitted to see.
- user/*.rs
- user/AllergyIntolerance.rs
- user/CarePlan.rs
- user/CareTeam.rs
- user/Condition.rs
- user/Coverage.rs
- user/Device.rs
- user/DiagnosticReport.rs
- user/DocumentReference.rs
- user/Encounter.rs
- user/Goal.rs
- user/Immunization.rs
- user/Location.rs
- user/Medication.rs
- user/MedicationDispense.rs
- user/MedicationRequest.rs
- user/Observation.rs
- user/Organization.rs
- user/Patient.rs
- user/Practitioner.rs
- user/PractitionerRole.rs
- user/Procedure.rs
- user/Provenance.rs
- user/QuestionnaireResponse.rs
- user/RelatedPerson.rs
- user/ServiceRequest.rs
- user/Specimen.rs
System-level scopes
Granted through the SMART Backend Services flow, for server-to-server access with no user present. Used for bulk export.
- system/*.rs
- system/AllergyIntolerance.rs
- system/CarePlan.rs
- system/CareTeam.rs
- system/Condition.rs
- system/Coverage.rs
- system/Device.rs
- system/DiagnosticReport.rs
- system/DocumentReference.rs
- system/Encounter.rs
- system/Goal.rs
- system/Immunization.rs
- system/Location.rs
- system/Medication.rs
- system/MedicationDispense.rs
- system/MedicationRequest.rs
- system/Observation.rs
- system/Organization.rs
- system/Patient.rs
- system/Practitioner.rs
- system/PractitionerRole.rs
- system/Procedure.rs
- system/Provenance.rs
- system/QuestionnaireResponse.rs
- system/RelatedPerson.rs
- system/ServiceRequest.rs
- system/Specimen.rs
Granular scopes
SMART 2.0.0 allows a scope to be narrowed by a search parameter, so an application can request one category of data rather than an entire resource type. The following granular scopes are supported:
- patient/Condition.rs?category=http://hl7.org/fhir/us/core/CodeSystem/condition-category|health-concern
- patient/Condition.rs?category=http://terminology.hl7.org/CodeSystem/condition-category|encounter-diagnosis
- patient/Condition.rs?category=http://terminology.hl7.org/CodeSystem/condition-category|problem-list-item
- patient/DocumentReference.rs?category=http://hl7.org/fhir/us/core/CodeSystem/us-core-documentreference-category|clinical-note
- patient/Observation.rs?category=http://hl7.org/fhir/us/core/CodeSystem/us-core-category|sdoh
- patient/Observation.rs?category=http://terminology.hl7.org/CodeSystem/observation-category|laboratory
- patient/Observation.rs?category=http://terminology.hl7.org/CodeSystem/observation-category|social-history
- patient/Observation.rs?category=http://terminology.hl7.org/CodeSystem/observation-category|survey
- patient/Observation.rs?category=http://terminology.hl7.org/CodeSystem/observation-category|vital-signs
- user/Condition.rs?category=http://hl7.org/fhir/us/core/CodeSystem/condition-category|health-concern
- user/Condition.rs?category=http://terminology.hl7.org/CodeSystem/condition-category|encounter-diagnosis
- user/Condition.rs?category=http://terminology.hl7.org/CodeSystem/condition-category|problem-list-item
- user/DocumentReference.rs?category=http://hl7.org/fhir/us/core/CodeSystem/us-core-documentreference-category|clinical-note
- user/Observation.rs?category=http://hl7.org/fhir/us/core/CodeSystem/us-core-category|sdoh
- user/Observation.rs?category=http://terminology.hl7.org/CodeSystem/observation-category|laboratory
- user/Observation.rs?category=http://terminology.hl7.org/CodeSystem/observation-category|social-history
- user/Observation.rs?category=http://terminology.hl7.org/CodeSystem/observation-category|survey
- user/Observation.rs?category=http://terminology.hl7.org/CodeSystem/observation-category|vital-signs
Granular scope strings contain a full code system URL and are long. Ensure your authorization request is URL-encoded and that your HTTP client does not impose a short query-string limit.
Complete advertised list
104 scope strings are advertised in total: 5 identity and context scopes, 27 patient-level, 27 user-level, 27 system-level and 18 granular.
Authorization server capabilities
The following SMART capabilities are declared:
- launch-ehr
- launch-standalone
- client-confidential-symmetric
- client-confidential-asymmetric
- client-public
- authorize-post
- sso-openid-connect
- context-ehr-patient
- context-ehr-encounter
- context-standalone-patient
- context-standalone-encounter
- context-banner
- context-style
- permission-offline
- permission-patient
- permission-user
- permission-v1
- permission-v2