Ir para o final dos metadados
Ir para o início dos metadados

Você está vendo a versão antiga da página. Ver a versão atual.

Comparar com o atual Ver Histórico da Página

« Anterior Versão 8 Próxima »

Para disponibilizar extratos de coparticipação, implemente os objetos descritos nesta documentação.

Caso seu SGDB esteja configurado para ser CASE SENSITIVE, crie todos os objetos de bancos de dados em MINÚSCULAS.

Importante: todos os objetos desta documentação são obrigatórios. Não criar um ou mais objetos impossibilitará que a integração via banco de dados OMNILINK seja corretamente realizada.

Tipo do objeto: View

Nome do objeto: omni_extrato_copart

Objeto obrigatório: SIM

Informação adicional: implemente esta view quando desejar exibir informações sobre coparticipação de um beneficiário ou de seu grupo familiar.

Estrutura de campos:

Nome

Tipo

Obrigatório

Descrição

id_omni_extrato_copart

Número

Sim

Atributo do tipo primary key. 

Este atributo deve ser um número único por registro.

id_operadora

Número

Sim

Atributo fixo o valor = 1, quanto view for implementado pela operadora.

instancia_aplicacao

Texto

Sim

Atributo fixo no valor = '1', quanto view ou tabela for implementado pela operadora.

id_config_cliente_app

Número

Sim

Atributo fixo no valor = 1, quanto view ou tabela for implementado pela operadora.

chave_unica

Texto

Sim

Chave de identificação única por beneficiário.

Não deve se repetir em nenhuma hipótese.

numero_contrato

Texto

Sim

Nome do contrato que aparecerá no extrato.

descricao_contrato

Texto

Sim

Nome do contrato que aparecerá no extrato.

cartao_numero

Texto

Sim

Número do cartão, que será exibido na carteirinha.

plano_matricula

Texto

Sim

Matrícula do beneficiário. Informar a matrícula completa, sem espaços ou caracteres especiais.

Indicar neste campo a matricula do beneficiário no plano. Se a matricula e o numero do cartão forem iguais, repetir a informação nos dois campos.

nome_beneficiario

Texto

Sim

Nome beneficiário.

id_tipo_usuario

Texto

Sim

Conteúdo válido:
T = Titular
D = Dependente
A = Agregado
Apenas maiúsculos.

codigo_procedimento

Texto

Sim

Código do procedimento a ser exibido no extrato

descricao_procedimento

Texto

Sim

Descrição do procedimento a ser exibido no extrato

numero_guia

Texto

Sim

numero da guia de registro do serviço/atendimento prestado.

data_atendimento

Date

Sim

Data da ocorrência do evento. Se o evento ocorreu no dia 18 de dezembro de 2023, indique 2024-12-18 neste campo.

id_executante

Texto

Sim

Código de identificação do prestador executante no seu sistema.

nome_executante

Texto

Sim

Nome do prestador executante.

id_tipo_servico

Texto

Sim

Código do tipo de serviço realizado. O código de serviços será utilizado para agrupar os procedimentos e apresentar os subtotais exigidos pela RN 389

descricao_tipo_servico

Texto

Sim

Descrição do tipo de serviço realizado, exemplo:

Consultas, Exames/Terapias, Internação, Odontologia, outras despesas, entre outras. 

Assim como o atributo codigoTipoServico, servirá como agrupador para apresentação de subtotais exigidos pela RN 389.

quantidade

Número

Sim

Quantidade executada.

A quantidade será MULTIPLICADA pelo valor_coparticipação no momento da exibição do extrato. Lembre-se de levar isso em consideração quando for alimentar os campos valor_servico e valor_coparticipacao.

valor_servico

Número

Sim

Indique o valor individualizado do serviço. Poderá definir através da configuração da funcionalidade se deseja exibir o valor por grupo/ individualmente ou apenas o total. (RN 389 permite esse comportamento).

Numérico, 2 posições decimais. Indicador decimal = PONTO (9999999.99)

Atenção: este valor precisa ser UNITÁRIO, pois será multiplicado pelo valor do campo quantidade. Exemplo:

Campo quantidade: 3

Campo valor_servico = 20.00

Valor que será exibido no app: 60.00

valor_coparticipacao

Número

Sim

Indique o valor da coparticipação individualizado do serviço. Poderá definir através da configuração da funcionalidade se deseja exibir o valor por grupo/ individualmente ou apenas o total. (RN 389 permite esse comportamento).

Numérico, 2 posições decimais. Indicador decimal = PONTO (9999999.99)

Atenção: este valor precisa ser UNITÁRIO, pois será multiplicado pelo valor do campo quantidade. Exemplo:

Campo quantidade: 3

Campo valor_coparticipacao: 10.00

Valor que será exibido no app: 60.00

local_atendimento

Texto

Sim

Indique o local no qual foi realizado o atendimento

data_competencia

Date

Não

Indique a data da competência que sua empresa deseja mostrar esse evento de coparticipação.

Exemplo:

Uma coparticipação que teve a data de ocorrência (campo data_atendimento) 18/12/2023, mas este evento deve ser exibido no extrato de coparticipação de fevereiro/24 deve ter este campo preenchido como 2024-02-01

IMPORTANTE: O campo é opcional, porém altamente recomendado. Caso não seja informado, o evento será listado conforme conteúdo do campo data_atendimento

  • Sem rótulos