Histórico da Página
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 foi desenvolvida seguindo as definições disponibilizadas no Swagger da Unimed Brasil.
...
.
...
a. Rota
/Beneficiario/v1/Extrato.
b. Parâmetros de Entrada
Para esta API devem ser informados os cabeçalhos abaixo no header da requisição:
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árioDevem ser informados, obrigatoriamente, o CPF e/ou carteira do beneficiário e o período.
b. Retorno
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": [
{
"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"
}
|
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 apenas caso o serviço tenha cobrança em Custo Operacional ou então possua Participação.
- Para classificar os serviços, o programa irá se valer do parâmetro da Manutenção da Transação X, que poderá estar classificado como.....
- Todos os insumos serão agrupados como Outras Despesas, etc, etc.
03. EXEMPLO DE UTILIZAÇÃO
- 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 com divisão de honorários também serão listados apenas uma vez, considerando o movimento do prestador pessoa jurídica.
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 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 dadosSe a requisição ocorrer no dia 01/07/2020, por exemplo, então a API irá retornar:
| Bloco de código |
|---|
{
"Result": 1,
"Data": [
{
"procedimentos": [
{
"id "procedimentoId": "10101012",
"dtRealizacao": "0730/01/2020",
"nome "nomePrestador": "PRESTADOR TESTE CHAMADO TIDMKI",
"nomeProcedimento": "07/2020CONSULTA EM CONSULTORIO"
},
{
"idprocedimentoId": "06/202010101012",
"nomedtRealizacao": "0630/01/2020",
},
{
"idnomePrestador": "05/2020PRESTADOR TESTE CHAMADO TIDMKI",
"nomenomeProcedimento": "05/2020CONSULTA EM CONSULTORIO"
}
],
{
"idvalor": "04/2020R$ 1,42",
"nome": "04/2020CONSULTAS"
},
{
{
"procedimentos": [
{
"idprocedimentoId": "03/202010101012",
"nomedtRealizacao": "0331/01/2020",
},
{
"idnomePrestador": "02/2020PRESTADOR",
"nomenomeProcedimento": "02/2020CONSULTA EM CONSULTORIO"
},
{
"idprocedimentoId": "01/202010101012",
"nomedtRealizacao": "30/01/2020",
}"nomePrestador": "PRESTADOR",
{
"idnomeProcedimento": "12/2019",CONSULTA EM CONSULTORIO"
},
{
"nomeprocedimentoId": "12/201910101012",
} "dtRealizacao": "30/01/2020",
{
"idnomePrestador": "11/2019PRESTADOR",
"nomenomeProcedimento": "11/2019CONSULTA EM CONSULTORIO"
},
{
"idprocedimentoId": "10/201910101039",
"nomedtRealizacao": "1007/01/20192020",
},
{
"idnomePrestador": "09/2019PRESTADOR",
"nomenomeProcedimento": "09/2019CONSULTA EM PRONTO SOCORRO"
}
{ ],
"idvalor": "R$ 1,08/2019",
"nome": "08EXAMES/2019TERAPIAS"
}
],
"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
| 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>
|


















