API

Version Update

The Network API is updated to v22.0.

As with all version updates, integration users should continue to use v21.0 until there is a change for v22.0 that they want to apply.

For more information about the Network API, see the Veeva Network API Reference at http://developer.veevanetwork.com.

Search filter exclusions

Integration users can now exclude records from search results using custom fields without excluding Veeva OpenData results. Previously, any filters used on custom fields automatically excluded OpenData-only records because those records do not have the custom field. You can use custom fields to identify the records that you want to exclude while still being able to search OpenData.

The exclusion filter supports the following:

  • Multiple values
  • Scoped entities
  • Field sets
  • Parent HCOs

NOT EQUAL

Use this exclusion filter to exclude objects from the search results if the object contains a certain value on a field. If Search against OpenData is enabled in the Network instance and the exclusion filter is on a custom field, OpenData records could be included in the results.

Example

Verteo uses a custom field top_institution__c to identify Top Institution Accounts. They want to exclude HCO records where top_institution__c = Y in Veeva CRM, because including them will cause an issue for roll-up reports. Verteo still wants reps to be able to search for other HCOs that do not have top_institution__c = Y (including OpenData records).

API call 

{{URL}}/api/v21.0/search?q=*&excludefilters=top_institution__c:Y

NOT IN

Integration users can use this filter to exclude records from the search results if the record contains a value from a set of values on a field.

If Search against OpenData is enabled in the Network instance and the exclusion filter is on a custom field, OpenData records could be included in the results.

Example

Verteo wants to exclude objects that have a primary pediatric specialty. OpenData has multiple specialty values for different types of pediatricians.

API call 

{{URL}}/api/v21.0/search?q=*&excludefilters=specialty_1__v:CPP,PMG,PPM,PDM,EMP,PD,PDN,CHC

Note: This example excludes the records that contain a value in the specialty_1__v field. To exclude records that contain the value in any of the specialty fields, see "Field sets" below.

Parent HCO

Parent HCOs can be excluded from the search results. The Parent HCO filters should filter the search results from the parent_hco__v section and the supplementalResults section.

Example

Verteo wants to exclude hospital departments in search results. The reference code for hospital departments is 4:1.

API call 

{{URL}}/api/v21.0/search?q=*&excludefilters=hco_type__v:4:1&parenthcoexcludefilters=hco_type__v:4:1

Field sets

Use exclusion filters to search an OR condition across field sets during search.

Supported field sets:

  • specialty (specialty_1__v to specialty_10__v)
  • credentials (credentials_1__v to credentials_5__v)
  • medical_degree (medical_degree_1__v to medical_degree_5__v)

Example

Verteo wants to exclude entities with a Pediatric specialty. OpenData has multiple specialty values for different types of Pediatricians.

This API call excludes records that has these values in any of the specialty fields (specialty_1__v to specialty_10__v)

API Call 

{{URL}}/api/v21.0/search?q=*&excludefilters=specialty:CPP,PMG,PPM,PDM,EMP,PD,PDN,CHC

Using with the parent HCO exclusion filter

You can also apply field sets to the parent hco filter.

API call 

{{URL}}/api/v21.0/search?q=*&excludeparenthcofilters=specialty:CPP,PMG,PPM,PDM,EMP,PD,PDN,CHC

Scoped objects

You can apply field sets to entity-scoped exclusion filters during search.

Example

Verteo wants to exclude HCPs with a pediatric specialty. OpenData has multiple specialty values for different types of pediatricians.

API call 

{{URL}}/api/v21.0/search?q=*&excludefilters=hcp.specialty:CPP,PMG,PPM,PDM,EMP,PD,PDN,CHC

Using multiple filters

Integration users can use multiple exclusion filters for search. The filters should be "AND" together.

Example API call 

{{URL}}/api/v21.0/search?q=*&excludefilters=hcp.specialty:CPP,PMG,PPM,PDM,EMP,PD,PDN,CHC&excludefilters=hcp.hcp_type__v:P

Example API call - multiple parent HCO exclusion filters

{{URL}}/api/v21.0/search?q=*&parenthcoexcludefilters=hco_type__v:4:1&parenthcoexcludefilters=is_veeva_master__v:Y

Search widget filters

The exclusion filter can be used on preset filters for the search widget.

Widget filter 

preset-exclude-filter="hcp.specialty_1__v=A"

You can also use exclusion parenthco filters on preset filters.

Widget filter with parent HCO filters 

phco-preset-exclude-filter="hco.hco_type__v=11:98,11:2&hco.hco_status__v=A"