Skip to main content

POST Upload de Documento de Conduta

Realiza o upload de um documento vinculado à conduta médica de uma consulta (prescrições, exames, encaminhamentos, orientações, atestado, declaração, parecer cardiológico, receita controlada).

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.

Formato da requisição

Esta rota utiliza multipart/form-data. Apesar do nome sugerir apenas PDF, são aceitos pdf, doc, docx, xls, xlsx e txt.


Endpoint​

POST https://api-dev.imagemais.com.br/api/consultations/conduct-document/upload

Corpo da Requisição (multipart/form-data)​

CampoTipoObrigatórioDescrição
fileFile (pdf, doc, docx, xls, xlsx, txt)✅Arquivo a ser enviado
consultationIdnumber✅ID da consulta vinculada
documentTypestring✅Tipo do documento. Define a pasta de armazenamento e o rótulo do arquivo (ver valores conhecidos abaixo)
replaceBeforestring (ISO 8601)❌Instante de início desta publicação. Documentos da mesma consulta e mesmo documentType criados antes dele são marcados como excluídos — use ao regerar um documento para não deixar duas versões válidas no prontuário

Valores conhecidos de documentType​

O campo não é validado contra uma lista fixa — qualquer texto é aceito. Os valores abaixo recebem um rótulo amigável no nome do arquivo; outros valores usam o próprio texto como rótulo.

ValorRótulo
parecer-cardiologicoParecer Cardiológico
receita-controladaReceituário Controle Especial
prescricoesPrescrições
examesExames
encaminhamentosEncaminhamentos
orientacoesOrientações
atestadoAtestado Médico
declaracaoDeclaração de Comparecimento

Requisição​

curl -X 'POST' \
'https://api-dev.imagemais.com.br/api/consultations/conduct-document/upload' \
-H 'Authorization: Bearer {accessToken}' \
-F 'file=@"/caminho/para/documento.pdf"' \
-F 'consultationId=1' \
-F 'documentType=prescricoes'

Respostas​

201 Criado​

Retorna o objeto do arquivo salvo com a URL de acesso.

{
"id": 317,
"url": "https://storagedev.imagemaislaboratorio.com.br/consultations/1/prescricoes/c08c441ef33a7d37e5fd698375855458414891025da22e47b864347e0f770f7f",
"fileType": "pdf",
"name": "Prescrições - ImageMais.pdf",
"accountId": null,
"createdAt": "2026-05-19T11:13:35.765Z",
"updatedAt": "2026-05-19T11:13:35.765Z",
"deletedAt": null
}

500 Tipo de arquivo não permitido ou falha no upload​

Retornado quando a extensão do arquivo não está entre pdf, doc, docx, xls, xlsx, txt (ex.: .png) ou quando o envio ao storage falha — o serviço converte qualquer erro do upload nesta mensagem genérica.

{
"message": "Erro ao fazer upload do documento de conduta",
"error": "Internal Server Error",
"statusCode": 500
}

404 Consulta não encontrada​

Retornado quando o consultationId informado não existe (ou pertence a outra conta).

{
"statusCode": 404,
"message": "Consulta não encontrada",
"error": "Not Found"
}

403 Sem Permissão​

Retornado quando o usuário autenticado não possui permissão para fazer upload de documentos de conduta.

{
"message": "Permissões insuficientes",
"error": "Forbidden",
"statusCode": 403
}