Key network enhancements

The following updates were made for key networks/IDNs in this release.

All enhancements are enabled by default in your Network instance.

Network API support

The Network API now supports the following actions for key networks:

• Retrieve a list of key networks

• Display key networks in Search/Retrieve APIs

KeyNetworks API call

Use the keyNetworks API to retrieve key networks/IDNs in your Network instance.

This API is available in version v35.0 and later.

Endpoint URL

https://{DNS}/api/version/keyNetworks

where

• DNS is the URL for your API service

• version is the API version. Supported for v35.0 only.

• keyNetworks are the top-level HCO entities that are flagged as key networks/IDNs to retrieve

This API call will retrieve all key networks

Parameters

• country (optional) - Use to filter the key networks by country.

  Countries are listed by reference code in a comma (,) separated list.

Example

https://verteo.veevanetwork.com/api/v35.0/keyNetworks?countries=CA,US,MX

Sample response

{
  "status": "SUCCESS",
  "total": 4,
  "keyNetworks": [
    {
      "vid__v": "242976932788962304",
      "alias": "@ArChildrens",
      "name": "Arkansas Childrens Hospital",
      "hco_type__v": "4:35",
      "record_owner_type__v": "VOD",
      "primary_country__v": "US"
    },
    {
      "vid__v": "242976927730631680",
      "alias": "@MayoClinic",
      "name": "Mayo Clinic",
      "hco_type__v": "4:37",
      "record_owner_type__v": "VOD",
      "primary_country__v": "US"
    },
    {
      "vid__v": "242976930339488769",
      "alias": "@SaintJude",
      "name": "Saint Jude Childrens Research Hospital",
      "hco_type__v": "4:6",
      "record_owner_type__v": "VOD",
      "primary_country__v": "US"
    },
    {
      "vid__v": "242976930616312832",
      "alias": "@Sanford",
      "name": "Sanford Health",
      "hco_type__v": "4:37",
      "record_owner_type__v": "VOD",
      "primary_country__v": "US"
    }
  ]
}

The key networks are sorted alphabetically (ascending) by alias.

Key network details

• VID - The HCO's unique ID.

• Alias - The HCO's key network alias. For example, @MayoClinic.

• Name - The corporate name of the HCO.

• HCO Type - The reference code for the HCO type, for example, 4:37.

• Record owner - The reference code for the record owner type: VOD (Veeva OpenData), LOCAL (locally managed), TPP (third party data provider).

• Primary country - The reference code for the country.

  Note: OpenData provides a list of key networks for the United Kingdom (UK) and the United States (US).

Permissions

The key networks display if you have access to HCOs for that country through your data visibility profile.

Display key networks in Search/Retrieve APIs

Users can now see key networks for entities returned in the Search and Retrieve APIs.

New parameter

• returnKeyNetworks

The parameter is applied to entities and supplemental entities.

Example

https://my.veevanetwork.com/api/v35.0/hco/Network:Entity:932671707694238303?returnKeyNetworks=true

Sample response

A keyNetworks section is returned for each HCP and HCO in the response.

The key networks are sorted alphabetically by alias.

"keyNetworks": [
       {
          "vid__v": "242976927730631680",
          "alias": "@MayoClinic",
          "name": "Mayo Clinic",
          "hco_type__v": "4:37",
          "record_owner_type__v": "VOD",
          "primary_country__v": "US"
        },
        {
          "vid__v": "242976930339488769",
          "alias": "@SaintJude",
          "name": "Saint Jude Childrens Research Hospital",
          "hco_type__v": "4:6",
          "record_owner_type__v": "VOD",
          "primary_country__v": "US"
        }
      ]

Key network details

• VID - The HCO's unique ID.

• Alias - The HCO's key network alias. For example, @MayoClinic.

• Name - The corporate name of the HCO.

• HCO Type - The reference code for the HCO type, for example, 4:37.

• Record owner - The reference code for the record owner type: VOD (Veeva OpenData), LOCAL (locally managed), TPP (third party data provider).

• Primary country - The reference code for the country.

Key networks on downloaded records

When you download a record from OpenData, the key network/IDN affiliation tags are now immediately displayed on the record in your Network instance.

Previously, the key network information displayed in the search results but it did not display on the downloaded record until the key networks were refreshed by the daily data maintenance job.

Note: This is also supported for records downloaded in Vault CRM.

Supported download actions

The key network is included when records are downloaded from Veeva OpenData using ad hoc download jobs:

• Ad Hoc Download (available on the Veeva OpenData subscription page)

• Download from OpenData (using the Download icon on the search results or profile page)

• Sync with OpenData (available on the search results).