...
- Visão Geral
- Exemplo de utilização
- Configuração
- Endpoint e Autenticação
- Certificado Digital
- Endpoint do Compartilhamento de Risco
- Programa de Menu
- Criando Lote de Envio
- Status do Lote
- Consultar Status
- Enviando Beneficiários
- Detalhes do Envio
- Mensagens de Erro
- Exportar Erros
- Compartilhamento de Risco
- Tabelas utilizadas
01. VISÃO GERAL
...
Essa integração permite enviar as movimentações de inclusão, alteração e exclusão dos beneficiários da Unimed para o Cadastro Nacional de Beneficiários (CadBenef), onde o envio dos dados dos beneficiários à Unimed do Brasil através do PTU A1300 deixará de existir.
...
Vale lembrar que tais mudanças otimizarão o processo de cadastramento de beneficiários no intercâmbio, uma vez que os processos manuais serão extintos.
02. EXEMPLO DE UTILIZAÇÃO
...
...
a. Configuração
...
...
i. Endpoint e Autenticação
...
Acesse o menu Operadora de Saúde (PLSA010), do módulo Plano de Saúde (SIGAPLS), e seleciona o código da Unimed que deseja configurar a integração.
...
Informações |
---|
|
URL Token: Endpoint de homologação/produção disponibilizado pela Unimed Brasil para autenticação. (BA0_UBURL) Exemplo: https://gateway-hml2.unimed.coop.br/oauth/v1/access-token ID Token: Client ID solicitado previamente para Unimed Brasil. (BA0_UBCLID) Secret Token : Secret ID solicitado previamente para Unimed Brasil. (BA0_UBCLSC) URL CadBenef: Endpoint de homologação/produção do CadBenef-Online. (BA0_CDBURL) Exemplo: https://gateway-hml2.unimed.coop.br/cadbenef-online/v1/beneficiarios |
...
ii. Certificado Digital
A Unimed Brasil utiliza certificados digitais do tipo ICP-Brasil que funcionam como uma identidade virtual que permite a identificação segura e inequívoca do autor de uma mensagem ou transação.
...
Informações |
---|
|
PFX CadBenef: O nome do certificado com extensão. (BA0_CDBPFX) Pass CadBen.: Senha que será utilizada para a abertura da chave privada. Para uma chave privada que não possua senha, deve ser informada uma string vazia. (BA0_CDBPAS) |
...
Âncora |
---|
| endpoint_compartilhamento |
---|
| endpoint_compartilhamento |
---|
|
iii. Endpoint do Compartilhamento de Risco
Disponibilizado API para possibilitar que seja enviada a movimentação de compartilhamento de Risco para a Unimed Destino.
...
Dica |
---|
|
https://<url>:<porta>/totvsHealthPlans/unimed/cadbenef-online/v1/beneficiarios/compartilhamento-riscos |
Para a integração do CadBenef foi desenvolvido um novo programa (rotina) de menu no seguinte caminho:
Dica |
---|
|
Miscelanea
Unimed
Integrações
Decrição: CadBenef Online Programa: PLPTU001 Módulo: Plano de Saúde Tipo: Função Protheus |
c. Criando Lote de Envio
Na tela inicial, serão apresentados todos os lotes criados para integrar com o CadBenef Online - Unimed Brasil:
...
Informações |
---|
|
Para manipular query que busca os beneficiário pro lote foi criado o seguinte ponto de entrada: PE PTU001QRY Manipula Query que Busca os Beneficiários do Lote - CadBenef Online |
d. Status do Lote
Os lotes poderão possuir os seguintes status:
Informações |
---|
|
Ao criar o lote. Estado |
---|
subtle | true |
---|
colour | Blue |
---|
title | Processando Envio |
---|
| Quando estiver enviando os beneficiários para o CadBenef. Estado |
---|
subtle | true |
---|
colour | Red |
---|
title | Falha de Envio |
---|
| Caso algum beneficiário tiver erro no envio. Estado |
---|
| |
---|
subtle | true |
---|
colour | Green |
---|
title | Finalizado com sucesso |
---|
| Quando todos os beneficiários do lote forem enviados com sucesso. Estado |
---|
subtle | true |
---|
colour | Yellow |
---|
title | Finalizado Parcialmente |
---|
| Quando houver beneficiários enviados com sucesso e nenhum com erro de envio. |
Âncora |
---|
| consultar_status |
---|
| consultar_status |
---|
|
i. Consultar Status
O consultar status apresenta a quantidade de beneficiários no lote por status, sendo:
![](/download/attachments/838691128/image-2024-5-6_15-16-4.png?version=1&modificationDate=1715019364670&api=v2&effects=drop-shadow)
Âncora |
---|
| enviar_beneficiario |
---|
| enviar_beneficiario |
---|
|
e. Enviando Beneficiários
...
Quando enviado o lote, o sistema irá processar o envio dos beneficiários de forma assíncrona, ou seja, o usuário não precisará esperar terminar o envio. Nesse momento, o lote ficará com o status
Estado |
---|
subtle | true |
---|
colour | Blue |
---|
title | Processando Envio |
---|
|
. Âncora |
---|
| detalhes_envio |
---|
| detalhes_envio |
---|
|
i. Detalhes do Envio
Através do consultar beneficiários, será possível verificar os Detalhes de Envio de cada beneficiário para o CadBenef:
![](/download/attachments/838691128/image-2024-5-24_20-15-36.png?version=1&modificationDate=1716592536987&api=v2&effects=drop-shadow)
Notatip |
---|
Status: Corresponde ao status de envio do beneficiário, sendo: Estado |
---|
subtle | true |
---|
title | Pendente de Envio |
---|
| , Estado |
---|
subtle | true |
---|
colour | Green |
---|
title | Envio Finalizado |
---|
| , Estado |
---|
subtle | true |
---|
colour | Red |
---|
title | Erro de Envio |
---|
| . Cd. Transac.: Código de Transação do PTU (esse código não irá repetir), através dele será possível consultar a transação no portal da Unimed Brasil referente ao CadBenef. Msg. Envio: Json enviado pelo sistema para o CadBenef. Msg. Resp.: Json de resposta do CadBenef. |
Informações |
---|
|
Para alterar os dados (valores, obrigatoriedade e tipo) dos campos enviados para a API de movimentação cadastral do beneficiário, foi criado o ponto de entrada: PE PTU001JSN Altera os Dados dos Campos da API de Beneficiários - CadBenef Online |
Nota |
---|
title | API Serviço de Movimentação Beneficiarios - Unimed Brasil |
---|
|
Para mais detalhes do swagger da api da Unimed Brasil, clique aqui! |
Âncora |
---|
| mensagem_erro |
---|
| mensagem_erro |
---|
|
1. Mensagens de Erro
Quando o beneficiário estiver com o status
Estado |
---|
subtle | true |
---|
colour | Red |
---|
title | Erro de Envio |
---|
|
, será possível através das mensagens de erro, consultar com mais detalhes as críticas que o sistema encontrou ou que a Unimed Brasil retornou:
![](/download/attachments/838691128/image-2024-5-24_20-16-44.png?version=1&modificationDate=1716592604817&api=v2&effects=drop-shadow)
Âncora |
---|
| exportar_erro |
---|
| exportar_erro |
---|
|
g. Exportar Erros
N No botão Exportar Erros do lote, é possível obter todos os erros de envio dos beneficiários daquele lote:
...
Selecione o tipo de impressão: Arquivo, Spool, Planilha (Padrão) e E-mail para exportar os erros do lote:
![](/download/attachments/838691128/image-2024-5-24_21-33-53.png?version=1&modificationDate=1716597233973&api=v2&effects=drop-shadow)
Âncora |
---|
| compatilhamento_risco |
---|
| compatilhamento_risco |
---|
|
g. Compartilhamento de Risco
...
Essa ação indicará que é um compartilhamento de risco, custo operacional ou pós-pagamento.
Bloco de código |
---|
language | c# |
---|
theme | Emacs |
---|
title | Exemplo de Request Body |
---|
linenumbers | true |
---|
collapse | true |
---|
|
{
"cabecalho": {
"codigoControleTransacao": 12345678901234567000,
"unimed": {
"codigoUnimedOrigem": 999,
"codigoUnimedDestino": 55
},
"dataGeracao": "2024-05-27T09:06:05-03:00"
},
"dadosEmpresaContratante": {
"tipoContratoLocal": 1
},
"dadosBeneficiario": {
"carteirinhaBeneficiario": "00011008000034016",
"tipoCompartilhamentoRisco": "C",
"dataInicioCompartilhamentoRisco": "2024-07-05",
"dataFimCompartilhamentoRisco": "2024-10-05",
"indicadorCompUB": true
},
"dadosPessoa": {
"nomeCompletoBeneficiario": "FILIPE THALES RAFAEL PORTO",
"dataNascimento": "1991-01-26"
}
} |
Nota |
---|
title | API de Inclusão do Compartilhamento de Riscos - Unimed Brasil |
---|
|
Para mais detalhes do swagger da api da Unimed Brasil, clique aqui! |
No sistema, na rotina do Grupo Familiar/Beneficiários (PLSA124), opção do menu Interc. Hab. Será possível verificar os compartilhamentos de risco dos beneficiários. (Processo realizado no antigo PTU A100 simplificado)
...
Aviso |
---|
|
O compartilhamento de risco em pré-pagamento ou repasse não estará disponível nesse projeto. |
03. TABELAS UTILIZADAS
- BPW - CadBenef Online - Lote
- BPY - CadBenef Online - Beneficiário
- BA1 - Beneficiários
- BTS - Vidas
- BA3 - Famílias
- BA0 - Operadora de Saúde
- BG9 - Empresas
- BQC - Subcontratos
- BI3 - Produto Saúde
...