Beneficiários - Layouts de carga de dados

Índice

1 Índice
- 1.1 Critérios de confecção de arquivos
- 1.2 Critérios de preenchimento
- 1.3 Arquivo beneficiário
- 1.4 Grupo Familiar
- 1.5 Multi-contrato
- 1.6 Acesso Funcionalidade
- 1.7 Arquivo carências
- 1.8 Modelos Arquivos de Carga
- 1.9 Realizando Carga Automatizada

O processo descrito neste documento vale tanto para cargas de beneficiários, quanto de rede credenciada.

Critérios de confecção de arquivos

Para que o importador automatizado execute suas tarefas corretamente, é obrigatório que seus arquivos estejam sejam compactados individualmente em um formato .ZIP.

Além disso, eles devem ser:

Compactados individualmente obedecendo a seguinte nomenclatura:
Compactados novamente, em um único ZIP (que caracterizará o lote de importação)

Disponibilizamos arquivos de exemplo para um melhor entendimento do artefato que deve ser importado na plataforma da Mobile Saúde. clique aqui

Carga de dados para Beneficiários

A estrutura de importação de beneficiários é composta por dois arquivos; beneficiários e carências. O arquivo de beneficiários é obrigatório, já o de carências não.

Critérios de preenchimento

Abreviação	Nome	Descrição

Abreviação	Nome	Descrição
M	Mandatório	O preenchimento do atributo é obrigatório. Caso o atributo esteja nulo ou em branco, seu arquivo será rejeitado.
C	Condicional	O atributo pode tornar-se obrigatório quando um ou mais atributos auxiliares for preenchido / atualizado.
OP	Opcional	Seu preenchimento não é obrigatório.

Arquivo beneficiário

	Nome da coluna	Descrição	Tipo	Tamanho	Obrigatório	Exemplos

	Nome da coluna	Descrição	Tipo	Tamanho	Obrigatório	Exemplos
1	id_registro	Código único que identifica o registro.	Alfanumérico	1 a 15	M	1, 0001, AA1
2	chave_unica	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.	Alfanumérico	1 a 100	M	RECOMENDAMOS FORTEMENTE O USO DE CPF PARA ESSE CAMPO.
3	perfil	Referente ao tipo de arquivo.	Alfanumérico	1 a 100	M	IMPORTANTE informe o valor fixo “beneficiario”
4	esquema_cor	Esquema de cor que o beneficiário verá nos apps.	Alfanumérico	1 a 100	OP	Informar esquema de cor definido no painel do Mosia Omnichannel
5	nome	Nome do beneficiário.	Alfanumérico	1 a 300	M
6	nome_social	Nome “social” do beneficiário.	Alfanumérico	1 a 300	OP
7	sexo_codigo	Código do sexo do beneficiário.	Alfanumérico	1	M	Conteúdos válidos: F ou M. Outros conteúdos não são válidos.
8	sexo_descricao	Sexo do beneficiário.	Alfanumérico	1 a 50	M	Feminino, Masculino
9	data_nascimento	Data de nascimento do beneficiário.	Data	10	M	Formato: AAAA-MM-DD 1980-12-31
10	cpf	Documento CPF do beneficiário (sem formatação).	CPF	11	OP	Sem pontos ou traços: 0188899950
11	telefone_celular	Número do celular do beneficiário.	Celular	11	OP	Sem pontos ou traços: 27999881010
12	telefone_fixo	Número do telefone fixo do beneficiário.C	Telefone	10	OP	Sem pontos ou traços: 2732601010
13	email	Email do beneficiário.	Email	5 a 100	OP	exemplo@teste.com.br
14	endereco	Logradouro da residência do beneficiário.	Alfanumérico	3 a 300	OP	Rua Fulano de Tal, Avenida Central, Rodovia 10 KM 20
15	bairro	Bairro da residência do beneficiário.	Alfanumérico	3 a 100	OP	Centro
16	cep	CEP	CEP	8	OP	Sem pontos ou traços: 01444050
17	cidade	Código IBGE do município da residência do beneficiário.	Alfanumérico	7 a 10	OP	Código IBGE: 3205309
18	estado	Sigla do estado da residência do beneficiário.	Sigla do estado	2	OP	Tabela UF IBGE: ES, MG, SP, RJ
19	complemento	Complemento do endereço da residência do beneficiário.	Alfanumérico	0 a 300	OP	Fundos, Perto da Loja Fulano, Apartamento 310
20	numero_endereco	Número da residência do beneficiário.	Alfanumérico	0 a 15	OP	SN, 100, 999A
21	estado_civil_codigo	Código do estado civil do beneficiário.	Alfanumérico	1	M	Ex: S - Solteiro, C - Casado, D - Divorciado, V - Viúvo
22	estado_civil_descricao	Descrição do estado civil do beneficiário.	Alfanumérico		M	Ex: Solteiro(a), Casado(a), Divorciado(a), Viúvo(a)
23	cod_familia	Código comum entre membros da mesma família, usamos este campo para agrupar os mesmos de uma mesma família.	Alfanumérico	100	M	Geralmente são um range de números referentes a uma parte da matricula do beneficiário na Operadora de saúde.
24	plano_matricula	Matrícula do plano do beneficiário.	Alfanumérico	0 a 100	OP
25	plano_matricula_antiga	Matrícula antiga do plano do beneficiário.	Alfanumérico	0 a 100	OP
26	plano_matricula_funcionario	Matrícula do plano do funcionário.	Alfanumérico	0 a 100	OP
27	plano_grau_parentesco_codigo	Código do grau de parentesco.	Numérico	1 a 3	M	Ex: 01 - Titular, 02 - Cônjuge (independente se for esposa, marido ou companheiro(a)), 03 - Daqui para frente é livre
28	plano_grau_parentesco_descricao	Descrição do grau de parentesco.	Alfanumérico	3 a 100	M	Ex: BENEFICIARIO TITULAR, CONJUGE/ COMPANHEIRO, AGREGADO e OUTROS (A descrição é livre)
29	plano_codigo	Código do plano.	Alfanumérico	1 a 15	M
30	plano_descricao	Descrição do plano.	Alfanumérico	3 a 100	M	PRODUTO EXEMPLO 1, PRODUTO PLUS EXEMPLO
31	plano_abrangencia	Abrangência do plano.	Alfanumérico	3 a 100	M	NACIONAL, REGIÃO SUDESTE
32	plano_acomodacao	Acomodação do plano.	Alfanumérico	3 a 100	M	APARTAMENTO
33	plano_modalidade_cobranca	Modalidade da cobrança do plano.	Alfanumérico	1 a 15	M	Este campo é livre Ex: 01, 02, PMC01, PMC02
34	plano_padrao_conforto	Indicação no nível de conforto da acomodação.	Alfanumérico	0 a 100	OP	APARTAMENTO LUXO, APARTAMENTO COMPARTILHADO
35	plano_participativo	Indica se o plano é coparticipativo.	Alfanumérico	1	M	Conteúdos válidos: 0 = NAO 1 = SIM
36	plano_segmentacao	Segmentação do plano.	Alfanumérico	0 a 100	M	AMBULATORIAL
37	plano_tipo_contratacao	Tipo de contratação do plano.	Alfanumérico	0 a 100	M
38	plano_regulamentacao	Regulamentação do plano.	Alfanumérico	0 a 100	M	REGULAMENTADO
39	plano_rede_atendimento_codigo	Código da rede de atendimento do plano.	Alfanumérico	0 a 100	OP	Este campo é livre Ex: 001, 002, RDA01, RDA02
40	plano_data_final_cpt	Data final CPT do plano.	Alfanumérico	0 a 100	M	Informar o conteúdo que deseja que esteja disponível. Exemplos: “31/12/2024" “Sem CPT” “Não Há” Etc
41	plano_registro_ans	Código no registro ANS.	Alfanumérico	9 a 10	M	ANS-99999
42	plano_inicio_vigencia	Data que o beneficiário iniciou no plano	Data		M	Formato: AAAA-MM-DD 2050-12-31
43	plano_tipo_usuario_codigo	Código do tipo do usuário.	Alfanumérico	1 a 3	M	D, T, A
44	plano_tipo_usuario_descricao	Descrição do tipo do usuário.	Alfanumérico	3 a 100	M	DEPENDENTE, TITULAR, AGREGADO
45	cartao_validade	Validade do cartão.	Data		M	Formato: AAAA-MM-DD 2050-12-31
46	cartao_via	Via do cartão.	Numérico	1 a 3	M	0, 1, 99
47	cartao_numero_cns	Número CNS do cartão.	Alfanumérico	3 a 100	M	999999999999999
48	cartao_apresenta_cartao	Indicação se o cartão será apresentado.	Alfanumérico	1	M	Conteúdos válidos: 0 = NAO 1 = SIM
49	empresa_contratante_codigo	Código da empresa contratante.	Alfanumérico	0 a 15	M
50	empresa_contratante_descricao	Descrição da empresa contratante.	Alfanumérico	0 a 100	M
51	cartao_modelo	Modelo do cartão.	Alfanumérico	3 a 100	M	padrao, plus, standard
52	cartao_numero	Número do cartão.	Alfanumérico	3 a 100	M	99999999999999, 99999999999999ABC
53	contrato_tipo_pessoa_codigo	Natureza jurídica do beneficiário.	Lista de opções	1	M	J, F
54	contrato_tipo_pessoa_descricao	Descrição da natureza jurídica do beneficiário.	Lista de opções	3 a 50	M	JURIDICO, FISICA
55	tipo_relacionamento_codigo	Código do tipo do relacionamento.	Alfanumérico	1	M	código do tipo de relacionamento (1, 2, 3)
56	tipo_relacionamento_descricao	Descrição do tipo de relacionamento.	Alfanumérico	50	M	Conteúdo válido: 1 = titular 2 = dependente 3 = responsável financeiro
57	tipo_contratante_codigo	Código do tipo do contratante.	Numérico	0 a 1	M	1
58	tipo_contratante_descricao	Descrição do tipo do contratante.	Alfanumérico	0 a 50	M	BENEFICIARIO
59	contrato_data_inicio_vigencia	Data de início da vigência do contrato.	Data		M	Formato: AAAA-MM-DD 2025-12-31
60	bloqueio_bloqueado	Indica o bloqueio do beneficiário.	Alfanumérico	1	OP	Conteúdos válidos: 0 = NAO 1 = SIM
61	bloqueio_data_bloqueio	Data do bloqueio.	Data		C	Obrigatório quando bloqueio_bloqueado = 1. Formato: AAAA-MM-DD 2025-12-31
62	bloqueio_motivo_bloqueio	Motivo do bloqueio.	Alfanumérico	0 a 300	C	Obrigatório quando bloqueio_bloqueado = 1.
63	contrato_descricao	Nome/descrição do contrato.	Alfanumérico	3 a 100	M	Contrato de exemplo
64	numero_contrato	Número do contrato.	Alfanumérico	3 a 100	M	123456789A
65	cartao_nome	Nome do beneficiário apresentado no cartão.	Alfanumérico	3 a 100	M
66	cartao_nome_social	Nome “social” apresentado no cartão.	Alfanumérico	0 a 100	OP
67	cartao_operadora_contratada	Nome da operadora apresentado no cartão.	Alfanumérico	0 a 100	OP
68	cartao_convenio_ans_contratada	Número ANS do convênio contratado.	Alfanumérico	0 a 100	OP
69	cartao_seed	Em caso disponibilização de um token na carteirinha do beneficiário este atributo que faz com que o token de um beneficiário seja diferente de outro.	Alfanumérico	0 a 100	OP	Seed utilizado para gerar o token. Formato: Texto livre, mas deve ser enviado como BASE32. Para saber como sua STRING deve ser enviada, siga esse link online:Caso não saiba o que é um BASE32, siga esse link: Link 1: Base32 converter – Encode and decode online Link 2: Base32
70	cartao_convenio_abrangencia_verso	Abrangência apresentado no verso do cartão.	Alfanumérico	0 a 100	OP
71	contrato_codigo_local_atendimento	Local de atendimento apresentado no cartão.	Alfanumérico	0 a 100	OP	Este campo é utilizado nos layout para cartões Unimed, se referente a descrição do local de atendimento do PTU no cartão Unimed, caso não possua não preencher este valor.
72	plano_rede_atendimento_descricao	Nome/descrição da rede de atendimento do plano.	Alfanumérico	0 a 100	OP	Este campo é livre: Ex: Rede Própria, Rede Credenciada, Rede Privada.
73	acesso_funcionalidade	Especifique quais funcionalidades que o beneficiário acesse, conforme os IDs de funcionalidades, na documentação mais abaixo segue a lista com os IDs das funcionalidades.	Alfanumérico	0 a 100	OP	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. Para que o seu beneficiário tenha acesso a todas as funcionalidades basta deixar este campo em branco.
74	nome_mae	Nome da mãe	Alfanumérico		OP
75	data_inclusao	Data do inclusão.	Data		OP	Formato: AAAA-MM-DD 2025-12-31

Acesso Funcionalidade

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

 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'

Arquivo carências

	Nome da coluna	Descrição	Tipo	Tamanho	Obrigatório	Exemplos

	Nome da coluna	Descrição	Tipo	Tamanho	Obrigatório	Exemplos
1	id_registro	Código único que identifica o registro. Este campo torna-se mandatório (M) caso este arquivo de “carências” seja enviado.	Alfanumérico	1 a 15	C	1, 0001, AA1
2	chave_unica	Valor informado no campo “chave_unica” no arquivo de carga de beneficiários. Este campo torna-se mandatório (M) caso este arquivo de “carências” seja enviado.	Alfanumérico	1 a 100	C	CPF, Matricula
3	plano_codigo	Valor informado no campo “plano_codigo” no arquivo de carga de beneficiários. Este campo torna-se mandatório (M) caso este arquivo de “carências” seja enviado.	Alfanumérico	1 a 15	C
4	tipo_servico	Tipo do serviço. Este campo torna-se mandatório (M) caso este arquivo de “carências” seja enviado.	Alfanumérico	0 a 100	C	Ex: Consulta, Exames
5	carencia	Informe a carência. Este campo torna-se mandatório (M) caso este arquivo de “carências” seja enviado.	Alfanumérico	0 a 100	C	Formato: AAAA-MM-DD Ex: 2024-12-01, sem carência, etc..
6	numero_contrato	Informe a numero_contrato. Este campo torna-se Opcional (OP) caso este arquivo de “carências” seja enviado.	Alfanumérico	0 a 45	OP	Ex: 36690631669

Modelos Arquivos de Carga

Estes são exemplos dos arquivos de carga de “beneficiário” e “carência”, onde a estrutura/quantidade de colunas devem estar obrigatoriamente iguais a estes.

Modelo Carga de Dados - Beneficiário
Modelo Carga de Dados - Carência

Realizando Carga Automatizada

É possível configurar a sua carga de dados de beneficiários de maneira automática, imagine a seguinte situação:

“Precisamos enviar um arquivo com os dados dos beneficiários atualizados diariamente, temos como fazer isso na plataforma?”

SIM! É possível automatizar o seu processo seguindo esta documentação para envio de arquivos de carga conforme necessidade da Operadora (diária, semanal, quinzenal e etc).

Para mais detalhes clique aqui