Os identificadores da agenda

Esta página descreve os identificadores utilizados no agendamento e a finalidade de cada um. O detalhamento de cada cadastro está nos guias dedicados.

Os dois identificadores do executor

GET /executor-agenda/lista retorna, para cada executor, dois campos numéricos:

{
  "id": 1,
  "idpessoa": 42,
  "nome": "Dr. Silva",
  "ativo": true,
  "tipoExecutor": "PROFISSIONAL"
}

Cada campo da API recebe um deles:

Campo do executor	Onde é utilizado
id	idExecutorAgenda na consulta de disponibilidade codExecutorAgenda na agenda do profissional idExecutor no filtro de convênios o {id} do caminho em /executor-agenda/{id}
idpessoa	idPessoaExecutor ao criar ou alterar um agendamento codigoPessoaExecutor no filtro de /agenda/lista

Em resumo: as consultas de agenda e de disponibilidade recebem o id; a criação e a alteração do agendamento recebem o idpessoa.

idPessoaExecutor na agenda e na lista de espera

O campo idPessoaExecutor existe em dois recursos e recebe um identificador diferente em cada um:

• Agenda (POST /agenda/novo, PUT /agenda/{id}): recebe o idpessoa do executor.
• Lista de espera (POST /lista-espera/novo, PUT /lista-espera/{id}): recebe o id do executor.

Convênio da clínica e convênio do paciente

São dois cadastros distintos, com um guia para cada um: Convênios e Convênios do paciente.

Na criação do agendamento, informe o idPacienteConvenio, que identifica o vínculo entre o paciente e o convênio. O idTipoConvenio identifica o convênio cadastrado na clínica.

  CADASTRO DA CLÍNICA                    VÍNCULO DO PACIENTE
  GET /tipo-convenio/lista               GET /convenio-paciente/lista?idPaciente=3
         │                                        │
         │  "Unimed", "Particular"                │  "o paciente 3 tem
         │  cadastrados na clínica                │   carteirinha na Unimed"
         ▼                                        ▼
    idTipoConvenio                          idPacienteConvenio
         │                                        │
         │                                        ▼
         │                              POST /agenda/novo
         ▼
  consulta de valores,
  filtro de procedimentos

Quando o paciente ainda não possui vínculo com o convênio, o vínculo é criado com POST /convenio-paciente/associar. O id retornado por essa operação é o idPacienteConvenio utilizado no agendamento. O passo a passo está em Gerenciar os convênios do paciente.

O convênio é representado por campos diferentes na criação e na consulta: o POST /agenda/novo recebe idPacienteConvenio, e o GET /agenda/{id} retorna idTipoConvenio.

Resumo

Finalidade	Campo	Valor informado
Agendar para um profissional	idPessoaExecutor	idpessoa do executor
Consultar a agenda de um profissional	codExecutorAgenda	id do executor
Consultar os horários disponíveis	idExecutorAgenda	id do executor
Filtrar agendamentos por profissional	codigoPessoaExecutor	idpessoa do executor
Informar o convênio do agendamento	idPacienteConvenio	id do vínculo entre paciente e convênio
Consultar o valor de um procedimento	idTipoConvenio	id do convênio da clínica

Próximo passo

Criar um agendamento descreve a montagem da requisição de criação.