Identifiers

This filter identifies custom text based on a given regular expression.

Required Parameters

Parameter Description Default Value
pattern A regular expression for the identifier. \b[A-Z0-9_-]{4,}\b

Optional Parameters

Parameter Description Default Value
identifierFilterStrategies A list of filter strategies.
enabled When set to false, the filter will be disabled and not applied. true
ignored A list of terms to be ignored by the filter.
classification Used to apply an arbitrary label to the identifier, such as “patient-id”, or “account-number.” “custom-identifier”
caseSensitive When set to true, the regular expression will be case sensitive. true

Filter Strategies

The filter may have zero or more filter strategies. When no filter strategy is given the default strategy of REDACT is used. When multiple filter strategies are given the filter strategies will be applied in as they are listed. See for details.

Strategy Description
REDACT Replace the sensitive text with a placeholder.
RANDOM_REPLACE Replace the sensitive text with a similar, random value.
STATIC_REPLACE Replace the sensitive text with a given value.
CRYPTO_REPLACE Replace the sensitive text with its encrypted value.
HASH_SHA256_REPLACE Replace the sensitive text with its SHA256 hash value.

Conditions

Conditional Description Operators
TOKEN Compares the value of the sensitive text. ==, !=
CONTEXT Compares the value of the filtering context. ==, !=
CONFIDENCE Compares the value of the confidence of the sensitive text against a threshold value. <, <=, >, >=, ==, !=

Example Filter Profile

Below is a sample filter profile illustrating usage of this filter.

{
   "name": "identifier-example",
   "identifiers": {
      "identifier": {
         "caseSensitive": false,
         "classification": "my-custom-type",
         "pattern": "[A-Z]{9}",
         "sectionFilterStrategies": [
            {
               "strategy": "REDACT",
               "redactionFormat": "{{{REDACTED-%t}}}"
            }
         ]
      }
}