01. DADOS GERAIS
| Produto: | TOTVS Saúde Planos |
|---|---|
| Linha de Produto: | Linha Datasul |
| Segmento: | Saúde |
| Módulo: | Planos - Linha Datasul - Atendimento ao Publico (HAT) |
| Função: | Autorização De Guias |
| País: | Brasil |
| Issue | DSAUGPSAUTOR-20525 |
02. SITUAÇÃO/REQUISITO
Este documento detalha as implementações realizadas no TOTVS Saúde Planos - Linha Datasul para conformidade com a Resolução Normativa ANS Nº 623.
03. SOLUÇÃO
Ao atualizar o patch do dia 21/07/2025 nas versões 12.1.2507.1, 12.1.2503.7 e 12.1.2411.12 é necessário que seja rodada SPP. O processo e detalhes estão abaixo na aba de Utilização da SPP.
Além disso, é necessário atualizar o hau.war disponibilizado através do documento: Pacote de atualização - RN 623.
Para negativas a nível de guia, foi incluído o campo Motivo de negativa complementar (com capacidade de 5000 caracteres) na Manutenção Motivo de Negativa - hcg.refusalReason:
Para negativas automáticas, foi incluído o campo Motivo de negativa complementar (com capacidade de 5000 caracteres) na Manutenção Glosa - hrc.restrictionCode:
Importante
Não há carga automática de informações nesses campos, sendo necessária manutenção por parte da operadora.
Ao realizar a negativa total de uma guia por meio da Auditoria Médica, será carregado automaticamente o campo Motivo de negativa complementar, conforme o motivo selecionado no cadastro.
Esse texto pode ser alterado manualmente na tela e, ao efetivar a negativa, o conteúdo informado será salvo na guia.
Da mesma forma, ao editar a quantidade autorizada de um movimento para um valor menor do que o solicitado, também será necessário informar um motivo de negativa. O texto correspondente poderá ser ajustado e, uma vez confirmado, será registrado na guia.
O motivo de negativa complementar salvo será considerado nas consultas realizadas pela API de autorizações.
Importante
Para que esses campos sejam apresentados, é necessário que o parâmetro Motivo da negação da Manutenção Tipos de Guias - hat.guideType esteja como 1 - Pede ou 2 - Obriga.
Ao realizar a negativa total de uma guia por meio do AT0110Z, será carregado automaticamente o campo Motivo de negativa complementar, conforme o motivo selecionado no cadastro.
Esse texto pode ser alterado manualmente na tela e, ao efetivar a negativa, o conteúdo informado será salvo na guia.
Os dados salvos na guia podem ser consultados através do F3 → Guia → Mot.Neg.:
Da mesma forma, ao editar a quantidade autorizada de um movimento para um valor menor do que o solicitado, também será necessário informar um motivo de negativa. O texto correspondente poderá ser ajustado e, uma vez confirmado, será registrado na guia.
Os dados salvos na guia podem ser consultados através do F5 - Detalhe → F6 - Dados de Negação:
O motivo de negativa complementar salvo na guia será considerado na consulta da API de autorizações.
Importante
Para que esses campos sejam apresentados, é necessário que o parâmetro Motivo da negação da Manutenção Tipos de Guias - hat.guideType esteja como 1 - Pede ou 2 - Obriga.
Ao negar uma guia automaticamente, sem passar por auditoria, será considerada a glosa do movimento.
Regra de auditoria para negar automaticamente:
Para esse caso será considerado o motivo complementar cadastrado na Manutenção de Glosa (hrc.restrictionCode):
Ao receber uma solicitação de autorização, a guia será negada imediatamente e o(s) movimento(s) glosado(s) com a glosa da regra:
O motivo de negativa complementar será salvo vinculado aos movimentos. Os dados salvos podem ser consultados através do F5 - Detalhe → F6 - Dados de Negação (Alteração disponível a partir do patch do dia 21/07/2025 nas versões 12.1.2507.1, 12.1.2503.7 e 12.1.2411.12) :
Como o motivo complementar está vinculado a glosa, não existe um código de motivo, dessa forma é exibido apenas o texto.
Glosa que não libera serviço: (Alteração liberada no patch do dia 01/09/2025 nas versões 12.1.2507.3, 12.1.2503.9 e 12.1.2411.14)
Ao receber uma guia de intercâmbio. Os movimentos da guia podem ser negados caso exista uma glosa e a mensagem de automação da mesma esteja para não liberar serviço.
Através da classe de erro parametrizada na mensagem será verificado a glosa e salvo o texto de motivo complementar parametrizado nela.
Na manutenção de guias (at0110z) é possível através do F5 - Detalhe → F6 - Dados de Negação visualizar o motivo de negativa complementar que foi salvo no movimento:
- Como o motivo complementar está vinculado a glosa, não existe um código de motivo, dessa forma é exibido apenas o texto.
- Quando houver mais de uma glosa, será salvo a primeira que tiver o motivo de negativa complementar.
Importante
Para que seja salvo o motivo de negativa da glosa manual, é necessário que o parâmetro Motivo da negação da Manutenção Tipos de Guias - hat.guideType esteja como 1 - Pede ou 2 - Obriga.
VISÃO GERAL
A API Autorizações por Período tem o objetivo de buscar e acompanhar as autorizações dando uma maior visibilidade para o cliente da situação da guia. Nessa API constarão os campos com o motivo da negativa para serem disponibilizados aos beneficiários, de acordo com as regras da RN.
FORMA DE CONSUMO DA API
Para utilização da API, deve-se informar a seguinte rota: http://<servidor>:<porta>/api/hat/v1/authorizationPeriods
Método HTTP: GET
Exemplo de rota completa: http://totvs-datasul:80/api/hat/v1/authorizationPeriods?dtInicio=30/04/2025&dtFim=13/05/2025
Autenticação:
- A autenticação para o consumo da API é feita por Basic Auth informando o usuário e senha respectivos do sistema.
Cabeçalho:
- No cabeçalho da requisição é possível informar parâmetros que servirão como filtro no consumo da API.
| Parâmetros | Descrição |
|---|---|
| x-carteira | Carteira do beneficiário |
| x-cpf | CPF do beneficiário |
Parâmetros para busca e consumo:
- Além dos parâmetros de filtro utilizados no cabeçalho da requisição é necessário a utilização dos parâmetros dtInicio e dtFim via path parameters.
| Parâmetros | Descrição |
|---|---|
| dtInicio | Data de inicial das solicitações de guias |
| dtFim | Data final da solicitações de guias |
REGRAS DE NEGÓCIO APLICADAS
- A API realiza as buscas através da carteira ou CPF do beneficiário e um intervalo inicial e final de datas.
- A partir das guias encontradas será retornado o histórico da situação de cada guia.
- É considerado todos os contratos da pessoa informada na requisição, seja um contrato ativo ou inativo.
Os Campos apresentados estão detalhados na tabela abaixo:
Campo Descrição Procedimentos Procedimentos que foram solicitados
- Outros campos relacionados ao campo procedimento:
Campo Relacionados Descrição QtSolicitada Quantidade do procedimento que foi solicitada Codigo Código do procedimento QtAutorizada Quantidade do procedimento que foi autorizada Status Status do Procedimento Nome Nome do Procedimento motivoNegativa Motivo negativa complementar - Motivo de negativa referente a glosa Status
Status da guia atualmente Medico Prestador solicitante Especialidade Especialidade do prestador Tipo Tipo da guia Histórico Histórico de Situação da Guia
- Outros campos relacionados ao campo Histórico:
Campo Relacionados Descrição DtEvento Data do Evento Status Status do Evento Senha Este campo não é utilizado DtSolicitacao Data de solicitação da guia DtValidadeSenha Data de validade da guia Guia Número da guia motivoNegativa Motivo negativa complementar - Informado ao negar a guia por completa
- A conversão da situação da guia é realizada conforme a tabela abaixo:
Status da Guia | Descrição no TOTVS | Descrição no APP |
|---|---|---|
1 | DIGITADA | DIGITADA |
2 | AUTORIZADA | AUTORIZADA |
3 | CANCELADA | CANCELADA |
4 | PROCESSADO PELO CONTAS | EM EXECUÇÃO |
5 | FECHADO | FECHADA |
6 | ORÇAMENTO | ORÇAMENTO |
7 | FATURADA | FATURADA |
8 | NEGADA | NEGADA |
9 | PENDENTE AUDITORIA | EM ANÁLISE |
10 | PENDENTE LIBERAÇÃO | EM ANÁLISE |
11 | PENDENTE LAUDO MÉDICO | EM ANÁLISE |
12 | PENDENTE JUSTIFICATIVA | EM ANÁLISE |
13 | PENDENTE PERICIA | EM ANÁLISE |
14 | AUTORIZADA PARCIAL | AUTORIZADA PARCIAL |
19 | EM AUDITORIA | EM ANÁLISE |
20 | GUIA EM ATENDIMENTO | EM ANÁLISE |
23 | EM PERICIA MÉDICA | EM ANÁLISE |
- Além da situação da guia, a API retorna a situação individual dos movimentos.
| Situação Guia | Descrição Situação | Situação Movimento |
|---|---|---|
| 1 | DIGITADA | DIGITADO |
| 2 | AUTORIZADA | AUTORIZADO Obs: Caso o procedimento conter a quantidade zerada o status do movimento será considerado NEGADO. |
| 3 | CANCELADA | CANCELADO |
| 4 | PROCESSADO PELO CONTAS | Se todas as quantidades do movimento já estiverem executadas pelo Contas, será considerado o status EXECUTADO. Obs: Caso o procedimento conter a quantidade zerada o status do movimento será considerado NEGADO. |
| 8 | NEGADA | NEGADO |
| 14 | AUTORIZADO PARCIAL | AUTORIZADA PARCIAL Obs: Caso o procedimento conter a quantidade zerada o status do movimento será considerado NEGADO. |
| Quando o procedimento não se enquadrar nas situação acima, será considerado o status EM ANALISE. | ||
COMO VALIDAR AS INFORMAÇÕES
Os resultados apresentados pela API podem ser validados e visualizados nos seguintes programas/relatórios:
Consulta Unificada de Pessoas (hvp.personInformation)
Pesquisa e Listagem das Guias
Ao acessar o programa na tela inicial está disponível a opção de Busca Avançada:
Através da Busca Avançada é possível pesquisar o beneficiário pelo CPF ou pela Carteira do Beneficiário:
Ao informar um dos campos e clicar em buscar será retornado os dados do beneficiário e habilitado a opção Autorização:
Ao clicar em Autorização abrirá uma tela onde é possível selecionar o intervalo inicial e final. Ao clicar em pesquisar será retornado uma lista com todas as guias do beneficiário no período determinado:
Situação das Guias
Ao realizar a pesquisa através do programa Consulta Unificada de Pessoas ficará disponibilizado a opção Autorizações no menu. Ao clicar nesta opção o programa permitirá visualizar as guias de atendimento que estão associados ao beneficiário. Nesta tela estará presente o status da guia através da coluna Situação.
Ao clicar no número da guia será aberta o programa Manutenção Autorização Guias AT0110Z onde é possível verificar os dados da guia e seu status. Esta tela é apenas para consulta.
Mais detalhes sobre o programa Consulta Unificada de Pessoas pode ser visto através da documentação: https://tdn.totvs.com/x/oHQxHQ.
Manutenção Autorização Guias (AT0110Z)
Situação das Guias
Ao clicar em Autorização e pesquisar uma guia será exibido os detalhes e disponibilizado a opção F8 - Infor. Adic:
Ao apertar F8 aparecerá a opção Mov AT:
Ao clicar nessa opção será exibida um filtro para selecionar as situações das guias. No caso deste exemplo serão retornadas as guias com as situações de 1- Digitada até 23 - Em Pericia:
Após a escolha serão exibidas todas as guias do beneficiário com sua situação:
Histórico das Guias
Ao clicar em Autorização e pesquisar uma guia será exibido os detalhes e disponibilizado a opção F3 - Inf. Guia:
Ao apertar F3 irá aparecer a opção Guia:
Ao apertar na opção Guia irá aparecer uma dela com as informações sobre a guia e a opção Histórico:
Ao selecionar a opção será exibido uma tela com o histórico da situação da guia contendo todos os status e descrições que a guia teve:
Será exibido também a data de atualização de cada status:
Mais detalhes sobre o programa Manutenção Autorização Guias pode ser visto através da documentação: https://tdn.totvs.com/x/CfhYDQ
EXEMPLO DE COMO VALIDAR AS INFORMAÇÕES
Exemplo de como pode ser realizada a validação da Listagem e Busca de Guias, explicada na sessão 3. Como Validar as Informações, que utiliza o programa Consulta Unificada de Pessoas (hvp.personInformation).
Para isso, foi realizada uma requisição na API utilizando a carteira do beneficiário, a data inicial e final do período desejado. Para uma melhor visualização foi utilizada a mesma data inicial e final para retornar apenas as guias de um dia, neste caso do dia 01/07/2020. Os parâmetros utilizados podem ser visualizados abaixo:
A API retornou os seguintes dados:
Pode-se observar que o retorno contém 3 guias: 202500001977, 202500001979 e 202500001992.
No programa Consulta Unificada de Pessoas foram utilizados os mesmos parâmetros da requisição da API, ou seja, a carteira do beneficiário, data inicial e final. O resultado pode ser visto abaixo:
Observando o retorno da API e da Consulta Unificada de Pessoas vemos que as guias retornadas e seus dados são os mesmos.
VISÃO GERAL
A funcionalidade da API Autorizações do Beneficiário por Período foi aprimorada, passando a disponibilizar, no campo "Anexo", a carta de negativa nos casos em que esta se aplica.
FORMA DE CONSUMO DA API
Para utilização da API, deve-se informar a seguinte rota: http://<servidor>:<porta>/api/appUnimedBrasil/Beneficiario/v1/AutorizacoesPeriodo
Método HTTP: GET
Exemplo de rota completa: http://totvs-datasul:80/api/appUnimedBrasil/Beneficiario/v1/AutorizacoesPeriodo?dtInicio=30/04/2025&dtFim=13/05/2025
Autenticação:
- A autenticação para o consumo da API é feita por Basic Auth informando o usuário e senha respectivos do sistema.
Cabeçalho:
- No cabeçalho da requisição é possível informar parâmetros que servirão como filtro no consumo da API.
| Parâmetros | Descrição |
|---|---|
| x-carteira | Carteira do beneficiário |
| x-cpf | CPF do beneficiário |
Parâmetros para busca e consumo:
- Além dos parâmetros de filtro utilizados no cabeçalho da requisição é necessário a utilização dos parâmetros dtInicio e dtFim via path parameters.
| Parâmetros | Descrição |
|---|---|
| dtInicio | Data de inicial das solicitações de guias |
| dtFim | Data final da solicitações de guias |
Para informações mais detalhadas, incluindo as regras de negócio aplicadas, orientações sobre validação de dados e exemplos de uso, consulte a documentação da API Autorizações do Beneficiário por Período.
Na impressão da carta de negativa, foi utilizado o recurso do SmartView, com a disponibilização de um layout padrão que pode ser customizado conforme a necessidade do cliente. A documentação completa da integração está disponível em: Smart View linha Datasul - Relatórios e Análises Integradas.
Com o SmartView devidamente configurado, devem ser realizados os passos para a utilização da impressão:
1 - Importação de menu:
Na tela Importação Menu Datasul (MEN706AA), importar o arquivo men_hac.d.
Deverão ser criados os registros svRefusalLetter e rpRefusalLetter:
2 - Importação de layout:
Para esse processo é necessário estar logado com o usuário administrador do SmartView (definido nas Propriedades da integração → Usuário Administrador).
Na tela Importação Layout SmartView (html.fwk-smartview-layout) localizar o registro rpRefusalLetter e realizar a importação (o recurso hsv/hat/report/rpRefusalLetter.treports deve estar disponível no propath).
A partir desse momento, a impressão estará disponível para utilização via sistema.
Em caso de customização do layout deve ser realizada a exportação (Exportação/Importação de Relatórios) e substituir a exportação no recurso hsv/hat/report/rpRefusalLetter.treports do propath pelo novo layout.
Após isso é necessário ir à tela de Importação Layout SmartView e realizar a atualização:
AT0110Z
Na Manutenção Autorização Guias (at0110z) foi incluída a opção "3 - Carta de negativa" no botão "Relatório":
Ao selecioná-la, deverá ser informada a guia a ser impressa a carta de negativa. A guia informada deve estar totalmente negada ou possuir algum movimento que tenha sido negado.
Após informar a guia, será realizada a impressão da carta e o arquivo enviado para a Central de documentos do usuário:
Campos disponíveis no Smarview para alteração do layout:
| Campo | Descrição | Data de Liberação |
|---|---|---|
| dt-geracao | Data da gerção da carta de negativa | Liberado no patch do dia 30/06/2025 nas versões 12.1.2503.6, 12.1.2411.11 e 12.1.2407.17 (antecipação via TDN) |
| nm-beneficiario | Nome do beneficiário | |
| nr-carteira | Carteira do beneficiário | |
| ds-assunto | Assunto da carta | |
| nr-protocolo | Número do protocolo | |
| nr-guia-atend | Número da guia de atendimento | |
| ds-motivo-nega | Motivo complementar da negativa da guia | |
| cd-motivo-nega | Código do motivo complementar da negativa | Liberado no patch do dia 11/08/2025 nas versões 12.1.2507.2, 12.1.2503.8 e 12.1.2411.13 |
| cd-plano-ans | Código do plano ANS do beneficiário | |
| ds-plano-ans | Descrição do plano ANS do beneficiário | |
| in-tipo-regulamentacao | Tipo de regulamentação do contrato | |
| nm-contratante | Nome do contratante do plano | |
| dt-inicio-termo | Data de início do termo | |
| cd-ibge | Código IBGE | |
| nm-cidade-ibge | Nome da cidade do IBGE | |
| cd-uf-ibge | UF do IBGE | |
| dt-negativa | Data da negativa da guia | |
| nm-solicitante | Nome do pretador solicitante | |
| ds-sigla-conselho | Sigla do conselho do prestador solicitante | |
| nr-conselho | Número do conselho do prestador solicitante | |
| uf-solicitante | UF do prestador solicitante | |
| dt-emissao-guia | Data da emissão da guia | |
| nm-social-benef | Nome social do beneficiário | |
| cr-solicitacao | Caráter do atendimento | |
| ds-status-guia | Status da guia | |
| Procedimento | ||
| cd-procedimento | Código do procedimento | Liberado no patch do dia 30/06/2025 nas versões 12.1.2503.6, 12.1.2411.11 e 12.1.2407.17 (antecipação via TDN) |
| ds-procedimento | Descrição do procedimento | |
| ds-motivo-nega | Motivo complementar da negativa do procedimento | |
| cd-motivo-nega | Código do motivo de negativa | Liberado no patch do dia 11/08/2025 nas versões 12.1.2507.2, 12.1.2503.8 e 12.1.2411.13 |
| qt-solicitada | Quantidade solicitade | |
| qt-autorizada | Quantidade autorizada | |
| cd-glosa-nega | Código da glosa da negativa | |
| Insumo | ||
| cd-insumo | Código do insumo | Liberado no patch do dia 30/06/2025 nas versões 12.1.2503.6, 12.1.2411.11 e 12.1.2407.17 (antecipação via TDN) |
| ds-insumo | Descrição do insumo | |
| ds-motivo-nega | Descrição do motivo de negativa | |
| cd-motivo-nega | Código do motivo de negativa | Liberado no patch do dia 11/08/2025 nas versões 12.1.2507.2, 12.1.2503.8 e 12.1.2411.13 |
| qt-solicitada | Quantidade solicitada | |
| cd-glosa-nega | Código da glosa da negativa | |
Quando o serviço for negado por glosa é populado o campo cd-glosa-nega, quando for negado manualmente por motivo de negativa é populado o cd-motivo-nega.
No patch do dia 21/07/2025 nas versões 12.1.2507.1, 12.1.2503.7 e 12.1.2411.12 foi liberado uma SPP para ajustar o banco.
Nessa SPP será feito a carga dos novos campos do código e descrição do motivo de negativa dos movimentos, pegando eles da tabela temporária utilizada e salvando na tabela do movimento.
A SPP só deve ser rodada depois de atualizar o patch do dia 21/04/2025, onde existe a alteração de delta e criação dos campos em banco. Após atualizado e rodar uma vez, não é necessário mais realizar esse processo.
Para realizar o ajuste, no TOTVS, acesse o programa Rodar Programa Progress - TEEXCPRO e informe o programa spp-ajuste-RN623.r
Ao clicar em Executar será apresentada uma mensagem no termino do processo:
E pode ser gerado dois arquivos no caminho C:\temp:
- param-geral-ajutados: CSV contendo todos os dados que foram migrados da tabela temporária.
- param-geral-nao-ajutados: CSV contendo todos os dados que não foram possível de ser migrados.
Esses arquivos só serão criados caso haja dados para serem migrados.
Para surprir a necessidade dos beneficiários que tivem guias guias negadas o direto de solicitar uma reanálise junto a operado foi criado um novo menu.
O novo menu Reanálise de guias (hat.guideReanalysis) permite:
Visualizar as guias negadas ou parcialmente autorizadas que são passíveis de reanálise.
Executar a reanálise diretamente pelo sistema.
Consultar a listagem das guias já reanalisadas.
Para mais detalhes de implatação e utilização acessar a documentação: https://tdn.totvs.com/x/P9FqP.
A liberação oficial da correção ocorrerá no patch do dia 17/11/2024 nas versões 12.1.2511.1, 12.1.2507.7 e 12.1.2503.13
04. INFORMAÇÕES ADICIONAIS
Pacote de atualização - RN 623
API Autorizações do Beneficiário por Período

















































