Histórico da Página
...
- Visão Geral
- Rota
- Manutenção de documentos - saveDocument
- Remoção de documentos - removeDocumentsById
- Consulta de documentos - getDocumentById
- Json retornado retornado
01. VISÃO GERAL Âncoravisao_geral visao_geral
visao_geral | |
visao_geral |
...
A API Manutenção de Documentos de Reembolso tem o objetivo de consultar, criar, atualizar e eliminar documentos de reembolso do Revisão de Contas.
O método refundDocumentsMaintenance da API fornece a opção de modificar os dados do documento e incluir, alterar ou excluir movimentos do documento, seguindo as regras de negócio explicadas na sessão 2. Regras de Negócio Aplicadas.
...
/hrc/<versao>/refundDocumentsMaintenance/
A transação enviada no campo cdTransacao deve estar marcada como transação de reembolso (rc0110f).
b. saveDocument ÂncorasaveDocument saveDocument
saveDocument | |
saveDocument |
Na inclusão do documento os campos cdUnidade e nrDocOriginal devem ser enviados com o valor 0.
Campo | Descrição | Tipo dado | Máscara | Obrigatório | Permite definir na alteração | Permite definir na inclusão | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
cdUnidade | Código da unidade | inteiro | Sim | Não | Não | ||||||||||||||||||
cdUnidadePrestadora | Código da unidade prestadora | inteiro | Sim | Não | Sim | ||||||||||||||||||
cdTransacao | Código da transação | inteiro | Sim | Não | Sim | ||||||||||||||||||
nrSerieDocOriginal | Nome da serie do documento | caracter | x(04) | Sim | Não | Sim | |||||||||||||||||
nrDocOriginal | Código do documento | inteiro | Sim | Não | Não | ||||||||||||||||||
nrDocSistema | Sequencia do documento no sistema | inteiro | Sim | Não | Não | ||||||||||||||||||
anoPeriodo | Ano do período de movimentação do Revisão de Contas | inteiro | Sim | Sim | Sim | ||||||||||||||||||
nrPeriodo | Período de movimentação do Revisão de Contas | inteiro | Sim | Sim | Sim | ||||||||||||||||||
anoGuiaAtendimento | Ano da guia de autorização | inteiro | Somente caso Ação sobre Gua for = obriga | Sim | Sim | ||||||||||||||||||
nrGuiaAtendimento | Número da guia de autorização | inteiro | Somente caso Ação sobre Gua for = obriga | Sim | Sim | ||||||||||||||||||
nrGuiaPrestador | Código da guia do prestador | caracter | Não | Sim | Sim | ||||||||||||||||||
cdUnidadeAnt | Unidade do documento principal | inteiro | Não | Sim | Sim | ||||||||||||||||||
cdUnidadePrestadoraAnt | Unidade Prestadora do documento principal | inteiro | Não | Sim | Sim | ||||||||||||||||||
cdTransacaoAnt | Transação do documento principal | inteiro | Não | Sim | Sim | ||||||||||||||||||
nrSerieDocOriginalAnt | Série do documento principal | caracter | x(04) | Não | Sim | Sim | |||||||||||||||||
nrDocOriginalAnt | Número do documento principal | inteiro | Não | Sim | Sim | ||||||||||||||||||
nrDocSistemaAnt | Numero de sistema do documento principal | inteiro | Não | Sim | Sim | ||||||||||||||||||
dtEmissao | Data de emissão do documento | data | aaaa-mm-dd | Sim | Sim | Sim | |||||||||||||||||
dtRealizacao | Data de realização* | data | aaaa-mm-dd | Somente caso Data Realizacao Unica (rc0110f) | Sim | Sim | |||||||||||||||||
hrRealizacao | Hora inicial de realização* | caracter | 99:99 | Somente caso Data Realizacao Unica (rc0110f) | Sim | Sim | |||||||||||||||||
cdUnidadeSolicitante | Unidade do Prestador Solicitante | inteiro | Sim | Sim | Sim | ||||||||||||||||||
cdPrestadorSolicitante | Código do Prestador Solicitante | inteiro | Sim | Sim | Sim | ||||||||||||||||||
anoGuiaOrigem | Ano da Guia Origem | inteiro | Não | Sim | Sim | ||||||||||||||||||
nrGuiaOrigem | Número da Guia Origem | inteiro | Não | Sim | Sim | ||||||||||||||||||
dtSolicitacaoOrigem | Data de solicitação da Guia Origem | data | aaaa-mm-dd | Não | Sim | Sim | |||||||||||||||||
dtAutorizacaoOrigem | Data de Autorização da Guia Origem | data | aaaa-mm-dd | Não | Sim | Sim | |||||||||||||||||
cdVinculoSolicitante | Vinculo do prestador solicitante | caracter | Sim | Sim | Sim | ||||||||||||||||||
cdEspecialidSolicitante | Especialidade do prestador solicitante | caracter | Sim | Sim | Sim | ||||||||||||||||||
cdCboSolicitante | CBO do prestador solicitante - Caso em branco a Central TISS preenche com o primeiro CBO válido para a especialidade informada | caracter | Sim | Sim | Sim | ||||||||||||||||||
cdConselhoProfSolic | Conselho do profissional solicitante | caracter | Somente para Exames | Sim | Sim | ||||||||||||||||||
nrConselhoProfSolic | Código do Conselho do profissional solicitante | caracter | Somente para Exames | Sim | Sim | ||||||||||||||||||
ufConselhoProfSolic | UF Conselho do profissional solicitante | caracter | Somente para Exames | Sim | Sim | ||||||||||||||||||
nmProfSol | Nome do profissional solicitante | caracter | Somente para Exames | Sim | Sim | ||||||||||||||||||
cdLocalAtendimento | Local de atendimento (caso a transação esteja como "Pede local Atendimento'"= Sim, irá gravar a informação do campo Local Atendimento do cadastro. Se estiver como Não, não vai gravar o local.) | inteiro | Sim | Sim | Sim | ||||||||||||||||||
cdClasseHospitalar | Classe Hospitalar (somente editável caso parametrizado no campo "Altera Class.Hosp." do cadastro da Transação) | inteiro | Somente se Altera Classe Hospitalar | Sim | Sim | ||||||||||||||||||
caraterSolicitacao | Carater da Solicitação (E-Eletiva, U-Urgencia) | caracter | Somente para Internação e SPSADT | Sim | Sim | ||||||||||||||||||
tpRegimInter | Regime de Internação (TISS Tab. 41)** | inteiro | Somente para Internação | Sim | Sim | ||||||||||||||||||
cdFaturamento | Tipo de Faturamento (TISS Tab. 55)** | inteiro | Somente para Internação | Sim | Sim | ||||||||||||||||||
dtInternacao | Data de Internação** | data | aaaa-mm-dd | Somente para Internação | Sim | Sim | |||||||||||||||||
dtAlta | Data de Alta** | data | aaaa-mm-dd | Somente para Internação | Sim | Sim | |||||||||||||||||
cdMotivoAlta | Motivo de Alta** | inteiro | Somente para Internação | Sim | Sim | ||||||||||||||||||
hrInternacao | Hora da internação** | caracter | 99:99 | Somente para Internação | Sim | Sim | |||||||||||||||||
hrAlta | Hora da Alta** | caracter | 99:99 | Somente para Internação | Sim | Sim | |||||||||||||||||
tpInter | Tipo de Internação (TISS Tab. 57)** | inteiro | Somente para Internação | Sim | Sim | ||||||||||||||||||
nmDeclNascViv a nmDeclNascViv5 | Declaração de nascido vivo (campos até o 5) | caracter | Não | Sim | Sim | ||||||||||||||||||
qtNascMortos | Quantidade de nascidos mortos | inteiro | Não | Sim | Sim | ||||||||||||||||||
qtNascVivosTermo | Quantidade de nascidos vivos não prematuros | inteiro | Não | Sim | Sim | ||||||||||||||||||
qtNascVivosPrem | Quantidade de nascidos vivos prematuros | inteiro | Não | Sim | Sim | ||||||||||||||||||
cidObito1 a cidObito5 | CID de óbito nascidos mortos (campos do 1 a 5) | caracter | Não | Sim | Sim | ||||||||||||||||||
nrDeclaracaoObito1 a nrDeclaracaoObito5 | Declaração de óbito nascidos mortos (campos 1 a 5) | caracter | Não | Sim | Sim | ||||||||||||||||||
indAcidente | Indicador de acidente (TISS Tab.36) | inteiro | Não | Sim | Sim | ||||||||||||||||||
tpConsulta | Tipo de Consulta (Transação de consulta - TISS Tab. 52) | inteiro | Somente para Consulta | Sim | Sim | ||||||||||||||||||
tpAtend | Tipo de Atendimento (Transação de SADT - TISS Tab. 50) | inteiro | Somente para Exames | Sim | Sim | ||||||||||||||||||
cdCid,cdCid2,cdCid3 | CID do atendimento | caracter | Não | Sim | Sim | ||||||||||||||||||
cdCidObito | CID do óbito** | caracter | Somente para Internação | Sim | Sim | ||||||||||||||||||
nrDeclaracaoObito | Declaração de óbito** | caracter | Somente para Internação | Sim | Sim | ||||||||||||||||||
dsIndClinica | Indicação Clínica Para as guias de reembolso e odontologicas, não é obrigatório. Obrigatório para todas as guias com tipo de atendimento, conforme parametrizado no cadastro hac.attendanceType. | caracter | Não | Sim | Sim | ||||||||||||||||||
dsObservacao | Observação do documento | caracter | Não | Sim | Sim | ||||||||||||||||||
anoFatura | Ano da fatura do prestador | inteiro | Não | Não | Sim | ||||||||||||||||||
anoNDR | Ano da NDR do prestador | inteiro | Não | Não | Sim | ||||||||||||||||||
nrSerieFatura | Série da fatura do prestador | caracter | Não | Não | Sim | ||||||||||||||||||
nrSerieNDR | Série da NDR do prestador | caracter | Não | Não | Sim | ||||||||||||||||||
nrFatura | Número da fatura do prestador | caracter | Não | Não | Sim | ||||||||||||||||||
nrNDR | Número da NDR do prestador | caracter | Não | Não | Sim | ||||||||||||||||||
nrLote | Número do lote | inteiro | Não | Não | Não | ||||||||||||||||||
cdUnidadeCarteira | Código da unidade da carteira do beneficiário | inteiro | Sim | Não | Sim | ||||||||||||||||||
cdCarteiraUsuario | Código da carteira do beneficiário | inteiro | Sim | Não | Sim | ||||||||||||||||||
cdUnidadePrestPrincipal | Código da unidade do prestador principal | inteiro | Sim | Não | Sim | ||||||||||||||||||
cdPrestadorPrincipal | Código do prestador principal | inteiro | Sim | Não | Sim | ||||||||||||||||||
cdVinculoPrestPrincipal | Código do vinculo do prestador principal | inteiro | Não | Não | Sim | ||||||||||||||||||
inStatusDocto | Status do documento (1- Pendente Análise de Glosa, 2- Pendente Liberação, 3- Liberado, 4- Pago, 5- Faturado, 6- Pago e Faturado, 7- Cancelado) | inteiro | Não | Não | Não | ||||||||||||||||||
urlChave | Chave | caracter | Não | Não | Não | ||||||||||||||||||
cdUnidCdPrestExec | Código da unidade e Prestador executante | caracter | Não | Não | Não | ||||||||||||||||||
nmMedicoAuditor | Nome do Médico Auditor | caracter | Somente para Internação quando obriga médico auditor | Sim | Sim | ||||||||||||||||||
cdCrmMedicoAuditor | CRM do Médico Auditor | caracter | Somente para Internação quando parametrizado para obrigar médico auditor | Sim | Sim | ||||||||||||||||||
cdUfMedicoAuditor | UF do conselho do Médico Auditor | caracter | Somente para Internação quando parametrizado para obrigar médico auditor | Sim | Sim | ||||||||||||||||||
nmEnfermAuditor | Nome do enfermeiro auditor | caracter | Somente para Internação quando parametrizado para obrigar enfermeiro auditor | Sim | Sim | ||||||||||||||||||
cdCorenEnfermAuditor | COREN do enfermeiro auditor | caracter | Somente para Internação quando parametrizado para obrigar enfermeiro auditor | Sim | Sim | ||||||||||||||||||
cdUfEnfermAuditor | UF conselho do enfermeiro auditor | caracter | Somente para Internação quando parametrizado para obrigar enfermeiro auditor | Sim | Sim | ||||||||||||||||||
codLotePrestadorTiss | Código do lote do prestador | inteiro | Não | Não | Não | ||||||||||||||||||
cdUnidadeImp | Código da unidade do Lote de Importação | inteiro | Não | Não | Não | ||||||||||||||||||
cdPrestadorImp | Código do prestador do Lote de Importação | inteiro | Não | Não | Não | ||||||||||||||||||
nrLoteImp | Número do Lote de Importação | inteiro | Não | Não | Não | ||||||||||||||||||
nrSequenciaImp | Número da sequencia do Lote de Importação | inteiro | Não | Não | Não | ||||||||||||||||||
logAtendimRN | Indica recém nascido, esta informação não é alterável, somente é possível informar o campo na inclusão do documento. | lógico | Somente para Internação | não | Sim | 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ãoNão | Não | Não | |||||||||||||||||
hrDigitacao | Hora de digitação do documento | caracter | hhmmss | Não | desVersaoTiss | Versão TISS - Versão API V2 | caracter | Sim (versão API V2) | Não | SimNão | |||||||||||||
regimeAtendimentonmDeclObt | Regime de Atendimento - Versão API V2 | inteiro | Somente para Exames e Consultas (versão API V2) | Sim | Sim | saudeOcupacional | Saúde Ocupacional - Versão API V2 | inteiro | Somente para Exames e Consultas (versão API V2) | Sim | Sim | coberturaEspecial | Cobertura Especial | inteiro | Somente para Exames e Consultas (versão API V2) | Sim | Sim | Nome declaração de óbito | caracter | Não | Não | Não | |
cdUnidadeReemb | Código da Unidade de reembolso | inteiro | Sim quando for alteração | Sim | Não | ||||||||||||||||||
cdPrestadorReemb | Código do prestador de reembolso | inteiro | Sim quando for alteração | Sim | Não | tag: 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 |
Create
Na inclusão do documento os campos cdUnidade e nrDocOriginal devem ser enviados com o valor 0.
Expandir | ||
---|---|---|
| ||
{ } |
Update
Na alteração do documento os campos cdUnidade e nrDocOriginal devem ser preenchidos.
Expandir | ||
---|---|---|
| ||
{ |
...
Para retornar as informações de procedimentos, prestadores e insumos é necessário passar por parâmetro estas informações na requisição.
e. Json retornado
Âncora | ||||
---|---|---|---|---|
|
...