Data dictionary
Every table and column in the Channel Keys listing. Refer to objects as CORE.<TABLE> under the database name you choose when you get the listing. Column names are plain uppercase identifiers, so no quoting is needed.
Keys and conventions
NDC11: 11-digit, zero-padded 5-4-2 NDC.XREF_NDC_FORMATSmaps every FDA 10-digit format to it.APPL_TYPEandAPPL_NO: the Orange Book application key (N for NDA, A for ANDA),APPL_NOzero-padded to six digits.LABELER_CODE: the first five digits of the NDC.DIM_LABELERcarries the best labeler name and the matched Open Payments manufacturer with its match score.ID_340B: the HRSA covered entity ID. Contract pharmacies key onID_340BplusCONTRACT_ID.SNAPSHOT_DATE: the refresh a row came from.CHANGE_LOGcompares consecutive refreshes;META_SOURCE_RUNrecords the agency files behind each one.- Derived fields (
EST_LOE_DATE,IS_DISCONTINUED,IS_ACTIVE, manufacturer matches) are ours. Validate before regulatory or contractual use.
Tables
- NDC_PRODUCT
- NDC_PACKAGE
- DIM_NDC11
- DIM_LABELER
- XREF_NDC_FORMATS
- OB_PRODUCT
- OB_PATENT
- OB_EXCLUSIVITY
- DIM_APPLICATION
- SDUD_UTILIZATION
- OPAIS_COVERED_ENTITY
- OPAIS_CONTRACT_PHARMACY
- OPAIS_CE_NPI
- OPAIS_CE_MEDICAID
- OPAIS_CE_SHIPPING
- OP_PAYMENT_SUMMARY
- OP_PRODUCT_SUMMARY
- OP_RECIPIENT_MANUFACTURER_YEAR
- OP_ENTITY_PROFILE
- CHANGE_LOG
- META_SOURCE_RUN
NDC_PRODUCT 345,642 rows
FDA NDC Directory product rows (finished, excluded and unfinished files) with typed dates and normalized application numbers.
| Column | Type |
|---|---|
PRODUCT_ID | VARCHAR |
PRODUCT_NDC | VARCHAR |
PRODUCT_NDC9 | VARCHAR |
LABELER_CODE | VARCHAR |
PRODUCT_CODE | VARCHAR |
PRODUCT_TYPE | VARCHAR |
PROPRIETARY_NAME | VARCHAR |
PROPRIETARY_NAME_SUFFIX | VARCHAR |
NONPROPRIETARY_NAME | VARCHAR |
DOSAGE_FORM | VARCHAR |
ROUTE | VARCHAR |
START_MARKETING_DATE | DATE |
END_MARKETING_DATE | DATE |
MARKETING_CATEGORY | VARCHAR |
APPLICATION_NUMBER | VARCHAR |
APPL_TYPE | VARCHAR |
APPL_NO | VARCHAR |
LABELER_NAME | VARCHAR |
SUBSTANCE_NAME | VARCHAR |
ACTIVE_NUMERATOR_STRENGTH | VARCHAR |
ACTIVE_INGRED_UNIT | VARCHAR |
PHARM_CLASSES | VARCHAR |
DEA_SCHEDULE | VARCHAR |
NDC_EXCLUDE_FLAG | VARCHAR |
LISTING_RECORD_CERTIFIED_THROUGH | DATE |
SOURCE_FILE | VARCHAR |
SNAPSHOT_DATE | DATE |
NDC_PACKAGE 640,244 rows
FDA NDC Directory package rows with the 11-digit NDC.
| Column | Type |
|---|---|
PRODUCT_ID | VARCHAR |
PRODUCT_NDC | VARCHAR |
NDC_PACKAGE_CODE | VARCHAR |
NDC11 | VARCHAR |
PRODUCT_NDC9 | VARCHAR |
PACKAGE_DESCRIPTION | VARCHAR |
START_MARKETING_DATE | DATE |
END_MARKETING_DATE | DATE |
NDC_EXCLUDE_FLAG | VARCHAR |
SAMPLE_PACKAGE | VARCHAR |
SOURCE_FILE | VARCHAR |
SNAPSHOT_DATE | DATE |
DIM_NDC11 638,180 rows
One row per 11-digit NDC (5-4-2) with product, labeler, application, marketing dates, Orange Book LOE fields and discontinuation flag. Precedence: finished > unfinished > excluded.
| Column | Type |
|---|---|
NDC11 | VARCHAR |
NDC_PACKAGE_CODE | VARCHAR |
PRODUCT_NDC | VARCHAR |
PRODUCT_NDC9 | VARCHAR |
PRODUCT_ID | VARCHAR |
LABELER_CODE | VARCHAR |
PRODUCT_CODE | VARCHAR |
PACKAGE_CODE | VARCHAR |
PRODUCT_TYPE | VARCHAR |
PROPRIETARY_NAME | VARCHAR |
PROPRIETARY_NAME_SUFFIX | VARCHAR |
NONPROPRIETARY_NAME | VARCHAR |
DOSAGE_FORM | VARCHAR |
ROUTE | VARCHAR |
SUBSTANCE_NAME | VARCHAR |
ACTIVE_NUMERATOR_STRENGTH | VARCHAR |
ACTIVE_INGRED_UNIT | VARCHAR |
PHARM_CLASSES | VARCHAR |
DEA_SCHEDULE | VARCHAR |
MARKETING_CATEGORY | VARCHAR |
APPLICATION_NUMBER | VARCHAR |
APPL_TYPE | VARCHAR |
APPL_NO | VARCHAR |
LABELER_NAME | VARCHAR |
PACKAGE_DESCRIPTION | VARCHAR |
SAMPLE_PACKAGE | VARCHAR |
START_MARKETING_DATE | DATE |
END_MARKETING_DATE | DATE |
SOURCE_FILE | VARCHAR |
IS_DISCONTINUED | BOOLEAN |
IN_ORANGE_BOOK | BOOLEAN |
OB_ANY_RLD | BOOLEAN |
LAST_PATENT_EXPIRY | DATE |
LAST_EXCLUSIVITY_DATE | DATE |
EST_LOE_DATE | DATE |
SNAPSHOT_DATE | DATE |
N_SOURCE_ROWS | BIGINT |
DIM_LABELER 18,241 rows
One row per labeler code with best name, product counts, marketing-date range and the matched CMS Open Payments manufacturer (exact or fuzzy, score shown).
| Column | Type |
|---|---|
LABELER_CODE | VARCHAR |
LABELER_NAME | VARCHAR |
LABELER_NAME_NORM | VARCHAR |
N_PRODUCTS | BIGINT |
N_ACTIVE_PRODUCTS | BIGINT |
N_PACKAGES | BIGINT |
FIRST_MARKETING_DATE | DATE |
LAST_MARKETING_DATE | DATE |
OP_MANUFACTURER_ID | VARCHAR |
OP_MANUFACTURER_NAME | VARCHAR |
OP_MATCH_METHOD | VARCHAR |
OP_MATCH_SCORE | DOUBLE |
SNAPSHOT_DATE | DATE |
XREF_NDC_FORMATS 640,244 rows
Crosswalk between FDA 10-digit hyphenated NDCs (4-4-2, 5-3-2, 5-4-1), 10-digit unhyphenated and the 11-digit claims format.
| Column | Type |
|---|---|
NDC11 | VARCHAR |
NDC10_HYPHENATED | VARCHAR |
NDC10_DIGITS | VARCHAR |
NDC11_HYPHENATED | VARCHAR |
FDA_FORMAT | VARCHAR |
SOURCE_FILE | VARCHAR |
SNAPSHOT_DATE | DATE |
OB_PRODUCT 48,865 rows
Orange Book products (applicant, TE code, RLD/RS flags, approval date).
| Column | Type |
|---|---|
INGREDIENT | VARCHAR |
DF_ROUTE | VARCHAR |
TRADE_NAME | VARCHAR |
APPLICANT | VARCHAR |
STRENGTH | VARCHAR |
APPL_TYPE | VARCHAR |
APPL_NO | VARCHAR |
PRODUCT_NO | VARCHAR |
TE_CODE | VARCHAR |
APPROVAL_DATE | DATE |
APPROVAL_DATE_TEXT | VARCHAR |
RLD | VARCHAR |
RS | VARCHAR |
OB_TYPE | VARCHAR |
APPLICANT_FULL_NAME | VARCHAR |
SNAPSHOT_DATE | DATE |
OB_PATENT 22,438 rows
Orange Book patents with expiry dates, use codes and delist flags.
| Column | Type |
|---|---|
APPL_TYPE | VARCHAR |
APPL_NO | VARCHAR |
PRODUCT_NO | VARCHAR |
PATENT_NO | VARCHAR |
PATENT_EXPIRE_DATE | DATE |
DRUG_SUBSTANCE_FLAG | VARCHAR |
DRUG_PRODUCT_FLAG | VARCHAR |
PATENT_USE_CODE | VARCHAR |
DELIST_FLAG | VARCHAR |
SUBMISSION_DATE | DATE |
SNAPSHOT_DATE | DATE |
OB_EXCLUSIVITY 2,347 rows
Orange Book exclusivity codes and dates.
| Column | Type |
|---|---|
APPL_TYPE | VARCHAR |
APPL_NO | VARCHAR |
PRODUCT_NO | VARCHAR |
EXCLUSIVITY_CODE | VARCHAR |
EXCLUSIVITY_DATE | DATE |
SNAPSHOT_DATE | DATE |
DIM_APPLICATION 27,428 rows
One row per NDA/ANDA with first approval, last patent expiry, last exclusivity, estimated loss-of-exclusivity date and linked NDC product counts.
| Column | Type |
|---|---|
APPL_TYPE | VARCHAR |
APPL_NO | VARCHAR |
N_OB_PRODUCTS | BIGINT |
APPLICANT | VARCHAR |
APPLICANT_FULL_NAME | VARCHAR |
FIRST_APPROVAL_DATE | DATE |
ANY_RLD | BOOLEAN |
TRADE_NAMES | VARCHAR[] |
LAST_PATENT_EXPIRY | DATE |
N_PATENTS | BIGINT |
LAST_EXCLUSIVITY_DATE | DATE |
EXCLUSIVITY_CODES | VARCHAR[] |
EST_LOE_DATE | DATE |
N_NDC_PRODUCTS | BIGINT |
N_LABELERS | BIGINT |
FIRST_NDC_MARKETING_DATE | DATE |
SNAPSHOT_DATE | DATE |
SDUD_UTILIZATION 17,221,265 rows
Medicaid State Drug Utilization Data by state, NDC, year and quarter (FFS and MCO), typed measures and suppression flag.
| Column | Type |
|---|---|
UTILIZATION_TYPE | VARCHAR |
STATE | VARCHAR |
NDC11 | VARCHAR |
LABELER_CODE | VARCHAR |
PRODUCT_CODE | VARCHAR |
PACKAGE_CODE | VARCHAR |
YEAR | INTEGER |
QUARTER | INTEGER |
YEAR_QUARTER | INTEGER |
SUPPRESSION_USED | BOOLEAN |
PRODUCT_NAME | VARCHAR |
UNITS_REIMBURSED | DOUBLE |
NUMBER_OF_PRESCRIPTIONS | DOUBLE |
TOTAL_AMOUNT_REIMBURSED | DOUBLE |
MEDICAID_AMOUNT_REIMBURSED | DOUBLE |
NON_MEDICAID_AMOUNT_REIMBURSED | DOUBLE |
SNAPSHOT_DATE | DATE |
OPAIS_COVERED_ENTITY 94,951 rows
340B OPAIS covered entities (participating and terminated) with addresses, officials and termination details.
| Column | Type |
|---|---|
ID_340B | VARCHAR |
CE_ID | BIGINT |
ENTITY_TYPE | VARCHAR |
ENTITY_NAME | VARCHAR |
ENTITY_SUB_NAME | VARCHAR |
PARTICIPATING | VARCHAR |
PARTICIPATING_START_DATE | DATE |
TERMINATION_DATE | DATE |
TERMINATION_REASON | VARCHAR |
GRANT_NUMBER | VARCHAR |
SITE_ID | VARCHAR |
MEDICARE_PROVIDER_NUMBER | "NULL" |
NOFO_NUMBER | VARCHAR |
ASSISTANCE_FROM_DATE | DATE |
ASSISTANCE_TO_DATE | DATE |
RURAL | BOOLEAN |
STREET_ORGANIZATION | "NULL" |
STREET_ADDRESS1 | VARCHAR |
STREET_ADDRESS2 | VARCHAR |
STREET_ADDRESS3 | VARCHAR |
STREET_CITY | VARCHAR |
STREET_STATE | VARCHAR |
STREET_ZIP | VARCHAR |
STREET_ZIP4 | VARCHAR |
BILLING_ORGANIZATION | VARCHAR |
BILLING_ADDRESS1 | VARCHAR |
BILLING_ADDRESS2 | VARCHAR |
BILLING_ADDRESS3 | VARCHAR |
BILLING_CITY | VARCHAR |
BILLING_STATE | VARCHAR |
BILLING_ZIP | VARCHAR |
BILLING_ZIP4 | VARCHAR |
AUTHORIZING_OFFICIAL_NAME | VARCHAR |
AUTHORIZING_OFFICIAL_TITLE | VARCHAR |
AUTHORIZING_OFFICIAL_PHONE | VARCHAR |
PRIMARY_CONTACT_NAME | VARCHAR |
PRIMARY_CONTACT_TITLE | VARCHAR |
PRIMARY_CONTACT_PHONE | VARCHAR |
CERTIFIED_DECERTIFIED_DATE | TIMESTAMP |
COMMENTS | VARCHAR |
EDIT_DATE | TIMESTAMP |
N_CONTRACT_PHARMACIES | BIGINT |
IS_PARTICIPATING | BOOLEAN |
SNAPSHOT_DATE | DATE |
OPAIS_CONTRACT_PHARMACY 409,900 rows
340B contract pharmacy arrangements per covered entity with begin and termination dates and an is_active flag.
| Column | Type |
|---|---|
ID_340B | VARCHAR |
CE_ID | BIGINT |
PHARMACY_NAME | VARCHAR |
CONTRACT_ID | BIGINT |
PHARMACY_ID | BIGINT |
CONTRACT_BEGIN_DATE | DATE |
CONTRACT_TERMINATION_DATE | DATE |
PHARMACY_ORGANIZATION | "NULL" |
PHARMACY_ADDRESS1 | VARCHAR |
PHARMACY_ADDRESS2 | VARCHAR |
PHARMACY_ADDRESS3 | VARCHAR |
PHARMACY_CITY | VARCHAR |
PHARMACY_STATE | VARCHAR |
PHARMACY_ZIP | VARCHAR |
PHARMACY_ZIP4 | VARCHAR |
PHARMACY_PHONE | VARCHAR |
PHARMACY_PHONE_EXT | VARCHAR |
IS_ACTIVE | BOOLEAN |
SNAPSHOT_DATE | DATE |
OPAIS_CE_NPI 759,991 rows
NPIs registered to each 340B covered entity.
| Column | Type |
|---|---|
ID_340B | VARCHAR |
CE_ID | BIGINT |
NPI | VARCHAR |
STATE | VARCHAR |
SNAPSHOT_DATE | DATE |
OPAIS_CE_MEDICAID 297,056 rows
Medicaid billing numbers registered to each 340B covered entity.
| Column | Type |
|---|---|
ID_340B | VARCHAR |
CE_ID | BIGINT |
MEDICAID_NUMBER | VARCHAR |
STATE | VARCHAR |
SNAPSHOT_DATE | DATE |
OPAIS_CE_SHIPPING 165,048 rows
Ship-to addresses registered to each 340B covered entity.
| Column | Type |
|---|---|
ID_340B | VARCHAR |
CE_ID | BIGINT |
IS_340B_STREET_ADDRESS | BOOLEAN |
SHIPPING_ORGANIZATION | VARCHAR |
SHIPPING_ADDRESS1 | VARCHAR |
SHIPPING_ADDRESS2 | VARCHAR |
SHIPPING_ADDRESS3 | VARCHAR |
SHIPPING_CITY | VARCHAR |
SHIPPING_STATE | VARCHAR |
SHIPPING_ZIP | VARCHAR |
SHIPPING_ZIP4 | VARCHAR |
SNAPSHOT_DATE | DATE |
OP_PAYMENT_SUMMARY 20,631 rows
CMS Open Payments general payments summarized by manufacturer, program year, recipient type, nature and form of payment.
| Column | Type |
|---|---|
MANUFACTURER_ID | VARCHAR |
MANUFACTURER_NAME | VARCHAR |
PROGRAM_YEAR | INTEGER |
COVERED_RECIPIENT_TYPE | VARCHAR |
NATURE_OF_PAYMENT | VARCHAR |
FORM_OF_PAYMENT | VARCHAR |
N_RECORDS | BIGINT |
N_PAYMENTS | DOUBLE |
TOTAL_USD | DOUBLE |
N_RECIPIENTS | BIGINT |
SNAPSHOT_DATE | DATE |
OP_PRODUCT_SUMMARY 66,151 rows
Open Payments general payments summarized by manufacturer and product (with NDC-11 where the reported NDC resolves), split and full-amount views.
| Column | Type |
|---|---|
MANUFACTURER_ID | VARCHAR |
MANUFACTURER_NAME | VARCHAR |
PROGRAM_YEAR | INTEGER |
COVERED_RECIPIENT_TYPE | VARCHAR |
NATURE_OF_PAYMENT | VARCHAR |
PRODUCT_TYPE | VARCHAR |
PRODUCT_CATEGORY | VARCHAR |
PRODUCT_NAME | VARCHAR |
NDC_RAW_DIGITS | VARCHAR |
NDC_RAW | VARCHAR |
N_RECORDS | BIGINT |
TOTAL_USD_FULL | DOUBLE |
TOTAL_USD_SPLIT | DOUBLE |
NDC11 | VARCHAR |
SNAPSHOT_DATE | DATE |
OP_RECIPIENT_MANUFACTURER_YEAR 9,461,472 rows
Open Payments general payments summarized by covered recipient (NPI or profile id), manufacturer and program year.
| Column | Type |
|---|---|
COVERED_RECIPIENT_TYPE | VARCHAR |
PROFILE_ID | VARCHAR |
NPI | VARCHAR |
TEACHING_HOSPITAL_ID | VARCHAR |
TEACHING_HOSPITAL_NAME | VARCHAR |
FIRST_NAME | VARCHAR |
LAST_NAME | VARCHAR |
SPECIALTY_1 | VARCHAR |
RECIPIENT_STATE | VARCHAR |
MANUFACTURER_ID | VARCHAR |
MANUFACTURER_NAME | VARCHAR |
PROGRAM_YEAR | INTEGER |
N_RECORDS | BIGINT |
TOTAL_USD | DOUBLE |
SNAPSHOT_DATE | DATE |
OP_ENTITY_PROFILE 4,482 rows
Open Payments company and teaching-hospital profiles (physician profiles excluded).
| Column | Type |
|---|---|
ENTITY_ID | VARCHAR |
ENTITY_PROVIDER_TYPE | VARCHAR |
ENTITY_NPI | VARCHAR |
ENTITY_ALTERNATE_ID | VARCHAR |
ENTITY_TYPE | VARCHAR |
ENTITY_NAME | VARCHAR |
ENTITY_ALTERNATE_NAME1 | VARCHAR |
ENTITY_ALTERNATE_NAME2 | VARCHAR |
ENTITY_ALTERNATE_NAME3 | VARCHAR |
ENTITY_ALTERNATE_NAME4 | VARCHAR |
ENTITY_ALTERNATE_NAME5 | VARCHAR |
ENTITY_ADDRESS_LINE_1 | VARCHAR |
ENTITY_ADDRESS_LINE_2 | VARCHAR |
ENTITY_CITY | VARCHAR |
ENTITY_STATE | VARCHAR |
ENTITY_ZIPCODE | VARCHAR |
ENTITY_COUNTRY_NAME | VARCHAR |
ENTITY_PROVINCE_NAME | VARCHAR |
ENTITY_SPECIALTY | VARCHAR |
LOCATION | VARCHAR |
SNAPSHOT_DATE | DATE |
CHANGE_LOG 0 rows
Row-level adds, removals and field changes between consecutive refreshes for NDC, Orange Book and 340B tables (old and new values as JSON).
| Column | Type |
|---|---|
SNAPSHOT_DATE | DATE |
PREV_SNAPSHOT_DATE | DATE |
TABLE_NAME | VARCHAR |
ENTITY_KEY | VARCHAR |
CHANGE_TYPE | VARCHAR |
CHANGED_FIELDS | VARCHAR[] |
OLD_VALUES | JSON |
NEW_VALUES | JSON |
META_SOURCE_RUN 13 rows
Source files behind this refresh: URL, size, SHA-256 and server last-modified.
| Column | Type |
|---|---|
SOURCE | VARCHAR |
RUN_DATE | VARCHAR |
FILE | VARCHAR |
BYTES | BIGINT |
SHA256 | VARCHAR |
URL | VARCHAR |
LAST_MODIFIED | VARCHAR |
BUILD_DATE | DATE |