Consultation

Set Consultation Context

Set consultation context for a patient session.

post/v1/set-consultation-context

Request

Base URL
https://scribe-api.telepatia.ai
Auth
HTTP bearer

Request body

namestring nullable

idCountry'AF' | 'AX' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BQ' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CX' | 'CC' | 'CO' | 'KM' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CW' | 'CY' | 'CZ' | 'CD' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'SZ' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GG' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IQ' | 'IE' | 'IR' | 'IM' | 'IL' | 'IT' | 'JM' | 'JP' | 'JE' | 'JO' | 'KZ' | 'KE' | 'KI' | 'XK' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'ME' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'KP' | 'MP' | 'NO' | 'OM' | 'PK' | 'PW' | 'PA' | 'PG' | 'PY' | 'CN' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'CG' | 'GM' | 'RE' | 'RO' | 'RU' | 'RW' | 'BL' | 'SH' | 'KN' | 'LC' | 'MF' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'RS' | 'SC' | 'SL' | 'SG' | 'SX' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'KR' | 'SS' | 'ES' | 'LK' | 'PS' | 'SD' | 'SR' | 'SJ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TH' | 'MK' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'TZ' | 'UM' | 'US' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW'

ISO 3166-1 alpha-2 country codes. Mirrors tanjiro's CountryCodes enum.

idType'CC' | 'TI' | 'CE' | 'RC' | 'PASSPORT' | 'RG' | 'CPF' | 'OTHER_DOC'

Supported patient identification document types.

idValuestring nullable

patientIdstring nullable

Public id of an existing patient (sp_...). When provided, the patient's stored identity is used and the inline identity fields (name, idCountry, idType, idValue) must be omitted. Mutually exclusive with the inline identity.

internalCodestring nullable

Your own patient code, unique per institution. Looks up an existing patient by this code; when none matches, the inline identity (name, idCountry, idType, idValue) creates and tags the patient at session start. Mutually exclusive with patientId.

notesstring nullable

pastMedicalHistorystring nullable

consultationInternalIdstring nullable

scribeSessionModality'IN_PERSON' | 'TELEMEDICINE' | 'DICTATION'

Supported scribe session modalities.

institutionalBranchIdstring nullable

Id of the institution branch for this consultation, returned by the create-branch endpoint. Stamped onto the scribe session at creation. Provide the id or the name.

institutionalBranchstring nullable

Name of the institution branch for this consultation. Resolved when institutionalBranchId is not provided. Provide the id or the name.

scribeSessionConfigurationIdstring nullable

Public id of a scribe session configuration (ssc_ + 16 chars [a-z0-9]). Mutually exclusive with medicalRecordConfigurationId and medicalRecordConfiguration.

medicalRecordConfigurationIdstring nullable

Public id of a medical record configuration (mrc_ + 16 chars [a-z0-9]). Mutually exclusive with scribeSessionConfigurationId and medicalRecordConfiguration.

medicalRecordConfigurationobject nullable

Inline medical record configuration JSON keyed by section name (e.g. 'chiefComplaint'). Auto-persisted and deduplicated by content hash; the resolved configuration id is attached to the doctor context buffer. Mutually exclusive with medicalRecordConfigurationId and scribeSessionConfigurationId.

Example request

{
  "consultationInternalId": "CONSULT-12345",
  "idCountry": "COLOMBIA",
  "idType": "PASSPORT",
  "idValue": "A12345678",
  "institutionalBranchId": "b1f2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
  "internalCode": "MRN-000123",
  "medicalRecordConfigurationId": "mrc_a1b2c3d4e5f6g7h8",
  "name": "John Doe",
  "notes": "Patient prefers morning appointments. Allergic to penicillin.",
  "pastMedicalHistory": "Hypertension diagnosed 2020. Diabetes Type 2 controlled with metformin.",
  "scribeSessionModality": "IN_PERSON"
}

Response

Successful Response

successboolean required

consultationInternalIdstring required

Example response

{
  "consultationInternalId": "CONSULT-12345",
  "success": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.