Interface AuthorizationToken

The authorization token (for example the one that is represented as code parameter in the code flow)

Hierarchy

Properties

client_id client_type? code_challenge? code_challenge_method? context encounter? need_patient_banner? patient? redirect_uri scope smart_style_url? user?

Properties

client_id

client_id: string

The client_id of the app being launched

Optional client_type

client_type?: SMARTClientType

Optional code_challenge

code_challenge?: string

The code_challenge used by the app

Optional code_challenge_method

code_challenge_method?: string

The code_challenge_method used by the app

context

context: LaunchContext

Optional encounter

encounter?: string

String value with an encounter id, indicating that the app was launched in the context of FHIR Encounter 123.

Optional need_patient_banner

need_patient_banner?: boolean

Boolean value indicating whether the app was launched in a UX context where a patient banner is required (when true) or not required (when false). An app receiving a value of false should not take up screen real estate displaying a patient banner.

Optional patient

patient?: string

String value with a patient id, indicating that the app was launched in the context of FHIR Patient 123. If the app has any patient-level scopes, they will be scoped to Patient 123.

redirect_uri

redirect_uri: string

scope

scope: string

The scopes requested bu the app

Optional smart_style_url

smart_style_url?: string

String URL where the EHR’s style parameters can be retrieved (for apps that support styling)

Optional user

user?: string

The selected user ID (if any)

Example

`Patient/123` or `Practitioner/123`

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc