8.4 - Lista locais de atendimento

1 Introdução
2 Método "locaisAtendimento"
3 Endpoint

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

Introdução

Utilize este método para retornar os locais de atendimentos disponíveis para a especialidade selecionada, retorna informações como endereço, telefone e localização.

Método "locaisAtendimento"

Este método é obrigatório;
Atente-se aos critérios de preenchimento;
Atente-se as mensagens de retorno para cada HTTPS Status Code;

IMPORTANTE

Os aplicativos e plataformas web refletem os dados conforme são consumidos diretamente da API. Caso haja necessidade de ordenar ou organizar as informações seguindo regras específicas da operadora, essas configurações devem ser realizadas diretamente na API responsável pelo fornecimento dos dados.

Endpoint

Endpoint	Método	Header Content-Type	Descrição

Endpoint	Método	Header Content-Type	Descrição
exemplo.com / listaLocaisAtendimento Atenção O endpoint obrigatoriamente deve terminar com “/ listaLocaisAtendimento.	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
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
idEspecialidade	M	String	Id da especialidade
idServico	OP	String	Id do tipo de serviço
tipoAgenda	M	String	Informe o tipo da agenda	Conteúdo válido: 1 = Presencial 2 = Teleconsulta

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/locaisAtendimento

Body:
{
  "chaveUnica":"String",
  "integracao":{
    "xpto":"voluptatibus",
    "xyz":"quibusdam",
    "abcdef":9288701
  },
  "idEspecialidade":"String",
  "idServico":"String"
  "tipoAgenda":"String",
  "paciente":{
    "chaveUnica":"String",
    "numeroContrato":"String",
    "integracao":{
      "xpto":"voluptatibus",
      "xyz":"quibusdam",
      "abcdef":9288701
    }
  }
}

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
locais	M	Array	Array de objetos de local
alertaPrincipal	OP	String	Texto de alerta geral dos locais de atendimento	Texto Livre

{
  "alertaPrincipal":"String",
  "locais":[ Array-objetos ]
}

Objeto locais

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
id	M	String	id do local de atendimento
endereco	M	Objeto	Objeto com dados do endereço	Objeto endereço
contatos	M	Array	Array de objetos do tipo contato	Array de objeto contato
alerta	OP	String	Texto de alerta do local de atendimento	Texto Livre
quantidadeMedicos	OP	String	Quantidades de médicos disponíveis para atendimento

{
  "locais":[
    {
      "descricao":"String",
      "id":"String",
      "alerta":"String",
      "endereco":{ objeto },
      "contatos": [ Array-objetos ],
      "quantidadeMedicos": "String"
}

Objeto endereco

Atributo	Critério	Tipo	Descrição	Regra de preenchimento

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

{
  "locais":[
    {
      "endereco":{
        "endereco":"String",
        "numero":"String",
        "complemento":"String",
        "bairro":"String",
        "cidade":"String",
        "estado":"String"
      }
}

Objeto contato

Atributo	Critério	Tipo	Descrição	Regra de preenchimento

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"

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

Retorno da API - Sucesso

{
  "alertaPrincipal":"Atenção: agendamentos só podem ser feitos com um máximo de 90 dias.",
  "locais":[
    {
      "descricao":"Hospital Sirio Libanes",
      "id":"19920",
      "alerta":"Atenção: Reforçamos medidas para o seu cuidado, como controle e monitoramento de temperatura das pessoas que circulam nas unidades, fluxos de atendimento, espaços físicos e equipes diferentes para pacientes com e sem sintomas de doenças respiratórias, horário mais espaçado entre as consultas (para evitar aglomerações).",
      "endereco":{
        "endereco":"Rua Dona Adma Jafet",
        "numero":"91",
        "complemento":"apt 414",
        "bairro":"Bela Vista",
        "cidade":"São Paulo",
        "estado":"SP"
      },
      "contatos":[
        {
          "tipo":"1",
          "titulo":"Telefone",
          "valor":"27 99292-9292"
        },
        {
          "tipo":"2",
          "titulo":"E-mail",
          "valor":"siriolibanes@hospital.com"
        }
      ]
    }
  ]
}

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;