How to monitor HCP/HCO Business Partners?

Overview

Use Case

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

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,

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

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

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

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

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:

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

Category

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

HCP name

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

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 app,

2. Click on Edit Data Mirror button,

3. Select the checkbox Tags managed by upsert,

4. click Save Settings button.

Tags will be added thanks to example mapping:

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

Value mappings

{
    "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,

3. Provide your dataSourceId and storageId,
4. Send the request.

Step 4: Create a configuration

The Business Partners monitoring required setting up a configuration.

1. Go to the Augmentation Configurator app,

2. Click on Create new configuration button,

3. Provide a name and select Create button,

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

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

7. 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 app,

2. Click on the Add New Data Monitor button,

3. Select Augmentation for Monitor Type,
4. Choose just created augmentation configuration,

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

Step 6: Read Updates

To read relation updates:

1. Go to the Business Partner Update Browser app,

2. In the Provenances fieldset:
   • CH_BETREG
   • CH_MEDREG

Step 7: Generate a Report

To generate reports:

1. Go to the Data Clinic app,

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

4. 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

5. Click Generate to create the report.
6. Wait until the job is finished and download it

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.

Your opinion matters!

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

Mail our developer-portal team: developer-portal@cdq.com