HCP kernel for CDA

The HCP kernel defines a concise data structure for people involved in the delivery or administration of healthcare services.

HCP kernel components

The kernel contains the following components:

• Entity - HCP

• Attributes - 50 fields (HCP, Address). All fields contain the _cda__v suffix.

• Picklists - New reference types and reference codes. Multivalued reference fields are supported.

HCP CDA fields

All CDA fields contain the _cda__v suffix.

The ID field (veevaid__v) is the exception to the naming convention.

List of fields

Field Name	Field Label	Field Type	Description
veevaid__v	Veeva ID	Text	Global identifier from Veeva data products. The field is enabled by default in all Network instances, even if the CDA data model is not enabled.
first_name_cda__v	First Name (CDA)	Text	Given name as officially recorded in professional or legal documents.
last_name_cda__v	Last Name (CDA)	Text	Family or surname as officially recorded in professional or legal documents.
middle_name_cda__v	Middle Name (CDA)	Text	Secondary given name or initial as officially recorded in professional or legal documents.
prefix_cda__v	Prefix (CDA)	Text	Salutation or title used before a person's name, such as Mr., Mrs., Dr., etc.
suffix__cda__v	Suffix (CDA)	Text	Includes professional credentials or generational titles such as I, II, III, IV, but excludes medical degrees.
language_cda__v	Language (CDA)	Reference Type	Primary spoken and written language.
email_cda__v	Email (CDA)	Text	Primary email address.
mobile_phone_cda__v	Mobile Phone (CDA)	Text	Primary mobile phone number. May include country code including non-alphanumeric characters. e.g. +, -
office_phone_cda__v	Office Phone (CDA)	Text	Primary office phone number. May include country code including non-alphanumeric characters. e.g. +, -
fax_cda__v	Fax (CDA)	Text	Primary fax. May include country code including non-alphanumeric characters. e.g. +, -
country_cda__v	Country (CDA)	Reference Type	Country from primary address.
state_cda__v	State (CDA) (HCP field)	Reference Type	State, province, or regional area from primary address.
city_cda__v	City (CDA) (HCP field)	Text	City or municipality from primary address.
postal_code_cda__v	Postal Code (CDA) (HCP field)	Text	Postal code from primary address. May include non-alphanumeric characters. e.g. -
hcp_type_cda__v	Type (CDA)	Reference Type	The role an individual plays in the life sciences industry, spanning from the development and commercialization of life science products to their delivery and administration in healthcare settings.
nhid_cda__v	National Healthcare ID (CDA)	Text	Unique identifier assigned to healthcare professionals within a country's healthcare system.
spec_1_cda__v	Specialty (CDA)	Reference Type	The primary medical field or expertise area to which the healthcare professional belongs. Uses the list of specialties.
all_spec_cda__v	All Specialties (CDA)	Multivalued Reference Type	All medical fields and expertise areas to which the healthcare provider belongs. Uses the list of specialties.
spec_group_1_cda__v	Specialty Group (CDA)	Reference Type	The primary overarching medical field or expertise area to which the healthcare provider belongs. Uses the list of global specialties.
all_spec_group_cda__v	All Specialty Groups (CDA)	Multivalued Reference Type	All overarching medical fields and expertise areas to which the healthcare provider belongs. Uses the list of global specialties.
prescriber_cda__v	Prescriber (CDA)	Boolean	Indicates whether the individual is authorized to prescribe medications.
degree_1_cda__v	Medical Degree (CDA)	Reference Type	The primary medical qualification or degree obtained.
all_degree_cda__v	All Medical Degrees (CDA)	Multivalued Reference Type	Additional medical qualification or degree obtained.
status_cda__v	Status (CDA)	Reference Type	Indicates whether the healthcare professional is currently active and working or not.
level_cda__v	Level	Reference Type	Indicates the level of importance of this individual to the company, where level 5 indicates the highest level of importance. Can be used to drive business rules. For example: You may want to limit personalized promotions to levels 3 and below. You may also require a single relationship owner for level 5.
adopter_type_cda__v	Adopter Type	Reference Type	A categorization of the individual based on their willingness and speed to adopt new medical technologies, treatments, practices, or products.
kol_cda__v	Key Opinion Leader	Boolean	Recognized as a key opinion leader in the industry.
investigator_cda__v	Investigator	Boolean	Indicates whether the individual is involved in running clinical research studies.
speaker_cda__v	Speaker	Boolean	Indicates whether the individual is engaged in speaking roles at professional gatherings or educational events for the company.
target_cda__v	Target	Boolean	Indicates whether the individual is a target for one or more brands of the company.
year_of_birth_cda__v	Year of Birth (CDA)	Number	Birth year of the HCP.
age_range_cda__v	Age Range (CDA)	Reference Type	Age range of the HCP.
street_address_1_cda__v	Street Address 1 (CDA)	Text	Residential or business street address information including house number and street name.
street_address_2_cda__v	Street Address 2 (CDA)	Text	Additional address details, such as apartment, suite, or building number.
country_cda__v	Country (CDA)	Reference Type	Name of country.
state_cda__v	State (CA) (Address field)	Reference Type	Name of state, province, or regional area.
city_cda__v	City (CDA) (Address field)	Text	Name of city or municipality.
postal_code_cda__v	Postal Code (CDA) (Address field)	Text	May include non-alphanumeric characters.
latitude_cda__v	Latitude (CDA)	Number	Geographic coordinate specifying north-south position.
longitude_cda__v	Longitude (CDA)	Number	Geographic coordinate indicating east-west position.
phone_cda__v	Phone (CDA)	Text	Phone number. May include country code including non-alphanumeric characters. e.g. +, -
fax_cda__v	Fax (CDA)	Text	Fax number. May include country code including non-alphanumeric characters. e.g. +, -
status_cda__v	Status (CDA)		Indicates whether this address is currently usable for contact purposes.
business_cda__v	Business (CDA)	Boolean	Indicates whether this represents a business address.
home_cda__v	Home	Boolean	Indicates whether this represents a home address.
billing_cda__v	Billing	Boolean	Indicates whether this represents a billing address.
shipping_cda__v	Shipping	Boolean	Indicates whether this represents a shipping address.
sample_shipping_cda__v	Sample Shipping	Boolean	Indicates whether this represents a shipping address that can accept medical shipments.
primary_cda__v	Primary (CDA)	Boolean	Indicates whether this represents the individual's primary address. Only one address can be marked as Primary.

Field details

See the CDA data model fields topic for the following information:

• Field calculation rules for each country / region

• Network > CDA language mappings

• Network CDA reference code mappings

OpenData managed HCP fields

Veeva-managed HCP CDA field values will be pushed to your Network instance through your OpenData subscriptions or ad hoc downloads as usual.

Note: The CDA Sync setting does not need to be enabled in our Network instance to receive OpenData in these CDA fields.

HCP fields

Field Name	Label
veevaid__v	Veeva ID
first_name_cda__v	First Name (CDA)
last_name_cda__v	Last Name (CDA)
middle_name_cda__v	Middle Name (CDA)
prefix_cda__v	Prefix (CDA)
suffix__cda__v	Suffix (CDA)
language_cda__v	Language (CDA)
email_cda__v	Email (CDA)
mobile_phone_cda__v	Mobile Phone (CDA)
office_phone_cda__v	Office Phone (CDA)
fax_cda__v	Fax (CDA)
country_cda__v	Country (CDA)
hcp_type_cda__v	Type (CDA)
nhid_cda__v	National Healthcare ID (CDA)
spec_1_cda__v	Specialty (CDA)
all_spec_cda__v	All Specialties (CDA)
spec_group_1_cda__v	Specialty Group (CDA)
all_spec_group_cda__v	All Specialty Groups (CDA)
prescriber_cda__v	Prescriber (CDA)
degree_1_cda__v	Medical Degree (CDA)
all_degree_cda__v	All Medical Degrees (CDA)
status_cda__v	Status (CDA)

Address fields

Field Name	Label
street_address_1_cda__v	Street Address 1 (CDA)
street_address_2_cda__v	Street Address 2 (CDA)
country_cda__v	Country (CDA)
state_cda__v	State (CA)
city_cda__v	City (CDA)
postal_code_cda__v	Postal Code (CDA)
latitude_cda__v	Latitude (CDA)
longitude_cda__v	Longitude (CDA)
phone_cda__v	Phone (CDA)
fax_cda__v	Fax (CDA)
status_cda__v	Status (CDA)
business_cda__v	Business (CDA)

Email field

You can subscribe to HCP email address data for supported OpenData countries.

The CDA email field, email_cda__v , is included with the legacy email fields (email _1__v to email_10__v) in these Email subscriptions.

To subscribe to HCP emails for a country, contact your Veeva representative.

Populate OpenData managed CDA fields

See OpenData-managed CDA fields.

Locally managed HCP fields

These CDA fields and their values are managed in your Network instance. These are custom fields, but they have the __v suffix.

HCP fields

Field Name	Label	Calculated?	Mapped Legacy Field
adopter_type_cda__v	Adopter Type	No	No mapping
age_range_cda__v	Age Range (CDA)	No	No mapping
city_cda__v	City (CDA)	Yes	locality__v
investigator_cda__v	Investigator	No	No mapping
level_cda__v	Level	No	No mapping
kol_cda__v	Key Opinion Leader	No	No mapping
postal_code_cda__v	Postal Code (CDA)	Yes	postal_code__v
speaker_cda__v	Speaker	No	No mapping
state_cda__v	State (CDA)	Yes	administrative_area__v
target_cda__v	Target	No	No mapping
year_of_birth_cda__v	Year of Birth (CDA)	No	No mapping

Address fields

Field Name	Label	Calculated?	Mapped Legacy Field
billing_cda__v	Billing	No	No mapping
home_cda__v	Home	No	No mapping
primary_cda__v	Primary (CDA)	No	No mapping
sample_shipping_cda__v	Sample Shipping	No	No mapping
shipping_cda__v	Shipping	No	No mapping

Primary CDA field

The primary_cda__v field flags an HCPs best address. Primary address fields contain several options for calculating the primary address.

For the Primary CDA field, all options are selected so Network will recalculate the primary for the following conditions:

• The record does not have a primary address

• The current primary address is inactive.

• The current primary address is invalid or deleted.

These options ensure that when a new HCP record is downloaded, a primary address is defined. The options can be customized to meet your business needs.

Calculated HCP fields

Calculated fields are populated by the CDA Sync process in your Network instance. This means that the fields are read-only.

CDA Sync maps the legacy HCP field values to the calculated CDA fields.

CDA Sync runs when data is updated in your Network instance, for example, through source subscriptions, data updater, DCRs, and merges. The process calculates the CDA field values using internal country-based rules or by mapping the corresponding legacy field value.

Note: The CDA Sync setting must be enabled in your Network instance so calculated fields values can be populated.

Non-calculated fields

Locally managed CDA fields that are not calculated are managed just like legacy fields.

• adopter_type_cda__v

• age_range_cda__v

• billing_cda__v

• home_cda__v

• investigator_cda__v

• kol_cda__v

• level_cda__v

• primary_cda__v

• sample_shipping_cda__v

• shipping_cda__v

• speaker_cda__v

• target_cda__v

• year_of_birth_cda__v

Populating the fields

See Locally managed CDA fields.

Picklists for HCP CDA fields

Many of the HCP fields are reference type fields that have CDA reference types (picklists).

Restricted picklists

Custom (customer owned) reference codes cannot be added to these picklists.

• AddressCountryCDA

• AddressStateCDA

• AdopterTypeCDA

• AgeRangeCDA

• HCPSpecialtyCDA

• HCPSpecialtyGroupCDA

• LanguageCDA

• LevelCDA

• StatusCDA

The KeyStatus reference list is also read-only.

Unrestricted picklists

Custom reference codes can be added to these picklists

• HCPTypeCDA

• HCPMedicalDegreeCDA

Reference codes

Administrators and Data Managers can view the reference codes in the Network UI (Data Model > Reference Data).

Note: CDA reference codes are in lowercase, for example, dvm, dmd, md.