CDA kernels
CDA kernels define a concise data structure for people or entities involved in the delivery or administration of healthcare services.
Supported kernels
-
HCP
-
HCO
The CDA industry standard includes fields in the Address sub-object.
Kernel components
Each kernel contains the following components:
| Entity | Attributes | Reference Types (Picklists) |
|---|---|---|
| HCP | 34 fields | 11 reference types Multivalued reference fields are supported. |
| HCO | 15 fields | 4 reference types |
| Address | 17 fields | 4 reference types |
CDA fields
The following fields are available for the HCP and HCO kernels. All CDA fields contain the _cda__v suffix.
Field ownership
CDA fields can be managed by Veeva or managed by customers (locally managed).
-
Veeva - Field values are populated through your OpenData country subscriptions or ad hoc downloads.
-
Customers - The fields and their values are locally managed in your Network instance. These are custom fields, but they have the
__vsuffix.Locally managed fields can be one of the following types:
-
Calculated - Fields are read-only. The values are mapped to the legacy field values and are populated through the CDA Sync process.
-
Non-calculated - Updates can be made directly to the field through data loading and data change requests (DCRs).
-
For details about populating the CDA field values, see Managing CDA fields.
List of fields
| Field Name | Field Label (EN) | Field Type | Description | Object | Managed By | Calculated? |
|---|---|---|---|---|---|---|
| adopter_type_cda__v | Adopter Type | Reference Type (AdopterTypeCDA) | A categorization of the individual based on their willingness and speed to adopt new medical technologies, treatments, practices, or products. | HCP |
Veeva |
|
| age_range_cda__v | Age Range (CDA) | Reference Type (AgeRangeCDA) | Age range of the HCP. | HCP |
Customer |
|
| all_degree_cda__v | All Medical Degrees (CDA) | Multivalued Reference Type (HCPMedicalDegreeCDA) | Additional medical qualification or degree obtained. | HCP | Veeva | |
| all_spec_cda__v | All Specialties (CDA) | Multivalued Reference Type (HCPSpecialtyCDA) | All medical fields and expertise areas to which the healthcare provider belongs. Uses the list of specialties. | HCP | Veeva | |
| all_spec_group_cda__v | All Specialty Groups (CDA) | Multivalued Reference Type (HCPSpecialtyGroupCDA) | All overarching medical fields and expertise areas to which the healthcare provider belongs. Uses the list of global specialties. | HCP | Veeva | |
| business_cda__v | Business (CDA) | Boolean | Indicates whether this represents a business address. | Address | Veeva | |
| billing_cda__v | Billing | Boolean | Indicates whether this represents a billing address. | Address |
Locally managed
(Non-calculated) |
|
| city_cda__v | City (CDA)
|
Text | Name of city or municipality. | HCP, HCO, Address | Veeva (Address) Customer (HCP/HCO) |
Yes (HCP/HCO only) Mapped legacy field: locality__v |
| country_cda__v | Country (CDA) |
Reference Type (AddressCountryCDA) |
Name of country. | HCP, HCO, Address | Veeva | |
| degree_1_cda__v | Medical Degree (CDA) | Reference Type (HCPMedicalDegreeCDA) | The primary medical qualification or degree obtained. | HCP | Veeva | |
| email_cda__v | Email (CDA) | Text | Primary email address. | HCP HCO |
Veeva Customer (US HCOs only) |
Yes (US HCOs only) Mapped legacy field: email_1__v |
| fax_cda__v | Fax (CDA) | Text | Primary fax. May include country code including non-alphanumeric characters. e.g. +, - | HCP, HCO, Address | Veeva | |
| first_name_cda__v | First Name (CDA) | Text | Given name as officially recorded in professional or legal documents. | HCP | Veeva | |
| hco_name_cda__v | Name (CDA) | Text | Official, legal name of the healthcare organization as registered with relevant regulatory or government authorities. | HCO | Veeva | |
| hco_type_cda__v | HCO Type (CDA) | Reference Type (HCOTypeCDA) | Category or classification of the healthcare organization. | HCO | Veeva | |
| hcp_type_cda__v | Type (CDA) | Reference Type (HCPTypeCDA) | 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. | HCP | Veeva | |
| home_cda__v | Home | Boolean | Indicates whether this represents a home address. | Address | Customer | |
| investigator_cda__v | Investigator | Boolean | Indicates whether the individual is involved in running clinical research studies. | HCP | Customer | |
| kol_cda__v | Key Opinion Leader | Boolean | Recognized as a key opinion leader in the industry. | HCP | Customer | |
| language_cda__v | Language (CDA) | Reference Type (LanguageCDA) | Primary spoken and written language. | HCP | Veeva | |
| last_name_cda__v | Last Name (CDA) | Text | Family or surname as officially recorded in professional or legal documents. | HCP | Veeva | |
| latitude_cda__v | Latitude (CDA) | Number | Geographic coordinate specifying north-south position. | Address | Veeva | |
| level_cda__v | Level | Reference Type (LevelCDA) | Indicates the level of importance of this individual to the company, level 5 indicates the highest. Can be used to drive business rules. For example: You may want to limit personalized promotions to levels 3 and below. You may require a single relationship owner for level 5. | HCP | Customer | |
| longitude_cda__v | Longitude (CDA) | Number | Geographic coordinate indicating east-west position. | Address | Veeva | |
| middle_name_cda__v | Middle Name (CDA) | Text | Secondary given name or initial as officially recorded in professional or legal documents. | HCP | Veeva | |
| mobile_phone_cda__v | Mobile Phone (CDA) | Text | Primary mobile phone number. May include country code including non-alphanumeric characters. e.g. +, - | HCP | Veeva | |
| nhid_cda__v | National Healthcare ID (CDA) | Text | Unique identifier assigned to healthcare professionals within a country's healthcare system. | HCP, HCO | Veeva | |
| office_phone_cda__v | Office Phone (CDA) | Text | Primary office phone number. May include country code including non-alphanumeric characters. e.g. +, - | HCP, HCO | Veeva | |
| phone_cda__v | Phone (CDA) | Text | Phone number. May include country code including non-alphanumeric characters. e.g. +, - | Address | Veeva | |
| postal_code_cda__v | Postal Code (CDA)
|
Text | Postal code from primary address. May include non-alphanumeric characters. e.g. - | HCP | Veeva (Address) Customer (HCP/HCO) |
Yes (HCP/HCO) Mapped legacy field: postal_code__v |
| prefix_cda__v | Prefix (CDA) | Text | Salutation or title used before a person's name, such as Mr., Mrs., Dr., etc. | HCP | Veeva | |
| prescriber_cda__v | Prescriber (CDA) | Boolean | Indicates whether the individual is authorized to prescribe medications. | HCP | Veeva | |
| primary_cda__v | Primary (CDA) | Boolean | Indicates whether this represents the individual's primary address. Only one address can be marked as Primary. | Address | Customer | |
| sample_shipping_cda__v | Sample Shipping | Boolean | Indicates whether this represents a shipping address that can accept medical shipments. | Address | Customer | |
| shipping_cda__v | Shipping | Boolean | Indicates whether this represents a shipping address. | Address | Customer | |
| speaker_cda__v | Speaker | Boolean | Indicates whether the individual is engaged in speaking roles at professional gatherings or educational events for the company. | HCP | Customer | |
| spec_1_cda__v | Specialty (CDA) | Reference Type (HCPSpecialtyCDA) | The primary medical field or expertise area to which the healthcare professional belongs. Uses the list of specialties. | HCP | Veeva | |
| spec_group_1_cda__v | Specialty Group (CDA) | Reference Type (HCPSpecialtyGroupCDA) | The primary overarching medical field or expertise area to which the healthcare provider belongs. Uses the list of global specialties. | HCP | Veeva | |
| state_cda__v | State (CDA)
|
Reference Type (AddressStateCDA) | Name of state, province, or regional area. | HCP, HCO, Address | Veeva (Address) Customer (HCP/HCO) |
Yes (HCP/HCO) Mapped legacy field: administrative_area__v |
| status_cda__v | Status (CDA) | Reference Type (StatusCDA) | Indicates whether this object is currently usable for contact purposes. | HCP, HCO, Address | Veeva | |
| street_address_1_cda__v | Street Address 1 (CDA) | Text | Residential or business street address information including house number and street name. | Address | Veeva | |
| street_address_2_cda__v | Street Address 2 (CDA) | Text | Additional address details, such as apartment, suite, or building number. | Address | Veeva | |
| study_site_cda__v | Study Site | Boolean | Indicates whether this organization is a site for clinical studies. | HCO | Customer | |
| suffix__cda__v | Suffix (CDA) | Text | Includes professional credentials or generational titles such as I, II, III, IV, but excludes medical degrees. | HCP | Veeva | |
| target_cda__v | Target | Boolean | Indicates whether the individual or organization is a target for one or more brands of the company. | HCP, HCO | Customer | |
| veevaid__v | Veeva ID | Text | Global identifier from Veeva data products. |
HCP, HCO | Veeva | |
| website_cda__v | Website (CDA) | Text | Official website URL for reference and contact purposes. | HCO | Veeva | |
| year_of_birth_cda__v | Year of Birth (CDA) | Number | Birth year of the HCP. | HCP | Customer |
Field details
See the Managing CDA fields topic for the following information:
-
Populating OpenData and locally managed fields.
-
OpenData CDA field calculations for each country and reference mappings
-
Network CDA Data Dictionary
Veeva ID field
The Veeva ID (veevaid__v) is an identifier that is used across Veeva data products. The ID field is the exception to the _cda__v naming convention.
The field is enabled by default in all Network instances, even if the CDA data model is not enabled.
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.
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.
Reference types for CDA fields
Several of the CDA fields are reference type fields that have CDA reference types (picklists).
Picklists that are restricted are read-only; custom codes cannot be added to the reference type.
| Reference Type | Field | Object | Restricted? |
|---|---|---|---|
| AddressCountryCDA | country_cda__v | HCP, HCO, Address | Yes |
| AddressStateCDA | state_cda__v | HCP, HCO, Address | Yes |
| AdopterTypeCDA | adopter_type_cda__v | HCP | Yes |
| AgeRangeCDA | age_range_cda__v | HCP | Yes |
| HCOTypeCDA | hco_type_cda__v | HCO | No |
| HCPMedicalDegreeCDA | degree_1_cda__v | HCP | No |
| HCPSpecialtyCDA | all_spec_cda__v | HCP | Yes |
| HCPSpecialtyGroupCDA | all_spec_group_cda__v | HCP | Yes |
| HCPTypeCDA | hcp_type_cda__v | HCP | No |
| LanguageCDA | language_cda__v | HCP | Yes |
| LevelCDA | level_cda__v | HCP | Yes |
| StatusCDA | status_cda__v | HCP, HCO, Address | Yes |
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.
Add custom codes
Picklists that are restricted are read-only; custom codes cannot be added to the reference type.
You can add custom codes to reference types that are not restricted. For details, see Adding reference codes to a reference type.