Skip to Content

Wiki source code of 4 Specific Item Schemes

Last modified by Helena on 2025/07/16 02:09
Show last authors
1 {{box title="**Contents**"}}
2 {{toc/}}
3 {{/box}}
4
5 == 4.1 Introduction ==
6
7 The structures that are an arrangement of objects into [[hierarchies>>doc:sdmx:Glossary.Hierarchy.WebHome]] or lists based on characteristics, and which are maintained as a group inherit from //ItemScheme//. These concrete classes are:
8
9 Codelist
10 ConceptScheme
11 CategoryScheme
12 AgencyScheme, DataProviderScheme, MetadataProviderScheme,
13 DataConsumerScheme, OrganisationUnitScheme, which all inherit from the abstract class //OrganisationScheme//
14 ReportingTaxonomy
15 TransformationScheme
16 RulesetScheme
17 UserDefinedOperatorScheme
18 NamePersonalisationScheme
19 CustomTypeScheme
20 VtlMappingScheme
21
22 Note that the [[VTL>>doc:sdmx:Glossary.Validation and transformation language.WebHome]] related schemes (the last 6 of the above list) are detailed in a dedicated section below ([[section 15>>doc:Methodology.SDMX 3\.1 Standards\. Section 2\. Information model.15 Validation and Transformation Language.WebHome]]).
23
24 == 4.2 Inheritance View ==
25
26 The inheritance and relationship views are shown together in each of the diagrams in the specific sections below.
27
28 == 4.3 Codelist ==
29
30 === 4.3.1 Class Diagram ===
31
32 [[image:1749246291075-895.jpeg]]
33
34 **Figure 16: Class diagram of the Codelist**
35
36 === 4.3.2 Explanation of the Diagram ===
37
38 ==== 4.3.2.1 Narrative ====
39
40 The Codelist inherits from the //ItemScheme// and therefore has the following [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: id uri urn (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%) validFrom validTo [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]] serviceURL structureURL isPartial
41
42 The [[Code>>doc:sdmx:Glossary.Code.WebHome]] inherits from //Item// and has the following [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]:
43
44 id
45 uri
46 urn
47
48 Both Codelist and [[Code>>doc:sdmx:Glossary.Code.WebHome]] have the association to InternationalString to support a multilingual name, an optional multi-lingual description, and an association to [[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]] to support notes (not shown).
49
50 Through the inheritance the Codelist comprise one or more [[Codes>>doc:sdmx:Glossary.Code.WebHome]], and the [[Code>>doc:sdmx:Glossary.Code.WebHome]] itself can have one or more child [[Codes>>doc:sdmx:Glossary.Code.WebHome]] in the (inherited) [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]] association. Note that a child [[Code>>doc:sdmx:Glossary.Code.WebHome]] can have only one parent [[Code>>doc:sdmx:Glossary.Code.WebHome]] in this association. A more complex Hierarhcy, which allows multiple parents is described later.
51
52 A partial Codelist (where isPartial is set to 'true') is identical to a Codelist and contains the [[Code>>doc:sdmx:Glossary.Code.WebHome]] and associated names and descriptions, just as in a normal Codelist. However, its content is a subset of the full Codelist. The way this works is described in section [[3.5.3.1>>doc:Methodology.SDMX 3\.1 Standards\. Section 2\. Information model.3 SDMX Base Package.WebHome||anchor="H3.5.3.1Narrative"]] on //ItemScheme//.
53
54 ==== 4.3.2.2 Definitions ====
55
56 (% style="width:912.835px" %)
57 |**Class**|**Feature**|(% style="width:656px" %)**Description**
58 |[[Codelist>>doc:sdmx:Glossary.Code list.WebHome]]|(((
59 Inherits from
60 //ItemScheme//
61 )))|(% style="width:656px" %)A list from which some statistical (% style="color:#e74c3c" %)[[concepts>>doc:sdmx:Glossary.Concept.WebHome]](%%) (coded (% style="color:#e74c3c" %)[[concepts>>doc:sdmx:Glossary.Concept.WebHome]](%%)) take their values.
62 |[[Code>>doc:sdmx:Glossary.Code.WebHome]]|(((
63 Inherits from
64 Item
65 )))|(% style="width:656px" %)A language independent set of letters, numbers or symbols that represent a (% style="color:#e74c3c" %)[[concept>>doc:sdmx:Glossary.Concept.WebHome]](%%) whose meaning is described in a natural language.
66 | |hierarchy|(% style="width:656px" %)Associates the parent and the child [[codes>>doc:sdmx:Glossary.Code.WebHome]].
67 | |extends|(% style="width:656px" %)Associates a Codelist with any Codelists that it may extend.
68
69 ==== 4.3.3 Class Diagram – Codelist Extension ====
70
71 [[image:1749246291156-936.jpeg]]
72
73 **Figure 17: Class diagram for Codelist Extension**
74
75 ==== 4.3.3.1 Narrative ====
76
77 A Codelist may extend other Codelists via the CodelistExtension class. The latter, via the sequence, indicates the order of precedence of the extended Codelists for conflict resolution of [[Codes>>doc:sdmx:Glossary.Code.WebHome]]. Besides that, the prefix property is used to ensure uniqueness of inherited [[Codes>>doc:sdmx:Glossary.Code.WebHome]] in the extending[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^~[1~]^^>>path:#_ftn1]](%%) Codelist in case conflicting [[Codes>>doc:sdmx:Glossary.Code.WebHome]] must be included in the latter. Each CodelistExtension association may include one InclusiveCodeSelection or one ExclusiveCodeSelection; those allow including or excluding a specific selection of [[Codes>>doc:sdmx:Glossary.Code.WebHome]] from the extended Codelists.
78
79 The [[code>>doc:sdmx:Glossary.Code.WebHome]] selection classes may have MemberValues in order to specify the subset of the [[Codes>>doc:sdmx:Glossary.Code.WebHome]] that should be included or excluded from the extended Codelist. A MemberValue may have a value that corresponds to a [[Code>>doc:sdmx:Glossary.Code.WebHome]], including its children [[Codes>>doc:sdmx:Glossary.Code.WebHome]] (via the cascadeValues property), or even include instances of the wildcard character ‘%’ in order to point to a set of [[Codes>>doc:sdmx:Glossary.Code.WebHome]] with common parts in their identifiers.
80
81 ==== 4.3.3.2 Definitions ====
82
83 (% style="width:970.835px" %)
84 |**Class**|**Feature**|(% style="width:655px" %)**Description**
85 |CodelistExtension| |(% style="width:655px" %)The association between Codelists that may extend other Codelists.
86 | |prefix|(% style="width:655px" %)A prefix to be used for a Codelist used in a extension, in order to avoid [[Code>>doc:sdmx:Glossary.Code.WebHome]] Conflicts.
87 | |sequence|(% style="width:655px" %)(((
88 The order that will be used when extending a Codelist, for resolving [[Code>>doc:sdmx:Glossary.Code.WebHome]] conflicts. The latest Codelist used overrides any previous Codelist.
89 )))
90 |InclusiveCodeSelection| |(% style="width:655px" %)The subset of [[Codes>>doc:sdmx:Glossary.Code.WebHome]] to be included when extending a Codelist.
91 |ExclusiveCodeSelection| |(% style="width:655px" %)The subset of [[Codes>>doc:sdmx:Glossary.Code.WebHome]] to be excluded when extending a Codelist.
92 |MemberValue|(((
93 Inherits from:
94 //SelectionValue//
95 )))|(% style="width:655px" %)A collection of values based on [[Codes>>doc:sdmx:Glossary.Code.WebHome]] and their children.
96 | |cascadeValues|(% style="width:655px" %)A property to indicate if the child [[Codes>>doc:sdmx:Glossary.Code.WebHome]] of the selected [[Code>>doc:sdmx:Glossary.Code.WebHome]] shall be included in the selection. It is also possible to include children and exclude the [[Code>>doc:sdmx:Glossary.Code.WebHome]] by using the 'excluderoot' value.
97 | |value|(% style="width:655px" %)The value of the [[Code>>doc:sdmx:Glossary.Code.WebHome]] to include in the selection. It may include the ‘%’ character as a wildcard.
98
99 === 4.3.4 Class Diagram – Geospatial Codelist ===
100
101 The geospatial support is implemented via an extension of the normal Codelist. This is illustrated in the following diagrams.
102
103 [[image:1749246291164-838.jpeg]]
104
105 **Figure 18: Inheritance for the GeoCodelist**
106
107 [[image:1749246291175-231.jpeg]]
108
109 **Figure 19: Class diagram for Geospatial Codelist**
110
111 ==== 4.3.4.1 Narrative ====
112
113 A //GeoCodelist// is a specialisation of Codelist that includes geospatial information, by comprising a set of special [[Codes>>doc:sdmx:Glossary.Code.WebHome]], i.e., //GeoRefCode//s. A //GeoCodelist// may be implemented by any of the two following classes, via the geoType property:
114
115 GeographicCodelist
116
117 GeoGridCodelist
118
119 The former, i.e., GeographicCodelist, comprises a set of GeoFeatureSetCodes, by adding a value in the [[Code>>doc:sdmx:Glossary.Code.WebHome]] that follows a pattern to represent a geo feature set.
120
121 The latter, i.e., GeoGridCodelist, comprises a set of GridCodes, which are related to the gridDefinition specified in the GeoGridCodelist.
122
123 ==== 4.3.4.2 Definitions ====
124
125 (% style="width:960.835px" %)
126 |**Class**|**Feature**|(% style="width:559px" %)**Description**
127 |//GeoCodelist//|(((
128 Abstract Class Sub Classes:
129 GeographicCodelist
130 GeoGridCodelist
131 )))|(% style="width:559px" %)The abstract class that represents a special type of Codelist, which includes geospatial information.
132 | |geoType|(% style="width:559px" %)The type of Geo Codelist that the Codelist will become.
133 |//GeoRefCode//|(((
134 Abstract Class
135 Sub Classes:
136 GeoFeatureSetCode
137 GeoGridCode
138 )))|(% style="width:559px" %)The abstract class that represents a special type of [[Code>>doc:sdmx:Glossary.Code.WebHome]], which includes geospatial information.
139 |GeographicCodelist| |(% style="width:559px" %)A special Codelist that has been extended to add a geographical feature set to each of its items, typically, this would include all types of administrative geographies.
140 |GeoGridCodelist| |(% style="width:559px" %)A [[code list>>doc:sdmx:Glossary.Code list.WebHome]] that has defined a geographical grid composed of cells representing regular squared portions of the Earth.
141 | |gridDefinition|(% style="width:559px" %)Contains a regular expression string corresponding to the grid definition for the GeoGrid Codelist.
142 |GeoFeatureSetCode| |(% style="width:559px" %)A [[Code>>doc:sdmx:Glossary.Code.WebHome]] that has a geo feature set.
143 | |value|(% style="width:559px" %)The geo feature set of the [[Code>>doc:sdmx:Glossary.Code.WebHome]], which represents a set of points defining a feature in a format defined a predefined pattern (see section 6).
144 |GeoGridCode| |(% style="width:559px" %)A [[Code>>doc:sdmx:Glossary.Code.WebHome]] that represents a Geo Grid Cell belonging in a specific grid definition.
145 | |geoCell|(% style="width:559px" %)The value used to assign the [[Code>>doc:sdmx:Glossary.Code.WebHome]] to one cell in the grid.
146
147 == 4.4 ValueList ==
148
149 === 4.4.1 Class Diagram ===
150
151 [[image:1749246291179-291.jpeg]]
152
153 **Figure 20: Class diagram of the ValueList**
154
155 === 4.4.2 Explanation of the Diagram ===
156
157 ==== 4.4.2.1 Narrative ====
158
159 A ValueList inherits from //EnumeratedList// (and hence the //MaintenableArtefact//) and thus has the following [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]:
160
161 id
162 uri
163 urn
164 (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%)
165 validFrom
166 validTo
167 [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]]
168 registryURL
169 structureURL
170 repositoryURL
171
172 ValueItem inherits from //EnumeratedItem//, which adds an id, with relaxed (% style="color:#e74c3c" %)[[constraints>>doc:sdmx:Glossary.Constraint.WebHome]](%%), to the former.
173
174 Through the inheritance from //NameableArtefact// the ValueList has the association to InternationalString to support a multi-lingual name, an optional multi-lingual description, and an association to [[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]] to support notes (not shown). Similarly, the ValueItem, inherits the association to InternationalString and to the [[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]] from the //EnumeratedItem//.
175
176 The ValueList can have one or more ValueItems.
177
178 ==== 4.4.2.2 Definitions ====
179
180 (% style="width:929.835px" %)
181 |**Class**|(% style="width:175px" %)**Feature**|(% style="width:632px" %)**Description**
182 |ValueList|(% style="width:175px" %)(((
183 Inherits from
184 //EnumeratedList//
185 )))|(% style="width:632px" %)A list from which some statistical (% style="color:#e74c3c" %)[[concepts>>doc:sdmx:Glossary.Concept.WebHome]](%%) (enumerated (% style="color:#e74c3c" %)[[concepts>>doc:sdmx:Glossary.Concept.WebHome]](%%)) take their values.
186 |ValueItem|(% style="width:175px" %)(((
187 Inherits from
188 //EnumeratedItem//
189 )))|(% style="width:632px" %)A language independent set of letters, numbers or symbols that represent a (% style="color:#e74c3c" %)[[concept>>doc:sdmx:Glossary.Concept.WebHome]](%%) whose meaning is described in a natural language.
190
191 == 4.5 Concept Scheme and Concepts ==
192
193 === 4.5.1 Class Diagram - Inheritance ===
194
195 [[image:1749246291184-799.jpeg]]
196
197 **Figure 21 Class diagram of the Concept Scheme**
198
199 === 4.5.2 Explanation of the Diagram ===
200
201 The ConceptScheme inherits from the //ItemScheme //and therefore has the following [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]:
202
203 id
204 uri
205 urn
206 (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%) validFrom validTo
207 [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]]
208 registryURL
209 structureURL
210 repositoryURL
211 isPartial
212
213 (% style="color:#e74c3c" %)[[Concept>>doc:sdmx:Glossary.Concept.WebHome]](%%) inherits from Item and has the following [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]:
214
215 id
216 uri
217 urn
218
219 Through the inheritance from //NameableArtefact// both ConceptScheme and (% style="color:#e74c3c" %)[[Concept>>doc:sdmx:Glossary.Concept.WebHome]](%%) have the association to InternationalString to support a multi-lingual name, an optional multilingual description, and an association to [[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]] to support notes (not shown).
220
221 Through the inheritance from //ItemScheme// the ConceptScheme comprise one or more (% style="color:#e74c3c" %)[[Concepts>>doc:sdmx:Glossary.Concept.WebHome]](%%), and the (% style="color:#e74c3c" %)[[Concept>>doc:sdmx:Glossary.Concept.WebHome]](%%) itself can have one or more child (% style="color:#e74c3c" %)[[Concepts>>doc:sdmx:Glossary.Concept.WebHome]](%%) in the (inherited) [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]] association. Note that a child (% style="color:#e74c3c" %)[[Concept>>doc:sdmx:Glossary.Concept.WebHome]](%%) can have only one parent (% style="color:#e74c3c" %)[[Concept>>doc:sdmx:Glossary.Concept.WebHome]](%%) in this association.
222
223 A partial ConceptScheme (where isPartial is set to “true”) is identical to a ConceptScheme and contains the (% style="color:#e74c3c" %)[[Concept>>doc:sdmx:Glossary.Concept.WebHome]](%%) and associated names and descriptions, just as in a normal ConceptScheme. However, its content is a subset of the full ConceptScheme. The way this works is described in section [[3.5.3.1>>doc:Methodology.SDMX 3\.1 Standards\. Section 2\. Information model.3 SDMX Base Package.WebHome||anchor="H3.5.3.1Narrative"]] on ItemScheme.
224
225 === 4.5.3 Class Diagram Relationship ===
226
227 [[image:1749246291189-654.jpeg]]
228
229 **Figure 22: Relationship class diagram of the Concept Scheme**
230
231 === 4.5.4 Explanation of the diagram ===
232
233 ==== 4.5.4.1 Narrative ====
234
235 The ConceptScheme can have one or more (% style="color:#e74c3c" %)[[Concepts>>doc:sdmx:Glossary.Concept.WebHome]](%%). A (% style="color:#e74c3c" %)[[Concept>>doc:sdmx:Glossary.Concept.WebHome]](%%) can have zero or more child (% style="color:#e74c3c" %)[[Concepts>>doc:sdmx:Glossary.Concept.WebHome]](%%), thus supporting a [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]] of (% style="color:#e74c3c" %)[[Concepts>>doc:sdmx:Glossary.Concept.WebHome]](%%). Note that a child (% style="color:#e74c3c" %)[[Concept>>doc:sdmx:Glossary.Concept.WebHome]](%%) can have only one parent (% style="color:#e74c3c" %)[[Concept>>doc:sdmx:Glossary.Concept.WebHome]](%%) in this association. The purpose of the [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]] is to relate (% style="color:#e74c3c" %)[[concepts>>doc:sdmx:Glossary.Concept.WebHome]](%%) that have a semantic relationship: for example, a Reporting_Country and Vis_a_Vis_Country may both have Country as a parent (% style="color:#e74c3c" %)[[concept>>doc:sdmx:Glossary.Concept.WebHome]](%%), or a (% style="color:#e74c3c" %)[[CONTACT>>doc:sdmx:Glossary.Contact.WebHome]](%%) may have a PRIMARY_CONTACT as a child (% style="color:#e74c3c" %)[[concept>>doc:sdmx:Glossary.Concept.WebHome]](%%). It is not the purpose of such schemes to define reporting structures: these reporting structures are defined in the MetadataStructureDefinition.
236
237 The (% style="color:#e74c3c" %)[[Concept>>doc:sdmx:Glossary.Concept.WebHome]](%%) can be associated with a coreRepresentation. The coreRepresentation is the specification of the format and value domain of the (% style="color:#e74c3c" %)[[Concept>>doc:sdmx:Glossary.Concept.WebHome]](%%) when used on a structure like a DataStructureDefinition or a MetadataStructureDefinition, unless the specification of the [[Representation>>doc:sdmx:Glossary.Representation.WebHome]] is overridden in the relevant structure definition. In a hierarchical ConceptScheme the [[Representation>>doc:sdmx:Glossary.Representation.WebHome]] is inherited from the parent (% style="color:#e74c3c" %)[[Concept>>doc:sdmx:Glossary.Concept.WebHome]](%%) unless overridden at the level of the child (% style="color:#e74c3c" %)[[Concept>>doc:sdmx:Glossary.Concept.WebHome]](%%).
238
239 The [[Representation>>doc:sdmx:Glossary.Representation.WebHome]] is documented in more detail in the section on the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] Base.
240
241 The (% style="color:#e74c3c" %)[[Concept>>doc:sdmx:Glossary.Concept.WebHome]](%%) may be related to a (% style="color:#e74c3c" %)[[concept>>doc:sdmx:Glossary.Concept.WebHome]](%%) described in terms of the ISO/IEC 11179 standard. The ISOConceptReference identifies this (% style="color:#e74c3c" %)[[concept>>doc:sdmx:Glossary.Concept.WebHome]](%%) and [[concept scheme>>doc:sdmx:Glossary.Concept scheme.WebHome]] in which it is contained.
242
243 ==== 4.5.4.2 Definitions ====
244
245 (% style="width:912.835px" %)
246 |(% style="width:170px" %)**Class**|(% style="width:184px" %)**Feature**|(% style="width:548px" %)**Description**
247 |(% style="width:170px" %)(((
248 ConceptScheme
249 )))|(% style="width:184px" %)(((
250 Inherits from
251 //ItemScheme//
252 )))|(% style="width:548px" %)The descriptive information for an arrangement or division of (% style="color:#e74c3c" %)[[concepts>>doc:sdmx:Glossary.Concept.WebHome]](%%) into groups based on characteristics, which the objects have in common.
253 |(% style="width:170px" %)Concept|(% style="width:184px" %)(((
254 Inherits from
255 //Item//
256 )))|(% style="width:548px" %)A (% style="color:#e74c3c" %)[[concept>>doc:sdmx:Glossary.Concept.WebHome]](%%) is a unit of knowledge created by a unique combination of characteristics.
257 |(% style="width:170px" %) |(% style="width:184px" %)/hierarchy|(% style="width:548px" %)Associates the parent and the child (% style="color:#e74c3c" %)[[concept>>doc:sdmx:Glossary.Concept.WebHome]](%%).
258 |(% style="width:170px" %) |(% style="width:184px" %)coreRepresentation|(% style="width:548px" %)Associates a [[Representation>>doc:sdmx:Glossary.Representation.WebHome]].
259 |(% style="width:170px" %) |(% style="width:184px" %)+ISOConcept|(% style="width:548px" %)Association to an ISO concept reference.
260 |(% style="width:170px" %)ISOConceptReference|(% style="width:184px" %) |(% style="width:548px" %)The identity of an ISO concept definition.
261 |(% style="width:170px" %) |(% style="width:184px" %)conceptAgency|(% style="width:548px" %)The [[maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]] of the [[concept scheme>>doc:sdmx:Glossary.Concept scheme.WebHome]] containing the (% style="color:#e74c3c" %)[[concept>>doc:sdmx:Glossary.Concept.WebHome]](%%).
262 |(% style="width:170px" %) |(% style="width:184px" %)conceptSchemeID|(% style="width:548px" %)The identifier of the [[concept scheme>>doc:sdmx:Glossary.Concept scheme.WebHome]].
263 |(% style="width:170px" %) |(% style="width:184px" %)conceptID|(% style="width:548px" %)The identifier of the (% style="color:#e74c3c" %)[[concept>>doc:sdmx:Glossary.Concept.WebHome]](%%).
264
265 == 4.6 Category Scheme ==
266
267 === 4.6.1 Context ===
268
269 This package defines the structure that supports the definition of and relationships between [[categories>>doc:sdmx:Glossary.Category.WebHome]] in a [[category scheme>>doc:sdmx:Glossary.Category scheme.WebHome]]. It is similar to the package for [[concept scheme>>doc:sdmx:Glossary.Concept scheme.WebHome]]. An example of a [[category scheme>>doc:sdmx:Glossary.Category scheme.WebHome]] is one which categorises data – sometimes known as a subject matter domain scheme or a data [[category scheme>>doc:sdmx:Glossary.Category scheme.WebHome]]. Importantly, as will be seen later, the individual nodes in the scheme (the “[[categories>>doc:sdmx:Glossary.Category.WebHome]]”) can be associated to any set of IdentiableArtefacts in a Categorisation.
270
271 === 4.6.2 Class diagram Inheritance ===
272
273 [[image:1749246291193-743.jpeg]]
274
275 **Figure 23 Inheritance Class diagram of the Category Scheme**
276
277 === 4.6.3 Explanation of the Diagram ===
278
279 ==== 4.6.3.1 Narrative ====
280
281 The [[categories>>doc:sdmx:Glossary.Category.WebHome]] are modelled as a hierarchical //ItemScheme//. The CategoryScheme inherits from the //ItemScheme// and has the following [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]:
282
283 id
284 uri
285 urn
286 version
287 validFrom
288 validTo
289 [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]]
290 structureURL
291 serviceURL
292 isPartial
293
294 [[Category>>doc:sdmx:Glossary.Category.WebHome]] inherits from //Item// and has the following [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]:
295
296 id
297 uri
298 urn
299
300 Both CategoryScheme and [[Category>>doc:sdmx:Glossary.Category.WebHome]] have the association to InternationalString to support a multi-lingual name, an optional multi-lingual description, and an association to [[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]] to support notes (not shown on the model).
301
302 Through the inheritance the CategoryScheme comprise one or more [[Categorys>>doc:sdmx:Glossary.Category.WebHome]], and the [[Category>>doc:sdmx:Glossary.Category.WebHome]] itself can have one or more child [[Category>>doc:sdmx:Glossary.Category.WebHome]] in the (inherited) [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]] association. Note that a child [[Category>>doc:sdmx:Glossary.Category.WebHome]] can have only one parent [[Category>>doc:sdmx:Glossary.Category.WebHome]] in this association.
303
304 A partial CategoryScheme (where isPartial is set to “true”) is identical to a CategoryScheme and contains the [[Category>>doc:sdmx:Glossary.Category.WebHome]] and associated names and descriptions, just as in a normal CategoryScheme. However, its content is a subset of the full CategoryScheme. The way this works is described in section [[3.5.3.1>>doc:Methodology.SDMX 3\.1 Standards\. Section 2\. Information model.3 SDMX Base Package.WebHome||anchor="H3.5.3.1Narrative"]] on ItemScheme.
305
306 === 4.6.4 Class diagram Relationship ===
307
308 [[image:1749246291197-631.jpeg]]
309
310 **Figure 24: Relationship Class diagram of the Category Scheme**
311
312 The CategoryScheme can have one or more [[Categorys>>doc:sdmx:Glossary.Category.WebHome]]. The [[Category>>doc:sdmx:Glossary.Category.WebHome]] is Identifiable and has identity information. A [[Category>>doc:sdmx:Glossary.Category.WebHome]] can have zero or more child [[Categorys>>doc:sdmx:Glossary.Category.WebHome]], thus supporting a [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]] of [[Categorys>>doc:sdmx:Glossary.Category.WebHome]]. Any IdentifiableArtefact can be +categorisedBy a [[Category>>doc:sdmx:Glossary.Category.WebHome]]. This is achieved by means of a Categorisation. Each Categorisation can associate one IdentifiableArtefact with one [[Category>>doc:sdmx:Glossary.Category.WebHome]]. Multiple Categorisations can be used to build a set of IdentifiableArtefacts that are +categorisedBy the same [[Category>>doc:sdmx:Glossary.Category.WebHome]]. Note that there is no navigation (i.e. no embedded reference) to the Categorisation from the [[Category>>doc:sdmx:Glossary.Category.WebHome]]. From an implementation perspective this is necessary as Categorisation has no effect on the versioning of either the CategoryScheme or the IdentifiableArtefact.
313
314 ==== 4.6.4.1 Definitions ====
315
316 (% style="width:935.835px" %)
317 |**Class**|**Feature**|(% style="width:601px" %)**Description**
318 |CategoryScheme|(((
319 Inherits from
320 //ItemScheme//
321 )))|(% style="width:601px" %)The descriptive information for an arrangement or division of [[categories>>doc:sdmx:Glossary.Category.WebHome]] into groups based on characteristics, which the objects have in common.
322 | |/items|(% style="width:601px" %)Associates the [[categories>>doc:sdmx:Glossary.Category.WebHome]].
323 |[[Category>>doc:sdmx:Glossary.Category.WebHome]]|(((
324 Inherits from
325 //Item//
326 )))|(% style="width:601px" %)An item at any (% style="color:#e74c3c" %)[[level>>doc:sdmx:Glossary.Level.WebHome]](%%) within a classification, typically tabulation [[categories>>doc:sdmx:Glossary.Category.WebHome]], sections, subsections, divisions, subdivisions, groups, subgroups, classes and subclasses.
327 | |/hierarchy|(% style="width:601px" %)Associates the parent and the child [[Category>>doc:sdmx:Glossary.Category.WebHome]].
328 |Categorisation|(((
329 Inherits from
330 //MaintainableArtefact//
331 )))|(% style="width:601px" %)Associates an Identifable [[Artefact>>doc:sdmx:Glossary.Artefact.WebHome]] with a [[Category>>doc:sdmx:Glossary.Category.WebHome]].
332 | |+categorisedArtefact|(% style="width:601px" %)Associates the Identifable [[Artefact>>doc:sdmx:Glossary.Artefact.WebHome]].
333 | |+categorisedBy|(% style="width:601px" %)Associates the [[Category>>doc:sdmx:Glossary.Category.WebHome]].
334
335 == 4.7 Organisation Scheme ==
336
337 === 4.7.1 Class Diagram ===
338
339 [[image:1749246291201-410.jpeg]]
340
341 **Figure 25 The Organisation Scheme class diagram**
342
343 === 4.7.2 Explanation of the Diagram ===
344
345 ==== 4.7.2.1 Narrative ====
346
347 The //OrganisationScheme// is abstract. It contains //Organisation// which is also abstract. The //Organisation// can have child //Organisation//.
348
349 The //OrganisationScheme// can be one of five types:
350
351 1. AgencyScheme – contains Agency which is restricted to a flat list of agencies (i.e., there is no [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]]). Note that the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] system of (Maintenance) Agency can be hierarchic and this is explained in more detail in the SDMX Standards Section 6 “Technical Notes”.
352 1. DataProviderScheme – contains DataProvider which is restricted to a flat list of agencies (i.e., there is no [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]]).
353 1. MetadataProviderScheme – contains MetadataProvider which is restricted to a flat list of agencies (i.e., there is no [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]]).
354 1. DataConsumerScheme – contains DataConsumer which is restricted to a flat list of agencies (i.e., there is no [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]]).
355 1. OrganisationUnitScheme – contains OrganisationUnit which does inherit the /[[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]] association from Organisation.
356
357 [[Reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] can be attached to the //Organisation// by means of the metadata attachment mechanism. This mechanism is explained in the [[Reference Metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] section of this document (see section 7). This means that the model does not specify the specific [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] that can be attached to a DataProvider, MetadataProvider, DataConsumer, OrganisationUnit or Agency, except for limited (% style="color:#e74c3c" %)[[Contact>>doc:sdmx:Glossary.Contact.WebHome]](%%) information.
358
359 A partial //OrganisationScheme// (where isPartial is set to “true”) is identical to an //OrganisationScheme// and contains the //Organisation// and associated names and descriptions, just as in a normal //OrganisationScheme//. However, its content is a subset of the full //OrganisationScheme//. The way this works is described in section [[3.5.3.1>>doc:Methodology.SDMX 3\.1 Standards\. Section 2\. Information model.3 SDMX Base Package.WebHome||anchor="H3.5.3.1Narrative"]] on //ItemScheme//.
360
361 ==== 4.7.2.2 Definitions ====
362
363 (% style="width:946.835px" %)
364 |**Class**|**Feature**|(% style="width:540px" %)**Description**
365 |//OrganisationScheme//|(((
366 Abstract Class
367 Inherits from
368 //ItemScheme//
369 Sub classes are:
370 AgencyScheme
371 DataProviderScheme
372 MetadataProviderScheme
373 DataConsumerScheme
374 OrganisationUnitScheme
375 )))|(% style="width:540px" %)A maintained collection of Organisations.
376 | |/items|(% style="width:540px" %)Association to the Organisations in the scheme.
377 |//Organisation//|(((
378 Abstract Class
379 Inherits from
380 //Item//
381 Sub classes are:
382 Agency
383 DataProvider
384 MetadataProvider
385 DataConsumer
386 OrganisationUnit
387 )))|(% style="width:540px" %)An organisation is a unique framework of authority within which a person or persons act, or are designated to act, towards some purpose.
388 | |+contact|(% style="width:540px" %)Association to the (% style="color:#e74c3c" %)[[Contact>>doc:sdmx:Glossary.Contact.WebHome]](%%) information.
389 | |/hierarchy|(% style="width:540px" %)Association to child Organisations.
390 |(%%)(% style="color:#e74c3c" %)[[Contact>>doc:sdmx:Glossary.Contact.WebHome]]| |(% style="width:540px" %)An instance of a role of an individual or an organization (or organization part or organization person) to whom an information item(s), a material object(s) and/or person(s) can be sent to or from in a specified context.
391 | |name|(% style="width:540px" %)The designation of the Contact person by a linguistic expression.
392 | |organisationUnit|(% style="width:540px" %)The designation of the organisational structure by a linguistic expression, within which Contact person works.
393 | |responsibility|(% style="width:540px" %)The function of the contact person with respect to the organisation role for which this person is the [[Contact>>doc:sdmx:Glossary.Contact.WebHome]].
394 | |telephone|(% style="width:540px" %)The [[telephone number>>doc:sdmx:Glossary.Contact phone number.WebHome]] of the [[Contact>>doc:sdmx:Glossary.Contact.WebHome]].
395 | |fax|(% style="width:540px" %)The fax number of the [[Contact>>doc:sdmx:Glossary.Contact.WebHome]].
396 | |email|(% style="width:540px" %)The Internet e-mail address of the [[Contact>>doc:sdmx:Glossary.Contact.WebHome]].
397 | |X400|(% style="width:540px" %)The X400 address of the (% style="color:#e74c3c" %)[[Contact>>doc:sdmx:Glossary.Contact.WebHome]](%%).
398 | |uri|(% style="width:540px" %)The URL address of the (% style="color:#e74c3c" %)[[Contact>>doc:sdmx:Glossary.Contact.WebHome]](%%).
399 |AgencyScheme| |(% style="width:540px" %)A maintained collection of Maintenance Agencies.
400 | |/items|(% style="width:540px" %)Association to the [[Maintenance Agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]] in the scheme.
401 |DataProviderScheme| |(% style="width:540px" %)A maintained collection of [[Data Providers>>doc:sdmx:Glossary.Data provider.WebHome]].
402 | |/items|(% style="width:540px" %)Association to the [[Data Providers>>doc:sdmx:Glossary.Data provider.WebHome]] in the scheme.
403 |MetadataProviderScheme| |(% style="width:540px" %)A maintained collection of Metadata Providers.
404 | |/items|(% style="width:540px" %)Association to the Metadata Providers in the scheme.
405 |DataConsumerScheme| |(% style="width:540px" %)A maintained collection of [[Data Consumers>>doc:sdmx:Glossary.Data consumer.WebHome]].
406 | |/items|(% style="width:540px" %)Association to the [[Data Consumers>>doc:sdmx:Glossary.Data consumer.WebHome]] in the scheme.
407 |OrganisationUnitScheme| |(% style="width:540px" %)A maintained collection of Organisation Units.
408 | |/items|(% style="width:540px" %)Association to the Organisation Units in the scheme.
409 |Agency|(((
410 Inherits from
411 //Organisation//
412 )))|(% style="width:540px" %)Responsible agency for maintaining [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] such as statistical classifications, glossaries, [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] such as Data and [[Metadata Structure Definitions>>doc:sdmx:Glossary.Metadata structure definition.WebHome]], (% style="color:#e74c3c" %)[[Concepts>>doc:sdmx:Glossary.Concept.WebHome]](%%) and [[Code lists>>doc:sdmx:Glossary.Code list.WebHome]].
413 |DataProvider|(((
414 Inherits from
415 //Organisation//
416 )))|(% style="width:540px" %)An organisation that produces data.
417 |MetadataProvider|(((
418 Inherits from
419 //Organisation//
420 )))|(% style="width:540px" %)An organisation that produces [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]].
421 |DataConsumer|(((
422 Inherits from
423 //Organisation//
424 )))|(% style="width:540px" %)An organisation using data as input for further processing.
425 |OrganisationUnit|(((
426 Inherits from
427 //Organisation//
428 )))|(% style="width:540px" %)A designation in the organisational structure.
429 | |/hierarchy|(% style="width:540px" %)Association to child Organisation Units
430
431 == 4.8 Reporting Taxonomy ==
432
433 === 4.8.1 Class Diagram ===
434
435 [[image:1749246291205-630.jpeg]]
436
437 **Figure 26: Class diagram of the Reporting Taxonomy**
438
439 === 4.8.2 Explanation of the Diagram ===
440
441 ==== 4.8.2.1 Narrative ====
442
443 In some data reporting environments, and in particular those in primary reporting, a report may comprise a variety of heterogeneous data, each described by a different //Structure//. Equally, a specific disseminated or published report may also comprise a variety of heterogeneous data. The definition of the set of linked sub reports is supported by the ReportingTaxonomy.
444
445 The ReportingTaxonomy is a specialised form of //ItemScheme//. Each ReportingCategory of the ReportingTaxonomy can link to one or more //StructureUsage// which itself can be one of [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]], or [[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]], and one or more //Structure//, which itself can be one of DataStructureDefinition or MetadataStructureDefinition. It is expected that within a specific ReportingTaxonomy each [[Category>>doc:sdmx:Glossary.Category.WebHome]] that is linked in this way will be linked to the same class (e.g. all [[Category>>doc:sdmx:Glossary.Category.WebHome]] in the scheme will link to a [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]]). Note that a ReportingCategory can have child ReportingCategory and in this way it is possible to define a hierarchical ReportingTaxonomy. It is possible in this taxonomy that some ReportingCategory are defined just to give a reporting structure. For instance:
446
447 Section 1
448
449 1. linked to Datafow_1
450 1. linked to Datafow_2
451
452 Section 2
453
454 1. linked to Datafow_3
455 1. linked to Datafow_4
456
457 Here, the nodes of Section 1 and Section 2 would not be linked to [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] but the other would be linked to a [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] (and hence the DataStructureDefinition).
458
459 A partial ReportingTaxonomy (where isPartial is set to “true”) is identical to a ReportingTaxonomy and contains the ReportingCategory and associated names and descriptions, just as in a normal ReportingTaxonomy. However, its content is a sub set of the full ReportingTaxonomy The way this works is described in section [[3.5.3.1>>doc:Methodology.SDMX 3\.1 Standards\. Section 2\. Information model.3 SDMX Base Package.WebHome||anchor="H3.5.3.1Narrative"]] on //ItemScheme//.
460
461 ==== 4.8.2.2 Definitions ====
462
463 (% style="width:969.835px" %)
464 |**Class**|**Feature**|(% style="width:668px" %)**Description**
465 |ReportingTaxonomy|(((
466 Inherits from
467 //ItemScheme//
468 )))|(% style="width:668px" %)A scheme which defines the composition structure of a data report where each [[component>>doc:sdmx:Glossary.Component.WebHome]] can be described by an independent [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] or [[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]].
469 | |/items|(% style="width:668px" %)Associates the Reporting [[Category>>doc:sdmx:Glossary.Category.WebHome]]
470 |ReportingCategory|Inherits from //Item//|(% style="width:668px" %)A [[component>>doc:sdmx:Glossary.Component.WebHome]] that gives structure to the report and links to data and metadata.
471 | |/hierarchy|(% style="width:668px" %)Associates child Reporting [[Category>>doc:sdmx:Glossary.Category.WebHome]].
472 | |+flow|(% style="width:668px" %)Association to the data and [[metadata flows>>doc:sdmx:Glossary.Metadataflow.WebHome]] that link to metadata about the provisioning and related data and [[metadata sets>>doc:sdmx:Glossary.Metadata set.WebHome]], and the structures that define them.
473 | |+structure|(% style="width:668px" %)Association to the [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] and [[Metadata Structure Definitions>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] which define the [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] describing the data and metadata that are contained at this part of the report.
474
475
476
477 ----
478
479 [[~[1~]>>path:#_ftnref1]] The Codelist that extends 0..* Codelists is the 'extending' Codelist, while the Codelist(s) that are inherited is/are the 'extended' Codelist(s).