# How to monitor HCP/HCO Business Partners?

## Overview

**Use Case**

The CDQ Business Partner Monitoring now includes monitoring of healthcare Professionals (`HCP`) and Healthcare Organizations (`HCO`).
It allows you to monitor your Business Partners against the `MEDREG` and `BETREG` data sources. The monitoring is based on linking your
Business Partners with the data from these sources. The monitoring is handy for companies in the healthcare sector, where it is
crucial to have up-to-date information about healthcare professionals and organizations. The monitoring helps you keep your Business Partner's
data up-to-date and comply with regulatory requirements.

**Learning Goals**

In this tutorial, the user will be focused on:

- Activating data sources that can be searched
- Applying required mapping changes
- Creating a configuration for the Monitoring
- Creating Augmentation Monitor
- Checking results in the Update Browser
- Generating HCP HCO Monitoring Report


## Prerequisites

**Login**

Log into the CDQ [Cloud Apps](https://apps.cdq.com)

Authorization
If you cannot access the CDQ Cloud App, ask your internal point of contact to create a CDQ dedicated account.
Account details will be sent by email.

## Step 1: Activate a Data Sources

CDQ is connected to various data sources, from business and tax registers to commercial data providers such as D&B or Moody‘s. Data sources
require explicit activation before they can be used in CDQ products, such as for monitoring the Business Partner. This is needed once for the
complete organization. Activated data sources are then usable in any workspace.

For activating data sources:

1. Navigate to the [Global Settings](https://apps.cdq.com/dashboard/global-settings),


![](/assets/hcp-img001.d05b11ad89d80a3842e4167196b1a81cecccd34509b4626fe397188717c67227.8a043c72.png)

1. Scroll down to the Reference Data Source Management section,
2. Filter by country `CH` or find by name: `CH_MEDREG` and `CH_BETREG`,
3. Open the settings for the data source,


![](/assets/hcp-img002.e63ea41840a097d3564dc82da79f50d382f95fc6eeaf3e5290731980e014a909.8a043c72.png)

1. Use the Status toggle to "Activate" the data source.


![](/assets/hcp-img003.47369db48714b386134928cb98647147bfbba4596018501bf4c45ac28505396b.8a043c72.png)

Data sources are subject to quotas. Unlimited usage is not possible. There is a quota on the organization level, which can be either controlled
by CDQ or by your organization itself (in case of authenticating with your own credentials, e.g., D&B). Additionally, quotas can be assigned to
each individual workspace. This allows for safeguarding the usage of data sources and prevents costly unintended downloads of data from commercial
providers such as D&B.

## Step 2: Prepare a mapping

To get updates from `MEDREG` and `BETREG` data sources, it's required to have the following concepts of Business Partners to make a linkage:

* **MEDREG**: `GS1_GLN` identifier, `HEALTHCARE_PROFESSIONAL` category + post code
* **BETREG**: `GS1_GLN` identifier, `HEALTHCARE_ORGANIZATION` category


Mapping Required
Create a mapping for the data source using a [Create Data Mapper Definition](https://developer.cdq.com/reference-docs/data-exchange/V5/tag/Data-Mapping/paths/~1datamapperdefinitions/post/) endpoint or request a CSM support.

Based on the mapping provided, the system will be able to link Business Partners from the mirror with the data from MEDREG and BETREG data sources.

### GS1_GLN identifier

Map the identifier to the Global Location Number with the following example:


```json
{
      "sourceAttributes": [
         "GLN"
      ],
      "targetAttributes": [
         "businessPartner.identifiers"
      ],
      "targetAttributeTypes": [
         "GS1_GLN"
      ]
}
```

### Category

Map the category to the Business Partner categories directly via `targetAttributeTypes` and `valueMapping`:


```json
{
      "sourceAttributes": [
         "Category"
      ],
      "targetAttributes": [
         "businessPartner.categories"
      ]
}
```

### HCP name

The name from the `MEDREG` data source is mapped as a name of type "`HEALTHCARE_PROFESSIONAL`", so for comparison purposes, it's
necessary to map our HCP BP name to this type.


```json
{
      "sourceAttributes": [
         "Name"
      ],
      "targetAttributes": [
         "businessPartner.names[0].value"
      ],
      "targetAttributeTypes": [
         "HEALTHCARE_PROFESSIONAL"
      ]
}
```

`BETREG` returns names in the `LOCAL` and `OTHER` types, so changing mapping is usually unnecessary.

### Marked for deletion

An HCP HCO Monitoring report provides a new option to mark Business Partners for deletion. You can use tags to show this option.
Make sure your Data Mirror has tags upserting enabled.

To mark for deletion:

1. Go to [Data Mirror Management](https://apps.cdq.com/dashboard/management) app,


![](/assets/hcp-img0010.a8a7a5ba4edfade62d92ce84655f9eb3e629e9f9a618f443bd83cd920b38bfa4.8a043c72.png)

1. Click on **Edit Data Mirror** button,


![](/assets/hcp-img004.070b38e090622579cb09074bb90eebc08587f25665b8e2672c98fd5d21eddf99.8a043c72.png)

1. Select the checkbox **Tags managed by upsert**,


![](/assets/hcp-img005.851586f0b33fd98734b1e2e3754560e807f942e99b194707a185ff2f178568d1.8a043c72.png)

1. click **Save Settings** button.


Tags will be added thanks to example mapping:


```json
{
      "sourceAttributes": [
         "Delete"
      ],
      "targetAttributes": [
         "businessPartner.profile.tags[0].value"
      ],
      "targetAttributeTypes": [
         "MARKED_FOR_DELETION"
      ]
}
```

### Value mappings

In some cases, to map correctly Business Partners, it's required to provide `valueMappings` as in the below examples:


```json
{
    "valueMappings": [
        {
            "sourceValue": "HP",
            "targetValue": "HEALTHCARE_PROFESSIONAL",
            "targetAttribute": "businessPartner.categories"
        },
        {
            "sourceValue": "HO",
            "targetValue": "HEALTHCARE_ORGANISATION",
            "targetAttribute": "businessPartner.categories"
        },
        {
            "sourceValue": "X",
            "targetValue": "True",
            "targetAttribute": "businessPartner.profile.tags[0].value"
        }
    ],
}
```

# Step 3: Transform Data

The transformation is not needed for new data sources if a mapping containing the required elements is provided before Business Partners upload it.

If we change the mapping ID for the data source with HCP, HCO Business Partner apps will transform records automatically. Still, if we change elements in already assigned mapping, we must transform our BPs to have the required linkage elements. To do that, use the following CURL:

1. Use the **Start Transformation Job** endpoint,
2. Use the **Transform HCP/HCO Business Partners** example,


Use default if there is no example to choose.

1. Provide your `dataSourceId` and `storageId`,
2. Send the request.


# Step 4: Create a configuration

The Business Partners monitoring required setting up a configuration.

1. Go to the [Augmentation Configurator](https://apps.cdq.com/dashboard/augmentation-configurator) app,


![](/assets/hcp-img006.c7bd546bceb6b833c7604eacdd372f24bccab1db946f44cfc8eb8c8d33c7f402.8a043c72.png)

Skip points 2 and 3 if you have already created a configuration for the monitoring.

1. Click on **Create new configuration** button,


![](/assets/hcp-img007.8d43e48c9ea8c5930be4e615622975b9b5d4f27c9bd3ba49e2a3018167df7b29.8a043c72.png)

1. Provide a name and select **Create** button,


![](/assets/hcp-img008.7daaced6624c359c30bf6553b966ffdde5943fd659d20bf62dc49e7a84d47f8a.8a043c72.png)

1. Find the configuration in the list and click on **See details** button,


![](/assets/hcp-img0011.f03549d394e4be64cd020fdb0e8ccd61f03142075d525e8c446e0628dbfb87c7.8a043c72.png)

1. In the **Data Source Settings** tab look for the **Activate Reference Data Sources** section,
2. Provide CH for country filtration and select `CH.BETREG` and `CH.MEDREG` for update monitoring,


![](/assets/hcp-img009.88704052e3671461bb66eb05a6415ba029e78b732f38ecabefebd675a951b2f4.8a043c72.png)

1. Click the **Save configuration** button.


# Step 5: Augmentation monitor

Create an Augmentation Monitor and activate it using the previously created configuration.

1. Go to the [Data Clinic](https://apps.cdq.com/dashboard/data-clinic) app,


![](/assets/hcp-img0012.765dde8de6d918522efde85ad3cbf2e42d9098fccb015bb0259e7a4aca58ec26.8a043c72.png)

1. Click on the **Add New Data Monitor** button,


![](/assets/hcp-img0013.908782ccef1f5c9dedef8bc3fa0e7459e90f92dd3e36641a6d66fc8add0d6154.8a043c72.png)

1. Select Augmentation for Monitor Type,
2. Choose just created augmentation configuration,


![](/assets/hcp-img0014.44632e47b24da33cadde743b97fbeea29ae2ee47d1cda5f4655150cc19f3b7ef.8a043c72.png)

1. Click the „Create New Data Monitor” button,
2. Wait until the job for the new monitor is finished,


![](/assets/hcp-img0015.e1af34f513eddd604e3b3844fbdb7654b509fb7f4c1b0062dafb3856a6228c8c.8a043c72.png)

# Step 6: Read Updates

To read relation updates:

1. Go to the [Business Partner Update Browser](https://apps.cdq.com/dashboard/business-partner-update-browser) app,


![](/assets/hcp-img0019.0e271f54fab8d0e921c44d5aa3792c1041d89d92137a3074cab0dfd3eafc6ce9.8a043c72.png)

1. In the Provenances fieldset:
  - `CH_BETREG`
  - `CH_MEDREG`


![](/assets/hcp-img0020.6f29102c838e4fafb34403eccc5b4634071418d5f66d47b5ecbcb136fa96c145.8a043c72.png)

`MEDREG` has specific rules dedicated to classification, which can be adjusted for your needs in the Augmentation Configuration.

# Step 7: Generate a Report

To generate reports:

1. Go to the [Data Clinic](https://apps.cdq.com/dashboard/data-clinic) app,


![](/assets/hcp-img0012.765dde8de6d918522efde85ad3cbf2e42d9098fccb015bb0259e7a4aca58ec26.8a043c72.png)

1. Select the **Reports** tab,
2. Click on the **Generate new report** button,


![](/assets/hcp-img0016.5255dc73ab98421b5628472025abc91e1651d39b073d55dfb84e73ab5a7a329f.8a043c72.png)

1. Configure the report:
   - Provide Report Title,
   - Select `HCP HCO Monitoring Report` as the report type,
   - Select data sources from your mirror,
   - Select `CH - Switzerland` as a country,
   - Select the checkbox `Include Records With No Insights`,
   - Provide a date range for the report - Created At,
   - Select what type of updates you would like to see in this report - Summary Classification - `MAJOR`, `CRITICAL`


![](/assets/hcp-img0017.8953aaf3bac724242c6888186494a8e97d68400bff6c9cee0850457eb7045568.8a043c72.png)

1. Click **Generate** to create the report.
2. Wait until the job is finished and download it


![](/assets/hcp-img0018.17eb0151e4f5f2110f749b2208ec1f6a7699003e20ed69d8be7a4675942da290.8a043c72.png)

### Report details

The report is divided into 3 parts:

1. Business Partner - Shows basic information of Business Partners from the mirror as externalId, name, address, GLN, or if this BP is marked for deletion (required mapped tags),
2. Linkage information - thanks to "Include Records With No Insights," you will see all Business Partners with specific categories that tried to link with the reference data source. In case of success, you will see "d" Linkage details can also provide detailed information on the reason for the lack of linkage,
3. Updates—Based on Summary Classification, we provide only those concepts for which classification was, for example, `MAJOR` or `CRITICAL`. If we don't provide any classification filtration, all updates for specific data ranges will be returned.


Email Notification
You can get an automatically generated HCP HCO Monitoring Report. It's sent only when we detect any linkage attempts or new updates available for your Business Partner. To enable such monitoring, please contact your CSM.

## Your opinion matters!

We are constantly working on providing an outstanding user experience with our products. Please share your opinion about this tutorial!