Skip to main content
Pacientes são as pessoas sobre as quais tratam suas sessões de scribe. Crie um paciente uma vez e reutilize seu id público estável (sp_...) em todas as consultas, em vez de reenviar os campos de identidade toda vez. Os campos de identidade (name, idCountry, idType, idValue) são os mesmos usados por set-consultation-context e seguem as mesmas regras de validação — veja Documentos aceitos por país.
Os pacientes são limitados pelo papel da sua chave de API: uma chave de médico vê apenas os próprios pacientes; uma chave institucional vê todos os pacientes da sua instituição. Você nunca precisa passar um id de conta ou instituição — o escopo é aplicado no servidor.

Criar um paciente

POST /v1/patients requer name, idCountry, idType e idValue. O idType deve ser válido para o idCountry informado (ex.: CC com idCountry: BR retorna 400).
Resposta:
Guarde o id (sp_...) — ele é estável e reutilizável. Criar um paciente com um documento de identidade que já existe retorna o paciente existente em vez de um duplicado.

Listar pacientes

GET /v1/patients retorna os pacientes visíveis para sua chave, do mais recente ao mais antigo. Pagine com page (base 1) e limit (1–50, padrão 20).
Resposta:
total e totalPages são calculados apenas na primeira página — são null nas páginas seguintes para evitar uma varredura completa a cada clique. Use hasMore para paginar de forma confiável; ele é preciso em todas as páginas.

Consultar um paciente

GET /v1/patients/{patient_id} busca um único paciente pelo seu id público (sp_...). Retorna 404 se nenhum paciente com esse id for visível para sua chave.
Resposta:
idCountry, idType e idValue podem ser null para pacientes criados fora desta API que não possuem identificação.