Histórico da Página

CONTEÚDO

Visão Geral
1. API de integração com o Revisão de ContasRota
2. Manutenção de documentos - API de integração com o Revisão de Contas saveDocument
3. Inclusão de glosas - API de integração com o Revisão de Contas addMovementManualRestriction
4. Remoção de glosas - API de integração com o Revisão de Contas removeMovementManualRestriction
5. Validação de glosas - API de integração com o Revisão de Contas validateMovementRestriction
6. Remoção de documentos - API de integração com o Revisão de Contas removeDocumentsByInvoice
7. Remoção de documentos - API de integração com o Revisão de Contas removeDocumentsById
8. Consulta de documentos - getDocumentById
9. Consulta de documentos - API de integração com o Revisão de ContasAPI de integração com o Revisão de Contas getDocumentByInvoice
10. Json retornado
Regras de Negócio Aplicadas
Como Validar as Informações
1. Central de Movimentação de Guias TISS
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.

...

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

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

cidObito1 a cidObito5

qtNascVivosTermo

CID

Quantidade de

óbito nascidos mortos (campos do 1 a 5)

nascidos vivos não prematuros

inteiro

caracter

Não

Sim

nrDeclaracaoObito1 a

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
inAcidente	Indicador de acidente	inteiro		Somente para Internação ou se o documento já possuir informação junto a base.	sim	Sim
dtDigitacao	Data de digitação do documento	data	aaaa-mm-dd	Não	Não	Não

hrDigitacaoHora de digitação do documentocaracter99:99NãoNãoNão

Lista de movimentos, informar na TAG "procedimentos" ou "insumos"

CampoDescriçãoTipo DadoMáscaraObrigatórioPermite
definir na alteraçãoPermite definir na inclusãoidRegistroIdentificador único para o movimento (único)
inteiroSimNãoSimidRegistroDocIdentificador do documentocaracterSimNãoNãoidRegistroPacoteIdentificador do pacote
inteiroSimNãoNãotpMovimento

Tipo do movimento:
PROC - indica procedimento
INSU - indica insumo
PACOTE - indica pacote

caracterSimNãoSimcdTipoInsumoCódigo do tipo do insumointeiro99Obrigatório para insumo na inclusãoNãoSimcdMovimentoCódigo do movimento
inteiroObrigatório na inclusão

Não

SimdsMovimentoDescrição do movimentocaracterNãoNãoNãodtRealizacaoData de realizaçãodataaaaa-mm-ddSimSimSimhrRealizacaoHora inicial de realizaçãocaracter99:99SimSimSimhrRealizacaoFimHora final de realizaçãocaracter99:99SimSimSimcdViaAcessoVia de acesso utilizada (TISS Tab. 61)inteiroSimSimSimtpTecUtilTécnica utilizada (TISS Tab. 48)caracterSimSimSimdsInsumoGenericoDescrição do Insumo***caracterObrigatório para insumos genéricosSimSimdtLimiteData LimitedataNãoNãoNaocdAnvisaCódigo ANVISA do insumocaracterNãoNãoNaonmFornecedorNome do Fornecedor do insumocaracterNãoNãoNaonrNotaFornecedorNúmero da Nota do fornecedor do insumocaracterNãoNãoNãodesReferMaterFabricanReferência Material Fabricante do insumocaracterObrigatório para insumos genéricosNãoSim

cdModulo

Código do módulo de cobertura do beneficiáriointeiroNãoNãoNãocdUnidOrigemSispacCódigo da unidade origem do pacote de intercâmbiocaracterNãoNãoNãocdPacoteSispacCódigo do pacote de intercâmbiocaracterNãoNãoNãocdTipoAcomodacaoSispacTipo de Acomodação do pacote de intercâmbiocaracterNãoNãoNãocnpjcpfSispacCNPJ ou CPF do prestador do pacote de intercâmbiocaracterNãoNãoNão inLiberadoContasIndicador da situação do movimento caracterNãoNão Não cdTipoPercentualFator de redução ou acréscimo, deve ser informado o Tipo de Percentual.inteiroNãoSimSimprestadores

Lista com os dado do prestador executante

CampoDescriçãoTipo DadoMáscaraObrigatórioPermite
definir na alteraçãoPermite definir na inclusãoidRegistroMovtoIdentificador do movimentointeiroSimNãoSimnrProcessoNúmero do processo do movimentointeiroSimNãoDeve ser 0nrSeqDigitacaoNúmero de sequencia do movimentointeiroSimNãoDeve ser 0cdUnidadeUnidade do prestadorinteiroSimSimSimcdPrestadorCódigo do prestadorinteiroSimSimSimnmProfissionalExecNome do profissional executantecaracterSomente para Prestadores Jurídicos e Obriga Procedimento como sim (pr0110h)SimSimcdConselhoConselho do prestador executantecaracterSomente para Prestadores Jurídicos e Obriga Procedimento como sim (pr0110h)SimSimnrRegistroCódigo do conselho do prestador executantecaracterSomente para Prestadores Jurídicos e Obriga Procedimento como sim (pr0110h)SimSimcdUfConselhoUF do conselho do prestador executantecaracterx(02)Somente para Prestadores Jurídicos e Obriga Procedimento como sim (pr0110h)SimSimcodCPFProfissionalExecCPF do profissional executantecaracter99999999999Somente para Prestadores Jurídicos e Obriga Procedimento como sim (pr0110h)Não, o cpf é o que consta no cadastro do prestador.Não, o cpf é o que consta no cadastro do prestador.qtCobradoQuantidade cobrada do movimento (é alterada caso "Considera Valor Cobrado" do cadastro da Transação).decimalSimSimSimvlCobradoValor cobrado do movimento (é recalculado caso "Considera Valor Cobrado" do cadastro da Transação).decimalNãoSimSimvlTaxaCobradoValor da taxa cobrado do movimentodecimalNãoNãoSimvlTaxaMovimentoValor da taxa do movimentodecimalNãoSimSimqtMovimentoQuantidade do movimentodecimalSimSimSimvlMovimentoValor do movimento*decimalNãoSimSimqtVezesTabelaPagMultiplicador da tabela de pagamentointeiroNãoSimSimqtVezesTabelaCobMultiplicador da tabela de cobrançainteiroNãoSimSimcdCboCBO do prestador executantecaracterSimSimSimcdEspecialidEspecialidade do prestador executanteinteiroSimSimSimcdPorteAnestesicoPorte anestésico pagamentointeiroSimSimSimcdPorteAnestesicoCobPorte anestésico cobrançainteiroSimSimSimlgAdicionalUrgenciaCobra adicional de urgência?lógicotrue/falseNãoSimSimlgUrgenciaIndica Urgêncialógicotrue/falseNãoSimSimcdnNivTissNível do prestador executante. Quando informado como "6" (anestesista) ou "7" (auxiliar de anestesista) o procedimento será consistido como de anestesista.inteiroSimSimSimcdTipoVinculoTipo de vinculo do prestador executante (valor é considerado do Vinculo Executante do Cadastro da Transação)inteiroNãoNãoNãovlGlosadoValor glosado do movimentodecimalNãoNãoNão

vlDescontoPrestador

Valor desconto do prestadordecimalNãoNãoNãolgDivisaoHonorarioPossui divisão de honoráriológicotrue/falsePara dividir honoráriosNãoSimcdUnidadePrestDiviHonoCódigo da unidade do prestador da divisão de honoráriointeiroPara dividir honoráriosSimSimcdPrestadorDiviHonoCódigo do prestador da divisão de honoráriointeiroPara dividir honoráriosSimSimcdEspPrestDiviHonoEspecialidade do prestador da divisão de honoráriointeiroPara dividir honoráriosSimSimcdCboDiviHonoCBO do prestador da divisão de honoráriointeiroPara dividir honoráriosSimSimcdTipoVincDiviHonoVinculo do prestador da divisão de honoráriointeiroNãoSimSimvlCobradoHonoValor cobrado divisão honoráriodecimalNãoSimSimvlTaxaCobradoHonoValor da taxa cobrada divisão honoráriodecimalNãoSimSimvlMovimentoHonoValor movimento divisão honoráriodecimalPara dividir honoráriosSimSimvlTaxaMovimentoHonoValor da taxa movimento divisão honoráriodecimalNãoSimSimvlGlosadoHonoValor glosa divisão honoráriodecimalNãoNãoNãoinStatus

Indica o status do movimento: 1 - Pendente Análise de Glosa, 2 - Pendente Liberação, 3 - Liberado , 4- Pago, 5- Faturado, 6- Pago e Faturado e 7- Cancelado.

intNãoNãoNãoSimSimSimSimtag: parametros campo: [nomeUsuario]Nome de usuário que está manipulando o(s) registro(s).caracterSimSim

Expandir

title	Exemplo JSON entrada - saveDocument

{
    "documentos": [{
            "anoFatura": 0,
            "anoGuiaAtendimento": 0,
            "anoGuiaOrigem": 0,
            "anoNDR": 0,
            "anoPeriodo": 2020,
            "caraterSolicitacao": "E",
            "cdCarteiraUsuario": 999999999999,
            "cdCboSolicitante": "201115",
            "cdCid": "",
            "cdCid1": "",
            "cdCid2": "",
            "cdCid3": "",
            "cdCidObito": "",
            "cdCidObito1": "",
            "cdCidObito2": "",
            "cdCidObito3": "",
            "cdCidObito4": "",
            "cdCidObito5": "",
            "cdClasseHospitalar": 1,
            "cdConselhoProfSolic": "CRM",
            "cdCorenEnfermAuditor": "",
            "cdCrmMedicoAuditor": "2",
            "cdEspecialidSolicitante": 16,
            "cdFaturamento": "",
            "cdMotivoAlta": 0,
            "cdPrestadorImp": 0,
            "cdPrestadorPrincipal": 11521,
            "cdPrestadorSolicitante": 11521,
            "cdTransacao": 3001,
            "cdTransacaoAnt": 0,
            "cdUfEnfermAuditor": "",
            "cdUfMedicoAuditor": "",
            "cdUnidCdPrestExec": "",
            "cdUnidade": 9999,
            "cdUnidadeAnt": 0,
            "cdUnidadeCarteira": 9999,
            "cdUnidadeImp": 0,
            "cdUnidadePrestPrincipal": 9999,
            "cdUnidadePrestadora": 9999,
            "cdUnidadePrestadoraAnt": 0,
            "cdUnidadeSolicitante": 9999,
            "cdVinculoPrestPrincipal": 2,
            "cdVinculoSolicitante": 2,
            "codLotePrestadorTiss": "",
            "dsIndClinica": "",
            "dsObservacao": "consulta",
            "dtAlta": null,
            "dtAutorizacaoOrigem": null,
            "dtDigitacao": "2020-10-26",
            "dtEmissao": "2020-10-20",
            "dtInternacao": null,
            "dtSolicitacaoOrigem": null,
            "hrAlta": "",
            "hrDigitacao": "091937",
            "hrInternacao": "",
            "inStatusDocto": 2,
            "indAcidente": 9,
            "nmDeclNascViv": "",
            "nmDeclNascViv2": "",
            "nmDeclNascViv3": "",
            "nmDeclNascViv4": "",
            "nmDeclNascViv5": "",
            "nmDeclObt": 0,
            "nmEnfermAuditor": "",
            "nmMedicoAuditor": "",
            "nmProfSol": "AQUI",
            "nrConselhoProfSolic": "12321",
            "nrDeclaracaoObito": "",
            "nrDeclaracaoObito1": "",
            "nrDeclaracaoObito2": "",
            "nrDeclaracaoObito3": "",
            "nrDeclaracaoObito4": "",
            "nrDeclaracaoObito5": "",
            "nrDocOriginal": 2,
            "nrDocOriginalAnt": 0,
            "nrDocSistema": 0,
            "nrDocSistemaAnt": 0,
            "nrFatura": "",
            "nrGuiaAtendimento": 0,
            "nrGuiaOrigem": 0,
            "nrGuiaPrestador": "",
            "nrLote": null,
            "nrLoteImp": 0,
            "nrNDR": "",
            "nrPeriodo": 10,
            "nrSequenciaImp": 0,
            "nrSerieDocOriginal": "API",
            "nrSerieDocOriginalAnt": "",
            "nrSerieFatura": "",
            "nrSerieNDR": "",

"atendimentoRN": false,

"dtRealizacao": "2020-10-20",

"hrRealizacao": "14:00",
"inAcidente": 1,

"logAtendimRN": false,
            "procedimentos": [{
                    "cdAnvisa": "",
                    "cdFatReducaoAcrescimo": 0,
                    "cdModulo": 9,
                    "cdMovimento": "10101012",
                    "cdPacoteSispac": "",
                    "cdTipoAcomodacaoSispac": "",
                    "cdTipoInsumo": 0,
                    "cdUnidOrigemSispac": "",
                    "cdViaAcesso": 1,
                    "cnpjcpfSispac": "",
                    "desReferMaterFabrican": "",
                    "dsInsumoGenerico": "",
                    "dsMovimento": "CONSULTA",
                    "dtLimite": null,
                    "dtRealizacao": "2020-10-20",
                    "glosas": [],
                    "hrRealizacao": "14:00",
                    "hrRealizacaoFim": "14:00",
                    "idRegistro": 1,
                    "idRegistroDoc": "9999/9999/3001/API/2/0",
                    "idRegistroPacote": 0,
                    "nmFornecedor": "",
                    "nrNotaFornecedor": "",
                    "prestadores": [{
                            "cdCbo": "",
                            "cdCboDiviHono": "",
                            "cdConselho": "crm",
                            "cdEspPrestDiviHono": 0,
                            "cdEspecialid": 16,
                            "cdPorteAnestesico": 0,
                            "cdPorteAnestesicoCob": 0,
                            "cdPrestador": 11521,
                            "cdPrestadorDiviHono": 0,
                            "cdTipoVincDiviHono": 0,
                            "cdTipoVinculo": 0,
                            "cdUfConselho": "rs",
                            "cdUnidade": 9999,
                            "cdUnidadePrestDiviHono": 0,
                            "cdnNivTiss": 0,
                            "codCPFProfissionalExec": "99999999999",
                            "idRegistroMovto": 1,
                            "inStatus": 2,
                            "lgAdicionalUrgencia": false,
                            "lgDivisaoHonorario": false,
                            "lgUrgencia": false,
                            "nmProfissionalExec": "Dr. da Clinica",
                            "nrProcesso": 1,
                            "nrRegistro": "115221",
                            "nrSeqDigitacao": 1,
                            "qtCobrado": 1.0,
                            "qtMovimento": 1.0,
                            "qtVezesTabelaCob": 1.0,
                            "qtVezesTabelaPag": 1.0,
                            "vlCobrado": 6.0,
                            "vlCobradoHono": 0.0,
                            "vlDescontoPrestador": 0.0,
                            "vlGlosado": 0.0,
                            "vlGlosadoHono": 0.0,
                            "vlMovimento": 6.0,
                            "vlMovimentoHono": 0.0,
                            "vlTaxaCobrado": 0.0,
                            "vlTaxaCobradoHono": 0.0,
                            "vlTaxaMovimento": 0.0,
                            "vlTaxaMovimentoHono": 0.0
                        }
                    ],
                    "tpMovimento": "PROC",
                    "tpTecUtil": ""
                }
            ],
            "tpAtend": 0,
            "tpConsulta": 1,
            "tpInter": 0,
            "tpRegimInter": 0,
            "ufConselhoProfSolic": "RS",
            "urlChave": "9999/9999/3001/API/2/0",

}
],

"parametros": [

{

"nomeUsuario": "super"

}

]

}

...

tag: pacotes	Acesse aqui os campos da TAG "pacotes"		Sim	Sim
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

Expandir

title	Exemplo JSON entrada - saveDocument

{
    "documentos": [{
            "anoFatura": 0,
            "anoGuiaAtendimento": 0,
            "anoGuiaOrigem": 0,
            "anoNDR": 0,
            "anoPeriodo": 2020,
            "caraterSolicitacao": "E",
            "cdCarteiraUsuario": 999999999999,
            "cdCboSolicitante": "201115",
            "cdCid": "",
            "cdCid1": "",
            "cdCid2": "",
            "cdCid3": "",
            "cdCidObito": "",
            "cdCidObito1": "",
            "cdCidObito2": "",
            "cdCidObito3": "",
            "cdCidObito4": "",
            "cdCidObito5": "",
            "cdClasseHospitalar": 1,
            "cdConselhoProfSolic": "CRM",
            "cdCorenEnfermAuditor": "",
            "cdCrmMedicoAuditor": "2",
            "cdEspecialidSolicitante": 16,
            "cdFaturamento": "",
            "cdMotivoAlta": 0,
            "cdPrestadorImp": 0,
            "cdPrestadorPrincipal": 11521,
            "cdPrestadorSolicitante": 11521,
            "cdTransacao": 3001,
            "cdTransacaoAnt": 0,
            "cdUfEnfermAuditor": "",
            "cdUfMedicoAuditor": "",
            "cdUnidCdPrestExec": "",
            "cdUnidade": 9999,
            "cdUnidadeAnt": 0,
            "cdUnidadeCarteira": 9999,
            "cdUnidadeImp": 0,
            "cdUnidadePrestPrincipal": 9999,
            "cdUnidadePrestadora": 9999,
            "cdUnidadePrestadoraAnt": 0,
            "cdUnidadeSolicitante": 9999,
            "cdVinculoPrestPrincipal": 2,
            "cdVinculoSolicitante": 2,
            "codLotePrestadorTiss": "",
            "dsIndClinica": "",
            "dsObservacao": "consulta",
            "dtAlta": null,
            "dtAutorizacaoOrigem": null,
            "dtDigitacao": "2020-10-26",
            "dtEmissao": "2020-10-20",
            "dtInternacao": null,
            "dtSolicitacaoOrigem": null,
            "hrAlta": "",
            "hrDigitacao": "091937",
            "hrInternacao": "",
            "inStatusDocto": 2,
            "indAcidente": 9,
            "nmDeclNascViv": "",
            "nmDeclNascViv2": "",
            "nmDeclNascViv3": "",
            "nmDeclNascViv4": "",
            "nmDeclNascViv5": "",
            "nmDeclObt": 0,
            "nmEnfermAuditor": "",
            "nmMedicoAuditor": "",
            "nmProfSol": "AQUI",
            "nrConselhoProfSolic": "12321",
            "nrDeclaracaoObito": "",
            "nrDeclaracaoObito1": "",
            "nrDeclaracaoObito2": "",
            "nrDeclaracaoObito3": "",
            "nrDeclaracaoObito4": "",
            "nrDeclaracaoObito5": "",
            "nrDocOriginal": 2,
            "nrDocOriginalAnt": 0,
            "nrDocSistema": 0,
            "nrDocSistemaAnt": 0,
            "nrFatura": "",
            "nrGuiaAtendimento": 0,
            "nrGuiaOrigem": 0,
            "nrGuiaPrestador": "",
            "nrLote": null,
            "nrLoteImp": 0,
            "nrNDR": "",
            "nrPeriodo": 10,
            "nrSequenciaImp": 0,
            "nrSerieDocOriginal": "API",
            "nrSerieDocOriginalAnt": "",
            "nrSerieFatura": "",
            "nrSerieNDR": "",

"atendimentoRN": false,

"dtRealizacao": "2020-10-20",

"hrRealizacao": "14:00",
"inAcidente": 1,

"logAtendimRN": false,
            "procedimentos": [{
                    "cdAnvisa": "",
                    "cdFatReducaoAcrescimo": 0,
                    "cdModulo": 9,
                    "cdMovimento": "10101012",
                    "cdPacoteSispac": "",
                    "cdTipoAcomodacaoSispac": "",
                    "cdTipoInsumo": 0,
                    "cdUnidOrigemSispac": "",
                    "cdViaAcesso": 1,
                    "cnpjcpfSispac": "",
                    "desReferMaterFabrican": "",
                    "dsInsumoGenerico": "",
                    "dsMovimento": "CONSULTA",
                    "dtLimite": null,
                    "dtRealizacao": "2020-10-20",
                    "glosas": [],
                    "hrRealizacao": "14:00",
                    "hrRealizacaoFim": "14:00",
                    "idRegistro": 1,
                    "idRegistroDoc": "9999/9999/3001/API/2/0",
                    "idRegistroPacote": 0,
                    "nmFornecedor": "",
                    "nrNotaFornecedor": "",
                    "prestadores": [{
                            "cdCbo": "",
                            "cdCboDiviHono": "",
                            "cdConselho": "crm",
                            "cdEspPrestDiviHono": 0,
                            "cdEspecialid": 16,
                            "cdPorteAnestesico": 0,
                            "cdPorteAnestesicoCob": 0,
                            "cdPrestador": 11521,
                            "cdPrestadorDiviHono": 0,
                            "cdTipoVincDiviHono": 0,
                            "cdTipoVinculo": 0,
                            "cdUfConselho": "rs",
                            "cdUnidade": 9999,
                            "cdUnidadePrestDiviHono": 0,
                            "cdnNivTiss": 0,
                            "codCPFProfissionalExec": "99999999999",
                            "idRegistroMovto": 1,
                            "inStatus": 2,
                            "lgAdicionalUrgencia": false,
                            "lgDivisaoHonorario": false,
                            "lgUrgencia": false,
                            "nmProfissionalExec": "Dr. da Clinica",
                            "nrProcesso": 1,
                            "nrRegistro": "115221",
                            "nrSeqDigitacao": 1,
                            "qtCobrado": 1.0,
                            "qtMovimento": 1.0,
                            "qtVezesTabelaCob": 1.0,
                            "qtVezesTabelaPag": 1.0,
                            "vlCobrado": 6.0,
                            "vlCobradoHono": 0.0,
                            "vlDescontoPrestador": 0.0,
                            "vlGlosado": 0.0,
                            "vlGlosadoHono": 0.0,
                            "vlMovimento": 6.0,
                            "vlMovimentoHono": 0.0,
                            "vlTaxaCobrado": 0.0,
                            "vlTaxaCobradoHono": 0.0,
                            "vlTaxaMovimento": 0.0,
                            "vlTaxaMovimentoHono": 0.0
                        }
                    ],
                    "tpMovimento": "PROC",
                    "tpTecUtil": ""
                }
            ],
            "tpAtend": 0,
            "tpConsulta": 1,
            "tpInter": 0,
            "tpRegimInter": 0,
            "ufConselhoProfSolic": "RS",
            "urlChave": "9999/9999/3001/API/2/0",

}
],

"parametros": [

{

"nomeUsuario": "super"

}

]

}

c. addMovementManualRestriction
Âncora
addMovementManualRestriction
addMovementManualRestriction

Campo

Descrição

Tipo dado

Máscara

Obrigatório

Permite
definir

cdUnidade

Código da unidade

inteiro

Sim

Não

cdUnidadePrestadora

Código da unidade prestadora

inteiro

Sim

Não

cdTransacao

Código da transação

inteiro

Sim

Não

nrSerieDocOriginal

Nome da serie do documento

caracter

x(04)

Sim

Não

nrDocOriginal

Código do documento

inteiro

Sim

Não

nrDocSistema

Sequencia do documento no sistema

inteiro

Sim

Não

cdTipoInsumo

Código do tipo do insumo

inteiro

99

Não

cdInsumo

Código do insumo

inteiro

Não

nrProcesso

Número do processo do movimento

inteiro

Sim

Não

nrSeqDigitacao

Número de sequencia do movimento

inteiro

Sim

Não

tpMovimento

Tipo do movimento:
PROC - indica procedimento
INSU - indica insumo
PACOTE - indica pacote

caracter

x(04)

Sim

Não

id

Identificador do movimento

inteiro

Sim

Não

glosasAdicionadas

Campo	Descrição	Tipo dado	Máscara	Obrigatório	Permite definir
idMovimento	Identificador do movimento	inteiro		Sim	Sim
cdClasseErro	Classe de erro	inteiro		Sim	Sim
cdGlosa	Código da glosa	inteiro		Sim	Sim
dsMotivoGlosa	Motivo da glosa	caracter		Não	Sim
qtdDisponivel	Qtd. procedimentos disponíveis	inteiro		Não	Não
cdRegraQuantitativo	Codigo regra quantit. tecnico	inteiro		Não	Não
qtMovimentosGlosados	Qtd. movimentos glosados	inteiro		Não	Não
dsGlosa				Não	Não
lgGlosaPrincipal	Glosa principal do movimento	lógico	true/false	Não	Não
lgGlosaManual	Indica se a glosa é do tipo manual	lógico	true/false	Não	Não
desJustificativaReconsulta	Justificativa reconsulta	caracter		Não	Não

tag: parametros campo: [nomeUsuario]

Nome de usuário que está manipulando o(s) registro(s).

caracter

Sim

Expandir

title	Exemplo JSON entrada - addMovementManualRestriction

{
    "parametros": [
        {
            "nomeUsuario": "super"
        }
    ],
    "movimentos": [
        {
            "cdUnidade": 120,
            "cdUnidadePrestadora": 120,
            "cdTransacao": 2,
            "nrSerieDocOriginal": "MARV",
            "nrDocOriginal": 300,
            "nrDocSistema": 0,
            "cdTipoInsumo": 0,
            "cdInsumo": 0,
            "nrProcesso": 2,
            "nrSeqDigitacao": 2,
            "tpMovimento": "INSU",
            "id": 1,
            "glosasAdicionadas": [
                {
                    "idMovimento": 1,
                    "cdClasseErro": 6,
                    "cdGlosa": 6,
                    "dsMotivoGlosa": "Motivo glosa"
                }
            ]
        }
    ]
}

d. removeMovementManualRestriction
Âncora
removeMovementManualRestriction
removeMovementManualRestriction

Campo

Descrição

Tipo dado

Máscara

Obrigatório

Permite
definir

cdUnidade

Código da unidade

inteiro

Sim

Não

cdUnidadePrestadora

Código da unidade prestadora

inteiro

Sim

Não

cdTransacao

Código da transação

inteiro

Sim

Não

nrSerieDocOriginal

Nome da serie do documento

caracter

x(04)

Sim

Não

nrDocOriginal

Código do documento

inteiro

Sim

Não

nrDocSistema

Sequencia do documento no sistema

inteiro

Sim

Não

cdTipoInsumo

Código do tipo do insumo

inteiro

99

Não

cdInsumo

Código do insumo

inteiro

Não

nrProcesso

Número do processo do movimento

inteiro

Sim

Não

nrSeqDigitacao

Número de sequencia do movimento

inteiro

Sim

Não

tpMovimento

Tipo do movimento:
PROC - indica procedimento
INSU - indica insumo
PACOTE - indica pacote

caracter

x(04)

Sim

Não

id

Identificador do movimento

inteiro

Sim

Não

glosasRemovidas

Campo	Descrição	Tipo dado	Máscara	Obrigatório	Permite definir
idMovimento	Identificador do movimento	inteiro		Sim	Sim
cdClasseErro	Classe de erro	inteiro		Sim	Sim
cdGlosa	Código da glosa	inteiro		Sim	Sim
dsMotivoGlosa	Motivo da glosa	caracter		Não	Sim
qtiQuantProcedDispon	Qtd. procedimentos disponíveis	inteiro		Não	Não
cdRegraQuantitativo	Codigo regra quantit. tecnico	inteiro		Não	Não
qtMovimentosGlosados	Qtd. movimentos glosados	inteiro		Não	Não
dsGlosa				Não	Não
lgGlosaPrincipal	Glosa principal do movimento	lógico	true/false	Não	Não
lgGlosaManual	Indica se a glosa é do tipo manual	lógico	true/false	Não	Não
desJustificativaReconsulta	Justificativa reconsulta	caracter		Não	Não

tag: parametros campo: [nomeUsuario]

Nome de usuário que está manipulando o(s) registro(s).

caracter

Sim

Expandir

title	Exemplo JSON entrada - removeMovementManualRestriction

{
    "parametros": [
        {
            "nomeUsuario": "super"
        }
    ],
    "movimentos": [
        {
            "cdUnidade": 120,
            "cdUnidadePrestadora": 120,
            "cdTransacao": 2,
            "nrSerieDocOriginal": "MARV",
            "nrDocOriginal": 300,
            "nrDocSistema": 0,
            "cdTipoInsumo": 0,
            "cdInsumo": 0,
            "nrProcesso": 2,
            "nrSeqDigitacao": 2,
            "tpMovimento": "INSU",
            "id": 1,
            "glosasRemovidas": [
                {
                    "idMovimento": 1,
                    "cdClasseErro": 6,
                    "cdGlosa": 6
                }
            ]
        }
    ]
}

e. validateMovementRestriction
Âncora
validateMovementRestriction
validateMovementRestriction

Campo

Descrição

Tipo dado

Máscara

Obrigatório

Permite
definir

cdUnidade

Código da unidade

inteiro

9999

Sim

Não

cdUnidadePrestadora

Código da unidade prestadora

inteiro

9999

Sim

Não

cdTransacao

Código da transação

inteiro

9999

Sim

Não

nrSerieDocOriginal

Nome da serie do documento

caracter

x(04)

Sim

Não

nrDocOriginal

Código do documento

inteiro

Sim

Não

nrDocSistema

Sequencia do documento no sistema

inteiro

Sim

Não

cdTipoInsumo

Código do tipo do insumo

inteiro

99

Não

cdInsumo

Código do insumo

inteiro

Não

nrProcesso

Número do processo do movimento

inteiro

99999999

Sim

Não

nrSeqDigitacao

Número de sequencia do movimento

inteiro

99999999

Sim

Não

tpMovimento

Tipo do movimento:
PROC - indica procedimento
INSU - indica insumo
PACOTE - indica pacote

caracter

x(04)

Sim

Não

id

Identificador do movimento

inteiro

Sim

Não

validacao

Campo	Descrição	Tipo dado	Obrigatório	Permite definir
idMovimento	Identificador do movimento	inteiro	Sim	Sim
cdTipoCob	Código da validação para cobrança	inteiro	Não	Sim
cdTipoPag	Código da validação para pagamento	inteiro	Não	Sim
cdValidacao	Código da validação	inteiro	Não	Não

Valores aceitos para o cdTipoCob:

0 - Cobrança conforme contrato;

1 - Cobrança por custo operacional;

3 - Desconsiderar cobrança;

4 - Cobertura por intercâmbio;

6 - Cobrar somente participação;

7 - Desconsiderar cobrança participação.

Valores aceitos para o cdTipoPag:

0 - Pagamento conforme contrato;

1 - Desconsiderar Pagamento.

Sim

tag: parametros campo: [nomeUsuario]

Nome de usuário que está manipulando o(s) registro(s).

caracter

Sim

Expandir

title	Exemplo JSON entrada - validateMovementRestriction

{
    "parametros": [
        {
            "nomeUsuario": "super"
        }
    ],
    "movimentos": [
        {
            "cdUnidade": 120,
            "cdUnidadePrestadora": 120,
            "cdTransacao": 2,
            "nrSerieDocOriginal": "MARV",
            "nrDocOriginal": 300,
            "nrDocSistema": 0,
            "cdTipoInsumo": 0,
            "cdInsumo": 0,
            "nrProcesso": 2,
            "nrSeqDigitacao": 2,
            "tpMovimento": "INSU",
            "id": 1,
            "validacao": [
                {

                    "cdTipoCob": 1,
                    "cdTipoPag": 1
                }
            ]
        }
    ]
}

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

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/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).

Restrições:

Somente será permitida a alteração de dados de um documento por requisição.
Somente será permitida a alteração de documento com os movimentos com o status de Em Auditoria.
O processo não permite a alteração de movimentos incluídos via pacote de intercâmbio (SISPAC);
Ao incluir/modificar um movimento ele estará com o situação do movimento ('in-liberado-contas') 8 - Em Auditoria.
O processo permite a inclusão de movimentos no documento, sendo que os campos que não podem ser definidos serão desconsiderados.
O processo permite a exclusão de movimentos do documento.
Quando da inclusão de um documento e ou movimento, os campos que não podem ser definidos serão desconsiderados. Não havendo validações se foram gravados ou se podem ser definidos pelo usuário.
Os métodos para adicionar glosa manual (addMovementManualRestriction), remover glosa manual (removeMovementManualRestriction) e validação de glosas (validateMovementRestriction) esperam na JSON da requisição apenas um movimento por solicitação conforme os exemplos apresentados na documentação.

Alteração dos valores dos movimentos:

Para quaisquer requisições de modificação de movimentos com valor informado nas tags vlMovimento, vlMovimentoHono, vlTaxaMovimento ou vlTaxaMovimentoHono esses valores serão considerados prioritariamente sobre quaisquer regras de valorização. Exemplo: se em uma requisição forem alterados via de acesso, quantidade de repasse e valor do movimento, o valor informado(diferente de zero e ?) nas tags vlMovimento, vlMovimentoHono, vlTaxaMovimento ou vlTaxaMovimentoHono prevalecerá, independente do valor valorizado pelo sistema.
Se o cliente desejar que o sistema realize a valorização nos campos(vlMovimento, vlMovimentoHono, vlTaxaMovimento e vlTaxaMovimentoHono) com base nos demais campos do movimento, então as tags vlMovimento, vlMovimentoHono, vlTaxaMovimento e vlTaxaMovimentoHono deverão ser zeradas ou omitidas.
- Se apenas algumas dessas tags forem informadas, o sistema realizará a valorização do movimento calculando o valor das demais e, ao fim do processo, gravará no movimento o valor da tag informada na requisição;
  - Exemplo1: informado na tag vlMovimento = 10 e na tag vlTaxaMovimento = 0. A api considera que o valor do movimento é 10 e a taxa será definida pela valorização do sistema;
  - Exemplo2: informado na tag vlMovimento = 0 e na tag vlTaxaMovimento = 1. A api considera que o valor do movimento será definido pela valorização do sistema e o valor da taxa será 1.
- A valorização do movimento somente irá ocorrer caso o valor do movimento(vlMovimento) não tenha sido modificado anteriormente, seja via API, seja via interface no TOTVS. Ou seja, o sistema revaloriza apenas quando o vl-principal ou vl-auxiliar for igual ao vl-base-valor-sistema;
- A tag vlmovimento é composta pela soma dos campos vl-principal e vl-auxiliar;
- A tag vlTaxaMovimento é composta pela soma dos campos vl-taxa-out-uni-prin e vl-taxa-out-uni-auxi;
- A tag vlMovimentoHono é composta pela soma dos campos vl-principal e vl-auxiliar, quando o movimento for de divisão de honorários;
- A tag vlTaxaMovimentoHono é composta pela soma dos campos vl-taxa-out-uni-prin e vl-taxa-out-uni-auxi, quando o movimento for de divisão de honorários;
- Através da api não podemos modificar diretamente os campos vl-base-valor-sistema, vl-honorarios-medicos, vl-operacional e vl-filme. Estes campos são de uso do sistema;
- Maiores informações sobre valorização de movimentos podem ser consultadas em: Valorização de Procedimentos e Insumos

Expandir

title	Exemplo JSON entrada - addMovementManualRestriction

{
    "parametros": [
        {
            "nomeUsuario": "super"
        }
    ],
    "movimentos": [
        {
            "cdUnidade": 120,
            "cdUnidadePrestadora": 120,
            "cdTransacao": 2,
            "nrSerieDocOriginal": "MARV",
            "nrDocOriginal": 300,
            "nrDocSistema": 0,
            "cdTipoInsumo": 0,
            "cdInsumo": 0,
            "nrProcesso": 2,
            "nrSeqDigitacao": 2,
            "tpMovimento": "INSU",
            "id": 1,
            "glosasAdicionadas": [
                {
                    "idMovimento": 1,
                    "cdClasseErro": 6,
                    "cdGlosa": 6,
                    "dsMotivoGlosa": "Motivo glosa"
                }
            ]
        }
    ]
}

...

Expandir

title	Exemplo JSON entrada - addMovementManualRestriction

{
    "parametros": [
        {
            "nomeUsuario": "super"
        }
    ],
    "movimentos": [
        {
            "cdUnidade": 120,
            "cdUnidadePrestadora": 120,
            "cdTransacao": 2,
            "nrSerieDocOriginal": "MARV",
            "nrDocOriginal": 300,
            "nrDocSistema": 0,
            "cdTipoInsumo": 0,
            "cdInsumo": 0,
            "nrProcesso": 2,
            "nrSeqDigitacao": 2,
            "tpMovimento": "INSU",
            "id": 1,
            "glosasRemovidas": [
                {
                    "idMovimento": 1,
                    "cdClasseErro": 6,
                    "cdGlosa": 6
                }
            ]
        }
    ]
}

...

Valores aceitos para o cdTipoCob:

0 - Cobrança conforme contrato;

1 - Cobrança por custo operacional;

3 - Desconsiderar cobrança;

4 - Cobertura por intercâmbio;

6 - Cobrar somente participação;

7 - Desconsiderar cobrança participação.

Valores aceitos para o cdTipoPag:

0 - Pagamento conforme contrato;

1 - Desconsiderar Pagamento.

...

Expandir

title	Exemplo JSON entrada - addMovementManualRestriction

{
    "parametros": [
        {
            "nomeUsuario": "super"
        }
    ],
    "movimentos": [
        {
            "cdUnidade": 120,
            "cdUnidadePrestadora": 120,
            "cdTransacao": 2,
            "nrSerieDocOriginal": "MARV",
            "nrDocOriginal": 300,
            "nrDocSistema": 0,
            "cdTipoInsumo": 0,
            "cdInsumo": 0,
            "nrProcesso": 2,
            "nrSeqDigitacao": 2,
            "tpMovimento": "INSU",
            "id": 1,
            "validacao": [
                {

                    "cdTipoCob": 1,
                    "cdTipoPag": 1
                }
            ]
        }
    ]
}

...

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

...

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"
        }
    ]
}

...

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

...

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"
}

...

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.

Restrições:

Somente será permitida a alteração de dados de um documento por requisição.
Somente será permitida a alteração de documento com os movimentos com o status de Em Auditoria.
O processo não permite a alteração de movimentos incluídos via pacote de intercâmbio (SISPAC);
Ao incluir/modificar um movimento ele estará com o situação do movimento ('in-liberado-contas') 8 - Em Auditoria.
O processo permite a inclusão de movimentos no documento, sendo que os campos que não podem ser definidos serão desconsiderados.
O processo permite a exclusão de movimentos do documento.
Quando da inclusão de um documento e ou movimento, os campos que não podem ser definidos serão desconsiderados. Não havendo validações se foram gravados ou se podem ser definidos pelo usuário.

Alteração dos valores dos movimentos:

Para quaisquer requisições de modificação de movimentos com valor informado nas tags vlMovimento, vlMovimentoHono, vlTaxaMovimento ou vlTaxaMovimentoHono esses valores serão considerados prioritariamente sobre quaisquer regras de valorização. Exemplo: se em uma requisição forem alterados via de acesso, quantidade de repasse e valor do movimento, o valor do movimento informado prevalecerá, independente da revalorização ocorrida em função das alterações dos campos anteriores.
Se o cliente desejar que o sistema realize a valorização com base nos demais campos do movimento, então as tags vlMovimento, vlMovimentoHono, vlTaxaMovimento e vlTaxaMovimentoHono deverão ser zeradas ou omitidas.
- Se apenas algumas dessas tags forem informadas, o sistema realizará a valorização do movimento calculando o valor das demais e, ao fim do processo, gravará no movimento o valor da tag informada na requisição.
- A valorização do movimento somente irá ocorrer caso o valor do movimento(vlMovimento) não tenha sido modificado anteriormente, seja via API, seja via interface no TOTVS. Ou seja, o sistema revaloriza apenas quando o vl-principal ou vl-auxiliar for igual ao vl-base-valor-sistema.

Inclusão/Exclusão de movimentos:

Para inclusão de um novo movimento no documento será necessário preencher todos os campos da tag procedimentos ou insumos e da tag prestadores, somente para os movimentos que serão adicionados ou alterados. Os dados do prestador desse movimento tornam-se obrigatórios na tag prestadores. Para a inclusão de um novo movimento as tags nrProcesso e nrSeqDigitação do prestador devem ser informadas com valor zero e as tags idRegistro e idRegistroMovto não podem estar informadas com valor zero e nem com valores duplicados.
Para realizar a inclusão de um documento com os movimentos, deve-se preencher todos os campos da tag documentos com exceção dos campos cdUnidade e nrDocOriginal, assim como pelo menos um movimento (procedimento ou insumo) e ainda os campos referente a tag prestadores do movimento com as tags nrProcesso e nrSeqDigitação zerados.
Para a exclusão do movimento é necessário preencher a tag movimentosExcluidos, dentro da tag documentos, com as informações chave do movimento(nrProcesso e nrSeqDigitacao). Não poderá ser enviado o movimento excluído na tag de procedimentos/insumos.

...

{
    "documentos": [
        {
            "movimentosExcluidos": [
                {"nrProcesso": 1, "nrSeqDigitacao": 1}
            ],
        }
    ]
}

03. COMO VALIDAR AS INFORMAÇÕES Âncora
valida_inf
valida_inf

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 documento que deseja consultar.

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

...

Consultar o documento

Localizando o documento, ao clicar no link do documento é possível consultar detalhes do documento.

Consultar glosas do documento.

Templatedocumentos

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>

Árvore de páginas

Versões comparadas

Versão antiga 102

Nova versão Atual

Chave

CONTEÚDO

01. VISÃO GERAL Âncora
visao_geral
visao_geral

a. Rota
Âncora
Rota
Rota

b. saveDocument
Âncora
saveDocument
saveDocument

c. addMovementManualRestriction
Âncora
addMovementManualRestriction
addMovementManualRestriction

d. removeMovementManualRestriction
Âncora
removeMovementManualRestriction
removeMovementManualRestriction

e. validateMovementRestriction
Âncora
validateMovementRestriction
validateMovementRestriction

f. removeDocumentsByInvoice
Âncora
removeDocumentsByInvoice
removeDocumentsByInvoice

g. removeDocumentsById
Âncora
removeDocumentsById
removeDocumentsById

h. getDocumentById
Âncora
getDocumentById
getDocumentById

i. getDocumentByInvoice
Âncora
getDocumentByInvoice
getDocumentByInvoice

j. Json retornado
Âncora
retornado
retornado

02. REGRAS DE NEGÓCIO APLICADAS Âncora
regras_neg
regras_neg

Pacotes

Restrições:

Alteração dos valores dos movimentos:

Restrições:

Alteração dos valores dos movimentos:

Inclusão/Exclusão de movimentos:

03. COMO VALIDAR AS INFORMAÇÕES Âncora
valida_inf
valida_inf

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

Localize o documento que deseja consultar.

Templatedocumentos

Árvore de páginas

Histórico da Página

Versões comparadas

Versão antiga 102

Nova versão Atual

Chave

CONTEÚDO

01. VISÃO GERAL Âncoravisao_geralvisao_geral

a. Rota ÂncoraRotaRota

b. saveDocument ÂncorasaveDocumentsaveDocument

c. addMovementManualRestriction ÂncoraaddMovementManualRestrictionaddMovementManualRestriction

d. removeMovementManualRestriction ÂncoraremoveMovementManualRestrictionremoveMovementManualRestriction

e. validateMovementRestriction ÂncoravalidateMovementRestrictionvalidateMovementRestriction

f. removeDocumentsByInvoice ÂncoraremoveDocumentsByInvoiceremoveDocumentsByInvoice

g. removeDocumentsById ÂncoraremoveDocumentsByIdremoveDocumentsById

h. getDocumentById ÂncoragetDocumentByIdgetDocumentById

i. getDocumentByInvoice ÂncoragetDocumentByInvoicegetDocumentByInvoice

j. Json retornado Âncoraretornadoretornado

02. REGRAS DE NEGÓCIO APLICADAS Âncoraregras_negregras_neg

Pacotes

Restrições:

Alteração dos valores dos movimentos:

Restrições:

Alteração dos valores dos movimentos:

Inclusão/Exclusão de movimentos:

03. COMO VALIDAR AS INFORMAÇÕES Âncoravalida_infvalida_inf

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

Localize o documento que deseja consultar.

Templatedocumentos

01. VISÃO GERAL Âncora
visao_geral
visao_geral

a. Rota
Âncora
Rota
Rota

b. saveDocument
Âncora
saveDocument
saveDocument

c. addMovementManualRestriction
Âncora
addMovementManualRestriction
addMovementManualRestriction

d. removeMovementManualRestriction
Âncora
removeMovementManualRestriction
removeMovementManualRestriction

e. validateMovementRestriction
Âncora
validateMovementRestriction
validateMovementRestriction

f. removeDocumentsByInvoice
Âncora
removeDocumentsByInvoice
removeDocumentsByInvoice

g. removeDocumentsById
Âncora
removeDocumentsById
removeDocumentsById

h. getDocumentById
Âncora
getDocumentById
getDocumentById

i. getDocumentByInvoice
Âncora
getDocumentByInvoice
getDocumentByInvoice

j. Json retornado
Âncora
retornado
retornado

02. REGRAS DE NEGÓCIO APLICADAS Âncora
regras_neg
regras_neg

03. COMO VALIDAR AS INFORMAÇÕES Âncora
valida_inf
valida_inf