POST/api/procedures

Cadastrar procedimento

Cria um procedimento no catálogo da clínica.

  • Exige o token de acesso — como obter
  • Permissão “Cadastrar procedimento” (procedures.create)

Headers

NomeTipoObrig.Descrição
Authorization
stringSimBearer {access_token}, com o token que o login devolve.
Content-Type
stringSimapplication/json

Corpo da requisição

NomeTipoObrig.Descrição
name
stringSimNome. Gravado em maiúsculas.
exam_type
stringNãovideocolposcopia, ecocardiograma, mapa_holter, ultrassom, consulta_cardiologica ou consulta_clinica. Padrão: videocolposcopia.
description
stringNãoDescrição livre.
notes
stringNãoObservações.
status
stringNãopending, in_progress, completed ou cancelled. Padrão: pending.
procedure_date
stringNãoData e hora ISO 8601.

Campos da resposta

NomeTipoDescrição
id
uuidO procedimento.
name
stringNome, em maiúsculas. É o que aparece no agendamento e no laudo.
description
string | nullDescrição livre.
exam_type
stringO tipo de exame, que decide a tela em que ele é feito: videocolposcopia, ecocardiograma, mapa_holter, ultrassom, consulta_cardiologica ou consulta_clinica.
status
stringpending, in_progress, completed ou cancelled. Campo antigo do cadastro; não muda sozinho.
procedure_date
string | nullData e hora ISO 8601. Campo antigo do cadastro.
notes
string | nullObservações.
transcription_keywords
string[]Uso interno do ditado por voz. Pode ignorar.
calculators
string[]Uso interno do Atlas IA. Pode ignorar.
created_at
stringQuando foi cadastrado (ISO 8601).
updated_at
stringA última alteração (ISO 8601).
deleted_at
string | nullSempre null nas respostas: procedimento excluído não aparece.

Request URL

https://api-endosystem.imagemais.com.br/api/procedures
curl -X POST "https://api-endosystem.imagemais.com.br/api/procedures" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"US Obstétrico","exam_type":"ultrassom","description":"Ultrassonografia obstétrica de rotina"}'
{
  "name": "US Obstétrico",
  "exam_type": "ultrassom",
  ...
{
  "name": "US Obstétrico",
  "exam_type": "ultrassom",
  "description": "Ultrassonografia obstétrica de rotina"
}

Respostas

{
  "id": "3c1e9a7b-2d4f-4b6a-8e0c-5f7a9b1c3d2e",
  "name": "US OBSTÉTRICO",
  ...
{
  "id": "3c1e9a7b-2d4f-4b6a-8e0c-5f7a9b1c3d2e",
  "name": "US OBSTÉTRICO",
  "description": "Ultrassonografia obstétrica de rotina",
  "status": "pending",
  "exam_type": "ultrassom",
  "procedure_date": null,
  "notes": null,
  "transcription_keywords": [],
  "calculators": [],
  "created_at": "2026-09-02T10:15:00-03:00",
  "updated_at": "2026-09-02T10:15:00-03:00",
  "deleted_at": null
}
{
  "error": "name é obrigatório"
}
{
  "error": "name é obrigatório"
}
{
  "error": "exam_type deve ser um dos: videocolposcopia, ecocardiograma, mapa_holter, ultrassom, consulta_cardiologica, consulta_clinica"
}
{
  "error": "exam_type deve ser um dos: videocolposcopia, ecocardiograma, mapa_holter, ultrassom, consulta_cardiologica, consulta_clinica"
}
{
  "error": "status deve ser um dos: pending, in_progress, completed, cancelled"
}
{
  "error": "status deve ser um dos: pending, in_progress, completed, cancelled"
}
{
  "error": "procedure_date inválido. Use formato ISO 8601"
}
{
  "error": "procedure_date inválido. Use formato ISO 8601"
}
{
  "error": "Você não tem a permissão \"Cadastrar procedimento\".",
  "code": "sem_permissao"
  ...
{
  "error": "Você não tem a permissão \"Cadastrar procedimento\".",
  "code": "sem_permissao"
}
{
  "error": "Funcionalidade não contratada",
  "message": "Esta funcionalidade não está habilitada para a sua clínica.",
  ...
{
  "error": "Funcionalidade não contratada",
  "message": "Esta funcionalidade não está habilitada para a sua clínica.",
  "code": "FEATURE_NOT_ENABLED"
}
{
  "error": "Token ausente",
  "message": "Token de autenticação necessário.",
  ...
{
  "error": "Token ausente",
  "message": "Token de autenticação necessário.",
  "code": "TOKEN_MISSING"
}
{
  "error": "Token expirado",
  "message": "Sua sessão expirou. Faça login novamente.",
  ...
{
  "error": "Token expirado",
  "message": "Sua sessão expirou. Faça login novamente.",
  "code": "TOKEN_EXPIRED"
}
{
  "error": "Token inválido",
  "message": "Token de autenticação inválido. Faça login novamente.",
  ...
{
  "error": "Token inválido",
  "message": "Token de autenticação inválido. Faça login novamente.",
  "code": "TOKEN_INVALID"
}
{
  "error": "Acesso revogado",
  "message": "Seu acesso foi desativado. Procure o administrador da clínica.",
  ...
{
  "error": "Acesso revogado",
  "message": "Seu acesso foi desativado. Procure o administrador da clínica.",
  "code": "ACCESS_REVOKED"
}
{
  "error": "Erro interno do servidor"
}
{
  "error": "Erro interno do servidor"
}