Linha Datasul

Árvore de páginas

Versões comparadas

Versão antiga 1

changes.mady.by.user Charles Luis Colleoni

Gravado em

comparado com

Nova versão Atual

changes.mady.by.user Charles Luis Colleoni

Gravado em

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

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

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

CONTEÚDO

  1. Visão Geral
    1. Pacotes API de integração com o Revisão de Contas
    2. Manutenção de documentos - Pacotes API de integração com o Revisão de Contas
    3. Inclusão de glosas - Pacotes API de integração com o Revisão de Contas
    4. Remoção de glosas - Pacotes API de integração com o Revisão de Contas
    5. Validação de glosas - Pacotes API de integração com o Revisão de Contas
    6. Remoção de documentos - Pacotes API de integração com o Revisão de Contas
    7. Remoção de documentos - Pacotes API de integração com o Revisão de Contas
    8. Consulta de documentos - Pacotes API de integração com o Revisão de Contas
    9. Consulta de documentos - Pacotes API de integração com o Revisão de Contas
    10. Json retornado
  2. Regras de Negócio Aplicadas
  3. Como Validar as Informações
    1. Central de Movimentação de Guias TISS
  4. Exemplo de Como Validar as Informações

01. VISÃO GERAL

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

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

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.

...

/hrc/<versao>/documentsMaintenance/

...

cdUnidadePrestadoraSimnrDocOriginal documentoSimnrDocSistemaSimanoPeriodoSimnrPeriodoSimSomente caso Ação sobre Gua for = obriganrGuiaAtendimentoNúmero da guia de autorizaçãoSiminteirointeironrSerieDocOriginalAntSérie do documento principalx(04)inteiroSimSiminteiroSimSim

Indica recém nascido, esta informação não é alterável, somente é possível informar o campo na inclusão do documento.

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

Lista com os dado do prestador executante

Campo

DescriçãoTipo dadoMáscaraObrigatórioPermite
definir na alteração		Permite definir na inclusão
cdUnidadeCódigo da unidade

Campos disponíveis na TAG "procedimentos" ou "insumos"

CampoDescriçãoTipo DadoMáscaraObrigatório na inclusãoObrigatório na alteraçãoPermite definir na inclusãoPermite
definir na alteração
idRegistroIdentificador único para o movimento (único)
inteiro
SimSimSimNão
idRegistroDocIdentificador do documentocaracter
SimSimNãoNão
idRegistroPacoteIdentificador do pacote
inteiro
SimNãoNão
Código da unidade prestadorainteiroSim
Não
SimcdTransacaoCódigo da transaçãointeiroSimNãoSimnrSerieDocOriginalNome da serie do documentocaracterx(04)
tpMovimento

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

  • A criação de documentos de reembolso não aceita a opção PACOTE
caracter
SimSimSimNão
cdTipoInsumoCódigo do tipo do insumointeiro99Obrigatório para insumo na inclusão
NãoSim
Não
cdMovimentoCódigo do
movimento
inteiro

Obrigatório na inclusãoNãoSim

Não

dsMovimento
Sequencia do documento no sistemainteiro
Descrição do movimentocaracter
NãoNão
NãoNão
dtRealizacao
Ano do período de movimentação do Revisão de Contasinteiro
Data de realização, se Data Realizacao Unica(rc0110f) e nada for informado considera a data do documentodataaaaa-mm-ddSimNão
SimSim
hrRealizacao
Período de movimentação do Revisão de Contasinteiro
Hora inicial de realização, se Data Realizacao Unica(rc0110f) e nada for informado considera a hora do documentocaracter99:99SimNão
SimSim
anoGuiaAtendimentoAno da guia de autorizaçãointeiro
hrRealizacaoFimHora final de realizaçãocaracter99:99SimNão
SimSim
cdViaAcesso
Via de acesso utilizada (TISS Tab. 61)inteiro
Somente caso Ação sobre Gua for = obriga

Sim
Não
nrGuiaPrestadorCódigo da guia do prestadorcaracterNãoSimSimcdUnidadeAntUnidade do documento principalinteiroNãoSimSimcdUnidadePrestadoraAntUnidade Prestadora do documento principal
Somente para procedimentoSomente para procedimento

ftViaAcessoPag

Fator de Honorários referente a via de acesso para pagamento. Caso a via de acesso ou o ato cirúrgico for modificado o sistema desconsiderará a informação enviada nesta tag e a  sobrescreverá com o valor calculado com base na via de acesso e ato cirúrgico informado.decimal999.99NãoNãoSim Sim

ftViaAcessoCob

Fator de Honorários referente a via de acesso para Cobrança. Caso a via de acesso ou o ato cirúrgico for modificado o sistema desconsiderará a informação enviada nesta tag e a  sobrescreverá com o valor calculado com base na via de acesso e ato cirúrgico informado.decimal999.99Não
NãoSimSim
cdTransacaoAntTransação do documento principal
tpTecUtilTécnica utilizada (TISS Tab. 48)caracter
Sim
NãoSimSim
dsInsumoGenerico
Descrição do Insumo***caracter

Obrigatório para insumos genéricosNãoSimSim
nrDocOriginalAntNúmero do documento principal
dtLimiteData Limitedata
Não
Não
Nao
Não
nrDocSistemaAntNumero de sistema do documento principal
cdAnvisaCódigo ANVISA do insumocaracter
Não
Não
Nao
Não
dtEmissaoData de emissão do documentodataaaaa-mm-ddSimSimSim
dtRealizacaoData de realização*dataaaaa-mm-ddSomente caso Data Realizacao Unica (rc0110f)SimSim
hrRealizacaoHora inicial de realização*caracter99:99Somente caso Data Realizacao Unica (rc0110f)SimSim
cdUnidadeSolicitanteUnidade do Prestador SolicitanteinteiroSimSimSimcdPrestadorSolicitanteCódigo do Prestador SolicitanteinteiroSimSimSimanoGuiaOrigemAno da Guia OrigeminteiroNãoSimSimnrGuiaOrigemNúmero da Guia OrigeminteiroNãoSimSim
dtSolicitacaoOrigemData de solicitação da Guia Origemdataaaaa-mm-ddNãoSimSim
dtAutorizacaoOrigemData de Autorização da Guia Origemdataaaaa-mm-ddNãoSimSim
cdVinculoSolicitanteVinculo do prestador solicitantecaracterSimSimSimcdEspecialidSolicitanteEspecialidade do prestador solicitantecaracterSimSimSimcdCboSolicitanteCBO do prestador solicitante - Caso em branco a Central TISS preenche com o primeiro CBO válido para a especialidade informadacaracterSimSimSimcdConselhoProfSolicConselho do profissional solicitantecaracterSomente para ExamesSimSimnrConselhoProfSolicCódigo do Conselho do profissional solicitantecaracterSomente para ExamesSimSimufConselhoProfSolicUF Conselho do profissional solicitantecaracterSomente para ExamesSimSimnmProfSolNome do profissional solicitantecaracterSomente para ExamesSimSimcdLocalAtendimentoLocal 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.)inteiroSimSimSimcdClasseHospitalarClasse Hospitalar (somente editável caso parametrizado no campo "Altera Class.Hosp." do cadastro da Transação)inteiroSomente se Altera Classe HospitalarSimSimcaraterSolicitacaoCarater da Solicitação (E-Eletiva, U-Urgencia)caracterSomente para Internação e SPSADTSimSimtpRegimInterRegime de Internação (TISS Tab. 41)**inteiroSomente para InternaçãoSimSimcdFaturamentoTipo de Faturamento (TISS Tab. 55)**inteiroSomente para InternaçãoSimSim
dtInternacaoData de Internação**dataaaaa-mm-ddSomente para InternaçãoSimSim
dtAltaData de Alta**dataaaaa-mm-ddSomente para InternaçãoSimSim
cdMotivoAltaMotivo de Alta**inteiroSomente para InternaçãoSimSim
hrInternacaoHora da internação**caracter99:99Somente para InternaçãoSimSim
hrAltaHora da Alta**caracter99:99Somente para InternaçãoSimSim
tpInterTipo de Internação (TISS Tab. 57)**inteiroSomente para InternaçãoSimSimnmDeclNascViv a nmDeclNascViv5Declaração de nascido vivo (campos até o 5)caracterNãoSimSimqtNascMortosQuantidade de nascidos mortosinteiroNãoSimSimqtNascVivosTermoQuantidade de nascidos vivos não prematurosinteiroNãoSimSimqtNascVivosPremQuantidade de nascidos vivos prematurosinteiroNãoSimSimcidObito1 a cidObito5CID de óbito nascidos mortos (campos do 1 a 5)caracterNãoSimSimnrDeclaracaoObito1 a nrDeclaracaoObito5Declaração de óbito nascidos mortos (campos 1 a 5)caracterNãoSimSimindAcidenteIndicador de acidente (TISS Tab.36)inteiroNãoSimSimtpConsultaTipo de Consulta (Transação de consulta - TISS Tab. 52)inteiroSomente para ConsultaSimSimtpAtendTipo de Atendimento (Transação de SADT - TISS Tab. 50)inteiroSomente para ExamesSimSimcdCid,cdCid2,cdCid3CID do atendimentocaracterNãoSimSimcdCidObitoCID do óbito**caracterSomente para InternaçãoSimSimnrDeclaracaoObitoDeclaração de óbito**caracterSomente para InternaçãoSimSimdsIndClinicaIndicaçã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.

caracterNãoSimSimdsObservacaoObservação do documentocaracterNãoSimSimanoFaturaAno da fatura do prestadorinteiroNãoNãoSimanoNDRAno da NDR do prestadorinteiroNãoNãoSimnrSerieFaturaSérie da fatura do prestadorcaracterNãoNãoSimnrSerieNDRSérie da NDR do prestadorcaracterNãoNãoSimnrFaturaNúmero da fatura do prestadorcaracterNãoNãoSimnrNDRNúmero da NDR do prestadorcaracterNãoNãoSimnrLoteNúmero do loteinteiroNãoNãoNãocdUnidadeCarteiraCódigo da unidade da carteira do beneficiáriointeiroSimNãoSimcdCarteiraUsuarioCódigo da carteira do beneficiáriointeiroSimNãoSim

cdUnidadePrestPrincipal

Código da unidade do prestador principalinteiroSimNãoSimcdPrestadorPrincipalCódigo do prestador principalinteiroSimNãoSimcdVinculoPrestPrincipalCódigo do vinculo do prestador principalinteiroNãoNãoSiminStatusDoctoStatus do documento (1- Pendente Análise de Glosa, 2- Pendente Liberação, 3- Liberado, 4- Pago, 5- Faturado, 6- Pago e Faturado, 7- Cancelado)inteiroNãoNãoNãourlChaveChavecaracterNãoNãoNãocdUnidCdPrestExecCódigo da unidade e Prestador executantecaracterNãoNãoNãonmMedicoAuditorNome do Médico AuditorcaracterSomente para Internação quando obriga médico auditorSimSim

cdCrmMedicoAuditor

CRM do Médico AuditorcaracterSomente para Internação quando parametrizado para obrigar médico auditorSimSimcdUfMedicoAuditorUF do conselho do Médico AuditorcaracterSomente para Internação quando parametrizado para obrigar médico auditorSimSimnmEnfermAuditorNome do enfermeiro auditorcaracterSomente para Internação quando parametrizado para obrigar enfermeiro auditorSimSimcdCorenEnfermAuditorCOREN do enfermeiro auditorcaracterSomente para Internação quando parametrizado para obrigar enfermeiro auditorSimSimcdUfEnfermAuditorUF conselho do enfermeiro auditorcaracterSomente para Internação quando parametrizado para obrigar enfermeiro auditorSimSimcodLotePrestadorTissCódigo do lote do prestadorinteiroNãoNãoNão

cdUnidadeImp

Código da unidade do Lote de ImportaçãointeiroNãoNãoNãocdPrestadorImpCódigo do prestador do Lote de ImportaçãointeiroNãoNãoNãonrLoteImpNúmero do Lote de ImportaçãointeiroNãoNãoNãonrSequenciaImpNúmero da sequencia do Lote de ImportaçãointeiroNãoNãoNãologAtendimRNlógicoSomente para InternaçãonãoSiminAcidenteIndicador de acidenteinteiroSomente para Internação ou se o documento já possuir informação junto a base.simSim
dtDigitacaoData de digitação do documentodataaaaa-mm-ddNãoNãoNão
hrDigitacaoHora de digitação do documentocaracter99:99NãoNãoNão
CampoDescriçãoTipo DadoMáscaraObrigatórioPermite
definir na alteração		Permite definir na inclusão
idRegistroIdentificador ú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ãoSim
cdTipoInsumoCódigo do tipo do insumointeiro99Obrigatório para insumo na inclusãoNãoSim
cdMovimentoCódigo do movimento
inteiroObrigatório na inclusão

Não

SimdsMovimentoDescrição do movimentocaracterNãoNãoNão
dtRealizacaoData de realização, se Data Realizacao Unica(rc0110f) e nada for informado considera a data do documentodataaaaa-mm-ddSimSimSim
hrRealizacaoHora inicial de realização, se Data Realizacao Unica(rc0110f) e nada for informado considera a hora do documentocaracter99:99SimSimSim
hrRealizacaoFimHora final de realizaçãocaracter99:99SimSimSim
cdViaAcessoVia 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
CampoDescriçãoTipo DadoMáscaraObrigatórioPermite
definir na alteração		Permite definir na inclusão
idRegistroMovtoIdentificador 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)SimSim
cdUfConselhoUF do conselho do prestador executantecaracterx(02)Somente para Prestadores Jurídicos e Obriga Procedimento como sim (pr0110h)SimSim
codCPFProfissionalExecCPF 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çainteiroSimSimSim
lgAdicionalUrgenciaCobra adicional de urgência?lógicotrue/falseNãoSimSim
lgUrgenciaIndica Urgêncialógicotrue/falseNãoSimSim
cdnNivTissNí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ão
lgDivisaoHonorarioPossui divisão de honoráriológicotrue/falsePara dividir honoráriosNãoSim
cdUnidadePrestDiviHonoCó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
titleExemplo 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"

              }

       ]

}

...

Expandir
titleExemplo 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
titleExemplo 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
titleExemplo 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

...

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

...

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

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.

Exemplo:

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

...

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:

Image Removed

Através da Busca Avançada é possível pesquisar o documento:

Image Removed

...

nmFornecedorNome do Fornecedor do insumocaracter
NãoNãoNaoNão
nrNotaFornecedorNúmero da Nota do fornecedor do insumocaracter
NãoNãoNãoNão
desReferMaterFabricanReferência Material Fabricante do insumocaracter
Obrigatório para insumos genéricosNãoSimNão

cdModulo

Código do módulo de cobertura do beneficiáriointeiro
NãoNãoNãoNão
cdUnidOrigemSispacCódigo da unidade origem do pacote de intercâmbiocaracter
NãoNãoNãoNão
cdPacoteSispacCódigo do pacote de intercâmbiocaracter
NãoNãoNãoNão
cdTipoAcomodacaoSispacTipo de Acomodação do pacote de intercâmbiocaracter
NãoNãoNãoNão
cnpjcpfSispacCNPJ ou CPF do prestador do pacote de intercâmbiocaracter
NãoNãoNãoNão
 inLiberadoContasIndicador da situação do movimento  caracter
NãoNãoNão Não 
cdTipoPercentualFator de redução ou acréscimo, deve ser informado o Tipo de Percentual.inteiro
NãoNãoSimSim
inAtoCirurgico

Permite informar a qual Ato Cirúrgico o procedimento pertence. Obedecendo o seguinte domínio.

0 = Não Informado
1 = Primeiro/Único
2 = Segundo
3 = Terceiro
4 = Quarto

inteiro
NãoNãoSimSim
prestadores

Lista com os dado do prestador executante

CampoDescriçãoTipo DadoMáscaraObrigatório na inclusãoObrigatório na alteraçãoPermite definir na inclusãoPermite
definir na alteração
idRegistroMovtoIdentificador do movimentointeiro
SimSimSimNão
nrProcessoNúmero do processo do movimentointeiro
SimSimDeve ser 0Não
nrSeqDigitacaoNúmero de sequencia do movimentointeiro
SimSimDeve ser 0Não
cdUnidadeUnidade do prestadorinteiro
SimNãoSimSim
cdPrestadorCódigo do prestadorinteiro
SimNãoSimSim
nmProfissionalExecNome do profissional executantecaracter
Somente para Prestadores Jurídicos e Obriga Procedimento como sim (pr0110h)NãoSimSim
cdConselhoConselho do prestador executantecaracter
Somente para Prestadores Jurídicos e Obriga Procedimento como sim (pr0110h)NãoSimSim
nrRegistroCódigo do conselho do prestador executantecaracter
Somente para Prestadores Jurídicos e Obriga Procedimento como sim (pr0110h)NãoSimSim
cdUfConselhoUF do conselho do prestador executantecaracterx(02)Somente para Prestadores Jurídicos e Obriga Procedimento como sim (pr0110h)NãoSimSim
codCPFProfissionalExecCPF do profissional executantecaracter99999999999Somente para Prestadores Jurídicos e Obriga Procedimento como sim (pr0110h)NãoNã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).decimal
SimNãoSimSim
vlCobradoValor cobrado do movimento (é recalculado caso "Considera Valor Cobrado" do cadastro da Transação).decimal
NãoNãoSimSim
vlTaxaCobradoValor da taxa cobrado  do movimentodecimal
NãoNãoSimNão
vlTaxaMovimentoValor da taxa do movimentodecimal
NãoNãoSimSim
qtMovimentoQuantidade do movimentodecimal
SimNãoSimSim
vlMovimentoValor do movimento*decimal
NãoNãoSimSim
qtVezesTabelaPagMultiplicador da tabela de pagamentointeiro
NãoNãoSimSim
qtVezesTabelaCobMultiplicador da tabela de cobrançainteiro
NãoNãoSimSim
cdCboCBO do profissional executantecaracter
SimNãoSimSim
cdEspecialidEspecialidade do prestador executanteinteiro
SimNãoSimSim
cdPorteAnestesicoPorte anestésico pagamentointeiro
SimNãoSimSim
cdPorteAnestesicoCobPorte anestésico cobrançainteiro
SimNãoSimSim
lgAdicionalUrgenciaCobra adicional de urgência?lógicotrue/falseNãoNãoSimSim
lgUrgenciaIndica Urgêncialógicotrue/falseNãoNãoSimSim
cdnNivTissNível do prestador executante. Quando informado como "6" (anestesista) ou "7" (auxiliar de anestesista) o procedimento será consistido como de anestesista.inteiro
SimNãoSimSim
cdTipoVinculoTipo de vinculo do prestador executante (valor é considerado do Vinculo Executante do Cadastro da Transação)inteiro
NãoNãoNãoNão
vlGlosadoValor glosado do movimentodecimal
NãoNãoNãoNão

vlDescontoPrestador

Valor desconto do prestadordecimal
NãoNãoNãoNão
lgDivisaoHonorarioPossui divisão de honoráriológicotrue/falsePara dividir honoráriosNãoSimNão
cdUnidadePrestDiviHonoCódigo da unidade do prestador da divisão de honoráriointeiro
Para dividir honoráriosNãoSimSim
cdPrestadorDiviHonoCódigo do prestador da divisão de honoráriointeiro
Para dividir honoráriosNãoSimSim
cdEspPrestDiviHonoEspecialidade do prestador da divisão de honoráriointeiro
Para dividir honoráriosNãoSimSim
cdCboDiviHonoCBO do prestador da divisão de honoráriocaracter
Para dividir honoráriosNãoSimSim
cdTipoVincDiviHonoVinculo do prestador da divisão de honoráriointeiro
NãoNãoSimSim
vlCobradoHonoValor cobrado divisão honoráriodecimal
NãoNãoSimSim
vlTaxaCobradoHonoValor da taxa cobrada divisão honoráriodecimal
NãoNãoSimSim
vlMovimentoHonoValor movimento divisão honoráriodecimal
Para dividir honoráriosNãoSimSim
vlTaxaMovimentoHonoValor da taxa movimento divisão honoráriodecimal
NãoNãoSimSim
vlGlosadoHonoValor glosa divisão honoráriodecimal
NãoNãoNãoNão
inStatus

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.

int
NãoNãoNãoNão


...

      



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>