Interface LaunchContext

Once an app is authorized, the token response will include any context data the app requested and any (potentially) unsolicited context data the EHR may decide to communicate. For example, EHRs may use launch context to communicate UX and UI expectations to the app (need_patient_banner).

Hierarchy

Properties

encounter? need_patient_banner? patient? smart_style_url?

Properties

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.

Optional smart_style_url

smart_style_url?: string

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

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc