API de Recursos de Glosa

CONTEÚDO

1. Visão Geral
   1. Rota
   2. Listagem de lotes de recurso de glosa - getBatchsByFilter
   3. Consulta detalhes do lote de recurso de glosa - getBatchById
   4. Listagem de movimentos do lote - getMovementsByBatch
   5. Listagem dos anexos de recurso de glosa TISS - getFileTiss
   6. Consulta de conteúdo de anexo de recurso de glosa TISS - getFileTissById
   7. Listagem dos anexos de recurso de glosa Foundation - getFileFoundation
   8. Atualização de análise do recurso e justificativa da operadora - updateMovements
   9. Finalizar análise do Recurso de Glosa - releaseAppeal
2. Regras de Negócio Aplicadas
3. Como Validar as Informações
   
   1. Central de Movimentação de Guias TISS
      
4. Exemplo de 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.

A  API de Recursos de Glosa tem o objetivo de gerenciar os Recursos de glosa solicitados pelo prestador.

a. Rota

/portprest/<versao>/restrictionsAppeal/

b. Listagem de lotes de recurso de glosa

Retorna um Json contendo todos os lotes de recurso de glosa de acordo com o filtro informado. Para esta funcionalidade não temos Json de entrada, os filtros são passados via queryParams.

Após a URL são enviados os filtros desejados via queryParams, sendo eles:

Exemplo:

http://es-datasul.sp01.local:8080/api/portprest/v1/restrictionsAppeal/?status=AL,RE&healthInsurerProviderInitial=120&healthInsurerProviderFinal=120&providerInitial=110005&providerFinal=110005&providerGroupInitial=0&providerGroupFinal=99&protocolInitial=00&protocolFinal=99999999999&receiptDateInitial=2024-10-01&receiptDateFinal=2024-10-11

Retorno:

{
    "total": 1,
    "hasNext": false,
    "items": [
        {     

          "batchCode": 31,
          "healthInsurerProvider": 120,
          "receiptDate": "2024-10-14",
          "periodCode": 9,
          "sequence": 916,
          "protocol": "31916",
          "sequenceGuideBatch": 910,
          "periodYear": 2024,
          "provider": 110005,
          "providerGuideBatchCode": "07102024002",
          "guideBatch": 31,
          "guideBatchProtocol": "31910",
          "providerBatchCode": "",
          "status": "AL"
        }

    ]
}

Campos do retorno:

Importante:

Os campos descritos seguir, que são devolvidos na resposta à consulta de lotes, referem-se à chave primária do lote de recurso de glosa. Esses campos serão referenciados em outros endpoints descritos neste documento:

• • healthInsurerProvider
  • provider
  • batchCode
  • sequence

Os campos a seguir referem-se à chave primária do lote de guias que originou o recurso de glosa:

• • healthInsurerProvider
  • provider
  • guideBatch
  • sequenceGuideBatch

c. Consulta detalhes do lote de recurso de glosa

Permite buscar mais detalhes de um lote de recurso de glosa, como os valores totais do lote. Para esta funcionalidade o Json de entrada não é necessário, os dados são passados pela URL.

detail/healthInsurerProvider/provider/batchCode/sequence

Os campos healthInsurerProvider, provider, batchCode e sequence referem-se à chave primária do lote de recurso de glosa. Esses dados são retornados na listagem dos lotes, descritos no item 'B' deste documento.

Exemplo:

http://es-datasul.sp01.local:8080/api/portprest/v1/restrictionsAppeal/detail/120/110005/31/826

Retorno:

{
    "period": "2018/006",
    "totalValueAccepted": 80.0,
    "batchCode": 31,
    "healthInsurerProvider": 120,
    "receiptDate": "2021-02-19",
    "totalValueGuideBatch": 400.0,
    "totalValueAppealed": 100.0,
    "totalValueRestricted": 200.0,
    "sequence": 826,
    "protocol": "00000031826",
    "sequenceGuideBatch": 682,
    "provider": 110005,
    "guideBatch": 10,
    "guideBatchProtocol": "00000010682",
    "status": "AL"
}

Campos do retorno:

d. Listagem de movimentos do lote

Retorna um Json contendo todos os movimentos de recurso de glosa do lote informado. Para esta funcionalidade não temos Json de entrada, os filtros são passados pela URL.

movements/healthInsurerProvider/provider/batchCode/sequence

Os campos healthInsurerProvider, provider, batchCode e sequence referem-se à chave primária do lote de recurso de glosa. Esses dados são retornados na listagem dos lotes, descritos no item 'B' deste documento.

Após a chave do lote, pode ser informando o expandable 'restrictions' caso desejado, com ele serão retornadas as glosas inseridas em cada movimento.

Exemplo:

http://es-datasul.sp01.local:8080/dts/datasul-rest/resources/prg/portprest/v1/restrictionsAppeal/movements/120/110005/31/826?expand=restrictions

Retorno:

{
    "total": 1,
    "hasNext": false,
    "items": [
        {

         "realizationDate": "2018-07-23",
         "chargedValue": 189.0,
         "healthInsurerProvider": 120,
         "processNumber": 1,
         "typingSequence": 1,
         "beneficiaryCardNumber": 1000000084,
         "quantityCharged": 1,
         "analysedMovement": true,
         "movementType": "P",
         "appealedValue": 99.1,
         "acceptedValue": 85.0,
         "supplyType": 0,
         "mainHealthInsurer": 120,
         "mainProvider": 110005,
         "id": 1,
         "providerJustification": "teste",
         "quantityRestricted": 1,
         "originalDocument": 46006,
         "healthInsurer": 120,
         "healthInsurerJustification": "justificativa",
         "restrictions": [
           {
             "codeTiss": 1014,
             "code": 6,
             "restrictionCode": 6,
             "mainRestriction": true,
             "description": "BENEFICIARIO COM DATA DE EXCLUSAO "
           }
         ],
         "mainRestrictionCode": 6,
         "healthInsurerCard": 120,
         "periodCode": 9,
         "yearAttendanceGuide": 0,
         "attendanceGuide": 0,
         "tussTableType": "22",
         "periodYear": 2024,
         "mainRestriction": 1014,
         "service": "10101039",
         "serie": "XML",
         "systemDocument": 0,
         "paidValue": 0.0,
         "mainRestrictionDescription": "BENEFICIARIO COM DATA DE EXCLUSAO ",
         "restrictedValue": 99.1,
         "providerGuide": "201900000474",
         "transaction": 3002
        },
    ]
}

Campos do retorno:

Importante

Os campos a seguir referem-se à chave primária dos movimentos:

• • healthInsurer

  • healthInsurerProvider

  • transaction

  • serie

  • originalDocument

  • systemDocument

  • processNumber

  • typingSequence

e. Listagem dos anexos do recurso de glosa TISS

A partir de dados do lote informado retorna o anexos relacionados. Possui as seguintes opções de consulta:

• Por lote: /file/tiss/batch
• Por guia/documento: /file/tiss/document
• Por movimento: /file/tiss/movement

Após a URL são enviados os filtros desejados via queryParams de acordo com o tipo de consulta realizado, sendo eles:

Por lote:

Exemplo:
http://es-datasul.sp01.local:8080/dts/datasul-rest/resources/prg/portprest/v1/restrictionsAppeal/file/tiss/batch?healthInsurer=120&provider=110005&batch=07102024005

Por guia/documento:

Possui 3 opções de consulta:

Exemplo:
http://es-datasul.sp01.local:8080/dts/datasul-rest/resources/prg/portprest/v1/restrictionsAppeal/file/tiss/document?healthInsurer=120&provider=110005&healthInsurerProvider=120&transaction=3002&serie=XML&originalDocument=46104&systemDocument=0

Exemplo:
http://es-datasul.sp01.local:8080/dts/datasul-rest/resources/prg/portprest/v1/restrictionsAppeal/file/tiss/document?healthInsurer=120&provider=110005&batch=07102024005&providerGuide=201900000474

Exemplo:
http://es-datasul.sp01.local:8080/dts/datasul-rest/resources/prg/portprest/v1/restrictionsAppeal/file/tiss/document?healthInsurer=120&provider=110005&batch=07102024005&healthInsurerGuide=0

Por movimento:

Possui 2 opções de consulta:

Exemplo: 
http://es-datasul.sp01.local:8080/dts/datasul-rest/resources/prg/portprest/v1/restrictionsAppeal/file/tiss/movement?healthInsurer=120&provider=110005&healthInsurerProvider=120&transaction=3002&serie=XML&originalDocument=46105&systemDocument=0&processNumber=1&typingSequence=1

Exemplo: 
http://es-datasul.sp01.local:8080/dts/datasul-rest/resources/prg/portprest/v1/restrictionsAppeal/file/tiss/movement?healthInsurer=120&provider=110005&batch=07102024005&providerGuide=201900000475&sequence=1

Retorno:

{
    "total": 1,
    "hasNext": false,
    "items": [
        {
            "sequence": 0,
            "fileName": "202429101704_Comprovante de elegibilidade.jpeg",
            "protocol": "31929",
            "healthInsurer": 120,
            "provider": 110005,
            "document": "202429101704",
            "batch": "07102024005",
            "attachmentId": 516,
            "documentFormat": ".jpeg",
            "healthInsurerGuide": "",
            "providerGuide": ""
        }
    ]
}

Campos do retorno:

f. Consulta de conteúdo de anexo de recurso de glosa TISS

Permite buscar o conteúdo de um anexo de recurso de glosa TISS. Para esta funcionalidade o Json de entrada não é necessário, os dados são passados pela URL.

file/tiss/attachmentId

O campo attachmentId refere-se à chave primária do anexo de recurso de glosa. Esse dado é retornado na listagem dos anexos de recurso de glosa TISS descrita no item 'G' deste documento.

Exemplo:
http://es-datasul.sp01.local:8080/dts/datasul-rest/resources/prg/portprest/v1/restrictionsAppeal/file/tiss/520

Retorno:

{
    "fileName": "202411010958_Comprovante de elegibilidade.jpeg",
    "content": "UEsDBBQACAgIAFtDA1cAAAAAAAAAAAAAAAAuAAAAMjAyMzAwMDAwMDAzX0NvbXByb3ZhbnRlIGRlIGVsZWdpYmlsaWRhZGUuanBlZ+y7d1RT7/cuGKWpgPQuRbpUlSZdVLqAAtKLCkiJIdIDBFCU3gQpCgLSO/c8..."
}

Campos do retorno:

g. Listagem dos anexos do recurso de glosa Foundation

A partir de dados do lote/guia/movimento retorna o anexo relacionado.

/file/foundation/unidade/unidadeprestadora/transacao/serie/documento/documentosistema/processo/seqdigitacao

Exemplo:

http://es-datasul.sp01.local:8080/dts/datasul-rest/resources/prg/portprest/v1/restrictionsAppeal/file/foundation/120/120/1/1/1/34/1/1

Retorno:

{
    "fileName": "202300000003_Comprovante de elegibilidade.zip",
    "content": "UEsDBBQACAgIAFtDA1cAAAAAAAAAAAAAAAAuAAAAMjAyMzAwMDAwMDAzX0NvbXByb3ZhbnRlIGRlIGVsZWdpYmlsaWRhZGUuanBlZ+y7d1RT7/cuGKWpgPQuRbpUlSZdVLqAAtKLCkiJIdIDBFCU3gQpCgLSO/kgJZSQKFVARAg11ITeE2qAkAyfu2burPne36w7Za35a/Y5e62sdd5z9vuc8+797CfJoUxSFgDMRnqGeoBLly4Bnl9sAMo04CGA6vLlf/cLo77Yaa7Q0FBT01yjo6O9wnCNgYH+Gj0943VWZsbrLNfp6Zk5mVnY2Dk4OBiYuLg52blZ2TnY/73IJaqLc6hprtLQXGVnpGdk/79tlB8AliuXHC6JUF0SBlxmuUTFconSBRAEAC7RXPpvBvhf7dLliznS0l25eo3+YkAjM+DyJSqqy9RU/8764mjYxXEANQsN6807OrRsT1/..."

}

Campos do retorno:

h. Atualização de análise do recurso e justificativa da operadora

Permite que a operadora faça a análise de um ou mais movimentos do lote informado na URL.

update/movements/healthInsurerProvider/provider/batchCode/sequence

Exemplo:

http://es-datasul.sp01.local:8080/dts/datasul-rest/resources/prg/portprest/v1/restrictionsAppeal/update/movements/120/110005/31/919

No corpo da requisição é enviado um array na propriedade "movements" contendo os movimentos a serem atualizados.

O json do movimento enviado é semelhante ao retornado na propriedade "items" da API método Listagem de movimentos do lote - getMovementsByBatch.

        Para a atualização do movimento, é obrigatório o envio dos campos a seguir:

Importante

Os campos a seguir referem-se à chave primária dos movimentos:

• • healthInsurer

  • healthInsurerProvider

  • transaction

  • serie

  • originalDocument

  • systemDocument

  • processNumber

  • typingSequence

Exemplo:

Retorno: 

Caso a atualização ocorra com sucesso, será retornado um json semelhante ao enviado no corpo da requisição.

i. Finalizar análise do Recurso de Glosa

Permite que a operadora finalize a análise do lote de Recurso de Glosa informado na URL.

releaseappeal/healthInsurerProvider/provider/batchCode/sequence

Exemplo:

http://es-datasul.sp01.local:8080/dts/datasul-rest/resources/prg/portprest/v1/restrictionsAppeal/releaseappeal/120/110005/31/919

No corpo da requisição é enviado um json contendo as seguintes configurações da liberação:

Exemplo:

Retorno: 

Caso a análise ocorra com sucesso, será retornado um payload vazio com status 200.

02. REGRAS DE NEGÓCIO APLICADAS 

03. COMO VALIDAR AS INFORMAÇÕES

Os resultados apresentados pela API podem ser validados e visualizados nos seguintes programas/relatórios:

Central de Movimentação de Guias Tiss (hrc.document)

Localize o lote de recurso de glosa que deseja consultar. 

Ao acessar o programa na tela inicial está disponível a opção de Busca Avançada:

Através da Busca Avançada, ao informar o prestador, é possível pesquisar o lote de importação:

Ao informar alguns campos e clicar em buscar serão retornados os documentos/movimentos encontrados para o lote informado.