Autenticação de beneficiários

A autenticação de beneficiários é o principal método de integração das soluções Mobile Saúde. É com ela que seus beneficiários conseguirão ter acesso identificado ao app e soluções web, podendo acessar cartões virtuais, chat identificado e demais integrações (como extratos, por exemplo).

Para viabilizar essas integrações, será necessária a criação dos seguintes artefatos de banco de dados:

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.

View - omni_beneficiario

Tipo do objeto: View

Nome do objeto: omni_beneficiario

Objeto obrigatório: SIM

Estrutura de campos:

Campo	Tipo	Obrigatório	Descrição
id_omni_beneficiario	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 de pessoa. Não deve se repetir em nenhuma hipótese, para pessoas diferentes. Importante: caso um mesmo beneficiário esteja presente em mais de um contrato ou em mais de um grupo familiar, a chave única poderá se repetir, desde que seja o MESMO BENEFICIARIO. É obrigatório o preenchimento deste campo: Recomendamos o uso do CPF, pois é ÚNICO POR PESSOA, ou seja, 2 pessoas diferentes terão sempre CPFs diferentes. Porém, se a mesma pessoa tiver 2 ou mais planos, ela terá o mesmo CPF nos 2 planos, que é o desejado para este campo.
esquema_cor	Texto	Não	Informe nesse campo o mesmo apelido na opção esquema de cor no configurador de aplicação. Caso não tenha um esquema de cor específico, este campo pode ficar vazio. Importante: caso a string neste campo não tenha relação com nenhum esquema de cores pre-cadastrado, o conteúdo do campo será desconsiderado.
nome	Texto	Sim	Nome do beneficiário. Não é permitido números nem caracteres especiais. Permitido acentos.
sexo_codigo	Texto	Sim	Chave que identifica a descrição de sexo. Exemplo: F M
sexo_descricao	Texto	Sim	Descrição do Sexo. Exemplo: Feminino Masculino
data_nascimento	Texto	Sim	Texto formato: YYYY-MM-DD
cpf	Texto	Sim	CPF do beneficiário, sem pontuação, tamanho definido 11 dígitos. Sempre informar 11 dígitos. Exemplo: 12345678901
telefone_celular	Texto	Sim	Indique o telefone celular do usuário logado, tamanho fixo 11 posições. Somente números Exemplo: 27987654321
telefone_fixo	Texto	Não	Indique o telefone fixo do usuário logado, tamanho mínimo 10 / máximo 11 posições. Somente números. Exemplo: 2733764321 27733764321
email	Texto	Sim	Indique o email do usuario logado. Email precisa ter uma estrutura válida. Exemplo: meuemail@serveremail.com.br
endereco	Texto	Sim	Endereço principal do beneficiário. Texto livre
bairro	Texto	Sim	Bairro da residencia principal do beneficiário. Texto livre
cep	Texto	Sim	CEP somente com números, sem pontos ou traços. Exemplo: 88032989
cidade	Texto	Sim	Código IBGE do município da residência do beneficiário. Tamanho de 7 a 10: Código IBGE: 3205309
cidade_descricao	Texto	Sim	Cidade da residencia principal do beneficiário. Texto livre.
estado	Texto	Sim	Informe a sigla do estado de residencia do beneficiário. Exemplo: SC RJ ES
estado_descricao	Texto	Sim	Estado da residência principal do beneficiário. Texto livre.
complemento	Texto	Sim	Complemento do endereço. Texto livre.
numero_endereco	Texto	Sim	Número da residencia principal do beneficiário.
estado_civil_codigo	Texto	Sim	Informe o código do estado civil. Exemplo: C S V D
estado_civil_descricao	Texto	Sim	Informe a descrição relacionada ao estado civil. Exemplos: Casado Solteiro Viúvo Divorciado
cod_familia	Texto	Sim	Este atributo define um código para uma família dentro de um contrato. Este código deve ser o mesmo para todos os membros que compõem uma família em um contrato. Quando a operadora usa o número do contrato para definir varias pessoas dentro do mesmo, o atributo deve retornar com a mesma numeração do numero_contrato.
plano_matricula	Texto	Sim	Matrícula do beneficiário. Informar a matrícula completa, sem espaços ou caracteres especiais. Exemplo: 01012222776655876
plano_matricula_antiga	Texto	Não	Matrícula do beneficiário no sistema antigo. Em alguns casos o cliente continua utilizando a matrícula do sistema antigo mesmo após trocar de sistema de gestão. Caso exista, informe esse conteúdo neste campo.
plano_matricula_funcionario	Texto	Não	Indicar o código da matrícula de funcionário na empresa patrocinadora, caso aplicável.
plano_grau_parentesco_codigo	Texto	Sim	Código do grau de parentesco do beneficiário em relação ao titular. 01 - Titular 02 - Cônjuge (independente se for esposa, marido ou companheiro(a)) 03 - Daqui para frente é livre Importante: usuários logados como titular poderão acessar todo o grupo familiar. Quando for 02 (cônjuge) o dependente poderá ver todos os dependentes, e não visualiza o titular.
plano_grau_parentesco_descri	Texto	Sim	Descrição do grau de parentesco Exemplo: Esposo(a) Filho(a) Avô / Avó
plano_codigo	Texto	Sim	Numeração do código do plano.
plano_descricao	Texto	Sim	Nome comercial do plano, ou descrição.
plano_abrangencia	Texto	Sim	Abrangência do plano. Ex: “Nacional”, “Estadual” …
plano_acomodacao	Texto	Sim	Texto descritivo do padrão de acomodação do plano do beneficiário, conforme ANS.
plano_modalidade_cobranca	Texto	Sim	Texto descritivo da modalidade de cobrança do contrato do beneficiário, como por exemplo: Pré-pagamento, Pós-pagamento e etc.
plano_padrao_conforto	Texto	Não	Texto descritivo do padrão de conforto do plano (produto).
plano_participativo	Número	Sim	Retornar 1 se o plano for participativo, 0 se não.
plano_segmentacao	Texto	Sim	Texto descritivo da segmentação do plano do (produto). Exemplo de segmentação: Ambulatorial + Hospitalar com Obstetrícia. Sugere-se utilizar as segmentações definidas pela ANS, conforme registro de produtos.
plano_tipo_contratacao	Texto	Sim	Informação sobre o tipo de contratação do plano privado de assistência à saúde, conforme RN 195. Individual/Familiar, coletivo por adesão ou coletivo empresarial.
plano_regulamentacao	Texto	Sim	Informação sobre a regulamentação do plano, entendendo-se por: Regulamentado / Adaptado / Não regulado.
plano_rede_atendimento_codigo	Texto	Não	Código da rede de atendimento. A rede de atendimento nesse caso é a classe de clínicas/hospitais que o plano do beneficiário pode acessar. Caso sua operadora tenha essa regra, informe aqui. Caso não tenha, deixe o campo em branco.
plano_rede_atendimento_descric	Texto	Não	Descrição da rede de atendimento. A rede de atendimento nesse caso é a classe de clínicas/hospitais que o plano do beneficiário pode acessar. Caso sua operadora tenha essa regra, informe aqui. Caso não tenha, deixe o campo em branco.
plano_data_final_cpt	Texto	Não	Data final da CPT do cliente, quando houver, no formato String. Pode-se informar também textos indicativos, de acordo com a necessidade da operadora. Obrigatório no cartão do beneficiário conforme RN 389. Nesse caso, portanto, o formato do texto é livre. Exemplos de conteúdo: 20/10/2022 NÃO POSSUI CPT ISENTO 30/10/2023
plano_registro_ans	Texto	Sim	Número de registro do plano do beneficiário na ANS.
plano_inicio_vigencia	Texto	Sim	Formato: YYYY-MM-DD.
plano_tipo_usuario_codigo	Texto	Sim	Conteúdo válido: T D A Importante. Só pode existir um (1) usuário no Array de beneficiários com a propriedate idTipoUsuario = T por contrato
plano_tipo_usuario_descricao	Texto	Sim	Descrição do código. Exemplos: Titular Dependente Agregado
cartao_validade	Texto	Sim	Formato: YYYY-MM-DD
cartao_via	Número	Sim	Indica o numero da via do cartão vigente do beneficiário.
cartao_numero_cns	Texto	Sim	Número do Cartão Nacional de Saúde. Obrigatório no cartão do beneficiário conforme RN 389. Importante: caso não possua a informação, preencher com “NÃO CONSTA”.
cartao_apresenta_cartao	Número	Sim	Informe 1 para apresentar o cartão virtual. Caso não tenha acesso ao cartão virtual, informe 0.
empresa_contratante_codigo	Texto	Sim	Quando o beneficiário for contrato PJ deve informar neste campo o código da empresa em seu sistema de gestão. Quando o beneficiário for contrato PF, deve vir o CPF do titular.
empresa_contratante_descricao	Texto	Sim	Quando o beneficiário for contrato PJ, informar nome da empresa. Quando o beneficiário for contrato PF deve vir o nome do titular.
cartao_modelo	Texto	Sim	Modelo do cartão que será reproduzido, no aplicativo. IMPORTANTE: esse campo DEVE NECESSARIAMENTE ter correlação com o NOME DO CARTÃO criado na ferramenta de construtor de cartão virtual. Motivo: ao exibir o cartão, a rotina de cartão virtual vai procurar por um MODELO DE CARTÃO no construtor de cartões que possua O MESMO NOME deste campo. Caso encontre, exibirá o modelo. Se não encontrar um cartão virtual relacionado, vai devolver CARTÃO NÃO LOCALIZADO. IMPORTANTE: Este atributo é obrigatório a exibição em letras minusculas Ex: plano-saude-basico Ex: saude-black
cartao_numero	Texto	Sim	Número do cartão, que será exibido na carteirinha.
contrato_tipo_pessoa_codigo	Texto	Sim	Código do tipo de pessoa. Exemplos: F J
contrato_tipo_pessoa_descricao	Texto	Sim	Descrição do tipo de pessoa. Exemplos: Pessoa Física Pessoa Jurídica
tipo_relacionamento_codigo	Texto	Sim	Código do tipo de relacionamento (1, 2, 3)
tipo_relacionamento_descricao	Texto	Sim	Conteúdo válido: 1 = titular 2 = dependente 3 = responsável financeiro
tipo_contratante_codigo	Texto	Sim	Código do tipo do contratante. Informe 1, 2, 3
tipo_contratante_descricao	Texto	Sim	Conteúdo válido: 1 = beneficiario 2 = profissional de saude 3 = empresa
contrato_data_inicio_vigencia	Texto	Sim	Formato: YYYY-MM-DD
bloqueio_bloqueado	Número	Sim	Retornar 1 se o beneficiário está bloqueado, e 0 se não.
bloqueio_data_bloqueio	Texto	Condicional	Torna-se obrigatório quando o campo bloqueio_bloqueado for informado com 1. Formato: YYYY-MM-DD
bloqueio_motivo_bloqueio	Texto	Condicional	Descrição do motivo de bloqueio. Obrigatório quando bloqueio_bloqueado tiver conteúdo 1
contrato_descricao	Texto	Sim	Formato: Texto livre.
numero_contrato	Texto	Sim	Número do contrato
cartao_nome	Texto	Sim	Utilize esse campo para exibir um nome reduzido. Caso não seja informado, o nome do beneficiário será exibido no cartão com base no atributo "nome", dentro do objeto dados pessoais.
cartao_nome_social	Texto	Não	Utilize esse campo para exibir um nome social reduzido. Caso não seja informado, o nome do beneficiário será exibido no cartão com base no atributo "nome", dentro do objeto dados pessoais.
cartao_operadora_contratada	Texto	Não	Informe o nome da operadora contratada, caso exista uma operadora contratada para atendimento a este beneficiário. Formato: Texto livre.
cartao_convenio_ans_contratada	Texto	Não	Informe o número de registro ANS da operadora contratada.
cartao_seed	Texto	Não	Seed utilizado para gerar o token de autorização. Formato: Texto livre, mas deve ser enviado como BASE32. A Mobile Saúde recomenda a utilização do número do cartão do beneficiário como SEED. LEMBRE-SE: converta-o em BASE32. Para saber como sua STRING deve ser enviada, siga esse link online: https://cryptii.com/pipes/base32 Caso não saiba o que é um BASE32, siga esse link: https://en.wikipedia.org/wiki/Base32 Importante: caso sua empresa não utilize o conceito de TOKEN para autorização, não preencha esse atributo.
cartao_convenio_abrangen_verso	Texto	Não	Texto descritivo da abrangência contido no verso do cartão
contrato_cod_local_atendimento	Texto	Não	Código referente ao local de atendimento
acesso_funcionalidade	Texto	Não	Utilize este campo para indicar as funcionalidades onde o beneficiário poderá ser listado para seleção na tela de Grupo Familiar. Exemplo: imagine que o seu aplicativo possui as funcionalidades abaixo: 1 - Solicitação de Reembolso Online ( ID 10) 2 - Solicitação de Autorização Online( ID 50) 3 - Solicitação de Atualização Cadastral (ID 16) E que este beneficiário, neste contrato, deve ser exibido para seleção apenas nas funcionalidades Autorização e Atualização Cadastral. Neste caso, preencha esta coluna da seguinte forma: 50 \| 16 Onde número “50” é o código da funcionalidade de Autorização, o símbolo Pipe ( \| ) é o delimitador, e número “16“ é o código da funcionalidade Atualização Cadastral. Uma vez preenchida, este beneficiário, neste contrato em questão só será exibido nas funcionalidades Autorização e Atualização Cadastral e será inibido na funcionalidade Solicitação de Reembolso, quando ele mesmo não for o usuário logado. Para que o seu beneficiário tenha acesso a todas as funcionalidades basta deixar este campo em branco. Na documentação mais abaixo segue a lista com os IDs das funcionalidades. A regra do atributo acesso_funcionalidade só é aplicada ao contexto do Grupo Familiar, sendo assim, o beneficiário LOGADO não é afetado pela regra descrita acima, apenas quando o mesmo é exibido no Grupo Familiar Regra de negócio ajustada em 26 de dez. de 2023
nome_mae	Texto	Não	Nome da mãe do beneficiário, será muito bem utilizado em casos que necessitem de elegibilidade, redefinição de senha e etc. Importante: apesar de não ser um campo obrigatório, ele é altamente recomendado porque é utilizado para reiniciar senha de beneficiários que não possuem e-mail cadastrado (APIs de reiniciar senha com perguntas)
data_inclusao	Texto	Não	A data de inclusão do beneficiário ao plano. Formato: YYYY-MM-DD 1990-08-05 Importante: apesar de não ser um campo obrigatório, ele é altamente recomendado porque é utilizado para reiniciar senha de beneficiários que não possuem e-mail cadastrado (APIs de reiniciar senha com perguntas)

Grupo Familiar

Grupo familiar são beneficiários (titulares, dependentes e agregados) que compõe uma familia o campo que determina esta amarração é o "cod_familia” ou seja todos que necessitam estar no mesmo grupo familiar necessitam estar com este código igual.

Visibilidade x Correlação

Titular: plano_tipo_usuario_codigo = T e plano_grau_parentesco_codigo = 01
- Retorna todos dentro do grupo familiar;
Dependente do tipo cônjuge: plano_tipo_usuario_codigo = D e plano_grau_parentesco_codigo = 02
- Retorna ele mesmo e todos os demais dependentes, excluindo os do tipo Agregado (A);
Dependentes diferentes do tipo cônjuge: plano_tipo_usuario_codigo = D e plano_grau_parentesco_codigo != 02
- Retorna apenas ele mesmo;
Agregados: plano_tipo_usuario_codigo = A e plano_grau_parentesco_codigo > 02
- Retorna apenas ele mesmo;

Multi-contrato

Em Operadoras de saúde é normal existir o mesmo beneficiário vinculado a contratos diferentes ou seja termos um beneficiário como:

Titular em um contrato e dependente em outro contrato.

Para que ele possa ter acesso a ambos os contratos o vinculo é realizado pelo campo chave_unica, ou seja, um beneficiário em 2 contratos distintos é vinculado a partir deste campo e com o cod_familia diferente do titular;

Os critérios de exibição de ícones e/ou permissões seguem os conceitos de grupo familiar desta documentação.

Ex:

Beneficiario Titular Contrato 1
chave_unica: 11111111111 ; numero_contrato: 000001 ; cod_familia: 100

Beneficiario Titular Contrato 2
chave_unica: 11111111111 ; numero_contrato: 000002 ; cod_familia: 101

Beneficiario Dependente Contrato 1
chave_unica: 22222222222 ; numero_contrato: 000001 ; cod_familia: 100

Beneficiario Dependente Contrato 2
chave_unica: 22222222222 ; numero_contrato: 000002 ; cod_familia: 101

Acesso Funcionalidade

IMPORTANTE

Os ID das funcionalidades customizadas são gerados dinamicamente e devem ser vistos no painel público e inclusos na relação de Acesso Funcionalidade da Operadora conforme forem criadas novas funcionalidades customizadas.

Clique abaixo para ver a relação das funcionalidades existentes na estrutura da Mobile Saúde.

Clique aqui para ver a lista completa

 Noticias: '0',
  InBox: '1',
  Agendamento: '2',
  CartaoVirtual: '3',
  RedeCredenciada: '4',
  Medicamento: '5',
  Alarme: '7',
  Login: '9',
  Contatos: '8',
  Reembolso: '10',
  Coparticipacao: '11',
  Boleto: '14',
  ImpostoRenda: '15',
  AtualizacaoCadastral: '16',
  Ouvidoria: '17',
  Declaracao: '20',
  ChatMosia: '46',
  SolicitacaoAutorizacao: '48',
  MeusProtocolos: '49',
  SolicitacaoCartao: '50',
  CancelamentoPlano: '51',
  MinhasConsultas: '53',
  ManuaisRevistas: '18',
  PINSS: '52',
  ExtratoUtilizacao: '55',
  PrimeiroAcesso: '134',
  BoasVindas: '136',
  RecuperarSenha: '137',
  TrocarSenha: '138',
  CentralDeAjuda: '139',
  Elegibilidade: '141',
  MeuPerfil: '47888',
  LiveNow: '47999',
  Servicos: '47777',
  FuncionalidadeEspecifica: '9000'

View - omni_beneficiario_carencia

Tipo do objeto: View

Nome do objeto: omni_beneficiario_carencia

Objeto obrigatório: SIM

Estrutura de campos:

Campo	Tipo	Obrigatório	Descrição
id_omni_beneficiario_carencia	Número	Sim	Atributo do tipo primary key. 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	Está chave é a identificação única por beneficiário. Importante: caso um mesmo beneficiário esteja presente em mais de um contrato ou em mais de um grupo familiar, a chave única poderá se repetir, desde que seja o MESMO BENEFICIARIO. É obrigatório o preenchimento deste campo: Recomendamos o uso do CPF, pois é ÚNICO POR PESSOA, ou seja, 2 pessoas diferentes terão sempre CPFs diferentes. Porém, se a mesma pessoa tiver 2 ou mais planos, ela terá o mesmo CPF nos 2 planos, que é o desejado para este campo.
plano_codigo	Texto	Sim	Numeração do código do plano.
tipo_servico	Texto	Sim	Texto com o tipo de serviço, exemplo: Consulta, Exames, Internação, Parto...
numero_contrato	Texto	Sim	Informar o numero do contrato que será vinculado esta carencia, exemplo: Contrato 0001 Carencias A, B e C Contrato 0002 Carencias D,E e F
carencia	Texto	Sim	Informar o texto a ser apresentado. O campo tem conteúdo aberto, podendo exibir datas ou texto livre. Exemplos: Vencida 31/12/2015 12 meses

View - omni_beneficiario_login

Tipo do objeto: View / Tabela

Nome do objeto: omni_beneficiario_login

Objeto obrigatório: SIM

Informação adicional: indicamos o uso de view caso vc já consiga / possua uma tabela centralizadora de logins.

Estrutura de campos:

Campo	Tipo	Obrigatório	Descrição
id_omni_beneficiario_login	Número	Sim	Atributo do tipo primary key. 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	Está chave é a identificação única por beneficiário. Importante: caso um mesmo beneficiário esteja presente em mais de um contrato ou em mais de um grupo familiar, a chave única poderá se repetir, desde que seja o MESMO BENEFICIARIO. É obrigatório o preenchimento deste campo: Recomendamos o uso do CPF, pois é ÚNICO POR PESSOA, ou seja, 2 pessoas diferentes terão sempre CPFs diferentes. Porém, se a mesma pessoa tiver 2 ou mais planos, ela terá o mesmo CPF nos 2 planos, que é o desejado para este campo.
login	Texto	Sim	Informação que o beneficiário vai utilizar no momento de se identificar na tela do login do app. Este login deve ser único, ou seja, não pode se repetir nessa view ou tabelas.
senha	Texto	Sim	Senha de acesso.
data_criacao_acesso	Data	Sim	Data de criação do acesso.
data_ultimo_update	Data	Não	Informe a data de última troca de senha do usuário.
permitir_acesso	Número	Sim	Retornar 1 se o deve permitir o acesso, e 0 se não. Utilização: caso a operadora queira restringir acesso, muda este atributo de 1 para 0 e o beneficiário não conseguirá mais logar no app.

View - omni_beneficiario_custom

Tipo do objeto: View

Nome do objeto: omni_beneficiario_custom

Objeto obrigatório: SIM

Estrutura de campos:

Campo	Tipo	Obrigatório	Descrição
id_omni_custom	Número	Sim	A ideia desse é ser um atributo do tipo primary key, ou seja, se a implementação for tabela ou wien este atributo deve ser um número único por registro.
id_operadora	Número	Sim	Criar atributo e deixar fixo o valor = 1, quanto view for implementado pela operadora.
instancia_aplicacao	Texto	Sim	Criar atributo e deixar fixo o valor = '1' , quanto view for implementado pela operadora.
id_config_cliente_app	Número	Sim	Criar atributo e deixar fixo o valor = 1 , quanto view for implementado pela operadora.
chave_unica	Texto	Sim	Está chave é a identificação única por beneficiário, é a identificação da Pessoa. Importante: caso um mesmo beneficiário esteja presente em mais de um contrato ou em mais de um grupo familiar, a chave única poderá se repetir, desde que seja o MESMO BENEFICIARIO. É obrigatório o preenchimento deste campo: Recomendamos o uso do CPF, pois é ÚNICO POR PESSOA, ou seja, 2 pessoas diferentes terão sempre CPFs diferentes. Porém, se a mesma pessoa tiver 2 ou mais planos, ela terá o mesmo CPF nos 2 planos, que é o desejado para este campo. Deve ter correlação com o campo 'chave_unica' da view 'omni_beneficiario'
plano_codigo	Texto	Sim	Numeração do código do plano. Deve ter correlação com o campo 'plano_codigo' da view 'omni_beneficiario'
numero_contrato	Texto	Sim	Número do contrato. Deve ter correlação com o campo 'numero_contrato' da view 'omni_beneficiario'
Você pode dar o nome que quiser, e criar quantos campos quiser. Crie 1 nome de acordo com a utilização do seu campo customizado. Exemplos de uso: cor_olhos doador_orgaos matricula_no_sistema_parceiro_abc	Texto	Sim	Você deve criar quantos campos quiser, para que seu conteúdo seja enviado para o app, no objeto CUSTOM. Ou seja, se você criar um campo “doador_orgaos”, insira SIM ou NÃO para cada linha, de acordo com seu cadastro de beneficiários. Você pode criar QUANTOS CAMPOS QUISER nessa tabela, desde que tenham conteúdos. IMPORTANTE: Caso você não tenha nenhum campo custom NESTE MOMENTO, não crie nenhum campo. Crie apenas a VIEW sem nenhum campo adicional.

IMPORTANTE

A tabela ou view resultante deve ser semelhante a esta (abaixo):

id_omni_custom	id_operadora	instancia_aplicacao	id_config_cliente_app	chave_unica	plano_codigo	numero_contrato	religiao_beneficiario	data_de_casamento
1	1	1	1	1123123123	123123	22222222	Católico
2	1	1	1	333333333	44444444	1233123123		20/10/2022

Nesse caso, a API vai retornar um conteúdo como esse:

 "custom": [
                {
                    "chave": "religiao_beneficiario",
                    "valor": "Católico"
                },
                {
                    "chave": "data_de_casamento",
                    "valor": null 
                }
            ]




 "custom": [
                {
                    "chave": "religiao_beneficiario",
                    "valor": null
                },
                {
                    "chave": "data_de_casamento",
                    "valor": "20/10/2022" 
                }
            ]

IMPORTANTE

Perceba que na tabela o campo data não veio formatado com DATA, e sim um TEXTO JÁ PRONTO para ser utilizado, como TEXTO. Se seu conteúdo customizado for, por exemplo, um número com decimais, deve estar como texto. Exemplo: “1.245,67” ou “R$ 120,34”.

Stored Procedure - omni_sp_cria_acesso

Tipo do objeto: Stored Procedure

Nome do objeto: omni_sp_cria_acesso

Objeto obrigatório: SIM

Informação adicional: esta stored procedure deve adicionar registros na view omni_beneficiario_login descrita anteriormente.

Estrutura de parâmetros:

Ordem	Nome	Tipo	Parâmetro IN/OUT	Descrição do Atributo
1	p_id_operadora	Número	IN	Seta Valor Default na tabela de login
2	p_id_config_cliente_app	Número	IN	Seta Valor Default na tabela de login
3	p_ambiente	Texto	IN	Seta Valor Default na tabela de login
4	p_chave_unica	Texto	IN	Está chave é a identificação única por beneficiário. Este chave não deve se repetir em nenhuma hipótese.
5	p_nova_senha	Texto	IN	Senha ao criar o acesso.
6	p_retorno	Texto	OUT	“TRUE” se a inserção ocorreu com sucesso, “FALSE” caso não tenha incluído na tabela.

Stored Procedure - omni_sp_update_acesso

Tipo do objeto: Stored Procedure

Nome do objeto: omni_sp_update_acesso

Objeto obrigatório: SIM

Informação adicional: stored procedure responsável por alterar a senha do usuário na view omni_beneficiario_login. Importante: atualize também o campo data_ultimo_update ao executar essa procedure.

Estrutura de parâmetros:

Ordem	Nome	Tipo	Parâmetro IN/OUT	Descrição do Atributo
1	p_id_operadora	Número	IN	Seta Valor Default na tabela de login
2	p_id_config_cliente_app	Número	IN	Seta Valor Default na tabela de login
3	p_ambiente	Texto	IN	Seta Valor Default na tabela de login
4	p_chave_unica	Texto	IN	Está chave é a identificação única por beneficiário. Este chave não deve se repetir em nenhuma hipótese.
5	p_nova_senha	Texto	IN	Senha ao criar o acesso.
6	p_retorno	Texto	OUT	“TRUE” se a inserção ocorreu com sucesso, “FALSE” caso não tenha incluído na tabela.

View - omni_beneficiario_integracao

Tipo do objeto: View

Nome do objeto: omni_beneficiario_integracao

Objeto obrigatório: NÃO
Informação adicional: A view é opcional e preenche o objeto “integracao” do payload de login, primeiro acesso e relogin do Beneficiário, para mais informações sobre o funcionamento do objeto integração consulte https://mobilesaudejira.atlassian.net/wiki/spaces/MO/pages/2404450305/1.1+-+Login#Objeto-%E2%80%9Cbeneficiarios%E2%80%9D

Estrutura de campos:

Campo	Tipo	Obrigatório	Descrição
id_omni_integracao	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 de pessoa. Não deve se repetir em nenhuma hipótese, para pessoas diferentes.
numero_contrato	Texto	Sim	Número do contrato
chave	Texto	Sim	Nome do atributo a ser retornado como chave no objeto integração, recomendamos que não utilize caracteres especiais ou espaços. As chaves não podem se repetir entre o mesmo beneficiário
valor	Texto	Sim	Valor a ser atribuido a chave, retornará no objeto integração no formato: "integracao”: { { “chave” : “valor”, “chave2” : “valor2”, }

View - omni_ben_acesso_grupo_familiar

Tipo do objeto: View

Nome do objeto: omni_ben_acesso_grupo_familiar

Objeto obrigatório: NÃO
Informação adicional: A view é opcional e é utilizada exclusivamente na integração (também opcional) “grupoFamiliar” do Connect , descrita no documento 1.4 - Grupo familiar - Acesso funcionalidade
Estrutura de campos:

Campo	Tipo	Obrigatório	Descrição
id_acesso_grupo_familiar	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 de pessoa. Representa o usuário logado a regra será aplicada na relação entre o usuário logado e o usuário referenciado em chave_unica_acesso Para aplicar uma regra ao próprio usuário logado, a chave_unica será igual a chave_unica_acesso
id_funcionalidade	Texto	Sim	Id da funcionalidade que o acesso está sendo permitido
numero_contrato	Texto	Sim	Número do contrato do beneficiário referenciado em chave_unica_acesso para aplicação da regra de acesso.
chave_unica_acesso	Texto	Sim	Chave unica do beneficiário do grupo familiar, ao qual o usuário logado “chave_unica” tem permissão Exemplo: Titular acessa Atualização cadastral, id_funcionalidade=16 ChaveUnica do titular: 111.111.111-11 ChaveUnica do dependente: 222.222.222-22 Ambos estão em 2 contratos Contrato 1: 0001 Contrato 2: 0002 Titular possui acesso aos dois contratos, seus e do dependente Dependente só possui acesso à ele mesmo no contratro 1; No arranjo acima teriamos as seguintes referencias, com um login do titular¨: Acesso do titular, à ele mesmo no contrato 1 chave_unica = `111.111.111-11` numero_Contrato = `0001` chave_unica_acesso = `111.111.111-11` Acesso do titular, à ele mesmo no contrato 2 chave_unica = `111.111.111-11` numero_Contrato = `0002` chave_unica_acesso = `111.111.111-11` Acesso do titular, ao seu dependente no contrato 1 chave_unica = `111.111.111-11` numero_Contrato = `0001` chave_unica_acesso = `222.222.222-22` Acesso do titular, ao seu dependente no contrato 2 chave_unica = `111.111.111-11` numero_Contrato = `0002` chave_unica_acesso = `222.222.222-22` Acesso do dependente, à ele mesmo no contrato 1 chave_unica = `222.222.222-22` numero_Contrato = `0001` chave_unica_acesso = `222.222.222-22`

Caso não exita regra para a funcionalidade acessada OU a view não exista, a view omni_beneficiario será acessada para que todas as permissões sejam concedidas

View - omni_beneficiario_permissao

Tipo do objeto: View

Nome do objeto: omni_beneficiario_permissao

Objeto obrigatório: NÃO
Informação adicional: A view é opcional e é utilizada exclusivamente na integração (também opcional) do Connect , descrita no documento https://mobilesaudejira.atlassian.net/wiki/spaces/MO/pages/2404450305/1.1+-+Login#Seguran%C3%A7a-e-permiss%C3%B5es https://mobilesaudejira.atlassian.net/wiki/spaces/MO/pages/2404450305/1.1+-+Login#Objeto-%E2%80%9CusuarioLogado%E2%80%9D
Estrutura de campos:

Campo	Tipo	Obrigatório	Descrição

Campo	Tipo	Obrigatório	Descrição
id_omni_beneficiario_permissao	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 de pessoa. Representa o usuário logado.
id_funcionalidade	Texto	Sim	Id da funcionalidade que o acesso está sendo permitido
acesso	Número	Sim	Como no array de permissões da autenticação, controla se o usuário possui ou não acesso à funcionalidade 0 = False 1 = True
mensagem_bloqueio	Texto	Sim	Mensagem de bloqueio exibida ao acessar uma funcionalidade que ele não tem acesso. Importante ser preenchida já que mesmo oculto o usuário pode chegar na funcionalidade por outros caminhos (banners, notificação e etc)
ocultar	Número	Sim	Define se a funcionalidade deve ou não ser ocultada 0 = False 1 = True

Cenário:

Beneficiário cuja chave unica é 111.111.111-11 não terá acesso, porém poderá ver a funcionalidade, ao clicar na funcionalidade receberá a mensagem.

Exemplo dos campos da view:

id_omni_beneficiario_permissao = 1
id_operadora = 1
instancia_aplicacao = '1'
id_config_cliente_app = 1
chave_unica = 111.111.111-11
id_funcionalidade = 3
acesso = 0
mensagem_bloqueio = ‘Sem acesso’
ocultar = 0

Caso não exita regra para nenhuma funcionalidade será atribuído null.