Histórico da Página

CONTEÚDO

1. Visão Geral
   1. Rota
   2. JSON de entrada
   3. Manutenção de documentos - saveDocument
   4. Inclusão de glosas - addMovementManualRestriction
   5. Remoção de glosas - removeMovementManualRestriction
   6. Validação de glosas - validateMovementRestriction
   7. Remoção de documentos - removeDocumentsByInvoice
   8. Remoção de documentos - removeDocumentsById
   9. Consulta de documentos - getDocumentById
   10. Consulta de documentos - getDocumentByInvoice
   11. Json retornadoRetorno
2. Regras de Negócio Aplicadas
3. Como Validar as Informações
   
   1. Central de Movimentação de Guias TISS
      
   2. Consultar de Documento
4. Exemplo de Como Validar as Informações

01. VISÃO GERAL

Âncora
visao_geral visao_geral

O TOTVS Saúde Planos (Linha Datasul) oferece uma série de APIs para integração.

...

O método documentsMaintenance da API fornece a opção de modificar os dados do documento e incluir, alterar ou excluir movimentos do documento, seguindo as regras de negócio explicadas na sessão 2. Regras de Negócio Aplicadas.

Versão atual: v1.

a. Rota

Com a entrada em vigência da TISS 4, a v1 desta API foi depreciada e é mantida apenas para compatibilidade pois trata apenas documentos versão TISS 3.05.00 e anteriores.

Favor considerar a utilização da última versão desta API, que trata documentos de versões mais novas da TISS além de manter a compatibilidade com documentos TISS 3.05.00 e anteriores.

a. Rota

Âncora
Rota Rota

//hrc/<versao>/documentsMaintenance/

b.

...

saveDocument

Âncora
saveDocument saveDocument

...

c. Retorno

Quando o processo de modificar o documento e/ou movimentos for realizado com sucesso será retornado o código 200 e o json com a chave do documento.

Exemplo:

{
    "serieDocumento": "API",
    "transacao": 3002,
    "documentoSistema": 0,
    "unidadePrestadora": 120,
    "documento": 20,
    "unidade": 120
}

Quando ocorrer alguma inconsistência no processo será retornado o código 500 e um json com as ocorrências.

Os códigos de erro na mensagem principal padronizados conforme a codificação abaixo. Enquanto que os códigos de erro listados na tag details são gerados pelo sistema e podem ser consultados no programa Manutenção de Mensagens (TE0110K).

...

Exemplo:

{
    "message": "Ocorream inconsistencias no processamento da solicitacao.",
    "details": [
        {
            "message": "ID Movimento: 3",
            "detailedMessage": "Movimento incluido via pacote intercambio nao pode ser alterado.\n saveDocument - BOSAU-DOCUMENT-MAINTENANCE",
            "code": "9999",
            "type": "error"
        },
       {
            "message": "TAG 'acao' possui valor invalido: ",
            "detailedMessage": " saveDocument - BOSAU-DOCUMENT-MAINTENANCE",
            "code": "1838",
            "type": "error"
        },    

],
    "detailedMessage": "",
    "code": "109",
    "type": "error"
}

...

O processo irá permitirá alterar os campos que são passíveis de alteração na Central de Movimentações TISS (hrc.documents).

Restrições:

...

c. addMovementManualRestriction

Âncora
addMovementManualRestriction addMovementManualRestriction

d. removeMovementManualRestriction

Âncora
removeMovementManualRestriction removeMovementManualRestriction

e. validateMovementRestriction

Âncora
validateMovementRestriction validateMovementRestriction

f. removeDocumentsByInvoice

Âncora
removeDocumentsByInvoice removeDocumentsByInvoice

Permite remover documentos passando a chave de uma fatura. Para esta funcionalidade não temos Json de entrada, os dados são passados pela URL.

Unidade/UnidadePrestadora/PrestadorPrincipal/AnoFatura/SerieFatura/Fatura

Exemplo:

http://cxs-man-dts03:8280/api/hrc/v1/documentsMaintenance/remove/fat/120/970/970/2020/970/2000G

g. removeDocumentsById

Âncora
removeDocumentsById removeDocumentsById

Permite remover documentos passando a chave de um documento. Para esta funcionalidade o Json de entrada possui apenas o usuário, os dados são passados pela URL.

Unidade/UnidadePrestadora/Transacao/SerieDocumento/NumeroDocumento/SequenciaDocumento

Exemplo:

http://cxs-man-dts03:8280/api/hrc/v1/documentsMaintenance/remove/doc/120/120/2/LUIS/26062181/0

{
    "parametros": [
        {
            "nomeUsuario": "user"
        }
    ]
}

h. getDocumentById

Âncora
getDocumentById getDocumentById

Retorna um Json contendo todos os dados de um documento. Para esta funcionalidade não temos Json de entrada, os dados são passados pela URL.

Unidade/UnidadePrestadora/Transacao/SerieDocumento/NumeroDocumento/SequenciaDocumento

Exemplo:

http://cxs-man-dts03:8280/api/hrc/v1/documentsMaintenance/doc/120/120/2/MARV/300/0

i. getDocumentByInvoice

Âncora
getDocumentByInvoice getDocumentByInvoice

Retorna um Json contendo todos os dados de um documento. Para esta funcionalidade não temos Json de entrada, os dados são passados pela URL.

Unidade/UnidadePrestadora/PrestadorPrincipal/AnoFatura/SerieFatura/Fatura

Exemplo:

http://cxs-man-dts03:8280/api/hrc/v1/documentsMaintenance/fat/120/970/970/2020/970/2000G

j. Json retornado

Âncora
retornado retornado

Quando o processo de modificar o documento e/ou movimentos for realizado com sucesso será retornado o código 200 e o json com a chave do documento.

Exemplo:

{
    "total": 1,
    "items": [
        {
            "cdUnidadePrestadora": 120,
            "cdUnidade": 120,
            "nrDocOriginal": 30424,
            "nrSerieDocOriginal": "TISS",
            "mensagemDetalhada": "",
            "nrDocSistema": 1,
            "tipoRegistro": "SUCCESS",
            "cdTransacao": 2
        }
    ],
    "hasNext": false
}

Quando ocorrer alguma inconsistência no processo será retornado o código 400 ou 500 e um json com as ocorrências.

O código de erro na mensagem principal é padronizado conforme a codificação abaixo. Enquanto que os códigos de erro listados na tag details são gerados pelo sistema e podem ser consultados no programa Manutenção de Mensagens (TE0110K).

Exemplo:

{
    "message": "Erro ao comunicar com API do Sistema",
    "details": [
        {
            "message": "Manutencao nao permitida em movimentos que nao estejam com status de Auditoria!",
            "detailedMessage": "",
            "code": "1",
            "type": "error"
        }
    ],
    "detailedMessage": "Erro ao executar saveDocument - api/v1/documentsMaintenance",
    "code": "100",
    "type": "error"
}

02. REGRAS DE NEGÓCIO APLICADAS 

Âncora
regras_neg regras_neg

O processo permitirá alterar os campos que são passíveis de alteração na Central de Movimentações TISS (hrc.document). Deve ser sempre informado valor nos campos editáveis, caso contrário o sistema entenderá que o valor do campo é nulo.

Pacotes

• Os campos nr-processo e nr-sequencia dos movimentos nunca podem mudar. Eles são a chave para a vinculação dos movimentos entre o que esta no Json e o que esta na base. 
• No caso do documento possuir mais de um lançamento de pacotes idênticos(mesmo código, prestador, data e hora), o sistema entende que o mesmo movimento não pode repetir dentro do mesmo pacote. Identificando assim a existência de outro pacote idêntico(mesmo código, prestador, data e hora).