Data model field tags

Network supports multiple data model schemas including OpenData 1.0, OpenData 2.0, CDA, IQVIA OneKey, and custom. Administrators and Data Managers can easily identify the fields associated to each schema. A tag displays for each field on an object configuration to identify the data model, ownership, and management of the field.

Uses

Use the tags to understand the differences between fields that seem similar. For example, the hcp_status_reason__v and hcp_reason_status__v fields
OpenData 2.0 contains a subset of OpenData 1.0 fields. The fields that are not included in OpenData 2.0 will become locally managed in the future. The tags identify those fields so you can understand the impact to your business.
Export the fields to get a data model report of the OpenData - Transition and OpenData - Legacy fields.
Quickly filter CDA or OpenData 2.0 fields so that you can enable the list of fields selectively.

Available tags

The following tags can display. Multiple tags can be applied to each field.

Tag Label	Definition	Example
CDA	Fields in the Common Data Architecture data model. All fields with the `_cda__v` suffix and the `veevaid__v` field.	hcp_type_cda__v, city_cda__v
Custom	Fields that are completely managed by customers; all `__c` fields and some `__v` fields. The tag is applied to all new custom fields.	primary_neurology__c, city_cda__v
IQVIA OneKey	IQVIA OneKey ID fields and fields defined in the DCR Routing Criteria section on the IQVIA third-party system configuration.	onekey_id__v
OpenData 1.0	Non-system OpenData fields that were released before version 26R1.	hcp_type__v
OpenData 2.0	All fields in the OpenData 2.0 data model.	hcp_type_local__v
OpenData Legacy	Fields identified by Veeva OpenData that will become locally managed in version 27R1.0.	language__v
OpenData Transition	Fields identified by Veeva OpenData that will become locally managed in 2033.	phone_1__v, healthcare_provider_id__v
Network	Fields used for specific Network MDM features.	candidate_record__v, key_hco_network_alias__v
System	Fields that are managed and updated by Network MDM. System fields are read-only.	created_date__v, is_veeva_mastered__v
System - OpenData	System-like fields delivered to customers from Veeva OpenData. System fields are read-only.	data_privacy_opt_out__v

Object considerations

Field tags can vary for the same field depending on its associated object.

To view these specific tags, click a field to open its configuration. The Data Model Schema section lists each associated object and its tags.

Example - Phone 2 field

The phone_2__v field for HCPs is included in the OpenData 2.0 data model. For HCO, Address, and ParentHCO objects, it is an OpenData Transition field and will become locally managed in 2033.

Country considerations

OpenData Legacy and OpenData Transition tags do not display for Network MDM instances in China.

Filter fields on schema

By default, all data model schema display for fields on an object configuration. To filter the list for a specific filter, choose the tag in the list.

The filter condition is OR, so all selected tags display.

Data model export

Field tags are included in the data model export.

A Tags column now displays the data model schema for each field.

Retrieve Fields Metadata API

When the details parameter is used with the full value, the response includes the tagIds fields. It lists the tags for each object associated to the field.

Sample request

https://my.veevanetwork.com/api/v38.0/metadata/fields?details=full

Sample response

{
  "fieldId": "record_state__v",
  "type": {...},
  "labels": {...},
  ...
  "primary": false,
  "tagIds": {
    "ADDRESS": [
      "system_vod",
      "system",
      "iqvia_ok"
    ],
    "HCO": [
      "system_vod",
      "system",
      "iqvia_ok"
    ],
    "HCP": [
      "system_vod",
      "system",
      "iqvia_ok"
    ],
    ...
  }
},

Retrieve fieldTags API

Integration users can use this API to return the list of active tags available for data model fields.

Sample request

GET https://my.veevanetwork.com/api/v38.0/metadata/fieldTags

Sample response

{
  "fieldTags": [
    {
      "id": "cda",
      "color": "orange",
      "labels": {
        "en": "CDA"
      }
    },
    {
      "id": "custom",
      "color": "grey",
      "labels": {
        "en": "Custom"
      }
    },
    ...
  ]
}