Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Heidi Health Patient Profiles API

Longitudinal patient records.

Heidi Health Patient Profiles API is one of 11 APIs that Heidi Health publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 7 JSON Schema definitions.

Tagged areas include Patient Profiles. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 7 JSON Schemas.

This API exposes 6 operations across 4 paths, and defines 3 schemas. It is described by OpenAPI 3.1.0, at version v2.

Requests are made against a single base URL, https://registrar.api.heidihealth.com/api/v2/ml-scribe/open-api.

6 operations 4 paths 3 schemas 2 GET1 PATCH3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v2
Server
https://registrar.api.heidihealth.com/api/v2/ml-scribe/open-api
Authentication
API Key, HTTP Bearer
Resource Areas
1

Authentication & Security 2

Heidi Health Patient Profiles API declares 2 security schemes for authenticating requests. An API key is passed in the header as Heidi-Api-Key (heidiApiKey). It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

Paths & Operations 6

Across 4 paths, the API surfaces 6 operations — 2 GET, 1 PATCH, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Patient Profiles 6

Longitudinal patient records.

POST
/patient-profiles
Create Patient Profile
createPatientProfile body → 200
GET
/patient-profiles
List Patient Profiles
listPatientProfiles 2 params → 200
GET
/patient-profiles/{patient_profile_id}
Get Patient Profile
getPatientProfile 1 param → 200
PATCH
/patient-profiles/{patient_profile_id}
Update Patient Profile
updatePatientProfile 1 param body → 200
POST
/patient-profiles:batch-delete
Batch Delete Patient Profiles
batchDeletePatientProfiles body → 200
POST
/patient-profiles/{patient_profile_id}/sessions
Link Session To Patient Profile
linkSessionToPatientProfile 1 param body → 200

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed is PatientProfileCreate (6 properties). Each schema is shown below with its type and property counts.

PatientProfileCreate
object
6 properties
PatientProfileUpdate
PatientProfile

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

heidi-health-patient-profiles-api-openapi.yml Raw ↑

Other APIs Heidi Health publishes across the network.

Heidi Widget SDK
Heidi Health Ask Heidi API
Heidi Health Authentication API
Heidi Health Clinical Coding API
Heidi Health Consult Notes API
Heidi Health Documents API
Heidi Health Session Context API
Heidi Health Sessions API
Heidi Health Templates API
Heidi Health Transcription API