Module entry/browser

Type declaration

• AbortController: { prototype: AbortController }

  • prototype: AbortController

• client: ((state: string | ClientState) => default)

  • • (state: string | ClientState): default

    • Creates and returns a Client instance that can be used to query the FHIR server.

      Parameters

      • state: string | ClientState

      Returns default

• oauth2: { authorize: ((options: AuthorizeParams) => Promise<string | void>); init: ((options: AuthorizeParams) => Promise<default>); ready: ((options?: ReadyOptions) => Promise<default>); settings: BrowserFHIRSettings }

  • authorize: ((options: AuthorizeParams) => Promise<string | void>)

    • • (options: AuthorizeParams): Promise<string | void>

      • Starts the SMART Launch Sequence.

        IMPORTANT: authorize() will end up redirecting you to the authorization server. This means that you should not add anything to the returned promise chain. Any code written directly after the authorize() call might not be executed due to that redirect!

        The options that you would typically pass for an EHR launch are just clientId and scope. For standalone launch you should also provide the iss option.

        Parameters

        • options: AuthorizeParams

        Returns Promise<string | void>

  • init: ((options: AuthorizeParams) => Promise<default>)

    • • (options: AuthorizeParams): Promise<default>

      • This function can be used when you want to handle everything in one page (no launch endpoint needed).

        1. It will only work if your launch_uri is the same as your redirect_uri. While this should be valid, we can't promise that every EHR will allow you to register client with such settings.
        2. Internally, init() will be called twice. First it will redirect to the EHR, then the EHR will redirect back to the page where init() will be called again to complete the authorization. This is generally fine, because the returned promise will only be resolved once, after the second execution, but please also consider the following:

        • You should wrap all your app's code in a function that is only executed after init() resolves!
        • Since the page will be loaded twice, you must be careful if your code has global side effects that can persist between page reloads (for example writing to localStorage).

        Parameters

        • options: AuthorizeParams

        Returns Promise<default>

  • ready: ((options?: ReadyOptions) => Promise<default>)

    • • (options?: ReadyOptions): Promise<default>

      • This should be called on your redirect_uri. Returns a Promise that will eventually be resolved with a Client instance that you can use to query the fhir server.

        Parameters

        • Optional options: ReadyOptions

        Returns Promise<default>

  • settings: BrowserFHIRSettings

• utils: any