Pular para o conteúdo principal

Consultar procedimentos

Procedimentos são os serviços que a clínica realiza: consultas, exames, aplicações, tratamentos etc. Eles entram no agendamento pelo array procedimentos, indicando o que será efetivamente feito no atendimento.

OperaçãoFinalidade
GET /tipo-procedimento/listaListar os procedimentos e seus identificadores (idTipoProcedimento)
GET /tipo-procedimento/{id}Obter o detalhe, com observação e orientação
GET /tipo-procedimento/valores-vendaConsultar o valor de venda para um convênio, em uma data e hora

Listar​

curl -G "https://api.clinicanasnuvens.com.br/tipo-procedimento/lista" \
-H "Authorization: Basic <CREDENCIAIS_EM_BASE64>" \
-H "clinicaNasNuvens-cid: <TOKEN_DA_CLINICA>" \
--data-urlencode "tipo=EXCETO_EXAME" \
--data-urlencode "somenteAtivos=true"

O filtro tipo aceita TODOS, SOMENTE_EXAME e EXCETO_EXAME.

A listagem retorna as especialidades de cada procedimento. Os valores são obtidos em Consultar o valor.

Buscar pelo identificador​

Os campos observacao e orientacao são retornados apenas nesta operação.

Os identificadores em especialidades são os valores aceitos no idEspecialidade dos itens de procedimentos de um agendamento.

Consultar o valor​

O valor de um procedimento varia conforme o convênio, ao longo do tempo e em períodos de promoção. Por isso, os parâmetros dataBase e horaBase são obrigatórios.

curl -G "https://api.clinicanasnuvens.com.br/tipo-procedimento/valores-venda" \
-H "Authorization: Basic <CREDENCIAIS_EM_BASE64>" \
-H "clinicaNasNuvens-cid: <TOKEN_DA_CLINICA>" \
--data-urlencode "idTipoConvenio=12" \
--data-urlencode "idTipoProcedimento=88" \
--data-urlencode "dataBase=2026-10-05" \
--data-urlencode "horaBase=14:00:00"

O idTipoConvenio é obtido em Planos de convênios.

Parâmetros
ParâmetroObrigatório
idTipoConvenioSim
idTipoProcedimentoSim
dataBaseSim
horaBaseSim
idEspecialidadeNão
Promoções por faixa horária

Promoções podem valer por faixa horária, portanto o mesmo procedimento pode ter valores diferentes no mesmo dia. Informe a data e a hora do atendimento, com segundos (14:00:00).

A resposta é um objeto único, sem paginação.

Promoções​

Sem promoção vigente, idPromocao, valorPromocao e tipoValorPromocao são retornados como nulos.

Quando há promoção vigente, os valores retornados não incluem o desconto. O tipoValorPromocao indica se o valorPromocao está em reais ou em percentual. O idPromocao retornado é informado no item de procedimentos na criação do agendamento.

Veja na Referência​

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