Skip to content

Médicos ​

Cadastro de médicos por empresa. Toda rota exige um token de usuário da empresa (Authorization: Bearer <token>); os registros são sempre escopados pela empresa atual (companyId do token), nunca por parâmetro.

MétodoRotaAuthDescrição
GET/api/doctorsBearerlista médicos da empresa (filtros + paginação)
GET/api/doctors/optionsBearerespecialidades e filiais (filtro e formulário)
GET/api/doctors/:idBearerdetalhe de um médico
POST/api/doctorsBearercadastra um médico
PATCH/api/doctors/:idBeareratualiza o cadastro (campos parciais)

Listar médicos ​

Aceita filtros por busca livre (q — nome ou CRM), especialidade, filial e status (ativo | afastado | inativo), além de paginação (page ≥ 1, perPage 1–100, padrão 8).

bash
curl "$BASE/api/doctors?q=ana&especialidade=Cardiologia&status=ativo&page=1&perPage=8" \
  -H "authorization: Bearer <token>"

A resposta é um envelope paginado com um resumo da empresa (independente dos filtros):

json
{
  "items": [ { "id": "…", "nome": "Ana Souza", "crm": "18.452", "ufCrm": "DF", "especialidade": "Cardiologia", "status": "ativo" } ],
  "total": 12,
  "page": 1,
  "perPage": 8,
  "summary": { "total": 12, "ativos": 10, "certificadosCriticos": 2 }
}

certificadosCriticos conta certificados digitais vencidos ou que expiram em até 60 dias.

Cadastrar médico ​

bash
curl -X POST $BASE/api/doctors -H "authorization: Bearer <token>" -H 'content-type: application/json' \
  -d '{
    "nome": "Ana Souza",
    "crm": "18.452",
    "ufCrm": "DF",
    "especialidade": "Cardiologia",
    "filial": "Matriz",
    "cpf": "123.456.789-01",
    "nascimento": "1985-05-23",
    "telefone": "(61) 99888-7777"
  }'

DTO & validação ​

CampoObrigatórioRegra
nomesimstring, 2–120 caracteres
crmsimstring, 1–20 caracteres
ufCrmsimUF do CRM, exatamente 2 caracteres (ex.: DF)
especialidadesimstring
filialsimstring
cpfsimCPF válido (dígitos verificadores); armazenado como dígitos crus
nascimentosimdata YYYY-MM-DD
telefonesimapenas dígitos, 10 ou 11 (formatação removida na entrada)
cbonãostring (Classificação Brasileira de Ocupações)
statusnãoativo | afastado | inativo
certificadoExpiraEmnãodata YYYY-MM-DD, ou null
emailnãostring

CPF e telefone são normalizados para dígitos crus na entrada: 123.456.789-01 → 12345678901, (61) 99888-7777 → 61998887777. O CPF passa por validação dos dígitos verificadores.

PATCH /api/doctors/:id aceita os mesmos campos, todos opcionais — apenas os enviados são alterados.