Skip to Content

Wiki source code of 4 Specific Item Schemes

Version 3.1 by Helena on 2025/05/19 23:53
Hide last authors
Helena 2.1 1 = {{id name="_Toc370986"/}}4 Specific Item Schemes =
2
3 == {{id name="_Toc370987"/}}4.1 Introduction ==
4
5 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:
6
7 * Codelist//  //
8 * ConceptScheme//  //
9 * CategoryScheme//  //
10 * AgencyScheme, DataProviderScheme, DataConsumerScheme, OrganisationUnitScheme which all inherit from the abstract class //OrganisationScheme//
11 * Reporting Taxonomy//  //
12
13 == {{id name="_Toc370988"/}}4.2 Inheritance View ==
14
15 The inheritance and relationship views are shown together in each of the diagrams in the specific sections below.
16
17 == {{id name="_Toc370989"/}}4.3 Codelist ==
18
19 === {{id name="_Toc370990"/}}4.3.1 Class Diagram ===
20
21 **Figure 15 Class diagram of the Codelist**
22
23 === {{id name="_Toc370991"/}}4.3.2 Explanation of the Diagram ===
24
25 ==== 4.3.2.1 Narrative ====
26
27 The Codelist inherits from the //ItemScheme// and therefore has the following attributes:
28
29 * id
30 * uri
31 * urn
32 * version
33 * validFrom//  //
34 * validTo//  //
35 * isExternalReference
36 * serviceURL
37 * structureURL
38 * final
39 * isPartial
40
41 The Code inherits from //Item// and has the following attributes:
42
43 * id
44 * uri
45 * urn
46
47 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).
48
49 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.
50
51 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//.
52
53 ==== 4.3.2.2 Definitions ====
54
55 :
56
57 (((
58 |**Class**|**Feature**|**Description**
59 |Codelist|(((
60 Inherits from
61
62 //ItemScheme//
63 )))|A list from which some statistical concepts (coded concepts) take their values.
64 |Code|(((
65 Inherits from
66
67 //Item//
68 )))|A language independent set of letters, numbers or symbols that represent a concept whose meaning is described in a natural language.
69 ||/hierarchy|Associates the parent and the child codes.
70 )))
71
72 == {{id name="_Toc370992"/}}4.4 Concept Scheme and Concepts ==
73
74 === {{id name="_Toc370993"/}}4.4.1 Class Diagram - Inheritance ===
75
76 **Figure 16 Class diagram of the Concept Scheme**
77
78 === {{id name="_Toc370994"/}}4.4.2 Explanation of the Diagram ===
79
80 The ConceptScheme inherits from the //ItemScheme //and therefore has the following attributes:
81
82 * id//  //
83 * uri//  //
84 * urn//  //
85 * version//  //
86 * validFrom//  //
87 * validTo//  //
88 * isExternalReference
89 * registryURL
90 * structureURL
91 * repositoryURL
92 * final//  //
93 * isPartial//  //
94
95 Concept inherits from Item and has the following attributes:
96
97 * id
98 * uri
99 * urn
100
101 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).
102
103 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.
104
105 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.
106
107 The way this works is described in section 3.5.3.1 on ItemScheme.
108
109 === {{id name="_Toc370995"/}}4.4.3 Class Diagram - Relationship ===
110
111 **Figure 17: Relationship class diagram of the Concept Scheme**
112
113 === {{id name="_Toc370996"/}}4.4.4 Explanation of the diagram ===
114
115 ==== 4.4.4.1 Narrative ====
116
117 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
118
119 MetadataStructureDefinition.
120
121 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
122
123 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.
124
125 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.
126
127 The Representation is documented in more detail in the section on the SDMX Base.
128
129 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.
130
131 ==== 4.4.4.2 Definitions ====
132
133 :
134
135 (((
136 |**Class**|**Feature**|**Description**
137 |ConceptScheme|(((
138 Inherits from
139
140 //ItemScheme//
141 )))|The descriptive information for an arrangement or division of concepts into groups based on characteristics, which the objects have in common.
142 |Concept|(((
143 Inherits from
144
145 //Item//
146 )))|A concept is a unit of knowledge created by a unique combination of characteristics.
147 ||/hierarchy|Associates the parent and the child concept.
148 ||coreRepresentation|Associates a Representation.
149 ||+ISOConcept|Association to an ISO concept reference.
150 |ISOConceptReference||The identity of an ISO concept definition.
151 ||conceptAgency|The maintenance agency of the concept scheme containing the concept.
152 ||conceptSchemeID|The identifier of the concept scheme.
153 ||conceptID|The identifier of the concept.
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
164 ====== Figure 18 Inheritance Class diagram of the Category Scheme ======
165
166 === {{id name="_Toc371000"/}}4.5.3 Explanation of the Diagram ===
167
168 ==== 4.5.3.1 Narrative ====
169
170 The categories are modelled as a hierarchical //ItemScheme//. The CategoryScheme inherits from the //ItemScheme// and has the following attributes:
171
172 * id//  //
173 * uri
174 * urn
175 * version
176 * validFrom
177 * validTo
178 * isExternalReference
179 * structureURL
180 * serviceURL
181 * final
182 * isPartial//  //
183
184 Category inherits from //Item// and has the following attributes:
185
186 * //id//
187 * //uri//
188 * //urn//
189
190 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).
191
192 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.
193
194 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.
195
196 === {{id name="_Toc371001"/}}4.5.4 Class diagram - Relationship ===
197
198 **Figure 19: Relationship Class diagram of the Category Scheme**
199
200 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
201
202 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.
203
204 ==== 4.5.4.1 Definitions ====
205
206 :
207
208 (((
209 |**Class**|**Feature**|**Description**
210 |CategoryScheme|(((
211 Inherits from
212
213 //ItemScheme//
214 )))|The descriptive information for an arrangement or division of categories into groups based on characteristics, which the objects have in common.
215 ||/items|Associates the categories.
216 |Category|(((
217 Inherits from
218
219 //Item//
220 )))|An item at any level within a classification, typically tabulation categories, sections, subsections, divisions, subdivisions, groups, subgroups, classes and subclasses.
221 ||/hierarchy|Associates the parent and the child Category.
222 |Categorisation|(((
223 Inherits from
224
225 MaintainableArtefact
226 )))|Associates anIdentifableArtefact with a Category.
227 ||+categorisedArtefact|Associates the IdentifableArtefact.
228 ||+categorisedBy|Associates the Category.
229 )))
230
231 == {{id name="_Toc371002"/}}4.6 Organisation Scheme ==
232
233 === {{id name="_Toc371003"/}}4.6.1 Class Diagram ===
234
235 [[image:SDMX_2-1_SECTION_2_InformationModel_2020-07_dcd0149.png||height="456" width="580"]]
236
237 ====== Figure 20 The Organisation Scheme class diagram ======
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
258 |**Class**|**Feature**|**Description**
259 |//OrganisationScheme//|(((
260 Abstract Class Inherits from
261
262 //ItemScheme//
263
264 Sub classes are:
265
266 AgencyScheme
267
268 DataProviderScheme
269
270 DataConsumerScheme
271
272 OrganisationUnitScheme
273 )))|A maintained collection of Organisations.
274 ||/items|Association to the Organisations in the scheme.
275 |//Organisation//|(((
276 Inherits from
277
278 //Item//
279
280 Sub classes are:
281
282 Agency
283
284 DataProvider
285
286 DataConsumer
287
288 OrganisationUnit
289 )))|An organisation is a unique framework of authority within which a person or persons act, or are designated to act, towards some purpose.
290 ||+contact|Association to the Contact information.
291 ||/hierarchy|Association to child Organisations.
292 |Contact||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.
293 ||name|The designation of the Contact person by a linguistic expression.
294 ||organisationUnit|The designation of the organisational structure by a linguistic expression, within which Contact person works.
295 ||responsibility|The function of the contact person with respect to the organisation role for which this person is the Contact.
296 ||telephone|The telephone number of the Contact.
297 ||fax|The fax number of the Contact.
298 ||email|The Internet e-mail address of the Contact.
299 ||X400|The X400 address of the Contact.
300 ||uri|The URL address of the Contact.
301 |AgencyScheme||A maintained collection of Maintenace Agencies.
302 ||/items|Association to the Maintenance Agency in the scheme.
303 |DataProviderScheme||A maintained collection of Data Providers.
304 ||/items|Association to the Data Providers in the scheme.
305 |DataConsumerScheme||A maintained collection of Data Consumers.
306 ||/items|Association to the Data Consumers in the scheme.
307 |OrganisationUnitScheme||A maintained collection of Organisation Units.
308 ||/items|Association to the Organisation Units in the scheme.
309 |Agency|(((
310 Inherits from
311
312 //Organisation//
313 )))|Responsible agency for maintaining artefacts such as statistical classifications, glossaries, structural metadata such as Data and Metadata Structure Definitions, Concepts and Code lists.
314 |DataProvider|(((
315 Inherits from
316
317 //Organisation//
318 )))|An organisation that produces data or reference metadata.
319 |DataConsumer|(((
320 Inherits from
321
322 //Organisation//
323 )))|An organisation using data as input for further processing.
324 |OrganisationUnit|(((
325 Inherits from
326
327 //Organisation //
328 )))|A designation in the organisational structure.
329 ||/hierarchy|Association to child Organisation Units
330
331 == {{id name="_Toc371005"/}}4.7 Reporting Taxonomy ==
332
333 === {{id name="_Toc371006"/}}4.7.1 Class Diagram ===
334
335 **Figure 21: Class diagram of the Reporting Taxonomy**
336
337 === {{id name="_Toc371007"/}}4.7.2 Explanation of the Diagram ===
338
339 ==== 4.7.2.1 Narrative ====
340
341 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.
342
343 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:
344
345 Section 1
346
347 ~1. linked to DatafowDefinition_1
348
349 2 linked to DatafowDefinition_2
350
351 Section 2
352
353 1. linked toDatafowDefinition_3
354 1. linked to DatafowDefinition_4
355
356 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).
357
358 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.
359
360 ==== 4.7.2.2 Definitions ====
361
362 |**Class**|**Feature**|**Description**
363 |ReportingTaxonomy|(((
364 Inherits from
365
366 //ItemScheme //
367 )))|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.
368 ||items|Associates the Reporting Category
369 |ReportingCategory|(((
370 Inherits from
371
372 //Item//
373 )))|A component that gives structure to the report and links to data and metadata.
374 ||hierarchy|Associates child Reporting Category.
375 ||+flow|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.
376 ||+structure|(((
377 Association to the Data Structure Definition and Metadata Structure
378
379 Definitions which define the structural metadata describing the data and metadata that are contained at this part of the report.
380 )))