Set Consultation Context
curl --request POST \
--url https://scribe-api.telepatia.ai/v1/set-consultation-context \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"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"
}
'import requests
url = "https://scribe-api.telepatia.ai/v1/set-consultation-context"
payload = {
"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"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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'
})
};
fetch('https://scribe-api.telepatia.ai/v1/set-consultation-context', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://scribe-api.telepatia.ai/v1/set-consultation-context",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://scribe-api.telepatia.ai/v1/set-consultation-context"
payload := strings.NewReader("{\n \"consultationInternalId\": \"CONSULT-12345\",\n \"idCountry\": \"COLOMBIA\",\n \"idType\": \"PASSPORT\",\n \"idValue\": \"A12345678\",\n \"institutionalBranchId\": \"b1f2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d\",\n \"internalCode\": \"MRN-000123\",\n \"medicalRecordConfigurationId\": \"mrc_a1b2c3d4e5f6g7h8\",\n \"name\": \"John Doe\",\n \"notes\": \"Patient prefers morning appointments. Allergic to penicillin.\",\n \"pastMedicalHistory\": \"Hypertension diagnosed 2020. Diabetes Type 2 controlled with metformin.\",\n \"scribeSessionModality\": \"IN_PERSON\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://scribe-api.telepatia.ai/v1/set-consultation-context")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"consultationInternalId\": \"CONSULT-12345\",\n \"idCountry\": \"COLOMBIA\",\n \"idType\": \"PASSPORT\",\n \"idValue\": \"A12345678\",\n \"institutionalBranchId\": \"b1f2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d\",\n \"internalCode\": \"MRN-000123\",\n \"medicalRecordConfigurationId\": \"mrc_a1b2c3d4e5f6g7h8\",\n \"name\": \"John Doe\",\n \"notes\": \"Patient prefers morning appointments. Allergic to penicillin.\",\n \"pastMedicalHistory\": \"Hypertension diagnosed 2020. Diabetes Type 2 controlled with metformin.\",\n \"scribeSessionModality\": \"IN_PERSON\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://scribe-api.telepatia.ai/v1/set-consultation-context")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"consultationInternalId\": \"CONSULT-12345\",\n \"idCountry\": \"COLOMBIA\",\n \"idType\": \"PASSPORT\",\n \"idValue\": \"A12345678\",\n \"institutionalBranchId\": \"b1f2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d\",\n \"internalCode\": \"MRN-000123\",\n \"medicalRecordConfigurationId\": \"mrc_a1b2c3d4e5f6g7h8\",\n \"name\": \"John Doe\",\n \"notes\": \"Patient prefers morning appointments. Allergic to penicillin.\",\n \"pastMedicalHistory\": \"Hypertension diagnosed 2020. Diabetes Type 2 controlled with metformin.\",\n \"scribeSessionModality\": \"IN_PERSON\"\n}"
response = http.request(request)
puts response.read_body{
"consultationInternalId": "CONSULT-12345",
"success": true
}Consultations
Set Consultation Context
Set consultation context for a patient session.
POST
/
v1
/
set-consultation-context
Set Consultation Context
curl --request POST \
--url https://scribe-api.telepatia.ai/v1/set-consultation-context \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"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"
}
'import requests
url = "https://scribe-api.telepatia.ai/v1/set-consultation-context"
payload = {
"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"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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'
})
};
fetch('https://scribe-api.telepatia.ai/v1/set-consultation-context', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://scribe-api.telepatia.ai/v1/set-consultation-context",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://scribe-api.telepatia.ai/v1/set-consultation-context"
payload := strings.NewReader("{\n \"consultationInternalId\": \"CONSULT-12345\",\n \"idCountry\": \"COLOMBIA\",\n \"idType\": \"PASSPORT\",\n \"idValue\": \"A12345678\",\n \"institutionalBranchId\": \"b1f2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d\",\n \"internalCode\": \"MRN-000123\",\n \"medicalRecordConfigurationId\": \"mrc_a1b2c3d4e5f6g7h8\",\n \"name\": \"John Doe\",\n \"notes\": \"Patient prefers morning appointments. Allergic to penicillin.\",\n \"pastMedicalHistory\": \"Hypertension diagnosed 2020. Diabetes Type 2 controlled with metformin.\",\n \"scribeSessionModality\": \"IN_PERSON\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://scribe-api.telepatia.ai/v1/set-consultation-context")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"consultationInternalId\": \"CONSULT-12345\",\n \"idCountry\": \"COLOMBIA\",\n \"idType\": \"PASSPORT\",\n \"idValue\": \"A12345678\",\n \"institutionalBranchId\": \"b1f2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d\",\n \"internalCode\": \"MRN-000123\",\n \"medicalRecordConfigurationId\": \"mrc_a1b2c3d4e5f6g7h8\",\n \"name\": \"John Doe\",\n \"notes\": \"Patient prefers morning appointments. Allergic to penicillin.\",\n \"pastMedicalHistory\": \"Hypertension diagnosed 2020. Diabetes Type 2 controlled with metformin.\",\n \"scribeSessionModality\": \"IN_PERSON\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://scribe-api.telepatia.ai/v1/set-consultation-context")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"consultationInternalId\": \"CONSULT-12345\",\n \"idCountry\": \"COLOMBIA\",\n \"idType\": \"PASSPORT\",\n \"idValue\": \"A12345678\",\n \"institutionalBranchId\": \"b1f2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d\",\n \"internalCode\": \"MRN-000123\",\n \"medicalRecordConfigurationId\": \"mrc_a1b2c3d4e5f6g7h8\",\n \"name\": \"John Doe\",\n \"notes\": \"Patient prefers morning appointments. Allergic to penicillin.\",\n \"pastMedicalHistory\": \"Hypertension diagnosed 2020. Diabetes Type 2 controlled with metformin.\",\n \"scribeSessionModality\": \"IN_PERSON\"\n}"
response = http.request(request)
puts response.read_body{
"consultationInternalId": "CONSULT-12345",
"success": true
}Authorizations
API key passed as a Bearer token
Body
application/json
Request body for setting consultation context.
Required string length:
1 - 500Example:
"John Doe"
ISO 3166-1 alpha-2 country codes. Mirrors tanjiro's CountryCodes enum.
Available options:
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 Example:
"CO"
Supported patient identification document types.
Available options:
CC, TI, CE, RC, PASSPORT, RG, CPF, OTHER_DOC Example:
"CC"
Required string length:
1 - 50Example:
"123456789"
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.
Pattern:
^sp_[a-z0-9]{16}$Example:
"sp_a1b2c3d4e5f6g7h8"
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.
Required string length:
1 - 128Example:
"MRN-000123"
Maximum string length:
10000Example:
"Patient reports headache"
Maximum string length:
10000Example:
"Hypertension, Diabetes Type 2"
Maximum string length:
128Pattern:
^[a-zA-Z0-9_-]{1,128}$Example:
"CONSULT-12345"
Supported scribe session modalities.
Available options:
IN_PERSON, TELEMEDICINE, DICTATION Example:
"IN_PERSON"
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.
Maximum string length:
128Example:
"b1f2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d"
Name of the institution branch for this consultation. Resolved when institutionalBranchId is not provided. Provide the id or the name.
Maximum string length:
256Example:
"Sede Norte"
Public id of a scribe session configuration (ssc_ + 16 chars [a-z0-9]). Mutually exclusive with medicalRecordConfigurationId and medicalRecordConfiguration.
Maximum string length:
128Example:
"ssc_a1b2c3d4e5f6g7h8"
Public id of a medical record configuration (mrc_ + 16 chars [a-z0-9]). Mutually exclusive with scribeSessionConfigurationId and medicalRecordConfiguration.
Maximum string length:
128Example:
"mrc_a1b2c3d4e5f6g7h8"
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.