8.2 - Detalhe da consulta

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

Introdução

Utilize este método retorna os detalhes da consulta que são utilizados no método listaConsultas, retorna informações detalhadas de uma consulta selecionada como data, hora, local, profissional e motivo da consulta.

Método "detalheConsulta"

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/detalheDebito /detalheConsulta	POST	application/json	Endpoint que retorna o detalhamento de um débito

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
idAgenda	M	String	Id de banco de dados da consulta no seu sistema interno. O aplicativo irá enviar a mesma informação que recebeu do atributo idAgenda do método listaConsulta
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

Exemplo request

url: 
https://www.operadoradesaude.com.br/mobilesaude/minhasConsultas/detalheConsulta

Body:
{              
	"integracao": {
    	"xpto": "voluptatibus",
        "xyz": "quibusdam",
        "abcdef": 9288701
    },
    "chaveUnica" : "101012",
    "idAgenda": "579",
}

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
agenda	M	Objeto agenda	Retornar um objeto com dados da “agenda“

Objeto agenda

Atributo	Critério	Tipo	Descrição	Regra de preenchimento
idAgenda	M	String	id da agenda
dataHora	C	String	Data e hora da consulta	Obrigatório para os tipos de agendamento: 1 = Presencial 2 = Teleconsulta Deve conter dia e hora da consulta. Formato: YYYY-MM-DD hh:mm:ss
tipoAgenda	M	String	Informe o tipo da agenda	Conteúdo válido: 1 = Presencial 2 = Teleconsulta 3 = Pronto atendimento. 4 = Cabine de atendimento
profissional	M	Objeto	Dados do profissional	Obrigatório para os tipos de agendamento: 1 = Presencial 2 = Teleconsulta Objeto profissional
especialidade	M	Objeto	Dados da especialidades	Obrigatório para os tipos de agendamento: 1 = Presencial 2 = Teleconsulta Objeto especialidade
localAtendimento	M	Objeto	Objeto com dados do local de atendimento	Obrigatório para os tipos de agendamento: 1 = Presencial 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
configuracoes	M	Objeto	Objeto com dados da configurações da funcionalidade	Objeto configurações
dataTermino	OP	String	Data de termino da consulta	Deve conter dia e hora. Formato: YYYY-MM-DD hh:mm:ss
anexos	OP	Array <anexo>	Array de anexos
meeting	OP	String	Objeto com dados da meeting	Agendas do tipo teleconsulta

   {
    "idAgenda": "String",
    "dataHora": "YYYY-MM-DD hh:mm:ss",
    "tipoAgenda": "String",
    "profissional": { Objeto },
    "especialidade": { Objeto },
    "localAtendimento": { Objeto },
    "status": { Objeto },
    "paciente": { Objeto },
    "configuracoes": { Objeto },
    "anexos": [{ 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
urlFoto	M	String	URL da foto do profissional responsável pelo atendimento
informacaoConselho	M	String	Texto de informação do conselho do profissional	Texto Livre. Ex: "CRM ES 123123"
contatos	OP	Array	Array de objeto de contatos do profissional	Array de objetos contatos

{
    "profissional": {
        "descricao": "String",
        "id": "String",
        "urlFoto": "String",
        "informacaoConcelho": "String",
        "contatos": [ Array de objeto ]
}

Objeto contato

Atributo	Critério	Tipo	Descrição	Regra de preenchimento
tipo	M	String	Tipo de contato	Conteúdo válido: 1 = Telefone 2 = Email
id	M	String	id do contato
titulo	M	String	Titulo do contato	EX: “Telefone"
valor	M	String	Valor do contato	EX:”28 999999999"

{
    "profissional": {
        "contatos": [
            {
                "tipo": "String",
                "titulo": "String",
                "valor": "String"
            },
            {
                "tipo": "String",
                "titulo": "String",
                "valor": "String"
            }
        ]
}

Objeto especialidade

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

servico

OP

String

Objeto do tipo serviço

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

{
  "especialidade": {
        "descricao": "String",
        "id": "String",
        "servico": {
          "idServico" : "String",
          "procedimento": "String",
          "descricao" : "String",
          "exigeAutorizacao": Boolean,
        }
    }
}

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	String	Objeto com dados do endereço	Objeto endereço
contatos	OP	Array	Array de objetos do tipo contato	Array de objeto contato

{
    "localAtendimento": {
            "descricao": "String",
            "id": "String",
            "endereco": { Objeto },
            "contatos": [ Array-objetos ]
        }
}

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

{
    "localAtendimento": {
            "endereco": {
                "endereco": "String",
                "numero": "String",
                "complemento": "String,
                "bairro": "String",
                "cidade": "String",
                "estado": "String",
                "latitude": "String",
                "longitude": String"
            },
            "contatos": [
                {
                    "tipo": "String",
                    "titulo": "String",
                    "valor": "String"
                }
            ]
        }
 }

Objeto status

Atributo	Critério	Tipo	Descrição	Regra de preenchimento
descricao	M	String	Descrição do status	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.: `#FF0000`
motivo	OP	String	Descrição do motivo	Deve ser preenchido quando o status da consulta for cancelado
~~encerrado~~	OP	~~Boolean~~	~~Consulta cancelado pelo paciente ou saber se esse atendimento está encerrado.~~	RESERVADO. PARAMETRO AINDA NÃO DISPONÍVEL PARA USO. RECOMENDAMOS NÃO ENVIAR AGENDAMENTOS CANCELADOS.

{
  "status": {
        "descricao": "String",
        "id": "String",
        "cor": "String",
        "motivo": "String"
    }
}

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: T = Titular D = Dependente A = Agregado Apenas maiúsculos
contatos	M	Array	Array de objetos do tipo contato abaixo

{
    "paciente": {
          "chaveUnica": "String",
          "numeroContrato": "String",
          "nome": "String",
          "idTipoUsuario": "String",
          "contatos": [ Array-objetos ]
      }
}

Objeto contato

Atributo	Critério	Tipo	Descrição	Regra de preenchimento
titulo	M	String	Titulo do contato	EX: “Telefone"
valor	M	String	Valor do contato	EX:”28 999999999"

{
    "paciente": {
          "contatos": [
            {
                "titulo": "String",
                "valor": "String"
            }
        ]
      }
}

Objeto configuracoes

Atributo	Critério	Tipo	Descrição
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

{
    "configuracoes": {
        "agendaConfirmada": Boolean,
        "permiteCancelar": Boolean,
        "solicitaConfirmacao": Boolean
    }
}

Objeto Anexo

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

descricao

M

String

Descrição do anexo

Texto livre

idAnexo

M

String

ID do registro que identifica esse anexo.

Texto livre

tipoAnexo

M

String

Tipo de arquivo

Extensão de arquivo:

pdf
jpg
…

{
      "anexos": [
          {
              "descricao": "String",
              "idAnexo": "String",
              "tipoAnexo": "String"
          },
          {
              "descricao": "String",
              "idAnexo": "String",
              "tipoAnexo": "String"
          }
      ]
}

Objeto meeting

Atributo	Critério	Tipo	Descrição	Regra de preenchimento
idMeeting	M	String	idMeeting fornecido pela Mobile Saúde no ato do Agendamento

{
    "meeting": {
        "idMeeting": "String",
    }
}

Retorno da API - Sucesso

   {
    "idAgenda": "121212",
    "dataHora": "2020-08-05 11:40:00",
    "tipoAgenda": "1",
    "profissional": {
        "descricao": "dr xpto",
        "id": "10294747",
        "urlFoto": "https://www.urlFot.com.br/foto.png",
        "informacaoConcelho": "CRM ES: 121112",
        "contatos": [
            {
                "tipo": "1",
                "titulo": "Telefone ",
                "valor": "27 99292-9292"
            },
            {
                "tipo": "2",
                "titulo": "E-mail ",
                "valor": "email@email.com.br"
            }
        ]
    },
    "especialidade": {
        "descricao": "clinica geral",
        "id": "01928",
        "servico": {
          "idServico" : "001",
          "procedimento": "3321",
          "descricao" : "String",
          "exigeAutorizacao": true,
        }
    },
    "localAtendimento": {
        "descricao": "CIAS",
        "id": "19919",
        "endereco": {
            "endereco": "rua 1",
            "numero": "1",
            "complemento": "apto 1",
            "bairro": "bairro 1",
            "cidade": "vitoria",
            "estado": "ES",
            "latitude": "121212.1212",
            "longitude": "12232323.223"
        },
        "contatos": [
            {
                "tipo": "1",
                "titulo": "Telefone ",
                "valor": "27 99292-9292"
            },
            {
                "tipo": "2",
                "titulo": "E-mail ",
                "valor": "email@email.com.br"
            }
        ]
    },
    "status": {
        "descricao": "Agendado",
        "id": "A",
        "cor": "#ua71ja9"
    },
    "paciente": {
        "chaveUnica": "182737464",
        "numeroContrato": "1212",
        "nome": "nome do paciente",
        "idTipoUsuario": "T",
        "contatos": [
            {
                "titulo": "Nome",
                "valor": "Vinicius Fiorio"
            },
            {
                "titulo": "Telefone",
                "valor": "27999999999"
            },
            {
                "titulo": "E-mail ",
                "valor": "vinicius@email.com.br"
            }
        ]
    },
    "anexos": [
          {
              "descricao": "String",
              "idAnexo": "String",
              "tipoAnexo": "String"
          },
          {
              "descricao": "String",
              "idAnexo": "String",
              "tipoAnexo": "String"
          }
    ],
    "configuracoes": {
        "agendaConfirmada": true,
        "permiteCancelar": true
    }
}

Retorno da API - Falha

Atente-se as mensagens de retorno para cada HTTPS Status Code;
Siga as instruções de Descrição dos objetos e atributos de retorno - falha;