UI Only Integrations

When implementing a UI Only integration, your application front end is hosting a portion of the Blueprint web application UI inside it, so there is nothing to download or install for your users. Your application front end communicates with the Blueprint UI by sending JavaScript messages to it, and the Blueprint UI will communicate with your application by firing events that your application can listen to.

In this integration method, the clinician user will be authenticated to your application, and they will be authenticated to Blueprint as well. Thus each clinician will need to have a Blueprint account, but our embedded UI makes it easy for a clinician to set up their account.

To start a recording session and to generate clinical artifacts, Blueprint needs to have a record for the client being treated. The embedded UI allows a clinician to create a client or search their list of clients. Your application front end can send a message to the Blueprint UI to select a client (perhaps based on the client the clinician is viewing in your application) or to start the process of creating a new client.

The workflow of implementing a UI Only integration looks like this:

1. Add the Blueprint UI JavaScript snippet to your application's front end code and configure it in code.

2. When clinicians use your application with the embedded Blueprint UI for the first time, they will be prompted to create a Blueprint account, or log in if they already have an account.

3. If a clinician has already been logged into Blueprint, either via the Blueprint web application or via the Blueprint browser extension, they will be automatically authenticated to the embedded UI.

4. This is minimum that you need to do!

   1. Clinicians can use the embedded Blueprint UI to create a client or select an existing client.

   2. The clinician will need to grant the Blueprint UI permission to use the microphone in the browser.

   3. They can then start a session recording. The Blueprint UI will capture the audio and upload it to the Blueprint servers, and will provide feedback (such as volume level or connectivity errors) to the clinician.

   4. Once the clinician ends the session, Blueprint will process the audio and generate clinical artifacts.

   5. The clinician can review and edit the artifacts in the embedded UI. Once they are satisfied, they can can click "Copy Note" then paste the note into your application.

5. While the above is the minimum needed for an integration, you can improve the experience for your clinicians by adding some code to your application front end:

   1. Automatic Client Detection: When navigating between clients in your application, send a message to search for the current client in Blueprint. Or if a client is not found, start the process of creating a new client in Blueprint using information from your application.

   2. Semi-Automatic Note Insertion: When initializing the Blueprint UI, send a message to change the text of the "Copy Note" button to custom text such as "Export to YOUR APP"

   3. Automatic Note Insertion: When the clinical notes are generated, listen for an event fired by the Blueprint UI. This event payload will include the contents of the note, so your application can then insert it into the correct place automatically.