View ou Tabela que deve constar todos os dados de beneficiário ativos.
Nome Atributo | Tipo Atributo | Obrigatório | Descrição |
|---|---|---|---|
id_omni_beneficiario | 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. |
chave_unica | Texto | Sim | Está chave é a identificação única por beneficiário, é a identificação da Pessoa. Este chave não deve se repetir em nenhuma hipótese, para uma outra Pessoa ou Beneficiário. |
perfil | !!! | !!! | !!! |
esquema_cor | Texto | Não | A string deve ser a mesma que o apelido gerado na opção de esquema de cor no configurador de aplicação, caso tenha definido um esquema de cor que não existe, o aplicativo irá usar as cores padrão. |
nome | Texto | Sim | Nome do beneficiário, Não permitir números, nem caracteres especiais. Permitido acentos. |
sexo_codigo | Texto | Sim | Chave que identifica a descrição de sexo. |
sexo_descricao | Texto | Sim | Descrição do Sexo. |
data_nascimento | Texto | Sim | Texto formato: YYYY-MM-DD |
cpf | Texto | Sim | CPF do beneficiário, sem pontuação, tamanho máximo 11 dígitos. |
telefone_celular | Texto | Sim | Indique o telefone celular do usuário logado, tamanho mínimo / máximo 11 posições. Somente números |
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. |
Texto | Sim | Indique o email do usuario logado. Email precisa ser válido . | |
endereco | !!! | !!! | !!! |
bairro | !!! | !!! | !!! |
cep | !!! | !!! | !!! |
cidade | !!! | !!! | !!! |
estado | !!! | !!! | !!! |
complemento | !!! | !!! | !!! |
numero_endereco | !!! | !!! | !!! |
estado_civil_codigo | Texto | Sim | C = casado, S = solteiro, V = viúvo, D = divorciado. |
estado_civil_descricao | Texto | Sim | “Casado”, “Solteiro”, “Viúvo”, “Divorciado”. |
cod_familia | Texto | Sim | Este atributo define uma código para uma família dentro de 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. |
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, para manter funcionando integrações com outros sistemas legados. Por este motivo é importante termos essa informação. |
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. |
plano_grau_parentesco_descricao | Texto | Sim | Descrição do grau de parentesco |
plano_codigo | Texto | Sim | Numeração do código do plano. |
plano_descricao | Texto | Sim | Nome 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 |
plano_rede_atendimento_descricao | Texto | Não | Descrição da rede de atendimento |
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. |
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: Titular, Denpendente, 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 | Numero do Cartão Nacional de Saúde. Obrigatório no cartão do beneficiário conforme RN 389. |
cartao_apresenta_cartao | Número | Sim | Retornar 1 se o cartão for apresentar, e 0 se não. |
empresa_contratante_codigo | Texto | !!! duvida ver regra de preenchimento | Código da empresa. |
empresa_contratante_descricao | Texto | !!! duvida | Nome da empresa. |
cartao_modelo | Texto | Sim | modelo do cartão que será reproduzido, no aplicativo. |
cartao_numero | Texto | Sim | Número do cartão, que será exibido na carteirinha. |
contrato_tipo_pessoa_codigo | Texto | Sim | “F” = Pessoa Física , “J” = Pessoa Jurídica. |
contrato_tipo_pessoa_descricao | Texto | Sim | 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 | Código do tipo do contratante (1, 2, 3) |
tipo_contratante_descricao | Texto | Sim | Conteúdo válido: |
contrato_data_inicio_vigencia | Texto | !!! dúvida | Formato: YYYY-MM-DD |
bloqueio_bloqueado | Texto | Sim | Retornar 1 se o beneficiário está bloqueado, e 0 se não. |
bloqueio_data_bloqueio | Texto | Sim caso bloqueio_bloqueado for igual a 1 | Formato: YYYY-MM-DD |
bloqueio_motivo_bloqueio | Texto | Sim caso bloqueio_bloqueado for igual a 1 | Formato: Texto livre. |
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 | 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. Formato: Texto livre, mas deve ser enviado como BASE32. |
cartao_convenio_abrangencia_verso | Texto | Não | Texto descritivo da abrangência contido no verso do cartão |
contrato_codigo_local_atendimento | Texto | Não | Código referente ao local de atendimento |