Heidi Health · Schema

HeidiConsultNote

Consult note generated for a session against a Heidi or custom template.

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
template_id	stringnull
generation_method	string
voice_style	string
brain	string
addition	string
content_type	string
content	string
created_at	string

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/heidi-health/main/json-schema/heidi-health-consult-note-schema.json",
  "title": "HeidiConsultNote",
  "description": "Consult note generated for a session against a Heidi or custom template.",
  "type": "object",
  "required": ["session_id"],
  "properties": {
    "session_id": { "type": "string" },
    "template_id": { "type": ["string", "null"] },
    "generation_method": { "type": "string", "enum": ["TEMPLATE"] },
    "voice_style": {
      "type": "string",
      "enum": ["GOLDILOCKS", "DETAILED", "BRIEF", "SUPER_DETAILED", "MY_VOICE"]
    },
    "brain": { "type": "string", "enum": ["LEFT", "RIGHT"] },
    "addition": { "type": "string" },
    "content_type": { "type": "string", "enum": ["MARKDOWN", "HTML"] },
    "content": { "type": "string" },
    "created_at": { "type": "string", "format": "date-time" }
  },
  "additionalProperties": true
}