DateTimeDomainType

A response domain capturing a date or time response for a question item. Contains the equivalent content of a DateTimeRepresentation including the format of the date field, a DateTypeCode, and restriction of content using a regular expression. Adds a set of elements available to all Response Domains; Label, Description, OutParameter, designation of response cardinality, and a declaration of an offset date for the data content. Has an equivalent DateTimeDomainReference which references a ManagedTextRepresentation.

Properties

Name

Type

Description

Label

LabelType

0..n

A display label for the domain. Supports multiple language versions of the same content as well as optional formatting of the content. Repeat for labels with different content, for example, labels with differing length limitations.

Description

StructuredStringType

0..1

A description of the content and purpose of the domain. Supports multiple language versions of the same content as well as optional formatting of the content.

OutParameter

ParameterType

0..1

Allows for the response to be bound to one of the QuestionItem’s OutParameters, so the collected information can be used elsewhere, for example as inputs to subsequent questions in an Instrument or to a GenerationInstruction. If multiple responses are possible, this would represent and ordered array of the responses.

ResponseCardinality

ResponseCardinalityType

0..1

Allows the designation of the minimum and maximum number of responses allowed for this response domain.

ContentDateOffset

ContentDateOffsetType

0..1

Identifies the difference between the date applied to the data as a whole and this specific item such as previous year’s income or residence 5 years ago.

Properties Inherited from DateTimeRepresentationBaseType

Name

Type

Description

DateFieldFormat

CodeValueType

0..1

Describes the format of the date field, in formats such as YYYY/MM or MM-DD-YY, etc. If this element is omitted, then the format is assumed to be the XML Schema format corresponding to the type attribute value.

DateTypeCode

CodeValueType

0..1

This is a standard XML date type code and supports the use of an external controlled vocabulary. Examples are date, dateTime, gYearMonth, gYear, and duration. The DDI Alliance has provided a controlled vocabulary (DateType) to support this element at http://www.ddialliance.org/controlled-vocabularies.

Range

RangeType

0..n

Indicates the high and low values (endpoints) of a non-numeric scale. This can be expressed as a value that matches the DateTime format. Repeatable in order to express as set of non-continuous values.

RegExp

string

0..1

The regular expression allows for further description of the allowable content of the data.

Properties Inherited from RepresentationType

Name

Type

Description

RecommendedDataType

CodeValueType

0..1

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. The DDI Alliance has provided a controlled vocabulary (DataType) to support this element at http://www.ddialliance.org/controlled-vocabularies.

GenericOutputFormat

CodeValueType

0..1

This field provides a recommended generic treatment of the data for display by an application. The value should come from a controlled vocabulary.

MeasurementUnit

CodeValueType

0..1

Records the measurement unit, for example, ‘km’, ‘miles’, etc. Supports the use of a controlled vocabulary.

MissingValue

string

0..1

List the values used to represent missing data. Use of MissingValuesReference is preferred. If this content does not match the values provided in the MissingValuesReference, the content of the MissingValuesReference overrides the content of this attribute.

BlankIsMissingValue

boolean

0..1

When value is true a blank or empty variable content should be treated as a missing value. Use of MissingValuesReference is preferred.

ClassificationLevelCode

CodeValueType

0..1

Indicates the type of relationship, nominal, ordinal, interval, ratio, or continuous. Use where appropriate for the representation type. Valid values include: Nominal, Ordinal, Interval, Ratio, Continuous

Item Type Hierarchy

Relationships

The following identified item types reference this type.

stub