API de Pacotes de Intercâmbio - SISPAC

01. VISÃO GERAL

Esta API tem como finalidade a busca dos Pacotes de Intercâmbio - SISPAC através de um documento do Revisão de Contas Médicas.

02. MÉTODOS

Método	Descrição	Tipo
GET	Realizar uma consultar os dados dos pacotes de intercâmbio (SISPAC) de um documento específico	GET
UPDATE	Realizar a alteração de valores reconhecidos de pacotes de intercâmbio (SISPAC)	POST
COMPOSITION	Realizar uma consulta da composição do Pacote	GET
DENIALPACKAGE	Realizar uma consulta das glosas do Pacote	GET

03. REQUISIÇÃO

Método GET:

Em seguida descrevemos os campos que podem ser enviados na requisição, alguns serão utilizados para filtrar os dados dos documentos do Revisão de Contas Médicas, outros modificam a quantidade de dados retornados na resposta da requisição ou mudam a ordenação dos resultados.

Campo	Descrição	Tipo	Obrigatório?	Formato
pageSize	Número de registros retornados. Neste caso será quantos registros de pacotes de intercâmbio será retornado dentro do documento.	Numérico	Não (default 20)	999999
page	Número da página a ser retornada.	Numérico	Não (default 1)	999999
unidadePrestadora	Utilizado para filtrar os documentos através da unidade prestadora do documento.	Numérico	Sim	9999
transacao	Utilizado para filtrar os documentos através da transação do documento.	Numérico	Sim	99
serie	Utilizado para filtrar os documentos através da série do documento.	Alfanumérico	Sim	x(4)
documento	Utilizado para filtrar os documentos através do número do documento.	Numérico	Sim	99999999
sequencia	Utilizado para filtrar os documentos através da sequencia do documento.	Numérico	Sim	999999999

Método UPDATE:

Em seguida descrevemos os campos que podem ser enviados na requisição, utilizados para filtrar os dados do pacote de intercâmbio.

Campo	Descrição	Tipo	Obrigatório?	Formato
Dados dentro do JsonArray TAG pacotesIntercambio
idPacote	Utilizado para filtrar o pacote através do seu identificador único.	Numérico	Sim	>>>>>9
vlTaxaReconhecido	Utilizado para informar o valor da taxa reconhecida.	Decimal	Não	>>>>9.99
vlPacoteReconhecido	Utilizado para informar o valor do pacote reconhecido.	Decimal	Não	>>>>9.99
vlFatorReconhecido	Utilizado para informar o valor do fator reconhecido.	Decimal	Não	>>>>9.99

Exemplo de requisição para o método UPDATE:

Requisição para o método UPDATE

{
    "pacotesIntercambio":[
        {
            "idPacote": 93,
            "vlTaxaReconhecido": 100,
            "vlPacoteReconhecido": 100.00,
            "vlFatorReconhecido": 1.3
        },
        {
            "idPacote": 84,
            "vlTaxaReconhecido": 200,
            "vlPacoteReconhecido": 200.00,
            "vlFatorReconhecido": 0.8
        }
    ]
}

Método COMPOSITION:

Realiza uma consulta de um pacote SISPAC especifico retornando os dados da composição do pacote.

- Deve ser informado a URL da api com o ID do pacote (ver os exemplos abaixo).

Método DENIALPACKAGE:

Realiza uma consulta de um pacote SISPAC especifico retornando os dados das glosas do pacote junto com seus movimentos.

- Deve ser informado a URL da api com o ID do pacote (ver os exemplos abaixo).

03. RESULTADO

Método GET:

Em seguida descrevemos os campos que podem ser retornados na requisição.

Dados dentro do JsonArray TAG ITEMS
numRegisters	Número de registros retornados.	Numérico
hasNext	Variável responsável pela a indicação de registros além do retornado através desta paginação.	Logical
items	JsonArray que contém o objeto do documento.	JsonArray
unidade	Unidade que realizou a criação do documento. Sempre será a unidade operando o sistema.	Numérico
unidadePrestadora	Unidade que executou o documento.	Numérico
transacao	Transação à qual o documento pertence.	Numérico
serieDocumento	Série à qual o documento pertence.	Alfanumérico
documentoOriginal	Número do documento no Revisão de Contas Médicas.	Numérico
documentoSistema	Número Sequencial de controle utilizado pelo sistema para diferenciar documentos em alguns casos.	Numérico
pacotesIntercambio	JsonArray que contém o objeto do Pacote de Intercâmbio.	JsonArray
Dados dentro do JsonArray TAG pacotesIntercambio
unidadeExec	Unidade Prestador Executante	Numérico
prestadorExec	Código Prestador Executante	Numérico
dataExecucao	Data de Execução	Alfanumérico (AAAA/MM/DD)
horaInicial	Hora Inicial	Alfanumérico (HH:MM:SS)
horaFinal	Hora Final	Alfanumérico (HH:MM:SS)
qtdCobrada	Quantidade Cobrada	Decimal
vlPacoteCobrado	Valor Cobrado do Pacote	Decimal
vlFatorCobrado	Fator Cobrado do Pacote	Decimal
vlTaxaCobrado	Taxa Cobrado do Pacote	Decimal
vlPacoteReconhecido	Valor Reconhecido do Pacote	Decimal
vlFatorReconhecido	Valor Reconhecido do Pacote	Decimal
vlTaxaCobrado	Valor Reconhecido do Pacote	Decimal
equipeProfissional	JsonArray que contém a equipe de profissionais do pacote.	JsonArray
pacoteIntercambio	JsonArray que contém o pacote do documento.	JsonArray
Dados dentro do JsonArray TAG equipeProfissional
registroProfissional	Registro Profissional	Alfanumérico
tipoParticipacao	Tipo de Participação	Alfanumérico
unidadePrestador	Unidade do Prestador	Numérico
prestador	Código do Prestador	Numérico
cpfProfissional	CPF do Profissional	Alfanumérico
nomeProfissional	Nome do Profissional	Alfanumérico
ufConselhoProfissional	UF do Conselho do Profissional	Numérico
cboProfissional	CBO do Profissional	Alfanumérico
cnpjProfissional	CNPJ do Profissional	Alfanumérico
siglaConselhoProfissional	Sigla do Conselho do Profissional	Alfanumérico
Dados dentro do JsonArray TAG pacoteIntercambio
dataAprovacaoReprovacao	Data da Aprovação	Alfanumérico (AAAA/MM/DD)
dataInicioVigencia	Data Início de Vigência	Alfanumérico (AAAA/MM/DD)
dataFimVigencia	Data Fim de Vigência	Alfanumérico (AAAA/MM/DD)
unidadeOrigem	Unidade Origem	Numérico
nomeUnidadeOrigem	Nome Unidade Origem	Alfanumérico
pacote	Código do Pacote	Numérico
statusPacote	Status do Pacote	Numérico
item	Item Principal	Numérico
descricaoItem	Descrição do Item	Alfanumérico
qtdeServico	Quantidade Serviço	Numérico
tipoAcomodacao	Tipo de Acomodação	Alfanumérico
tipoInternacao	Tipo de Internação	Numérico
especialidade	Especialidade	Numérico
dataPublicacao	Data de Publicação	Alfanumérico (AAAA/MM/DD)
indicadorOpme	Indicador de OPME	Numérico
etiquetaPacote	Etiqueta	Numérico
tipoRede	Tipo de Rede	Numérico
indicadorHm	Indicador de HM	Numérico
indicadorAuxiliar	Indicador de Auxiliar	Numérico
indicadorDiaria	Indicador de Diária	Numérico
indicadorAnestesista	Indicador de Anestesista	Numérico
valorInsumo	Valor do Insumo do Pacote	Numérico
valorTotal	Valor Total do do Pacote	Decimal
versaoPacote	Versão Pacote	Numérico
valorOpme	Valor do OPME	Decimal
valorPacote	Valor so Pacote	Decimal
valorMaterial	Valor de Material	Decimal
valorMedicamento	Valor de Medicamento	Decimal
valorDiarias	Valor de Diárias	Decimal
valorTaxGas	Valor de Taxas e Gases	Decimal
valorProc	Valor Procedimento	Decimal
tipoPacote	Tipo do Pacote do Pacote	Decimal
prestadores	JsonArray que contém os prestadores	JsonArray
detalhes	JsonArray que contém os detalhes	JsonArray
permiteConsultaAutorizacao	Permite consulta de autorização para o pacote.	Logical
Dados dentro do JsonArray TAG prestadores
codigoPrestador	Código do Prestador	Numérico
cnes	CNES do Prestador	Alfanumérico
nomePrestador	Nome do Prestador	Alfanumérico
cpfCnpj	CPF/CNPJ do Prestador	Alfanumérico
Dados dentro do JsonArray TAG detalhes
item	Código do Item	Alfanumérico
quantidadeServico	Quantidade do Serviço	Decimal
tipoComposicao	Tipo da Composição	Numérico
tipoTabela	Tipo da Tabela	Alfanumérico
descricaoItem	Descrição do Item	Alfanumérico
valorTotal	Valor Total do Item	Decimal
unidadeMedida	Unidade de Medida do Item	Numérico

Método UPDATE:

Dados dentro do JsonArray TAG messages
code	Código da mensagem	Alfanumérico
details	Detalhes da mensagem	Alfanumérico
message	Descrição da mensagem	Alfanumérico
type	Tipo de mensagem	Alfanumérico
helpMessage	Ajuda da mensahem	Alfanumérico

04. EXEMPLOS

Métodos GET:

Requisição:

- http://servidor:porta/dts/datasul-rest/resources/prg/hrc/v1/packageSispac/get/?unidadePrestadora={unidadePrestadora}&transacao={transacao}&serie={serieDocumento}&documento={documentoOriginal}&sequencia={documentoSistema}

Resposta HTTP 200:

Resposta HTTP 200

Exemplo de resposta (INFO) quando nenhum documento é encontrado (Resposta HTTP 200):

Resposta HTTP 200 - INFO

{
    "numRegisters": 0,
    "messages": [
        {
            "code": "DOC_NOT_FOUND",
            "details": "Verifique os parametros informados: unidadePrestadora, transacao, serie, documento, sequencia",
            "message": "Nenhum documento encontrado.",
            "type": "INFO",
            "helpMessage": ""
        }
    ],
    "hasNext": false,
    "items": []
}

Resposta em casos que ocorrem erros (Resposta HTTP 400):

Resposta HTTP 400

{
    "detailedMessage": "Verifique se os parametros obrigatorios foram informados: unidadePrestadora, transacao, serie, documento, sequencia",
    "code": "1",
    "message": "Nao foi possivel encontrar a tabela de filtros.",
    "type": "error"
}

Método UPDATE:

Requisição:

- http://servidor:porta/dts/datasul-rest/resources/prg/hrc/v1/packageSispac/update

Resposta HTTP 200:

Resposta HTTP 200

{
    "messages": [
        {
            "code": "DOC_UPDATE_SUCCESS",
            "details": "",
            "message": "Registro alterado com sucesso.",
            "type": "INFO",
            "helpMessage": ""
        }
    ]
}

Resposta em casos que ocorrem erros (Resposta HTTP 400):

Resposta HTTP 400

{
    "detailedMessage": "Pacote Intercambio nao encontrado com o ID informado. ID: 200",
    "code": "1",
    "message": "Pacote nao encontrado.",
    "type": "error"
}

Resposta HTTP 400

{
    "detailedMessage": "Nao e permitido atualizar o pacote, pois o documento encontra-se em auditoria. ID: 100",
    "code": "1",
    "message": "Documento em auditoria.",
    "type": "error"
}

Método COMPOSITION:

Requisição:

- http://servidor:porta/dts/datasul-rest/resources/prg/hrc/v1/packageSispac/composition/{idPacote}

Resposta HTTP 200:

Resposta HTTP 200

{
    "composicaoRealizada": [
        {
            "item": "50005278",
            "tipoComposicao": 6,
            "vlReconhecido": 0.0,
            "vlSistema": 330.92,
            "vlProporcionalCobrado": 329.92,
            "quantidadeServico": 1.0,
            "glosas": [
                {
                    "descricaoGlosa": "GLOSA MANUAL",
                    "tagContestComple": "cd_cnes",
                    "motivoGlosa": "O termo glosa possui significados distintos dependendo do contexto.",
                    "qtdeGlosada": 0,
                    "justificativaReconsulta": "",
                    "classeErro": 6,
                    "codigoGlosa": 6,
                    "descricaoClasseErro": "Glosa Manual",
                    "regraQuantitativoTecnico": "",
                    "id": 1,
                    "glosaPrincipal": true,
                    "tagContestPrincipal": "cd_Ato"
                },
                {
                    "descricaoGlosa": "BENEFICIÁRIO SEM COBERTURA",
                    "tagContestComple": "",
                    "motivoGlosa": "",
                    "qtdeGlosada": 0,
                    "justificativaReconsulta": "",
                    "classeErro": 26,
                    "codigoGlosa": 26,
                    "descricaoClasseErro": "BENEFICIARIO SEM COBERTURA",
                    "regraQuantitativoTecnico": "",
                    "id": 1,
                    "glosaPrincipal": false,
                    "tagContestPrincipal": ""
                },
                {
                    "descricaoGlosa": "VLR. COBRADO PACOTE MAIOR QUE O VALOR TOTAL SISPAC",
                    "tagContestComple": "",
                    "motivoGlosa": "",
                    "qtdeGlosada": 0,
                    "justificativaReconsulta": "",
                    "classeErro": 210,
                    "codigoGlosa": 801,
                    "descricaoClasseErro": "VLR. COBRADO PACOTE MAIOR QUE O VALOR TOTAL SISPAC",
                    "regraQuantitativoTecnico": "",
                    "id": 1,
                    "glosaPrincipal": false,
                    "tagContestPrincipal": ""
                }
            ],
            "tipoTabela": "22",
            "descricaoItem": "PSICOPEDAGOGIA - TERAPIAS PEDIÁTRICAS ESPECIAIS",
            "valorTotal": 24.0,
            "unidadeMedida": 0,
            "id": 1,
            "tipoPagamento": 1,
            "tipoCob": 3
        },
        {
            "item": "50005286",
            "tipoComposicao": 6,
            "vlReconhecido": 0.0,
            "vlSistema": 330.92,
            "vlProporcionalCobrado": 329.92,
            "quantidadeServico": 1.0,
            "glosas": [
                {
                    "descricaoGlosa": "BENEFICIÁRIO SEM COBERTURA",
                    "tagContestComple": "",
                    "motivoGlosa": "",
                    "qtdeGlosada": 0,
                    "justificativaReconsulta": "",
                    "classeErro": 26,
                    "codigoGlosa": 26,
                    "descricaoClasseErro": "BENEFICIARIO SEM COBERTURA",
                    "regraQuantitativoTecnico": "",
                    "id": 2,
                    "glosaPrincipal": false,
                    "tagContestPrincipal": ""
                },
                {
                    "descricaoGlosa": "PROC. COM COBRANCA DUPLICIDADE",
                    "tagContestComple": "",
                    "motivoGlosa": " Lote Prestador: 000600083674 Guia Prestador: 610_WEB3_90047629 Guia Operadora: 90047629000 Nr.Fatura: 19032026004",
                    "qtdeGlosada": 0,
                    "justificativaReconsulta": "",
                    "classeErro": 197,
                    "codigoGlosa": 197,
                    "descricaoClasseErro": "PROCEDIMENTO COM COBRANCA EM DUPLICIDADE",
                    "regraQuantitativoTecnico": "",
                    "id": 2,
                    "glosaPrincipal": true,
                    "tagContestPrincipal": ""
                },
                {
                    "descricaoGlosa": "VLR. COBRADO PACOTE MAIOR QUE O VALOR TOTAL SISPAC",
                    "tagContestComple": "",
                    "motivoGlosa": "",
                    "qtdeGlosada": 0,
                    "justificativaReconsulta": "",
                    "classeErro": 210,
                    "codigoGlosa": 801,
                    "descricaoClasseErro": "VLR. COBRADO PACOTE MAIOR QUE O VALOR TOTAL SISPAC",
                    "regraQuantitativoTecnico": "",
                    "id": 2,
                    "glosaPrincipal": false,
                    "tagContestPrincipal": ""
                }
            ],
            "tipoTabela": "22",
            "descricaoItem": "PSICÓLOGO - TERAPIAS PARA TRANSTORNOS GLOBAIS DE DESENVOLVIMENTO",
            "valorTotal": 24.0,
            "unidadeMedida": 0,
            "id": 2,
            "tipoPagamento": 0,
            "tipoCob": 0
        }
    ]
}

Método AUTHORIZATIONDETAILS:

Requisição:

- http://servidor:porta/dts/datasul-rest/resources/prg/hrc/v1/packageSispac/authorizationDetails/{idPacote}

Resposta HTTP 200:

Resposta HTTP 200

{
    "detalheAutorizacao": {
        "nomeUnidadeOrigem": "SAUDE UNIMED",
        "statusPacote": "1 - Publicado sem aprovacao",
        "unidadeOrigem": 517,
        "tipoAcomodacao": "C",
        "dtEmissaoGuia": "2026-05-14",
        "nomePrestador": "3 D DIAGNOSE LTDA",
        "pacote": "89709302",
        "dsObsInterna": "Obs. Interna - pacote para teste da autorização",
        "indicadorHm": 1,
        "dsObsGuia": "Obs. guia - pacote para teste da autorização",
        "dtAutorizacao": "2026-03-08",
        "nrGuiaAtendimento": 1556,
        "aaGuiaAtendOrigem": 2026,
        "descricaoServicoPrincipal": "TC - COLUNA - SEGMENTO ADICIONAL",
        "cdUseridAutorizacao": "usuario.teste",
        "codigoPrestadorPrincipal": "97275056",
        "codigoServicoPrincipal": "41001133"
    }
}

Método DENIALPACKAGE:

Requisição:

- http://servidor:porta/dts/datasul-rest/resources/prg/hrc/v1/packageSispac/denialPackage/{idPacote}

Resposta HTTP 200:

Resposta HTTP 200

{
    "glosasPacote": [
        {
            "descricaoGlosa": "GLOSA MANUAL",
            "motivoGlosa": "O termo glosa possui significados distintos dependendo do contexto.",
            "idGlosa": 1,
            "classeErro": 6,
            "codigoGlosa": 6,
            "descricaoClasseErro": "Glosa Manual",
            "movimentosGlosados": [
                {
                    "nrDocSistema": 0,
                    "transacao": 5003,
                    "nrDocOriginal": 161906,
                    "descricaoViaAcesso": "0 - NAO INFORMADA",
                    "descricaoMotivo": "O termo glosa possui significados distintos dependendo do contexto.h",
                    "nrSeqDigitacao": 0,
                    "unidade": 120,
                    "quantidadeCobrada": 1,
                    "valorGlosado": 0.0,
                    "valorCobrado": 329.92,
                    "idGlosa": 1,
                    "nrSerieDocOriginal": "PTU",
                    "quantidadeGlosada": 0.0,
                    "processo": 1,
                    "descricaoMovimento": "PSICOLOGO - TERAPIAS PARA TRANSTORNOS GLOBAIS",
                    "unidadePrestadora": 6,
                    "codigoMovimento": "50005278",
                    "tipoPagamento": 1,
                    "validacaoGlosa": "Com glosa / Com validacao",
                    "tipoCob": 3
                }
            ],
            "glosaPrincipal": true,
            "todosMovimentosGlosados": false
        },
        {
            "descricaoGlosa": "BENEFICIÁRIO SEM COBERTURA",
            "motivoGlosa": "",
            "idGlosa": 2,
            "classeErro": 26,
            "codigoGlosa": 26,
            "descricaoClasseErro": "BENEFICIARIO SEM COBERTURA",
            "movimentosGlosados": [
                {
                    "nrDocSistema": 0,
                    "transacao": 5003,
                    "nrDocOriginal": 161906,
                    "descricaoViaAcesso": "0 - NAO INFORMADA",
                    "descricaoMotivo": "",
                    "nrSeqDigitacao": 0,
                    "unidade": 120,
                    "quantidadeCobrada": 1,
                    "valorGlosado": 0.0,
                    "valorCobrado": 329.92,
                    "idGlosa": 2,
                    "nrSerieDocOriginal": "PTU",
                    "quantidadeGlosada": 0.0,
                    "processo": 1,
                    "descricaoMovimento": "PSICOLOGO - TERAPIAS PARA TRANSTORNOS GLOBAIS",
                    "unidadePrestadora": 6,
                    "codigoMovimento": "50005278",
                    "tipoPagamento": 1,
                    "validacaoGlosa": "Com glosa / Com validacao",
                    "tipoCob": 3
                },
                {
                    "nrDocSistema": 0,
                    "transacao": 5003,
                    "nrDocOriginal": 161906,
                    "descricaoViaAcesso": "0 - NAO INFORMADA",
                    "descricaoMotivo": "",
                    "nrSeqDigitacao": 0,
                    "unidade": 120,
                    "quantidadeCobrada": 1,
                    "valorGlosado": 0.0,
                    "valorCobrado": 329.92,
                    "idGlosa": 2,
                    "nrSerieDocOriginal": "PTU",
                    "quantidadeGlosada": 0.0,
                    "processo": 2,
                    "descricaoMovimento": "PSICOLOGO - TERAPIAS PARA TRANSTORNOS GLOBAIS",
                    "unidadePrestadora": 6,
                    "codigoMovimento": "50005286",
                    "tipoPagamento": 0,
                    "validacaoGlosa": "Pendente de analise de glosa",
                    "tipoCob": 0
                },
                {
                    "nrDocSistema": 0,
                    "transacao": 5003,
                    "nrDocOriginal": 161906,
                    "descricaoViaAcesso": "0 - NAO INFORMADA",
                    "descricaoMotivo": "",
                    "nrSeqDigitacao": 0,
                    "unidade": 120,
                    "quantidadeCobrada": 1,
                    "valorGlosado": 0.0,
                    "valorCobrado": 329.92,
                    "idGlosa": 2,
                    "nrSerieDocOriginal": "PTU",
                    "quantidadeGlosada": 0.0,
                    "processo": 3,
                    "descricaoMovimento": "PSICOLOGO - TERAPIAS PARA TRANSTORNOS GLOBAIS",
                    "unidadePrestadora": 6,
                    "codigoMovimento": "50005308",
                    "tipoPagamento": 0,
                    "validacaoGlosa": "Pendente de analise de glosa",
                    "tipoCob": 0
                },
                {
                    "nrDocSistema": 0,
                    "transacao": 5003,
                    "nrDocOriginal": 161906,
                    "descricaoViaAcesso": "0 - NAO INFORMADA",
                    "descricaoMotivo": "",
                    "nrSeqDigitacao": 0,
                    "unidade": 120,
                    "quantidadeCobrada": 1,
                    "valorGlosado": 0.0,
                    "valorCobrado": 329.92,
                    "idGlosa": 2,
                    "nrSerieDocOriginal": "PTU",
                    "quantidadeGlosada": 0.0,
                    "processo": 4,
                    "descricaoMovimento": "TERAPIA OCUPACIONAL-TERAPIAS P/TRANSTORNOS GLOBAIS DE DESENV",
                    "unidadePrestadora": 6,
                    "codigoMovimento": "50005340",
                    "tipoPagamento": 0,
                    "validacaoGlosa": "Pendente de analise de glosa",
                    "tipoCob": 0
                },
                {
                    "nrDocSistema": 0,
                    "transacao": 5003,
                    "nrDocOriginal": 161906,
                    "descricaoViaAcesso": "0 - NAO INFORMADA",
                    "descricaoMotivo": "",
                    "nrSeqDigitacao": 0,
                    "unidade": 120,
                    "quantidadeCobrada": 1,
                    "valorGlosado": 0.0,
                    "valorCobrado": 329.9,
                    "idGlosa": 2,
                    "nrSerieDocOriginal": "PTU",
                    "quantidadeGlosada": 0.0,
                    "processo": 5,
                    "descricaoMovimento": "PSICOLOGO - TERAPIAS PARA TRANSTORNOS GLOBAIS",
                    "unidadePrestadora": 6,
                    "codigoMovimento": "50005359",
                    "tipoPagamento": 0,
                    "validacaoGlosa": "Pendente de analise de glosa",
                    "tipoCob": 0
                }
            ],
            "glosaPrincipal": false,
            "todosMovimentosGlosados": true
        }
   ],
    "validacaoDiferente": true
}

Árvore de páginas

API de Pacotes de Intercâmbio - SISPAC

01. VISÃO GERAL

02. MÉTODOS

03. REQUISIÇÃO

Método GET:

Método UPDATE:

Método COMPOSITION:

Método DENIALPACKAGE:

03. RESULTADO

Método GET:

Método UPDATE:

04. EXEMPLOS

Métodos GET:

Método UPDATE:

Método COMPOSITION:

Método AUTHORIZATIONDETAILS:

Método DENIALPACKAGE: