Objetivo geral
Nessa documentação a Mobile Saúde abordará todos os modelos de integração disponíveis para a Plataforma do Beneficiário.
O entendimento do formato de integração é fundamental para a implantação do projeto.
Para realizar uma implantação do produto padrão, a adoção dos padrões de integração é imprescindível.
Não seguir o padrão de integrações documentado levará o projeto IMEDIATAMENTE para um projeto ESPECÍFICO, com horas abertas, e tempo de duração muito maior.
O processo de instalação:
Para que sua empresa tenha acesso a uma ou mais funcionalidades do padrão do produto, existe um fluxo de processos que consiste - de forma resumida - em:
- Cliente: Adquirir o direito de uso da funcionalidade padrão (via departamento comercial);
- Mobile Saúde e cliente: Kick-off do projeto (através do time comercial e entrega) e início formal da implantação;
- Cliente: Entendimento de como funciona a feature contratada (de onde os dados são obtidos, como é exibido, interações, etc);
- Cliente: Implementação das integrações ou configurações por parte do cliente (com base nos manuais da mobile saúde ou integrações disponíveis no padrão);
- Mobile Saúde: validar as integrações / fornecer app de homologação para validação
- Cliente: utilizando o app, validar as funcionalidades contratadas;
- Mobile Saúde: atualizar apps nas lojas oficiais, quando necessário, para liberar as novas features para os beneficiários.
Conhecendo as integrações:
Quando uma funcionalidade nova é implantada, podem ser necessárias integrações.
Essas integrações devem obedecer o formato e layout designado pela Mobile Saúde, para que possamos garantir o bom funcionamento, além de desempenho e alta disponibilidade.
Cada funcionalidade tem integrações, diferentes. Alguns exemplos de integrações existentes:
- Rede credenciada no app e na web: necessita de carga de dados de rede credenciada, no formato CSV, com layout de campos pré-definidos em documentação da Mobile Saúde;
- Cartão virtual: exige a criação de integrações para realizar login e recuperar senha, por exemplo.
- Extratos de utilização: necessita de um webservice capaz de entregar as utilizações do usuário logado, em determinado período.
- Solicitação de atualização cadastral: sua empresa pode implementar um método que receberá os dados fornecidos pelo beneficiário, e grava-los diretamente na base de dados de seu sistema gestor de planos de saúde.
Iniciando o trabalho:
Uma vez que sua empresa tenha definido o escopo da implantação, é hora de entender que tipo de integração deve ser implementada.
Integrações disponíveis:
- CMS - Gerenciador de conteúdo: sua empresa acessa o painel de gestão do app (usando usuário/senha fornecido pela Mobile Saúde). Lá, sua empresa configura o conteúdo e comportamento da aplicação, e o app reflete a mudança realizada
- Arquivos Batch CSV: sua empresa gera arquivos de carga (batch) e realiza o upload dos dados utilizando um painel de importação web, ou rotina automatizada (SFTP)
- APIs (REST): integração online utilizando Webservices padrão REST, onde sua empresa desenvolve integrações no padrão REST, conforme layout de integração pre-definido;
- Webhook: atualizações de dados originadas pela Mobile Saúde, quando recebemos uma solicitação vinda do usuário (como por exemplo uma solicitação de atualização cadastral);
- N/A: quando não existe integração, utilizamos o formato "N/A" que significa não se aplica.
A tabela abaixo identifica cada funcionalidade, e como funciona o critério de integração (quando existente):
| Funcionalidade | Apps (iOS e Android) | Área do beneficiário | Observações |
|---|---|---|---|
| Notícias | CMS | CMS | |
| Banners | CMS | CMS | |
| Revistas e manuais | CMS | CMS | |
| Alarmes | N/A | N/A | |
| Prescrições (foto) | N/A | N/A | |
| Busca de rede credenciada | Arquivos Batch CSV | Arquivos Batch CSV | Enviar set de arquivos que compõem a carga de dados |
| Prestadores favoritos | N/A | N/A | Funcionalidade exclusiva para apps, utiliza-se da carga de dados de rede credenciada |
| Descredenciados | Arquivos Batch CSV | Arquivos Batch CSV | Mesmos arquivos da Busca de rede credenciada |
| Livreto em PDF | N/A | Arquivos Batch CSV + CMS | Operadora configura a capa, contracapa, e introdução no CMS. O conteúdo dos livretos em PDF são gerados automaticamente, a cada nova carga de dados de rede credenciada |
| Autenticação de usuários no app | APIs (REST) | APIs (REST) | Métodos padrões disponíveis:
|
| Extrato de utilização e coparticipação | APIs (REST) | APIs (REST) | Métodos:
|
| Débitos (Boletos) | APIs (REST) | APIs (REST) | Métodos:
|
| Extrato de autorizações | API (REST) | APIs (REST) | Métodos:
|
| Extrato de reembolso | APIs (REST) | APIs (REST) | Métodos:
|
| Solicitação de 2a via de cartão | CMS + Webhook | CMS + Webhook | Formato:
|
- Para impO beneficiário acessa o app ou interface web, e realiza login na aplicação;
- Ao acessar a rotina de "Utilização / Coparticipação" o beneficiário tem acesso a um seletor de "Mês / Ano" ;
- Com base nessas informações, a rotina irá buscar em seu sistema as informações de utilização e coparticipação no seu WS / método disponível;
- Uma vez exibidas as informações, o usuário do app pode visualiza-las em tela, ou emitir um relatório (padrão Mobile Saúde) em PDF.
Todas as informações exibidas pela rotina são obtidas, de forma online, pela Mobile Saúde, utilizando APIs construídas para realizar tal integração. A Mobile Saúde não armazena, sob nenhum aspecto, informações sobre conteúdos exibidos para os beneficiários de sua empresa. Dessa forma, sempre que necessário, o app realizará novas solicitações, buscando por uma lista atualizada e detalhes das declarações.
Documentação de integrações necessárias para essa funcionalidade
A funcionalidade de Extrato de utilização e coparticipação exige que sua empresa construa integrações com o layout padrão de webservice elaborado pela Mobile Saúde, disponível no link abaixo:
Extrato de Utilização e Coparticipação
Nossos sistemas validam, de forma automatizada, a estrutura dos webservices e os tipos de dados fornecidos no retorno das requisições. Na prática, sua empresa precisa obedecer exatamente a documentação técnica disponível no link acima.
A impossibilidade de adoção desse padrão de integração por parte de sua empresa impede que essa rotina seja implantada. Nesses casos, um projeto de customização pode ser oferecido, com custos e formato de cobrança diferentes dos estabelecidos no "Escopo padrão".
Extrato de utilização e coparticipação - acessando as informações - fluxo de telas do app
As telas a seguir demonstram a funcionalidade de extrato de utilização e coparticipação, usando o app Plataforma do beneficiário.
Nesta funcionalidade, é possível ocultar a aba de utilização ou coparticipação, de acordo com sua necessidade. Para fazer isso, especifique sua necessidade para a Mobile Saúde. A configuração é feita de forma online, sem necessidade de modificações nos seus WebServices.
Da mesma forma, é possível ocultar dados em tela. Porém, incluir novas informações está fora do escopo. Por isso, incluir novos campos nas rotinas padrões não está no escopo da rotina padrão, e será tratado como customização.
1 - Acessando a rotina na dashboard (o texto "Declarações" pode ser modificado de acordo com a necessidade). Essa modificação pode ser feita em tempo de projeto, e após entrar em produção ser modificada via chamado, sem custos. |
O usuário do app escolhe qual período deseja visualizar (por mês). Nessa imagem, é possível perceber que estão disponíveis extrato de utilização e coparticipação, em abas distintas. Sua empresa pode optar por mostrar apenas uma delas. Para configurar essa aparência, é necessário intervenção da Mobile Saúde. Essa ação é uma configuração, não configurando customização. |
3 - Serão exibidas as informações de utilização, na referida aba. Perceba que existem quebras por tipo de eventos, conforme previsto na lei (PIN-SS Utilização - RN 389). No fim, existe o totalizador por período. Os títulos / quebras serão exibidos conforme o layout e textos adotados na integração prevista. |
4 - Exemplo de como as informações podem ser exibidas, no extrato de coparticipação. É possível configurar o extrato de coparticipação para mostrar, ao lado do valor de coparticipação, o valor do serviço. Trata-se de uma configuração, não caracterizando customização. |
5 - Ao pressionar o botão de compartilhar, é gerado um relatório em PDF (padrão Mobile Saúde). Quando a aba ativia é a de utilização, um relatório com o padrão de extrato de utilização é gerado. |
6 - Da mesma forma, é possível gerar um relatório de coparticipação em PDF, quando a aba de coparticipação estiver ativa. |
Extrato de utilização e coparticipação - acessando as informações - fluxo de telas usando a área do beneficiário
A seguir será exemplificado o fluxo da aplicação web, durante acesso da rotina de utilização e coparticipação.
Atenção
O uso desta funcionalidade está condicionado a aquisição do produto Área do Beneficiário, que é contratado de forma separada em alguns planos. Entre em contato com o departamento comercial da Mobile Saúde para adquirir essa funcionalidade, ou confirmar se existe em seu contrato.
1 - Ao acessar a área do beneficiário e identificar-se, o usuário da aplicação tem acesso à funcionalidade "Utilização e coparticipação" também na web; |
2 - Após escolher o mês/ano e pressionar "Enviar", os dados de utilização são exibidos abaixo. Da mesma que no app, as informações de utilização e coparticipação estão dispostas em abas. É possível ocultar uma das abas, conforme sua necessidade, bastando informar a Mobile Saúde. |
3 - As informações de coparticipação estão dispostas também, na aba relacionada.. |
4 - Pressionando o botão "Extrato detalhado" na rotina de utilização, um extrato de utilização é exibido. |
5 - Da mesma forma, ao detalhar o extrato de coparticipação, as informações são geradas em um PDF, que pode ser baixado pelo usuário da web. |
Você vai perceber, ao longo deste documento, que existem 3 formatos de integração disponíveis:
- Carga de dados via arquivos CSV (utilizados essencialmente para carga de rede credenciada);
- Integrações "por demanda" através de webservices padrão REST: utilizados em funcionalidades muito dinâmicas, como login, troca de senha, extrato de uso, declarações de IR, etc.
- Gerenciador de conteúdo e webhook / API: