ddi:datacollection:3_0
Imports: http://www.w3.org/XML/1998/namespace (xml.xsd)
Imports: ddi:reusable:3_0 (reusable.xsd)
Imports: ddi:logicalproduct:3_0 (logicalproduct.xsd)
Global Elements
DataCollection (DataCollectionType): The DataCollection element contains all of the metadata about the data collection process of the study or studies being described. This includes methodologies used for determining data sources, sample, and repetitions for data collection, question structures, flow logic for questionnaires (traditional or computer-assisted), and data processing occurring during data collection and data product creation.
SourceDescription (r:StructuredStringType):
SourceType (r:CodeValueType): SourceType allows for the provision of a term describing primary or secondary data sources, and may be from a controlled vocabulary.
Aggregation (AggregationType):
Method (r:CodeValueType):
VariableSet (VariableSetType):
VariableSetReference (r:ReferenceType):
IndependentVariableReference (r:ReferenceType):
DependentVariableReference (r:ReferenceType):
InterviewerInstructionScheme (InterviewerInstructionSchemeType):
Instruction (InstructionType):
InterviewerInstructionSchemeReference (r:SchemeReferenceType):
ControlConstructScheme (ControlConstructSchemeType): A set of control constructs maintained by an agency, and used in the instrument.
ControlConstruct (ControlConstructType): [abstract] The global element ControlConstruct serves as the head of a substitution group for describing the order and flow of questions and supporting information within a data collection instrument.
IfThenElse (IfThenElseType): [substitution: ControlConstruct]
RepeatUntil (RepeatUntilType): [substitution: ControlConstruct]
RepeatWhile (RepeatWhileType): [substitution: ControlConstruct]
Loop (LoopType): [substitution: ControlConstruct]
Sequence (SequenceType): [substitution: ControlConstruct]
ConstructSequence (SpecificSequenceType):
ComputationItem (ComputationItemType): [substitution: ControlConstruct]
StatementItem (StatementItemType): [substitution: ControlConstruct]
Text (TextType): [abstract] Text exists only to act as the head of a substitution group for the various types of derived text elements within the instrument.
LiteralText (LiteralTextType): [substitution: Text]
ConditionalText (ConditionalTextType): [substitution: Text]
QuestionItem (QuestionItemType): Acts as the head of a substitution group for a set of derived question items.
StructuredMixedResponseDomain (StructuredMixedResponseDomainType): ResponseDomains should be chosen that do NOT duplicate responses such as CodeSchemes with overlapping codes. Be aware that certain instruments may collect responses in such a way that confusion between a code response and text response may be possible. The process of resolving such conflicts should be addressed in the data processing instructions. There is an assumption that if a text or numeric response duplicates a coded response to a question, that the value is that of the coded category.
MultipleQuestionItem (MultipleQuestionItemType): Describes a multiple-question question item. Inherits from QuestionItem.
SubQuestionSequence (SpecificSequenceType): Prescribes the order in which the sub-questions should appear.
ResponseDomain (r:RepresentationType): [abstract] A response domain for a question item, used only as the head of a substitution group for the various derived types of response domains.
QuestionConstruct (QuestionConstructType): [substitution: ControlConstruct]
ResponseSequence (SpecificSequenceType):
TextDomain (r:TextDomainType): [substitution: ResponseDomain]
DateTimeDomain (DateTimeDomainType): [substitution: ResponseDomain]
NumericDomain (NumericDomainType): [substitution: ResponseDomain]
CodeDomain (CodeDomainType): [substitution: ResponseDomain]
CategoryDomain (CategoryDomainType): [substitution: ResponseDomain]
GeographicDomain (GeographicDomainType): [substitution: ResponseDomain]
QuestionSequenceType (QuestionSequenceTypeType):
AlternateSequenceType (r:CommandType):
Type (r:CodeValueType): A generic element for specifying a further classification of an object. Note that this element can be substituted with an element that extends the reusable code type to restrict the possible values to an enumeration.
Methodology (MethodologyType): Methodological metadata for the data collection.
CollectionEvent (CollectionEventType): A set of metadata describing a data collection event. Several events may be described in a single data collection activity.
QuestionScheme (QuestionSchemeType): Describes a set of questions used in the data collection. Several sets of questions may be used. A single scheme always is maintained by a single agency.
QuestionSchemeReference (r:SchemeReferenceType): Provides for inclusion by reference of one question scheme in another.
Instrument (InstrumentType): A description of an instrument related to the data collection activity.
ProcessingEvent (ProcessingType): Metadata regarding a processing event occurring as part of the data collection.
DataCollectionMethodology (r:IdentifiedStructuredStringType): Describes a methodology for data collection.
TimeMethod (r:IdentifiedStructuredStringType): Describes how time fits into the data collection methodology.
SamplingProcedure (r:IdentifiedStructuredStringType): Describes a sampling procedure.
DeviationFromSampleDesign (r:IdentifiedStructuredStringType): Describes deviation from a sample design.
DataSource (DataSourceType): Describes a data source.
Origin (OriginType): A citation or URI indicating the origin of the data. Note that this is an external reference, and should not be used to point to DDI descriptions of the data, or to DDI-encoded data.
Characteristic (r:StructuredStringType): A significant characteristic of the data source that may effect understanding or collection of the data. For example: legibility of data source affected due to water damage.
DataCollectionFrequency (DataCollectionFrequencyType): Provides the intended frequency of data collection, for example monthly, yearly, weekly preferably using an optional controlled vocabulary in the attribute intendedFrequncy. Date of first collection should be provided in StartDate as a basis for defining periodicity. EndDate should be entered for data collection cycles with a known or anticipated end date. EndDate is omitted in data collection series that are intended to be on-going.
ModeOfCollection (r:IdentifiedStructuredStringType): Describes the mode of collection.
CollectionSituation (r:IdentifiedStructuredStringType): Describes the situation in which the data collection event takes place.
ActionToMinimizeLosses (r:IdentifiedStructuredStringType): Describes action taken to minimize loss of data from the collection event.
ControlOperation (OperationType): Describes a control operation.
CleaningOperation (OperationType): Describes a raw data cleaning operation.
Weighting (r:IdentifiedStructuredStringType): Describes the weighting used in the process.
DataAppraisalInformation (DataAppraisalInformationType): Information about the data appraisal.
Coding (CodingType): A description of the coding of the data within the process.
Expression (r:CodeType): A computational expression used in the coding.
SourceVariableReference (r:ReferenceType): A reference to a source variable used as an input in the preceding Expression.
IfCondition (r:CodeType): The condition which must be met to trigger the Then clause, expressed as a Coding. The condition is an expression in the programming language used in the instrument.
ThenConstructReference (r:ReferenceType): A reference to the control construct which should be triggered if the associated condition is met.
ElseConstructReference (r:ReferenceType): A reference to the control construct which is triggered if the associated condition is not met.
UntilCondition (r:CodeType): The condition which must be met to stop the repeated operation of the Coding in the associated UntilConstruct. The condition is an expression in the programming language used in the instrument.
UntilConstructReference (r:ReferenceType): A reference to the Coding which runs until the UntilCondition is met. When the operation ceases, the flow returns to the containing control construct.
WhileCondition (r:CodeType): The condition which must be met to trigger the operation of the associated Coding.
WhileConstructReference (r:ReferenceType): A reference to the Coding which is to be run when the associated condition has been met.
LoopVariableReference (r:ReferenceType): A reference to the variable (as used in the associated Codings) which is incremented or otherwise manipulated to meet the conditions stated in the LoopWhile condition.
InitialValue (r:CodeType): The initial value to which the LoopVariable is set.
LoopWhile (r:CodeType): The condition which must be met for the Loop's functioning to cease; when this condition is met, control is handed back to the containing control construct.
StepValue (r:CodeType): A Coding which is used to manipulate the LoopVariable after each iteration of the Loop's associated ControlConstruct element.
Code (r:CodeType): The Code which contains the value of the variable.
AssignedVariableReference (r:ReferenceType): A reference to a variable to which the associated value in the Code element is assigned.
DisplayText (DynamicTextType): The string to be displayed in the instrument.
QuestionText (DynamicTextType): The text of the question presented in the instrument.
QuestionIntent (r:StructuredStringType): The purpose of the question vis-a-vis the data being collected.
ConceptReference (r:ReferenceType): A reference to the concept associated with the response to the question.
AssociatedItems (QuestionGroupType): Question items associated with the Question Item.
SubQuestions (QuestionGroupType): A group of question items forming a group of sub-questions.
Label (r:InternationalStringType): Label for the response domain as a human-readable string.
QuestionReference (r:ReferenceType): A reference to a question.
ResponseText (DynamicTextType): The text of a response.
SamplingError (r:StructuredStringType): The sampling error of the data.
OtherAppraisalProcess (r:StructuredStringType): Description of any other form of data appraisal.
ResponseUnit (r:InternationalStringType): The response unit.
GeneralInstruction (GeneralInstructionType): Coding instructions that pertain to data collection or data processing overall such as handling of non-response to questions, imputation practices, suppression rules, etc. Coding instructions should be listed separately to allow for referencing of specific processes.
GenerationInstruction (GenerationInstructionType): Instructions for recodes, derivations from multiple question or variable sources, and derivations based on external sources. Instructions should be listed separately so they can be referenced by variables in the logical product.
SourceQuestion (SourceReferenceType): Reference to a question used in the coding process.
ControlConstructReference (r:ReferenceType): Reference to an element in the substitution group headed by the abstract element ControlConstruct.
ControlConstructSchemeReference (r:SchemeReferenceType): Provides for inclusion by reference of external Control Construct Schemes.
SourceVariable (SourceReferenceType): Reference to a variable used in the coding process.
ExternalInformation (r:ReferenceType): Reference to an external source of information used in the coding process, for example a value from a chart, etc.
DataCollectorOrganizationReference (r:ReferenceType): Reference to an organization, defined in the organization scheme, responsible for the data collection.
AgencyOrganizationReference (r:ReferenceType): Reference to an organization, defined in the organziation scheme, responsible for the operation.
ExternalInterviewerInstructionReference (ExternalInterviewerInstructionReferenceType): External reference to an interviewer instruction not expressed as DDI XML.
InterviewerInstructionReference (InterviewerInstructionReferenceType): Reference to an interviewer instruction expressed as DDI XML.
IsOverride (r:ReferenceType): Provides a reference to the GeneralInstruction which the containing GeneralInstruction overrides.
DataCollectionDate (r:DateType): Provides a date or range of dates for the described data collection event as well as a cycle number when the collection is part of a series of data collection events.
ExternalAid (r:OtherMaterialType): A pointer to an exteral aid presented by the instrument such as a text card, image, audio, or audiovisual aid. Typically a URN. Use type attribute to describe the type of external aid provided. Example of terms to use would include: imageOnly audioOnly audioVisual multiMedia.
Complex Types
DataCollectionType: Includes information about the data collection and post-collection processing.
- Content:
- Extends: r:MaintainableType
- Base Content
- Extends: AbstractMaintainableType
- Base Content
- Extends: AbstractVersionableType
- Base Content
- Extends: AbstractIdentifiableType
- Base Content
- Sequence of:
- [Reference] (Name) - min. 0 - max. unbounded
- Human-readable name given the entity being identified. May be repeated to provide language and/or geographic alternatives.
- Extended Content
- Sequence of:
- VersionResponsibility (xs:string) - min. 0
- Person and/or organization within the MaintenanceAgency responsible for the version change. This is primarily intended for internal use.
- [Reference] (VersionRationale) - min. 0 - max. unbounded
- Textual description of the rationale/purpose for a version change.
- Base Attributes
- id (BaseIDType) - required
- Assigned ID, unique within its maintainable object.
- urn (xs:anyURI) - optional
- DDI-structured URN of the element as described in Part I of the Technical Documentation.
- action (ActionCodeType) - optional
- Used for inheritance to indicate that the element being described is being added, updated, or deleted at the local level. Add: This element is added to the inherited structure. Update: This element is to be used in place of the inherited element with this ID for local processing. Delete: This element has been removed from the inherited group for local processing. There will be a new ID only in the case of Add.
- Extended Attributes
- version (NewVersionType) - optional
- Restricted string - numeric with optional decimal points.
- versionDate (BaseDateType) - optional
- Date of version. Duration should not be used in this field, even though allowed by the ISO format enforced by the parser.
- Extended Attributes
- agency (xs:NCName) - optional
- Maintaining agency as described in Part 1 of the Technical Specification.
- Extended Attributes
- Extended Content
- Sequence of:
- [Reference] (r:Coverage) - min. 0
- Describes the coverage of the data collection activity.
- [Reference] (r:OtherMaterial) - min. 0 - max. unbounded
- Other materials related to the data collection.
- [Reference] (r:Note) - min. 0 - max. unbounded
- Notes regarding the data collection metadata.
- [Reference] (Methodology) - min. 0
- Methodological metadata for the data collection.
- [Reference] (CollectionEvent) - min. 0 - max. unbounded
- A set of metadata describing a data collection event. Several events may be described in a single data collection activity.
- [Reference] (QuestionScheme) - min. 0 - max. unbounded
- Describes a set of questions used in the data collection. Several sets of questions may be used. A single scheme always is maintained by a single agency.
- [Reference] (ControlConstructScheme) - min. 0 - max. unbounded
- A collection of control constructs used in data collection by one or more instruments.
- [Reference] (InterviewerInstructionScheme) - min. 0 - max. unbounded
- A collection of interviewer instructions used in data collection by instruments.
- [Reference] (Instrument) - min. 0 - max. unbounded
- A description of an instrument used in the data collection activity.
- [Reference] (ProcessingEvent) - min. 0 - max. unbounded
- Metadata regarding a processing event occurring as part of the data collection or data file preparation.
MethodologyType: MethodologyType describes the methodology used for data collection.
- Content:
- Extends: r:VersionableType
- Base Content
- Extends: AbstractVersionableType
- Base Content
- Extends: AbstractIdentifiableType
- Base Content
- Sequence of:
- [Reference] (Name) - min. 0 - max. unbounded
- Human-readable name given the entity being identified. May be repeated to provide language and/or geographic alternatives.
- Extended Content
- Sequence of:
- VersionResponsibility (xs:string) - min. 0
- Person and/or organization within the MaintenanceAgency responsible for the version change. This is primarily intended for internal use.
- [Reference] (VersionRationale) - min. 0 - max. unbounded
- Textual description of the rationale/purpose for a version change.
- Base Attributes
- id (BaseIDType) - required
- Assigned ID, unique within its maintainable object.
- urn (xs:anyURI) - optional
- DDI-structured URN of the element as described in Part I of the Technical Documentation.
- action (ActionCodeType) - optional
- Used for inheritance to indicate that the element being described is being added, updated, or deleted at the local level. Add: This element is added to the inherited structure. Update: This element is to be used in place of the inherited element with this ID for local processing. Delete: This element has been removed from the inherited group for local processing. There will be a new ID only in the case of Add.
- Extended Attributes
- version (NewVersionType) - optional
- Restricted string - numeric with optional decimal points.
- versionDate (BaseDateType) - optional
- Date of version. Duration should not be used in this field, even though allowed by the ISO format enforced by the parser.
- Extended Attributes
- Extended Content
- Sequence of:
- [Reference] (DataCollectionMethodology) - min. 0 - max. unbounded
- Describes a methodology for data collection.
- [Reference] (TimeMethod) - min. 0 - max. unbounded
- Describes the time method or time dimension of the data collection.
- [Reference] (SamplingProcedure) - min. 0 - max. unbounded
- Describes the type of sample, sample design and provides details on drawing the sample. May include reference to the target sample size and the sampling fraction.
- [Reference] (DeviationFromSampleDesign) - min. 0 - max. unbounded
- Describes deviations from the sample design.
- [Reference] (r:Software) - min. 0 - max. unbounded
- Metadata regarding a software package used to instantiate a data collection method.
CollectionEventType: Provides information regarding a data collection event.
- Content:
- Extends: r:IdentifiableType
- Base Content
- Extends: AbstractIdentifiableType
- Base Content
- Sequence of:
- [Reference] (Name) - min. 0 - max. unbounded
- Human-readable name given the entity being identified. May be repeated to provide language and/or geographic alternatives.
- Base Attributes
- id (BaseIDType) - required
- Assigned ID, unique within its maintainable object.
- urn (xs:anyURI) - optional
- DDI-structured URN of the element as described in Part I of the Technical Documentation.
- action (ActionCodeType) - optional
- Used for inheritance to indicate that the element being described is being added, updated, or deleted at the local level. Add: This element is added to the inherited structure. Update: This element is to be used in place of the inherited element with this ID for local processing. Delete: This element has been removed from the inherited group for local processing. There will be a new ID only in the case of Add.
- Extended Attributes
- Extended Content
- Sequence of:
- Sequence of:
- [Reference] (DataCollectorOrganizationReference) - min. 0 - max. unbounded
- Reference to an organization, defined in the organziation scheme, responsible for the data collection
- [Reference] (DataSource) - min. 0 - max. unbounded
- Describes a source of the data.
- [Reference] (DataCollectionDate)
- Provides a date or range of dates for the described data collection event as well as a cycle number when the collection is part of a series of data collection events.
- [Reference] (DataCollectionFrequency) - min. 0 - max. unbounded
- Documents the intended frequency of data collection, for example monthly, yearly, weekly, etc., preferably using an optional controlled vocabulary in the IntendedFrequency element. Date of first collection should be provided in StartDate as a basis for defining periodicity. EndDate should be entered for data collection cycles with a known or anticipated end date. EndDate is omitted in data collection series that are intended to be on-going.
- [Reference] (ModeOfCollection) - min. 0 - max. unbounded
- Describes the mode of collection.
- [Reference] (CollectionSituation) - min. 0 - max. unbounded
- Describes the situation in which the data collection event takes place.
- [Reference] (ActionToMinimizeLosses) - min. 0 - max. unbounded
- Describes action taken to minimize loss of data from the collection event.
DataCollectionFrequencyType: Documents the intended frequency of data collection, for example monthly, yearly, weekly, etc., preferably using an optional controlled vocabulary in the IntendedFrequency element. Date of first collection should be provided in StartDate as a basis for defining periodicity. EndDate should be entered for data collection cycles with a known or anticipated end date. EndDate is omitted in data collection series that are intended to be on-going.
- Content:
- Extends: r:DateType
- Base Content
- Sequence of:
- Choice Of:
- [Reference] (SimpleDate)
- Sequence of:
- [Reference] (StartDate)
- [Reference] (HistoricalStartDate) - min. 0
- Start of a date range, expressed in a historical date format, according to a system specified in the historicalDateFormat attribute.
- [Reference] (EndDate) - min. 0
- End of a date range. If range is continuing on, end date can be blank.
- [Reference] (HistoricalEndDate) - min. 0
- End of a date range, expressed in a historical date format, according to a system specified in the historicalDateFormat attribute.
- Cycle (xs:integer) - min. 0
- Indicates the sequence of a date range within several ranges.
- [Reference] (HistoricalDate) - min. 0
- A date expressed in a historical date format, according to a system specified in the historicalDateFormat attribute.
- Extended Content
- Sequence of:
- IntendedFrequency (r:CodeValueType) - min. 0
- Documents the intended frequency of data collection, for example monthly, yearly, weekly, etc., preferably using an optional controlled vocabulary
- Base Attributes
- calendar (xs:string) - optional
- Specifies the type of calendar used (e.g., Gregorian, Julian, Jewish).
DataSourceType: Describes a source for the data.
- Content:
- Sequence of:
- [Reference] (SourceDescription) - min. 0 - max. unbounded
- A description of the source from which data are collected.
- [Reference] (SourceType) - min. 0 - max. unbounded
- Describes the type of source, and may be from a controlled vocabulary.
- [Reference] (Origin) - min. 0 - max. unbounded
- A citation or URI for the source of the data. Note that this is an external reference, and should not be used to point to DDI descriptions of the data, or to DDI-encoded data.
- [Reference] (Characteristic) - min. 0 - max. unbounded
- A significant characteristic of the data source that may affect understanding or collection of the data. This will include the level of documentation of the source data. For example: 'Legibility of data source affected due to water damage.'
OriginType: A citation or URI for the source of the data. Note that this is an external reference, and should not be used to point to DDI descriptions of the data, or to DDI-encoded data.
- Content:
- Sequence of:
- [Reference] (r:Citation) - min. 0
- Citation for the data source.
- OriginLocation (xs:anyURI) - min. 0
ProcessingType: ProcessingType provides a structure for describing the processing within data collection.
- Content:
- Extends: r:IdentifiableType
- Base Content
- Extends: AbstractIdentifiableType
- Base Content
- Sequence of:
- [Reference] (Name) - min. 0 - max. unbounded
- Human-readable name given the entity being identified. May be repeated to provide language and/or geographic alternatives.
- Base Attributes
- id (BaseIDType) - required
- Assigned ID, unique within its maintainable object.
- urn (xs:anyURI) - optional
- DDI-structured URN of the element as described in Part I of the Technical Documentation.
- action (ActionCodeType) - optional
- Used for inheritance to indicate that the element being described is being added, updated, or deleted at the local level. Add: This element is added to the inherited structure. Update: This element is to be used in place of the inherited element with this ID for local processing. Delete: This element has been removed from the inherited group for local processing. There will be a new ID only in the case of Add.
- Extended Attributes
- Extended Content
- Sequence of:
- [Reference] (ControlOperation) - min. 0 - max. unbounded
- Describes a control operation.
- [Reference] (CleaningOperation) - min. 0 - max. unbounded
- Describes a raw data cleaning operation.
- [Reference] (Weighting) - min. 0 - max. unbounded
- Describes the weighting used in the process.
- [Reference] (DataAppraisalInformation) - min. 0 - max. unbounded
- Information about the data appraisal.
- [Reference] (Coding) - min. 0 - max. unbounded
- A structure for the description of the computation used in the data collection or data processing such as recoding, derivations, or incorporation of external data sources.
OperationType: Provides a structure for cleaning and control operations within a data collection process.
- Content:
- Sequence of:
- [Reference] (r:Description) - min. 0 - max. unbounded
- A description of the operation.
- [Reference] (AgencyOrganizationReference) - min. 0 - max. unbounded
- A reference to the listing in Organization of the agency responsible for the operation.
DataAppraisalInformationType: Metadata regarding the appraisal of the collected data.
- Content:
- Sequence of:
- ResponseRate (xs:string) - min. 0 - max. unbounded
- [Reference] (SamplingError) - min. 0 - max. unbounded
- The sampling error of the data.
- [Reference] (OtherAppraisalProcess) - min. 0 - max. unbounded
- Description of any other form of data appraisal.
CodingType: A structure for the description of the computation used in the data collection or data processing such as recoding, derivations, or incorporation of external data sources.
- Content:
- Extends: r:IdentifiableType
- Base Content
- Extends: AbstractIdentifiableType
- Base Content
- Sequence of:
- [Reference] (Name) - min. 0 - max. unbounded
- Human-readable name given the entity being identified. May be repeated to provide language and/or geographic alternatives.
- Base Attributes
- id (BaseIDType) - required
- Assigned ID, unique within its maintainable object.
- urn (xs:anyURI) - optional
- DDI-structured URN of the element as described in Part I of the Technical Documentation.
- action (ActionCodeType) - optional
- Used for inheritance to indicate that the element being described is being added, updated, or deleted at the local level. Add: This element is added to the inherited structure. Update: This element is to be used in place of the inherited element with this ID for local processing. Delete: This element has been removed from the inherited group for local processing. There will be a new ID only in the case of Add.
- Extended Attributes
- Extended Content
- Sequence of:
- Choice Of:
- [Reference] (GeneralInstruction)
- Coding instructions that pertain to data collection or data processing overall such as handling of non-response to questions, imputation practices, suppression rules, etc. Coding instructions should be listed separately to allow for referencing of specific processes.
- [Reference] (GenerationInstruction)
- Instructions for recodes, derivations from multiple question or variable sources, and derivations based on external sources. Instructions should be listed separately so they can be referenced by variables in the logical product.
GeneralInstructionType: Coding instructions that pertain to data collection or data processing overall such as handling of non-response to questions, imputation practices, suppression rules, etc. Coding instructions should be listed separately to allow for referencing of specific processes.
- Content:
- Sequence of:
- [Reference] (r:Description) - max. unbounded
- A human-readable description of the coding instruction.
- [Reference] (r:Command) - min. 0 - max. unbounded
- A machine-actionable command for processing the coding process.
- [Reference] (IsOverride) - min. 0
- Used when attribute of the containing GeneralInstruction isOverride equals true. This element provides the reference to the GeneralInstruction that is being overriden.Used when attribute of the containing GeneralInstruction isOverride equals true. This element provides the reference to the GeneralInstruction that is being overridden.
- Attributes:
- isOverride (xs:boolean) - default: false
- When changed to true, indicates that this coding instruction overrides a more generally used process.
GenerationInstructionType: For recodes, derivations from multiple question or variable sources, and derivations based on external sources. Instructions should be listed separately so they can be referenced by variables in the logical product.
- Content:
- Sequence of:
- [Reference] (SourceQuestion) - min. 0 - max. unbounded
- Reference to a question used in the coding process
- [Reference] (SourceVariable) - min. 0 - max. unbounded
- Reference to a variable used in the coding process
- [Reference] (ExternalInformation) - min. 0 - max. unbounded
- Reference to an external source of information used in the coding process, for example a value from a chart, etc.
- [Reference] (r:Description) - min. 0 - max. unbounded
- A human-readable description of the coding instruction.
- [Reference] (r:Command) - min. 0 - max. unbounded
- A machine-actionable command for processing the coding process.
- [Reference] (ControlConstructReference) - min. 0 - max. unbounded
- A control construct within the derivation instruction.
- [Reference] (Aggregation) - min. 0
- Describes the aggregation.
- Attributes:
- isDerived (xs:boolean) - default: true
- When set to true, the instruction describes a derivation. When false, indicates a simple recode.
AggregationType: Describes the aggregation of a generation instruction.
- Content:
- Sequence of:
- [Reference] (Method)
- Choice Of:
- [Reference] (VariableSet)
- Provides detail on a variable set of dependent and independent variables.
- [Reference] (VariableSetReference)
- A reference to a variable set of dependent and independent variables.
VariableSetType: Provides detail on a variable set of dependent and independent variables.
- Content:
- Extends: r:IdentifiableType
- Base Content
- Extends: AbstractIdentifiableType
- Base Content
- Sequence of:
- [Reference] (Name) - min. 0 - max. unbounded
- Human-readable name given the entity being identified. May be repeated to provide language and/or geographic alternatives.
- Base Attributes
- id (BaseIDType) - required
- Assigned ID, unique within its maintainable object.
- urn (xs:anyURI) - optional
- DDI-structured URN of the element as described in Part I of the Technical Documentation.
- action (ActionCodeType) - optional
- Used for inheritance to indicate that the element being described is being added, updated, or deleted at the local level. Add: This element is added to the inherited structure. Update: This element is to be used in place of the inherited element with this ID for local processing. Delete: This element has been removed from the inherited group for local processing. There will be a new ID only in the case of Add.
- Extended Attributes
- Extended Content
- Sequence of:
- [Reference] (IndependentVariableReference) - min. 0 - max. unbounded
- A reference to a variable, which is an important constraint for the computed aggregation measure and has the potential to invoke a change in a dependent variable like sex for average of income.
- [Reference] (DependentVariableReference) - max. unbounded
- A reference to a variable, for which the aggregate measure is computed like average of income.
SourceReferenceType: Reference to a variable or question used in the deriviation or coding instruction.
- Content:
- Extends: r:ReferenceType
- Base Content
- Sequence of:
- [Reference] (Module) - min. 0
- References the module of the entity that is being referenced, in cases where there have been local modifications.
- [Reference] (Scheme) - min. 0
- Containing scheme of the entity that is being referenced.
- Choice Of: - max. 2
- [Reference] (URN)
- URN of the entity that is being referenced.
- Sequence of:
- [Reference] (ID)
- ID of the entity that is being referenced.
- IdentifyingAgency (xs:NCName) - min. 0
- Maintaining agency as described in Part 1 of the Technical Specification.
- [Reference] (Version) - min. 0
- If referencing a versioned or maintained element you must include Version. The version can be identified as lateBound, meaning that the latest version should be used.
- Extended Content
- Sequence of:
- Mnemonic (xs:string) - min. 0
- Allows for assigning a mnemonic name used to reference this item in a command.
- Base Attributes
- isExternal (xs:boolean) - default: false
- Indicates that the reference is made to an external source. If the value is true, then a URI must be provided.
- URI (xs:anyURI) - optional
- URI identifying the location of an external reference.
- isReference (xs:boolean) - fixed: true
- A fixed attribute value identifying which elements are references.
- lateBound (xs:boolean) - default: false
InterviewerInstructionSchemeType: series of interviewer instructuctions including routing information to be displayed within the instrument, definitions, and explanations of terminology and questions.
- Content:
- Extends: r:MaintainableType
- Base Content
- Extends: AbstractMaintainableType
- Base Content
- Extends: AbstractVersionableType
- Base Content
- Extends: AbstractIdentifiableType
- Base Content
- Sequence of:
- [Reference] (Name) - min. 0 - max. unbounded
- Human-readable name given the entity being identified. May be repeated to provide language and/or geographic alternatives.
- Extended Content
- Sequence of:
- VersionResponsibility (xs:string) - min. 0
- Person and/or organization within the MaintenanceAgency responsible for the version change. This is primarily intended for internal use.
- [Reference] (VersionRationale) - min. 0 - max. unbounded
- Textual description of the rationale/purpose for a version change.
- Base Attributes
- id (BaseIDType) - required
- Assigned ID, unique within its maintainable object.
- urn (xs:anyURI) - optional
- DDI-structured URN of the element as described in Part I of the Technical Documentation.
- action (ActionCodeType) - optional
- Used for inheritance to indicate that the element being described is being added, updated, or deleted at the local level. Add: This element is added to the inherited structure. Update: This element is to be used in place of the inherited element with this ID for local processing. Delete: This element has been removed from the inherited group for local processing. There will be a new ID only in the case of Add.
- Extended Attributes
- version (NewVersionType) - optional
- Restricted string - numeric with optional decimal points.
- versionDate (BaseDateType) - optional
- Date of version. Duration should not be used in this field, even though allowed by the ISO format enforced by the parser.
- Extended Attributes
- agency (xs:NCName) - optional
- Maintaining agency as described in Part 1 of the Technical Specification.
- Extended Attributes
- Extended Content
- Sequence of:
- [Reference] (r:Label) - min. 0 - max. unbounded
- A short description of the interviewer instruction scheme.
- [Reference] (r:Description) - min. 0 - max. unbounded
- A description of the use of the interviewer instruction scheme.
- [Reference] (InterviewerInstructionSchemeReference) - min. 0 - max. unbounded
- Allows for inclusion by reference of other interviewer instruction schemes.
- [Reference] (Instruction) - min. 0 - max. unbounded
- A description of a particular interviewer instruction.
InstructionType: A description of a particular interviewer instruction.
- Content:
- Extends: r:VersionableType
- Base Content
- Extends: AbstractVersionableType
- Base Content
- Extends: AbstractIdentifiableType
- Base Content
- Sequence of:
- [Reference] (Name) - min. 0 - max. unbounded
- Human-readable name given the entity being identified. May be repeated to provide language and/or geographic alternatives.
- Extended Content
- Sequence of:
- VersionResponsibility (xs:string) - min. 0
- Person and/or organization within the MaintenanceAgency responsible for the version change. This is primarily intended for internal use.
- [Reference] (VersionRationale) - min. 0 - max. unbounded
- Textual description of the rationale/purpose for a version change.
- Base Attributes
- id (BaseIDType) - required
- Assigned ID, unique within its maintainable object.
- urn (xs:anyURI) - optional
- DDI-structured URN of the element as described in Part I of the Technical Documentation.
- action (ActionCodeType) - optional
- Used for inheritance to indicate that the element being described is being added, updated, or deleted at the local level. Add: This element is added to the inherited structure. Update: This element is to be used in place of the inherited element with this ID for local processing. Delete: This element has been removed from the inherited group for local processing. There will be a new ID only in the case of Add.
- Extended Attributes
- version (NewVersionType) - optional
- Restricted string - numeric with optional decimal points.
- versionDate (BaseDateType) - optional
- Date of version. Duration should not be used in this field, even though allowed by the ISO format enforced by the parser.
- Extended Attributes
- Extended Content
- Sequence of:
- [Reference] (r:Label) - min. 0 - max. unbounded
- A short description of the interviewer instruction.
- AssociatedImage (xs:anyURI) - min. 0 - max. unbounded
- An image associated with the interviewer instruction, located at the provided URI.
- InstructionText (r:StructuredStringType) - min. 0 - max. unbounded
- This provides the textual content of the instruction.
InstrumentType: Structures the metadata describing a collection instrument used in the data collection.
- Content:
- Extends: r:MaintainableType
- Base Content
- Extends: AbstractMaintainableType
- Base Content
- Extends: AbstractVersionableType
- Base Content
- Extends: AbstractIdentifiableType
- Base Content
- Sequence of:
- [Reference] (Name) - min. 0 - max. unbounded
- Human-readable name given the entity being identified. May be repeated to provide language and/or geographic alternatives.
- Extended Content
- Sequence of:
- VersionResponsibility (xs:string) - min. 0
- Person and/or organization within the MaintenanceAgency responsible for the version change. This is primarily intended for internal use.
- [Reference] (VersionRationale) - min. 0 - max. unbounded
- Textual description of the rationale/purpose for a version change.
- Base Attributes
- id (BaseIDType) - required
- Assigned ID, unique within its maintainable object.
- urn (xs:anyURI) - optional
- DDI-structured URN of the element as described in Part I of the Technical Documentation.
- action (ActionCodeType) - optional
- Used for inheritance to indicate that the element being described is being added, updated, or deleted at the local level. Add: This element is added to the inherited structure. Update: This element is to be used in place of the inherited element with this ID for local processing. Delete: This element has been removed from the inherited group for local processing. There will be a new ID only in the case of Add.
- Extended Attributes
- version (NewVersionType) - optional
- Restricted string - numeric with optional decimal points.
- versionDate (BaseDateType) - optional
- Date of version. Duration should not be used in this field, even though allowed by the ISO format enforced by the parser.
- Extended Attributes
- agency (xs:NCName) - optional
- Maintaining agency as described in Part 1 of the Technical Specification.
- Extended Attributes
- Extended Content
- Sequence of:
- [Reference] (Type) - min. 0
- Describes the type of the instrument, according to the documentor's type classification.
- [Reference] (r:Software) - min. 0 - max. unbounded
- Describes a software package associated with the collection instrument.
- ExternalInstrumentLocation (xs:anyURI) - min. 0 - max. unbounded
- A reference to an external representation of the data collection instrument.
- [Reference] (ControlConstructReference) - min. 0
- A reference to the control construct that initiates the sequence of the instrument content.
ControlConstructSchemeType: A set of control constructs maintained by an agency, and used in the instrument.
- Content:
- Extends: r:MaintainableType
- Base Content
- Extends: AbstractMaintainableType
- Base Content
- Extends: AbstractVersionableType
- Base Content
- Extends: AbstractIdentifiableType
- Base Content
- Sequence of:
- [Reference] (Name) - min. 0 - max. unbounded
- Human-readable name given the entity being identified. May be repeated to provide language and/or geographic alternatives.
- Extended Content
- Sequence of:
- VersionResponsibility (xs:string) - min. 0
- Person and/or organization within the MaintenanceAgency responsible for the version change. This is primarily intended for internal use.
- [Reference] (VersionRationale) - min. 0 - max. unbounded
- Textual description of the rationale/purpose for a version change.
- Base Attributes
- id (BaseIDType) - required
- Assigned ID, unique within its maintainable object.
- urn (xs:anyURI) - optional
- DDI-structured URN of the element as described in Part I of the Technical Documentation.
- action (ActionCodeType) - optional
- Used for inheritance to indicate that the element being described is being added, updated, or deleted at the local level. Add: This element is added to the inherited structure. Update: This element is to be used in place of the inherited element with this ID for local processing. Delete: This element has been removed from the inherited group for local processing. There will be a new ID only in the case of Add.
- Extended Attributes
- version (NewVersionType) - optional
- Restricted string - numeric with optional decimal points.
- versionDate (BaseDateType) - optional
- Date of version. Duration should not be used in this field, even though allowed by the ISO format enforced by the parser.
- Extended Attributes
- agency (xs:NCName) - optional
- Maintaining agency as described in Part 1 of the Technical Specification.
- Extended Attributes
- Extended Content
- Sequence of:
- [Reference] (r:Label) - min. 0 - max. unbounded
- A short description of the Control Construct Scheme.
- [Reference] (r:Description) - min. 0 - max. unbounded
- A further human-readable description of the Control Construct Scheme.
- [Reference] (ControlConstructSchemeReference) - min. 0 - max. unbounded
- Provides for inclusion by reference of external Control Construct Schemes.
- [Reference] (ControlConstruct) - max. unbounded
- Extensible structure for control elements used in describing flow logic within the instrument.: IfThenElse, RepeatUntil, RepeatWhile, Loop, Sequence, ComputationItem, StatementItem, and QuestionConstruct.
ControlConstructType: [abstract] Provides the basic, extensible structure for control elements used in describing flow logic within the instrument. The only data point which is inherited by the extended constructs based on this type is the identification of the control construct.
- Content:
- Extends: r:VersionableType
- Base Content
- Extends: AbstractVersionableType
- Base Content
- Extends: AbstractIdentifiableType
- Base Content
- Sequence of:
- [Reference] (Name) - min. 0 - max. unbounded
- Human-readable name given the entity being identified. May be repeated to provide language and/or geographic alternatives.
- Extended Content
- Sequence of:
- VersionResponsibility (xs:string) - min. 0
- Person and/or organization within the MaintenanceAgency responsible for the version change. This is primarily intended for internal use.
- [Reference] (VersionRationale) - min. 0 - max. unbounded
- Textual description of the rationale/purpose for a version change.
- Base Attributes
- id (BaseIDType) - required
- Assigned ID, unique within its maintainable object.
- urn (xs:anyURI) - optional
- DDI-structured URN of the element as described in Part I of the Technical Documentation.
- action (ActionCodeType) - optional
- Used for inheritance to indicate that the element being described is being added, updated, or deleted at the local level. Add: This element is added to the inherited structure. Update: This element is to be used in place of the inherited element with this ID for local processing. Delete: This element has been removed from the inherited group for local processing. There will be a new ID only in the case of Add.
- Extended Attributes
- version (NewVersionType) - optional
- Restricted string - numeric with optional decimal points.
- versionDate (BaseDateType) - optional
- Date of version. Duration should not be used in this field, even though allowed by the ISO format enforced by the parser.
- Extended Attributes
- Extended Content
- Sequence of:
- [Reference] (ExternalAid) - min. 0 - max. unbounded
- A pointer to an exteral aid presented by the instrument such as a text card, image, audio, or audiovisual aid. Typically a URN. Use type attribute to describe the type of external aid provided. Example of terms to use would include: imageOnly audioOnly audioVisual multiMedia. ExternalAid will be be available each time the control construct is invoked. Care should be taken when placing an ExternalAid in RepeatWhile, RepeatUntil and Loop constructs as it will recure each time the conditional statement is checked. This does not include interviewer instructions, which are handled separately.
- Choice Of: - min. 0 - max. unbounded
IfThenElseType: Provides an if-then-else construct, so that if the stated condition is met, the Then clause is triggered, and otherwise the Else clause is triggered.
- Content:
- Extends: ControlConstructType
- Base Content
- Extends: r:VersionableType
- Base Content
- Extends: AbstractVersionableType
- Base Content
- Extends: AbstractIdentifiableType
- Base Content
- Sequence of:
- [Reference] (Name) - min. 0 - max. unbounded
- Human-readable name given the entity being identified. May be repeated to provide language and/or geographic alternatives.
- Extended Content
- Sequence of:
- VersionResponsibility (xs:string) - min. 0
- Person and/or organization within the MaintenanceAgency responsible for the version change. This is primarily intended for internal use.
- [Reference] (VersionRationale) - min. 0 - max. unbounded
- Textual description of the rationale/purpose for a version change.
- Base Attributes
- id (BaseIDType) - required
- Assigned ID, unique within its maintainable object.
- urn (xs:anyURI) - optional
- DDI-structured URN of the element as described in Part I of the Technical Documentation.
- action (ActionCodeType) - optional
- Used for inheritance to indicate that the element being described is being added, updated, or deleted at the local level. Add: This element is added to the inherited structure. Update: This element is to be used in place of the inherited element with this ID for local processing. Delete: This element has been removed from the inherited group for local processing. There will be a new ID only in the case of Add.
- Extended Attributes
- version (NewVersionType) - optional
- Restricted string - numeric with optional decimal points.
- versionDate (BaseDateType) - optional
- Date of version. Duration should not be used in this field, even though allowed by the ISO format enforced by the parser.
- Extended Attributes
- Extended Content
- Sequence of:
- [Reference] (ExternalAid) - min. 0 - max. unbounded
- A pointer to an exteral aid presented by the instrument such as a text card, image, audio, or audiovisual aid. Typically a URN. Use type attribute to describe the type of external aid provided. Example of terms to use would include: imageOnly audioOnly audioVisual multiMedia. ExternalAid will be be available each time the control construct is invoked. Care should be taken when placing an ExternalAid in RepeatWhile, RepeatUntil and Loop constructs as it will recure each time the conditional statement is checked. This does not include interviewer instructions, which are handled separately.
- Choice Of: - min. 0 - max. unbounded
- Extended Content
- Sequence of:
- [Reference] (IfCondition)
- The condition which must be met to trigger the Then clause, expressed as a Coding. The condition is an expression in the programming language used in the instrument.
- [Reference] (ThenConstructReference)
- Reference to the control construct which should be triggered if the associated condition is met.
- [Reference] (ElseConstructReference) - min. 0
- Reference to the control construct which is triggered if the associated condition is not met.
RepeatUntilType: Structures the control construct which allows a Coding to be repeated until a specified condition is met.
- Content:
- Extends: ControlConstructType
- Base Content
- Extends: r:VersionableType
- Base Content
- Extends: AbstractVersionableType
- Base Content
- Extends: AbstractIdentifiableType
- Base Content
- Sequence of:
- [Reference] (Name) - min. 0 - max. unbounded
- Human-readable name given the entity being identified. May be repeated to provide language and/or geographic alternatives.
- Extended Content
- Sequence of:
- VersionResponsibility (xs:string) - min. 0
- Person and/or organization within the MaintenanceAgency responsible for the version change. This is primarily intended for internal use.
- [Reference] (VersionRationale) - min. 0 - max. unbounded
- Textual description of the rationale/purpose for a version change.
- Base Attributes
- id (BaseIDType) - required
- Assigned ID, unique within its maintainable object.
- urn (xs:anyURI) - optional
- DDI-structured URN of the element as described in Part I of the Technical Documentation.
- action (ActionCodeType) - optional
- Used for inheritance to indicate that the element being described is being added, updated, or deleted at the local level. Add: This element is added to the inherited structure. Update: This element is to be used in place of the inherited element with this ID for local processing. Delete: This element has been removed from the inherited group for local processing. There will be a new ID only in the case of Add.
- Extended Attributes
- version (NewVersionType) - optional
- Restricted string - numeric with optional decimal points.
- versionDate (BaseDateType) - optional
- Date of version. Duration should not be used in this field, even though allowed by the ISO format enforced by the parser.
- Extended Attributes
- Extended Content
- Sequence of:
- [Reference] (ExternalAid) - min. 0 - max. unbounded
- A pointer to an exteral aid presented by the instrument such as a text card, image, audio, or audiovisual aid. Typically a URN. Use type attribute to describe the type of external aid provided. Example of terms to use would include: imageOnly audioOnly audioVisual multiMedia. ExternalAid will be be available each time the control construct is invoked. Care should be taken when placing an ExternalAid in RepeatWhile, RepeatUntil and Loop constructs as it will recure each time the conditional statement is checked. This does not include interviewer instructions, which are handled separately.
- Choice Of: - min. 0 - max. unbounded
- Extended Content
- Sequence of:
- [Reference] (UntilCondition)
- The condition which must be met to stop the repeated operation of the Coding in the associated UntilConstruct. The condition is an expression in the programming language used in the instrument.
- [Reference] (UntilConstructReference)
- Reference to the Coding which runs until the UntilCondition is met. When the operation ceases, the flow returns to the containing control construct.
RepeatWhileType: Structures a control construct which repeats while a specified condition is met. Before each iteration the condition is tested. When the condition is not met, control passes back to the containing control construct.
- Content:
- Extends: ControlConstructType
- Base Content
- Extends: r:VersionableType
- Base Content
- Extends: AbstractVersionableType
- Base Content
- Extends: AbstractIdentifiableType
- Base Content
- Sequence of:
- [Reference] (Name) - min. 0 - max. unbounded
- Human-readable name given the entity being identified. May be repeated to provide language and/or geographic alternatives.
- Extended Content
- Sequence of:
- VersionResponsibility (xs:string) - min. 0
- Person and/or organization within the MaintenanceAgency responsible for the version change. This is primarily intended for internal use.
- [Reference] (VersionRationale) - min. 0 - max. unbounded
- Textual description of the rationale/purpose for a version change.
- Base Attributes
- id (BaseIDType) - required
- Assigned ID, unique within its maintainable object.
- urn (xs:anyURI) - optional
- DDI-structured URN of the element as described in Part I of the Technical Documentation.
- action (ActionCodeType) - optional
- Used for inheritance to indicate that the element being described is being added, updated, or deleted at the local level. Add: This element is added to the inherited structure. Update: This element is to be used in place of the inherited element with this ID for local processing. Delete: This element has been removed from the inherited group for local processing. There will be a new ID only in the case of Add.
- Extended Attributes
- version (NewVersionType) - optional
- Restricted string - numeric with optional decimal points.
- versionDate (BaseDateType) - optional
- Date of version. Duration should not be used in this field, even though allowed by the ISO format enforced by the parser.
- Extended Attributes
- Extended Content
- Sequence of:
- [Reference] (ExternalAid) - min. 0 - max. unbounded
- A pointer to an exteral aid presented by the instrument such as a text card, image, audio, or audiovisual aid. Typically a URN. Use type attribute to describe the type of external aid provided. Example of terms to use would include: imageOnly audioOnly audioVisual multiMedia. ExternalAid will be be available each time the control construct is invoked. Care should be taken when placing an ExternalAid in RepeatWhile, RepeatUntil and Loop constructs as it will recure each time the conditional statement is checked. This does not include interviewer instructions, which are handled separately.
- Choice Of: - min. 0 - max. unbounded
- Extended Content
- Sequence of:
- [Reference] (WhileCondition)
- The condition which must be met to trigger the operation of the associated Coding.
- [Reference] (WhileConstructReference)
- Reference to the Coding which is to be run when the associated condition has been met.
LoopType: Structures a control construct which loops until a limiting condition is met. The ControlConstruct contained in the Loop operates on the LoopVariable until the LoopWhile condition is met, and then control is handed back to the containing control construct.
- Content:
- Extends: ControlConstructType
- Base Content
- Extends: r:VersionableType
- Base Content
- Extends: AbstractVersionableType
- Base Content
- Extends: AbstractIdentifiableType
- Base Content
- Sequence of:
- [Reference] (Name) - min. 0 - max. unbounded
- Human-readable name given the entity being identified. May be repeated to provide language and/or geographic alternatives.
- Extended Content
- Sequence of:
- VersionResponsibility (xs:string) - min. 0
- Person and/or organization within the MaintenanceAgency responsible for the version change. This is primarily intended for internal use.
- [Reference] (VersionRationale) - min. 0 - max. unbounded
- Textual description of the rationale/purpose for a version change.
- Base Attributes
- id (BaseIDType) - required
- Assigned ID, unique within its maintainable object.
- urn (xs:anyURI) - optional
- DDI-structured URN of the element as described in Part I of the Technical Documentation.
- action (ActionCodeType) - optional
- Used for inheritance to indicate that the element being described is being added, updated, or deleted at the local level. Add: This element is added to the inherited structure. Update: This element is to be used in place of the inherited element with this ID for local processing. Delete: This element has been removed from the inherited group for local processing. There will be a new ID only in the case of Add.
- Extended Attributes
- version (NewVersionType) - optional
- Restricted string - numeric with optional decimal points.
- versionDate (BaseDateType) - optional
- Date of version. Duration should not be used in this field, even though allowed by the ISO format enforced by the parser.
- Extended Attributes
- Extended Content
- Sequence of:
- [Reference] (ExternalAid) - min. 0 - max. unbounded
- A pointer to an exteral aid presented by the instrument such as a text card, image, audio, or audiovisual aid. Typically a URN. Use type attribute to describe the type of external aid provided. Example of terms to use would include: imageOnly audioOnly audioVisual multiMedia. ExternalAid will be be available each time the control construct is invoked. Care should be taken when placing an ExternalAid in RepeatWhile, RepeatUntil and Loop constructs as it will recure each time the conditional statement is checked. This does not include interviewer instructions, which are handled separately.
- Choice Of: - min. 0 - max. unbounded
- Extended Content
- Sequence of:
- [Reference] (LoopVariableReference) - min. 0
- A reference to the variable (as used in the associated Codings) which is incremented or otherwise manipulated to meet the conditions stated in the LoopWhile condition.
- [Reference] (InitialValue) - min. 0
- The initial value to which the LoopVariable is set.
- [Reference] (LoopWhile)
- The condition which must be met for the Loop's functioning to cease; when this condition is met, control is handed back to the containing control construct.
- [Reference] (StepValue) - min. 0
- A Coding which is used to manipulate the LoopVariable after each iteration of the Loop's associated ControlConstruct element.
- [Reference] (ControlConstructReference) - min. 0 - max. unbounded
SequenceType: A sequence of operations expressed as control constructs performed by the instrument.
- Content:
- Extends: ControlConstructType
- Base Content
- Extends: r:VersionableType
- Base Content
- Extends: AbstractVersionableType
- Base Content
- Extends: AbstractIdentifiableType
- Base Content
- Sequence of:
- [Reference] (Name) - min. 0 - max. unbounded
- Human-readable name given the entity being identified. May be repeated to provide language and/or geographic alternatives.
- Extended Content
- Sequence of:
- VersionResponsibility (xs:string) - min. 0
- Person and/or organization within the MaintenanceAgency responsible for the version change. This is primarily intended for internal use.
- [Reference] (VersionRationale) - min. 0 - max. unbounded
- Textual description of the rationale/purpose for a version change.
- Base Attributes
- id (BaseIDType) - required
- Assigned ID, unique within its maintainable object.
- urn (xs:anyURI) - optional
- DDI-structured URN of the element as described in Part I of the Technical Documentation.
- action (ActionCodeType) - optional
- Used for inheritance to indicate that the element being described is being added, updated, or deleted at the local level. Add: This element is added to the inherited structure. Update: This element is to be used in place of the inherited element with this ID for local processing. Delete: This element has been removed from the inherited group for local processing. There will be a new ID only in the case of Add.
- Extended Attributes
- version (NewVersionType) - optional
- Restricted string - numeric with optional decimal points.
- versionDate (BaseDateType) - optional
- Date of version. Duration should not be used in this field, even though allowed by the ISO format enforced by the parser.
- Extended Attributes
- Extended Content
- Sequence of:
- [Reference] (ExternalAid) - min. 0 - max. unbounded
- A pointer to an exteral aid presented by the instrument such as a text card, image, audio, or audiovisual aid. Typically a URN. Use type attribute to describe the type of external aid provided. Example of terms to use would include: imageOnly audioOnly audioVisual multiMedia. ExternalAid will be be available each time the control construct is invoked. Care should be taken when placing an ExternalAid in RepeatWhile, RepeatUntil and Loop constructs as it will recure each time the conditional statement is checked. This does not include interviewer instructions, which are handled separately.
- Choice Of: - min. 0 - max. unbounded
- Extended Content
- Sequence of:
- [Reference] (Type) - min. 0
- Used to assign a type to the control construct within the Sequence, according to a classification used by the Documentor.
- [Reference] (ControlConstructReference) - min. 0 - max. unbounded
- References control constructs in the order that they should appear within the instrument.
- [Reference] (ConstructSequence) - min. 0
- If you are going to set the sequence to anything other than order of appearance the only allowable children are QuestionConstruct or Sequence. Contents must be randomizable.
ComputationItemType:
- Content:
- Extends: ControlConstructType
- Base Content
- Extends: r:VersionableType
- Base Content
- Extends: AbstractVersionableType
- Base Content
- Extends: AbstractIdentifiableType
- Base Content
- Sequence of:
- [Reference] (Name) - min. 0 - max. unbounded
- Human-readable name given the entity being identified. May be repeated to provide language and/or geographic alternatives.
- Extended Content
- Sequence of:
- VersionResponsibility (xs:string) - min. 0
- Person and/or organization within the MaintenanceAgency responsible for the version change. This is primarily intended for internal use.
- [Reference] (VersionRationale) - min. 0 - max. unbounded
- Textual description of the rationale/purpose for a version change.
- Base Attributes
- id (BaseIDType) - required
- Assigned ID, unique within its maintainable object.
- urn (xs:anyURI) - optional
- DDI-structured URN of the element as described in Part I of the Technical Documentation.
- action (ActionCodeType) - optional
- Used for inheritance to indicate that the element being described is being added, updated, or deleted at the local level. Add: This element is added to the inherited structure. Update: This element is to be used in place of the inherited element with this ID for local processing. Delete: This element has been removed from the inherited group for local processing. There will be a new ID only in the case of Add.
- Extended Attributes
- version (NewVersionType) - optional
- Restricted string - numeric with optional decimal points.
- versionDate (BaseDateType) - optional
- Date of version. Duration should not be used in this field, even though allowed by the ISO format enforced by the parser.
- Extended Attributes
- Extended Content
- Sequence of:
- [Reference] (ExternalAid) - min. 0 - max. unbounded
- A pointer to an exteral aid presented by the instrument such as a text card, image, audio, or audiovisual aid. Typically a URN. Use type attribute to describe the type of external aid provided. Example of terms to use would include: imageOnly audioOnly audioVisual multiMedia. ExternalAid will be be available each time the control construct is invoked. Care should be taken when placing an ExternalAid in RepeatWhile, RepeatUntil and Loop constructs as it will recure each time the conditional statement is checked. This does not include interviewer instructions, which are handled separately.
- Choice Of: - min. 0 - max. unbounded
- Extended Content
- Sequence of:
- [Reference] (Code)
- The Code which contains the value of the variable in programming terms.
- [Reference] (AssignedVariableReference) - min. 0
- A reference to a variable to which the associated value in the Code element is assigned.
StatementItemType: A textual statement used in the Instrument.
- Content:
- Extends: ControlConstructType
- Base Content
- Extends: r:VersionableType
- Base Content
- Extends: AbstractVersionableType
- Base Content
- Extends: AbstractIdentifiableType
- Base Content
- Sequence of:
- [Reference] (Name) - min. 0 - max. unbounded
- Human-readable name given the entity being identified. May be repeated to provide language and/or geographic alternatives.
- Extended Content
- Sequence of:
- VersionResponsibility (xs:string) - min. 0
- Person and/or organization within the MaintenanceAgency responsible for the version change. This is primarily intended for internal use.
- [Reference] (VersionRationale) - min. 0 - max. unbounded
- Textual description of the rationale/purpose for a version change.
- Base Attributes
- id (BaseIDType) - required
- Assigned ID, unique within its maintainable object.
- urn (xs:anyURI) - optional
- DDI-structured URN of the element as described in Part I of the Technical Documentation.
- action (ActionCodeType) - optional
- Used for inheritance to indicate that the element being described is being added, updated, or deleted at the local level. Add: This element is added to the inherited structure. Update: This element is to be used in place of the inherited element with this ID for local processing. Delete: This element has been removed from the inherited group for local processing. There will be a new ID only in the case of Add.
- Extended Attributes
- version (NewVersionType) - optional
- Restricted string - numeric with optional decimal points.
- versionDate (BaseDateType) - optional
- Date of version. Duration should not be used in this field, even though allowed by the ISO format enforced by the parser.
- Extended Attributes
- Extended Content
- Sequence of:
- [Reference] (ExternalAid) - min. 0 - max. unbounded
- A pointer to an exteral aid presented by the instrument such as a text card, image, audio, or audiovisual aid. Typically a URN. Use type attribute to describe the type of external aid provided. Example of terms to use would include: imageOnly audioOnly audioVisual multiMedia. ExternalAid will be be available each time the control construct is invoked. Care should be taken when placing an ExternalAid in RepeatWhile, RepeatUntil and Loop constructs as it will recure each time the conditional statement is checked. This does not include interviewer instructions, which are handled separately.
- Choice Of: - min. 0 - max. unbounded
- Extended Content
- Sequence of:
- [Reference] (DisplayText)
- The string to be displayed in the instrument.
- [Reference] (r:Description) - min. 0 - max. unbounded
- A description of the string's purpose within the instrument.
DynamicTextType: Structures the behavior of dynamic or static text within the instrument.
- Content:
- Sequence of:
- [Reference] (Text) - max. unbounded
- The element containing the text. It is never used directly, but is always replaced by one of the derived elements in the substitution group for which the Text elements acts as the head.
- Attributes:
TextType: [abstract] Provides a structure to be inherited by derivation for elements belonging to the substitution group of which the Text element is the head.
- Content:
- Sequence of:
- [Reference] (r:Description) - min. 0 - max. unbounded
- A description of the text element.
LiteralTextType: Literal (static) text to be used in the instrument.
- Content:
- Extends: TextType
- Base Content
- Sequence of:
- [Reference] (r:Description) - min. 0 - max. unbounded
- A description of the text element.
- Extended Content
- Sequence of:
- Text (xs:string)
- The value of the static text string.
ConditionalTextType: Text which has a changeable value, based on a condition expressed in Code.
- Content:
- Extends: TextType
- Base Content
- Sequence of:
- [Reference] (r:Description) - min. 0 - max. unbounded
- A description of the text element.
- Extended Content
- Sequence of:
- [Reference] (Expression)
- The condition on which the associated text varies.
QuestionSchemeType: A set of questions maintained by an agency, and used in the instrument.
- Content:
- Extends: r:MaintainableType
- Base Content
- Extends: AbstractMaintainableType
- Base Content
- Extends: AbstractVersionableType
- Base Content
- Extends: AbstractIdentifiableType
- Base Content
- Sequence of:
- [Reference] (Name) - min. 0 - max. unbounded
- Human-readable name given the entity being identified. May be repeated to provide language and/or geographic alternatives.
- Extended Content
- Sequence of:
- VersionResponsibility (xs:string) - min. 0
- Person and/or organization within the MaintenanceAgency responsible for the version change. This is primarily intended for internal use.
- [Reference] (VersionRationale) - min. 0 - max. unbounded
- Textual description of the rationale/purpose for a version change.
- Base Attributes
- id (BaseIDType) - required
- Assigned ID, unique within its maintainable object.
- urn (xs:anyURI) - optional
- DDI-structured URN of the element as described in Part I of the Technical Documentation.
- action (ActionCodeType) - optional
- Used for inheritance to indicate that the element being described is being added, updated, or deleted at the local level. Add: This element is added to the inherited structure. Update: This element is to be used in place of the inherited element with this ID for local processing. Delete: This element has been removed from the inherited group for local processing. There will be a new ID only in the case of Add.
- Extended Attributes
- version (NewVersionType) - optional
- Restricted string - numeric with optional decimal points.
- versionDate (BaseDateType) - optional
- Date of version. Duration should not be used in this field, even though allowed by the ISO format enforced by the parser.
- Extended Attributes
- agency (xs:NCName) - optional
- Maintaining agency as described in Part 1 of the Technical Specification.
- Extended Attributes
- Extended Content
- Sequence of:
- [Reference] (r:Label) - min. 0 - max. unbounded
- A short description of the question scheme.
- [Reference] (r:Description) - min. 0 - max. unbounded
- A description of the use of the question scheme.
- [Reference] (QuestionSchemeReference) - min. 0 - max. unbounded
- Provides for inclusion by reference of external question schemes.
- Choice Of: - max. unbounded
- [Reference] (QuestionItem)
- An item (that is, a question) belonging to the Question Scheme.
- [Reference] (MultipleQuestionItem)
- An item (that is, a question) belonging to the Question Scheme.
QuestionItemType: Structures the QuestionItem, and provides a structure inherited by other derived question item types.
- Content:
- Extends: r:VersionableType
- Base Content
- Extends: AbstractVersionableType
- Base Content
- Extends: AbstractIdentifiableType
- Base Content
- Sequence of:
- [Reference] (Name) - min. 0 - max. unbounded
- Human-readable name given the entity being identified. May be repeated to provide language and/or geographic alternatives.
- Extended Content
- Sequence of:
- VersionResponsibility (xs:string) - min. 0
- Person and/or organization within the MaintenanceAgency responsible for the version change. This is primarily intended for internal use.
- [Reference] (VersionRationale) - min. 0 - max. unbounded
- Textual description of the rationale/purpose for a version change.
- Base Attributes
- id (BaseIDType) - required
- Assigned ID, unique within its maintainable object.
- urn (xs:anyURI) - optional
- DDI-structured URN of the element as described in Part I of the Technical Documentation.
- action (ActionCodeType) - optional
- Used for inheritance to indicate that the element being described is being added, updated, or deleted at the local level. Add: This element is added to the inherited structure. Update: This element is to be used in place of the inherited element with this ID for local processing. Delete: This element has been removed from the inherited group for local processing. There will be a new ID only in the case of Add.
- Extended Attributes
- version (NewVersionType) - optional
- Restricted string - numeric with optional decimal points.
- versionDate (BaseDateType) - optional
- Date of version. Duration should not be used in this field, even though allowed by the ISO format enforced by the parser.
- Extended Attributes
- Extended Content
- Sequence of:
- [Reference] (QuestionText) - min. 0 - max. unbounded
- The text of the question presented in the instrument. this can occur multiple times for multi lingual questions.
- [Reference] (QuestionIntent) - min. 0 - max. unbounded
- The purpose of the question vis-a-vis the data being collected.
- Choice Of:
- [Reference] (ResponseDomain)
- Contains a response domain for the question. Typically used to describe simple response domains (textual, numeric, etc.)
- [Reference] (StructuredMixedResponseDomain)
- Contains a response domain for the question. Typically used to describe simple response domains (textual, numeric, etc.)
- [Reference] (ConceptReference) - min. 0 - max. unbounded
- A reference to the concept associated with the response to the question.
- [Reference] (ExternalAid) - min. 0 - max. unbounded
- A pointer to an exteral aid presented by the instrument such as a text card, image, audio, or audiovisual aid. Typically a URN. Use type attribute to describe the type of external aid provided. Example of terms to use would include: imageOnly audioOnly audioVisual multiMedia.
StructuredMixedResponseDomainType: ResponseDomains should be chosen that do NOT duplicate responses such as CodeSchemes with overlapping codes. Be aware that certain instruments may collect responses in such a way that confusion between a code response and text response may be possible. The process of resolving such conflicts should be addressed in the data processing instructions. There is an assumption that if a text or numeric response duplicates a coded response to a question, that the value is that of the coded category. At least one ResponseDomain must be provided.
- Content:
- Choice Of: - min. 2 - max. unbounded
MultipleQuestionItemType: Structures a multiple-question question item.
- Content:
- Extends: r:VersionableType
- Base Content
- Extends: AbstractVersionableType
- Base Content
- Extends: AbstractIdentifiableType
- Base Content
- Sequence of:
- [Reference] (Name) - min. 0 - max. unbounded
- Human-readable name given the entity being identified. May be repeated to provide language and/or geographic alternatives.
- Extended Content
- Sequence of:
- VersionResponsibility (xs:string) - min. 0
- Person and/or organization within the MaintenanceAgency responsible for the version change. This is primarily intended for internal use.
- [Reference] (VersionRationale) - min. 0 - max. unbounded
- Textual description of the rationale/purpose for a version change.
- Base Attributes
- id (BaseIDType) - required
- Assigned ID, unique within its maintainable object.
- urn (xs:anyURI) - optional
- DDI-structured URN of the element as described in Part I of the Technical Documentation.
- action (ActionCodeType) - optional
- Used for inheritance to indicate that the element being described is being added, updated, or deleted at the local level. Add: This element is added to the inherited structure. Update: This element is to be used in place of the inherited element with this ID for local processing. Delete: This element has been removed from the inherited group for local processing. There will be a new ID only in the case of Add.
- Extended Attributes
- version (NewVersionType) - optional
- Restricted string - numeric with optional decimal points.
- versionDate (BaseDateType) - optional
- Date of version. Duration should not be used in this field, even though allowed by the ISO format enforced by the parser.
- Extended Attributes
- Extended Content
- Sequence of:
- [Reference] (QuestionText) - min. 0 - max. unbounded
- The text of the top-level question presented in the instrument. This can occur multiple times for multi lingual questions.
- [Reference] (QuestionIntent) - min. 0 - max. unbounded
- The purpose of the question vis-a-vis the data being collected.
- [Reference] (ConceptReference) - min. 0 - max. unbounded
- A reference to the concept associated with the response to the question.
- [Reference] (ExternalAid) - min. 0 - max. unbounded
- A pointer to an exteral aid presented by the instrument such as a text card, image, audio, or audiovisual aid. Typically a URN. Use type attribute to describe the type of external aid provided. Example of terms to use would include: imageOnly audioOnly audioVisual multiMedia.
- [Reference] (SubQuestionSequence) - min. 0
- Prescribes the order in which the sub-questions should appear.
- [Reference] (SubQuestions)
- A group of question items forming a group of sub-questions.
QuestionGroupType: Structures a group of question items.
- Content:
- Sequence of:
- Choice Of: - max. unbounded
- [Reference] (QuestionItem)
- A reference to a question item within the group.
- [Reference] (MultipleQuestionItem)
- A reference to a multiple question item within the group.
QuestionConstructType: Structures the construct which ties together questions and the programmatic logic of the control constructs.
- Content:
- Extends: ControlConstructType
- Base Content
- Extends: r:VersionableType
- Base Content
- Extends: AbstractVersionableType
- Base Content
- Extends: AbstractIdentifiableType
- Base Content
- Sequence of:
- [Reference] (Name) - min. 0 - max. unbounded
- Human-readable name given the entity being identified. May be repeated to provide language and/or geographic alternatives.
- Extended Content
- Sequence of:
- VersionResponsibility (xs:string) - min. 0
- Person and/or organization within the MaintenanceAgency responsible for the version change. This is primarily intended for internal use.
- [Reference] (VersionRationale) - min. 0 - max. unbounded
- Textual description of the rationale/purpose for a version change.
- Base Attributes
- id (BaseIDType) - required
- Assigned ID, unique within its maintainable object.
- urn (xs:anyURI) - optional
- DDI-structured URN of the element as described in Part I of the Technical Documentation.
- action (ActionCodeType) - optional
- Used for inheritance to indicate that the element being described is being added, updated, or deleted at the local level. Add: This element is added to the inherited structure. Update: This element is to be used in place of the inherited element with this ID for local processing. Delete: This element has been removed from the inherited group for local processing. There will be a new ID only in the case of Add.
- Extended Attributes
- version (NewVersionType) - optional
- Restricted string - numeric with optional decimal points.
- versionDate (BaseDateType) - optional
- Date of version. Duration should not be used in this field, even though allowed by the ISO format enforced by the parser.
- Extended Attributes
- Extended Content
- Sequence of:
- [Reference] (ExternalAid) - min. 0 - max. unbounded
- A pointer to an exteral aid presented by the instrument such as a text card, image, audio, or audiovisual aid. Typically a URN. Use type attribute to describe the type of external aid provided. Example of terms to use would include: imageOnly audioOnly audioVisual multiMedia. ExternalAid will be be available each time the control construct is invoked. Care should be taken when placing an ExternalAid in RepeatWhile, RepeatUntil and Loop constructs as it will recure each time the conditional statement is checked. This does not include interviewer instructions, which are handled separately.
- Choice Of: - min. 0 - max. unbounded
- Extended Content
- Sequence of:
- [Reference] (QuestionReference)
- A reference to a question.
- [Reference] (ResponseSequence) - min. 0
- Describes the sequencing of the response categories or response options to a question
- [Reference] (ResponseUnit) - min. 0 - max. unbounded
- [Reference] (r:AnalysisUnit) - min. 0 - max. unbounded
- The analysis unit, expressed as a term which may come from a controlled vocabulary.
- [Reference] (r:UniverseReference) - min. 0 - max. unbounded
- Reference to the description of the persons or other elements that are the object of the research and to which any analytic results refer.
DateTimeDomainType: Structures the response domain for a Date, Time, or DateTime response.
- Content:
- Extends: r:DateTimeRepresentationType
- Base Content
- Extends: RepresentationType
- Base Content
- Sequence of:
- RecommendedDataType (CodeValueType) - min. 0
- This field provides the recommended treatment of the data within an application. The value should come from a controlled vocabulary - recommended values include the set found in W3C XML Schema Part 2, but excluding string sub-types, QNAME, and NOTATION.
- GenericOutputFormat (CodeValueType) - min. 0
- This field provides a recommended generic treatment of the data for display by an application. The value should come from a controlled vocabulary.
- Base Attributes
- missingValue (xs:NMTOKENS) - optional
- List the values used to represent missing data in a space delimited array.
- blankIsMissingValue (xs:boolean) - optional
- When value is true a blank or empty variable content should be treated as a missing value.
- classificationLevel (CategoryRelationCodeType) - optional
- Indicates the type of relationship, nominal, ordinal, interval, ratio, or continuous.
- Extended Attributes
- type (DateTypeCodeType) - required
- Value of the date type selected from a controlled vocabulary.
- format (xs:string) - optional
- Describes the format of the date field, in formats such as YYYY/MM or MM-DD-YY, etc. If this attribute is omitted, then the format is assumed to be the XML Schema format corresponding to the type attribute value.
- Extended Content
- Sequence of:
- [Reference] (Label) - min. 0 - max. unbounded
- Label for the response domain as a human-readable string.
- [Reference] (r:Description) - min. 0 - max. unbounded
- A human-readable description of the response domain.
NumericDomainType: Structures the response domain for a numeric response. May be a range or specific value, or a list of ranges.
- Content:
- Extends: r:NumericRepresentationType
- Base Content
- Extends: RepresentationType
- Base Content
- Sequence of:
- RecommendedDataType (CodeValueType) - min. 0
- This field provides the recommended treatment of the data within an application. The value should come from a controlled vocabulary - recommended values include the set found in W3C XML Schema Part 2, but excluding string sub-types, QNAME, and NOTATION.
- GenericOutputFormat (CodeValueType) - min. 0
- This field provides a recommended generic treatment of the data for display by an application. The value should come from a controlled vocabulary.
- Extended Content
- Base Attributes
- missingValue (xs:NMTOKENS) - optional
- List the values used to represent missing data in a space delimited array.
- blankIsMissingValue (xs:boolean) - optional
- When value is true a blank or empty variable content should be treated as a missing value.
- classificationLevel (CategoryRelationCodeType) - optional
- Indicates the type of relationship, nominal, ordinal, interval, ratio, or continuous.
- Extended Attributes
- type (NumericTypeCodeType) - required
- The type attribute is used by the documentor to describe the numeric response domain.
- scale (xs:integer) - optional
- Records unit of scale, for example 'x1', 'x1000'.
- decimalPositions (xs:integer) - optional
- Refers to the number of decimal places in the variable.
- startValue (xs:double) - optional
- Start, or seed, value for an incremental numeric representation.
- endValue (xs:double) - optional
- End value for a incremental numeric representation.
- interval (xs:double) - optional
- Value to increase, or step value for a incremental numeric representation.
- Extended Content
- Sequence of:
- [Reference] (Label) - min. 0 - max. unbounded
- Label for the response domain as a human-readable string.
- [Reference] (r:Description) - min. 0 - max. unbounded
- A human-readable description of the response domain.
CodeDomainType: Describes a coded response domain.
- Content:
- Extends: r:CodeRepresentationType
- Base Content
- Extends: RepresentationType
- Base Content
- Sequence of:
- RecommendedDataType (CodeValueType) - min. 0
- This field provides the recommended treatment of the data within an application. The value should come from a controlled vocabulary - recommended values include the set found in W3C XML Schema Part 2, but excluding string sub-types, QNAME, and NOTATION.
- GenericOutputFormat (CodeValueType) - min. 0
- This field provides a recommended generic treatment of the data for display by an application. The value should come from a controlled vocabulary.
- Extended Content
- Sequence of:
- [Reference] (CodeSchemeReference) - min. 0 - max. unbounded
- A reference to a code scheme containing the valid response values..
- Base Attributes
- missingValue (xs:NMTOKENS) - optional
- List the values used to represent missing data in a space delimited array.
- blankIsMissingValue (xs:boolean) - optional
- When value is true a blank or empty variable content should be treated as a missing value.
- classificationLevel (CategoryRelationCodeType) - optional
- Indicates the type of relationship, nominal, ordinal, interval, ratio, or continuous.
- Extended Content
- Sequence of:
- [Reference] (Label) - min. 0 - max. unbounded
- Label for the response domain as a human-readable string.
- [Reference] (r:Description) - min. 0 - max. unbounded
- A human-readable description of the response domain.
CategoryDomainType: Structures a response domain based on categorization.
- Content:
- Extends: r:CategoryRepresentationType
- Base Content
- Extends: RepresentationType
- Base Content
- Sequence of:
- RecommendedDataType (CodeValueType) - min. 0
- This field provides the recommended treatment of the data within an application. The value should come from a controlled vocabulary - recommended values include the set found in W3C XML Schema Part 2, but excluding string sub-types, QNAME, and NOTATION.
- GenericOutputFormat (CodeValueType) - min. 0
- This field provides a recommended generic treatment of the data for display by an application. The value should come from a controlled vocabulary.
- Extended Content
- Sequence of:
- [Reference] (CategorySchemeReference) - min. 0 - max. unbounded
- A reference to a category scheme describing the representation.
- Base Attributes
- missingValue (xs:NMTOKENS) - optional
- List the values used to represent missing data in a space delimited array.
- blankIsMissingValue (xs:boolean) - optional
- When value is true a blank or empty variable content should be treated as a missing value.
- classificationLevel (CategoryRelationCodeType) - optional
- Indicates the type of relationship, nominal, ordinal, interval, ratio, or continuous.
- Extended Content
- Sequence of:
- [Reference] (Label) - min. 0 - max. unbounded
- Label for the response domain as a human-readable string.
- [Reference] (r:Description) - min. 0 - max. unbounded
- A human-readable description of the response domain.
GeographicDomainType: Structures the response domain for a geographic point to ensure collection of relevant information. The point may be associated with a polygon (such as the centroid of the polygon) or a line (end or shape points of a line).
- Content:
- Extends: r:GeographicRepresentationType
- Base Content
- Extends: RepresentationType
- Base Content
- Sequence of:
- RecommendedDataType (CodeValueType) - min. 0
- This field provides the recommended treatment of the data within an application. The value should come from a controlled vocabulary - recommended values include the set found in W3C XML Schema Part 2, but excluding string sub-types, QNAME, and NOTATION.
- GenericOutputFormat (CodeValueType) - min. 0
- This field provides a recommended generic treatment of the data for display by an application. The value should come from a controlled vocabulary.
- Extended Content
- Sequence of:
- Datum (xs:NCName)
- The type of datum being recorded.
- CoordinateSystem (xs:string)
- The precision of the numeric response to be applied by default to the responses, expressed as an integer indicating the number of decimal places to the right of the decimal separator.
- CoordinateZone (xs:string) - min. 0
- CoordinateSource (xs:string)
- Source of the coordinate such as GPS, address mapping, or map interpretation.
- ErrorCorrection (xs:string)
- Type of error correction employed. For example point averaging, WAAS, etc. If none, state none.
- Offset (xs:string)
- GeoreferencedObject (xs:string)
- This could be a household, village centroid, etc.
- AddressMatchType (xs:string) - min. 0
- Use for address match coordinates only. Example: street segment match, ZIPcode centroid, etc.
- [Reference] (CoordinatePairs) - max. unbounded
- Field to capture coordinate pairs as individual pairs or as an array of pairs.
- [Reference] (AlternateOffset) - min. 0
- Allows entry of a non-standard offset figure.
- [Reference] (AlternateObject) - min. 0
- Allows identification of an alternate object when the default object is not measureable.
- [Reference] (AlternateCoordinateSystem) - min. 0
- Allows collection of data for a case in a different coordinate system than stated in the response structure.
- Base Attributes
- missingValue (xs:NMTOKENS) - optional
- List the values used to represent missing data in a space delimited array.
- blankIsMissingValue (xs:boolean) - optional
- When value is true a blank or empty variable content should be treated as a missing value.
- classificationLevel (CategoryRelationCodeType) - optional
- Indicates the type of relationship, nominal, ordinal, interval, ratio, or continuous.
- Extended Attributes
- format (PointFormatType) - required
- The type attribute is used by the documentor to describe the numeric response domain.
- spatialPrimitive (GeographicDescriptionCodeType) - required
- Indicates the spatial primitive object which the point references.
- Extended Content
- Sequence of:
- [Reference] (Label) - min. 0 - max. unbounded
- Label for the response domain as a human-readable string.
- [Reference] (r:Description) - min. 0 - max. unbounded
- A human-readable description of the response domain.
ExternalInterviewerInstructionReferenceType: External reference to an interviewer instruction not expressed as DDI XML.
- Content:
- Extends: r:OtherMaterialType
- Base Content
- Sequence of:
- [Reference] (Citation)
- Bibliographic citation for the external resource.
- ExternalURLReference (xs:anyURI) - min. 0
- Contains a URL which indicates the location of the cited external resource.
- ExternalURNReference (xs:anyURI) - min. 0
- Contains a URN which identifies the cited external resource.
- [Reference] (Relationship) - min. 0 - max. unbounded
- Reference to the item within the DDI Instance to which the external resource is related.
- MIMEType (xs:string) - min. 0
- Provides a standard Internet MIME type for use by processing applications.
- Base Attributes
- type (xs:string) - required
- Specifies the type of material.
- Extended Attributes
InterviewerInstructionReferenceType: Reference to an interviewer instruction expressed as DDI XML.
- Content:
- Extends: r:ReferenceType
- Base Content
- Sequence of:
- [Reference] (Module) - min. 0
- References the module of the entity that is being referenced, in cases where there have been local modifications.
- [Reference] (Scheme) - min. 0
- Containing scheme of the entity that is being referenced.
- Choice Of: - max. 2
- [Reference] (URN)
- URN of the entity that is being referenced.
- Sequence of:
- [Reference] (ID)
- ID of the entity that is being referenced.
- IdentifyingAgency (xs:NCName) - min. 0
- Maintaining agency as described in Part 1 of the Technical Specification.
- [Reference] (Version) - min. 0
- If referencing a versioned or maintained element you must include Version. The version can be identified as lateBound, meaning that the latest version should be used.
- Base Attributes
- isExternal (xs:boolean) - default: false
- Indicates that the reference is made to an external source. If the value is true, then a URI must be provided.
- URI (xs:anyURI) - optional
- URI identifying the location of an external reference.
- isReference (xs:boolean) - fixed: true
- A fixed attribute value identifying which elements are references.
- lateBound (xs:boolean) - default: false
- Extended Attributes
SpecificSequenceType: Describes the ordering of questions when not otherwise indicated. There are a set number of values for QuestionSequenceType, but also a provision for describing an alternate ordering using a command language.
Simple Types
QuestionSequenceTypeType: Describes the types of sequences of questions.
- Restricts: xs:string
- Code: InOrderOfAppearance -
In the order of appearance per the DDI instance, for each use.
- Code: Random -
Randomly resorts sequence for each use.
- Code: Rotate -
Rotates order of sequence for each use where first use is 1 2 3 4, second use is 2 3 4 1, third use is 3 4 1 2 etc.
- Code: Other -
Any other means of reordering sequence. When value is Other, AlterativeSequenceType must be specified to describe the resequencing process.
This documentation is extracted from the inline documentation of DDI 3.0 XML Schema and is licensed under the terms of the GNU General Public License as the schema itself.