PATCH Atualizar Protocolo
Atualiza um protocolo. Todos os campos são opcionais; items, quando enviado, substitui a lista inteira. Editar um protocolo da clínica, ou mudar clinic, exige também manage_medical_protocols. Regras de conteúdo: o protocolo precisa de pelo menos um item ou um dos textos; o texto do atestado não pode conter código de CID (ele só entra com a concordância do paciente, caso a caso — CFM 2.381/2024).
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 a permissão update_medical_protocols.
Endpoint
PATCH https://api-dev.imagemais.com.br/api/medical-protocols/{id}
Parâmetros de Rota
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id | number | ✅ | ID do protocolo |
Corpo da Requisição
| Campo | Tipo | Obrigatório | Valores válidos | Descrição |
|---|---|---|---|---|
name | string | ❌ | até 120 caracteres; não vazio | Nome do protocolo |
clinic | boolean | ❌ | true ou false | true: protocolo de toda a clínica; false: só de quem criou |
cids | string[] | ❌ | até 20 itens; formato A00 ou A00.0, e existir na CID-10 | Códigos da CID-10 do protocolo (pode ser vazio) |
lifestyleAdvice | string | ❌ | até 5000 caracteres | Texto de orientações de estilo de vida |
medicalCertificate | string | ❌ | até 5000 caracteres; sem código de CID | Texto do atestado |
declaration | string | ❌ | até 5000 caracteres | Texto da declaração |
medicalConduct | string | ❌ | até 5000 caracteres | Texto da conduta médica |
items | object[] | ❌ | até 100 itens | Itens do protocolo. Quando enviado, substitui a lista inteira |
items[].type | string | ✅ | PRESCRIPTION, EXAM ou REFERRAL | Tipo do item |
items[].text | string | ✅ | até 1000 caracteres; não vazio | Texto do item (ex.: nome do medicamento ou do exame) |
items[].category | string | ❌ | laboratorio ou imagens | Obrigatório quando type é EXAM |
items[].procedureId | number | ❌ | inteiro positivo | Só para EXAM: procedimento do catálogo da clínica. Sem ele, o exame é texto livre |
items[].data | object | ❌ | mapa de texto | Campos da prescrição ou do encaminhamento (ex.: medicamento, dosagem, posologia). Ignorado em EXAM |
Requisição
curl -X 'PATCH' \
'https://api-dev.imagemais.com.br/api/medical-protocols/1' \
-H 'accept: application/json' \
-H 'Authorization: Bearer {accessToken}' \
-H 'Content-Type: application/json' \
-d '{
"name": "Hipertensão — acompanhamento (revisado)",
"medicalConduct": "Retorno em 15 dias."
}'
Respostas
200 Sucesso
{
"id": 31,
"name": "Hipertensão — acompanhamento (revisado)",
"clinic": true,
"cids": [
{
"code": "I10",
"name": "Hipertensão essencial (primária)"
}
],
"lifestyleAdvice": "Reduzir o sal e praticar atividade física.",
"medicalCertificate": null,
"declaration": null,
"medicalConduct": "Retorno em 15 dias.",
"items": [
{
"type": "PRESCRIPTION",
"text": "Losartana 50 mg",
"category": null,
"data": {
"medicamento": "Losartana",
"dosagem": "50 mg",
"posologia": "1 comprimido ao dia"
},
"procedureId": null
},
{
"type": "EXAM",
"text": "Creatinina",
"category": "laboratorio",
"data": null,
"procedureId": 42
}
],
"updatedAt": "2026-11-10T14:00:00.000Z"
}
400 Requisição inválida
Mensagens possíveis, além das de validação dos campos:
O protocolo precisa de pelo menos um item ou textoO atestado do protocolo não pode ter CID: ele só entra com a concordância do pacienteCID não encontrado: {códigos}Procedimento não encontrado no catálogo da clínicaProtocolo pessoal precisa de um usuário(chamada com API Key eclinic: false)Validation failed (numeric string is expected)(idinválido)
{
"message": "CID não encontrado: Z99",
"error": "Bad Request",
"statusCode": 400
}
403 Sem permissão
Além de Permissões insuficientes, responde assim quando o protocolo é da clínica e falta manage_medical_protocols.
{
"message": "Permissões insuficientes para alterar os protocolos da clínica",
"error": "Forbidden",
"statusCode": 403
}
404 Não encontrado
{
"message": "Protocolo não encontrado",
"error": "Not Found",
"statusCode": 404
}