Agenda: visão geral

A Agenda reúne dois tipos de operação: as que gerenciam o agendamento (criar, alterar, alterar status e remarcar) e as consultas aos cadastros de apoio, que fornecem os identificadores utilizados na criação do agendamento.

O que um agendamento exige

Um agendamento reúne seis informações obrigatórias, cada uma obtida em um recurso diferente:

                          POST /agenda/novo
                                 │
   ┌──────────────┬──────────────┼──────────────┬──────────────┐
   │              │              │              │              │
idPaciente   idPacienteConvenio  │         idLocalAgenda   data + horaInicio
   │              │              │              │            + horaFim
   │              │        idTipoConsulta       │              │
   ▼              ▼              ▼              ▼              ▼
 bloco        bloco          cadastro        cadastro     disponibilidade
Paciente     Paciente       /tipo-consulta  /local-agenda  do executor
             (convênios      /lista          /lista
              do paciente)

O campo idPessoaExecutor é opcional. Quando informado, o agendamento é validado contra a grade de horários do profissional; quando omitido, essa validação não é realizada.

O fluxo completo

 1. CONSULTAR OS EXECUTORES
    GET /executor-agenda/lista
         │  cada executor tem dois identificadores: "id" e "idpessoa"
         ▼
 2. CONSULTAR OS CADASTROS
    GET /local-agenda/lista        →  idLocalAgenda
    GET /tipo-consulta/lista       →  idTipoConsulta
    GET /tipo-procedimento/lista   →  idTipoProcedimento
    GET /agenda/origem             →  idOrigemPaciente
    GET /agenda-rotulo/lista       →  idRotulo
         │  somenteAtivos=true retorna apenas cadastros ativos
         ▼
 3. CONSULTAR A DISPONIBILIDADE
    GET /executor-agenda/disponibilidade
         │  intervalo máximo de 15 dias
         ▼
 4. CRIAR
    POST /agenda/novo
         │  retorna o agendamento com o "id"
         ▼
 5. ACOMPANHAR                        6. ALTERAR
    GET /agenda/lista                    PUT /agenda/alteracao-status
    GET /agenda/{id}                     PUT /agenda/{id}
    GET /agenda/profissional             POST /agenda/{id}/remarcar

Os cadastros de apoio e os campos que alimentam

Oito cadastros fornecem os identificadores do agendamento:

Cadastro	Alimenta	Guia
/especialidade/lista	idEspecialidade	Especialidades
/executor-agenda/lista	idPessoaExecutor, codExecutorAgenda	Executores de agenda
/local-agenda/lista	idLocalAgenda	Locais de agenda
/tipo-consulta/lista	idTipoConsulta	Tipos de consulta
/tipo-convenio/lista	Consulta de valores	Convênios
/tipo-procedimento/lista	idTipoProcedimento	Procedimentos
/agenda-rotulo/lista	idRotulo	Aceita os parâmetros de paginação
/agenda/origem	idOrigemPaciente	Lista própria do agendamento, distinta das origens de cadastro

Obrigatoriedade conforme a configuração da clínica

Campos como idPessoaExecutor, procedimentos e idEspecialidade podem ser obrigatórios ou opcionais, de acordo com a configuração de cada clínica. Por isso, o mesmo corpo da requisição pode ser aceito em uma clínica e recusado em outra.

Próximo passo

Consulte Identificadores da agenda para ver a finalidade de cada identificador usado na criação do agendamento.