Consultar especialidades

Especialidades são as áreas de atuação da clínica, como clínica geral, cardiologia ou ortopedia. Elas aparecem em dois pontos do fluxo: vinculadas aos profissionais de saúde e vinculadas aos procedimentos de um agendamento.

O recurso disponibiliza duas operações de consulta:

Operação	Finalidade
GET /especialidade/lista	Listar as especialidades e seus identificadores (idEspecialidade)
GET /especialidade/{id}	Obter os dados a partir de um identificador já armazenado

Listar

curl -G "https://api.clinicanasnuvens.com.br/especialidade/lista" \
  -H "Authorization: Basic <CREDENCIAIS_EM_BASE64>" \
  -H "clinicaNasNuvens-cid: <TOKEN_DA_CLINICA>" \
  --data-urlencode "nomeContem=Cardio" \
  --data-urlencode "somenteAtendidasNaClinica=true"

Filtros de status. A listagem de especialidades utiliza dois filtros próprios no lugar do somenteAtivos, que não se aplica a este recurso:

Filtro	Restringe a
somenteAtendidasNaClinica	Especialidades atendidas pela clínica
somenteAtivasNaWeb	Especialidades disponíveis para agendamento pela web externa

Buscar pelo identificador

A resposta contém o id e o nome. A situação da especialidade é consultada na listagem, com os filtros acima.

Escopo do cadastro

Tipos de consulta, locais, convênios e procedimentos pertencem a uma clínica. As especialidades pertencem à empresa e são compartilhadas por todas as filiais do grupo.

Assim, o id de uma especialidade obtido com o token de uma filial é válido nas demais. Em integrações com várias clínicas do mesmo grupo, a lista de especialidades pode ser armazenada uma única vez.

Onde o identificador é usado

Campo	Onde
idEspecialidade	Nos itens de procedimentos ao criar um agendamento
idEspecialidade	Opcional na consulta de valores de um procedimento, onde pode alterar o valor
especialidades	No cadastro de aluno e de supervisor da clínica escola

Veja na Referência

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