Skip to Content

Wiki source code of 4 Specific Item Schemes

Version 6.1 by Helena on 2025/05/22 00:41
Hide last authors
Helena 3.2 1 {{box title="**Contents**"}}
2 {{toc/}}
3 {{/box}}
Helena 2.1 4
5 == {{id name="_Toc370987"/}}4.1 Introduction ==
6
7 The structures that are an arrangement of objects into hierarchies or lists based on characteristics, and which are maintained as a group inherit from //ItemScheme//. These concrete classes are:
8
Helena 3.3 9 * Codelist
10 * ConceptScheme
11 * CategoryScheme
Helena 2.1 12 * AgencyScheme, DataProviderScheme, DataConsumerScheme, OrganisationUnitScheme which all inherit from the abstract class //OrganisationScheme//
Helena 3.3 13 * Reporting Taxonomy
Helena 2.1 14
15 == {{id name="_Toc370988"/}}4.2 Inheritance View ==
16
17 The inheritance and relationship views are shown together in each of the diagrams in the specific sections below.
18
19 == {{id name="_Toc370989"/}}4.3 Codelist ==
20
21 === {{id name="_Toc370990"/}}4.3.1 Class Diagram ===
22
Helena 3.7 23 [[image:1747732337979-971.png]]
24
Helena 2.1 25 **Figure 15 Class diagram of the Codelist**
26
27 === {{id name="_Toc370991"/}}4.3.2 Explanation of the Diagram ===
28
29 ==== 4.3.2.1 Narrative ====
30
31 The Codelist inherits from the //ItemScheme// and therefore has the following attributes:
32
33 * id
34 * uri
35 * urn
36 * version
Helena 3.2 37 * validFrom
38 * validTo
Helena 2.1 39 * isExternalReference
40 * serviceURL
41 * structureURL
42 * final
43 * isPartial
44
45 The Code inherits from //Item// and has the following attributes:
46
47 * id
48 * uri
49 * urn
50
51 Both Codelist and Code have the association to InternationalString to support a multi-lingual name, an optional multi-lingual description, and an association to Annotation to support notes (not shown).
52
53 Through the inheritance the Codelist comprise one or more Codes, and the Code itself can have one or more child Codes in the (inherited) hierarchy association. Note that a child Code can have only one parent Code in this association. A more complex HierachicalCodelist which allow multiple parents and multiple hierarchies is described later.
54
55 A partial Codelist (where isPartial is set to “true”) is identical to a Codelist and contains the Code and associated names and descriptions, just as in a normal code list. However, its content is a sub set of the full Codelist. The way this works is described in section 3.5.3.1 on //ItemScheme//.
56
57 ==== 4.3.2.2 Definitions ====
58
59 (((
Helena 3.5 60 (% style="width:905.294px" %)
61 |(% style="width:132px" %)**Class**|(% style="width:172px" %)**Feature**|(% style="width:598px" %)**Description**
62 |(% style="width:132px" %)Codelist|(% style="width:172px" %)(((
Helena 2.1 63 Inherits from
64 //ItemScheme//
Helena 3.5 65 )))|(% style="width:598px" %)A list from which some statistical concepts (coded concepts) take their values.
66 |(% style="width:132px" %)Code|(% style="width:172px" %)(((
Helena 2.1 67 Inherits from
68 //Item//
Helena 3.5 69 )))|(% style="width:598px" %)A language independent set of letters, numbers or symbols that represent a concept whose meaning is described in a natural language.
70 |(% style="width:132px" %) |(% style="width:172px" %)/hierarchy|(% style="width:598px" %)Associates the parent and the child codes.
Helena 2.1 71 )))
72
73 == {{id name="_Toc370992"/}}4.4 Concept Scheme and Concepts ==
74
75 === {{id name="_Toc370993"/}}4.4.1 Class Diagram - Inheritance ===
76
Helena 3.7 77 [[image:1747732287949-594.png]]
78
Helena 2.1 79 **Figure 16 Class diagram of the Concept Scheme**
80
81 === {{id name="_Toc370994"/}}4.4.2 Explanation of the Diagram ===
82
83 The ConceptScheme inherits from the //ItemScheme //and therefore has the following attributes:
84
Helena 3.3 85 * id
86 * uri
87 * urn
88 * version
89 * validFrom
90 * validTo
Helena 2.1 91 * isExternalReference
92 * registryURL
93 * structureURL
94 * repositoryURL
Helena 3.3 95 * final
96 * isPartial
Helena 2.1 97
98 Concept inherits from Item and has the following attributes:
99
100 * id
101 * uri
102 * urn
103
104 Through the inheritance from //NameableArtefact// both ConceptScheme and Concept have the association to InternationalString to support a multi-lingual name, an optional multi-lingual description, and an association to Annotation to support notes (not shown).
105
106 Through the inheritance from //ItemScheme// the ConceptScheme comprise one or more Concepts, and the Concept itself can have one or more child Concepts in the (inherited) hierarchy association. Note that a child Concept can have only one parent Concept in this association.
107
108 A partial ConceptScheme (where isPartial is set to “true”) is identical to a ConceptScheme and contains the Concept and associated names and descriptions, just as in a normal ConceptScheme. However, its content is a sub set of the full ConceptScheme.
109
110 The way this works is described in section 3.5.3.1 on ItemScheme.
111
112 === {{id name="_Toc370995"/}}4.4.3 Class Diagram - Relationship ===
113
Helena 3.7 114 [[image:1747732242162-856.png]]
Helena 3.4 115
Helena 2.1 116 **Figure 17: Relationship class diagram of the Concept Scheme**
117
118 === {{id name="_Toc370996"/}}4.4.4 Explanation of the diagram ===
119
120 ==== 4.4.4.1 Narrative ====
121
Helena 3.7 122 The ConceptScheme can have one or more Concepts. A Concept can have zero or more child Concepts, thus supporting a hierarchy of Concepts. Note that a child Concept can have only one parent Concept in this association. The purpose of the hierarchy is to relate concepts that have a semantic relationship: for example a Reporting_Country and Vis_a_Vis_Country may both have Country as a parent concept, or a CONTACT may have a PRIMARY_CONTACT as a child concept. It is not the purpose of such schemes to define reporting structures: these reporting structures are defined in the MetadataStructureDefinition.
Helena 2.1 123
Helena 3.8 124 The Concept can be associated with a coreRepresentation. The coreRepresentation isthe specification of the format and value domain of the Concept when used on a structure like a DataStructureDefinition or a MetadataStructureDefinition, unless the specification of the Representation is overridden in the relevant structure definition. In a hierarchical ConceptScheme the Representation is inherited from the parent Concept unless overridden at the level of the child Concept.
Helena 2.1 125
126 Note that the ConceptScheme is used as the Representation of the MeasureDimension in a DataStructureDefinition (see 5.3.2). Each Concept in this ConceptScheme is a specific measure, each of which can be given a coreRepresentation. Thus the valid format of the observation for each measure when reported in a data set for the MeasureDimension is specified in the Concept. This allows a different format for each measure. This is covered in more detail in 5.3.
127
128 The Representation is documented in more detail in the section on the SDMX Base.
129
130 The Concept may be related to a concept described in terms of the ISO/IEC 11179 standard. The ISOConceptReference identifies this concept and concept scheme in which it is contained.
131
132 ==== 4.4.4.2 Definitions ====
133
134 (((
Helena 3.4 135 (% style="width:931.294px" %)
136 |(% style="width:195px" %)**Class**|(% style="width:210px" %)**Feature**|(% style="width:522px" %)**Description**
137 |(% style="width:195px" %)ConceptScheme|(% style="width:210px" %)(((
Helena 2.1 138 Inherits from
139
140 //ItemScheme//
Helena 3.4 141 )))|(% style="width:522px" %)The descriptive information for an arrangement or division of concepts into groups based on characteristics, which the objects have in common.
142 |(% style="width:195px" %)Concept|(% style="width:210px" %)(((
Helena 2.1 143 Inherits from
144
145 //Item//
Helena 3.4 146 )))|(% style="width:522px" %)A concept is a unit of knowledge created by a unique combination of characteristics.
147 |(% style="width:195px" %) |(% style="width:210px" %)/hierarchy|(% style="width:522px" %)Associates the parent and the child concept.
148 |(% style="width:195px" %) |(% style="width:210px" %)coreRepresentation|(% style="width:522px" %)Associates a Representation.
149 |(% style="width:195px" %) |(% style="width:210px" %)+ISOConcept|(% style="width:522px" %)Association to an ISO concept reference.
150 |(% style="width:195px" %)ISOConceptReference|(% style="width:210px" %) |(% style="width:522px" %)The identity of an ISO concept definition.
151 |(% style="width:195px" %) |(% style="width:210px" %)conceptAgency|(% style="width:522px" %)The maintenance agency of the concept scheme containing the concept.
152 |(% style="width:195px" %) |(% style="width:210px" %)conceptSchemeID|(% style="width:522px" %)The identifier of the concept scheme.
153 |(% style="width:195px" %) |(% style="width:210px" %)conceptID|(% style="width:522px" %)The identifier of the concept.
Helena 2.1 154 )))
155
156 == {{id name="_Toc370997"/}}4.5 Category Scheme ==
157
158 === {{id name="_Toc370998"/}}4.5.1 Context ===
159
160 This package defines the structure that supports the definition of and relationships between categories in a category scheme. It is similar to the package for concept scheme. An example of a category scheme is one which categorises data – sometimes known as a subject matter domain scheme or a data category scheme. Importantly, as will be seen later, the individual nodes in the scheme (the “categories”) can be associated to any set of IdentiableArtefacts in a Categorisation.
161
162 === {{id name="_Toc370999"/}}4.5.2 Class diagram - Inheritance ===
163
Helena 3.9 164 ====== [[image:1747732448450-721.png]] ======
Helena 2.1 165
Helena 3.9 166 (% class="wikigeneratedid" id="HFigure18InheritanceClassdiagramoftheCategoryScheme" %)
167 **Figure 18 Inheritance Class diagram of the Category Scheme**
168
Helena 2.1 169 === {{id name="_Toc371000"/}}4.5.3 Explanation of the Diagram ===
170
171 ==== 4.5.3.1 Narrative ====
172
173 The categories are modelled as a hierarchical //ItemScheme//. The CategoryScheme inherits from the //ItemScheme// and has the following attributes:
174
Helena 3.4 175 * id
Helena 2.1 176 * uri
177 * urn
178 * version
179 * validFrom
180 * validTo
181 * isExternalReference
182 * structureURL
183 * serviceURL
184 * final
Helena 3.4 185 * isPartial
Helena 2.1 186
187 Category inherits from //Item// and has the following attributes:
188
189 * //id//
190 * //uri//
191 * //urn//
192
193 Both CategoryScheme and Category have the association to InternationalString to support a multi-lingual name, an optional multi-lingual description, and an association to Annotation to support notes (not shown on the model).
194
195 Through the inheritance the CategoryScheme comprise one or more Categorys, and the Category itself can have one or more child Category in the (inherited) hierarchy association. Note that a child Category can have only one parent Category in this association.
196
197 A partial CategoryScheme (where isPartial is set to “true”) is identical to a CategoryScheme and contains the Category and associated names and descriptions, just as in a normal CategoryScheme. However, its content is a sub set of the full CategoryScheme. The way this works is described in section 3.5.3.1 on ItemScheme.
198
199 === {{id name="_Toc371001"/}}4.5.4 Class diagram - Relationship ===
200
Helena 3.9 201 [[image:1747732486733-495.png]]
202
Helena 2.1 203 **Figure 19: Relationship Class diagram of the Category Scheme**
204
Helena 3.9 205 The CategoryScheme can have one or more Categorys. The Category is Identifiable and has identity information. A Category can have zero or more child Categorys, thus supporting a hierarchy of Categorys. Any IdentifiableArtefact can be +categorisedBy a Category. This is achieved by means of a Categorisation. Each Categorisation can associate one IdentifiableArtefact with one Category. Multiple Categorisations can be used to build a set of IdentifiableArtefacts that are +categorisedBy the same Category. Note that there is no navigation (i.e. no embedded reference) to the Categorisation from the Category. From an implementation perspective this is necessary as Categorisation has no affect on the versioning of either the Category or the IdentifiableArtefact.
Helena 2.1 206
207 ==== 4.5.4.1 Definitions ====
208
209 (((
Helena 3.5 210 (% style="width:965.294px" %)
211 |(% style="width:171px" %)**Class**|(% style="width:213px" %)**Feature**|(% style="width:577px" %)**Description**
212 |(% style="width:171px" %)CategoryScheme|(% style="width:213px" %)(((
Helena 2.1 213 Inherits from
214 //ItemScheme//
Helena 3.5 215 )))|(% style="width:577px" %)The descriptive information for an arrangement or division of categories into groups based on characteristics, which the objects have in common.
216 |(% style="width:171px" %) |(% style="width:213px" %)/items|(% style="width:577px" %)Associates the categories.
217 |(% style="width:171px" %)Category|(% style="width:213px" %)(((
Helena 2.1 218 Inherits from
219 //Item//
Helena 3.5 220 )))|(% style="width:577px" %)An item at any level within a classification, typically tabulation categories, sections, subsections, divisions, subdivisions, groups, subgroups, classes and subclasses.
221 |(% style="width:171px" %) |(% style="width:213px" %)/hierarchy|(% style="width:577px" %)Associates the parent and the child Category.
222 |(% style="width:171px" %)Categorisation|(% style="width:213px" %)(((
Helena 2.1 223 Inherits from
224 MaintainableArtefact
Helena 3.5 225 )))|(% style="width:577px" %)Associates anIdentifableArtefact with a Category.
226 |(% style="width:171px" %) |(% style="width:213px" %)+categorisedArtefact|(% style="width:577px" %)Associates the IdentifableArtefact.
227 |(% style="width:171px" %) |(% style="width:213px" %)+categorisedBy|(% style="width:577px" %)Associates the Category.
Helena 2.1 228 )))
229
230 == {{id name="_Toc371002"/}}4.6 Organisation Scheme ==
231
232 === {{id name="_Toc371003"/}}4.6.1 Class Diagram ===
233
234 [[image:SDMX_2-1_SECTION_2_InformationModel_2020-07_dcd0149.png||height="456" width="580"]]
235
Helena 3.5 236 (% class="wikigeneratedid" id="HFigure20TheOrganisationSchemeclassdiagram" %)
237 **Figure 20 The Organisation Scheme class diagram**
Helena 2.1 238
239 === {{id name="_Toc371004"/}}4.6.2 Explanation of the Diagram ===
240
241 ==== 4.6.2.1 Narrative ====
242
243 The //OrganisationScheme// is abstract. It contains //Organisation// which is also abstract. The Organisation can have child Organisation.
244
245 The //OrganisationScheme// can be one of four types:
246
247 1. AgencyScheme – contains Agency which is restricted to a flat list of agencies (i.e. there is no hierarchy). Note that the SDMX system of (Maintenance) Agency can be hierarchic and this is explained in more detail in the separate document “Technical Notes”.
248 1. DataProviderScheme – contains DataProvider which is restricted to a flat list of agencies (i.e. there is no hierarchy).
249 1. DataConsumerScheme – contains DataConsumer which is restricted to a flat list of agencies (i.e. there is no hierarchy).
250 1. OrganisationUnitScheme – contains OrganisationUnit which does inherit the /hierarchy association from Organisation.
251
252 Reference metadata can be attached to the //Organisation //by means of the metadata attachment mechanism. This mechanism is explained in the Reference Metadata section of this document (see section 7). This means that the model does not specify the specific reference metadata that can be attached to a DataProvider, DataConsumer,OrganisationUnit or Agency, except for limited Contact information.
253
254 A partial //OrganisationScheme// (where isPartial is set to “true”) is identical to a //OrganisationScheme// and contains the Organisation and associated names and descriptions, just as in a normal //OrganisationScheme// However, its content is a sub set of the full //OrganisationScheme//. The way this works is described in section 3.5.3.1 on ItemScheme.
255
256 ==== 4.6.2.2 Definitions ====
257
Helena 3.6 258 (% style="width:845.294px" %)
259 |(% style="width:181px" %)**Class**|(% style="width:217px" %)**Feature**|(% style="width:429px" %)**Description**
260 |(% style="width:181px" %)//OrganisationScheme//|(% style="width:217px" %)(((
Helena 2.1 261 Abstract Class Inherits from
262 //ItemScheme//
263 Sub classes are:
264 AgencyScheme
265 DataProviderScheme
266 DataConsumerScheme
267 OrganisationUnitScheme
Helena 3.6 268 )))|(% style="width:429px" %)A maintained collection of Organisations.
269 |(% style="width:181px" %) |(% style="width:217px" %)/items|(% style="width:429px" %)Association to the Organisations in the scheme.
270 |(% style="width:181px" %)//Organisation//|(% style="width:217px" %)(((
Helena 2.1 271 Inherits from
272 //Item//
273 Sub classes are:
274 Agency
275 DataProvider
276 DataConsumer
277 OrganisationUnit
Helena 3.6 278 )))|(% style="width:429px" %)An organisation is a unique framework of authority within which a person or persons act, or are designated to act, towards some purpose.
279 |(% style="width:181px" %) |(% style="width:217px" %)+contact|(% style="width:429px" %)Association to the Contact information.
280 |(% style="width:181px" %) |(% style="width:217px" %)/hierarchy|(% style="width:429px" %)Association to child Organisations.
281 |(% style="width:181px" %)Contact|(% style="width:217px" %) |(% style="width:429px" %)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.
282 |(% style="width:181px" %) |(% style="width:217px" %)name|(% style="width:429px" %)The designation of the Contact person by a linguistic expression.
283 |(% style="width:181px" %) |(% style="width:217px" %)organisationUnit|(% style="width:429px" %)The designation of the organisational structure by a linguistic expression, within which Contact person works.
284 |(% style="width:181px" %) |(% style="width:217px" %)responsibility|(% style="width:429px" %)The function of the contact person with respect to the organisation role for which this person is the Contact.
285 |(% style="width:181px" %) |(% style="width:217px" %)telephone|(% style="width:429px" %)The telephone number of the Contact.
286 |(% style="width:181px" %) |(% style="width:217px" %)fax|(% style="width:429px" %)The fax number of the Contact.
287 |(% style="width:181px" %) |(% style="width:217px" %)email|(% style="width:429px" %)The Internet e-mail address of the Contact.
288 |(% style="width:181px" %) |(% style="width:217px" %)X400|(% style="width:429px" %)The X400 address of the Contact.
289 |(% style="width:181px" %) |(% style="width:217px" %)uri|(% style="width:429px" %)The URL address of the Contact.
290 |(% style="width:181px" %)AgencyScheme|(% style="width:217px" %) |(% style="width:429px" %)A maintained collection of Maintenace Agencies.
291 |(% style="width:181px" %) |(% style="width:217px" %)/items|(% style="width:429px" %)Association to the Maintenance Agency in the scheme.
292 |(% style="width:181px" %)DataProviderScheme|(% style="width:217px" %) |(% style="width:429px" %)A maintained collection of Data Providers.
293 |(% style="width:181px" %) |(% style="width:217px" %)/items|(% style="width:429px" %)Association to the Data Providers in the scheme.
294 |(% style="width:181px" %)DataConsumerScheme|(% style="width:217px" %) |(% style="width:429px" %)A maintained collection of Data Consumers.
295 |(% style="width:181px" %) |(% style="width:217px" %)/items|(% style="width:429px" %)Association to the Data Consumers in the scheme.
296 |(% style="width:181px" %)OrganisationUnitScheme|(% style="width:217px" %) |(% style="width:429px" %)A maintained collection of Organisation Units.
297 |(% style="width:181px" %) |(% style="width:217px" %)/items|(% style="width:429px" %)Association to the Organisation Units in the scheme.
298 |(% style="width:181px" %)Agency|(% style="width:217px" %)(((
Helena 2.1 299 Inherits from
300 //Organisation//
Helena 3.6 301 )))|(% style="width:429px" %)Responsible agency for maintaining artefacts such as statistical classifications, glossaries, structural metadata such as Data and Metadata Structure Definitions, Concepts and Code lists.
302 |(% style="width:181px" %)DataProvider|(% style="width:217px" %)(((
Helena 2.1 303 Inherits from
304 //Organisation//
Helena 3.6 305 )))|(% style="width:429px" %)An organisation that produces data or reference metadata.
306 |(% style="width:181px" %)DataConsumer|(% style="width:217px" %)(((
Helena 2.1 307 Inherits from
308 //Organisation//
Helena 3.6 309 )))|(% style="width:429px" %)An organisation using data as input for further processing.
310 |(% style="width:181px" %)OrganisationUnit|(% style="width:217px" %)(((
Helena 2.1 311 Inherits from
Helena 3.6 312 //Organisation//
313 )))|(% style="width:429px" %)A designation in the organisational structure.
314 |(% style="width:181px" %) |(% style="width:217px" %)/hierarchy|(% style="width:429px" %)Association to child Organisation Units
Helena 2.1 315
316 == {{id name="_Toc371005"/}}4.7 Reporting Taxonomy ==
317
318 === {{id name="_Toc371006"/}}4.7.1 Class Diagram ===
319
Helena 4.1 320 [[image:1747732548003-370.png]]
Helena 3.6 321
Helena 2.1 322 **Figure 21: Class diagram of the Reporting Taxonomy**
323
324 === {{id name="_Toc371007"/}}4.7.2 Explanation of the Diagram ===
325
326 ==== 4.7.2.1 Narrative ====
327
328 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.
329
330 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 DataflowDefinition, or MetadataflowDefinition, and one or more //Structure//, which itself can be one of DataStructureDefinition or MetadataStructureDefinition. It is expected that within a specific ReportingTaxonomy each Category that is linked in this way will be linked to the same class (e.g. all Category in the scheme will link to a DataflowDefinition). 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:
331
332 Section 1
333
Helena 6.1 334 1. linked to DatafowDefinition_1
335 1. linked to DatafowDefinition_2
Helena 2.1 336
337 Section 2
338
339 1. linked toDatafowDefinition_3
340 1. linked to DatafowDefinition_4
341
342 Here, the nodes of Section 1 and Section 2 would not be linked to DataflowDefinition but the other would be linked to a DataflowDefinition (and hence the DataStructureDefinition).
343
344 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 on ItemScheme.
345
346 ==== 4.7.2.2 Definitions ====
347
Helena 3.6 348 (% style="width:1033.29px" %)
349 |**Class**|**Feature**|(% style="width:687px" %)**Description**
Helena 2.1 350 |ReportingTaxonomy|(((
351 Inherits from
Helena 3.6 352 //ItemScheme//
353 )))|(% style="width:687px" %)A scheme which defines the composition structure of a data report where each component can be described by an independent Dataflow Definition or Metdataflow Definition.
354 | |items|(% style="width:687px" %)Associates the Reporting Category
Helena 2.1 355 |ReportingCategory|(((
356 Inherits from
357 //Item//
Helena 3.6 358 )))|(% style="width:687px" %)A component that gives structure to the report and links to data and metadata.
359 | |hierarchy|(% style="width:687px" %)Associates child Reporting Category.
360 | |+flow|(% style="width:687px" %)Association to the data and metadata flows that link to metadata about the provisioning and related data and metadata sets, and the structures that define them.
361 | |+structure|(% style="width:687px" %)(((
362 Association to the Data Structure Definition and Metadata Structure Definitions which define the structural metadata describing the data and metadata that are contained at this part of the report.
Helena 2.1 363 )))