API Field Descriptions Dec2019 PDF
API Field Descriptions Dec2019 PDF
Download & API Field Descriptions Download & API Field Descriptions (contains 1 line for each file and field)
Abbreviations List of abbreviations used in the Field Descriptions tab (for example in the synonyms column)
Conventions Naming conventions used for naming files and fields (and their rationale)
MS Access queries List of sample MS Access queries provided in downloadable MS Access database
FNDDS crosswalk Documentation on what FDC fields the FNDDS data were imported into
Download & API Field Descriptions
Table / File Field Definition of data element Synonyms (used on user API Location
interface only)
GLOBAL column definitions These fields appear in multiple files, and their definition is typically the same
unless noted below
fdc_id Unique permanent identifier of a food in the food table
id Unique permanent identifier of other kinds of data (e.g. nutrients, lab methods,
etc.) in their related table
fdc_id_of_sample_food ID of the sample food that uses the acquisitioned food
fdc_id_of_acquisition_food ID of the acquisitioned food used in the sample food
Download & API Field Descriptions, Page 1 of 7
Download & API Field Descriptions
Table / File Field Definition of data element Synonyms (used on user API Location
interface only)
food Any substance consumed by humans for nutrition, taste and/or aroma
fdc_id Unique permanent identifier of the food FDC Source ID (used for
foodClass For internal use only
data_type Type of food data (see Files tab for possible values).
description Description of the food
food_category_id Id of the food category the food belongs to foodGroup
publication_date Date when the food was published to FoodData Central Published, Published Date, FDC
Published
scientific_name The scientific name for the food
food_key A string of characters used to identify both the current and all historical records
for a specific food.
Download & API Field Descriptions, Page 2 of 7
Download & API Field Descriptions
Table / File Field Definition of data element Synonyms (used on user API Location
interface only)
food_fat_conversion_factor Factor to calculate total lipid fat (204) food‐>nutrientConversionFactors
food_nutrient_conversion_factor_id Id of the related row in the nutrient_conversion_factor table id
fat_nlea_value The multiplication factor to convert from fat NLEA (298) to total fat (204)
Download & API Field Descriptions, Page 3 of 7
Download & API Field Descriptions
Table / File Field Definition of data element Synonyms (used on user API Location
interface only)
food_portion Discrete amount of food Measures (for foundation or food‐>foodPortions
legacy foods), Portions (for
id
fdc_id ID of the food this food portion pertains to N/A
seq_num The order the measure will be displayed on the released food. sequenceNumber
amount The number of measure units that comprise the measure (e.g. if measure is 3 tsp,
the amount is 3). Not defined for survey (FNDDS) foods (amount is instead
embedded in portion description).
measure_unit_id The unit used for the measure (e.g. if measure is 3 tsp, the unit is tsp). For food Unit measureUnit
types that do not use measure SR legacy foods and survey (FNDDS) foods), a value
of '9999' is assigned to this field.
portion_description Foundation foods: Comments that provide more specificity on the measure. For Measure Description
example, for a pizza measure the dissemination text might be 1 slice is 1/8th of a
14 inch pizza"." Survey (FNDDS) foods: The household description of the portion.
modifier Foundation foods: Qualifier of the measure (e.g. related to food shape or form)
(e.g. melted, crushed, diced). Survey (FNDDS) foods: The portion code. SR legacy
foods: description of measures, including the unit of measure and the measure
modifier (e.g. waffle round (4" dia)).
gram_weight The weight of the measure in grams Weight (g)
data_points The number of observations on which the measure is based n
footnote Comments on any unusual aspects of the measure. These are released to the
public. Examples might include caveats on the usage of a measure, or reasons why
a measure gram weight is an unexpected value.
min_year_acquired Minimum purchase year of all acquisitions used to derive the measure value Year Acquired
food_protein_conversion_factor food‐>nutrientConversionFactors
food_nutrient_conversion_factor_id Id of the related row in the nutrient_conversion_factor table id
value The multiplication factor used to calculate protein from nitrogen
Download & API Field Descriptions, Page 4 of 7
Download & API Field Descriptions
Table / File Field Definition of data element Synonyms (used on user API Location
interface only)
input_food A food that is an ingredient (for survey (FNDDS) foods) or a source food (for Sources (for foundation foods), food‐>inputFoods
foundation foods or their source foods) to another food. Ingredients (for survey foods)
id
fdc_id fdc_id of the food that contains the input food N/A
fdc_id_of_input_food fdc_id of the food that is the input food inputFood
seq_num The order in which to display the input food sequenceNumber
amount The amount of the input food included within this food given in terms of unit
sr_code The SR (aka NDB) code of the SR food that is the ingredient food (used for Survey
(FNDDS) foods only)
sr_description The description of the SR food that is the ingredient food (used for Survey
(FNDDS) foods only)
unit The unit of measure for the amount of the input food that is included within this Measure
food (used for Survey (FNDDS) foods only)
portion_code Code that identifies the portion description used to measure the amount of the
ingredient (used for Survey (FNDDS) foods only)
portion_description The description of the portion used to measure the amount of the ingredient Portion
(used for Survey (FNDDS) foods only)
gram_weight The weight in grams of the input food Weight (g)
retention_code A numeric code identifying processing on the input food that may have impacted retentionFactor
food nutrient content (used for Survey (FNDDS) foods only)
survey_flag 2 = SR description does not match SR code, other values = internal processing Flag
codes for FSRG use only
Download & API Field Descriptions, Page 5 of 7
Download & API Field Descriptions
Table / File Field Definition of data element Synonyms (used on user API Location
interface only)
market_acquisition A food obtained for chemical analysis. food (is a type of food)
fdc_id ID of the food in the food table FDC Source ID
brand_description Brand name description of the food
expiration_date Date the food will expire
label_weight The weight of the food per the product label
location The region in which the food was purchased, e.g. CA1
acquisition_date Date the food was purchased
sales_type The type of establishment in which the food was acquired (e.g. Retail Store,
restaurant, farm, etc.)
sample_lot_nbr The lot number of the food Sample Lot Number sampleLotNumber
sell_by_date Date the food should be sold by
store_city The city where the food was acquired
store_name The name of the store the food is purchased from
store_state The state where the food was acquired
upc_code UPC code for the food. Only applicable for retail products.
nutrient_incoming_name A nutrient name used to identify a nutrient in incoming nutrient data
id
name The name used for the incoming nutrient (e.g. if nutrient is Protein, name might
be Prot)
nutrient_id The id of the nutrient (in the nutrient file) related to the incoming name. Optional
(see is_ignored for more info).
Download & API Field Descriptions, Page 6 of 7
Download & API Field Descriptions
Table / File Field Definition of data element Synonyms (used on user API Location
interface only)
sample_food A food that is acquired as a representative sample of the food supply. It may be food (is a type of food)
created from a single acquired food, or from a composite of multiple acquired
foods.
fdc_id ID of the food in the food table N/A
fdc_id ID of the food in the food table
fdc_id_of_sample_food ID of the sample food from which the sub sample originated
start_date Start date indicates time period corresponding to WWEIA data
end_date End date indicates time period corresponding to WWEIA data
Download & API Field Descriptions, Page 7 of 7
Abbreviation Meaning
Abbreviations used in data element names
id unique identification number
max minimum
min minimum
Abbreviations used for API fields
Field is not included as it is a
N/A reference to a parent element
Abbreviations
Query Name What it retrieves
q_fndds_<FnddsTableName> FNDDS data in the format origininally used to distribute FNDDS 2013‐2014
q_foundation_agricultural_acquisition_sources Source agricultural acquisitions of foundation foods
q_foundation_agricultural_acquisition_nutrients Source agricultural acquisition nutrients of foundation foods
q_foundation_market_acquisition_sources Source market acquisitions of foundation foods
q_foundation_market_acquisition_nutrients Source market acquisition nutrients of foundation foods
q_foundation_market_acquisition_portions Source market acquisition portions of foundation foods
q_foundation_market_acquisition_components Source market acquisition components of foundation foods
MS Access queries
FNDDS ‐> FDC Crosswalk Data was imported from FNDDS 2013‐14 MS Access database to FDC Access database and CSV files
Main goal is to document where imported survey (FNDDS) data is stored in FDC
FNDDS Table Name FNDDS Column Name FDC Table Name* FDC Column Name* FDC Location on Website Migration Notes
AddFoodDesc Food code food_attribute fdc_id Food Details -> FDC ID Used to link to survey_fndds_food . food_code
AddFoodDesc Seq num food_attribute seq_num Attributes -> Seq num
AddFoodDesc Start date survey_fndds_food start_date Food Details -> Start date
AddFoodDesc End date survey_fndds_food end_date Food Details -> End date
AddFoodDesc Additional food description food_attribute value Attributes -> Additional Description
FNDDSNutVal Food code food_nutrient fdc_id Food Details -> FDC ID Used to link to survey_fndds_food . food_code
FNDDSNutVal Nutrient code food_nutrient nutrient_id Based on nutrient.nutrient_nbr = 'Nutrient code'
FNDDSNutVal Start date survey_fndds_food start_date
FNDDSNutVal End date survey_fndds_food end_date Food Details -> End date
FNDDSNutVal Nutrient value food_nutrient amount Nutrients - > Amount
FNDDSRecCount Full File Name
FNDDSRecCount no_of_records
FNDDSSRLinks Food code input_food fdc_id Food Details -> FDC ID Used to link to survey_fndds_food . food_code
FNDDSSRLinks Start date survey_fndds_food start_date Food Details -> Start date
FNDDSSRLinks End date survey_fndds_food end_date Food Details -> End date
FNDDSSRLinks Seq num input_food seq_num Ingredients -> Seq Num
FNDDSSRLinks SR code input_food sr_code Ingredients -> Code
FNDDSSRLinks SR description input_food sr_description Ingredients -> Description
FNDDSSRLinks Amount input_food amount Ingredients -> Amount
FNDDSSRLinks Measure input_food unit Ingredients -> Measure
FNDDSSRLinks Portion code input_food portion_code Portions -> Portion Code
FoodPortionDesc Portion description input_food portion_description Portions -> Portion Description
FNDDSSRLinks Retention code input_food retention_code Ingredients -> Retention Code
FNDDSSRLinks Flag input_food survey_flag Ingredients -> Flag
FNDDSSRLinks Weight input_food gram_weight Ingredients -> Weight(g)
FoodPortionDesc Portion code food_portion modifier
FoodPortionDesc Start date survey_fndds_food start_date Food Details -> Start date
FoodPortionDesc End date survey_fndds_food end_date Food Details -> End date
FoodPortionDesc Portion description food_portion portion_description Ingredients -> Portion
FoodSubcodeLinks Food code survey_fndds_food food_code Food Details -> Food Code
FoodSubcodeLinks Subcode Used to link to FoodWeights (We only import subcodes into food_portion
that have a subcode code of 0 ("default gram weights")) so this field is
not needed.
FoodSubcodeLinks Start date survey_fndds_food start_date Food Details -> Start date
FoodSubcodeLinks End date survey_fndds_food end_date Food Details -> End date
FoodWeights Food code food_portion fdc_id Food Details -> FDC ID Used to link to survey_fndds_food . food_code
FoodWeights Subcode See FoodSubcodeLinks . Subcode explanation
FoodWeights Seq num food_portion seq_num Portions -> Seq num
FoodWeights Portion code food_portion modifier Portions -> Portion code
FoodWeights Start date survey_fndds_food start_date Food Details -> Start date
FoodWeights End date survey_fndds_food end_date Food Details -> End date
FoodWeights Portion weight food_portion gram_weight Portions -> Weight (g)
MainFoodDesc Food code survey_fndds_food food_code Food Details -> Food Code
MainFoodDesc Start date survey_fndds_food start_date Food Details -> Start date
FNDDS crosswalk, Page 1 of 2
FNDDS Table Name FNDDS Column Name FDC Table Name* FDC Column Name* FDC Location on Website Migration Notes
MainFoodDesc End date survey_fndds_food end_date Food Details -> End date
MainFoodDesc Main food description food description Food Details -> Description
MoistNFatAdjust Food code food_attribute fdc_id Food Details -> FDC ID Used to link to survey_fndds_food . food_code
MoistNFatAdjust Start date survey_fndds_food start_date Food Details -> Start date
MoistNFatAdjust End date survey_fndds_food end_date Food Details -> End date
MoistNFatAdjust Moisture change food_attribute value Attributes -> Adjustments Example, "Moisture change: -20.0%"
MoistNFatAdjust Fat change food_attribute value Attributes -> Adjustments Example, "Fat change: 5.3%, Fat code: 4615 (Shortening, vegetable,
household, composite)"
MoistNFatAdjust Type of fat food_attribute value Attributes -> Adjustments See above
NutDesc Nutrient code nutrient nutrient_nbr
NutDesc Nutrient description nutrient name
NutDesc Tagname
NutDesc Unit nutrient unit_name
NutDesc Decimals
SRNutVal SR code input_food sr_code Based on NDB_number
SRNutVal Nutrient code These data were not migrated to FDC. Nutrient values for SR codes
used as the basis for FNDDS 13-14 nutrient values can be found at
https://www.ars.usda.gov/northeast-area/beltsville-md-bhnrc/beltsville-
human-nutrition-research-center/food-surveys-research-
group/docs/fndds-download-databases/
SRNutVal Start date survey_fndds_food start_date Food Details -> Start date
SRNutVal End date survey_fndds_food end_date Food Details -> End date
SRNutVal Nutrient value These data were not migrated to FDC. Nutrient values for SR codes
used as the basis for FNDDS 13-14 nutrient values can be found at
https://www.ars.usda.gov/northeast-area/beltsville-md-bhnrc/beltsville-
human-nutrition-research-center/food-surveys-research-
group/docs/fndds-download-databases/
SRNutVal Nutrient value change flag These data were not migrated to FDC. Nutrient values for SR codes
used as the basis for FNDDS 13-14 nutrient values can be found at
https://www.ars.usda.gov/northeast-area/beltsville-md-bhnrc/beltsville-
human-nutrition-research-center/food-surveys-research-
group/docs/fndds-download-databases/
SubcodeDesc Subcode Did not import subCode descriptions other than for subcode=0
SubcodeDesc Start date survey_fndds_food start_date Food Details -> Start date
SubcodeDesc End date survey_fndds_food end_date Food Details -> End date
SubcodeDesc Subcode description
category_list category_number wweia_food_category wweia_category_code
category_list category_description wweia_food_category wweia_category_description Food Details -> Food Category
FNDDS_foodcat food_code survey_fndds_food food_code Food Details -> Food Code
FNDDS_foodcat category_number survey_fndds_food wweia_category_code
FNDDS crosswalk, Page 2 of 2