POST Encerrar Consulta
Encerra uma consulta. Muda o status para CLOSED e registra quem e quando finalizou. Não recebe conteúdo clínico: o prontuário é salvo durante a consulta, etapa por etapa. Idempotente — encerrar uma consulta já encerrada devolve o estado atual sem reescrever finalizedAt.
Autenticação necessária
Envie o header Authorization: Bearer {accessToken} (token de usuário) ou x-api-key: {apiKey} (integrações). Veja Autenticação.
Permissão necessária
Exige as permissões create_consultations e update_consultations. Tanto com token JWT quanto com API Key, todas são obrigatórias.
Endpoint
POST https://api-dev.imagemais.com.br/api/consultations/{id}/close
Parâmetros de Rota
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id | number | ✅ | ID da consulta |
Requisição
curl -X 'POST' \
'https://api-dev.imagemais.com.br/api/consultations/1/close' \
-H 'accept: application/json' \
-H 'Authorization: Bearer {accessToken}'
Respostas
201 Sucesso
400 Requisição inválida
Mensagens possíveis:
Validation failed (numeric string is expected)Preencha a conduta médica para encerrar a consulta
{
"message": "Validation failed (numeric string is expected)",
"error": "Bad Request",
"statusCode": 400
}
403 Sem permissão
{
"message": "Permissões insuficientes",
"error": "Forbidden",
"statusCode": 403
}
404 Não encontrado
{
"message": "Consulta não encontrada",
"error": "Not Found",
"statusCode": 404
}