Instrument (Questionnaire)

This refers to the data collection instrument used e.g. a questionnaire. It can have a one to many relationship with the Data Collection, as each instrument can used more than once.

The table gives a approximate idea of the structure of the DDI 3.2 XML instance used (it is not exact).

Please refer to the CLOSER GitHub page for more information.

Fields					Description	Required	DDI Documentation
Instrument					Holds information about the instrument (usually a questionnaire)	Yes	https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/item-types/Instrument/
	InstrumentName				Instrument prefix	Yes	https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/item-types/Instrument/
	Agency				The DDI agency identifier for the metadata e.g. uk.alspac, uk.cls.mcs	Yes	https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/item-types/Instrument/
	Label				Title of the instrument	Yes	https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/item-types/Instrument/
	InterviewerInstruction				Question instruction	No	https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/item-types/Instrument/
		LiteralText			Instruction text	No	https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/item-types/Instrument/
	ControlConstruct				Holds all constructs in order they appear in the questionnaire	Yes	https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/item-types/ControlConstruct/
		Sequence			Section of questionnaire which contains other control constructs	Yes	https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/item-types/Sequence/
			ConstructName		Section header		https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/item-types/ControlConstruct/
			ConstructLabel		Section header		https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/item-types/ControlConstruct/
		QuestionConstruct			Holds question construct label, position and interviewee	Yes	https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/item-types/QuestionConstruct/
			ConstructName		Question construct label e.g. qc_1		https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/item-types/ControlConstruct/
			ConstructLabel		Question construct name e.g. 1		https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/item-types/ControlConstruct/
			ResponseUnit		The person answering the question		https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/item-types/QuestionConstruct/
			QuestionReference		Reference to the question		https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/item-types/QuestionConstruct/
		IfThenElse				No	https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/item-types/IfThenElse/
			ConstructName		Condition label e.g. c_q1		https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/item-types/ControlConstruct/
			Description		Condition text		https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/composite-types/CommandCodeType/
			Command				https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/composite-types/CommandCodeType/
				ProgramLanguage	Program language logic is in		https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/composite-types/CommandType/
				CommandContent	Condition logic		https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/composite-types/CommandType/
		LoopWhile				No	https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/item-types/Loop/
			ConstructName		Loop label e.g. l_q1		https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/composite-types/CommandCodeType/
			Command				https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/composite-types/CommandCodeType/
				ProgramLanguage	Program language logic is in		https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/composite-types/CommandType/
				CommandContent	Condition logic		https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/composite-types/CommandType/
		StatementItem				No	https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/item-types/StatementItem/
			ConstructName		Statement label e.g. s_q1		https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/item-types/StatementItem/
			LiteralText		Statement text		https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/item-types/StatementItem/
	QuestionScheme				Contains the question items	Yes	Container for Question Types
		QuestionItem			Single question	Yes	https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/item-types/QuestionItem/
			QuestionItemName		Question item label e.g. qi_1		https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/composite-types/StandardKeyValuePairType/
			LiteralText		Question text		https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/item-types/QuestionItem/
			CodeDomain		Code list response domain		https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/composite-types/CodeDomainType/
				CodeListReference	Reference to the code list		https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/composite-types/CodeDomainType/
				ResponseCardinality	Number of options a respondent can select		https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/composite-types/CodeDomainType/
			NumericDomain		Numeric response domain		https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/composite-types/NumericDomainType/
				Label	Numeric response domain label		https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/composite-types/NumericDomainType/
				NumericTypeCode	Type of numeric (float or interger)		https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/composite-types/NumericDomainType/
				NumberRange	Min and max range		https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/composite-types/NumericDomainType/
			TextDomain		Text response domain max length		https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/composite-types/TextDomainType/
				Label	Text response domain label		https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/composite-types/TextDomainType/
			DateTimeDomain		Date response domain		https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/composite-types/DateTimeRepresentationBaseType/
				Label	Date response domain label		https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/composite-types/DateTimeRepresentationBaseType/
				DateTypeCode	Date, time or duration		https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/composite-types/DateTimeRepresentationBaseType/
		QuestionGrid			Matrix of questions	No	https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/item-types/QuestionGrid/
			QuestionGridName		Question grid label e.g. qc_1		https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/item-types/QuestionGrid/
			LiteralText		Question text		https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/item-types/QuestionGrid/
			GridDimension		Contains the structure of the matrix and response domains		https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/item-types/QuestionGrid/
				CodeDomain	Code lists for X and Y axis		https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/composite-types/GridDimensionType/
				StructuredMixedGridResponseDomain	Contains the response domains attached to the grid		https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/composite-types/GridDimensionType/
	CategoryScheme					Yes	Container for Categories
		CategoryName			ID of category (auto-generated)		https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/item-types/Category/
		Label			Category text		https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/item-types/Category/
	CodeList					Yes	Container for CodeLists
		Label			Code list label		https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/item-types/CodeList/
		Value			Code value		https://ddialliance.github.io/ddimodel-web/DDI-L-3.2/item-types/CodeList/