TextDomainType¶
A response domain capturing a textual response. Contains the equivalent content of a TextRepresentation including the length of the text 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 TextDomainReference which references a ManagedTextRepresentation.
Properties¶
Name |
Type |
Description |
|
|---|---|---|---|
Label |
0..n |
A display label for the domain. May be expressed in multiple languages. Repeat for labels with different content, for example, labels with differing length limitations. |
|
Description |
0..1 |
A description of the content and purpose of the domain. May be expressed in multiple languages and supports the use of structured content. |
|
OutParameter |
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 |
0..1 |
Allows the designation of the minimum and maximum number of responses allowed for this response domain. |
|
ContentDateOffset |
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 TextRepresentationBaseType¶
Name |
Type |
Description |
|
|---|---|---|---|
MaxLength |
int |
0..1 |
The maximum number of characters allowed. |
MinLength |
int |
0..1 |
The minimum number of characters allowed. |
RegExp |
string |
0..1 |
A regular expression limiting the allowed characters or character order of the content. |
Properties Inherited from RepresentationType¶
Name |
Type |
Description |
|
|---|---|---|---|
RecommendedDataType |
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. |
|
GenericOutputFormat |
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. |
|
MissingValue |
string |
0..1 |
List the values used to represent missing data in a space delimited array. 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. |
ClassificationLevel |
string |
0..1 |
Indicates the type of relationship, nominal, ordinal, interval, ratio, or continuous. Use where appropriate for the representation type. |
Item Type Hierarchy¶
- RepresentationType
- TextRepresentationBaseType
- TextDomainType
