Data Dictionary Content Template Definition

Data Asset Level

On this level, the User must provide metadata for the Data Asset. It may be a database, database partition, a group of
database tables or views, collection of data files, S3 bucket(s), data exchange process or any other collection of data the
User wants to treat as a data asset.

This level is very generic as all elements are optional, and usually contains just one record.
Entity Level
Entity level is separated to Logical (Entity) and Physical (Table) layers. Logical or business layer contains properties that
belong to business abstraction (entity name and definition, business requirement and security category). The physical
layer contains properties that belong to a physical implementation of a business concept (table names and descriptions,
system of records, etc.)
Attribute Level
Attribute level is also separated to Logical (Attribute) and Physical (Column) layers. The logical layer on the Attribute level
also contains properties that belong to business abstraction (attribute name and definition, valid values and validation
rules, sensitive/PII information, etc.). The physical layer on the Column level contains properties that belong to a physical
implementation of the attributes(column names and descriptions, data types and field length, field nullability/optionality,
primary/foreign key information, etc.).

Depending upon the needs of the organization and project evolution, some project-specific and technical-related
properties may be added to this layer, such as indexes, alternative or unique keys, XML or JSON calls, etc.
Value Level
Value Domain or Look-up level is the lowest level of the data dictionary. It contains a pre-defined collection of values for all
affected fields and their numeric or text codes. On the physical level it should be implemented as a collection of look-up
tables or some master look-up tables/metadata repositories.

The Value Domain level is an optional element in the data dictionary. The organization should assess their needs and
project requirements to determine the suitability of including the value domain layer within their data dictionary.
 CMS Enterprise Architecture
Data Dictionary Template
Last Update: 01/28/2024

Data Component Name Description Type Required Sample

Data Asset Level Data Asset Tab of the DD
Data Asset Name Data asset name Logical Required COVID_PRIMARY_DATASET
Data Asset Description Data asset description Logical Required Collection of data for COVID 19 cases and vaccination
Data Asset Type Data asset type (database, text file, S3 bucket, etc.) Logical Optional Oracle database
Data Asset Version Data asset version Logical Optional 1.2
Created Date Data asset creation date Logical Optional 03/19/2007
Last Update Date Data asset last update date Logical Optional 02/28/2021

Entity Level Entity Tab of the DD

Entity Name Logical Entity Name Logical Required COVID-19 Vaccine Details
Entity Definition Logical Entity Definition Logical Required Entity to store COVID-19 vaccine details
Table Name Physical Table Name Physical Optional CME_COVID_VCCN_DTLS
Table Description Physical Table Description Physical Optional Table to store COVID-19 vaccine details
Entity Requirement ID Entity Requirement ID Logical Optional IDDOC-10830
Entity Security Category Entity Security Category Description Logical Optional CONFIDENTIALITY=LOW; INTEGRITY=MEDIUM; AVAILABILITY=HIGH
System of Records System of Records Physical Optional COVID_PRIMARY_DATASET

Attribute Level Attribute Tab of the DD

Entity Name Logical Entity Name Logical Required COVID-19 Vaccine Details
Attribute Name Logical Attribute Name Logical Required Sex Code
Attribute Definition Logical Attribute Definition Logical Required COVID Vaccine Receiver Sex Code
Table Name Physical Table Name Physical Optional CME_COVID_VCCN_DTLS
Column Name Physical Column Name Physical Optional SEX_CD
Column Description Physical Column Description Physical Optional COVID Vaccine Receiver Sex Code
Data Type Physical Column Data Type/Length Physical Optional CHAR(1)
Null Option Column Null Option Physical Optional Not Null/Null
Is Primary Key Column Primary Key Indicator Physical Optional Yes/No
Is Foreign Key Column Foreign Key Indicator Physical Optional Yes/No
Foreign Key Table Foreign Key Table Physical Optional CME_SEX_LKUP
Foreign Key Column Foreign Key Column Physical Optional SEX_CD
Is PII Column PII Indicator Logical Optional No
Validation Column Valid Values or Validation Rule Logical Optional M-Male, F-Female

Value Level Value Domain Tab of the DD

Group Name Business rule, value group or lookup table name Physical Optional CME_SEX_CD
Group Type Group type (business rule/lookup table/list of valid values) Physical Optional Valid Values
Group Description Value group description or list of values Physical Optional M-Male, F-Female

Page 2 of 8 723035509.xlsx
 CMS Enterprise Architecture
Data Dictionary Template
Last Update: 01/28/2024

Value Code/numeric value of a field Physical Optional M

Description Value description Physical Optional Male

Page 3 of 8 723035509.xlsx
 CMS Enterprise Architecture
Data Dictionary Template
Last Update: 01/28/2024

Data Asset Name Data Asset Data Asset Type Data Asset Version Created Date Last Update Date
COVID_PRIMARY_DATASET Description
Oracle database Collection of data for COVID 19 cases and vaccination 1.2 03/19/2007 02/28/2021

Page 4 of 8 723035509.xlsx
 CMS Enterprise Architecture
Data Dictionary Template
Last Update: 01/28/2024

Entity Name Entity Definition Table Name Table Description Entity Requirement ID Entity Security Category System of Records

COVID-19 Vaccine Details Entity to store COVID-19 CME_COVID_VCCN_DTLS Table to store COVID-19 IDDOC-10830 CONFIDENTIALITY=LOW; COVID_PRIMARY_DATASET
vaccine details vaccine details INTEGRITY=MEDIUM;
AVAILABILITY=HIGH

Page 5 of 8 723035509.xlsx
 CMS Enterprise Architecture
Data Dictionary Template
Last Update: 01/28/2024

Entity Name Attribute Attribute Table Name Column Column Data Type Null Is Primary Is Foreign Foreign Key Foreign Key Is Physical Is PII Data Source Validation
Name Definition Name Description Option Key Key Table Column Only

COVID-19 Vaccine Sex Code COVID Vaccine CME_COVID_VCCN_DTLS SEX_CD COVID Vaccine CHAR(1) Not Null No Yes CME_SEX_LKUP SEX_CD No No COVID_PRIMARY_ M-Male,
Details Receiver Sex Receiver Sex DATASET F-Female
Code Code

Page 6 of 8 723035509.xlsx
 CMS Enterprise Architecture
Data Dictionary Template
Last Update: 01/28/2024

Group Name Group Type Group Description Value Description

CME_SEX_CD Valid Values M-Male, F-Female M Male
CME_SEX_CD Valid Values M-Male, F-Female F Female

Page 7 of 8 723035509.xlsx
 CMS Enterprise Architecture
Data Dictionary Template
Last Update: 01/28/2024

Version Description of Change Author Date Comments

1.0 Inherited the legacy version Roman I Ozerov 1/20/2021
1.1. Improved further by doing market research and CMS resources Roman I Ozerov 1/27/2021
1.3 Standardized with Erwin-based template Roman I Ozerov 2/5/2021

Page 8 of 8 723035509.xlsx