Heidi Health website screenshot

Heidi Health

Heidi Health is a Melbourne, Australia-founded AI care partner for clinicians, founded in 2019 by Dr. Tom Kelly (CEO), Waleed Mussa (CFO), and Yu Liu (CTO). The product began as an ambient AI medical scribe and now spans four capability surfaces: Scribe (real-time clinical documentation from audio), Evidence (clinical decision support and literature lookup with citations), Remote (a 21-gram wearable microphone with on-device encryption for offline ambient capture), and Comms (clinical communications). The platform is used by more than one million clinicians across 50+ countries spanning family medicine, specialists, nursing, mental health, allied health, dentistry, veterinary medicine, and trainees, and claims to have returned over 18 million hours of clinician time to date. Heidi exposes a public Heidi API and embeddable Heidi Widget that EHR vendors, telehealth platforms, and partners use to embed ambient documentation into their own workflows; documented integrations include Epic (Hyperspace/Hyperdrive/Haiku), Oracle Cerner (PowerChart/FirstNet), Athenahealth, eClinicalWorks (via Vim), Best Practice, Medical Director, Gentu, Cliniko, Halaxy, MediRecords, and many others. Heidi holds SOC 2, ISO 27001, ISO 42001, HIPAA, GDPR, APP, PIPEDA, NHS, Cyber Essentials+, UKCA, and Swiss FDPA attestations, has raised approximately $80M across Seed, Series A (Blackbird), and a $65M Series B led by Point72 Private Investments with Blackbird, Headline, and Latitude, and recently announced a strategic partnership with R1 RCM to embed Heidi into US revenue cycle management workflows.

Heidi Health publishes 10 APIs on the APIs.io network, including Ask Heidi API, Authentication API, Clinical Coding API, and 7 more. Tagged areas include Healthcare, Health Tech, AI Medical Scribe, Ambient AI, and Clinical Documentation.

The Heidi Health catalog on APIs.io includes 1 JSON-LD context and 2 Spectral governance rulesets.

Heidi Health’s developer surface includes authentication, developer portal, documentation, signup flow, pricing, engineering blog, changelog, and 36 more developer resources.

🌐 Visit website 📡 Source on GitHub
61.4/100 strong ▼ -7.8 Agent 31/100 agent aware Full breakdown ↓
scored 2026-07-28 · rubric v0.6
AccessFreemiumSelf serveFree trial⚡ Free to try
11 APIs 20 Features
HealthcareHealth TechAI Medical ScribeAmbient AIClinical DocumentationClinical Decision SupportArtificial IntelligenceSpeech To TextTranscriptionEHR IntegrationElectronic Health RecordsTelehealthClinical CodingICD-10SNOMEDHIPAAGDPRSOC 2ISO 27001ISO 42001WearablesVoiceAudioAustraliaMelbourne

Kin Score

Kin Score Kin Score How this is scored →
scored 2026-07-28 · rubric v0.6
Composite quality — 61.4/100 · strong
Contract Quality 17.7 / 25
Developer Ergonomics 7.8 / 20
Commercial Clarity 20.0 / 20
Operational Transparency 4.1 / 13
Governance 8.3 / 12
Discoverability 6.5 / 10
Agent readiness — 31/100 · agent aware
Machine-Readable Contract 18 / 18
Agentic Access Contract 10 / 10
MCP Server 0 / 12
Machine-Readable Auth 10 / 10
Idempotency 0 / 9
Stable Error Semantics 0 / 8
Request/Response Examples 0 / 7
Rate-Limit Signaling 7 / 7
Typed Event Surface 0 / 6
Agent Skills 0 / 5
Well-Known Catalog 0 / 4
Consent & Bot Identity 0 / 3
A2A Agent Card 0 / 8
Dry-Run / Simulate Mode 0 / 4
Improve this rating by publishing the missing artifacts — every area above can be raised, and the full rubric is at apis.io/rating/. This rating is computed from github.com/api-evangelist/heidi-health: open an issue to ask a question, or submit a pull request to add artifacts. Want it done for you? Prioritized profiling — $2,500 →

APIs 11

Individual APIs this provider publishes, each with its own machine-readable definition.

Heidi Widget SDK

Embeddable JavaScript widget for dropping Heidi's ambient documentation experience directly into a web-based EHR or clinical workflow with minimal engineering, with documented i...

Heidi Health Ask Heidi API

Streamed AI-assistant responses scoped to a session.

Heidi Health Authentication API

Token exchange.

Heidi Health Clinical Coding API

ICD/SNOMED/CPT and related code generation.

Heidi Health Consult Notes API

Streamed consult-note generation.

Heidi Health Documents API

Auxiliary template-driven documents.

Heidi Health Patient Profiles API

Longitudinal patient records.

Heidi Health Session Context API

Notes, linked sessions, and context document attachments.

Heidi Health Sessions API

Clinical session lifecycle.

Heidi Health Templates API

Consult-note templates.

Heidi Health Transcription API

Audio upload and transcript retrieval.

Scroll for all 11

Postman Collections 10

Ready-to-run Postman collections for exercising this provider's APIs.

Heidi Health Ask Heidi API

POSTMAN

Heidi Health Ask Heidi Authentication API

POSTMAN

Heidi Health Ask Heidi Clinical Coding API

POSTMAN

Heidi Health Ask Heidi Consult Notes API

POSTMAN

Heidi Health Ask Heidi Documents API

POSTMAN

Heidi Health Ask Heidi Patient Profiles API

POSTMAN

Heidi Health Ask Heidi Session Context API

POSTMAN

Heidi Health Ask Heidi Sessions API

POSTMAN

Heidi Health Ask Heidi Templates API

POSTMAN

Heidi Health Ask Heidi Transcription API

POSTMAN

Scroll for all 10

Open Collections 1

Open, tool-agnostic API collections (OpenAPI-derived and Bruno).

Heidi Health API

OPEN COLLECTION

Pricing Plans 1

Published pricing tiers and plan structures.

Heidi Health Plans Pricing

4 plans

PLANS

Rate Limits 1

Documented rate limits and quota policies.

Heidi Health Rate Limits

0 limits

RATE LIMITS

FinOps 1

Cost, billing, and metering signals for API financial operations.

Heidi Health Finops

FINOPS

Features 20

Notable capabilities this provider offers.

Heidi Scribe — ambient AI medical scribe generating real-time consult notes from clinical audio
Heidi Evidence — clinical decision-support and literature lookup with transparent citations and CPD/CME tracking
Heidi Remote — 21-gram wearable microphone with offline capture and on-device encryption
Heidi Comms — clinical communications module
Heidi API — public REST API at registrar.api.heidihealth.com for sessions, transcription, consult notes, documents, coding, Ask Heidi
Heidi Widget — embeddable JavaScript widget for any web-based EHR
Custom JSON templates for organisation-specific consult-note structures
Multilingual transcription and output across 50+ countries
Voice-style controls (Goldilocks, Detailed, Brief, Super-Detailed, My Voice)
Clinical coding generation in ICD-10, ICD-10-CM, ICD-9, ICD-9-CM, SNOMED, SNOMED-CT, OPCS-410, ACHI-13, CPT-2025
Streamed generation responses for incremental UI rendering
Patient profiles linking many sessions to a single patient for longitudinal context
Context attachments (PDF, JPG, PNG, DOCX, DOC) per session
EHR integrations spanning Epic, Cerner, Athenahealth, eClinicalWorks (via Vim), Best Practice, Medical Director, Gentu, Cliniko, Halaxy, MediRecords, and 15+ others
Free plan with unlimited transcription and standard templates
Evidence Plus, Clinician, and Enterprise paid tiers with 14-day trials
Enterprise features including SSO, centralised billing, custom hosting, dedicated CSM
SOC 2, ISO 27001, ISO 42001, HIPAA, GDPR, APP, PIPEDA, NHS, Cyber Essentials+, UKCA, Swiss FDPA compliance
No clinician data used for AI model training
R1 RCM strategic partnership for US revenue cycle management

Scroll for all 20

Semantic Vocabularies 1

JSON-LD contexts and semantic vocabularies used across these APIs.

Heidi Health Context

43 classes · 0 properties

JSON-LD

Spectral Rules 2

Spectral governance rulesets for linting and validating these APIs.

Heidi Health API Rules

5 rules · 4 warnings 1 info

SPECTRAL

Heidi Health API Rules

8 rules · 3 errors 5 warnings

SPECTRAL

JSON Schema 6

Standalone JSON Schema definitions for this provider's data models.

HeidiClinicalCode

7 properties

JSON SCHEMA

HeidiConsultNote

9 properties

JSON SCHEMA

HeidiDocument

10 properties

JSON SCHEMA

HeidiPatientProfile

9 properties

JSON SCHEMA

HeidiSession

16 properties

JSON SCHEMA

HeidiTranscript

5 properties

JSON SCHEMA

JSON Structure 1

JSON Structure definitions describing this provider's data shapes.

Heidi Health Session Structure

0 properties

JSON STRUCTURE

Examples 4

Example request and response payloads for these APIs.

Heidi Health Create Session Example

5 fields

EXAMPLE

Heidi Health Generate Consult Note Example

5 fields

EXAMPLE

Heidi Health Get Clinical Codes Example

5 fields

EXAMPLE

Heidi Health Get Jwt Example

5 fields

EXAMPLE

Security Posture 3

Authentication, domain security, vulnerability disclosure, and trust-center signals.

Heidi Health Authentication

apiKey/http · 2 schemes

SECURITY

Heidi Health Domain Security

TLSv1.3 · HSTS · DMARC

SECURITY

Heidi Health Vulnerability Disclosure

security.txt · contact published

SECURITY

Agentic Access 1

Recommended x-agentic-access execution contracts for AI agents.

Heidi Health Agentic Access

24 operations · 13 acting

24 operations · 13 acting

AGENTIC

Resources

Get Started 3

Portal, sign-up, and the first successful call

Portal
Portal
 Signup
Signup
 Login
Login

Documentation 2

Reference material describing how the API behaves

Documentation
Documentation
 Documentation
Documentation

Agent Surfaces 1

MCP servers, agent skills, and machine-readable catalogs

AgenticAccess
AgenticAccess

Design & Contract 3

Pagination, idempotency, versioning, errors, and events

JSONLD
JSONLD
 Vocabulary
Vocabulary
 SpectralRules
SpectralRules

Build 1

SDKs, sample code, and the tooling you integrate with

PostmanWorkspace
PostmanWorkspace

Access & Security 9

Authentication, authorization, and security posture

VulnerabilityDisclosure
VulnerabilityDisclosure
 DomainSecurity
DomainSecurity
 Authentication
Authentication
 TrustCenter
TrustCenter
 Compliance
Compliance
 Compliance
Compliance
 Compliance
Compliance
 Compliance
Compliance
 Compliance
Compliance

Scroll for all 9

Operate 6

Status, limits, changes, and where to get help

ChangeLog
ChangeLog
 StatusPage
StatusPage
 Support
Support
 Contact
Contact
 Contact
Contact
 RateLimits
RateLimits

Commercial 5

Pricing, plans, and the legal terms of use

Pricing
Pricing
 PrivacyPolicy
PrivacyPolicy
 TermsOfService
TermsOfService
 Plans
Plans
 FinOps
FinOps

Company 5

The organization behind the API

Website
Website
 Blog
Blog
 Press
Press
 Careers
Careers
 Partners
Partners

Other 8

Properties that don't map to a standard resource type

AcceptableUse
AcceptableUse
 Safety
Safety
 Company
Company
 Customers
Customers
 Downloads
Downloads
 SystemRequirements
SystemRequirements
 Templates
Templates
 ROICalculator
ROICalculator

Scroll for all 8

Source (apis.yml)

apis.yml Raw ↑ 
aid: heidi-health
name: Heidi Health
description: 'Heidi Health is a Melbourne, Australia-founded AI care partner for clinicians, founded in 2019 by Dr. Tom Kelly
  (CEO), Waleed Mussa (CFO), and Yu Liu (CTO). The product began as an ambient AI medical scribe and now spans four capability
  surfaces: Scribe (real-time clinical documentation from audio), Evidence (clinical decision support and literature lookup
  with citations), Remote (a 21-gram wearable microphone with on-device encryption for offline ambient capture), and Comms
  (clinical communications). The platform is used by more than one million clinicians across 50+ countries spanning family
  medicine, specialists, nursing, mental health, allied health, dentistry, veterinary medicine, and trainees, and claims to
  have returned over 18 million hours of clinician time to date. Heidi exposes a public Heidi API and embeddable Heidi Widget
  that EHR vendors, telehealth platforms, and partners use to embed ambient documentation into their own workflows; documented
  integrations include Epic (Hyperspace/Hyperdrive/Haiku), Oracle Cerner (PowerChart/FirstNet), Athenahealth, eClinicalWorks
  (via Vim), Best Practice, Medical Director, Gentu, Cliniko, Halaxy, MediRecords, and many others. Heidi holds SOC 2, ISO
  27001, ISO 42001, HIPAA, GDPR, APP, PIPEDA, NHS, Cyber Essentials+, UKCA, and Swiss FDPA attestations, has raised approximately
  $80M across Seed, Series A (Blackbird), and a $65M Series B led by Point72 Private Investments with Blackbird, Headline,
  and Latitude, and recently announced a strategic partnership with R1 RCM to embed Heidi into US revenue cycle management
  workflows.'
tags:
- Healthcare
- Health Tech
- AI Medical Scribe
- Ambient AI
- Clinical Documentation
- Clinical Decision Support
- Artificial Intelligence
- Speech To Text
- Transcription
- EHR Integration
- Electronic Health Records
- Telehealth
- Clinical Coding
- ICD-10
- SNOMED
- HIPAA
- GDPR
- SOC 2
- ISO 27001
- ISO 42001
- Wearables
- Voice
- Audio
- Australia
- Melbourne
url: https://raw.githubusercontent.com/api-evangelist/heidi-health/refs/heads/main/apis.yml
accessModel:
  pricing: freemium
  onboarding: self-serve
  trial: true
  try_now: true
  public: false
  label: Freemium (free trial) · Self-serve signup
  confidence: high
  source:
  - plans
  - authentication
  generated: '2026-07-22'
  method: derived
created: '2026-05-24'
modified: '2026-05-24'
specificationVersion: '0.20'
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/icons/heidi-health.png
kind: contract
position: Provider
access: 3rd-Party
apis:
- aid: heidi-health:heidi-widget-sdk
  name: Heidi Widget SDK
  description: Embeddable JavaScript widget for dropping Heidi's ambient documentation experience directly into a web-based
    EHR or clinical workflow with minimal engineering, with documented initialisation options, methods/callbacks, patient-information
    parameters, and TypeScript types.
  humanURL: https://www.heidihealth.com/developers/widget/overview
  tags:
  - Widget
  - SDK
  - Embed
  - JavaScript
  - EHR Integration
  properties:
  - type: Documentation
    url: https://www.heidihealth.com/developers/widget/overview
  - type: Documentation
    url: https://www.heidihealth.com/developers/widget/install-the-widget
  - type: Documentation
    url: https://www.heidihealth.com/developers/widget/sdk-specification/initialisation-options
  - type: Documentation
    url: https://www.heidihealth.com/developers/widget/sdk-specification/methods-and-callbacks
  - type: Documentation
    url: https://www.heidihealth.com/developers/widget/sdk-specification/patient-information
  - type: Documentation
    url: https://www.heidihealth.com/developers/widget/sdk-specification/types
- aid: heidi-health:heidi-health-ask-heidi-api
  name: Heidi Health Ask Heidi API
  description: Streamed AI-assistant responses scoped to a session.
  humanURL: https://www.heidihealth.com/developers/heidi-api/authentication
  tags:
  - Ask Heidi
  properties:
  - type: OpenAPI
    url: openapi/heidi-health-ask-heidi-api-openapi.yml
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/authentication
  - type: Examples
    url: examples/heidi-health-get-jwt-example.json
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/templates
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/patient-profiles
  - type: JSONSchema
    url: json-schema/heidi-health-patient-profile-schema.json
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/sessions/overview
  - type: JSONSchema
    url: json-schema/heidi-health-session-schema.json
  - type: JSONStructure
    url: json-structure/heidi-health-session-structure.json
  - type: Examples
    url: examples/heidi-health-create-session-example.json
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/sessions/context
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/sessions/coding
  - type: JSONSchema
    url: json-schema/heidi-health-clinical-code-schema.json
  - type: Examples
    url: examples/heidi-health-get-clinical-codes-example.json
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/transcription
  - type: JSONSchema
    url: json-schema/heidi-health-transcript-schema.json
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/consult-notes
  - type: JSONSchema
    url: json-schema/heidi-health-consult-note-schema.json
  - type: Examples
    url: examples/heidi-health-generate-consult-note-example.json
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/documents
  - type: JSONSchema
    url: json-schema/heidi-health-document-schema.json
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/ask-heidi
- aid: heidi-health:heidi-health-authentication-api
  name: Heidi Health Authentication API
  description: Token exchange.
  humanURL: https://www.heidihealth.com/developers/heidi-api/authentication
  tags:
  - Authentication
  properties:
  - type: OpenAPI
    url: openapi/heidi-health-authentication-api-openapi.yml
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/authentication
  - type: Examples
    url: examples/heidi-health-get-jwt-example.json
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/templates
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/patient-profiles
  - type: JSONSchema
    url: json-schema/heidi-health-patient-profile-schema.json
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/sessions/overview
  - type: JSONSchema
    url: json-schema/heidi-health-session-schema.json
  - type: JSONStructure
    url: json-structure/heidi-health-session-structure.json
  - type: Examples
    url: examples/heidi-health-create-session-example.json
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/sessions/context
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/sessions/coding
  - type: JSONSchema
    url: json-schema/heidi-health-clinical-code-schema.json
  - type: Examples
    url: examples/heidi-health-get-clinical-codes-example.json
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/transcription
  - type: JSONSchema
    url: json-schema/heidi-health-transcript-schema.json
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/consult-notes
  - type: JSONSchema
    url: json-schema/heidi-health-consult-note-schema.json
  - type: Examples
    url: examples/heidi-health-generate-consult-note-example.json
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/documents
  - type: JSONSchema
    url: json-schema/heidi-health-document-schema.json
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/ask-heidi
- aid: heidi-health:heidi-health-clinical-coding-api
  name: Heidi Health Clinical Coding API
  description: ICD/SNOMED/CPT and related code generation.
  humanURL: https://www.heidihealth.com/developers/heidi-api/authentication
  tags:
  - Clinical Coding
  properties:
  - type: OpenAPI
    url: openapi/heidi-health-clinical-coding-api-openapi.yml
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/authentication
  - type: Examples
    url: examples/heidi-health-get-jwt-example.json
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/templates
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/patient-profiles
  - type: JSONSchema
    url: json-schema/heidi-health-patient-profile-schema.json
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/sessions/overview
  - type: JSONSchema
    url: json-schema/heidi-health-session-schema.json
  - type: JSONStructure
    url: json-structure/heidi-health-session-structure.json
  - type: Examples
    url: examples/heidi-health-create-session-example.json
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/sessions/context
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/sessions/coding
  - type: JSONSchema
    url: json-schema/heidi-health-clinical-code-schema.json
  - type: Examples
    url: examples/heidi-health-get-clinical-codes-example.json
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/transcription
  - type: JSONSchema
    url: json-schema/heidi-health-transcript-schema.json
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/consult-notes
  - type: JSONSchema
    url: json-schema/heidi-health-consult-note-schema.json
  - type: Examples
    url: examples/heidi-health-generate-consult-note-example.json
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/documents
  - type: JSONSchema
    url: json-schema/heidi-health-document-schema.json
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/ask-heidi
- aid: heidi-health:heidi-health-consult-notes-api
  name: Heidi Health Consult Notes API
  description: Streamed consult-note generation.
  humanURL: https://www.heidihealth.com/developers/heidi-api/authentication
  tags:
  - Consult Notes
  properties:
  - type: OpenAPI
    url: openapi/heidi-health-consult-notes-api-openapi.yml
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/authentication
  - type: Examples
    url: examples/heidi-health-get-jwt-example.json
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/templates
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/patient-profiles
  - type: JSONSchema
    url: json-schema/heidi-health-patient-profile-schema.json
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/sessions/overview
  - type: JSONSchema
    url: json-schema/heidi-health-session-schema.json
  - type: JSONStructure
    url: json-structure/heidi-health-session-structure.json
  - type: Examples
    url: examples/heidi-health-create-session-example.json
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/sessions/context
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/sessions/coding
  - type: JSONSchema
    url: json-schema/heidi-health-clinical-code-schema.json
  - type: Examples
    url: examples/heidi-health-get-clinical-codes-example.json
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/transcription
  - type: JSONSchema
    url: json-schema/heidi-health-transcript-schema.json
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/consult-notes
  - type: JSONSchema
    url: json-schema/heidi-health-consult-note-schema.json
  - type: Examples
    url: examples/heidi-health-generate-consult-note-example.json
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/documents
  - type: JSONSchema
    url: json-schema/heidi-health-document-schema.json
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/ask-heidi
- aid: heidi-health:heidi-health-documents-api
  name: Heidi Health Documents API
  description: Auxiliary template-driven documents.
  humanURL: https://www.heidihealth.com/developers/heidi-api/authentication
  tags:
  - Documents
  properties:
  - type: OpenAPI
    url: openapi/heidi-health-documents-api-openapi.yml
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/authentication
  - type: Examples
    url: examples/heidi-health-get-jwt-example.json
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/templates
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/patient-profiles
  - type: JSONSchema
    url: json-schema/heidi-health-patient-profile-schema.json
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/sessions/overview
  - type: JSONSchema
    url: json-schema/heidi-health-session-schema.json
  - type: JSONStructure
    url: json-structure/heidi-health-session-structure.json
  - type: Examples
    url: examples/heidi-health-create-session-example.json
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/sessions/context
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/sessions/coding
  - type: JSONSchema
    url: json-schema/heidi-health-clinical-code-schema.json
  - type: Examples
    url: examples/heidi-health-get-clinical-codes-example.json
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/transcription
  - type: JSONSchema
    url: json-schema/heidi-health-transcript-schema.json
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/consult-notes
  - type: JSONSchema
    url: json-schema/heidi-health-consult-note-schema.json
  - type: Examples
    url: examples/heidi-health-generate-consult-note-example.json
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/documents
  - type: JSONSchema
    url: json-schema/heidi-health-document-schema.json
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/ask-heidi
- aid: heidi-health:heidi-health-patient-profiles-api
  name: Heidi Health Patient Profiles API
  description: Longitudinal patient records.
  humanURL: https://www.heidihealth.com/developers/heidi-api/authentication
  tags:
  - Patient Profiles
  properties:
  - type: OpenAPI
    url: openapi/heidi-health-patient-profiles-api-openapi.yml
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/authentication
  - type: Examples
    url: examples/heidi-health-get-jwt-example.json
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/templates
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/patient-profiles
  - type: JSONSchema
    url: json-schema/heidi-health-patient-profile-schema.json
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/sessions/overview
  - type: JSONSchema
    url: json-schema/heidi-health-session-schema.json
  - type: JSONStructure
    url: json-structure/heidi-health-session-structure.json
  - type: Examples
    url: examples/heidi-health-create-session-example.json
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/sessions/context
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/sessions/coding
  - type: JSONSchema
    url: json-schema/heidi-health-clinical-code-schema.json
  - type: Examples
    url: examples/heidi-health-get-clinical-codes-example.json
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/transcription
  - type: JSONSchema
    url: json-schema/heidi-health-transcript-schema.json
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/consult-notes
  - type: JSONSchema
    url: json-schema/heidi-health-consult-note-schema.json
  - type: Examples
    url: examples/heidi-health-generate-consult-note-example.json
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/documents
  - type: JSONSchema
    url: json-schema/heidi-health-document-schema.json
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/ask-heidi
- aid: heidi-health:heidi-health-session-context-api
  name: Heidi Health Session Context API
  description: Notes, linked sessions, and context document attachments.
  humanURL: https://www.heidihealth.com/developers/heidi-api/authentication
  tags:
  - Session Context
  properties:
  - type: OpenAPI
    url: openapi/heidi-health-session-context-api-openapi.yml
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/authentication
  - type: Examples
    url: examples/heidi-health-get-jwt-example.json
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/templates
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/patient-profiles
  - type: JSONSchema
    url: json-schema/heidi-health-patient-profile-schema.json
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/sessions/overview
  - type: JSONSchema
    url: json-schema/heidi-health-session-schema.json
  - type: JSONStructure
    url: json-structure/heidi-health-session-structure.json
  - type: Examples
    url: examples/heidi-health-create-session-example.json
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/sessions/context
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/sessions/coding
  - type: JSONSchema
    url: json-schema/heidi-health-clinical-code-schema.json
  - type: Examples
    url: examples/heidi-health-get-clinical-codes-example.json
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/transcription
  - type: JSONSchema
    url: json-schema/heidi-health-transcript-schema.json
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/consult-notes
  - type: JSONSchema
    url: json-schema/heidi-health-consult-note-schema.json
  - type: Examples
    url: examples/heidi-health-generate-consult-note-example.json
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/documents
  - type: JSONSchema
    url: json-schema/heidi-health-document-schema.json
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/ask-heidi
- aid: heidi-health:heidi-health-sessions-api
  name: Heidi Health Sessions API
  description: Clinical session lifecycle.
  humanURL: https://www.heidihealth.com/developers/heidi-api/authentication
  tags:
  - Sessions
  properties:
  - type: OpenAPI
    url: openapi/heidi-health-sessions-api-openapi.yml
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/authentication
  - type: Examples
    url: examples/heidi-health-get-jwt-example.json
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/templates
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/patient-profiles
  - type: JSONSchema
    url: json-schema/heidi-health-patient-profile-schema.json
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/sessions/overview
  - type: JSONSchema
    url: json-schema/heidi-health-session-schema.json
  - type: JSONStructure
    url: json-structure/heidi-health-session-structure.json
  - type: Examples
    url: examples/heidi-health-create-session-example.json
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/sessions/context
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/sessions/coding
  - type: JSONSchema
    url: json-schema/heidi-health-clinical-code-schema.json
  - type: Examples
    url: examples/heidi-health-get-clinical-codes-example.json
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/transcription
  - type: JSONSchema
    url: json-schema/heidi-health-transcript-schema.json
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/consult-notes
  - type: JSONSchema
    url: json-schema/heidi-health-consult-note-schema.json
  - type: Examples
    url: examples/heidi-health-generate-consult-note-example.json
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/documents
  - type: JSONSchema
    url: json-schema/heidi-health-document-schema.json
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/ask-heidi
- aid: heidi-health:heidi-health-templates-api
  name: Heidi Health Templates API
  description: Consult-note templates.
  humanURL: https://www.heidihealth.com/developers/heidi-api/authentication
  tags:
  - Templates
  properties:
  - type: OpenAPI
    url: openapi/heidi-health-templates-api-openapi.yml
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/authentication
  - type: Examples
    url: examples/heidi-health-get-jwt-example.json
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/templates
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/patient-profiles
  - type: JSONSchema
    url: json-schema/heidi-health-patient-profile-schema.json
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/sessions/overview
  - type: JSONSchema
    url: json-schema/heidi-health-session-schema.json
  - type: JSONStructure
    url: json-structure/heidi-health-session-structure.json
  - type: Examples
    url: examples/heidi-health-create-session-example.json
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/sessions/context
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/sessions/coding
  - type: JSONSchema
    url: json-schema/heidi-health-clinical-code-schema.json
  - type: Examples
    url: examples/heidi-health-get-clinical-codes-example.json
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/transcription
  - type: JSONSchema
    url: json-schema/heidi-health-transcript-schema.json
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/consult-notes
  - type: JSONSchema
    url: json-schema/heidi-health-consult-note-schema.json
  - type: Examples
    url: examples/heidi-health-generate-consult-note-example.json
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/documents
  - type: JSONSchema
    url: json-schema/heidi-health-document-schema.json
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/ask-heidi
- aid: heidi-health:heidi-health-transcription-api
  name: Heidi Health Transcription API
  description: Audio upload and transcript retrieval.
  humanURL: https://www.heidihealth.com/developers/heidi-api/authentication
  tags:
  - Transcription
  properties:
  - type: OpenAPI
    url: openapi/heidi-health-transcription-api-openapi.yml
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/authentication
  - type: Examples
    url: examples/heidi-health-get-jwt-example.json
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/templates
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/patient-profiles
  - type: JSONSchema
    url: json-schema/heidi-health-patient-profile-schema.json
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/sessions/overview
  - type: JSONSchema
    url: json-schema/heidi-health-session-schema.json
  - type: JSONStructure
    url: json-structure/heidi-health-session-structure.json
  - type: Examples
    url: examples/heidi-health-create-session-example.json
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/sessions/context
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/sessions/coding
  - type: JSONSchema
    url: json-schema/heidi-health-clinical-code-schema.json
  - type: Examples
    url: examples/heidi-health-get-clinical-codes-example.json
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/transcription
  - type: JSONSchema
    url: json-schema/heidi-health-transcript-schema.json
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/consult-notes
  - type: JSONSchema
    url: json-schema/heidi-health-consult-note-schema.json
  - type: Examples
    url: examples/heidi-health-generate-consult-note-example.json
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/documents
  - type: JSONSchema
    url: json-schema/heidi-health-document-schema.json
  - type: Documentation
    url: https://www.heidihealth.com/developers/heidi-api/ask-heidi
common:
- type: PostmanWorkspace
  url: https://www.postman.com/kinlaneapi/heidi-health/overview
- type: AgenticAccess
  url: agentic-access/heidi-health-agentic-access.yml
- type: VulnerabilityDisclosure
  url: security/heidi-health-vulnerability-disclosure.yml
- type: DomainSecurity
  url: security/heidi-health-domain-security.yml
- type: Authentication
  url: authentication/heidi-health-authentication.yml
- type: Website
  url: https://www.heidihealth.com
- type: Portal
  url: https://www.heidihealth.com/developers
- type: Documentation
  url: https://www.heidihealth.com/developers/heidi-api/overview
- type: Documentation
  url: https://www.heidihealth.com/developers/faq
- type: Signup
  url: https://scribe.heidihealth.com/register
- type: Login
  url: https://scribe.heidihealth.com/login
- type: Pricing
  url: https://www.heidihealth.com/pricing
- type: Blog
  url: https://www.heidihealth.com/blog
- type: ChangeLog
  url: https://www.heidihealth.com/changelog
- type: StatusPage
  url: https://status.heidihealth.com
- type: TrustCenter
  url: https://trust.heidihealth.com
- type: Support
  url: https://support.heidihealth.com
- type: PrivacyPolicy
  url: https://www.heidihealth.com/legal/privacy-policy
- type: TermsOfService
  url: https://www.heidihealth.com/legal/terms-of-service
- type: AcceptableUse
  url: https://www.heidihealth.com/legal/usage-policy
- type: Compliance
  url: https://www.heidihealth.com/compliance/hipaa
- type: Compliance
  url: https://www.heidihealth.com/compliance/gdpr
- type: Compliance
  url: https://www.heidihealth.com/compliance/uk
- type: Compliance
  url: https://www.heidihealth.com/compliance/canada
- type: Compliance
  url: https://www.heidihealth.com/compliance/au-nz
- type: Safety
  url: https://www.heidihealth.com/safety
- type: Company
  url: https://www.heidihealth.com/company
- type: Customers
  url: https://www.heidihealth.com/customer-stories
- type: Press
  url: https://www.heidihealth.com/media
- type: Careers
  url: https://www.heidihealth.com/careers
- type: Contact
  url: https://www.heidihealth.com/contact
- type: Contact
  url: https://www.heidihealth.com/contact-sales
- type: Partners
  url: https://www.heidihealth.com/partners
- type: Integrations
  url: https://www.heidihealth.com/integrations
- type: Downloads
  url: https://www.heidihealth.com/downloads
- type: SystemRequirements
  url: https://www.heidihealth.com/system-requirements
- type: Templates
  url: https://www.heidihealth.com/template-community
- type: ROICalculator
  url: https://www.heidihealth.com/roi-calculator
- type: Plans
  url: plans/heidi-health-plans-pricing.yml
- type: RateLimits
  url: rate-limits/heidi-health-rate-limits.yml
- type: FinOps
  url: finops/heidi-health-finops.yml
- type: JSONLD
  url: json-ld/heidi-health-context.jsonld
- type: Vocabulary
  url: vocabulary/heidi-health-vocabulary.yml
- type: SpectralRules
  url: rules/heidi-health-rules.yml
- type: Features
  data:
  - Heidi Scribe — ambient AI medical scribe generating real-time consult notes from clinical audio
  - Heidi Evidence — clinical decision-support and literature lookup with transparent citations and CPD/CME tracking
  - Heidi Remote — 21-gram wearable microphone with offline capture and on-device encryption
  - Heidi Comms — clinical communications module
  - Heidi API — public REST API at registrar.api.heidihealth.com for sessions, transcription, consult notes, documents, coding,
    Ask Heidi
  - Heidi Widget — embeddable JavaScript widget for any web-based EHR
  - Custom JSON templates for organisation-specific consult-note structures
  - Multilingual transcription and output across 50+ countries
  - Voice-style controls (Goldilocks, Detailed, Brief, Super-Detailed, My Voice)
  - Clinical coding generation in ICD-10, ICD-10-CM, ICD-9, ICD-9-CM, SNOMED, SNOMED-CT, OPCS-410, ACHI-13, CPT-2025
  - Streamed generation responses for incremental UI rendering
  - Patient profiles linking many sessions to a single patient for longitudinal context
  - Context attachments (PDF, JPG, PNG, DOCX, DOC) per session
  - EHR integrations spanning Epic, Cerner, Athenahealth, eClinicalWorks (via Vim), Best Practice, Medical Director, Gentu,
    Cliniko, Halaxy, MediRecords, and 15+ others
  - Free plan with unlimited transcription and standard templates
  - Evidence Plus, Clinician, and Enterprise paid tiers with 14-day trials
  - Enterprise features including SSO, centralised billing, custom hosting, dedicated CSM
  - SOC 2, ISO 27001, ISO 42001, HIPAA, GDPR, APP, PIPEDA, NHS, Cyber Essentials+, UKCA, Swiss FDPA compliance
  - No clinician data used for AI model training
  - R1 RCM strategic partnership for US revenue cycle management
maintainers:
- FN: Kin Lane
  email: kin@apievangelist.com