Histórico da Página

...

Visão Geral
Exemplo de utilização
Configuração Layout Cartão
1. Outras Ações / Ações relacionadas
Configuração dos Campos no Arquivo JSON
1. Principais Campos e Parâmetros
Tabelas utilizadas

01. VISÃO GERAL

Essa Esta documentação descreve detalha o processo de configuração do layout customizado da carteirinha no portal do beneficiário. A API /totvsHealthPlans/familyContract/v1/beneficiaries/:subscriberId/card retorna os dados necessários para montar o layout do cartão, tanto para , abrangendo tanto a frente quanto para o verso. Caso seja necessário incluir outros Para adicionar novos campos, utilize o ponto de entrada PTBENCARD.

...

Bloco de código

language	c#
theme	Midnight
title	layout-config.json
linenumbers	true
collapse	true

{
	"front": [
		{
			"css": "font-size: 9px;font-weight: bold;top: 50px; width: 200px; left: 300px;",
			"values": [
				{
					"type": "custom",
					"value": "meuCampo"
				}
			]
		},
		{
			"css": "font-size: 9px;font-weight: bold;top: 70px; width: 200px; left: 20px;",
			"values": [
				{
					"type": "field",
					"value": "planDescription"
				},
				{
					"type": "field",
					"value": "accommodationDescription"
				}
			]
		},
		{
			"css": "font-size: 9px;font-weight: bold;top: 85px; width: 200px; left: 20px;",
			"values": [
				{
					"type": "field",
					"value": "coverageArea"
				}
			]
		},
		{
			"css": "font-size: 8px;top: 117px; width: 70px; left: 330px;",
			"values": [
				{
					"type": "text",
					"value": "VÁLIDO ATÉ:"
				}
			]
		},
		{
			"css": "font-size: 10px;font-weight: bold;top: 135px; width: 400px; left: 20px; color: white",
			"values": [
				{
					"type": "field",
					"value": "subcontractCardName"
				}
			]
		}
	],
	"back": [
		{
			"css": "font-size: 9px;font-weight: bold;top: 70px; width: 200px; left: 100px;",
			"values": [
				{
					"type": "field",
					"value": "planDescription"
				},
				{
					"type": "field",
					"value": "accommodationDescription"
				}
			]
		}
	]
}

View file

name	layout-config.json
height	150

Após aplicar a configuração, a carteirinha no portal será renderizada com os campos dinâmicos e fixos conforme definidos no arquivo layout-config.json. A imagem do cartão será gerada com base nas imagens da frente e verso, aplicando o estilo CSS e exibindo os valores de acordo com as informações retornadas pela API.

Segue a lista de campos padrão disponíveis para a configuração do arquivo de layout:

Campo	Descrição	Campo (Protheus)
name	Nome completo do beneficiário.	BTS_NOMCAR ou BTS_NOMUSR
socialName	Nome social do beneficiário.	BTS_NOMSOC
healthInsurerCode	Código da operadora de saúde.	BA1_CODINT
companyCode	Código da empresa.	BA1_CODEMP
registrationCode	Código de registro do beneficiário.	BA1_MATRIC
kinshipCode	Código de parentesco.	BA1_TIPREG
digit	Dígito de identificação.	BA1_DIGITO
nationalHealthCard	Número do cartão nacional de saúde	BTS_NRCRNA
subscriberId	Identificador único do beneficiário.	BA1_CODINT + BA1_CODEMP + BA1_MATRIC + BA1_TIPREG + BA1_DIGITO
birthDate	Data de nascimento do beneficiário.	BA1_DATNAS
cardValidity	Data de validade do cartão.	BA1_DTVLCR
effectiveDate	Data de efetivação do plano de saúde.	BA1_DATINC
cardCopy	Identificador da cópia do cartão.	BA1_VIACAR
holderName	Nome do titular do plano.	BTS_NOMCAR ou BTS_NOMUSR
holderHealthInsurerCode	Código da operadora de saúde do titular.	BA1_CODINT
holderCompanyCode	Código da empresa do titular.	BA1_CODEMP
holderRegistrationCode	Código de registro do titular.	BA1_MATRIC
holderKinshipCode	Código de parentesco do titular.	BA1_TIPREG
holderDigit	Dígito de identificação do titular.	BA1_DIGITO
holderSubscriberId	Identificador único do titular.	BA1_CODINT + BA1_CODEMP + BA1_MATRIC + BA1_TIPREG + BA1_DIGITO
dependentName	Nome do dependente.	BTS_NOMCAR ou BTS_NOMUSR
dependentHealthInsurerCode	Código da operadora de saúde do dependente.	BA1_CODINT
dependentCompanyCode	Código da empresa do dependente.	BA1_CODEMP
dependentRegistrationCode	Código de registro do dependente.	BA1_MATRIC
dependentKinshipCode	Código de parentesco do dependente.	BA1_TIPREG
dependentDigit	Dígito de identificação do dependente.	BA1_DIGITO
dependentSubscriberId	Identificador único do dependente.	BA1_CODINT + BA1_CODEMP + BA1_MATRIC + BA1_TIPREG + BA1_DIGITO
planCode	Código do plano.	BI3_CODIGO
planDescription	Descrição do plano de saúde.	BI3_NREDUZ
accommodationDescription	Descrição da acomodação do plano.	BI4_CODEDI
coverageArea	Área de cobertura do plano de saúde.	BI3_ABRANG
planRegulation	Tipo de regulamentação do plano.	BI3_APOSRG
planCodeANS	Código do plano na ANS.	BI3_SUSEP ou BI3_SCPA
planSegmentation	Segmentação do plano.	BI6_DESCRI
subcontractCardName	Nome do cartão de subcontrato.	BQC_NOMCAR
healthInsurerCodeANS	Código da operadora de saúde na ANS.	BA0_SUSEP
healthInsurerName	Nome da operadora de saúde.	BA0_NOMINT

Exemplo de Imagem do Cartão no Portal

...

Campo	Descrição
front	Contém a lista de configurações para a frente do cartão.
back	Contém a lista de configurações para o verso do cartão.
css	Define o estilo CSS para cada campo.
values	Define os valores a serem exibidos, podendo ser: field, text, ou custom.
type: field	Refere-se a um campo retornado pela API.
type: text	Exibe um texto fixo no layout.
type: custom	Permite adicionar campos customizados, definidos pelo ponto de entrada PTBENCARD.
value	Define o valor a ser exibido no campo, conforme o tipo (campo da API ou texto fixo).

05. TABELAS UTILIZADAS

BA0 - Operadoras de Saúde
BA1 - Beneficiários
BA3 - Famílias de Usuários
BDE - Exportação de Identificação
BED - Cobranças e Emissão de Carteirinhas
BI3 - Produtos de Saúde
BI4 - Tipos de Acomodação para Internação
BI6 - Segmentação de Saúde
BPX - Motivos para Emissão de Carteira
BQC - Subcontratos
BTS - Cadastro de Vidas

Árvore de páginas

Versões comparadas

Versão antiga 5

Nova versão Atual

Chave

01. VISÃO GERAL

Exemplo de Imagem do Cartão no Portal

05. TABELAS UTILIZADAS