InParameterType

A parameter that may accept content from outside its parent element. In addition to standard parameter content may provide the instructions for limiting the allowable array index.

Properties

Name

Type

Description

LimitArrayIndex

string

0..1

When the InParameter represents an array of items, this attribute specifies the index identification of the items within the zero-based array which should be treated as input parameters. If not specified, the full array is treated as the input parameter.

Properties Inherited from ParameterType

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. May be expressed in multiple languages and supports the use of structured 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

RepresentationReferenceType

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.

InheritanceAction

string

0..1

The attribute “action” is used for inheritance situations where there is an override at the local level (within a grouped StudyUnit) which is not available for further inheritance. There are three possible values for “action”: Add - A new identifiable object (an Identifiable, Versionable, or Maintainable element) is provided locally with a new identifier (one that is not inherited). All properties (elements and attributes contained in the object) of the object are as specified. If an object with an existing id is created, this is an error.; Update - An object is provided locally with the SAME id as the inherited object. For each type of property that is specified locally, a full set of those properties is specified for local use. These properties replace any properties of this type which were inherited. Unspecified properties are used as inherited.; Delete - An object is provided locally with the SAME id as the inherited object. All properties specified locally in this object will be deleted if their types and values match those inherited. Note that to completely delete an object at the local level, all properties of the inherited object must be listed.

Item Type Hierarchy

Relationships

The following types reference this type.

stub