Interface AccessTokenResponse

The shape of the response of the token endpoint.

Hierarchy

Properties

access_token encounter? expires_in? id_token? need_patient_banner? patient? refresh_token? scope smart_style_url? token_type

Properties

access_token

access_token: string

Optional encounter

encounter?: string

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

Optional expires_in

expires_in?: number

Lifetime in seconds of the access token, after which the token SHALL NOT be accepted by the resource server

Optional id_token

id_token?: string

Authenticated user identity and user details, if requested

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.

Optional refresh_token

refresh_token?: string

Token that can be used to obtain a new access token, using the same or a subset of the original authorization grants. If present, the app should discard any previous refresh_token associated with this launch and replace it with this new value.

scope

scope: string

Scope of access authorized. Note that this can be different from the scopes requested by 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)

token_type

token_type: "Bearer"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc