CodeType

A structure that links a unique value of a code to a specified category and provides information as to the location of the code within a hierarchy, whether it is discrete, represents a total for the CodeList contents, and if its sub-elements represent a comprehensive coverage of the code. The Code is identifiable, but the value within the code must also be unique within the CodeList.

Properties

Name

Type

Description

CategoryReference

Category

0..1

Reference to the category that the code value represents.

Value

ValueType

0..1

The value of the code. In a microdata file this would be the value found in the data file. If used as the description of an NCube dimension the value provides the coordinate value for that dimension. Note that r:Value has an attribute xml:space with the default value of “default”. If white space is critical to the understanding of this code value (such as critical leading or tailing spaces, or multiple spaces within the code) change the value of xml:space to “preserve”.

Code

CodeType

0..n

Allows for nesting of codes.

IsDiscrete

boolean

0..1

Indicates whether the code is discrete (that is, placed at the lowest level in a hierarchy and has no children).

LevelNumber

nonNegativeInteger

0..1

Level number of the code.

IsComprehensive

string

0..1

Used in hierarchical structures at upper level values to indicate whether or not the subelements of the code are comprehensive in coverage. Not applicable if attribute isDiscrete is set to “true”. Valid values include: True, False, Unknown

IsTotal

boolean

0..1

This expresses a total whether or not isComprehensive is true. If isComprehensive = “true” then if addition is supported by the measure type, the contained categories can be aggregated to calculate the total. If isComprehensive = “false” or “unknown” the content of this field cannot be calculated if the value is not provided in the data.

Properties Inherited from IdentifiableType

Name

Type

Description

URN

string

1..1

The URN of the entity matching the DDI URN pattern associated with the value of the attribute typeOfIdentifier (Canonical or Deprecated).

Agency

string

1..1

This is the registered agency code with optional sub-agencies separated by dots.

ID

string

1..1

The ID of the object. This must conform to the allowed structure of the DDI Identifier and must be unique within the declared scope of uniqueness (Agency or Maintainable).

Version

string

1..1

The version number of the object. For the identifiable object this is the version number of its parent versionable at the point of creation or alteration of the non-administrative metadata of the identifiable. Versionable and Maintainable items increment their version number whenever the non-administrative metadata contained by the object changes.

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

Relationships

The following identified item types reference this type.

stub