Manter o cadastro

Este guia descreve a consulta, a alteração e a mudança de status do paciente. Os convênios do paciente estão em Convênios do paciente.

Encontrar um paciente

Quando o paciente não é encontrado para a clínica informada, o GET /paciente/{id} retorna 200 sem corpo.

Filtrar a listagem

curl -G "https://api.clinicanasnuvens.com.br/paciente/lista" \
  -H "Authorization: Basic <CREDENCIAIS_EM_BASE64>" \
  -H "clinicaNasNuvens-cid: <TOKEN_DA_CLINICA>" \
  --data-urlencode "nomeContem=Silva" \
  --data-urlencode "somenteAtivos=true" \
  --data-urlencode "registrosPorPagina=20"

Filtro	Comportamento
nomeContem	Localiza o texto em qualquer posição e compara com o nome social, quando informado, ou com o nome civil
cpfCnpj	Igualdade exata. O parâmetro de consulta é cpfCnpj; na requisição de cadastro, o campo é cpfcnpj
numeroIdentificacao	Igualdade exata
dataInicial / dataFinal	Filtram a data de cadastro
dataPor	Aceita o valor CRIACAO. O período (dataInicial/dataFinal) é sempre aplicado à data de cadastro

Quando apenas uma das datas é informada, o mesmo valor é usado para a outra, e a consulta considera um único dia.

Os resultados são ordenados pela data de cadastro, do mais antigo para o mais recente.

Alterar o cadastro

O PUT /paciente/{id} substitui os dados do cadastro pelos enviados no corpo da requisição. Os campos não informados não são preservados; para manter os valores atuais, consulte o cadastro antes e envie o corpo da requisição completo. O fluxo de alteração é:

  GET /paciente/{id}          →  obtém o cadastro completo
         ▼
  alteração dos campos        →  no objeto completo
         ▼
  PUT /paciente/{id}          →  envia o cadastro completo

Efeito dos campos omitidos:

Campo omitido	Efeito
contato	Remove todos os telefones, ramais e o e-mail
endereco	Remove CEP, rua, número, complemento, bairro e cidade
Um campo dentro de contato ou endereco	Remove aquele campo
nomeSocial, sexo, genero, cpfcnpj, numeroIdentificacao, idNacionalidade, idOrigem	Limpam o valor
estrangeiro	Grava false
nome dataNascimento	400 Bad Request, pois são obrigatórios em toda chamada

Contato e endereço pertencem à pessoa, portanto a alteração se aplica a todas as clínicas do grupo. A troca do cpfcnpj por um CPF já cadastrado no grupo vincula o paciente àquele cadastro, como na criação. Ver Pessoa e paciente.

O status do paciente não faz parte da requisição do PUT; ele é alterado pela operação descrita a seguir.

Ativar ou inativar

O status do paciente é alterado pela operação PATCH /paciente/{id}/status, que modifica apenas esse campo. O corpo da requisição contém somente o campo ativo:

Valor de ativo	Efeito
true	Ativa o paciente
false	Inativa o paciente

curl -X PATCH "https://api.clinicanasnuvens.com.br/paciente/1/status" \
  -H "Authorization: Basic <CREDENCIAIS_EM_BASE64>" \
  -H "clinicaNasNuvens-cid: <TOKEN_DA_CLINICA>" \
  -H "Content-Type: application/json" \
  -d '{ "ativo": false }'

A resposta contém o id e o ativo resultante: { "id": 1, "ativo": false }.

Comportamento	Detalhe
Escopo	Por clínica. A inativação na Clínica A não altera o paciente com o mesmo CPF na Clínica B
Repetição da chamada	Enviar o status atual retorna 200 sem alterar o registro
Paciente inativo	Continua disponível na consulta e pode ser alterado
Agendamentos	Os agendamentos existentes são mantidos
Convênios e origens	Os vínculos de convênio e a origem permanecem cadastrados
Validações	Na mudança de status, as validações do cadastro são aplicadas; pode ser retornado 400 Bad Request quando o CPF ou o número de identificação já está em uso por outro paciente da clínica

Veja na Referência

Os detalhes de cada operação, campo a campo, estão em Referência › Paciente.