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/ | ||||
| InstrumentName | 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/ | ||||
| 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 | |||||
| ConstructName | Section header | ||||||
| ConstructLabel | Section header | ||||||
| QuestionConstruct | Holds question construct label, position and interviewee | Yes | |||||
| ConstructName | Question construct label e.g. qc_1 | ||||||
| ConstructLabel | Question construct name e.g. 1 | ||||||
| ResponseUnit | The person answering the question | ||||||
| ControlConstructReference | Reference to the question | ||||||
| IfThenElse | No | ||||||
| ConstructName | Condition label e.g. c_q1 | ||||||
| Description | Condition text | ||||||
| Command | |||||||
| ProgramLanguage | Program language logic is in | ||||||
| CommandContent | Condition logic | ||||||
| LoopWhile | No | ||||||
| ConstructName | Loop label e.g. l_q1 | ||||||
| Command | |||||||
| ProgramLanguage | Program language logic is in | ||||||
| CommandContent | Condition logic | ||||||
| StatementItem | No | ||||||
| ConstructName | Statement label e.g. s_q1 | ||||||
| LiteralText | Statement text | ||||||
| QuestionScheme | Contains the question items | Yes | |||||
| QuestionItem | Single question | Yes | |||||
| QuestionItemName | Question item label e.g. qi_1 | ||||||
| LiteralText | Question text | ||||||
| CodeDomain | Code list response domain | ||||||
| CodeListReference | Reference to the code list | ||||||
| ResponseCardinality | Number of options a respondent can select | ||||||
| NumericDomain | Numeric response domain | ||||||
| Label | Numeric response domain label | ||||||
| NumericTypeCode | Type of numeric (float or interger) | ||||||
| NumberRange | Min and max range | ||||||
| TextDomain | Text response domain max length | ||||||
| Label | Text response domain label | ||||||
| DateTimeDomain | Date response domain | ||||||
| Label | Date response domain label | ||||||
| DateTypeCode | Date, time or duration | ||||||
| QuestionGrid | Matrix of questions | No | |||||
| QuestionGridName | Question grid label e.g. qc_1 | ||||||
| LiteralText | Question text | ||||||
| GridDimension | Contains the structure of the matrix and response domains | ||||||
| CodeDomain | Code lists for X and Y axis | ||||||
| StructuredMixedGridResponseDomain | Contains the response domains attached to the grid | ||||||
| CategoryScheme | Yes | ||||||
| CategoryName | ID of category (auto-generated) | ||||||
| Label | Category text | ||||||
| CodeList | Yes | ||||||
| Label | Code list label | ||||||
| Value | Code value |