Histórico da Página
...
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 Utilização Coparticipação do Beneficiário/DemonstrativoCoparticipacao tem por objetivo retornar o extrato de utilização 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/Extrato.DemonstrativoCoparticipacao
b. Parâmetros de Entrada
Esta API deve receber os seguintes parâmetros via header ou via query parameters:
...
O objeto Json de retorno da API possui a seguinte estrutura:
Bloco de código |
---|
{ "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": [ { "nomecategoria": "categoria"Nome, da categoria de agrupamento do extrato"valor": 0, "valorvalorFormatado": "Valor total da seção no categoriaformato de agrupamentoexibição do extratodesejado", "procedimentositens": [ { "procedimentoId { "valor": 0, "valorFormatado": "CódigoValor do procedimento realizado item no formato de exibição desejado", "nomeProcedimentodetalhes": "Nome do procedimento realizado", "dtRealizacao [ { "Titulo": "Data de realizaçãoTítulo apresentado para o detalhe do procedimento em formato de exibição", "nomePrestadoritem", "Campo": "NomeCampo com a descrição do prestadordetalhe do executante" } item" } ] } ] } ], "DebugMessage": "string" } |
02. REGRAS DE NEGÓCIO APLICADAS
- A API irá retornar apenas os movimentos dos beneficiários que já estiverem sidos liberados do RC.
Os serviços serão classificados/agrupados por categoria de serviços. A categoria corresponderá ao valor do campo 'Tipo de Guia TISS' parametrizado na transação do serviço e pode ser classificadas como:
- Consultas: procedimentos em transação de Consulta;
- Exames/Terapias: procedimentos em transação de SADT;
- Internações: procedimentos em transações de Internação e Honorário Individual;
- Outras Despesas: todos os insumos, independente de transação.
- O campo de valor será preenchido de acordo com o valor de cobrança do beneficiário e forma de pagamento:
- Serviços cobrados em pré-pagamento e sem incidência de participação serão listados com valor zerado;
- Serviços cobrados em pré-pagamento com incidência de participação serão listados apenas com o valor da participação;
- Serviços cobrados em custo operacional serão listados com o valor integral do procedimento para cobrança.
- Procedimentos com equipe médica (auxiliares e anestesistas) serão listados apenas uma vez, considerando o movimento do Cirurgião.
- (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
...
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 0104/20202018, por exemplo, o intervalo de datas deverá ser 01/0104/2020 2018 a 3130/0104/20202018):
Ao clicar em buscar, serão listados na tela principal, os movimentos do beneficiário para o período. Os movimentos que estiver com status maior que 3 ('Liberado') deverão ser os mesmos retornados pela APIestiverem nas situações, conforme as regras da API, serão os movimetnos listados no APP.
EXEMPLO DE UTILIZAÇÃO
Segue abaixo um exemplo 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:
Bloco de código |
---|
{ "Result": 1, "Data": [ { "procedimentoscategoria": [ { "procedimentoId": "10101012"SENHOR CHOW", "dtRealizacaovalor": "30/01/2020"441.83, "nomePrestadorvalorFormatado": "PRESTADORR$ TESTE CHAMADO TIDMKI441,83", "nomeProcedimentoitens": "CONSULTA EM CONSULTORIO" [ }, { "procedimentoIdvalor": "10101012"441.83, "dtRealizacaovalorFormatado": "30/01/2020", R$ "nomePrestador": "PRESTADOR TESTE CHAMADO TIDMKI"441,83", "nomeProcedimentodetalhes": "CONSULTA EM CONSULTORIO"[ } ],{ "valor": "R$ 1,42", "nomeTitulo": "CONSULTAS" }, { "procedimentos": [ Realizacao", { "procedimentoIdCampo": "10101012", "dtRealizacao": "31/01/2020",22/08/17" "nomePrestador": "PRESTADOR" }, "nomeProcedimento": "CONSULTA EM CONSULTORIO" { }, { "procedimentoId"Titulo": "10101012Quantidade", "dtRealizacao": "30/01/2020", "nomePrestadorCampo": "PRESTADOR100", "nomeProcedimento": "CONSULTA EM CONSULTORIO" }, }, { "procedimentoId": "10101012", "dtRealizacao"Titulo": "30/01/2020Procedimento", "nomePrestador": "PRESTADOR", "nomeProcedimentoCampo": "CONSULTA EM CONSULTORIO" }, { "procedimentoId": "10101039",PRONTO SOCORRO" "dtRealizacao": "07/01/2020", "nomePrestador": "PRESTADOR", } "nomeProcedimento": "CONSULTA EM PRONTO SOCORRO"] } ], "valor": "R$ 1,08", "nome": "EXAMES/TERAPIAS" } ], "DebugMessage": "", "Message": "" } |
Os movimentos listados no programa 'Central de Movimentação Guias TISS - hrc-document' para a mesma carteira e período com status maior que 3, foram:
Primeiramente analisaremos os procedimentos retornados com a categoria 'CONSULTA':
Estes, foram corretamente agrupados, conforme parametrizado na transação 5001:
Podemos observar ainda que o código, nome e data de realização dos movimentos, bem como o nome do prestador são os mesmos retornados na API.
O valor total dos movimentos desta categoria também está correto, conforme dados visualizados na tela de detalhes de cada movimento:
1º movimento = R$ 0,71
2º movimento= R$ 0,71
Total = R$ 1,42
Os procedimentos retornados com a categoria 'EXAMES/TERAPIA' também foram corretamente grupados, conforme transação 2 e 3002:
Podemos observar ainda que o código, nome e data de realização dos movimentos, bem como o nome do prestador são os mesmos retornados na API.
O valor total dos movimentos desta categoria também está correto, conforme dados visualizados na tela de detalhes de cada movimento:
1º movimento = R$ 0,35
2º movimento= R$ 0,73
3º movimento= R$ 0,00
4º movimento= R$ 0,00
Total = R$ 1,08
Ao detalhar o movimento pode ser verificado o valor faturado:
HTML |
---|
<!-- esconder o menu --> <style> div.theme-default .ia-splitter #main { margin-left: 0px; } .ia-fixed-sidebar, .ia-splitter-left { display: none; } #main { padding-left: 10px; padding-right: 10px; overflow-x: hidden; } .aui-header-primary .aui-nav, .aui-page-panel { margin-left: 0px !important; } .aui-header-primary .aui-nav { margin-left: 0px !important; } </style> |