Pacientes
Consulte e mantenha o cadastro de pacientes de saúde via OAuth2 client_credentials.
Visão Geral
Endpoints da API Externa para listar, buscar e fazer upsert de pacientes. A aplicação destino é inferida do claim aplicacao_id do token — todas as operações são escopadas ao seu tenant.
Base URL: /api/external/v2/pacientes
Autenticação: OAuth2 Bearer Token — escopos pacientes:read (GET) e pacientes:write (POST)
Listar Pacientes
GET /api/external/v2/pacientes
Escopo: pacientes:read
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
busca | string | Opcional | Filtro por nome, telefone ou CPF |
page | int | Opcional | Página (default 0) |
size | int | Opcional | Itens por página (default 20, máx 100) |
Resposta (200):
Buscar por CPF
GET /api/external/v2/pacientes/{cpf}
Escopo: pacientes:read. O CPF pode ser enviado com ou sem máscara — os dígitos são normalizados no servidor.
404 se não houver paciente com esse CPF na sua aplicação (não confirma existência em outros tenants).Cadastrar / Atualizar (Upsert por CPF)
POST /api/external/v2/pacientes
Escopo: pacientes:write. Se já existe paciente com o mesmo CPF na aplicação, os campos não-nulos são atualizados; senão um novo paciente é criado.
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
cpf | string | Obrigatório | 11 dígitos (com ou sem máscara) |
nome | string | Obrigatório | Nome completo |
telefone | string | Opcional | Número com DDI. Ex: +5511999999999 |
sexo | string | Opcional | Sexo |
bairro | string | Opcional | Bairro |
cidade | string | Opcional | Cidade |
estado | string | Opcional | UF |
cartaoSus | string | Opcional | Número do Cartão SUS |
201 Created quando cria um paciente novo e 200 OK quando atualiza um existente. CPF com formato inválido (≠ 11 dígitos) ou sem nome retorna 400.