CDA data model fields
HCP and Address fields are currently supported for CDA. The naming convention for the fields contain the _cda__v
suffix. The ID field (veevaid__v
) is the exception to the naming convention.
Field ownership
Most of the new fields are managed by Veeva OpenData for OpenData records. The remaining fields are locally managed.
Field details
A list of the fields with high-level details is provided in the sections below.
Download the following files for more information about the fields:
Calculation of CDA Fields 24R2 August 9th 2024.xlsx
-
Field ownership
-
Field calculation rules for each country / region
Network CDA - Data dictionary 24R2 August 9th 2024.xlsx
-
Network > CDA language mappings
-
Network > CDA reference code mappings
CDA fields managed by OpenData
Veeva managed 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 | Primary Language (CDA) |
email_cda__v | Primary 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 | Primary Specialty (CDA) |
all_spec_cda__v | All Specialties (CDA) |
spec_group_1_cda__v | Primary Specialty Group (CDA) |
all_spec_group_cda__v | All Specialty Groups (CDA) |
prescriber_cda__v | Prescriber (CDA) |
degree_1_cda__v | Primary 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.
Receive data in CDA fields from OpenData
After you enable at least one CDA field in your Network instance, run a full OpenData country subscription to update all records that are downloaded in your Network instance.
To run a full update:
-
Open an OpenData country subscription (System Interfaces > OpenData Subscriptions).
-
In the Updates to OpenData records section, select Update all records.
-
Save your changes.
The next time the subscription runs, you will receive updates for all the OpenData managed CDA fields that you have enabled.
Locally managed CDA 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 |
---|---|---|---|
state_cda__v | State (CDA) | Yes | administrative_area__v |
city_cda__v | City (CDA) | Yes | locality__v |
postal_code_cda__v | Postal Code (CDA) | Yes | postal_code__v |
level_cda__v | Level | No | No mapping |
adopter_type_cda__v | Adopter Type | No | No mapping |
kol_cda__v | Key Opinion Leader | No | No mapping |
investigator_cda__v | Investigator | No | No mapping |
speaker_cda__v | Speaker | No | No mapping |
target_cda__v | Target | No | No mapping |
year_of_birth_cda__v | Year of Birth (CDA) | No | No mapping |
age_range_cda__v | Age Range (CDA) | No | No mapping |
Address fields
Field Name | Label | Calculated? | Mapped Legacy Field |
---|---|---|---|
home_cda__v | Home | No | No mapping |
billing_cda__v | Billing | No | No mapping |
shipping_cda__v | Shipping | No | No mapping |
sample_shipping_cda__v | Sample Shipping | No | No mapping |
primary_cda__v | Primary (CDA) | 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 fields
Some locally managed fields are calculated fields. This means that the field values are populated by the CDA Sync process in your Network instance.
- state_cda__v
- city_cda__v
- postal_code_cda__v
CDA Sync applies to locally managed records only.
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: CDA Sync must be enabled so calculated fields values can be populated.
Update fields
On locally managed records, calculated CDA fields are populated by the CDA Sync process.
The fields can be updated in the following ways:
-
Load data into the mapped legacy fields
The CDA Sync process will map the values to the calculated CDA fields.
Important: If calculated CDA fields are included in the import files, the data will be overwritten when CDA Sync runs.
For more details, see the CDA Sync section.
-
Submit data change requests on calculated CDA fields
The CDA Sync process will map the values to the legacy fields for Data Stewards to process.
For more details, see the CDA DCRs section.
Non-calculated fields
The local CDA fields that are not calculated are managed just like legacy fields.
-
level_cda__v
-
adopter_type_cda__v
-
kol_cda__v
-
investigator_cda__v
-
speaker_cda__v
-
target_cda__v
-
year_of_birth_cda__v
-
age_range_cda__v
-
home_cda__v
-
billing_cda__v
-
shipping_cda__v
-
sample_shipping_cda__v
-
primary_cda__v
Update fields
The fields can be updated in the following ways:
-
Submit data change requests on the non-calculated fields.
-
Load the data into your Network instance
Include non-calculated fields in the import files.
CDA picklists
Many of the CDA fields are reference type fields (picklists). New reference types have been added to Network to support the CDA fields.
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.