Code Set Management

What is Code Set Management?

Code Set Management enables consistent, governed use of standardized code sets data across systems and business domains. By standardizing permissible values and mappings, it improves data quality, reduces operational friction, and supports compliance requirements—ensuring data models and analytics can be trusted enterprise-wide.

Code Set Libraries

Code Set Libraries provide a centralized place to manage Code Sets and their values for use across attributes, domains, and entities. By organizing Code Sets into libraries, users can govern code set values consistently while enabling reuse and interoperability across the data model.

Through Code Set Libraries, users can create, view, edit, delete, and organize Code Sets and their associated values.

Code Set Library Types

Code Set Libraries are categorized into two types:

• Verato-defined Libraries – System-provided libraries that contain predefined Code Sets. These libraries and their Code Sets cannot be modified directly.
• Custom Libraries – User-managed libraries that support fully editable Custom Code Sets. Custom Code Sets can only exist within Custom libraries. Verato-defined libraries are limited to Verato-defined Code Sets and do not support custom values.

Accessing Code Set Libraries

From the Admin Console, users can navigate to Code Set Libraries via the Global Settings panel. This section provides access to all Code Set Libraries available within the account and serves as the primary workspace for managing Code Sets and their values.

Code Set Libraries Listing

The Code Set Libraries listing displays a paginated view of available libraries, showing up to 20 libraries per page. For each library, the following information is displayed:

• Library Name – The name of the Code Set Library, which acts as a container for related Code Sets.
• Number of Code Sets – The total number of Code Sets contained within the library.
• Type – Indicates whether the library is Verato-defined or Custom.
• Created By – The user who created the library, along with the date and time of creation.
• Last Updated – The user who last modified the library, along with the date and time of the update.

Code Set Library Actions

From the Libraries listing, users can perform the following actions on Code Set Libraries, depending on library type and permissions:

• Edit – Update library details.
• Delete – Remove a library and its associated Code Sets.
• Duplicate – Create a copy of an existing library for reuse or customization.

Duplicate a Code Set Library

The Duplicate action (two squares icon) allows users to reuse an existing Code Set Library by creating a new library based on it.

When duplicating a library:

• A new Code Set Library is created as a copy of the selected library.
• The duplicated library must be assigned a unique name.
• The duplicated library can then be modified independently of the original.

This action is commonly used to extend or customize existing libraries without altering the source library.

Delete a Code Set Library

The Delete action (trash icon) allows users to permanently remove an existing Custom Code Set Library.

Key considerations:

• Deletion is irreversible.
• Users must confirm the action by typing “Delete Library” before deletion is executed.
• Deleting a Code Set or an entire Code Set Library may impact attributes that reference them.

Important: Before deleting a Code Set or Code Set Library, users should assess any downstream dependencies to avoid unintended effects on associated attributes or domains.

Create a Custom Code Set Library

Users can create new Custom Code Set Libraries to define and manage Code Sets tailored to their organization’s requirements.

To create a new Code Set Library:

1. Click the + New Library button.
2. Enter a unique library name and click Add Library.
3. Add Code Sets to the library by either:
   • Clicking New Code Set to define values manually, or
   • Clicking Upload Code Set to upload Code Sets from a JSON or CSV file.
4. Define Code Set properties such as:
   • Code
   • Display Name
   • Definition
5. Click Save Code Set to complete the process.

Verato-defined Code Set Libraries are system-provided and cannot be created manually.

Enter a unique library name and click Add Library.

Adding Code Sets to the library

Defining code set values manually

Uploading code set values from JSON/CSV
 

 

Edit a Code Set Library

The Edit action (pencil icon) allows users to modify Custom Code Set Libraries.

• Verato-defined Code Set Libraries cannot be edited directly.
• To modify a Verato-defined library, users must duplicate it as a Custom library and make changes to the duplicated version.

Users can also click on the name of a Code Set Library to view detailed information about its Code Sets, including their values and metadata.

Code Set Library Details

When a user selects a Code Set Library from the listing, they can view detailed information about the library and the Code Sets it contains.

At the library level, users can see general metadata such as:

• Library name
• Library type
• Last updated date and user

The primary focus of this view is the list of Code Sets contained within the library.

Code Sets in a Library

Each Code Set represents a collection of permissible values that can be associated with one or more attributes in the data model.

For each Code Set, the following information is displayed:

Code Set values read-only view

Viewing Code Set Values and Usage

By clicking a Code Set name, users can:

• View the Code Set’s values and properties.
• Review how the Code Set is associated with attributes across domains and entities.

This view provides visibility into both the content of the Code Set and its usage across the data model.

Code Set values edit mode
 

Verato-Defined vs. Custom Code Sets

Code Sets can be either Verato-defined or Custom.

• Verato-defined Code Sets – System-provided and maintained by Verato. These Code Sets are read-only and cannot be edited or deleted directly. To make changes, users must duplicate the Code Set, which creates a Custom version that can then be modified.
• Custom Code Sets – User-defined and fully manageable. Users can add, edit, or delete code values and update Code Set properties using the available Edit and Save actions.

The Duplicate and Download actions are available for both Verato-defined and Custom Code Sets. Code Set values can be downloaded in CSV or JSON format.

Duplicating a Code Set: Naming new code set and destination library selection

 

Once the user clicks duplicate on a Verato-defined Code Set:

• A new Code Set is created as a copy of the selected code set.
• The duplicated code set must be assigned a unique name and a destination library.
• The duplicated code set can then be modified independently of the original.

Working with Code Sets in Domain Configuration

In the Domain Configuration section, Code Sets link to attributes to define allowed values for code-based attributes. This ensures consistent code set values across domains and entities while centralizing their modification and management in the Code Set Libraries section.

This section describes how Code Sets are attached to and viewed within Attribute Settings.

Associating a Code Set with an Attribute

When configuring an attribute whose data type is Code Set, users can associate it with an existing Code Set.

To attach a Code Set:

1. Select the attribute in Domain Configuration.
2. Select the target Environment for the code set association.
3. Select a Code Set Library.
4. Select a Code Set from the selected library.

Once selected, the Code Set is immediately applied to the attribute.

Domain Configuration section

Attribute metadata page within Domain Configuration section

Attribute and Code set settings in Domain Configuration section

 

Viewing Code Set Values

After a Code Set is associated, a table displays the following information for reference:

• Code values
• Display names
• Descriptions (if available)

This table is read-only within Attribute Settings and is intended to provide visibility into the values permitted for the attribute.

Updating Code Sets Used by Attributes

Code Sets cannot be edited directly within Attribute Settings. Any changes to Code Set values or metadata are made through centralized Code Set management and are reflected immediately in Domain Configuration without requiring a page refresh.

Users can click the Open Code Set Library button to navigate from the Attribute Association flow within the Domain Configuration section to the Code Set Management section to perform updates.

Code Set metadata and values within Code Set management section

Code Set Updating – Edit Mode
 

Post-Identity Validation

When a record is posted through the postIdentity API, all attributes are validated against their configured data types and constraints.

For attributes configured with a Code Set data type, the submitted value must match one of the codes defined in the Code Set associated with that attribute. If the value does not match a valid code, or if the data type is incorrect, the request fails.

In such cases, the system returns a validation error indicating the attribute and value that are not recognized based on the attribute configuration and associated Code Set. This validation step ensures data consistency and prevents unsupported or invalid values from being persisted in the system.

Example JSON Request With Code-Set Attribute

"names": [
  {
    "use": "casual",
    "prefix": "Mr.",
    "first": "Andrew",
    "middle": "M",
    "last": "Peterson"
  }
]

Example Response When the Code-Set Value Is Not Valid

{
  "success": false,
  "message": "names[0]use: Value 'casual' is not a valid code set option. Valid code set options include: '[maiden, temp, usual, old, nickname, official, anonymous, preferred]'",
  "retryableError": false,
  "errors": [
    "names[0]use: Value 'casual' is not a valid code set option. Valid code set options include: '[maiden, temp, usual, old, nickname, official, anonymous, preferred]'"
  ]
}