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.
- 1 View - omni_beneficiario
- 2 View - omni_beneficiario_carencia
- 3 View - omni_beneficiario_login
- 4 View - omni_beneficiario_custom
- 5 Stored Procedure - omni_sp_cria_acesso
- 6 Stored Procedure - omni_sp_update_acesso
- 7 View - omni_beneficiario_integracao
- 8 View - omni_ben_acesso_grupo_familiar
- 9 View - omni_beneficiario_permissao
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: No Omnilink o uso do CPF é OBRIGATÓRIO neste campo, 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 |
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: |
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 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: 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 |
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: |
tipo_contratante_codigo | Texto | Sim |
Mobile Saúde - Mosia Omnichannel