Manual de integração QUALISS

1. Objetivo

Este documento tem por objetivo detalhar as operações que serão disponibilizadas através de API’s RESTFul, assim como as informações requeridas como parâmetros de entrada para cada operação e os retornos esperados. Tal instrumento visa facilitar o processo de integração entre os sistemas das entidades participantes do programa QUALISS e o sistema QUALISS da ANS. A versão atual deste documento contempla apenas as operações relacionadas a manutenção de dados de acreditação de prestadores de serviço de saúde.

Esta documentação tem como público-alvo, as equipes técnicas em TI: Gerentes de Projeto de TI, Analistas e desenvolvedores de sistemas.

2. Introdução

O Programa de Qualificação dos Prestadores de Serviços de Saúde – QUALISS - visa estimular a qualificação dos prestadores de serviços na saúde suplementar e aumentar a disponibilidade de informações. O intuito é ampliar o poder de avaliação e escolha de prestadores de serviços por parte das operadoras e dos beneficiários de planos de saúde.

O QUALISS contemplará os seguintes tipos de prestadores de serviço de saúde: prestadores de serviços hospitalares, Serviços Auxiliares de Diagnóstico e Terapia - SADT, clínicas ambulatoriais, profissionais de saúde ou pessoas jurídicas que prestam serviços em consultórios isolados e prestadores de serviços de hospital-dia isolado

Maiores detalhes sobre o programa podem ser obtidos através da Resolução Normativa nº 405/2016.

3. Entidades participantes

O quadro abaixo representa os tipos de entidades participantes do programa QUALISS, conforme o tipo de atributo de qualidade ao qual terá responsabilidade de envio.

4. Descrição do processo

A integração por serviços será realizada a partir de Web Service disponível no barramento de serviços da ANS. A partir do consumo dos serviços disponibilizados pelo sistema QUALISS será possível gerir as informações relacionadas à atributos de qualidade de prestadores de serviço de saúde.

Para o consumo dos serviços disponibilizados pelo sistema QUALISS devem ser observados os seguintes itens:

•  Os webservices ofertados pela ANS utilizarão o padrão de autenticação Oauth2. Detalhes em https://oauth.net/2/;
•  O código do token de acesso aos serviços poderá ser obtido através da API de solicitação de token descrita na documentação sobre o OAUTH e deverá ser novamente solicitado a cada vez que o token expirar;
•  Os webservices foram construídos seguindo o padrão RESTful;
•  As requisições e os retornos dos serviços seguirão a notação JSON;
•  A comunicação com os serviços se dará através do protocolo HTTPS.

5. Serviços

Abaixo estão detalhados os serviços que tratam do fluxo de negócio necessários para manter todos os dados relacionados ao QUALISS.

5.1. Gestão do Atributo de Qualidade Acreditação

Acreditação em saúde é um processo periódico e voluntário de reconhecimento por uma organização independente, especializada em normas técnicas do setor, de que o estabelecimento atende a requisitos previamente definidos e demonstra competência para realizar suas atividades com segurança, dentro de padrões de excelência de atendimento ao usuário.

A seguir serão detalhados os serviços que serão disponibilizados às entidades acreditadoras para que possam gerir os dados dos prestadores de serviço de saúde acreditados pelos seus respectivos programas de acreditação.

5.1.1. Incluir Acreditação

•  Objetivo: Inserir na base do programa QUALISS da ANS os dados referentes à um determinado prestador de serviço que foi acreditado pela entidade acreditadora de modo a permitir que estes dados sejam divulgados no portal da ANS.
• Endpoint:
• Homologação
  URL: https://wwwhm.ans.gov.br/qualiss-services/acreditadoras/[CNPJ ACREDITADORA]/prestadores
• Produção
  URL: https://www.ans.gov.br/qualiss-services/acreditadoras/[CNPJ ACREDITADORA]/prestadores
•  Método: POST

• Parâmetros:

• Exemplo de Requisição

{
  "cnpj": "01234567891234",
  "cnes": "1234567",
  "dataAcreditacao": "2017-03-01",
  "dataExpiracao": "2019-03-01",
  "nomeAcreditacao": "TESTE"
}

• Exemplo de Retorno em Caso de Sucesso
  HTTP/1.1 201 OK

• Exemplo de Retorno em Caso de Erro Ocorrido nos Dados Enviados
  HTTP/1.1 400 - Requisição inválida

{ 
   "code": "id do código do erro ocorrido",
   "error": " descrição da mensagem do erro ocorrido"
}

5.1.2. Alterar Acreditação

• Objetivo: Realizar a atualização dos dados de uma acreditação de um determinado prestador de serviço na base do programa QUALISS da ANS visando corrigir informações que tenham sido enviadas de forma equivocada. Os dados enviados serão imediatamente atualizados no portal da ANS.
  • Endpoint:
    • Homologação
      URL: https://wwwhm.ans.gov.br/qualiss-services/acreditadoras/[CNPJ ACREDITADORA]/prestadores
    • Produção
      URL: https://www.ans.gov.br/qualiss-services/acreditadoras/[CNPJ ACREDITADORA]/prestadores

•  Método: PUT

OBS : Seguindo boas práticas de segurança, o WAF permite apenas requisições com método POST ou GET, uma vez que o método PUT pode representar riscos como:

• Upload arbitrário de arquivos; 

• Execução de código malicioso; 

• Substituição de páginas e arquivos legítimos do site; 

• Aumento da superfície de ataque.
  
  

Dito isso, caso seja de interesse, podemos liberar a requisição PUT nesta política para que o tráfego não seja bloqueado. No entanto, recomendamos a adoção de algumas boas práticas para minimizar riscos:

• Autenticação forte: somente usuários ou automações autorizados devem ter permissão para usar o método PUT. 

• Restrição de diretórios: permitir o uso do PUT apenas em pastas específicas, nunca na raiz do site. 

• Uso de APIs seguras: se o objetivo é apenas o upload de arquivos legítimos, considere usar POST com uma API bem definida em vez de PUT direto no servidor.

•  Parâmetros:

• Exemplo de Requisição

{
  "cnpj": "01234567891234",
  "cnes": "1234567",
  "dataAcreditacao": "2017-03-01",
  "dataExpiracao": "2019-03-01",
 "nomeAcreditacao": "TESTE"
}

• Exemplo de Retorno em Caso de Sucesso
  HTTP/1.1 200 OK

• Exemplo de Retorno em Caso de Erro Ocorrido nos Dados Enviados
  HTTP/1.1 400 - Requisição inválida

{
   "code": "id do código do erro ocorrido",
   "error": " descrição da mensagem do erro ocorrido"
}

5.1.3. Excluir Acreditação

• Objetivo: Excluir dados de uma acreditação de um determinado prestador de serviço na base do programa QUALISS da ANS que tenha sido enviada de forma equivocada. A solicitação efetivada será imediatamente refletida no portal da ANS.

• Endpoint:
  • Homologação
    URL: https://wwwhm.ans.gov.br/qualiss-services/acreditadoras/[CNPJ ACREDITADORA]/prestadores

• Produção
  URL: https://www.ans.gov.br/qualiss-services/acreditadoras/[CNPJ ACREDITADORA]/prestadores

• Método: DELETE

• Parâmetros:

• Exemplo de Requisição

{
  "cnpj": "01234567891234",
  "cnes": "1234567",
  "nomeAcreditacao": "TESTE"
}

• Exemplo de Retorno em Caso de Sucesso
  HTTP/1.1 204 OK

• Exemplo de Retorno em Caso de Erro Ocorrido nos Dados Enviados
  HTTP/1.1 400 - Requisição inválida

{
   "code": "id do código do erro ocorrido",
   "error": " descrição da mensagem do erro ocorrido"
}

5.1.4. Consultar Acreditação

• Objetivo: Consultar a lista de prestadores de serviço que constam na base da ANS e que possuem acreditações vigentes que foram fornecidas pela entidade acreditadora. Esta funcionalidade visa possibilitar que a entidade acreditadora tenha o conhecimento dos prestadores de serviço que ainda não foram enviados à ANS. No retorno da requisição constará a lista de prestadores de serviço que atendem aos parâmetros fornecidos.
• Endpoint:
  • Homologação
    URL: https://wwwhm.ans.gov.br/qualiss-services/acreditadoras/[CNPJACREDITADORA]/prestadores

• Produção
  URL: https://www.ans.gov.br/qualiss-services/acreditadoras/[CNPJACREDITADORA]/prestadores

• Método: GET

• Parâmetros:

• Exemplo de Requisição
  https://wwwhm.ans.gov.br/qualiss-services/acreditadoras/[CNPJ_ACREDITADORA]/prestadores?cnpj=01234567891234&cnes=12345678&nomeAcreditacao=TESTE

• Exemplo de Retorno em Caso de Sucesso
  HTTP/1.1 200 OK

[{
"cnpj":"01234567891234",
"cnes":"1234567",
"acreditacoes":[{
                           "dataAcreditacao":"2017-01-05",
                           "dataExpiracao":"2019-01-05",
                           “programa”: {"nomeAcreditacao":"TESTE"}
                         }]
}]

• Exemplo de Retorno em Caso de Nenhum Registro Retornado
  HTTP/1.1 404 Not Found

5.1.5. Consultar Programas de Acreditação

• Objetivo: Consultar a lista de programas de acreditação oferecidos pela entidade acreditadora que estão habilitados perante a ANS.
• Endpoint:

• Homologação
  URL: https://wwwhm.ans.gov.br/qualiss-services/acreditadoras/[CNPJ ACREDITADORA]/programas
• Produção
  URL: https://www.ans.gov.br/qualiss-services/acreditadoras/[CNPJ ACREDITADORA]/programas

• Método: GET

• Parâmetros:
  Não há

• Exemplo de Retorno em Caso de Sucesso
  HTTP/1.1 200 OK

 [
        {“nomeAcreditacao”:”Programa 1”},
        {“nomeAcreditacao”:”Programa 2”}
]

• Exemplo de Retorno em Caso de Nenhum Registro Retornado
  HTTP/1.1 404 Not Found

5.1.6. Lista de códigos de erros na recepção de dados de acreditação

As requisições efetuadas às operações na API de Acreditação também estão sujeitas às seguintes ocorrências de erro: