Skip to main content
POST
/
v1
/
set-consultation-context
Set Consultation Context
curl --request POST \
  --url https://synapse.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",
  "name": "John Doe",
  "notes": "Patient prefers morning appointments. Allergic to penicillin.",
  "pastMedicalHistory": "Hypertension diagnosed 2020. Diabetes Type 2 controlled with metformin.",
  "scribeSessionConfigurationId": "ssc_a1b2c3d4e5f6g7h8",
  "scribeSessionModality": "IN_PERSON"
}
'
{
  "consultationInternalId": "EMR-CONSULT-12345",
  "success": true
}

Authorizations

​
Authorization
string
header
required

API key passed as a Bearer token

Body

application/json

Request body for setting consultation context.

​
name
string
required
Required string length: 1 - 500
Example:

"John Doe"

​
idCountry
enum<string>
required

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"

​
idType
enum<string>
required

Supported patient identification document types.

Available options:
CC,
TI,
CE,
RC,
PASSPORT,
RG,
CPF,
OTHER_DOC
Example:

"CC"

​
idValue
string
required
Required string length: 1 - 50
Example:

"123456789"

​
notes
string | null
Maximum string length: 10000
Example:

"Patient reports headache"

​
pastMedicalHistory
string | null
Maximum string length: 10000
Example:

"Hypertension, Diabetes Type 2"

​
consultationInternalId
string | null
Maximum string length: 128
Pattern: ^[a-zA-Z0-9_-]{1,128}$
Example:

"CONSULT-12345"

​
scribeSessionModality
enum<string> | null

Supported scribe session modalities.

Available options:
IN_PERSON,
TELEMEDICINE
Example:

"IN_PERSON"

​
scribeSessionConfigurationId
string | null
Maximum string length: 128
Example:

"ssc_a1b2c3d4e5f6g7h8"

Response

Successful Response

Response body for setting consultation context.

​
success
boolean
required
Example:

true

​
consultationInternalId
string
required
Example:

"EMR-CONSULT-12345"