Getting Started with Blueprint

Blueprint turns a therapy session into clinical documentation. You bring the session; Blueprint
produces a transcript, a summary, a progress note in the format the clinician wants, and — for
prescribers — medical decision making elements.

This documentation covers the Partner Platform: the API and embeddable UI you use to put that
capability inside your own application, typically an EHR.

How an integration fits together

Three things have to happen. How much of each you own is what distinguishes the integration methods.

Model your users and clients in Blueprint. Blueprint needs a record for the clinician doing
the work and the client being treated, so it can attach documentation to the right chart. You
create these through the API and link them to your own records with an externalId.
Capture the session audio. Either you embed Blueprint's UI and it handles recording, device
selection, and upload — or you capture audio yourself and hand Blueprint a URL.
Get the documentation back into your application. Either the clinician reviews and copies it
from the embedded UI, or your backend receives a webhook and fetches the artifact by API.

Choose an integration method

Method	You build	Best when
UI Only	A script tag	You want to ship in days and are happy with Blueprint's recording and note-review UI
UI + API	Backend API calls + a script tag	You want Blueprint's audio capture but your own user and client management, and notes written into your database
API Only	Everything, including audio capture	You need full control of the experience and already have working audio capture

Most integrations are UI + API. Start at Design Your Integration
for the tradeoffs.

Get set up

Get credentials. Blueprint provisions a clientId, clientSecret, and apiKey for your
partner organization — one set for sandbox, one for production. Contact your Blueprint
representative if you do not have them.
Read Concepts so the object model and the vocabulary in these docs line up
with your own.
Work through the Quickstart. It goes from credentials to a generated progress
note with copy-pasteable curl, and takes about fifteen minutes.
Check Environments & Base URLs before your first call. The API base URL
includes a /v2 path segment, and if you are embedding the UI there are CSP entries you will need.

Sample application

A working reference implementation of all the integration methods:

https://github.com/blueprinthq/partner-samples

It is an Express app standing in for an EHR, with a chart page for each integration style and a
webhook listener. Clone it, add your sandbox credentials, and run it against the sandbox environment
to see the whole flow end to end.

Getting help

The API Reference has every endpoint with request and response schemas
Reach out to your Blueprint representative for credentials, onboarding, or anything you cannot
find here