Heidi Health · Example Payload

Heidi Health Generate Consult Note Example

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

Heidi Health Generate Consult Note Example is an example object payload from Heidi Health, with 5 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationmethodpathrequestresponse

Example Payload

Raw ↑ 
{
  "operation": "generateConsultNote",
  "method": "POST",
  "path": "/sessions/{session_id}/consult-note",
  "request": {
    "headers": {
      "Authorization": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
      "Content-Type": "application/json"
    },
    "path": {
      "session_id": "sess_01HXYZABC456"
    },
    "body": {
      "generation_method": "TEMPLATE",
      "template_id": "tpl_h_and_p",
      "addition": "Include differential diagnosis prioritised by likelihood.",
      "voice_style": "GOLDILOCKS",
      "brain": "LEFT",
      "content_type": "MARKDOWN"
    }
  },
  "response": {
    "status": 200,
    "content_type": "application/x-ndjson",
    "body_stream": [
      { "data": "## History\n" },
      { "data": "55-year-old female presenting with " },
      { "data": "intermittent chest pain over the past " },
      { "data": "two weeks...\n" },
      { "data": "## Differential\n1. Stable angina\n2. GERD\n3. Costochondritis\n" }
    ]
  }
}