CodeListStructure¶
Generalization is Identifiable.
Superclass hierarchy
Definition¶
Relation structure of codes within a codelist.
Examples¶
Explanatory notes¶
Allows for the specification of complex relationships among codes. The CodeListStructure employs a set of CodeRelationips to describe the relationship among concepts. Each CodeRelationship is a one to many description of connections between codes. Together they might commonly describe relationships as complex as a hierarchy.
Subclasses¶
Properties¶
Name |
Description |
Data Type |
Multi- plicity |
---|---|---|---|
name
from CodeListStructure
|
A linguistic signifier. Human understandable name (word, phrase, or mnemonic) that reflects the ISO/IEC 11179-5 naming principles. If more than one name is provided provide a context to differentiate usage. |
0..* |
|
purpose
from CodeListStructure
|
Explanation of the intent of some decision or object. Supports the use of multiple languages and structured text. |
0..1 |
|
semantics
from CodeListStructure
|
Provides semantic context for the relationship. |
0..1 |
|
specification
from CodeListStructure
|
0..1 |
||
topology
from CodeListStructure
|
1..1 |
||
totality
from CodeListStructure
|
Type of relation in terms of totality with respect to an associated collection. |
0..1 |
Inherited Properties¶
Name |
Description |
Data Type |
Multi- plicity |
---|---|---|---|
agency
from Identifiable
|
Agency expressed as filed with the DDI Agency ID registry [registry.ddialliance.org] with optional additional sub-agency extensions. |
:ref:`` |
1..1 |
id
from Identifiable
|
ID conforming to the allowed structure of the DDI Identifier and must be unique within the Agency. |
:ref:`` |
1..1 |
isPersistent
from Identifiable
|
Default value is false indicating that the content of the current version may change (may be in development mode). Set to true when the content of this version will no longer change. |
:ref:`` |
1..1 |
isUniversallyUnique
from Identifiable
|
Default value is false. If the id of the object was created as a Universally Unique ID (UUID) set to true. |
:ref:`` |
1..1 |
localId
from Identifiable
|
Locally used identifier unique with a specified context, such as a variable name within a dataset. |
0..* |
|
version
from Identifiable
|
Version number of the object. |
:ref:`` |
1..1 |
versionDate
from Identifiable
|
Date and time the object was changed expressed in standard ISO formats. |
0..1 |
|
versionRationale
from Identifiable
|
Reason for making a new version of the object. |
0..1 |
|
versionResponsibility
from Identifiable
|
Contributor who has the ownership and responsibility for the current version. |
:ref:`` |
0..1 |
Associations¶
Multiplicity |
Association |
Navigable Class |
Multiplicity |
---|---|---|---|
0..1 |
CodeListStructure_structures_CodeList |
0..1 |
|
0..* |
CodeListStructure_has_CodeRelationship |
1..1 |
TBD
Diagram¶
TBD