Definir contexto da consulta

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",
  "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",
    "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',
    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',
    '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  \"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  \"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  \"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
}

POST

set-consultation-context

Definir contexto da consulta

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",
  "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",
    "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',
    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',
    '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  \"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  \"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  \"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
}

Autorizações

Authorization

string

header

obrigatório

Chave de API enviada como token Bearer

Corpo

application/json

Corpo da requisição para definir o contexto da consulta.

name

string | null

Required string length: 1 - 500

Exemplo:

"John Doe"

idCountry

enum<string> | null

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

Opções disponíveis:

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

Exemplo:

"CO"

idType

enum<string> | null

Tipos de documento de identificação do paciente suportados.

Opções disponíveis:

CC,

TI,

CE,

RC,

PASSPORT,

RG,

CPF,

OTHER_DOC

Exemplo:

"CC"

idValue

string | null

Required string length: 1 - 50

Exemplo:

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

Exemplo:

"sp_a1b2c3d4e5f6g7h8"

notes

string | null

Maximum string length: 10000

Exemplo:

"Patient reports headache"

pastMedicalHistory

string | null

Maximum string length: 10000

Exemplo:

"Hypertension, Diabetes Type 2"

consultationInternalId

string | null

Maximum string length: 128

Pattern: ^[a-zA-Z0-9_-]{1,128}$

Exemplo:

"CONSULT-12345"

scribeSessionModality

enum<string> | null

Modalidades de sessão de scribe suportadas.

Opções disponíveis:

IN_PERSON,

TELEMEDICINE

Exemplo:

"IN_PERSON"

scribeSessionConfigurationId

string | null

Maximum string length: 128

Exemplo:

"ssc_a1b2c3d4e5f6g7h8"

medicalRecordConfigurationId

string | null

Maximum string length: 128

Exemplo:

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

Resposta

Resposta bem-sucedida

Corpo da resposta para definição do contexto da consulta.

success

boolean

obrigatório

Exemplo:

true

consultationInternalId

string

obrigatório

Exemplo:

"CONSULT-12345"

Autenticação

Consultas

Sessões de Scribe

Suporte à Decisão Clínica

Smart Templates

Templates de Sessão

Pacientes

Definir contexto da consulta

Autorizações

Corpo

Resposta