8.10 - Pronto atendimento - Lista especialidades

1 Método "listaConsultas"
2 Endpoint

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

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

Endpoint	Método	Header Content-Type	Descrição
exemplo.com/listaEspecialidadesPA	POST	application/json

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

Exemplo request

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

Body:
{
  "chaveUnica":"String",
  "integracao":{
    "xpto":"voluptatibus",
    "xyz":"quibusdam",
    "abcdef":9288701
  },
  "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

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

Retorno da API - Sucesso

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;