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 do Beneficiário tem por objetivo retornar o extrato de utilização do beneficiário, isto é, todos os procedimentos e insumos realizados pelo beneficiário em determinado período.
A API foi desenvolvida seguindo as definições disponibilizadas no Swagger da Unimed Brasil.
/Beneficiario/v1/Extrato.
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.
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": [
{
"nome": "Nome da categoria de agrupamento do extrato",
"valor": "Valor total da categoria de agrupamento do extrato",
"procedimentos": [
{
"procedimentoId": "Código do procedimento realizado",
"nomeProcedimento": "Nome do procedimento realizado",
"dtRealizacao": "Data de realização do procedimento em formato de exibição",
"nomePrestador": "Nome do prestador executante"
}
]
}
],
"DebugMessage": "string"
}
|
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:
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 01/2020, por exemplo, o intervalo de datas deverá ser 01/01/2020 a 31/01/2020):
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 API.
EXEMPLO DE UTILIZAÇÃO
Segue abaixo um exemplo prático de como pode ser realizada a validação da API.
Realizada uma requisição na API utilizando a carteira do beneficiário e período de acordo com os parâmetros visualizados abaixo:
A API retornou os seguintes dados:
{
"Result": 1,
"Data": [
{
"procedimentos": [
{
"procedimentoId": "10101012",
"dtRealizacao": "30/01/2020",
"nomePrestador": "PRESTADOR TESTE CHAMADO TIDMKI",
"nomeProcedimento": "CONSULTA EM CONSULTORIO"
},
{
"procedimentoId": "10101012",
"dtRealizacao": "30/01/2020",
"nomePrestador": "PRESTADOR TESTE CHAMADO TIDMKI",
"nomeProcedimento": "CONSULTA EM CONSULTORIO"
}
],
"valor": "R$ 1,42",
"nome": "CONSULTAS"
},
{
"procedimentos": [
{
"procedimentoId": "10101012",
"dtRealizacao": "31/01/2020",
"nomePrestador": "PRESTADOR",
"nomeProcedimento": "CONSULTA EM CONSULTORIO"
},
{
"procedimentoId": "10101012",
"dtRealizacao": "30/01/2020",
"nomePrestador": "PRESTADOR",
"nomeProcedimento": "CONSULTA EM CONSULTORIO"
},
{
"procedimentoId": "10101012",
"dtRealizacao": "30/01/2020",
"nomePrestador": "PRESTADOR",
"nomeProcedimento": "CONSULTA EM CONSULTORIO"
},
{
"procedimentoId": "10101039",
"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
<!-- 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>
|