CONTEÚDO
- Visão Geral
- Rota
- Parâmetros de Entrada
- Retorno
- Regras de Negócio Aplicadas
- Como Validar as Informações
01. VISÃO GERAL
O TOTVS Saúde Planos (Linha Datasul) oferece uma série de APIs para integração com o APP da Unimed Brasil.
A API Extrato de Coparticipação do Beneficiário/DemonstrativoCoparticipacao tem por objetivo retornar o extrato de coparticipação do beneficiário, isto é, todos os procedimentos e insumos realizados pelo beneficiário em determinado período e que tiveram coparticipação cobrada do beneficiário.
A API foi desenvolvida seguindo as definições disponibilizadas no Swagger da Unimed Brasil.
a. Rota
/Beneficiario/v1/DemonstrativoCoparticipacao
b. Parâmetros de Entrada
Esta API deve receber os seguintes parâmetros via header ou via query parameters:
Parâmetro | Tipo de Parâmetro | Tipo de dados | Formato | Obrigatório? |
---|---|---|---|---|
header | String | 99999999999 | ||
header | String | 99999999999999999 | ||
periodoId | query | String | MM/AAAA | Sim |
Deve ser informado obrigatoriamente um CPF ou uma carteira de beneficiário.
b. Retorno
O objeto Json de retorno da API possui a seguinte estrutura:
{ "Result": "Domínio: 0 = Erro na execução do serviço, 1 = Processamento Ok", "Message": "Mensagem de retorno que deverá ser exibida ao usuário (obrigatória em caso de erro, ou seja, Result = 0)", "Data": [ { "categoria": "categoria", "valor": 0, "valorFormatado": "Valor total da seção no formato de exibição desejado", "itens": [ { "valor": 0, "valorFormatado": "Valor do item no formato de exibição desejado", "detalhes": [ { "Titulo": "Título apresentado para o detalhe do item", "Campo": "Campo com a descrição do detalhe do item" } ] } ] } ], "DebugMessage": "string" }
02. REGRAS DE NEGÓCIO APLICADAS
- A API irá retornar os movimentos (procedimentos/insumos) onde a data de realização esteja dentro do primeiro e último dia do período selecionado.
- Sempre que o movimento indicar que houve recolhimento de valor no prestador (vl-desconto-prestador) será apresentado no demonstrativo.
- Sempre que o movimento estiver amarrado a uma nota de coparticipação, e essa nota amarrada a uma fatura integrada ao financeiro (contas a receber) será apresentado no demonstrativo.
03. COMO VALIDAR AS INFORMAÇÕES
Os resultados apresentados pela API podem ser validados e visualizados no programa 'Central de Movimentação Guias TISS - hrc-document'.
Para tanto, deve-se realizar a busca por beneficiário e data de realização do movimento conforme período desejado.
Na tela inicial, clique em 'Busca Avançada':
Na tela da busca, na aba 'Documento', selecione o tipo de exibição 'Por Movimento' e o beneficiário desejado:
E, na aba 'Movimento', selecione o intervalo de data de realização de acordo com o período desejado (se período informado na API foi 04/2018, por exemplo, o intervalo de datas deverá ser 01/04/2018 a 30/04/2018):
Ao clicar em buscar, serão listados na tela principal, os movimentos do beneficiário para o período. Os movimentos que estiverem nas situações, conforme as regras da API, serão os movimetnos listados no APP.
EXEMPLO DE UTILIZAÇÃO
Segue abaixo exemplos prático de como pode ser realizada a validação da API.
a) Realizada uma requisição na API utilizando a carteira do beneficiário e período de acordo com os parâmetros visualizados abaixo:
Parâmetro | Valor |
---|---|
2008077000052 | |
periodoId | 08/2017 |
A API retornou os seguintes dados:
{ "Result": 1, "Data": [ { "categoria": "SENHOR CHOW", "valor": 441.83, "valorFormatado": "R$ 441,83", "itens": [ { "valor": 441.83, "valorFormatado": "R$ 441,83", "detalhes": [ { "Titulo": "Realizacao", "Campo": "22/08/17" }, { "Titulo": "Quantidade", "Campo": "100" }, { "Titulo": "Procedimento", "Campo": "CONSULTA EM PRONTO SOCORRO" } ] } ] } ], "DebugMessage": "", "Message": "" }
Os movimentos listados no programa 'Central de Movimentação Guias TISS - hrc-document' para a mesma carteira e período foram:
Ao detalhar o movimento pode ser verificado o valor faturado: