v1

latestOpenAPI 3.1.02026-08-0629125194.8 KB

Heidi API

Update Session

update session details by id

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

Path parameters

session_idstring required

Request body

language_code'ar-AE' | 'auto' | 'bg' | 'ca' | 'zh' | 'zh-Hant' | 'zh-HK' | 'cs' | 'da' | 'da-DK' | 'nl' | 'en' | 'en-US' | 'en-AU' | 'en-GB' | 'en-NZ' | 'en-IN' | 'et' | 'fi' | 'nl-BE' | 'fr' | 'fr-CA' | 'de' | 'de-CH' | 'el' | 'hi' | 'hi-Latn' | 'hu' | 'id' | 'it' | 'ja' | 'ko' | 'ko-KR' | 'lv' | 'lt' | 'ms' | 'no' | 'pl' | 'pt' | 'pt-BR' | 'ro' | 'ru' | 'sk' | 'es' | 'es-419' | 'sv' | 'sv-SE' | 'th' | 'th-TH' | 'tr' | 'uk' | 'vi' | 'multi' | 'ar' | 'bn' | 'hr' | 'iw' | 'sr' | 'sl' | 'sw' | 'af' | 'am' | 'as' | 'az' | 'be' | 'bs' | 'ceb' | 'co' | 'cy' | 'dv' | 'eo' | 'eu' | 'fa' | 'fil' | 'fy' | 'ga' | 'gd' | 'gl' | 'gu' | 'ha' | 'haw' | 'hmn' | 'ht' | 'hy' | 'ig' | 'is' | 'jv' | 'ka' | 'kk' | 'km' | 'kn' | 'kri' | 'ku' | 'ky' | 'la' | 'lb' | 'lo' | 'mg' | 'mi' | 'mk' | 'ml' | 'mn' | 'mni-Mtei' | 'mr' | 'mt' | 'my' | 'ne' | 'ny' | 'or' | 'pa' | 'ps' | 'sd' | 'si' | 'sm' | 'sn' | 'so' | 'sq' | 'st' | 'su' | 'ta' | 'te' | 'to' | 'tg' | 'ug' | 'ur' | 'uz' | 'xh' | 'yi' | 'yo' | 'zu'

output_language_code'ar-AE' | 'auto' | 'bg' | 'ca' | 'zh' | 'zh-Hant' | 'zh-HK' | 'cs' | 'da' | 'da-DK' | 'nl' | 'en' | 'en-US' | 'en-AU' | 'en-GB' | 'en-NZ' | 'en-IN' | 'et' | 'fi' | 'nl-BE' | 'fr' | 'fr-CA' | 'de' | 'de-CH' | 'el' | 'hi' | 'hi-Latn' | 'hu' | 'id' | 'it' | 'ja' | 'ko' | 'ko-KR' | 'lv' | 'lt' | 'ms' | 'no' | 'pl' | 'pt' | 'pt-BR' | 'ro' | 'ru' | 'sk' | 'es' | 'es-419' | 'sv' | 'sv-SE' | 'th' | 'th-TH' | 'tr' | 'uk' | 'vi' | 'multi' | 'ar' | 'bn' | 'hr' | 'iw' | 'sr' | 'sl' | 'sw' | 'af' | 'am' | 'as' | 'az' | 'be' | 'bs' | 'ceb' | 'co' | 'cy' | 'dv' | 'eo' | 'eu' | 'fa' | 'fil' | 'fy' | 'ga' | 'gd' | 'gl' | 'gu' | 'ha' | 'haw' | 'hmn' | 'ht' | 'hy' | 'ig' | 'is' | 'jv' | 'ka' | 'kk' | 'km' | 'kn' | 'kri' | 'ku' | 'ky' | 'la' | 'lb' | 'lo' | 'mg' | 'mi' | 'mk' | 'ml' | 'mn' | 'mni-Mtei' | 'mr' | 'mt' | 'my' | 'ne' | 'ny' | 'or' | 'pa' | 'ps' | 'sd' | 'si' | 'sm' | 'sn' | 'so' | 'sq' | 'st' | 'su' | 'ta' | 'te' | 'to' | 'tg' | 'ug' | 'ur' | 'uz' | 'xh' | 'yi' | 'yo' | 'zu'

durationinteger nullable

transcribe_mode'TRANSCRIBE' | 'DICTATE'

clinician_notesstring[] nullable

latest_consult_note_idstring nullable

ehr_patient_idstring nullable

generate_output_without_recordingboolean nullable

recording_status'IDLE' | 'PAUSED' | 'RECORDING'

Represents the current status of the recording session.

session_status'EMPTY' | 'DRAFT' | 'REVIEWED' | 'APPROVED' | 'SENT'

Represents the review workflow status of a session's letter/document.

is_consentboolean nullable

created_time_localstring date-time nullable

linked_sessions_for_contextstring[] nullable

Example request

{
  "latest_consult_note_id": "5eb7cf5a86d9755df3a6c593"
}

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"
    }
  }
}