Concepts

Preface

App Embed helps you integrate Junction Dashboard features into your web application.

To facilitate this, App Embed makes a few assumptions:

You programmatically manage the profiles of the providers as integration-managed members.

An integration-managed member must be at least a team admin of the team for App Embed to work.

What provider means in your use case may differ. Here are two example mappings for your consideration:

I am a health care practice...

Junction noun	Synonym	Meaning	API
Org	-	Your business entity.	Management API
Team	-	A division in your Junction organization, containing an isolated pool of users.	Management API
Member Org Admin	Staff	Your members of staff.	Management API
Member Team Admin	Provider 📍	Your members of staff, with access restricted to a specific set of teams.	Management API
User	Patient	An end user of the device and lab testing services; belongs to a team.	Junction API

I am an EMR...

Junction noun	Synonym	Meaning	API
Org	-	Your business entity.	Management API
Team	-	A customer of yours.	Management API
Member Org Admin	-	Your own members of staff.	Management API
Member Team Admin	Provider 📍	A customer’s members of staff.	Management API
User	Patient	An end user of the device and lab testing services; belongs to a team.	Junction API

Core flow

Prepare identity and team records

Use the Junction Management API to create or resolve the team and integration-managed member for the current provider.

Create a Dashboard URL

Call Create Dashboard URL with the target member, team, modality, feature, and environment.

Launch the App Embed

Open the returned Dashboard URL in a top-level browser context for Link Out, or load it in an iframe for Feature Embed.

Configuration

You can configure App Embed either through “Org Config -> EHR Integration” in the Junction Dashboard, or programmatically via the Upsert App Embed Configuration endpoint on the Junction Management API.

Setting	Description
Unique slug	A unique kebab-case slug that identifies your organization, e.g., `my-clinical-practice`. Your Fast Launch subdomain is based on this slug.
Modalities	The App Embed modalities you intend to use: `link_out`, `feature_embed`, both, or none.
Allowed origins	Origins allowed to launch Link Out or Feature Embed sessions. For each origin, you may optionally specify a publicly accessible Session Continuation URL. If this is left unspecified, Fast Launch will not work, and App Embed will show an error screen when it encounters a launch error or an irrecoverable client session.

Integration-managed members

To launch App Embed in either modality, identify the provider who should use Junction Dashboard as an integration-managed member.

These members are created and managed through the Junction Management API by your backend system.

Integration-managed members:

can sign in only through App Embed launch flows;

cannot sign in through Junction Dashboard identity providers; and

can be assigned team role bindings when created or updated.

Preface