Heidi Health · Schema

HeidiTranscript

Final or live chunked transcript produced from a Heidi session's audio.

HealthcareHealth TechAI Medical ScribeAmbient AIClinical DocumentationClinical Decision SupportArtificial IntelligenceSpeech To TextTranscriptionEHR IntegrationElectronic Health RecordsTelehealthClinical CodingICD-10SNOMEDHIPAAGDPRSOC 2ISO 27001ISO 42001WearablesVoiceAudioAustraliaMelbourne

Properties

Name Type Description
session_id string
transcript string Concatenated transcript text.
language_code string
active_source string Which audio source is currently active for the session.
chunks array
View JSON Schema on GitHub

JSON Schema

heidi-health-transcript-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/heidi-health/main/json-schema/heidi-health-transcript-schema.json",
  "title": "HeidiTranscript",
  "description": "Final or live chunked transcript produced from a Heidi session's audio.",
  "type": "object",
  "required": ["session_id"],
  "properties": {
    "session_id": { "type": "string" },
    "transcript": { "type": "string", "description": "Concatenated transcript text." },
    "language_code": { "type": "string" },
    "active_source": {
      "type": "string",
      "enum": ["USER_UPLOADED", "LIVE", "BACKUP"],
      "description": "Which audio source is currently active for the session."
    },
    "chunks": {
      "type": "array",
      "items": {
        "type": "object",
        "required": ["id", "status"],
        "properties": {
          "id": { "type": "string" },
          "status": { "type": "string", "enum": ["PENDING", "READY", "FAILED"] },
          "duration": { "type": "number" },
          "text": { "type": "string" },
          "source": { "type": "string", "enum": ["USER_UPLOADED", "LIVE", "BACKUP"] }
        }
      }
    }
  },
  "additionalProperties": true
}