8.5 - Lista agendas dos profissionais

Só são suportadas integrações no padrão REST.

Introdução

Utilize este método para disponibilizar os profissionais por data e horário pela especialidade e local de atendimento selecionado.

Método "profissionaisAgenda"

Endpoint

Endpoint

Método

Header Content-Type

Descrição

Endpoint

Método

Header Content-Type

Descrição

http://exemplo.com/ / profissionaisAgenda

Atenção

Recomendamos que o endpoint termine com “/profissionaisAgenda.

POST

application/json

Endpoint para listar os registros de consultas relacionadas ao localizador (chaveUnica)

 

Parâmetros de entrada

Serão enviados no HEADER os headers estáticos definidos ao configurar a integração, combinado com os tokens retornados pela configuração de autorização da integração (caso seja vinculada) e os headers de segurança retornado no login do beneficiário.

Serão enviados no BODY os seguintes parâmetros:

Parâmetro

Obrigatório

Tipo

Descrição

Regra de preenchimento

Parâmetro

Obrigatório

Tipo

Descrição

Regra de preenchimento

idEspecialidade

M

String

Id da especialidade

 

idServico

OP

String

Id do tipo de serviço

 

idLocal

OP

String

Id do local da consulta

Obrigatório quando agendamento presencial

chaveUnica

M

String

Chave de identificação do usuário retornada no login

 

integracao

OP

Objeto

Nó integração retornado no login do usário

 

paciente

M

Objeto

Objeto paciente selecionado para realizar um pedido de consulta

 

data

OP

Data no formato: YYYY-MM-DD

Quando não enviada deve retornar dados das agendas dos profissionais e próximas datas disponíveis para consultas. Quando preenchida deve retornar agendas dos profissionais somente do dia selecionado

 

idProfissional

OP

String

Quando enviado deve retornar dados do detalhe da agenda do profissional.

O array de profissionais deve conter somente um profissional

 

tipoAgenda

M

String

Informe o tipo da agenda

Conteúdo válido:
1 = Presencial
2 = Teleconsulta
3 = Pronto atendimento

 

Objeto paciente

Parâmetro

Obrigatório

Tipo

Descrição

Parâmetro

Obrigatório

Tipo

Descrição

chaveUnica

M

String

Chave de identificação do usuário retornada no login

integracao

OP

Objeto

Nó integração retornado no login do usuário

numeroContrato

M

String

Código do contrato do paciente

Exemplo request

url: https://www.operadoradesaude.com.br/mobilesaude/minhasConsultas/profissionaisAgenda Body: { "chaveUnica":"101012", "integracao":{ "xpto":"voluptatibus", "xyz":"quibusdam", "abcdef":9288701 }, "paciente":{ "chaveUnica":"101012", "numeroContrato":"616161", "integracao":{ "xpto":"voluptatibus", "xyz":"quibusdam", "abcdef":9288701 } }, "tipoAgenda":"1", "idEspecialidade":"9191919", "idServico":"3321", "idLocal":"123", "data":"2022-02-01", "idProfissional":"123", "data":"2022-03-01" }

 

Descrição dos objetos e atributos de retorno - Sucesso

Está indicado abaixo a estrutura de retorno do método. Esse método deve obedecer as regras indicadas no objeto principal e em seus desdobramentos.

 Objeto principal

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

profissionaisAgendas

M

Array

Array de objetos de dataProfissionais

 

{ "profissionaisAgendas": [ Array-Objetos ] }

 

Objeto dataProfissionais

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

data

M

String

Data da agenda

Deve conter o seguinte formato

Formato: YYYY-MM-DD

profissionais

M

Array

Array de objeto profissional

 

{ "profissionaisAgendas": [ { "data": "YYYY-MM-DD", "profissionais": [ Array-objetos ] } ] }

 

Objeto profissional

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

nome

M

String

Nome do profissional

Texto livre

id

M

String

id do profissional

 

urlFoto

OP

String

URL da foto do profissional

 

conselho

M

String

Texto de informação do conselho do profissional

Texto Livre.

Ex: "CRM ES 123123"

localAtendimento

M

Objeto

Objeto com dados sobre o local de atendimento

Objeto do tipo localAtendimento

especialidade

M

Objeto

Objeto com dados da especialidade do profissional

Objeto do tipo especialidade

horarios

M

Array

Array de horarios disponíveis para atendimento

Array de objetos horario

 

Objeto localAtendimento

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

descricao

M

String

Texto de descrição do local de atendimento

Texto livre

Ex:”Em atendimento em Local XPTO"

id

M

String

id do local de atendimento

 

 

Objeto especialidade

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

descricao

M

String

Texto de descrição da especialidade

Texto livre

EX:”clinica geral"

id

M

String

id da especialidade

 

 

Objeto horario

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

idAgenda

M

String

id da agenda

 

dataHora

 

 

Data e hora disponível

Deve conter dia e hora.

Formato: YYYY-MM-DD hh:mm:ss

 

Retorno da API - Sucesso Caso o atributo data (que é opcional) no body da requisição for preenchido

 

Exemplo de retorno com "sucesso” - Caso o atributo idProfissional no body da requisição for preenchido e o atributo data for preenchido

 

Retorno da API - Falha