Web services RN 395

Características do Requisito

Descrição

No "Foundation Saúde", foram implementados os web services para atender a RN 395 da ANS, de acordo com os "Schemas" definidos no sistema de "Gestão de Protocolos", pela Unimed do Brasil. Os novos serviços são integrados ao módulo "MR" (Marketing Receptivo", do "Gestão de Planos", embora os serviços de "Solicitar e Complementar Protocolo", também estejam integrados com o módulo "AT" (Atendimento ao Público). Este projeto contempla a integração entre os módulos "AT" e "MR".

Procedimento para Implantação

A implementação descrita no documento estará disponível a partir da atualização do pacote no cliente.

O pacote está disponível no portal (https://suporte.totvs.com/download).

Procedimento para Configuração

CONFIGURAÇÃO DE PARÂMETROS NO FOUNDATION SAÚDE

No arquivo "<JBoss>/server/<instancia>/conf/foundation-exchange.properties", foram criadas novas propriedades que devem ser configuradas para o funcionamento dos web services no "Foundation Saúde".

Endpoints

Propriedades referentes aos "Endpoints", dos serviços da Unimed do Brasil. Existe uma propriedade para cada web service, e no exemplo abaixo está configurado para o ambiente de homologação.

com.totvs.foundation.protocolmanager.message.v1_00_00.RequestProtocol.ENDPOINT = https://gpuhml.unimed.coop.br/gpu/v1_00_00/SolicitarProtocolo
com.totvs.foundation.protocolmanager.message.v1_00_00.AnswerProtocol.ENDPOINT = https://gpuhml.unimed.coop.br/gpu/v1_00_00/RespostaAtendimento
com.totvs.foundation.protocolmanager.message.v1_00_00.CancelRequest.ENDPOINT = https://gpuhml.unimed.coop.br/gpu/v1_00_00/Cancelamento
com.totvs.foundation.protocolmanager.message.v1_00_00.CompleteProtocol.ENDPOINT = https://gpuhml.unimed.coop.br/gpu/v1_00_00/ComplementoProtocolo
com.totvs.foundation.protocolmanager.message.v1_00_00.SearchBeneficiaryProtocolHistory.ENDPOINT = https://gpuhml.unimed.coop.br/gpu/v1_00_00/ConsultaHistorico
com.totvs.foundation.protocolmanager.message.v1_00_00.SearchProtocolStatus.ENDPOINT = https://gpuhml.unimed.coop.br/gpu/v1_00_00/ConsultaStatusProtocolo
com.totvs.foundation.protocolmanager.message.v1_00_00.ForwardPerformedSolicitation.ENDPOINT = https://gpuhml.unimed.coop.br/gpu/v1_00_00/EncaminharExecucao

URI

Propriedades que definem os "namespaces", dos web services definidos pelo "Schema". Existe uma propriedade para cada web service e não é necessário alterar a definição, basta copiar para o arquivo.

com.totvs.foundation.protocolmanager.message.v1_00_00.RequestProtocol.URI = http://gp.unimed.coop.br/solicitarProtocolo/webservices/V1_00_00
com.totvs.foundation.protocolmanager.message.v1_00_00.AnswerProtocol.URI = http://gp.unimed.coop.br/respostaAtendimento/webservices/V1_00_00
com.totvs.foundation.protocolmanager.message.v1_00_00.CancelRequest.URI = http://gp.unimed.coop.br/cancelamento/webservices/V1_00_00
com.totvs.foundation.protocolmanager.message.v1_00_00.CompleteProtocol.URI = http://gp.unimed.coop.br/complementoProtocolo/webservices/V1_00_00
com.totvs.foundation.protocolmanager.message.v1_00_00.SearchBeneficiaryProtocolHistory.URI = http://gp.unimed.coop.br/consultaHistorico/webservices/V1_00_00
com.totvs.foundation.protocolmanager.message.v1_00_00.SearchProtocolStatus.URI = http://gp.unimed.coop.br/consultaStatusProtocolo/webservices/V1_00_00
com.totvs.foundation.protocolmanager.message.v1_00_00.ForwardPerformedSolicitation.URI = http://gp.unimed.coop.br/encaminharExecucao/webservices/V1_00_00

WSDL

Propriedades que definem os endereços dos arquivos "WSDL", no servidor local da operadora. Existe uma propriedade para cada serviço, que devem ser alteradas para corresponder ao endereço da aplicação "Foundation Saúde", e porta em que o "JBoss" foi carregado.

"http://<endereço>:<porta>/wsdl/v1_00_00/solicitarProtocolo_V1_00_00.wsdl"

com.totvs.foundation.protocolmanager.message.v1_00_00.RequestProtocol.WSDL = http://10.54.252.21:28080/wsdl/gp/v1_00_00/solicitarProtocolo_V1_00_00.wsdl
com.totvs.foundation.protocolmanager.message.v1_00_00.AnswerProtocol.WSDL = http://10.54.252.21:28080/wsdl/gp/v1_00_00/respostaAtendimento_V1_00_00.wsdl
com.totvs.foundation.protocolmanager.message.v1_00_00.CancelRequest.WSDL = http://10.54.252.21:28080/wsdl/gp/v1_00_00/cancelamento_V1_00_00.wsdl
com.totvs.foundation.protocolmanager.message.v1_00_00.CompleteProtocol.WSDL = http://10.54.252.21:28080/wsdl/gp/v1_00_00/complementarProtocolo_V1_00_00.wsdl
com.totvs.foundation.protocolmanager.message.v1_00_00.SearchBeneficiaryProtocolHistory.WSDL = http://10.54.252.21:28080/wsdl/gp/v1_00_00/consultaHistorico_V1_00_00.wsdl
com.totvs.foundation.protocolmanager.message.v1_00_00.SearchProtocolStatus.WSDL = http://10.54.252.21:28080/wsdl/gp/v1_00_00/consultaStatusProtocolo_V1_00_00.wsdl 
com.totvs.foundation.protocolmanager.message.v1_00_00.ForwardPerformedSolicitation.WSDL = http://10.54.252.21:28080/wsdl/gp/v1_00_00/encaminharExecucao_V1_00_00.wsdl

Timeout

Configurar a propriedade de "protocolmanager.webservices.timeout" para definir o tempo máximo, em milissegundos, que o "Foundation Saúde" irá esperar por uma resposta da Unimed do Brasil, até que encerre a comunicação e devolva uma inconsistência. Os valores possíveis variam de -1 ao infinito. Abaixo segue alguns exemplos de utilização.

• "protocolmanager.webservices.timeout = -1":
  • O valor -1 indica tempo infinito de espera, isto é, o Foundation Saúde irá aguardar por uma resposta da Unimed do Brasil indefinidamente;
• "protocolmanager.webservices.timeout = 9000":
  • Nesse caso o Foundation Saúde irá aguardar 9 segundos por uma resposta da Unimed do Brasil, após esse tempo irá encerrar a comunicação e devolver um erro de Time Out.

Schemas e WSDL's

É necessário copiar todos os arquivos "XSD" e "WSDL", referentes ao "Gestão de Protocolos", disponibilizados pela Unimed do Brasil para a pasta "<JBoss>/server/<instancia>/deploy/wsdl.war/gp/v1_00_00".

CONFIGURAÇÃO DE PARÂMETROS NO GESTÃO DE PLANOS DE SAÚDE

Parâmetros Globais Sistema (PR1410P)

1. Alterar o parâmetro "Integração RN395/Intercambio", para: "2 - Online";
2. Informar a URL de comunicação com o "Foundation Saúde", que é o endereço para o serviço "WsdProtocolManager":
   
   1. Exemplo: "http://fndsauhml.totvs.com.br:28080/htz-foundation/WsdProtocolManagerWS?wsdl".
3. Informar o "Namespace", de comunicação com o "Foundation Saúde":
   1. Valor fixo igual a "http://v1_00_00.ws.protocolmanager.foundation.totvs.com/".

Manter Parâmetros Marketing Receptivo (HMRParametersView)

1. Grupo de atendimento responsável pelo Web Service:
   1. Define o grupo de atendimento para o qual serão criados os chamados recebidos pelo serviço de "Solicitar Protocolo", ou por meio da digitação da guia no "AT";
2. Usuário responsável pelo Web Service:
   1. Campo opcional para indicar qual será o usuário que é responsável pelos chamados que chegarem pela "Solicitação de Protocolo do Web Service", ou por meio da digitação da guia no "AT". Na ausência desse parâmetro, o chamado é criado com "Nenhum Responsável", e todos os atendentes do grupo podem visualizar a solicitação até que um usuário assuma.

Manter Categorias de Atendimento(CallCategoryView)

Na manutenção de um registro, foi criado o campo "Tipo Manifestação", para relacionar essa informação com a "Categoria de Atendimento do Gestão de Planos". As opções de preenchimento, listadas abaixo, são oriundas do domínio da Unimed do Brasil:

1. Elogio;
2. Reclamação;
3. Denúncia;
4. Sugestão;
5. Dúvida;
6. Solicitação.

Deve ser criado uma "Categoria de Atendimento", para cada "Tipo de Manifestação", para que a criação de um chamado por meio de uma "Solicitação de Protocolo", recebida pelo web service, seja efetuada corretamente.

Manter Motivos de Atendimento (CallMotiveView)

Na manutenção de um registro, foi criado o campo "Categoria da Manifestação", para relacionar essa informação com o "Motivo de Atendimento do Gestão de Planos". As opções de preenchimento, listadas abaixo, são oriundas do domínio da Unimed do Brasil e dependentes do preenchimento do campo "Categoria de Atendimento", pois varia conforme o "Tipo de Manifestação".

1. Se Tipo da Manifestação = 1, 2, 3, 4:
   1. 1. Médicos Cooperados;
   2. 2. Hospitais/Clínicas Credenciadas;
   3. 3. Hospitais/ Clínicas Unimed;
   4. 4. Operadora.
2. Se Tipo da Manifestação = 5: 
   1. 5. Coberturas;
   2. 6. Carência;
   3. 7. Fatura.
3. Se Tipo da Manifestação = 6: 
   1. 8. Cancelamento de Plano;
   2. 9. Compra de Plano;
   3. 10. Alterações Cadastrais;
   4. 11. Estorno;
   5. 12. Posição de Pagamento;
   6. 13. IRPF;
   7. 14. Parcerias/Doações;
   8. 15. 2ª via de boleto;
   9. 16. Envio de Cartão;
   10. 17. Documentos;
   11. 18. Guia Médico;
   12. 19. Procedimento Médico.

Deve ser criado um "Motivo de Atendimento", para cada "Categoria de Manifestação", onde a criação de um chamado, por meio de uma "Solicitação de Protocolo", recebida pelo web service, seja efetuada corretamente. Esses "Motivos de Atendimento", devem estar associados ao "Grupo de Atendimento", cadastrado para receber chamados do web service.

Manter Configuração de Atendimento (ConfigAttentionView)

Implementada a nova aba "Integração AT", que define vínculos entre o grupo de atendimento e "Tipos de Guias do AT", com o objetivo de criar chamados automaticamente durante a digitação de guias (AT0110Z) ,do módulo "AT". A digitação de guia no "AT", somente cria um chamado no "MR" se:

• O usuário do sistema, que estiver digitando a guia, esta vinculado a algum grupo de SAC no "MR";
• O grupo de SAC, da regra anterior, deve ter uma regra vigente para o tipo da guia.

A funções de "Adicionar" e "Alterar", permitem configurar os seguintes atributos:

1. Tipo de Guia:
   1. Definir para qual "Tipo de Guia", essa regra vale, isto é, ao digitar uma guia no "AT", o sistema irá procurar, nos grupos de atendimento que o usuário pertence, por uma regra vigente cujo "Tipo de Guia", seja igual entre regra e guia digitada;
2. Motivo de Atendimento:
   1. Definir qual o "Motivo de Atendimento", do "MR", deve ser usado para criar o chamado. Somente são permitidos os "Motivos de Atendimento", cadastrados para o "Grupo de Atendimento", que está em manutenido;
3. Categoria:
   1. Campo meramente informativo para ilustrar a categoria associada ao motivo de atendimento selecionado;
4. Prioridade:
   1. Definir a prioridade com a qual o chamado será aberto;
5. Vigência:
   1. Período em que essa regra esta ativa, esses campos são considerados para identificar se a parametrização está válida.

Procedimento para Utilização

Os serviços do web service foram implementados da seguinte maneira:

• Manutenção Autorização Guias - AT:
  • Solicitar protocolo durante a inclusão de uma guia, ou após a inclusão;
  • Complementar protocolo após a inclusão de uma guia;
  • Possibilidade de incluir chamados no "MR" automaticamente, na inclusão de uma guia;
• Manter Chamados de Atendimento - MR:
  • Solicitar Protocolo na criação de chamados;
  • Responder Atendimentos na resposta ou solução de chamados;
  • Cancelar Atendimentos no cancelamento de chamados;
  • Consultar Histórico, Consultar Status e Encaminhar execução como funções extras;
  • Receber as mensagens do web service.

A seguir os detalhes da utilização das novas funções.

Manutenção Autorização Guias (AT0110z)

Solicitar protocolo de atendimento

Ao autorizar uma nova guia, existem as seguintes possibilidades:

1. Beneficiários da base:
   1. o sistema considera o parâmetro "Numero Protocolo", do cadastro de tipos de guia (at0110a), para decidir se o campo do número do protocolo: 
      1. 0 - Não trata: ignora a informação na tela;
      2. 1 - Pede: solicita que o usuário informe o número do protocolo na tela;
      3. 2 - Obriga: solicita e obriga que o usuário informe o número do protocolo na tela;
      4. 3 - Automático: o sistema gera o número do protocolo e cria o chamado no "MR", caso exista parametrização de integração válida;
2. Beneficiários em intercâmbio:
   1. o sistema considera o parâmetro "Integracao RN 395/Intercambio", dos parâmetros globais do sistema (pr1410p), para decidir se:
      1. 0 - Offline: o sistema ignora a informação do número do protocolo;
      2. 1 - Contingência: solicita que o usuário informe o número do protocolo na tela;
      3. 2 - Online: conecta com o "Foundation Saúde", para invocar o serviço de "Solicitar Protocolo de Atendimento", da Unimed do Brasil, conforme definido nos "Procedimentos de Configuração". Nessa opção o sistema irá criar o chamado no "MR", caso exista parametrização de integração válida;

Observação 1: Foi incluído o campo "DDD", na tela de atualização de informações do beneficiário em intercâmbio. Essa informação, assim como o número do "Telefone", é exigida pelo serviço de "Solicitar Protocolo". 

Observação 2: Caso ocorra alguma inconsistência na solicitação do protocolo via web service, o sistema permite que o usuário informe manualmente ou solicite posteriormente o número do protocolo.

A criação automática do chamado no "MR", ocorre somente na geração automática, para os beneficiários da base, ou com o protocolo recebido por intermédio do web service, para os beneficiários de intercâmbio. Tal criação será efetuada de acordo com as seguintes regras:

1. O usuário logado no sistema deve possuir um papel de SAC no "MR" (HDA ou HDS), e estar configurado como atendente ou supervisor em algum grupo de atendimento de SAC;
2. O sistema irá procurar pelo primeiro grupo de atendimento de SAC, que o usuário pertença, e que contenha alguma regra de integração "AT x MR", vigente para o tipo da guia. O cadastro das regras foi descrito na seção de configurações do GPS;
3. O chamado é criado no grupo encontrado e seu responsável será o usuário que incluiu a guia. Outras informações do chamado serão criadas como descrito a seguir:
   1. Motivo de Atendimento: oriundo da regra de integração encontrada;
   2. Prioridade: oriundo da regra de integração encontrada;
   3. Título e Descrição: texto fixo;
   4. Solicitante: beneficiário da guia incluída;

Complementar protocolo de atendimento

Nas funções da autorização de guias, foi adicionado o botão "Inf/Compl. Protocolo", que abre a seguinte tela:

Ao informar o ano e número da guia, o sistema permitirá:

• Caso a guia ainda não tenha número de protocolo, informar um número de protocolo, de acordo com a mesma regra da solicitação descrita acima;
• Caso ainda não tenha sido enviado o complemento do protocolo com sucesso, enviar a mensagem de "Complementar Protocolo de Atendimento". Essa mensagem permite a associação do número de protocolo com a transação de intercâmbio do beneficiário.

Manter Chamados de Atendimento (callView)

Este programa foi integrado aos serviços do sistema de "Gestão de Protocolos", da Unimed do Brasil, sendo a principal ferramenta de trabalho para utilização desses serviços. Nesse sentido, os chamados do "MR", ganharam uma conotação de 

As seções a seguir, descrevem o uso dos novos serviços bem como as adaptações necessárias.

Geração do número de protocolo

A partir desta implementação, o protocolo passa a ser gerado somente após a seleção do "Solicitante" do chamado, exceto quando o solicitante é um beneficiário em intercâmbio, mas este caso será detalhado na seção que detalha o serviço de solicitação de protocolo. Até que essa etapa não seja concluída, o cabeçalho exibirá o texto "Carregando".

Solicitar Protocolo de Atendimento

O serviço de "Solicitar Protocolo de Atendimento", será invocado automaticamente na finalização da criação do chamado somente, quando o solicitante do chamado for um beneficiário em intercâmbio. Nesse caso, o cabeçalho exibe a mensagem de "Carregando", até que o chamado seja criado com sucesso e com o número do protocolo resultante do serviço. Para executar essa operação, siga os passos abaixo:

Na tela principal do chamado, clique no botão "Adicionar".

Selecione a opção "Outros", em seguida a opção "Beneficiário de Intercâmbio". A tela abaixo será exibida.

Informar o número da "Unidade" do beneficiário e sua "Carteira". Caso o beneficiário já possua cadastro na unidade, a tela exibe as suas informações, caso contrário permite que o cadastro seja efetuado. Após inserir as informações clique em "Salvar", para gravar as informações e escolher o beneficiário em intercâmbio como solicitante do chamado.

Observação: Foi incluído o campo "DDD", na aba "Endereço". Essa informação, assim como o número do "Telefone", é exigida pelo serviço de "Solicitar Protocolo".

Após definir o solicitante do chamado, continue o fluxo da criação do chamado normalmente até a etapa abaixo.

Configurar o restante das informações e clicar no botão "Salvar". O sistema carrega o serviço de "Solicitar Protocolo", e com o número retornado, salve o chamado.

Observação 1: Nessa tela foi incluído o novo campo "Sentimento do Cliente", que é referente ao campo homônimo opcional, definido no serviço de "Solicitar Protocolo". Além disso, as informações da "Categoria de Atendimento" e "Motivo do Atendimento", são utilizadas para enviar os dados do "Tipo de Manifestação" e "Categoria da Manifestação", conforme as associativas descritas na seção da configuração. Tais informações são obrigatórias na mensagem de solicitação de protocolo.

Observação 2: Caso ocorra alguma inconsistência na solicitação do protocolo, o sistema permite que o usuário informe manualmente o número do protocolo.

Receber Solicitação de Protocolo

Ao receber uma nova solicitação de protocolo, o sistema identifica se o código do beneficiário recebido existe e se trata de um beneficiário ativo. Caso o código esteja correto, o sistema cria de um novo chamado no MR e retorna o seu número do protocolo. Caso contrário, retorna uma inconsistência para o solicitante. 

A criação do chamado depende das parametrizações descritas na configuração dos parâmetros do MR, onde o chamado é direcionado para o grupo configurado no campo "Grupo de atendimento responsável pelo Web Service", e o usuário configurado no campo "Usuário responsável pelo Web Service", se existir algum, será o responsável pelo novo chamado. O sistema configura automaticamente, no chamado, a "Categoria" e o "Motivo de Atendimento", de acordo com o "Tipo de Manifestação" e "Categoria da Manifestação", informados na solicitação, por meio das associativas descritas nesta seção da configuração.

Solicitar e Receber Resposta de Atendimento

O serviço de "Responder", foi incorporado à função "Responder", já existente no "MR", de modo quando o usuário criar uma interação de resposta em um chamado externo, o sistema invoca este serviço e informa o texto da resposta. Somente é gravado a resposta no chamado, se o o retorno do serviço for uma confirmação do recebimento.

De forma análoga, ao receber a resposta de um atendimento, o sistema grava a movimentação de resposta no chamado referente ao protocolo informado.

Observação: Ao solucionar um chamado externo, o sistema invoca este serviço e informa o campo "ID Resposta"como "3 - Finalizado", também só grava a solução, caso o retorno do serviço seja de confirmação.

Solicitar e Receber Cancelamento de Atendimento

O serviço de "Cancelar", foi incorporado à função "Cancelar", já existente no "MR", de modo quando o usuário efetuar uma operação de cancelamento em um chamado externo, o sistema invoca este serviço e informa o texto do cancelamento. Somente é gravado o cancelamento do chamado, se o o retorno do serviço for uma confirmação do recebimento.

De forma análoga, ao receber o cancelamento de um atendimento, o sistema cancela o chamado referente ao protocolo informado.

Solicitar Encaminhamento de Execução

Para encaminhar a execução de um chamado, deve-se clicar na opção "WS - Gestão de Protocolos", e em seguida em "Encaminhar Execução". O sistema invoca o respectivo serviço, caso o beneficiário solicitante do chamado, possuir um repasse ativo, utilizando a "Unidade de Destino de Atendimento", do beneficiário como o destino do solicitação. A confirmação dessa ação grava uma sequência de "Resposta" no chamado, e não permite outro envio.

Importante: Essa ação "não", gera nenhuma sequência de "Encaminhamento", no chamado, que só é criada quando o chamado é encaminhado para "Grupos de Atendimento de Back-Office". 

Receber Solicitação de Encaminhar Execução

Quando o sistema receber uma solicitação encaminhando a execução de um atendimento, o sistema valida se o beneficiário da mensagem está repassado para a unidade e, caso esteja, gera um novo chamado no "MR", utilizando as mesmas regras que a criação de chamados da Solicitação de Protocolos.

Receber e Consultar Status do Protocolo

Para efetuar essa consulta, deve-se clicar na opção "WS - Gestão de Protocolos", e em seguida em "Consultar Protocolo". Caso o chamado selecionado para a consulta seja externo, o sistema, automaticamente, disparar uma consulta para a Unimed solicitante do protocolo e exibe os resultados em tela.

Ao receber uma solicitação de consulta, o sistema retorna os dados do chamado junto com as informações das sequências de "Abertura", "Respostas", "Solução" e "Cancelamento". Outros tipos de sequência são ignorados.

Receber e Consultar Histórico do Protocolo

Para efetuar essa consulta, deve-se clicar na opção "WS - Gestão de Protocolos", e em seguida em "Consultar Histórico". Caso o chamado selecionado para a consulta seja externo, o sistema abre a tela de consulta, permite que o usuário informe o período desejado e dispare uma consulta para a Unimed solicitante do protocolo, após exibe os resultados em tela.

Ao receber uma solicitação de consulta, o sistema retorna os dados dos chamados referentes ao beneficiário solicitado.