CodeListStructure#
Fully qualified class name of the UML model DDI-CDI 1.0: DDICDIModels::DDICDILibrary::Classes::Representations::CodeListStructure
Definition#
Relation structure of codes within a codelist.
Explanatory notes#
Allows for the specification of complex relationships among codes. The code list structure employs a set of code relationips to describe the relationship among concepts. Each code relationship is a one to many description of connections between codes. Together they might commonly describe relationships as complex as a hierarchy.
Diagram#
Diagram
Attributes#
Attributes
Name |
Inherited from |
Description |
Data Type |
Multiplicity |
Default value |
|---|---|---|---|---|---|
identifier |
- own class - |
Identifier for objects requiring short- or long-lasting referencing and management. |
0..1 |
||
name |
- own class - |
Human understandable name (liguistic signifier, word, phrase, or mnemonic). May follow ISO/IEC 11179-5 naming principles, and have context provided to specify usage. |
0..* |
||
purpose |
- own class - |
Intent or reason for the object/the description of the object. |
0..1 |
||
semantics |
- own class - |
Specifies the semantics of the object in reference to a vocabulary, ontology, etc. |
0..1 |
||
specification |
- own class - |
Provides information on reflexivity, transitivity, and symmetry of relationship using a descriptive term from an enumerated list. Use if all relations within this relation structure are of the same specification. |
0..1 |
||
topology |
- own class - |
Indicates the form of the associations among members of the collection. Specifies the way in which constituent parts are interrelated or arranged. |
1..1 |
||
totality |
- own class - |
Indicates whether the related collections are comprehensive in terms of their coverage. |
0..1 |
Associations#
Associations
Direction |
Association |
Description |
Multiplicity of CodeListStructure |
Package of Other Class |
Other Class |
Multiplicity of other class |
Aggregation Kind |
Inherited from |
|---|---|---|---|---|---|---|---|---|
from |
CodeListStructure has CodeRelationship |
1..1 |
- own package - |
0..* |
composite |
own class |
||
from |
CodeListStructure structures CodeList |
0..1 |
- own package - |
0..1 |
none |
own class |
Encodings#
Syntax representations / encodings
All syntax representations except the Canonical XMI are provided as reference points for specific implementations, or for use as defaults if sufficient in the form presented.
Fragment for the class CodeListStructure (entire model as XMI)
1<packagedElement xmlns:StandardProfile="http://www.omg.org/spec/UML/20131001/StandardProfile"
2 xmlns:uml="http://www.omg.org/spec/UML/20131001"
3 xmlns:xmi="http://www.omg.org/spec/XMI/20131001"
4 xmi:id="DDICDIModels-DDICDILibrary-Classes-Representations-CodeListStructure"
5 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#CodeListStructure"
6 xmi:type="uml:Class">
7 <ownedComment xmi:id="DDICDIModels-DDICDILibrary-Classes-Representations-CodeListStructure-ownedComment"
8 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#CodeListStructure-ownedComment"
9 xmi:type="uml:Comment">
10 <annotatedElement xmi:idref="DDICDIModels-DDICDILibrary-Classes-Representations-CodeListStructure"/>
11 <body>Definition
12============
13Relation structure of codes within a codelist.
14
15Explanatory notes
16===================
17Allows for the specification of complex relationships among codes. The code list structure employs a set of code relationips to describe the relationship among concepts. Each code relationship is a one to many description of connections between codes. Together they might commonly describe relationships as complex as a hierarchy.</body>
18 </ownedComment>
19 <name>CodeListStructure</name>
20 <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-Classes-Representations-CodeListStructure-identifier"
21 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#CodeListStructure-identifier"
22 xmi:type="uml:Property">
23 <ownedComment xmi:id="DDICDIModels-DDICDILibrary-Classes-Representations-CodeListStructure-identifier-ownedComment"
24 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#CodeListStructure-identifier-ownedComment"
25 xmi:type="uml:Comment">
26 <annotatedElement xmi:idref="DDICDIModels-DDICDILibrary-Classes-Representations-CodeListStructure-identifier"/>
27 <body>Identifier for objects requiring short- or long-lasting referencing and management.</body>
28 </ownedComment>
29 <lowerValue xmi:id="DDICDIModels-DDICDILibrary-Classes-Representations-CodeListStructure-identifier-lowerValue"
30 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#CodeListStructure-identifier-lowerValue"
31 xmi:type="uml:LiteralInteger"/>
32 <upperValue xmi:id="DDICDIModels-DDICDILibrary-Classes-Representations-CodeListStructure-identifier-upperValue"
33 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#CodeListStructure-identifier-upperValue"
34 xmi:type="uml:LiteralUnlimitedNatural">
35 <value>1</value>
36 </upperValue>
37 <name>identifier</name>
38 <isID>true</isID>
39 <type xmi:idref="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-Identifier"/>
40 </ownedAttribute>
41 <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-Classes-Representations-CodeListStructure-name"
42 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#CodeListStructure-name"
43 xmi:type="uml:Property">
44 <ownedComment xmi:id="DDICDIModels-DDICDILibrary-Classes-Representations-CodeListStructure-name-ownedComment"
45 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#CodeListStructure-name-ownedComment"
46 xmi:type="uml:Comment">
47 <annotatedElement xmi:idref="DDICDIModels-DDICDILibrary-Classes-Representations-CodeListStructure-name"/>
48 <body>Human understandable name (liguistic signifier, word, phrase, or mnemonic). May follow ISO/IEC 11179-5 naming principles, and have context provided to specify usage.</body>
49 </ownedComment>
50 <lowerValue xmi:id="DDICDIModels-DDICDILibrary-Classes-Representations-CodeListStructure-name-lowerValue"
51 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#CodeListStructure-name-lowerValue"
52 xmi:type="uml:LiteralInteger"/>
53 <upperValue xmi:id="DDICDIModels-DDICDILibrary-Classes-Representations-CodeListStructure-name-upperValue"
54 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#CodeListStructure-name-upperValue"
55 xmi:type="uml:LiteralUnlimitedNatural">
56 <value>*</value>
57 </upperValue>
58 <name>name</name>
59 <isOrdered>true</isOrdered>
60 <type xmi:idref="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-ObjectName"/>
61 </ownedAttribute>
62 <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-Classes-Representations-CodeListStructure-ownedAttribute_1"
63 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#CodeListStructure-ownedAttribute_1"
64 xmi:type="uml:Property">
65 <lowerValue xmi:id="DDICDIModels-DDICDILibrary-Classes-Representations-CodeListStructure-ownedAttribute_1-lowerValue"
66 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#CodeListStructure-ownedAttribute_1-lowerValue"
67 xmi:type="uml:LiteralInteger"/>
68 <upperValue xmi:id="DDICDIModels-DDICDILibrary-Classes-Representations-CodeListStructure-ownedAttribute_1-upperValue"
69 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#CodeListStructure-ownedAttribute_1-upperValue"
70 xmi:type="uml:LiteralUnlimitedNatural">
71 <value>1</value>
72 </upperValue>
73 <association xmi:idref="DDICDIModels-DDICDILibrary-Classes-Representations-CodeListStructure_structures_CodeList"/>
74 <type xmi:idref="DDICDIModels-DDICDILibrary-Classes-Representations-CodeList"/>
75 </ownedAttribute>
76 <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-Classes-Representations-CodeListStructure-ownedAttribute_2"
77 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#CodeListStructure-ownedAttribute_2"
78 xmi:type="uml:Property">
79 <lowerValue xmi:id="DDICDIModels-DDICDILibrary-Classes-Representations-CodeListStructure-ownedAttribute_2-lowerValue"
80 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#CodeListStructure-ownedAttribute_2-lowerValue"
81 xmi:type="uml:LiteralInteger"/>
82 <upperValue xmi:id="DDICDIModels-DDICDILibrary-Classes-Representations-CodeListStructure-ownedAttribute_2-upperValue"
83 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#CodeListStructure-ownedAttribute_2-upperValue"
84 xmi:type="uml:LiteralUnlimitedNatural">
85 <value>*</value>
86 </upperValue>
87 <aggregation>composite</aggregation>
88 <association xmi:idref="DDICDIModels-DDICDILibrary-Classes-Representations-CodeListStructure_has_CodeRelationship"/>
89 <type xmi:idref="DDICDIModels-DDICDILibrary-Classes-Representations-CodeRelationship"/>
90 </ownedAttribute>
91 <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-Classes-Representations-CodeListStructure-purpose"
92 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#CodeListStructure-purpose"
93 xmi:type="uml:Property">
94 <ownedComment xmi:id="DDICDIModels-DDICDILibrary-Classes-Representations-CodeListStructure-purpose-ownedComment"
95 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#CodeListStructure-purpose-ownedComment"
96 xmi:type="uml:Comment">
97 <annotatedElement xmi:idref="DDICDIModels-DDICDILibrary-Classes-Representations-CodeListStructure-purpose"/>
98 <body>Intent or reason for the object/the description of the object.</body>
99 </ownedComment>
100 <lowerValue xmi:id="DDICDIModels-DDICDILibrary-Classes-Representations-CodeListStructure-purpose-lowerValue"
101 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#CodeListStructure-purpose-lowerValue"
102 xmi:type="uml:LiteralInteger"/>
103 <upperValue xmi:id="DDICDIModels-DDICDILibrary-Classes-Representations-CodeListStructure-purpose-upperValue"
104 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#CodeListStructure-purpose-upperValue"
105 xmi:type="uml:LiteralUnlimitedNatural">
106 <value>1</value>
107 </upperValue>
108 <name>purpose</name>
109 <type xmi:idref="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-InternationalString"/>
110 </ownedAttribute>
111 <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-Classes-Representations-CodeListStructure-semantics"
112 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#CodeListStructure-semantics"
113 xmi:type="uml:Property">
114 <ownedComment xmi:id="DDICDIModels-DDICDILibrary-Classes-Representations-CodeListStructure-semantics-ownedComment"
115 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#CodeListStructure-semantics-ownedComment"
116 xmi:type="uml:Comment">
117 <annotatedElement xmi:idref="DDICDIModels-DDICDILibrary-Classes-Representations-CodeListStructure-semantics"/>
118 <body>Specifies the semantics of the object in reference to a vocabulary, ontology, etc.</body>
119 </ownedComment>
120 <lowerValue xmi:id="DDICDIModels-DDICDILibrary-Classes-Representations-CodeListStructure-semantics-lowerValue"
121 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#CodeListStructure-semantics-lowerValue"
122 xmi:type="uml:LiteralInteger"/>
123 <upperValue xmi:id="DDICDIModels-DDICDILibrary-Classes-Representations-CodeListStructure-semantics-upperValue"
124 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#CodeListStructure-semantics-upperValue"
125 xmi:type="uml:LiteralUnlimitedNatural">
126 <value>1</value>
127 </upperValue>
128 <name>semantics</name>
129 <type xmi:idref="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-ControlledVocabularyEntry"/>
130 </ownedAttribute>
131 <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-Classes-Representations-CodeListStructure-specification"
132 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#CodeListStructure-specification"
133 xmi:type="uml:Property">
134 <ownedComment xmi:id="DDICDIModels-DDICDILibrary-Classes-Representations-CodeListStructure-specification-ownedComment"
135 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#CodeListStructure-specification-ownedComment"
136 xmi:type="uml:Comment">
137 <annotatedElement xmi:idref="DDICDIModels-DDICDILibrary-Classes-Representations-CodeListStructure-specification"/>
138 <body>Provides information on reflexivity, transitivity, and symmetry of relationship using a descriptive term from an enumerated list. Use if all relations within this relation structure are of the same specification.</body>
139 </ownedComment>
140 <lowerValue xmi:id="DDICDIModels-DDICDILibrary-Classes-Representations-CodeListStructure-specification-lowerValue"
141 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#CodeListStructure-specification-lowerValue"
142 xmi:type="uml:LiteralInteger"/>
143 <upperValue xmi:id="DDICDIModels-DDICDILibrary-Classes-Representations-CodeListStructure-specification-upperValue"
144 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#CodeListStructure-specification-upperValue"
145 xmi:type="uml:LiteralUnlimitedNatural">
146 <value>1</value>
147 </upperValue>
148 <name>specification</name>
149 <type xmi:idref="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-StructureSpecification"/>
150 </ownedAttribute>
151 <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-Classes-Representations-CodeListStructure-topology"
152 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#CodeListStructure-topology"
153 xmi:type="uml:Property">
154 <ownedComment xmi:id="DDICDIModels-DDICDILibrary-Classes-Representations-CodeListStructure-topology-ownedComment"
155 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#CodeListStructure-topology-ownedComment"
156 xmi:type="uml:Comment">
157 <annotatedElement xmi:idref="DDICDIModels-DDICDILibrary-Classes-Representations-CodeListStructure-topology"/>
158 <body>Indicates the form of the associations among members of the collection. Specifies the way in which constituent parts are interrelated or arranged.</body>
159 </ownedComment>
160 <lowerValue xmi:id="DDICDIModels-DDICDILibrary-Classes-Representations-CodeListStructure-topology-lowerValue"
161 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#CodeListStructure-topology-lowerValue"
162 xmi:type="uml:LiteralInteger">
163 <value>1</value>
164 </lowerValue>
165 <upperValue xmi:id="DDICDIModels-DDICDILibrary-Classes-Representations-CodeListStructure-topology-upperValue"
166 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#CodeListStructure-topology-upperValue"
167 xmi:type="uml:LiteralUnlimitedNatural">
168 <value>1</value>
169 </upperValue>
170 <name>topology</name>
171 <type xmi:idref="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-ControlledVocabularyEntry"/>
172 </ownedAttribute>
173 <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-Classes-Representations-CodeListStructure-totality"
174 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#CodeListStructure-totality"
175 xmi:type="uml:Property">
176 <ownedComment xmi:id="DDICDIModels-DDICDILibrary-Classes-Representations-CodeListStructure-totality-ownedComment"
177 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#CodeListStructure-totality-ownedComment"
178 xmi:type="uml:Comment">
179 <annotatedElement xmi:idref="DDICDIModels-DDICDILibrary-Classes-Representations-CodeListStructure-totality"/>
180 <body>Indicates whether the related collections are comprehensive in terms of their coverage.</body>
181 </ownedComment>
182 <lowerValue xmi:id="DDICDIModels-DDICDILibrary-Classes-Representations-CodeListStructure-totality-lowerValue"
183 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#CodeListStructure-totality-lowerValue"
184 xmi:type="uml:LiteralInteger"/>
185 <upperValue xmi:id="DDICDIModels-DDICDILibrary-Classes-Representations-CodeListStructure-totality-upperValue"
186 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#CodeListStructure-totality-upperValue"
187 xmi:type="uml:LiteralUnlimitedNatural">
188 <value>1</value>
189 </upperValue>
190 <name>totality</name>
191 <type xmi:idref="DDICDIModels-DDICDILibrary-DataTypes-Enumerations-StructureExtent"/>
192 </ownedAttribute>
193</packagedElement>
Fragment for the class CodeListStructure (entire XML Schema)
1<xs:element name="CodeListStructure"
2 type="CodeListStructureXsdType"
3 xml:id="CodeListStructure">
4 <!-- based on the UML class DDICDIModels::DDICDILibrary::Classes::Representations::CodeListStructure -->
5 <xs:annotation>
6 <xs:documentation>Definition
7 ============
8 Relation structure of codes within a codelist.
9
10 Explanatory notes
11 ===================
12 Allows for the specification of complex relationships among codes. The code list structure employs a set of code relationips to describe the relationship among concepts. Each code relationship is a one to many description of connections between codes. Together they might commonly describe relationships as complex as a hierarchy.</xs:documentation>
13 </xs:annotation>
14</xs:element>
15<xs:complexType name="CodeListStructureXsdType"
16 xml:id="CodeListStructureXsdType">
17 <xs:annotation>
18 <xs:documentation>Definition
19 ============
20 Relation structure of codes within a codelist.
21
22 Explanatory notes
23 ===================
24 Allows for the specification of complex relationships among codes. The code list structure employs a set of code relationips to describe the relationship among concepts. Each code relationship is a one to many description of connections between codes. Together they might commonly describe relationships as complex as a hierarchy.</xs:documentation>
25 </xs:annotation>
26 <xs:sequence>
27 <xs:element name="identifier"
28 type="IdentifierXsdType"
29 minOccurs="0"
30 maxOccurs="1"
31 xml:id="CodeListStructure-identifier">
32 <xs:annotation>
33 <xs:documentation>Identifier for objects requiring short- or long-lasting referencing and management.</xs:documentation>
34 </xs:annotation>
35 </xs:element>
36 <xs:element name="name"
37 type="ObjectNameXsdType"
38 minOccurs="0"
39 maxOccurs="unbounded"
40 xml:id="CodeListStructure-name">
41 <xs:annotation>
42 <xs:documentation>Human understandable name (liguistic signifier, word, phrase, or mnemonic). May follow ISO/IEC 11179-5 naming principles, and have context provided to specify usage.</xs:documentation>
43 </xs:annotation>
44 </xs:element>
45 <xs:element name="purpose"
46 type="InternationalStringXsdType"
47 minOccurs="0"
48 maxOccurs="1"
49 xml:id="CodeListStructure-purpose">
50 <xs:annotation>
51 <xs:documentation>Intent or reason for the object/the description of the object.</xs:documentation>
52 </xs:annotation>
53 </xs:element>
54 <xs:element name="semantics"
55 type="ControlledVocabularyEntryXsdType"
56 minOccurs="0"
57 maxOccurs="1"
58 xml:id="CodeListStructure-semantics">
59 <xs:annotation>
60 <xs:documentation>Specifies the semantics of the object in reference to a vocabulary, ontology, etc.</xs:documentation>
61 </xs:annotation>
62 </xs:element>
63 <xs:element name="specification"
64 type="StructureSpecificationXsdType"
65 minOccurs="0"
66 maxOccurs="1"
67 xml:id="CodeListStructure-specification">
68 <xs:annotation>
69 <xs:documentation>Provides information on reflexivity, transitivity, and symmetry of relationship using a descriptive term from an enumerated list. Use if all relations within this relation structure are of the same specification.</xs:documentation>
70 </xs:annotation>
71 </xs:element>
72 <xs:element name="topology"
73 type="ControlledVocabularyEntryXsdType"
74 minOccurs="1"
75 maxOccurs="1"
76 xml:id="CodeListStructure-topology">
77 <xs:annotation>
78 <xs:documentation>Indicates the form of the associations among members of the collection. Specifies the way in which constituent parts are interrelated or arranged.</xs:documentation>
79 </xs:annotation>
80 </xs:element>
81 <xs:element name="totality"
82 type="StructureExtentXsdType"
83 minOccurs="0"
84 maxOccurs="1"
85 xml:id="CodeListStructure-totality">
86 <xs:annotation>
87 <xs:documentation>Indicates whether the related collections are comprehensive in terms of their coverage.</xs:documentation>
88 </xs:annotation>
89 </xs:element>
90 <xs:element name="CodeListStructure_structures_CodeList"
91 minOccurs="0"
92 maxOccurs="1"
93 xml:id="CodeListStructure_structures_CodeList">
94 <xs:annotation>
95 <xs:documentation></xs:documentation>
96 </xs:annotation>
97 <xs:complexType>
98 <xs:complexContent>
99 <xs:restriction base="AssociationReferenceXsdType">
100 <xs:sequence>
101 <xs:element name="ddiReference"
102 type="InternationalRegistrationDataIdentifierXsdType"
103 minOccurs="0"
104 maxOccurs="1"
105 xml:id="CodeListStructure_structures_CodeList-ddiReference"/>
106 <xs:element name="validType"
107 minOccurs="0"
108 maxOccurs="1"
109 xml:id="CodeListStructure_structures_CodeList-validType">
110 <xs:simpleType>
111 <xs:restriction base="xs:NMTOKEN">
112 <xs:enumeration value="CodeList"/>
113 </xs:restriction>
114 </xs:simpleType>
115 </xs:element>
116 </xs:sequence>
117 </xs:restriction>
118 </xs:complexContent>
119 </xs:complexType>
120 </xs:element>
121 <xs:element name="CodeListStructure_has_CodeRelationship"
122 minOccurs="0"
123 maxOccurs="unbounded"
124 xml:id="CodeListStructure_has_CodeRelationship">
125 <xs:annotation>
126 <xs:documentation></xs:documentation>
127 </xs:annotation>
128 <xs:complexType>
129 <xs:complexContent>
130 <xs:restriction base="AssociationReferenceXsdType">
131 <xs:sequence>
132 <xs:element name="ddiReference"
133 type="InternationalRegistrationDataIdentifierXsdType"
134 minOccurs="0"
135 maxOccurs="1"
136 xml:id="CodeListStructure_has_CodeRelationship-ddiReference"/>
137 <xs:element name="validType"
138 minOccurs="1"
139 maxOccurs="1"
140 xml:id="CodeListStructure_has_CodeRelationship-validType">
141 <xs:simpleType>
142 <xs:restriction base="xs:NMTOKEN">
143 <xs:enumeration value="CodeRelationship"/>
144 </xs:restriction>
145 </xs:simpleType>
146 </xs:element>
147 </xs:sequence>
148 </xs:restriction>
149 </xs:complexContent>
150 </xs:complexType>
151 </xs:element>
152 </xs:sequence>
153</xs:complexType>
Fragment for the class CodeListStructure (entire JSON Schema)
1"cls-CodeListStructure": {
2 "description": "http://ddialliance.org/Specification/DDI-CDI/1.0/RDF/CodeListStructure",
3 "type": "object",
4 "properties": {
5 "@context": {
6 "$ref": "#/defs/at-context"
7 },
8 "@id": {
9 "type": "string",
10 "format": "iri-reference"
11 },
12 "@type": {
13 "const": "CodeListStructure"
14 },
15 "identifier": {
16 "$comment": "cardinality 0..1 – from cdi:CodeListStructure",
17 "$ref": "#/defs/dt-Identifier"
18 },
19 "name": {
20 "$comment": "cardinality 0..-1 – from cdi:CodeListStructure",
21 "if": { "type": "array" },
22 "then": { "items": { "$ref": "#/defs/dt-ObjectName" } },
23 "else": { "$ref": "#/defs/dt-ObjectName" }
24 },
25 "purpose": {
26 "$comment": "cardinality 0..1 – from cdi:CodeListStructure",
27 "$ref": "#/defs/dt-InternationalString"
28 },
29 "semantics": {
30 "$comment": "cardinality 0..1 – from cdi:CodeListStructure",
31 "$ref": "#/defs/dt-ControlledVocabularyEntry"
32 },
33 "specification": {
34 "$comment": "cardinality 0..1 – from cdi:CodeListStructure",
35 "$ref": "#/defs/dt-StructureSpecification"
36 },
37 "topology": {
38 "$comment": "cardinality 1..1 – from cdi:CodeListStructure",
39 "$ref": "#/defs/dt-ControlledVocabularyEntry"
40 },
41 "totality": {
42 "$comment": "cardinality 0..1 – from cdi:CodeListStructure",
43 "$ref": "#/defs/enum-StructureExtent"
44 },
45 "has_CodeRelationship": {
46 "description": "CodeListStructure_has_CodeRelationship",
47 "$comment": "cardinality 0..-1",
48 "anyOf": [
49 {
50 "$ref": "#/defs/target-CodeRelationship"
51 },
52 {
53 "type": "array",
54 "items": {
55 "$ref": "#/defs/target-CodeRelationship"
56 }
57 }
58 ]
59 },
60 "structures": {
61 "description": "CodeListStructure_structures_CodeList",
62 "$comment": "cardinality 0..1",
63 "$ref": "#/defs/target-CodeList"
64 },
65
66 "sameAs": {
67 "$ref": "#/defs/owl:sameAs"
68 }
69 },
70 "required": ["topology","@type"],
71 "additionalProperties": false
72},
73"target-CodeListStructure": {
74 "description": "all subclasses of http://ddialliance.org/Specification/DDI-CDI/1.0/RDF/CodeListStructure",
75 "anyOf": [
76 { "$ref": "#/defs/cls-CodeListStructure" },
77 { "type": "string", "format": "iri-reference" }
78 ]
79},
Fragment for the class CodeListStructure (main ontology)
1# class CodeListStructure
2# based on the UML class DDICDIModels::DDICDILibrary::Classes::Representations::CodeListStructure
3cdi:CodeListStructure
4 a rdfs:Class, owl:Class, ucmis:Class;
5 rdfs:label "CodeListStructure";
6 rdfs:comment "Definition\n============\nRelation structure of codes within a codelist.\n\nExplanatory notes\n===================\nAllows for the specification of complex relationships among codes. The code list structure employs a set of code relationips to describe the relationship among concepts. Each code relationship is a one to many description of connections between codes. Together they might commonly describe relationships as complex as a hierarchy."@en;
7
8.
9
10cdi:CodeListStructure-identifier
11 a rdf:Property, owl:ObjectProperty, ucmis:Attribute;
12 rdfs:label "identifier";
13 rdfs:comment "Identifier for objects requiring short- or long-lasting referencing and management."@en;
14 rdfs:domain cdi:CodeListStructure;
15 rdfs:range cdi:Identifier;
16.
17
18cdi:CodeListStructure-name
19 a rdf:Property, owl:ObjectProperty, ucmis:Attribute;
20 rdfs:label "name";
21 rdfs:comment "Human understandable name (liguistic signifier, word, phrase, or mnemonic). May follow ISO/IEC 11179-5 naming principles, and have context provided to specify usage."@en;
22 rdfs:domain cdi:CodeListStructure;
23 rdfs:range cdi:ObjectName;
24.
25
26cdi:CodeListStructure-purpose
27 a rdf:Property, owl:ObjectProperty, ucmis:Attribute;
28 rdfs:label "purpose";
29 rdfs:comment "Intent or reason for the object/the description of the object."@en;
30 rdfs:domain cdi:CodeListStructure;
31 rdfs:range cdi:InternationalString;
32.
33
34cdi:CodeListStructure-semantics
35 a rdf:Property, owl:ObjectProperty, ucmis:Attribute;
36 rdfs:label "semantics";
37 rdfs:comment "Specifies the semantics of the object in reference to a vocabulary, ontology, etc."@en;
38 rdfs:domain cdi:CodeListStructure;
39 rdfs:range cdi:ControlledVocabularyEntry;
40.
41
42cdi:CodeListStructure-specification
43 a rdf:Property, owl:ObjectProperty, ucmis:Attribute;
44 rdfs:label "specification";
45 rdfs:comment "Provides information on reflexivity, transitivity, and symmetry of relationship using a descriptive term from an enumerated list. Use if all relations within this relation structure are of the same specification."@en;
46 rdfs:domain cdi:CodeListStructure;
47 rdfs:range cdi:StructureSpecification;
48.
49
50cdi:CodeListStructure-topology
51 a rdf:Property, owl:ObjectProperty, ucmis:Attribute;
52 rdfs:label "topology";
53 rdfs:comment "Indicates the form of the associations among members of the collection. Specifies the way in which constituent parts are interrelated or arranged."@en;
54 rdfs:domain cdi:CodeListStructure;
55 rdfs:range cdi:ControlledVocabularyEntry;
56.
57
58cdi:CodeListStructure-totality
59 a rdf:Property, owl:ObjectProperty, ucmis:Attribute;
60 rdfs:label "totality";
61 rdfs:comment "Indicates whether the related collections are comprehensive in terms of their coverage."@en;
62 rdfs:domain cdi:CodeListStructure;
63 rdfs:range cdi:StructureExtent;
64.
65
66
67cdi:CodeListStructure_has_CodeRelationship
68 a rdf:Property, owl:ObjectProperty, ucmis:Association;
69 # ASSOCIATION
70 rdfs:label "has_CodeRelationship";
71 skos:altLabel "CodeListStructure_has_CodeRelationship";
72
73 rdfs:domain cdi:CodeListStructure;
74 rdfs:range cdi:CodeRelationship;
75.
76
77cdi:CodeListStructure_structures_CodeList
78 a rdf:Property, owl:ObjectProperty, ucmis:Association;
79 # ASSOCIATION
80 rdfs:label "structures";
81 skos:altLabel "CodeListStructure_structures_CodeList";
82
83 rdfs:domain cdi:CodeListStructure;
84 rdfs:range cdi:CodeList;
85.
Fragment for the class CodeListStructure (entire JSON-LD)
1{
2 "@context": [
3 {
4 "cdi": "http://ddialliance.org/Specification/DDI-CDI/1.0/RDF/",
5 "xsd": "http://www.w3.org/2001/XMLSchema#",
6
7 "identifier": {
8 "@id": "cdi:CodeListStructure-identifier",
9 "@type": "@id",
10 "@context": "Identifier.jsonld"
11 },
12 "name": {
13 "@id": "cdi:CodeListStructure-name",
14 "@type": "@id",
15 "@context": "ObjectName.jsonld"
16 },
17 "purpose": {
18 "@id": "cdi:CodeListStructure-purpose",
19 "@type": "@id",
20 "@context": "InternationalString.jsonld"
21 },
22 "semantics": {
23 "@id": "cdi:CodeListStructure-semantics",
24 "@type": "@id",
25 "@context": "ControlledVocabularyEntry.jsonld"
26 },
27 "specification": {
28 "@id": "cdi:CodeListStructure-specification",
29 "@type": "@id",
30 "@context": "StructureSpecification.jsonld"
31 },
32 "topology": {
33 "@id": "cdi:CodeListStructure-topology",
34 "@type": "@id",
35 "@context": "ControlledVocabularyEntry.jsonld"
36 },
37 "totality": {
38 "@id": "cdi:CodeListStructure-totality",
39 "@type": "@vocab",
40 "@context": {
41 "Partial": "cdi:Partial"
42 , "Total": "cdi:Total"
43 }
44 },
45
46 "has_CodeRelationship": {
47 "@id": "cdi:CodeListStructure_has_CodeRelationship",
48 "@type": "@id",
49 "@context": "CodeRelationship.jsonld"
50 },
51 "structures": {
52 "@id": "cdi:CodeListStructure_structures_CodeList",
53 "@type": "@id",
54 "@context": "CodeList.jsonld"
55 },
56 " comment ": "tag:json-should-support-trailing-commas"
57 }
58 ],
59 "generatedBy": "This code was generated by the Eclipse Acceleo project UCMIS M2T on 2025-08-29 14:34:54.",
60 "basedOn": "based on the UML data type DDICDIModels::DDICDILibrary::Classes::Representations::CodeListStructure"
61}
Fragment for the class CodeListStructure (entire SHACL - Shapes Constraint Language)
1# class CodeListStructure
2# based on the UML class DDICDIModels::DDICDILibrary::Classes::Representations::CodeListStructure
3<#CodeListStructure> a sh:NodeShape;
4 sh:targetClass cdi:CodeListStructure;
5 sh:message "See http://ddialliance.org/Specification/DDI-CDI/1.0/RDF/CodeListStructure";
6 sh:closed true;
7 sh:ignoredProperties ( owl:sameAs );
8 sh:property [
9 sh:path rdf:type;
10 sh:in ( cdi:CodeListStructure
11 ) ;
12 ];
13 # attributes
14 sh:property <#CodeListStructure-identifier>;
15 sh:property <#CodeListStructure-name>;
16 sh:property <#CodeListStructure-purpose>;
17 sh:property <#CodeListStructure-semantics>;
18 sh:property <#CodeListStructure-specification>;
19 sh:property <#CodeListStructure-topology>;
20 sh:property <#CodeListStructure-totality>;
21 # associations from CodeListStructure
22 sh:property <#CodeListStructure_has_CodeRelationship>;
23 sh:property <#CodeListStructure_structures_CodeList>;
24 # associations to CodeListStructure
25
26
27
28.
29
30<#CodeListStructure-identifier> a sh:PropertyShape ;
31 sh:path cdi:CodeListStructure-identifier;
32 sh:node [ sh:property [ sh:path rdf:type; sh:minCount 1; sh:in (
33 cdi:Identifier
34
35 ) ]];
36 sh:maxCount 1;
37.
38<#CodeListStructure-name> a sh:PropertyShape ;
39 sh:path cdi:CodeListStructure-name;
40 sh:node [ sh:property [ sh:path rdf:type; sh:minCount 1; sh:in (
41 cdi:ObjectName
42 cdi:OrganizationName
43
44 ) ]];
45.
46<#CodeListStructure-purpose> a sh:PropertyShape ;
47 sh:path cdi:CodeListStructure-purpose;
48 sh:node [ sh:property [ sh:path rdf:type; sh:minCount 1; sh:in (
49 cdi:InternationalString
50 cdi:BibliographicName
51 cdi:LabelForDisplay
52
53 ) ]];
54 sh:maxCount 1;
55.
56<#CodeListStructure-semantics> a sh:PropertyShape ;
57 sh:path cdi:CodeListStructure-semantics;
58 sh:node [ sh:property [ sh:path rdf:type; sh:minCount 1; sh:in (
59 cdi:ControlledVocabularyEntry
60
61 ) ]];
62 sh:maxCount 1;
63.
64<#CodeListStructure-specification> a sh:PropertyShape ;
65 sh:path cdi:CodeListStructure-specification;
66 sh:node [ sh:property [ sh:path rdf:type; sh:minCount 1; sh:in (
67 cdi:StructureSpecification
68
69 ) ]];
70 sh:maxCount 1;
71.
72<#CodeListStructure-topology> a sh:PropertyShape ;
73 sh:path cdi:CodeListStructure-topology;
74 sh:node [ sh:property [ sh:path rdf:type; sh:minCount 1; sh:in (
75 cdi:ControlledVocabularyEntry
76
77 ) ]];
78 sh:minCount 1;
79 sh:maxCount 1;
80.
81<#CodeListStructure-totality> a sh:PropertyShape ;
82 sh:path cdi:CodeListStructure-totality;
83 sh:node <#StructureExtent>
84 ;
85 sh:maxCount 1;
86.
87
88<#CodeListStructure_has_CodeRelationship> a sh:PropertyShape ;
89 sh:path cdi:CodeListStructure_has_CodeRelationship;
90 sh:node [ sh:property [ sh:path rdf:type; sh:minCount 1; sh:in (
91 cdi:CodeRelationship
92
93 ) ]];
94.
95<#rev_CodeListStructure_has_CodeRelationship> a sh:PropertyShape ;
96 sh:path [ sh:inversePath cdi:CodeListStructure_has_CodeRelationship ];
97 sh:minCount 1;
98 sh:maxCount 1;
99.
100<#CodeListStructure_structures_CodeList> a sh:PropertyShape ;
101 sh:path cdi:CodeListStructure_structures_CodeList;
102 sh:node [ sh:property [ sh:path rdf:type; sh:minCount 1; sh:in (
103 cdi:CodeList
104
105 ) ]];
106 sh:maxCount 1;
107.
108<#rev_CodeListStructure_structures_CodeList> a sh:PropertyShape ;
109 sh:path [ sh:inversePath cdi:CodeListStructure_structures_CodeList ];
110 sh:maxCount 1;
111.
Fragment for the class CodeListStructure (entire ShEx - Shape Expressions)
1# class CodeListStructure
2# based on the UML class DDICDIModels::DDICDILibrary::Classes::Representations::CodeListStructure
3cdi:CodeListStructureShape CLOSED {
4 a [cdi:CodeListStructure];
5 cdi:CodeListStructure-identifier @cdi:IdentifierShape?;
6 cdi:CodeListStructure-name @cdi:ObjectNameShape*;
7 cdi:CodeListStructure-purpose @cdi:InternationalStringShape?;
8 cdi:CodeListStructure-semantics @cdi:ControlledVocabularyEntryShape?;
9 cdi:CodeListStructure-specification @cdi:StructureSpecificationShape?;
10 cdi:CodeListStructure-topology @cdi:ControlledVocabularyEntryShape;
11 cdi:CodeListStructure-totality @cdi:StructureExtentShape?;
12 cdi:CodeListStructure_has_CodeRelationship @cdi:CodeRelationshipShape *;
13
14 cdi:CodeListStructure_structures_CodeList @cdi:CodeListShape ?;
15
16 }