8.3 - Lista especialidades

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

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

Introdução

Utilize este método para visualizar as especialidades médicas que estarão disponíveis para o beneficiário, este método deve retornar APENAS as especialidades disponíveis para o beneficiário selecionado.

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;

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/listaEspecialidades	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	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 usuário
paciente	M	Objeto	Objeto paciente selecionado para realizar um pedido de consulta
idLocal	OP	String	Id do local da consulta
tipoAgenda	M	String	Informe o tipo da agenda	Conteúdo válido: 1 = Presencial 2 = Teleconsulta

Exemplo request

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

Body:
{
  "chaveUnica":"String",
  "integracao":{
    "xpto":"voluptatibus",
    "xyz":"quibusdam",
    "abcdef":9288701
  },
  "idLocal":"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
especialidades	M	Array	Array de objetos do tipo especialidade

 {
  "especialidades" : [ Array-objets ]
}

Objeto especialidade

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

Atributo	Critério	Tipo	Descrição	Regra de preenchimento
id	M	String	id da especialidade
descricao	M	String	Descrição da especialidade	Texto livre EX:”Psiquiatria"
codigoCbos	M	String
exigeAutorizacao	M	Boolean	Booleano de controle se a especialidade exige autorização prévia
alerta	OP	String	Mensagem de alerta caso a especialidade tenha	Texto livre
tipoServico	OP	Array	Array de objetos do tipo serviço	Objeto Opcional. Envie quando desejar exibir um detalhamento de serviços vinculados à especialidade, para que seja exibido ao usuário. Se a especialidade não possuir nenhum serviço vinculado, não envie o objeto.

Objeto tipoServiço

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

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

 {
  "especialidades" : [
    {
      "id" : "String",
      "descricao" : "String",
      "codigoCbos" : "String",
      "exigeAutorizacao" : Boolean,
      "alerta" : "String",
      "tipoServico" : [
        {
          "idServico" : "String",
          "procedimento": "String",
          "descricao" : "String",
          "exigeAutorizacao": Boolean,
        }
      ]
    }  
  ]
}

Retorno da API - Sucesso

 {
  "especialidades" : [
    {
      "id" : "121212",
      "descricao" : "Psiquiatria",
      "codigoCbos" : "101919",
      "exigeAutorizacao" : false,
      "alerta" : "para esta especialidade é necessário apresentar laudo de psiquiatria",
      "tipoServico" : [
        {
          "idServico" : "001",
          "procedimento": "003",
          "descricao" : "Psiquiatria",
          "exigeAutorizacao": Boolean,
        }
      ]
    }  
  ]
}

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;