Usar a fila

Colocar um paciente na fila

curl -X POST "https://api.clinicanasnuvens.com.br/lista-espera/novo" \
  -H "Authorization: Basic <CREDENCIAIS_EM_BASE64>" \
  -H "clinicaNasNuvens-cid: <TOKEN_DA_CLINICA>" \
  -H "Content-Type: application/json" \
  -d '{
    "idPaciente": 3,
    "observacoes": "Aguardando vaga, aceita qualquer horário.",
    "idPessoaExecutor": 1,
    "idTipoConsulta": 15
  }'

Campos da requisição

Campo	Tipo	Obrigatório	Descrição
`idPaciente`	Integer	Sim	Paciente que entrará na fila
`observacoes`	String	Sim	Observação sobre o paciente na fila, com até 1000 caracteres. Texto vazio é recusado
`idPessoaExecutor`	Integer	Não	`id` do executor desejado. Sem ele, o paciente aceita qualquer profissional
`idTipoConsulta`	Integer	Conforme a clínica	Tipo de consulta pretendido

{
  "id": 1542,
  "idPaciente": 3,
  "idPessoaExecutor": 1,
  "idTipoConsulta": 15,
  "observacoes": "Aguardando vaga, aceita qualquer horário."
}

O identificador retornado na criação é usado para consultar e alterar o registro.

Na lista de espera, o campo idPessoaExecutor recebe o id do executor. Ver Identificadores.

Sem idPessoaExecutor, o paciente fica disponível para qualquer profissional.

O campo observacoes é obrigatório e aceita até 1000 caracteres; texto vazio é recusado. O idTipoConsulta pode ser obrigatório, conforme a configuração da clínica.

Regras de duplicidade

O sistema identifica uma entrada pelo par paciente + profissional:

Situação	Resultado
Mesmo paciente, mesmo profissional, ainda na fila	Recusado
Mesmo paciente, profissionais diferentes	Permitido, entradas independentes
Mesmo paciente, mesmo profissional, já saiu da fila	Permitido: a entrada existente é reativada e um novo `id` é devolvido
Mesmo paciente, sem profissional, já havendo entradas com profissional	Permitido, a entrada sem profissional é independente

A lista de espera não tem limite de pacientes.

Consultar

curl "https://api.clinicanasnuvens.com.br/lista-espera/1542" \
  -H "Authorization: Basic <CREDENCIAIS_EM_BASE64>" \
  -H "clinicaNasNuvens-cid: <TOKEN_DA_CLINICA>"

Alterar

curl -X PUT "https://api.clinicanasnuvens.com.br/lista-espera/1542" \
  -H "Authorization: Basic <CREDENCIAIS_EM_BASE64>" \
  -H "clinicaNasNuvens-cid: <TOKEN_DA_CLINICA>" \
  -H "Content-Type: application/json" \
  -d '{
    "observacoes": "Paciente só pode nas manhãs de terça.",
    "idPessoaExecutor": 1,
    "idTipoConsulta": 15
  }'

Resposta:

{
  "id": 1542,
  "idPaciente": 3,
  "idPessoaExecutor": 1,
  "idTipoConsulta": 15,
  "observacoes": "Paciente só pode nas manhãs de terça."
}

A alteração substitui os dados do registro pelos enviados no corpo da requisição. Os campos não informados não são preservados. Para manter os valores atuais, consulte o registro antes e envie o corpo da requisição completo.

Campo	Omitido ou nulo
`observacoes`	`400 Bad Request`, pois é obrigatória em toda chamada
`idPessoaExecutor`	Remove o profissional do registro
`idTipoConsulta`	Remove o tipo de consulta
`idPaciente`	Não pertence a esta operação, é ignorado

Regras adicionais:

Situação do registro. A alteração é aceita em qualquer situação, inclusive quando o paciente já foi agendado, atendido ou removido da fila.
Conflito de profissional. A alteração para um profissional que já tem outra entrada do mesmo paciente é recusada, mesmo que a outra entrada já tenha saído da fila.
Paciente. O paciente do registro é mantido; outro paciente é registrado com uma nova criação.

Como o paciente sai da fila

A saída da fila ocorre automaticamente, por eventos do sistema:

  Um agendamento é criado para o paciente     →  sai como AGENDADO
  (inclusive via POST /agenda/novo)

  Um prontuário é finalizado sem agendamento  →  sai como ATENDIDO

  Remoção pela interface do sistema          →  sai como REMOVIDO

Saída da fila na criação do agendamento

Ao criar um agendamento, o sistema procura a entrada do paciente com o profissional do agendamento e, quando não a encontra, a entrada sem profissional. A entrada encontrada sai da fila como AGENDADO. Quando o paciente não tem nenhuma dessas entradas em espera, a fila não é alterada.

Se o paciente está na fila com o profissional A e o agendamento é feito com o profissional B, a entrada do profissional A permanece em espera.

Esses eventos não geram notificação para a integração. A situação do paciente pode ser acompanhada pela agenda dele.

Veja na Referência

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

Colocar um paciente na fila​

Campos da requisição​

Regras de duplicidade​

Consultar​

Alterar​

Como o paciente sai da fila​

Veja na Referência​