Skip to main content
POST
Establecer contexto de consulta

Autorizaciones

Authorization
string
header
requerido

Clave API enviada como token Bearer

Cuerpo

application/json

Cuerpo de solicitud para establecer el contexto de consulta.

name
string | null
Required string length: 1 - 500
Ejemplo:

"John Doe"

idCountry
enum<string> | null

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

Opciones disponibles:
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
Ejemplo:

"CO"

idType
enum<string> | null

Tipos de documento de identificación de paciente soportados.

Opciones disponibles:
CC,
TI,
CE,
RC,
PASSPORT,
RG,
CPF,
OTHER_DOC
Ejemplo:

"CC"

idValue
string | null
Required string length: 1 - 50
Ejemplo:

"123456789"

patientId
string | null

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}$
Ejemplo:

"sp_a1b2c3d4e5f6g7h8"

internalCode
string | null

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 - 128
Ejemplo:

"MRN-000123"

notes
string | null
Maximum string length: 10000
Ejemplo:

"Patient reports headache"

pastMedicalHistory
string | null
Maximum string length: 10000
Ejemplo:

"Hypertension, Diabetes Type 2"

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

"CONSULT-12345"

scribeSessionModality
enum<string> | null

Modalidades de sesión de scribe soportadas.

Opciones disponibles:
IN_PERSON,
TELEMEDICINE,
DICTATION
Ejemplo:

"IN_PERSON"

institutionalBranchId
string | null

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: 128
Ejemplo:

"b1f2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d"

institutionalBranch
string | null

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

Maximum string length: 256
Ejemplo:

"Sede Norte"

scribeSessionConfigurationId
string | null

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

Maximum string length: 128
Ejemplo:

"ssc_a1b2c3d4e5f6g7h8"

medicalRecordConfigurationId
string | null

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

Maximum string length: 128
Ejemplo:

"mrc_a1b2c3d4e5f6g7h8"

medicalRecordConfiguration
Medicalrecordconfiguration · object | null

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.

Respuesta

Respuesta exitosa

Cuerpo de respuesta para establecer el contexto de consulta.

success
boolean
requerido
Ejemplo:

true

consultationInternalId
string
requerido
Ejemplo:

"CONSULT-12345"