API de integração com o Revisão de Contas (Reembolso)

CONTEÚDO

Visão Geral
1. Rota
2. Manutenção de documentos - saveDocument
3. Remoção de documentos - removeDocumentsById
4. Consulta de documentos - getDocumentById
5. Json retornado

01. VISÃO GERAL

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

A API Manutenção de Documentos de Reembolso tem o objetivo de consultar, criar, atualizar e eliminar documentos de reembolso do Revisão de Contas.

O método refundDocumentsMaintenance 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.

a. Rota

/hrc/<versao>/refundDocumentsMaintenance/

A transação enviada no campo cdTransacao deve estar marcada como transação de reembolso (rc0110f).

b. saveDocument

Na inclusão do documento os campos cdUnidade e nrDocOriginal devem ser enviados com o valor 0.

Campo	Descrição	Tipo dado	Máscara	Obrigatório	Permite definir na alteração	Permite definir na inclusão
cdUnidade	Código da unidade	inteiro		Sim	Não	Não
cdUnidadePrestadora	Código da unidade prestadora	inteiro		Sim	Não	Sim
cdTransacao	Código da transação	inteiro		Sim	Não	Sim
nrSerieDocOriginal	Nome da serie do documento	caracter	x(04)	Sim	Não	Sim
nrDocOriginal	Código do documento	inteiro		Sim	Não	Não
nrDocSistema	Sequencia do documento no sistema	inteiro		Sim	Não	Não
anoPeriodo	Ano do período de movimentação do Revisão de Contas	inteiro		Sim	Sim	Sim
nrPeriodo	Período de movimentação do Revisão de Contas	inteiro		Sim	Sim	Sim
anoGuiaAtendimento	Ano da guia de autorização	inteiro		Somente caso Ação sobre Gua for = obriga	Sim	Sim
nrGuiaAtendimento	Número da guia de autorização	inteiro		Somente caso Ação sobre Gua for = obriga	Sim	Sim
nrGuiaPrestador	Código da guia do prestador	caracter		Não	Sim	Sim
cdUnidadeAnt	Unidade do documento principal	inteiro		Não	Sim	Sim
cdUnidadePrestadoraAnt	Unidade Prestadora do documento principal	inteiro		Não	Sim	Sim
cdTransacaoAnt	Transação do documento principal	inteiro		Não	Sim	Sim
nrSerieDocOriginalAnt	Série do documento principal	caracter	x(04)	Não	Sim	Sim
nrDocOriginalAnt	Número do documento principal	inteiro		Não	Sim	Sim
nrDocSistemaAnt	Numero de sistema do documento principal	inteiro		Não	Sim	Sim
dtEmissao	Data de emissão do documento	data	aaaa-mm-dd	Sim	Sim	Sim
dtRealizacao	Data de realização*	data	aaaa-mm-dd	Somente caso Data Realizacao Unica (rc0110f)	Sim	Sim
hrRealizacao	Hora inicial de realização*	caracter	99:99	Somente caso Data Realizacao Unica (rc0110f)	Sim	Sim
cdUnidadeSolicitante	Unidade do Prestador Solicitante	inteiro		Sim	Sim	Sim
cdPrestadorSolicitante	Código do Prestador Solicitante	inteiro		Sim	Sim	Sim
anoGuiaOrigem	Ano da Guia Origem	inteiro		Não	Sim	Sim
nrGuiaOrigem	Número da Guia Origem	inteiro		Não	Sim	Sim
dtSolicitacaoOrigem	Data de solicitação da Guia Origem	data	aaaa-mm-dd	Não	Sim	Sim
dtAutorizacaoOrigem	Data de Autorização da Guia Origem	data	aaaa-mm-dd	Não	Sim	Sim
cdVinculoSolicitante	Vinculo do prestador solicitante	caracter		Sim	Sim	Sim
cdEspecialidSolicitante	Especialidade do prestador solicitante	caracter		Sim	Sim	Sim
cdCboSolicitante	CBO do prestador solicitante - Caso em branco a Central TISS preenche com o primeiro CBO válido para a especialidade informada	caracter		Sim	Sim	Sim
cdConselhoProfSolic	Conselho do profissional solicitante	caracter		Somente para Exames	Sim	Sim
nrConselhoProfSolic	Código do Conselho do profissional solicitante	caracter		Somente para Exames	Sim	Sim
ufConselhoProfSolic	UF Conselho do profissional solicitante	caracter		Somente para Exames	Sim	Sim
nmProfSol	Nome do profissional solicitante	caracter		Somente para Exames	Sim	Sim
cdLocalAtendimento	Local de atendimento (caso a transação esteja como "Pede local Atendimento'"= Sim, irá gravar a informação do campo Local Atendimento do cadastro. Se estiver como Não, não vai gravar o local.)	inteiro		Sim	Sim	Sim
cdClasseHospitalar	Classe Hospitalar (somente editável caso parametrizado no campo "Altera Class.Hosp." do cadastro da Transação)	inteiro		Somente se Altera Classe Hospitalar	Sim	Sim
caraterSolicitacao	Carater da Solicitação (E-Eletiva, U-Urgencia)	caracter		Somente para Internação e SPSADT	Sim	Sim
tpRegimInter	Regime de Internação (TISS Tab. 41)**	inteiro		Somente para Internação	Sim	Sim
cdFaturamento	Tipo de Faturamento (TISS Tab. 55)**	inteiro		Somente para Internação	Sim	Sim
dtInternacao	Data de Internação**	data	aaaa-mm-dd	Somente para Internação	Sim	Sim
dtAlta	Data de Alta**	data	aaaa-mm-dd	Somente para Internação	Sim	Sim
cdMotivoAlta	Motivo de Alta**	inteiro		Somente para Internação	Sim	Sim
hrInternacao	Hora da internação**	caracter	99:99	Somente para Internação	Sim	Sim
hrAlta	Hora da Alta**	caracter	99:99	Somente para Internação	Sim	Sim
tpInter	Tipo de Internação (TISS Tab. 57)**	inteiro		Somente para Internação	Sim	Sim
nmDeclNascViv a nmDeclNascViv5	Declaração de nascido vivo (campos até o 5)	caracter		Não	Sim	Sim
qtNascMortos	Quantidade de nascidos mortos	inteiro		Não	Sim	Sim
qtNascVivosTermo	Quantidade de nascidos vivos não prematuros	inteiro		Não	Sim	Sim
qtNascVivosPrem	Quantidade de nascidos vivos prematuros	inteiro		Não	Sim	Sim
cidObito1 a cidObito5	CID de óbito nascidos mortos (campos do 1 a 5)	caracter		Não	Sim	Sim
nrDeclaracaoObito1 a nrDeclaracaoObito5	Declaração de óbito nascidos mortos (campos 1 a 5)	caracter		Não	Sim	Sim
indAcidente	Indicador de acidente (TISS Tab.36)	inteiro		Não	Sim	Sim
tpConsulta	Tipo de Consulta (Transação de consulta - TISS Tab. 52)	inteiro		Somente para Consulta	Sim	Sim
tpAtend	Tipo de Atendimento (Transação de SADT - TISS Tab. 50)	inteiro		Somente para Exames	Sim	Sim
cdCid,cdCid2,cdCid3	CID do atendimento	caracter		Não	Sim	Sim
cdCidObito	CID do óbito**	caracter		Somente para Internação	Sim	Sim
nrDeclaracaoObito	Declaração de óbito**	caracter		Somente para Internação	Sim	Sim
dsIndClinica	Indicação Clínica Para as guias de reembolso e odontologicas, não é obrigatório. Obrigatório para todas as guias com tipo de atendimento, conforme parametrizado no cadastro hac.attendanceType.	caracter		Não	Sim	Sim
dsObservacao	Observação do documento	caracter		Não	Sim	Sim
anoFatura	Ano da fatura do prestador	inteiro		Não	Não	Sim
anoNDR	Ano da NDR do prestador	inteiro		Não	Não	Sim
nrSerieFatura	Série da fatura do prestador	caracter		Não	Não	Sim
nrSerieNDR	Série da NDR do prestador	caracter		Não	Não	Sim
nrFatura	Número da fatura do prestador	caracter		Não	Não	Sim
nrNDR	Número da NDR do prestador	caracter		Não	Não	Sim
nrLote	Número do lote	inteiro		Não	Não	Não
cdUnidadeCarteira	Código da unidade da carteira do beneficiário	inteiro		Sim	Não	Sim
cdCarteiraUsuario	Código da carteira do beneficiário	inteiro		Sim	Não	Sim
cdUnidadePrestPrincipal	Código da unidade do prestador principal	inteiro		Sim	Não	Sim
cdPrestadorPrincipal	Código do prestador principal	inteiro		Sim	Não	Sim
cdVinculoPrestPrincipal	Código do vinculo do prestador principal	inteiro		Não	Não	Sim
inStatusDocto	Status do documento (1- Pendente Análise de Glosa, 2- Pendente Liberação, 3- Liberado, 4- Pago, 5- Faturado, 6- Pago e Faturado, 7- Cancelado)	inteiro		Não	Não	Não
urlChave	Chave	caracter		Não	Não	Não
cdUnidCdPrestExec	Código da unidade e Prestador executante	caracter		Não	Não	Não
nmMedicoAuditor	Nome do Médico Auditor	caracter		Somente para Internação quando obriga médico auditor	Sim	Sim
cdCrmMedicoAuditor	CRM do Médico Auditor	caracter		Somente para Internação quando parametrizado para obrigar médico auditor	Sim	Sim
cdUfMedicoAuditor	UF do conselho do Médico Auditor	caracter		Somente para Internação quando parametrizado para obrigar médico auditor	Sim	Sim
nmEnfermAuditor	Nome do enfermeiro auditor	caracter		Somente para Internação quando parametrizado para obrigar enfermeiro auditor	Sim	Sim
cdCorenEnfermAuditor	COREN do enfermeiro auditor	caracter		Somente para Internação quando parametrizado para obrigar enfermeiro auditor	Sim	Sim
cdUfEnfermAuditor	UF conselho do enfermeiro auditor	caracter		Somente para Internação quando parametrizado para obrigar enfermeiro auditor	Sim	Sim
codLotePrestadorTiss	Código do lote do prestador	inteiro		Não	Não	Não
cdUnidadeImp	Código da unidade do Lote de Importação	inteiro		Não	Não	Não
cdPrestadorImp	Código do prestador do Lote de Importação	inteiro		Não	Não	Não
nrLoteImp	Número do Lote de Importação	inteiro		Não	Não	Não
nrSequenciaImp	Número da sequencia do Lote de Importação	inteiro		Não	Não	Não
logAtendimRN	Indica recém nascido, esta informação não é alterável, somente é possível informar o campo na inclusão do documento.	lógico		Somente para Internação	não	Sim
dtDigitacao	Data de digitação do documento	data	aaaa-mm-dd	Não	Não	Não
hrDigitacao	Hora de digitação do documento	caracter	hhmmss	Não	Não	Não
nmDeclObt	Nome declaração de óbito	caracter		Não	Não	Não
cdUnidadeReemb	Código da Unidade de reembolso	inteiro		Sim quando for alteração	Sim	Não
cdPrestadorReemb	Código do prestador de reembolso	inteiro		Sim quando for alteração	Sim	Não
tag: procedimentos	Acesse aqui os campos da TAG "procedimentos"				Sim	Sim
tag: insumos	Acesse aqui os campos da TAG "insumos"				Sim	Sim
tag: parametros campo: [nomeUsuario]	Nome de usuário que está manipulando o(s) registro(s).	caracter			Sim	Sim

Create

Na inclusão do documento os campos cdUnidade e nrDocOriginal devem ser enviados com o valor 0.

Exemplo JSON entrada - saveDocument

{
    "documentos": [{
            "anoFatura": 0,
            "anoGuiaAtendimento": 0,
            "anoGuiaOrigem": 0,
            "anoNDR": 0,
            "anoPeriodo": 2023,
            "caraterSolicitacao": "U",
            "cdCarteiraUsuario": 1000000084,
            "cdCboSolicitante": "201115",
            "cdCid": "",
            "cdCid1": "",
            "cdCid2": "",
            "cdCid3": "",
            "cdCidObito": "",
            "cdCidObito1": "",
            "cdCidObito2": "",
            "cdCidObito3": "",
            "cdCidObito4": "",
            "cdCidObito5": "",
            "cdClasseHospitalar": 1,
            "cdConselhoProfSolic": "CRM",
            "cdCorenEnfermAuditor": "",
            "cdEspecialidSolicitante": 16,
            "cdFaturamento": "",
            "cdMotivoAlta": 0,
            "cdPrestadorImp": 0,
            "cdPrestadorReemb": 5,
            "cdUnidadeReemb": 1,
            "cdPrestadorPrincipal": 120,
            "cdPrestadorSolicitante": 11521,
            "cdTransacao": 13,
            "cdTransacaoAnt": 0,
            "cdUfEnfermAuditor": "",
            "cdUfMedicoAuditor": "",
            "cdUnidCdPrestExec": "",
            "cdUnidade": 0,
            "cdUnidadeAnt": 0,
            "cdUnidadeCarteira": 120,
            "cdUnidadeImp": 0,
            "cdUnidadePrestPrincipal": 120,
            "cdUnidadePrestadora": 120,
            "cdUnidadePrestadoraAnt": 0,
            "cdUnidadeSolicitante": 120,
            "cdVinculoPrestPrincipal": 3,
            "cdVinculoSolicitante": 2,
            "codLotePrestadorTiss": "012000000167",
            "dsIndClinica": "",
            "dsObservacao": "consulta",
            "dtAlta": null,
            "dtAutorizacaoOrigem": null,
            "dtDigitacao": "2023-01-09",
            "dtEmissao": "2023-01-09",
            "dtInternacao": null,
            "dtSolicitacaoOrigem": null,
            "hrAlta": "",
            "hrDigitacao": "080000",
            "hrInternacao": "",
            "inStatusDocto": 2,
            "nmDeclNascViv": "",
            "nmDeclNascViv2": "",
            "nmDeclNascViv3": "",
            "nmDeclNascViv4": "",
            "nmDeclNascViv5": "",
            "nmDeclObt": 0,
            "nmEnfermAuditor": "",
            "nmMedicoAuditor": "",
            "nmProfSol": "AQUI",
            "nrConselhoProfSolic": "12321",
            "nrDeclaracaoObito": "",
            "nrDeclaracaoObito1": "",
            "nrDeclaracaoObito2": "",
            "nrDeclaracaoObito3": "",
            "nrDeclaracaoObito4": "",
            "nrDeclaracaoObito5": "",
            "nrDocOriginal": 0,
            "nrDocOriginalAnt": 0,
            "nrDocSistema": 0,
            "nrDocSistemaAnt": 0,
            "nrFatura": "",
            "nrGuiaAtendimento": 0,
            "nrGuiaOrigem": 0,
            "nrGuiaPrestador": "",
            "nrLote": null,
            "nrLoteImp": 0,
            "nrNDR": "",
            "nrPeriodo": 1,
            "nrSequenciaImp": 0,
            "nrSerieDocOriginal": "7777",
            "nrSerieDocOriginalAnt": "",
            "nrSerieFatura": "",
            "nrSerieNDR": "",
            "atendimentoRN": false,
            "logAtendimRN": false,
            "cdLocalAtendimento": 1,
            "procedimentos": [{
                    "cdUnidOrigemSispac": "",
                    "cdModulo": 1,
                    "hrRealizacao": "08:00",
                    "cnpjcpfSispac": "",
                    "cdCboReemb": "",
                    "dtLimite": null,
                    "dsMovimento": "CONSULTA EM CONSULTÓRIO (NO HORARIO NORM",
                    "nrNotaFornecedor": "",
                    "inTipoPessoaReemb": "F",
                    "prestadores": [
                        {
                            "cdTipoVincDiviHono": 0,
                            "cdEspecialid": 1,
                            "cdUnidade": 120,
                            "cdPrestador": 120,
                            "vlTaxaCobrado": 0.0,
                            "cdPorteAnestesicoCob": 0,
                            "inStatus": 1,
                            "ultimaAcao": "",
                            "nmProfissionalExec": "PROFISSIONAL",
                            "qtCobrado": 1.0,
                            "cdPorteAnestesico": 0,
                            "lgVlMovimentoInformado": false,
                            "qtMovimento": 1.0,
                            "cdTipoVinculo": 1,
                            "vlCobrado": 10.0,
                            "cdUnidadePrestDiviHono": 0,
                            "cdEspPrestDiviHono": 0,
                            "qtVezesTabelaPag": 1.0,
                            "vlMovimento": 10.0,
                            "cdPrestadorDiviHono": 0,
                            "vlCobradoHono": 0.0,
                            "vlGlosadoHono": 0.0,
                            "lgDivisaoHonorario": false,
                            "codCPFProfissionalExec": "23004463083",
                            "nrRegistro": "123456",
                            "vlMovimentoHono": 0.0,
                            "vlGlosado": 0.0,
                            "vlTaxaMovimento": 0.0,
                            "cdCbo": "",
                            "vlTaxaCobradoHono": 0.0,
                            "vlTaxaMovimentoHono": 0.0,
                            "vlDescontoPrestador": 0.0,
                            "cdCboDiviHono": "",
                            "lgUrgencia": false,
                            "cdUfConselho": "SP",
                            "idRegistroMovto": 1,
                            "cdConselho": "CRM",
                            "lgAdicionalUrgencia": false,
                            "qtVezesTabelaCob": 1.0,
                            "cdnNivTiss": 0
                        }
                    ],
                    "cdConselhoReemb": "123456",
                    "cdAnvisa": "",
                    "cdTipoAcomodacaoSispac": "",
                    "cdTipoInsumo": 0,
                    "tpTecUtil": "",
                    "dtRealizacao": "2023-01-09",
                    "nmFornecedor": "",
                    "nrCpfCnpjReemb": "56232591038",
                    "nmConselhoReemb": "CRM",
                    "nmPrestReemb": "RODOLFO",
                    "nmProfissionalReemb": "PROFISSIONAL",
                    "ufProfissionalReemb": "SP",
                    "cdPacoteSispac": "",
                    "dsInsumoGenerico": "",
                    "_expandables": [
                        "glosas"
                    ],
                    "cdMovimento": "10101012",
                    "hrRealizacaoFim": "08:10",
                    "desReferMaterFabrican": "",
                    "idRegistroDoc": "",
                    "idRegistroPacote": 0,
                    "cdTipoPercentual": 0,
                    "tpMovimento": "PROC",
                    "cdViaAcesso": 1,
                    "inLiberadoContas": "0",
                    "idRegistro": 1
                }
            ],
            "insumos": [
                {
                    "cdUnidOrigemSispac": "",
                    "cdModulo": 16,
                    "hrRealizacao": "08:10",
                    "cnpjcpfSispac": "",
                    "cdCboReemb": "201115",
                    "dtLimite": null,
                    "dsMovimento": "SADT",
                    "nrNotaFornecedor": "",
                    "inTipoPessoaReemb": "F",
                    "prestadores": [
                        {
                            "cdTipoVincDiviHono": 0,
                            "cdEspecialid": 1,
                            "cdUnidade": 120,
                            "cdPrestador": 120,
                            "vlTaxaCobrado": 0.0,
                            "cdPorteAnestesicoCob": 0,
                            "inStatus": 2,
                            "ultimaAcao": "",
                            "nmProfissionalExec": "PROF REEMB INSUMO",
                            "qtCobrado": 1.0,
                            "cdPorteAnestesico": 0,
                            "lgVlMovimentoInformado": false,
                            "qtMovimento": 1.0,
                            "cdTipoVinculo": 1,
                            "vlCobrado": 1.0,
                            "cdUnidadePrestDiviHono": 0,
                            "cdEspPrestDiviHono": 0,
                            "qtVezesTabelaPag": 0.0,
                            "vlMovimento": 1.0,
                            "cdPrestadorDiviHono": 0,
                            "vlCobradoHono": 0.0,
                            "vlGlosadoHono": 0.0,
                            "lgDivisaoHonorario": false,
                            "codCPFProfissionalExec": "",
                            "vlMovimentoHono": 0.0,
                            "vlGlosado": 0.0,
                            "vlTaxaMovimento": 0.0,
                            "cdCbo": "201115",
                            "vlTaxaCobradoHono": 0.0,
                            "vlTaxaMovimentoHono": 0.0,
                            "vlDescontoPrestador": 0.0,
                            "cdCboDiviHono": "",
                            "lgUrgencia": false,
                            "idRegistroMovto": 2,
                            "lgAdicionalUrgencia": false,
                            "qtVezesTabelaCob": 0.0,
                            "cdnNivTiss": 0
                        }
                    ],
                    "cdConselhoReemb": "2222",
                    "cdAnvisa": "",
                    "cdTipoAcomodacaoSispac": "",
                    "cdTipoInsumo": 6,
                    "tpTecUtil": "",
                    "dtRealizacao": "2023-01-09",
                    "nmFornecedor": "",
                    "nrCpfCnpjReemb": "58980951019",
                    "nmConselhoReemb": "CRM",
                    "nmPrestReemb": "PRESTADOR REEM INSUMO",
                    "nmProfissionalReemb": "PROF REEMB INSUMO",
                    "ufProfissionalReemb": "SP",
                    "cdPacoteSispac": "",
                    "dsInsumoGenerico": "",
                    "_expandables": [
                        "glosas"
                    ],
                    "cdMovimento": "0000000015",
                    "hrRealizacaoFim": "08:15",
                    "desReferMaterFabrican": "",
                    "idRegistroDoc": "120/120/13/7777/3/0",
                    "idRegistroPacote": 0,
                    "cdTipoPercentual": 0,
                    "tpMovimento": "INSU",
                    "cdViaAcesso": 0,
                    "inLiberadoContas": "0",
                    "idRegistro": 2
                }
            ],
            "tpAtend": 0,
            "tpConsulta": 1,
            "tpInter": 0,
            "tpRegimInter": 0,
            "ufConselhoProfSolic": "RS",
            "urlChave": ""

}
    ],
    "parametros": [
             {
                  "nomeUsuario": "super120"
              }
       ]
}

Update

Na alteração do documento os campos cdUnidade e nrDocOriginal devem ser preenchidos.

Exemplo JSON entrada - saveDocument

{
    "documentos": [{
            "anoFatura": 0,
            "anoGuiaAtendimento": 0,
            "anoGuiaOrigem": 0,
            "anoNDR": 0,
            "anoPeriodo": 2023,
            "caraterSolicitacao": "U",
            "cdCarteiraUsuario": 1000000084,
            "cdCboSolicitante": "201115",
            "cdCid": "",
            "cdCid1": "",
            "cdCid2": "",
            "cdCid3": "",
            "cdCidObito": "",
            "cdCidObito1": "",
            "cdCidObito2": "",
            "cdCidObito3": "",
            "cdCidObito4": "",
            "cdCidObito5": "",
            "cdClasseHospitalar": 1,
            "cdConselhoProfSolic": "CRM",
            "cdCorenEnfermAuditor": "",
            "cdEspecialidSolicitante": 1,
            "cdFaturamento": "",
            "cdMotivoAlta": 0,
            "cdPrestadorImp": 0,
            "cdPrestadorReemb": 5,
            "cdUnidadeReemb": 1,
            "cdPrestadorPrincipal": 120,
            "cdPrestadorSolicitante": 120,
            "cdTransacao": 13,
            "cdTransacaoAnt": 0,
            "cdUfEnfermAuditor": "",
            "cdUfMedicoAuditor": "",
            "cdUnidCdPrestExec": "",
            "cdUnidade": 120,
            "cdUnidadeAnt": 0,
            "cdUnidadeCarteira": 120,
            "cdUnidadeImp": 0,
            "cdUnidadePrestPrincipal": 120,
            "cdUnidadePrestadora": 120,
            "cdUnidadePrestadoraAnt": 0,
            "cdUnidadeSolicitante": 120,
            "cdVinculoPrestPrincipal": 1,
            "cdVinculoSolicitante": 1,
            "dsIndClinica": "",
            "dsObservacao": "consulta",
            "dtAlta": null,
            "dtAutorizacaoOrigem": null,
            "dtDigitacao": "2023-01-09",
            "dtEmissao": "2023-01-09",
            "dtInternacao": null,
            "dtSolicitacaoOrigem": null,
            "hrAlta": "",
            "hrInternacao": "",
            "inStatusDocto": 2,
            "nmDeclNascViv": "",
            "nmDeclNascViv2": "",
            "nmDeclNascViv3": "",
            "nmDeclNascViv4": "",
            "nmDeclNascViv5": "",
            "nmDeclObt": 0,
            "nmEnfermAuditor": "",
            "nmMedicoAuditor": "",
            "nmProfSol": "AQUI",
            "nrConselhoProfSolic": "12321",
            "nrDeclaracaoObito": "",
            "nrDeclaracaoObito1": "",
            "nrDeclaracaoObito2": "",
            "nrDeclaracaoObito3": "",
            "nrDeclaracaoObito4": "",
            "nrDeclaracaoObito5": "",
            "nrDocOriginal": 4,
            "nrDocOriginalAnt": 0,
            "nrDocSistema": 0,
            "nrDocSistemaAnt": 0,
            "nrFatura": "",
            "nrGuiaAtendimento": 0,
            "nrGuiaOrigem": 0,
            "nrGuiaPrestador": "",
            "nrLote": null,
            "nrLoteImp": 0,
            "nrNDR": "",
            "nrPeriodo": 1,
            "nrSequenciaImp": 0,
            "nrSerieDocOriginal": "666",
            "nrSerieDocOriginalAnt": "",
            "nrSerieFatura": "",
            "nrSerieNDR": "",
            "atendimentoRN": false,
            "logAtendimRN": false,
            "cdLocalAtendimento": 1,
            "procedimentos": [{
                    "cdUnidOrigemSispac": "",
                    "cdModulo": 1,
                    "hrRealizacao": "08:00",
                    "cnpjcpfSispac": "",
                    "dtLimite": null,
                    "dsMovimento": "CONSULTA EM CONSULTÓRIO (NO HORARIO NORM",
                    "nrNotaFornecedor": "",
                    "prestadores": [
                        {
                            "cdTipoVincDiviHono": 0,
                            "cdEspecialid": 1,
                            "cdUnidade": 120,
                            "cdPrestador": 120,
                            "vlTaxaCobrado": 0.0,
                            "nrSeqDigitacao": 2,
                            "nrProcesso": 2,
                            "cdPorteAnestesicoCob": 0,
                            "inStatus": 1,
                            "ultimaAcao": "",
                            "nmProfissionalExec": "PROFISSIONAL EXEC",
                            "qtCobrado": 1.0,
                            "cdPorteAnestesico": 0,
                            "lgVlMovimentoInformado": false,
                            "qtMovimento": 1.0,
                            "cdTipoVinculo": 1,
                            "vlCobrado": 31.0,
                            "cdUnidadePrestDiviHono": 0,
                            "cdEspPrestDiviHono": 0,
                            "qtVezesTabelaPag": 1.0,
                            "vlMovimento": 31.0,
                            "cdPrestadorDiviHono": 0,
                            "vlCobradoHono": 0.0,
                            "vlGlosadoHono": 0.0,
                            "lgDivisaoHonorario": false,
                            "codCPFProfissionalExec": "98791402069",
                            "nrRegistro": "1234567",
                            "vlMovimentoHono": 0.0,
                            "vlGlosado": 0.0,
                            "vlTaxaMovimento": 0.0,
                            "cdCbo": "223505",
                            "vlTaxaCobradoHono": 0.0,
                            "vlTaxaMovimentoHono": 0.0,
                            "vlDescontoPrestador": 0.0,
                            "cdCboDiviHono": "",
                            "lgUrgencia": false,
                            "cdUfConselho": "SP",
                            "idRegistroMovto": 1,
                            "cdConselho": "CRM",
                            "lgAdicionalUrgencia": false,
                            "qtVezesTabelaCob": 1.0,
                            "cdnNivTiss": 0
                        }
                    ],
                    "cdAnvisa": "",
                    "cdTipoAcomodacaoSispac": "",
                    "cdTipoInsumo": 0,
                    "tpTecUtil": "",
                    "dtRealizacao": "2023-01-09",
                    "nmFornecedor": "",
                    "inTipoPessoaReemb": "J",
                    "nrCpfCnpjReemb": "89750470000186",
                    "nmPrestReemb": "RODOLFO JURIDICA TESTE",
                    "nmProfissionalReemb": "PROFISSIONAL REEMB",
                    "ufProfissionalReemb": "SP",
                    "nmConselhoReemb": "CRM",
                    "cdConselhoReemb": "123456789",
                    "cdCboReemb": "223505",
                    "cdPacoteSispac": "",
                    "dsInsumoGenerico": "",
                    "_expandables": [
                        "glosas"
                    ],
                    "cdMovimento": "10101012",
                    "hrRealizacaoFim": "08:10",
                    "desReferMaterFabrican": "",
                    "idRegistroDoc": "120/120/13/666/4/0",
                    "idRegistroPacote": 0,
                    "cdTipoPercentual": 0,
                    "tpMovimento": "PROC",
                    "cdViaAcesso": 1,
                    "inLiberadoContas": "8",
                    "idRegistro": 1
                }
            ],
            "insumos": [
                {
                    "cdUnidOrigemSispac": "",
                    "cdModulo": 16,
                    "hrRealizacao": "08:10",
                    "cnpjcpfSispac": "",
                    "cdCboReemb": "223505",
                    "dtLimite": null,
                    "dsMovimento": "SADT",
                    "nrNotaFornecedor": "",
                    "inTipoPessoaReemb": "F",
                    "prestadores": [
                        {
                            "cdTipoVincDiviHono": 0,
                            "cdEspecialid": 1,
                            "cdUnidade": 120,
                            "cdPrestador": 120,
                            "vlTaxaCobrado": 0.0,
                            "cdPorteAnestesicoCob": 0,
                            "nrSeqDigitacao": 1,
                            "nrProcesso": 1,
                            "inStatus": 2,
                            "ultimaAcao": "",
                            "nmProfissionalExec": "PROF REEMB INSUMO TESTE",
                            "qtCobrado": 1.0,
                            "cdPorteAnestesico": 0,
                            "lgVlMovimentoInformado": false,
                            "qtMovimento": 1.0,
                            "cdTipoVinculo": 1,
                            "vlCobrado": 1.0,
                            "cdUnidadePrestDiviHono": 0,
                            "cdEspPrestDiviHono": 0,
                            "qtVezesTabelaPag": 0.0,
                            "vlMovimento": 1.0,
                            "cdPrestadorDiviHono": 0,
                            "vlCobradoHono": 0.0,
                            "vlGlosadoHono": 0.0,
                            "lgDivisaoHonorario": false,
                            "codCPFProfissionalExec": "",
                            "vlMovimentoHono": 0.0,
                            "vlGlosado": 0.0,
                            "vlTaxaMovimento": 0.0,
                            "cdCbo": "223505",
                            "vlTaxaCobradoHono": 0.0,
                            "vlTaxaMovimentoHono": 0.0,
                            "vlDescontoPrestador": 0.0,
                            "cdCboDiviHono": "",
                            "lgUrgencia": false,
                            "idRegistroMovto": 2,
                            "lgAdicionalUrgencia": false,
                            "qtVezesTabelaCob": 0.0,
                            "cdnNivTiss": 0
                        }
                    ],
                    "cdConselhoReemb": "2222",
                    "cdAnvisa": "",
                    "cdTipoAcomodacaoSispac": "",
                    "cdTipoInsumo": 6,
                    "tpTecUtil": "",
                    "dtRealizacao": "2023-01-09",
                    "nmFornecedor": "",
                    "nrCpfCnpjReemb": "58980951019",
                    "nmConselhoReemb": "CRM",
                    "nmPrestReemb": "PRESTADOR REEM INSUMO ",
                    "nmProfissionalReemb": "PROF REEMB INSUMO ",
                    "ufProfissionalReemb": "SP",
                    "cdPacoteSispac": "",
                    "dsInsumoGenerico": "",
                    "_expandables": [
                        "glosas"
                    ],
                    "cdMovimento": "0000000015",
                    "hrRealizacaoFim": "08:15",
                    "desReferMaterFabrican": "",
                    "idRegistroDoc": "120/120/13/666/4/0",
                    "idRegistroPacote": 0,
                    "cdTipoPercentual": 0,
                    "tpMovimento": "INSU",
                    "cdViaAcesso": 0,
                    "inLiberadoContas": "8",
                    "idRegistro": 2
                }
            ],
            "tpAtend": 0,
            "tpConsulta": 1,
            "tpInter": 0,
            "tpRegimInter": 0,
            "ufConselhoProfSolic": "RS",
            "urlChave": "120/120/13/666/4/0"
        }
    ],
    "parametros": [
             {
                  "nomeUsuario": "super120"
              }
       ]
}

c. 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-squad-sus01:8580/api/hrc/v1/refundDocumentsMaintenance/remove/doc/120/120/13/7777/1/0

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

d. 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-squad-sus01:8580/api/hrc/v1/refundDocumentsMaintenance/doc/120/120/13/7777/1/0?expand=procedimentos

Para retornar as informações de procedimentos, prestadores e insumos é necessário passar por parâmetro estas informações na requisição.

e. Json 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).

Código	Descrição
100	Indica alguma inconsistência no processo em função de regra de negócio

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/refundDocumentsMaintenance",
    "code": "100",
    "type": "error"
}

Árvore de páginas

API de integração com o Revisão de Contas (Reembolso)

CONTEÚDO

01. VISÃO GERAL

a. Rota

b. saveDocument

Create

Update

c. removeDocumentsById

d. getDocumentById

e. Json retornado