Overview

Introduction

Flow overview

Requirements

Versionning

Authentication

Server authentication

Incoming APIs

Overview

Provision user

Create encounter

Refresh encounter URL

Outgoing APIs

Overview

Callback authentication

Response protocol

Callback types

Reference

Changelog

High-level diagram

The following schema presents the two main steps of the Nabla Connect flow.

User flow

From a user perspective, the flow looks like this:

1. Click on the Nabla button (built by you) in the EHR, inside the patient encounter screen.
2. Nabla opens (as an iframe or external web browser) on the specific encounter that is auto-created on Nabla's side.
3. Classic Nabla flow — the provider listens to the encounter, generates the note, and reviews/edits it with Nabla tools. The encounter is enhanced with context data passed by your EHR.
4. Export — at the end of the encounter, the provider clicks the Export Note button (which replaces the usual Copy Note button), and all generated data (note, visit diagnoses, and more) is sent back to the EHR.

Two main API directions

• Incoming APIs (EHR → Nabla) — Your backend calls Nabla to create or refresh an encounter. See Incoming APIs for details.
• Outgoing APIs (Nabla → EHR) — Nabla calls your backend to export the generated note and other data. See Outgoing APIs for details.