Include Page | ||
---|---|---|
|
|
Panel | ||
---|---|---|
| ||
CCSQ D&A HOME | CDR Data Catalog | Data Roadmap | Data Taxonomy | Mapping DUAs to CDR | Archive |
Panel | ||||||
---|---|---|---|---|---|---|
| ||||||
|
id | CDR Contributor Resources |
---|
title | Documentation Requirements |
---|
borderWidth | 1 px |
---|
CDR Contributor Documentation Requirements
Overview of CDR Data Catalog
The CDR Data Catalog provides a location for data contributors to make documentation available to CDR users. The DAMOD team provides a general layout document of each schema that includes table names, column names, and datatypes for every source in Hive. This document (located under the CDR Table Layouts column) is produced when the data is made available in the CDR or if data definitions are updated. Data contributors to the CDR are responsible for providing supplemental documentation necessary to support end-users of their data. Such examples of documentation may include:
Data Dictionaries
Data Models
User Guides
Training Documents
Minimum Requested Documentation from Data Contributors
Available documentation on the CDR Data Catalog will vary from source to source. Some mature data sources will have excellent existing documentation/artifacts while newer sources may provide less. At a minimum, the DAMOD team recommends data contributors to provide the following documents:
Document Name
Description
Necessary Information
Other Information
Data Dictionary
Data dictionaries can be various formats including Excel, PDF, and Word. We recommend all documents provided to be 508 compliant for users. We strongly recommend that data for columns that contain discrete, non-inferable or computed values have clear and detailed documentation.
Table Name
Column Name
Column Description
Where Relevant - Domains of values, either listed in their entirety, or a link to a reference document
Data Types
Examples
Other relevant information
Null Option
Data Model
Data Models provide the keys for each table. This provides users a mechanism for understanding how to join data across tables and identifying unique records (if applicable to your source).
Surrogate Keys
Foreign Keys
Primary Keys
Indexes
Example Approved Data Dictionary
The example below meets all criteria including:
Table Name
Column Name
Column Description (Comment)
Code values for non-inferable data
Null Option
Data Type
Expectations
- Data Contributors provide updated documentation when source data changes
- Data Contributors provide consistent versioning on documents
- Data Contributors provide accurate documentation for users
- Data Contributors support questions about the data and documentation
title | Data Issue Reporting |
---|
borderWidth | 1 px |
---|
|
CDR Data Contribution Standard Operating Procedure (SOP)
This SOP provides an overview of the Centralized Data Repository (CDR) Contribution process for contributors that plan to make data available in the CDR for all organizations with an approved data usage agreement (DUA). These sources and their approved documentation will be posted to the CDR Data Catalog.
Background
The CDR provides access to CCSQ data including claims, provider, beneficiary, and other data within a secure cloud environment. The goal of the CDR is to make data available from source systems with greater accessibility, security, quality, and timeliness of data. The goal of Contribution is to allow CDR Data Contributors to make data available directly to CDR users with less data duplication.
Horizontal Navigation Bar | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
|
|
|
|
|