Overview

Introduction

Flow overview

Requirements

Versionning

Authentication

Server authentication

Incoming APIs

Overview

Provision user

Create encounter

Refresh encounter URL

Outgoing APIs

Overview

Callback authentication (HMAC)

Response protocol

Callback types

Reference

Changelog

NOTE_EXPORT

Triggered when the provider clicks Export Note in the Nabla app.

{
  "request_uuid": string,
  "type": "NOTE_EXPORT",
  "data": {
    "external_patient_id": string,
    "external_encounter_id": string,
    "external_provider_id": string,
    "note": {
      "sections": [
        {
          "content": string,
          "title": string,
          "category": string | null
        }
      ]
    },
    "visit_diagnoses": [
      {
        "system": string,
        "code": string,
        "display": string,
        "is_hcc": boolean,
        "is_mcc": boolean
      }
    ]
  }
}

Optional visit_diagnoses may be included when ICD-10 suggestions are available; each item has system, code, display, is_hcc, and is_mcc.

Section categories

CHIEF_COMPLAINT, HISTORY_OF_PRESENT_ILLNESS, PAST_HISTORY, CURRENT_MEDICATIONS, VITALS, IMMUNIZATIONS, ASSESSMENT_AND_PLAN, EXAMINATION, RESULTS, PRESCRIPTIONS, APPOINTMENTS

ℹ️ Multiple sections can share the same category (e.g. separate "Assessment" and "Plan" sections both return "category": "ASSESSMENT_AND_PLAN"). A section with category: null means it doesn't fit any existing category.

PATIENT_INSTRUCTIONS_EXPORT

Triggered when the provider clicks Export patient instructions in the Nabla app.

{
  "request_uuid": string,
  "type": "PATIENT_INSTRUCTIONS_EXPORT",
  "data": {
    "external_patient_id": string,
    "external_encounter_id": string,
    "external_provider_id": string,
    "patient_instructions": {
      "instructions": string
    }
  }
}