CONTEÚDO

Visão Geral
1. Rota
2. Parâmetros de Entrada
3. Retorno
Regras de Negócio Aplicadas
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 com o APP da Unimed Brasil.

A API Extrato de Utilização do Beneficiário tem por objetivo retornar o extrato de utilização do beneficiário, isto é, todos os procedimentos e insumos realizados pelo beneficiário em determinado período.

A API foi desenvolvida seguindo as definições disponibilizadas no Swagger da Unimed Brasil.

a. Rota

/Beneficiario/v1/Extrato.

b. Parâmetros de Entrada

Esta API deve receber os seguintes parâmetros via header ou via query parameters:

Parâmetro	Tipo de Parâmetro	Tipo de dados	Formato	Obrigatório?
X-CPF	header	String	99999999999
X-Carteira	header	String	99999999999999999
periodoId	query	String	MM/AAAA	Sim

Deve ser informado obrigatoriamente um CPF ou uma carteira de beneficiário.

b. Retorno

O objeto Json de retorno da API possui a seguinte estrutura:

{
 "Result": "Domínio: 0 = Erro na execução do serviço, 1 = Processamento Ok",
 "Message": "Mensagem de retorno que deverá ser exibida ao usuário (obrigatória em caso de erro, ou seja, Result = 0)",
 "Data": [
 	{
 	 "nome": "Nome da categoria de agrupamento do extrato",
 	 "valor": "Valor total da categoria de agrupamento do extrato",
 	 "procedimentos": [
		{
	 	 "procedimentoId": "Código do procedimento realizado",
	 	 "nomeProcedimento": "Nome do procedimento realizado",
	 	 "dtRealizacao": "Data de realização do procedimento em formato de exibição",
	 	 "nomePrestador": "Nome do prestador executante"
		}	
	 ]
 	}
 ],
 "DebugMessage": "string"
}

02. REGRAS DE NEGÓCIO APLICADAS

A API irá retornar apenas os movimentos dos beneficiários que já estiverem sidos liberados do RC.
Os serviços serão classificados/agrupados por categoria de serviços. A categoria corresponderá ao valor do campo 'Tipo de Guia TISS' parametrizado na transação do serviço e pode ser classificadas como:
- Consultas: procedimentos em transação de Consulta;
- Exames/Terapias: procedimentos em transação de SADT;
- Internações: procedimentos em transações de Internação e Honorário Individual;
- Outras Despesas: todos os insumos, independente de transação.
O campo de valor será preenchido de acordo com o valor de cobrança do beneficiário e forma de pagamento:
- Serviços cobrados em pré-pagamento e sem incidência de participação serão listados com valor zerado;
- Serviços cobrados em pré-pagamento com incidência de participação serão listados apenas com o valor da participação;
- Serviços cobrados em custo operacional serão listados com o valor integral do procedimento para cobrança.
Procedimentos com equipe médica (auxiliares e anestesistas) serão listados apenas uma vez, considerando o movimento do Cirurgião.
Procedimentos com divisão de honorários também serão listados apenas uma vez, considerando o movimento do prestador pessoa jurídica.

03. COMO VALIDAR AS INFORMAÇÕES

Os resultados apresentados pela API podem ser validados e visualizados no programa 'Central de Movimentação Guias TISS - hrc-document'.
Para tanto, deve-se realizar a busca por beneficiário e data de realização do movimento conforme período desejado.

Na tela inicial, clique em 'Busca Avançada':

Na tela da busca, na aba 'Documento', selecione o tipo de exibição 'Por Movimento' e o beneficiário desejado:

E, na aba 'Movimento', selecione o intervalo de data de realização de acordo com o período desejado (se período informado na API foi 01/2020, por exemplo, o intervalo de datas deverá ser 01/01/2020 a 31/01/2020):

Ao clicar em buscar, serão listados na tela principal, os movimentos do beneficiário para o período. Os movimentos que estiver com status maior que 3 ('Liberado') deverão ser os mesmos retornados pela API.

EXEMPLO DE UTILIZAÇÃO

Segue abaixo um exemplo prático de como pode ser realizada a validação da API.

Realizada uma requisição na API utilizando a carteira do beneficiário e período de acordo com os parâmetros visualizados abaixo:

A API retornou os seguintes dados:

{
  "Result": 1,
  "Data": [
    {
      "procedimentos": [
        {
          "procedimentoId": "10101012",
          "dtRealizacao": "30/01/2020",
          "nomePrestador": "PRESTADOR TESTE CHAMADO TIDMKI",
          "nomeProcedimento": "CONSULTA EM CONSULTORIO"
        },
        {
          "procedimentoId": "10101012",
          "dtRealizacao": "30/01/2020",
          "nomePrestador": "PRESTADOR TESTE CHAMADO TIDMKI",
          "nomeProcedimento": "CONSULTA EM CONSULTORIO"
        }
      ],
      "valor": "R$ 1,42",
      "nome": "CONSULTAS"
    },
    {
      "procedimentos": [
        {
          "procedimentoId": "10101012",
          "dtRealizacao": "31/01/2020",
          "nomePrestador": "PRESTADOR",
          "nomeProcedimento": "CONSULTA EM CONSULTORIO"
        },
        {
          "procedimentoId": "10101012",
          "dtRealizacao": "30/01/2020",
          "nomePrestador": "PRESTADOR",
          "nomeProcedimento": "CONSULTA EM CONSULTORIO"
        },
        {
          "procedimentoId": "10101012",
          "dtRealizacao": "30/01/2020",
          "nomePrestador": "PRESTADOR",
          "nomeProcedimento": "CONSULTA EM CONSULTORIO"
        },
        {
          "procedimentoId": "10101039",
          "dtRealizacao": "07/01/2020",
          "nomePrestador": "PRESTADOR",
          "nomeProcedimento": "CONSULTA EM PRONTO SOCORRO"
        }
      ],
      "valor": "R$ 1,08",
      "nome": "EXAMES/TERAPIAS"
    }
  ],
  "DebugMessage": "",
  "Message": ""
}

Os movimentos listados no programa 'Central de Movimentação Guias TISS - hrc-document' para a mesma carteira e período com status maior que 3, foram: