RECURSO DE API

Pacientes

Ficha do paciente: dados demográficos, anamnese/alergias, histórico médico e documentos. Cada registro é isolado à sua clínica; a operação de exclusão é um arquivamento reversível (sem hard-delete).

Acesso Antecipado Toda a API

Endpoints

9 endpoint

Endpoints deste recurso. Cada endpoint é limitado aos dados da clínica à qual a chave de API está vinculada; os endpoints de gravação suportam o cabeçalho Idempotency-Key.

GET /v1/patients Obtém a lista de pacientes de forma paginada Todos os papéis autorizados

POST /v1/patients Cria um novo registro de paciente admin · secretário · médico

GET /v1/patients/{id} Obtém os detalhes de um único paciente Todos os papéis autorizados

PUT /v1/patients/{id} Atualiza as informações do paciente admin · secretário · médico

DELETE /v1/patients/{id} Arquiva o paciente (soft-delete) admin

GET /v1/patients/{id}/medical Lista anamnese, alergias e histórico médico Todos os papéis autorizados

POST /v1/patients/{id}/medical Adiciona um registro médico/de anamnese admin · médico

GET /v1/patients/{id}/documents Lista os documentos do paciente Todos os papéis autorizados

POST /v1/patients/{id}/documents Adiciona um documento ao paciente admin · secretário

Exemplo de Uso

Criar novo paciente

Requisição

curl -X POST https://api.udentiva.com/v1/patients \
  -H "Authorization: Bearer udk_live_xxx" \
  -H "Idempotency-Key: 9f1c2e7a-..." \
  -H "Content-Type: application/json" \
  -d '{"first_name":"Ayse","last_name":"Yilmaz","phone":"+90555..."}'

Resposta

HTTP/1.1 201 Created
{
  "id": "c0ffee00-1234-...",
  "first_name": "Ayse",
  "last_name": "Yilmaz",
  "phone": "+90555...",
  "created_at": "2026-06-24T09:00:00Z"
}

Segurança neste recurso

Segurança não é um recurso, é a própria arquitetura. As garantias que se aplicam a este recurso:

Isolamento de dados: todas as consultas de pacientes são limitadas em nível de linha (RLS) à clínica à qual a chave está vinculada; o paciente de outra clínica nunca é retornado.

Autorização baseada em papéis: criar/atualizar por admin, secretário ou médico; excluir apenas por admin. A autorização é imposta na camada da API.

Dados sensíveis (TCKN, dados de saúde) são mascarados e não são gravados de forma bruta no log de auditoria.

Exclusão = soft-delete (deleted_at); o registro é anonimizado, não é fisicamente excluído (em conformidade com a KVKK).

Todo o modelo de segurança →

Formato de Erro

Os erros retornam em um envelope consistente; o código é destinado à máquina, a mensagem ao usuário. Erro interno/stack nunca é vazado.

{
  "error": {
    "code": "validation_failed",
    "message": "Campo inválido: e-mail"
  }
}

Outros Recursos

Agendamentos e calendário Odontograma & Tratamento Cobrança e Finanças Estoque Imagem Laboratório Lead & CRM Turismo de saúde Relatórios & BI Webhooks Transferência de Dados (Export API)

Deseja acesso antecipado?

Seja o primeiro a saber quando a API for lançada.

Entre em Contato