Minimum Metadata Requirements

All studies included in CLOSER Discovery must comply to the minimum metadata requirements listed below, in addition to the Study, Sweep and Data collection metadata provided using the Metadata audit spreadsheet.

Questionnaires

Item	Description	Mandatory	DDI Mapping	DDI Documentation
Data Collection	The data collection the questionnaire is associated with	Yes	Data Collection	https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/item-types/DataCollection/
Interviewer / Respondent	Type of interviewer or respondent (e.g. Parent / Child etc.)	Yes	ResponseUnit	https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/item-types/QuestionConstruct/?highlight=responseunit
DDI Agency	The registered agency ID for the study (or metadata ‘owner’)	Yes	Agency	https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/item-types/Versionable/?highlight=versionable
Questionnaire Title	Title of questionnaire	Yes	Instrument Label	https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/item-types/Instrument/
Sequence	Section headings	Yes	Sequence	https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/item-types/Sequence/
Flow	Order the same as in the questionnaire	Yes	-	-
Conditions	If else / filters / go to etc.	Yes	IfThenElse	https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/item-types/IfThenElse/
Question Label	CAI name or label of the question	Yes	UserAttributePair
Question Text	Text of question	Yes	QuestionText	https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/item-types/QuestionItem/ or https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/item-types/QuestionGrid/
Response Domain	How the respondent can answer the question e.g. code List, numeric, text etc.	Yes	RepresentationType	https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/composite-types/RepresentationType/
Cardinality	Number of responses to question code list	Yes	ResponseCardinalityType	https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/composite-types/ResponseCardinalityType/?highlight=responsecardinality
Instruction	Interviewer or respondent instructions associated with a question	Yes	Instruction	https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/item-types/Instruction/
Statements	Other text	Yes	StatementItem	https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/item-types/StatementItem/
Loops	Repeating questions	Yes	Loop	https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/item-types/Loop/

Datasets

Item	Description	Mandatory	DDI Mapping	DDI Documentation
Sweep	The sweep the dataset are associated with	Yes	StudyUnit	https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/item-types/StudyUnit/
Dataset Name	Name of dataset	Yes	Citation	https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/item-types/PhysicalInstance/
URL	Where dataset can obtained e.g. DOI or website	Yes	DataFileIdentification	https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/item-types/PhysicalInstance/
Variable Name	Name of variable / column	Yes	VariableName	https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/item-types/Variable/
Variable Description / Label	Variable label	Yes	Label	https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/item-types/Variable/
Variable Type	String / Numeric / Time / Date etc	Yes	VariableRepresentationType	https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/composite-types/VariableRepresentationType/
Variable Format	Length / decimal / YYYMMMDD etc	Yes	VariableRepresentationType	https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/composite-types/VariableRepresentationType/
Number of Cases / Rows	Number of rows in dataset	Yes	CaseQuantity	https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/composite-types/GrossFileStructureType/?highlight=casequantity
Case Identifier	Case identifier	Yes	CaseIdentification	https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/composite-types/LogicalRecordType/
Code List	Codes available on question if appropriate	Yes	CodeList	https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/item-types/CodeList/
Minimum Value	Minimum value of numeric	Yes	NumberRangeType	https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/composite-types/NumberRangeType/
Maximum Value	Maximum value of numeric	Yes	NumberRangeType	https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/composite-types/NumberRangeType/
Valid	No. of cases with valid responses	Yes	SummaryStatisticType	https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/composite-types/SummaryStatisticType/
Invalid	No. of cases with invalid responses	Yes	SummaryStatisticType	https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/composite-types/SummaryStatisticType/
Frequency count	Count of coded values (valid / invalid)	No	SummaryStatisticType	https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/composite-types/SummaryStatisticType/
Frequency %	% of coded values (valid / invalid)	No	SummaryStatisticType	https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/composite-types/SummaryStatisticType/
Mean	Mean of numeric values	Yes	SummaryStatisticType	https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/composite-types/SummaryStatisticType/
STDV	Standard Deviation of numeric values	No	SummaryStatisticType	https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/composite-types/SummaryStatisticType/

Mappings

Item	Description	Mandatory	DDI Mapping	DDI Documentation
Variable to Question	Variable, question mapping for each question	Yes	QuestionReference	https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/item-types/Variable/
Topics	Map topics to each variable and question	Yes	QuestionGroup VariableGroup	https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/item-types/QuestionGroup https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/item-types/VariableGroup/?highlight=variablegroup
Derived Variable	Variables which form a derived variable	Yes	SourceVariableReference	https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/item-types/Variable/
Equivalencies	Variables with consistent concept	Yes	ConceptualVariable	https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/item-types/ConceptualVariable/