Configuring Cleanse Rules

Cleanse rule configuration details are part of tenant configuration and these rules can be applied to any entity type.

Configuration details for entity cleansing are available in the cleanseConfig section of the entity configuration.

HCP Entity with cleanseConfig

{
  "URI": "configuration/entityTypes/HCP",
  "cleanseConfig": {
    "mappings": [
      {
        "URI": "configuration/entityTypes/HCP/cleanseConfig/mappings/Identifiers",
        "inputMapping": [
          {
            "attribute": "configuration/entityTypes/HCP/attributes/Identifiers/attributes/Type",
            "cleanseAttribute": "Identifiers.Type",
            "mandatory": true,
            "allValues": true
          },
          {
            "attribute": "configuration/entityTypes/HCP/attributes/Identifiers/attributes/ID",
            "cleanseAttribute": "Identifiers.ID",
            "mandatory": false,
            "allValues": true
          }
        ]
      }
    ],
    "infos": [
      {
        "URI": "configuration/entityTypes/Individual/cleanse/infos/default",
        "useInCleansing": true,
        "sequence": [
          {
            "chain": [
              {
                "cleanseFunction": "MECleanser",
                "mapping": {
                  "inputMappingRef": "configuration/entityTypes/HCP/cleanseConfig/mappings/Identifiers",
                  "outputMapping": [
                    {
                      "attribute": "configuration/entityTypes/HCP/attributes/ME",
                      "cleanseAttribute": "ME",
                      "mandatory": true
                    }
                  ]
                },
                "proceedOnSuccess": true,
                "proceedOnFailure": true
              },
              {
                "cleanseFunction": "NPICleanser",
                "mapping": {
                  "inputMappingRef": "configuration/entityTypes/HCP/cleanseConfig/mappings/Identifiers/inputMapping",
                  "outputMapping": [
                    {
                      "attribute": "configuration/entityTypes/HCP/attributes/NPI",
                      "cleanseAttribute": "NPI",
                      "mandatory": true
                    }
                  ]
                },
                "proceedOnSuccess": true,
                "proceedOnFailure": true
              }
            ]
          }
        ]
      }
    ]
  }
}