Section:

HIPAAsuite.Deidentifier

Back to Projects
Class

Class Reference

68 Items

Type Description
Built-in generator that returns a synthetic street address line.
Detailed Remarks
Combines a numeric street number with a street name and suffix.
Usage Example
var address = new AddressLine1Generator().Generate(generator);

Type Description
Built-in generator that returns a city name.
Detailed Remarks
Registers a built-in generator used by de-identification rules to synthesize values. The generator is selected by its key in configuration or UI catalogs.
Usage Example
var city = new CityGenerator().Generate(generator);

Type Description
Built-in generator that returns a synthetic claim identifier (alphanumeric).
Detailed Remarks
Registers a built-in generator used by de-identification rules to synthesize values. The generator is selected by its key in configuration or UI catalogs.
Usage Example
var claimId = new ClaimIdGenerator().Generate(generator);

Type Description
Built-in value list of claim numbers (REF D9 / CLM).
Detailed Remarks
Provides a built-in sample list for synthetic replacements in de-identification. The values are non-sensitive and intended for testing or masking workflows.
Usage Example
var claim = new ClaimNumberList().Values[0];

Type Description
Built-in value list of synthetic communication numbers (digits only).
Detailed Remarks
Intended for PER and similar segments where numeric-only phone values are needed.
Usage Example
var value = new CommunicationNumberList().Values[0];

Type Description
Built-in value list of company suffixes.
Detailed Remarks
Used to build synthetic organization names.
Usage Example
var suffix = new CompanySuffixList().Values[0];

Type Description
Built-in value list of CPT/HCPCS procedure codes.
Detailed Remarks
Provides a built-in sample list for synthetic replacements in de-identification. The values are non-sensitive and intended for testing or masking workflows.
Usage Example
var code = new CptHcpcsCodeList().Values[0];

Type Description
Built-in generator that returns a CPT/HCPCS procedure code.
Detailed Remarks
Registers a built-in generator used by de-identification rules to synthesize values. The generator is selected by its key in configuration or UI catalogs.
Usage Example
var code = new CptHcpcsProcedureGenerator().Generate(generator);

Type Description
Built-in generator that returns a synthetic date formatted as yyyyMMdd.
Detailed Remarks
Dates are generated within a configurable range by RandomValueGenerator.
Usage Example
var date = new DateGenerator().Generate(generator);

Type Description
Built-in generator that returns an RD8 date range formatted as yyyyMMdd-yyyyMMdd.
Detailed Remarks
Registers a built-in generator used by de-identification rules to synthesize values. The generator is selected by its key in configuration or UI catalogs.
Usage Example
var rd8 = new DateRangeRd8Generator().Generate(generator);

Type Description
Provides access to the packaged default seed file and configuration.
Detailed Remarks
The default seed file ships with the application and can be used to bootstrap a JSON configuration for the de-identification pipeline. This helper is a convenience for CLI and UI tools that need to generate a baseline config without requiring users to hand-author rules.
Usage Example
var rules = DefaultSeedProvider.LoadDefaultRules();

Type Description
Discovers and exposes available de-identification value lists and generators.
Detailed Remarks
Discovery scans the current assembly for types annotated with DeidentifierValueListAttribute and DeidentifierGeneratorAttribute. Results are cached and exposed as read-only collections. Types must be concrete and constructable with a parameterless constructor to be discovered.
Usage Example
var lists = DeidentifierCatalog.ValueLists;
var generators = DeidentifierCatalog.Generators;

Type Description
Represents the root configuration for segment-level de-identification rules.
Detailed Remarks
This configuration is typically serialized to JSON and consumed by SegmentDeidentifier to drive replacement decisions for X12 segment elements. Rules are evaluated in the order they appear in Rules; when multiple rules target the same element, later rules overwrite earlier replacements. Keep this in mind when layering coarse and fine-grained rules.
Usage Example
var config = DeidentifierConfig.Load("deid.json");
var processor = new SegmentDeidentifier(config);
processor.ProcessInterchange(interchange);

Type Description
Marks a type as a discoverable de-identification generator.
Detailed Remarks
Generators annotated with this attribute are discovered by DeidentifierCatalog. Keys should be unique and stable because they are used in configuration files to reference generators by name.
Usage Example
[DeidentifierGenerator("name", "Name", "Generates a synthetic name.")]
public sealed class NameGenerator : IDeidentifierGenerator { }

Type Description
Marks a type as a discoverable de-identification value list.
Detailed Remarks
Value lists annotated with this attribute are discovered by DeidentifierCatalog. Keys should be unique and stable because they are used in configuration files and rule generators to reference the list.
Usage Example
[DeidentifierValueList("us.states", "US states", "State abbreviations.")]
public sealed class UsStateList : IDeidentifierValueList { }

Enum

Enum Reference

2 Items

Interface

Interface Reference

2 Items

Struct

Struct Reference

1 Items