Consumer product use frequencies data formats

Consumer product use frequencies are described by five table.

Download empty dataset template: Zipped CSV Excel

Consumer product surveys

The records of the consumer product surveys table contain the ids, names, descriptions, and other relevant metadata of consumer product surveys.

Accepted table names: ConsumerProductSurveys, CPSurveys.

Table 59 Table definition for Consumer product surveys.
Name Type Description Aliases Required

idSurvey

AlphaNumeric (50)

Unique identification code of the consumer product survey.

idSurvey, Survey, SurveyId, Id

Yes

Name

AlphaNumeric (100)

The name of the consumer product survey.

Name, SurveyName

No

Description

AlphaNumeric (200)

Description of the consumer product survey.

Description

No

Country

AlphaNumeric (50)

The location or country where the survey is held. It is recommended to use ISO Alpha-2 country codes.

Location, Country

No

BodyWeightUnit

BodyWeightUnit

The unit of bodyweight of the individuals of the survey: kg (default) or g.

BodyWeightUnit, UnitBodyWeight, WeightIn

No

AmountUnit

ConsumptionUnit

The unit of the amounts of consumer product use in the survey: g (default) or kg or CustomUnit (see table food consumption quantifications table).

AmountUnit, UnitAmount

No

StartDate

DateTime

The start date of the survey.

StartDate

No

EndDate

DateTime

The end date of the survey.

EndDate

No

idPopulation

AlphaNumeric (50)

Unique identification code of the population.

IdPopulation, PopulationId

No

Individuals

The individuals of a survey are recorded in the Individuals table. Add additional properties like Region, Breastfeeding to further describe an individual. In table IndividualProperties, each property in the Individuals table is described (recommended way). Note that only those properties that are available in the Individuals table are used in module Populations, table Populations or PopulationIndividualPropertyValues to subset the individuals. This is only relevant when the UseData option in the population module is used.

Accepted table names: Individuals, SurveyIndividuals, ConsumptionSurveyIndividuals, FoodConsumptionSurveyIndividuals.

Table 60 Table definition for Individuals.
Name Type Description Aliases Required

idIndividual

AlphaNumeric (50)

Unique identification code of the individual.

idIndividual, IndividualId, Individual, Id

Yes

idFoodSurvey

AlphaNumeric (50)

The identification code / short name of survey.

idSurvey, idFoodSurvey, Survey, FoodSurvey, SurveyId, FoodSurveyId, SurveyCode

Yes

BodyWeight

Numeric

The body weight of the individual.

BodyWeight, Weight

No

SamplingWeight

Numeric

The sampling weight for an individual (default = 1).

SamplingWeight

No

NumberOfSurveyDays

Integer

The number of days the individual participated in the survey.

NumberOfSurveyDays, NumberOfDaysInSurvey, DaysInSurvey, NDaysInSurvey

No

Name

AlphaNumeric (100)

Name or label of the individual.

Name

No

Description

AlphaNumeric (200)

Additional description of the individual.

Description

No

Individual properties

Other individual properties can be added like the fields Age, Gender, Region etc. These properties are automatically parsed as co-factors or co-variables.

No

Individual properties

This table is used to describe the properties used in the Populations or PopulationIndividualPropertyValues table characterising the population (table Populations) and/or the properties used in the Individuals table characterising an individual. Properties like Age, Gender, Region are describing an individual (PropertyLevel = Individual). Properties like Period (for populations) or Month (sampling date for an individual day) are describing an individual day (PropertyLevel = IndividualDay).

Accepted table names: IndividualProperties, IndividualProperty.

Table 61 Table definition for Individual properties.
Name Type Description Aliases Required

idIndividualProperty

AlphaNumeric (50)

The code of the property.

idIndividualProperty, IndividualPropertyId, IndividualProperty

Yes

Name

AlphaNumeric (100)

The name of the property.

Name

No

PropertyLevel

PropertyLevelType

The level of the property. This type follows a controlled terminology, with possible values: Individual or IndividualDay.

PropertyLevel, LevelProperty

No

Description

AlphaNumeric (200)

Description of the property.

Description

No

Type

IndividualPropertyType

This field specifies the type of the values of this individual property. This type follows a controlled terminology, with possible values: Boolean, Categorical (default), Numeric, Nonnegative, Integer, NonnegativeInteger, Month, Datetime, Gender.

Type

No

Individual property values

Not recommended. This table describes individual property values. Property values are describing an individual for properties like e.g. Region, Breastfeeding. The recommended way is to add these columns as additional columns in the Individuals table. In table IndividualProperties, each property in the IndividualPropertyValues table is described.

Accepted table names: IndividualPropertyValues, IndividualPropertyValue.

Table 62 Table definition for Individual property values.
Name Type Description Aliases Required

idIndividual

AlphaNumeric (50)

The identification number of the Individual.

Id

Yes

PropertyName

AlphaNumeric (50)

The name of the property.

Name

Yes

TextValue

AlphaNumeric (50)

The value of the property as text value.

No

DoubleValue

Numeric

The value of the property as number.

No

Individual consumer product use frequencies

Individual consumer product use frequencies are specified as a number of use per day for a consumer product (>= 0).

Accepted table names: ConsumerProductUseFrequencies, CPUseFrequencies, UseFrequencies.

Table 63 Table definition for Individual consumer product use frequencies.
Name Type Description Aliases Required

idIndividual

AlphaNumeric (50)

The unique identification code of the consumer (individual).

idIndividual, IndividualId, Individual

Yes

idProduct

AlphaNumeric (50)

The consumer product id or code.

idProduct, ProductId, Product

Yes

Frequency

Numeric

The frequency of use, a value equal or higher than zero (freq >= 0).

Frequency

Yes