HEheidihealth
Heidi API

Get Session Details

Changed on

get session details

get/api/v2/ml-scribe/open-api/sessions/{session_id}

Request

  • Base URL
    https://au.api.heidihealth.com
  • Auth
    HTTP bearer

Path parameters

session_idstring required

Response

Successful Response

Example response

{
  "session": {
    "documents": [
      {
        "id": "5eb7cf5a86d9755df3a6c593",
        "template_id": "5eb7cf5a86d9755df3a6c593",
        "ai_command_id": "5eb7cf5a86d9755df3a6c593"
      }
    ],
    "latest_consult_note_id": "5eb7cf5a86d9755df3a6c593",
    "patient_profile": {
      "id": "5eb7cf5a86d9755df3a6c593",
      "managed_by": "5eb7cf5a86d9755df3a6c593"
    },
    "consult_note": {
      "template_id": "5eb7cf5a86d9755df3a6c593",
      "ai_command_id": "5eb7cf5a86d9755df3a6c593"
    }
  }
}

Changes

  • 353da1bac96fRevision changes
    • warning

      added the new ASK_AI enum value to the ///// response property for the response status

    • warning

      added the new AUTO_MODE enum value to the // response property for the response status

    • warning

      added the new BLANK enum value to the ///// response property for the response status

    • warning

      added the new DICTATION enum value to the // response property for the response status

    • warning

      added the new DICTATION enum value to the ///// response property for the response status