ParameterType

A parameter is a structure that specifically identifies a source of input or output information so that it can be use pragmatically.

Properties

Name

Type

Description

ParameterName

NameType

0..n

A name for the Parameter. May be expressed in multiple languages. Repeat the element to express names with different content, for example different names for different systems.

Alias

string

0..1

If the content of the parameter is being used in a generic set of code as an alias for the value of an object in a formula (for example source code for a statistical program) enter that name here. This provides a link from the identified parameter to the alias in the code.

Description

StructuredStringType

0..1

A description of the Parameter. Supports multiple language versions of the same content as well as optional formatting of the content.

ValueRepresentation

RepresentationType

0..1

If the content of the parameter contains representational content, such as codes, provide the representation here. ValueRepresentation is the abstract head of a substitution group and may be replaced with any valid substitution for ValueRepresentation. Inclusion of the ValueRepresentation is recommended if you will be sharing data with others as it provides information on the structure of what they can expect to receive when the parameter is processed.

ValueRepresentationReference

ManagedRepresentation

0..1

Allows for the use of a ManagedRepresentation by reference. ValueRepresentationReference is the abstract head of a substitution group and may be replaced with any valid substitution for ValueRepresentationReference.

DefaultValue

ValueType

0..1

Provides a default value for the parameter if there is no value provided by the object it is bound to or the process that was intended to produce a value.

IsArray

boolean

0..1

If set to “true” indicates that the content of the parameter is a delimited array rather than a single object and should be processed as such.

Properties Inherited from IdentifiableType

Name

Type

Description

URN

string

1..1

Agency

string

1..1

ID

string

1..1

Version

string

1..1

UserID

UserIDType

0..n

Allows for the specification of identifiers other than the specified DDI identification of the object. This may be a legacy ID from DDI-C, a system specific ID such as for a database or registry, or a non-DDI unique identifier. As the identifier is specific to a system the system must be identified with the UserID structure.

UserAttributePair

StandardKeyValuePairType

0..n

A system specific user defined property of the object expressed as a key/value pair. As this is specific to an individual system the use of controlled vocabularies for the key is strongly recommended.

Item Type Hierarchy