8.1 - Lista consultas
Só são suportadas integrações no padrão REST.
Introdução
Utilize este método para visualizar todas as consultas agendadas. Acesse informações detalhadas de cada consulta, como data, hora, local, profissional e motivo da consulta.
Método "listaConsultas"
Este método é obrigatório;
Atente-se aos critérios de preenchimento;
Atente-se as mensagens de retorno para cada HTTPS Status Code;
Endpoint
Endpoint | Método | Header Content-Type | Descrição |
---|---|---|---|
http://exemplo.com/ listaConsultas Atenção O endpoint obrigatoriamente deve terminar com “/listaConsultas”. | 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 |
---|---|---|---|
integracao | M | Objeto |
|
chaveUnica | M | String | IMPORTANTE: A chave única repassada é a do usuário logado. Caso deseje mostrar consultas de outros beneficiários além do usuário logado, sua API deverá ser capaz de iterar os demais pacientes, e devolver todas as consultas de todos os pacientes que desejam ser exibidos. |
dataInicial | M | String | Data inicial do periodo desejado. |
dataFinal | M | String | Data final do periodo. desejado. |
Exemplo request
url:
https://www.operadoradesaude.com.br/mobilesaude/minhasConsultas/listaConsultas
Body:
{
"integracao": {
"xpto": "voluptatibus",
"xyz": "quibusdam",
"abcdef": 9288701
},
"chaveUnica": "string",
"dataInicial": "YYYY/MM/DD",
"dataFinal": "YYYY/MM/DD"
}
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 |
---|---|---|---|---|
agendas | M | Array de objetos do tipo agenda | Retornar um array de objetos “agenda“ |
|
{
"agendas": [Array-objetos]
}
Objeto agenda
Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
---|---|---|---|---|
idAgenda | M | String | id da agenda |
|
numeroProtocolo | OP | String | Numero do protocolo do agendamento |
|
dataHora | C | String | Data e hora da consulta | Obrigatório para os tipos de agendamento: Formato: YYYY-MM-DD hh:mm:ss |
dataTermino | OP | String | Data de termino da consulta | Deve conter dia e hora. Formato: YYYY-MM-DD hh:mm:ss |
tipoAgenda | M | String | Informe o tipo da agenda | Conteúdo válido: |
profissional | C | Objeto | Dados do profissional | Obrigatório para os tipos de agendamento: |
especialidade | C | Objeto | Dados da especialidade
| Obrigatório para os tipos de agendamento: |
localAtendimento | C | Objeto | Objeto com dados do local de atendimento | Obrigatório para os tipos de agendamento: Objeto localAtendimento |
status | M | Objeto | Objeto com dados sobre o status da consulta | Objeto status |
paciente | M | Objeto | Objeto com dados do paciente | Objeto paciente. IMPORTANTE: A chave única repassada é a do usuário logado. Caso deseje mostrar consultas de outros beneficiários além do usuário logado, sua API deverá ser capaz de iterar os demais pacientes, e devolver todas as consultas de todos os pacientes que desejam ser exibidos. |
configuracoes | M | Objeto | Objeto com dados da configurações da funcionalidade | Objeto configurações
|
meeting | OP | Objeto | Objeto com dados da meeting | Agendas do tipo teleconsulta |
{
"agendas": [
{
"idAgenda": "string",
"numeroProtocolo": "String"
"dataHora": "YYYY-MM-DD hh:mm:ss",
"dataTermino": "YYYY-MM-DD hh:mm:ss"
"tipoAgenda": "string",
"profissional": { Objeto },
"especialidade": { Objeto },
"localAtendimento": { Objeto },
"status": { Objeto },
"paciente": { Objeto },
"configuracoes": { Objeto },
"meeting": { Objeto }
}
]
}
Objeto profissional
Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
---|---|---|---|---|
descricao | M | String | Texto de descrição do profissional | Texto livre |
id | M | String | id do profissional |
|
Objeto especialidade
Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
---|---|---|---|---|
descricao | M | String | Texto de descrição da especialidade | Texto livre |
id | M | String | id da especialidade |
|
servico | OP | String | Objeto do tipo serviço | Objeto Opcional. Envie quando desejar exibir um detalhamento de serviços vinculado à especialidade. Se a especialidade não possuir nenhum serviço vinculado, não envie o objeto. |
Objeto servico
Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
---|---|---|---|---|
idServico | M | String | id do serviço |
|
procedimento | M | String | id do procedimento |
|
descricao | M | String | Descrição do serviço | Texto livre |
exigeAutorizacao | M | Boolean | Booleano de controle se a especialidade exige autorização prévia |
|
Objeto localatendimento
Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
---|---|---|---|---|
descricao | M | String | Texto de descrição do local de atendimento | Texto livre |
id | M | String | id do local de atendimento |
|
endereco | M | Objeto | Objeto com dados do endereço | Objeto endereço |
Objeto endereco
Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
---|---|---|---|---|
endereco | M | String | Texto de endereço do local de atendimento | Texto livre |
numero | M | String | Número do local de atendimento | Texto livre |
complemento | M | String | Complemento do local de atendimento | Texto livre |
bairro | M | String | Bairro do local de atendimento | Texto livre |
cidade | M | String | Cidade do local de atendimento | Texto livre |
estado | M | String | Estado do local de atendimento | Texto livre |
latitude | OP | String | Latitude referente ao local de atendimento |
|
longitude | OP | String | Longitude referente ao local de atendimento |
|
Objeto status
Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
---|---|---|---|---|
descricao | M | String | Descrição da situação da consulta | Texto livre |
id | M | String | id do status |
|
cor | M | String | Cor referente ao status | Hexadecimal. com o #. da cor que deseja que seja usada para representar o status da consulta. Ex.: |
encerrado | OP | Boolean | Consulta cancelado pelo paciente ou saber se esse atendimento está encerrado. | Indicação de uso: quando uma consulta está cancelada ou já foi finalizada, informe esse atributo como TRUE. |
Objeto paciente
Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
---|---|---|---|---|
chaveUnica | M | String | Chave de identificação do paciente |
|
numeroContrato | M | String | Número que identifica a qual contrato essa consulta está vinculada |
|
nome | M | String | Nome do paciente |
|
idTipoUsuario | M | String | Informe o tipo de usuário | Conteúdo válido: |
Objeto configuracoes
Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
---|---|---|---|---|
agendaConfirmada | OP | Boolean | Define se a consulta tem agenda confirmada |
|
permiteCancelar | M | Boolean | Define se permite cancelar a consulta |
|
solicitaConfirmacao | OP | Boolean | Define se permite solicitar confirmação de presença |
|
Objeto meeting
Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
---|---|---|---|---|
idMeeting | M | string | idMeeting fornecido pela Mobile Saúde no ato do Agendamento |
|
Retorno da API - Sucesso
Retorno da API - Falha
Mobile Saúde - Mosia Omnichannel