Skip to Content

Wiki source code of 4 Specific Item Schemes

Version 13.3 by Helena on 2025/05/15 10:34
Hide last authors
Helena 13.2 1 {{box title="**Contents**"}}
2 {{toc/}}
3 {{/box}}
Helena 2.1 4
5 == 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
9 Codelist
10
11 ConceptScheme
12
13 CategoryScheme
14
15 AgencyScheme, DataProviderScheme, MetadataProviderScheme,
16
17 DataConsumerScheme, OrganisationUnitScheme, which all inherit from the abstract class //OrganisationScheme//
18
19 ReportingTaxonomy
20
21 TransformationScheme
22
23 RulesetScheme
24
25 UserDefinedOperatorScheme
26
27 NamePersonalisationScheme
28
29 CustomTypeScheme
30
31 VtlMappingScheme
32
33 Note that the VTL related schemes (the last 6 of the above list) are detailed in a dedicated section below (section 15).
34
35 == 4.2 Inheritance View ==
36
37 The inheritance and relationship views are shown together in each of the diagrams in the specific sections below.
38
39 == 4.3 Codelist ==
40
41 === 4.3.1 Class Diagram ===
42
43 [[image:SDMX 3-0-0 SECTION 2 FINAL-1.0 (1)_en_98388f74.jpg||height="674" width="433"]]
44
45 **Figure 16: Class diagram of the Codelist**
46
47 === 4.3.2 Explanation of the Diagram ===
48
49 ==== 4.3.2.1 Narrative ====
50
51 The Codelist inherits from the //ItemScheme// and therefore has the following attributes: id uri urn version validFrom validTo isExternalReference serviceURL structureURL isPartial
52
53 The Code inherits from //Item// and has the following attributes:
54
55 id uri urn
56
57 Both Codelist and Code have the association to InternationalString to support a multilingual name, an optional multi-lingual description, and an association to Annotation to support notes (not shown).
58
59 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 Hierarhcy, which allows multiple parents is described later.
60
61 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 Codelist. However, its content is a subset of the full Codelist. The way this works is described in section 3.5.3.1 on
62
63 //ItemScheme//.
64
65 ==== 4.3.2.2 Definitions ====
66
Helena 13.2 67 (% style="width:743.039px" %)
68 |**Class**|**Feature**|(% style="width:465px" %)**Description**
Helena 2.1 69 |Codelist|(((
70 Inherits from
71
72 //ItemScheme//
Helena 13.2 73 )))|(% style="width:465px" %)A list from which some statistical concepts (coded concepts) take their values.
Helena 2.1 74 |Code|(((
75 Inherits from
76
77 Item
Helena 13.2 78 )))|(% style="width:465px" %)A language independent set of letters, numbers or symbols that represent a concept whose meaning is described in a natural language.
79 | |hierarchy|(% style="width:465px" %)Associates the parent and the child codes.
80 | |extends|(% style="width:465px" %)Associates a Codelist with any Codelists that it may extend.
Helena 2.1 81
82 === 4.3.3 Class Diagram – Codelist Extension ===
83
84 [[image:SDMX 3-0-0 SECTION 2 FINAL-1.0 (1)_en_e758cbcf.jpg||height="546" width="559"]]
85
86 **Figure 17: Class diagram for Codelist Extension**
87
88 ==== 4.3.3.1 Narrative ====
89
Helena 13.2 90 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. Besides that, the prefix property is used to ensure uniqueness of inherited Codes in the extending^^[[(% class="wikiinternallink wikiinternallink" %)^^2^^>>path:#sdfootnote2sym||name="sdfootnote2anc"]](%%)^^ Codelist in case conflicting Codes 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 from the extended Codelists.
Helena 2.1 91
92 The code selection classes may have MemberValues in order to specify the subset of the Codes that should be included or excluded from the extended Codelist. A MemberValue may have a value that corresponds to a ,,Code,,, including its children ,,Code,,s (via the ,,cascadeValues,, property), or even include instances of the wildcard character ‘%’ in order to point to a set of ,,Code,,s with common parts in their identifiers.
93
94 ==== 4.3.3.2 Definitions ====
95
Helena 13.2 96 :
Helena 2.1 97
98 (((
Helena 13.3 99 (% style="width:753.039px" %)
100 |(% style="width:184px" %)**Class**|(% style="width:145px" %)**Feature**|(% style="width:421px" %)**Description**
101 |(% style="width:184px" %)CodelistExtension|(% style="width:145px" %) |(% style="width:421px" %)The association between Codelists that may extend other Codelists.
102 |(% style="width:184px" %) |(% style="width:145px" %)prefix|(% style="width:421px" %)A prefix to be used for a Codelist used in a extension, in order to avoid Code Conflicts.
103 |(% style="width:184px" %) |(% style="width:145px" %)sequence|(% style="width:421px" %)The order that will be used when extending a Codelist, for resolving Code conflicts. The latest Codelist used overrides any previous Codelist.
104 |(% style="width:184px" %)InclusiveCodeSelection|(% style="width:145px" %) |(% style="width:421px" %)The subset of Codes to be included when extending a Codelist.
105 |(% style="width:184px" %)ExclusiveCodeSelection|(% style="width:145px" %) |(% style="width:421px" %)The subset of Codes to be excluded when extending a Codelist.
106 |(% style="width:184px" %)MemberValue|(% style="width:145px" %)(((
Helena 2.1 107 Inherits from:
108
109 //SelectionValue//
Helena 13.3 110 )))|(% style="width:421px" %)A collection of values based on Codes and their children.
111 |(% style="width:184px" %) |(% style="width:145px" %)cascadeValues|(% style="width:421px" %)A property to indicate if the child Codes of the selected Code shall be included in the selection. It is also possible to include children and exclude the Code by using the 'excluderoot' value.
112 |(% style="width:184px" %) |(% style="width:145px" %)value|(% style="width:421px" %)The value of the Code to include in the selection. It may include the ‘%’ character as a wildcard.
Helena 2.1 113 )))
114
115 === 4.3.4 Class Diagram – Geospatial Codelist ===
116
117 The geospatial support is implemented via an extension of the normal ,,Codelist,,. This is illustrated in the following diagrams.
118
119 [[image:SDMX 3-0-0 SECTION 2 FINAL-1.0 (1)_en_472b895.jpg||height="863" width="466"]]
120
121 **Figure 18: Inheritance for the GeoCodelist**
122
123 [[image:SDMX 3-0-0 SECTION 2 FINAL-1.0 (1)_en_410255be.jpg||height="405" width="559"]]
124
125 **Figure 19: Class diagram for Geospatial Codelist**
126
127 ==== 4.3.4.1 Narrative ====
128
129 A //GeoCodelist// is a specialisation of Codelist that includes geospatial information, by comprising a set of special Codes, i.e., //GeoRefCode//s. A //GeoCodelist// may be implemented by any of the two following classes, via the geoType property:
130
131 GeographicCodelist
132
133 GeoGridCodelist
134
135 The former, i.e., GeographicCodelist, comprises a set of GeoFeatureSetCodes, by adding a value in the Code that follows a pattern to represent a geo feature set.
136
137 The latter, i.e., GeoGridCodelist, comprises a set of GridCodes, which are related to the gridDefinition specified in the GeoGridCodelist.
138
139 ==== 4.3.4.2 Definitions ====
140
Helena 13.3 141 (% style="width:760.039px" %)
Helena 2.1 142 |(% colspan="2" %)**Class**|(% colspan="4" %)**Feature**|**Description**
143 |(% colspan="2" %)//GeoCodelist//|(% colspan="4" %)(((
144 Abstract Class Sub Classes:
145
146 GeographicCodelist GeoGridCodelist geoType
147 )))|(((
148 The abstract class that represents a special type of Codelist, which includes geospatial information.
149
150 The type of Geo Codelist that the Codelist will become.
151 )))
152 |(% colspan="2" %)//GeoRefCode//|(% colspan="4" %)(((
153 Abstract Class Sub Classes:
154
155 GeoFeatureSet
156
157 GeoGridCode
158 )))|The abstract class that represents a special type of Code, which includes geospatial information.
Helena 13.3 159 |(% colspan="2" %)GeographicCodelist|(% colspan="4" %) |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.
160 |(% colspan="2" %)GeoGridCodelist|(% colspan="4" %) |A code list that has defined a geographical grid composed of cells representing regular squared portions of the Earth.
161 |(% colspan="2" %) |(% colspan="4" %)gridDefinition|Contains a regular expression string corresponding to the grid definition for the GeoGrid Codelist.
162 |(% colspan="2" %)GeoFeatureSetCode|(% colspan="4" %) |A Code that has a geo feature set.
163 |(% colspan="2" %) |(% colspan="4" %)value|The geo feature set of the Code, which represents a set of points defining a feature in a format defined a predefined pattern (see section 6).
164 |(% colspan="2" %)GeoGridCode|(% colspan="4" %) |A Code that represents a Geo Grid Cell belonging in a specific grid definition.
165 |(% colspan="2" %) |(% colspan="4" %)geoCell|The value used to assign the Code to one cell in the grid.
Helena 2.1 166
167 == 4.4 ValueList ==
168
169 === 4.4.1 Class Diagram ===
170
171 [[image:SDMX 3-0-0 SECTION 2 FINAL-1.0 (1)_en_4d9e301b.jpg||height="695" width="526"]]
172
173 **Figure 20: Class diagram of the ValueList**
174
175 === 4.4.2 Explanation of the Diagram ===
176
177 ==== 4.4.2.1 Narrative ====
178
179 A ValueList inherits from //EnumeratedList// (and hence the //MaintenableArtefact//) and thus has the following attributes:
180
181 id// //uri// //urn// //version// //validFrom// //validTo// //isExternalReference registryURL structureURL repositoryURL
182
183 ValueItem inherits from //EnumeratedItem//, which adds an id, with relaxed constraints, to the former.
184
185 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 to support notes (not shown). Similarly, the ValueItem, inherits the association to InternationalString and to the Annotation from the //EnumeratedItem//.
186
187 The ValueList can have one or more ValueItems.
188
189 ==== 4.4.2.2 Definitions ====
190
191 |**Class**|**Feature**|**Description**
192 |ValueList|(((
193 Inherits from
194
195 //EnumeratedList//
196 )))|A list from which some statistical concepts (enumerated concepts) take their values.
197 |ValueItem|(((
198 Inherits from
199
200 //EnumeratedItem//
201 )))|A language independent set of letters, numbers or symbols that represent a concept whose meaning is described in a natural language.
202
203 == 4.5 Concept Scheme and Concepts ==
204
205 === 4.5.1 Class Diagram - Inheritance ===
206
207 [[image:SDMX 3-0-0 SECTION 2 FINAL-1.0 (1)_en_e6942837.jpg||height="717" width="457"]]
208
209 **Figure 21 Class diagram of the Concept Scheme**
210
211 === 4.5.2 Explanation of the Diagram ===
212
213 The ConceptScheme inherits from the //ItemScheme //and therefore has the following attributes: id uri urn version validFrom validTo isExternalReference registryURL structureURL repositoryURL isPartial Concept inherits from Item and has the following attributes:
214
215 id uri urn
216
217 Through the inheritance from //NameableArtefact// both ConceptScheme and Concept have the association to InternationalString to support a multi-lingual name, an optional multilingual description, and an association to Annotation to support notes (not shown).
218
219 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.
220
221 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 subset of the full ConceptScheme. The way this works is described in section 3.5.3.1 on ItemScheme.
222
223 === 4.5.3 Class Diagram Relationship ===
224
225 [[image:SDMX 3-0-0 SECTION 2 FINAL-1.0 (1)_en_d9b0bdf4.jpg||height="450" width="461"]]
226
227 **Figure 22: Relationship class diagram of the Concept Scheme**
228
229 === 4.5.4 Explanation of the diagram ===
230
231 ==== 4.5.4.1 Narrative ====
232
233 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.
234
235 The Concept can be associated with a coreRepresentation. The coreRepresentation is the 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.
236
237 The Representation is documented in more detail in the section on the SDMX Base.
238
239 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.
240
241 ==== 4.5.4.2 Definitions ====
242
243 |**Class**|**Feature**|**Description**
244 |ConceptScheme|(((
245 Inherits from
246
247 //ItemScheme//
248 )))|The descriptive information for an arrangement or division of concepts into groups based on characteristics, which the objects have in common.
249 |Concept|(((
250 Inherits from
251
252 //Item//
253 )))|A concept is a unit of knowledge created by a unique combination of characteristics.
Helena 13.2 254 | |/hierarchy|Associates the parent and the child concept.
255 | |coreRepresentation|Associates a Representation.
256 | |+ISOConcept|Association to an ISO concept reference.
257 |ISOConceptReference| |The identity of an ISO concept definition.
258 | |conceptAgency|The maintenance agency of the concept scheme containing the concept.
259 | |conceptSchemeID|The identifier of the concept scheme.
260 | |conceptID|The identifier of the concept.
Helena 2.1 261
262 == 4.6 Category Scheme ==
263
264 === 4.6.1 Context ===
265
266 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.
267
268 === 4.6.2 Class diagram Inheritance ===
269
270 [[image:SDMX 3-0-0 SECTION 2 FINAL-1.0 (1)_en_3a450acd.jpg||height="776" width="452"]]
271
272 **Figure 23 Inheritance Class diagram of the Category Scheme**
273
274 === 4.6.3 Explanation of the Diagram ===
275
276 ==== 4.6.3.1 Narrative ====
277
278 The categories are modelled as a hierarchical //ItemScheme//. The CategoryScheme inherits from the //ItemScheme// and has the following attributes:
279
280 id uri urn version validFrom validTo isExternalReference structureURL serviceURL isPartial
281
282 Category inherits from //Item// and has the following attributes:
283
284 id uri urn
285
286 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).
287
288 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.
289
290 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 subset of the full CategoryScheme. The way this works is described in section 3.5.3.1 on ItemScheme.
291
292 === 4.6.4 Class diagram Relationship ===
293
294 [[image:SDMX 3-0-0 SECTION 2 FINAL-1.0 (1)_en_3696e610.jpg||height="407" width="525"]]
295
296 **Figure 24: Relationship Class diagram of the Category Scheme**
297
298 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.
299
300 ==== 4.6.4.1 Definitions ====
301
302 |**Class**|(% colspan="2" %)**Feature**|**Description**
303 |CategoryScheme|(% colspan="2" %)(((
304 Inherits from
305
306 //ItemScheme//
307 )))|The descriptive information for an arrangement or division of categories into groups based on characteristics, which the objects have in common.
Helena 13.2 308 | |(% colspan="2" %)/items|Associates the categories.
Helena 2.1 309 |Category|(((
310 Inherits from
311
312 //Item//
313 )))|(% colspan="2" %)An item at any level within a classification, typically tabulation categories, sections, subsections, divisions, subdivisions, groups, subgroups, classes and subclasses.
Helena 13.2 314 | |/hierarchy|(% colspan="2" %)Associates the parent and the child Category.
Helena 2.1 315 |Categorisation|(((
316 Inherits from
317
318 //MaintainableArtefact//
319 )))|(% colspan="2" %)Associates an Identifable Artefact with a Category.
Helena 13.2 320 | |+categorisedArtefact|(% colspan="2" %)Associates the Identifable Artefact.
321 | |+categorisedBy|(% colspan="2" %)Associates the Category.
Helena 2.1 322
323 == 4.7 Organisation Scheme ==
324
325 === 4.7.1 Class Diagram ===
326
327 [[image:SDMX 3-0-0 SECTION 2 FINAL-1.0 (1)_en_e9f53aa7.jpg||height="470" width="588"]]
328
329 **Figure 25 The Organisation Scheme class diagram**
330
331 === 4.7.2 Explanation of the Diagram ===
332
333 ==== 4.7.2.1 Narrative ====
334
335 The //OrganisationScheme// is abstract. It contains //Organisation// which is also abstract. The //Organisation// can have child //Organisation//.
336
337 The //OrganisationScheme// can be one of five types:
338
339 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 SDMX Standards Section 6 “Technical Notes”.
340 1. DataProviderScheme – contains DataProvider which is restricted to a flat list of agencies (i.e., there is no hierarchy).
341 1. MetadataProviderScheme – contains MetadataProvider which is restricted to a flat list of agencies (i.e., there is no hierarchy).
342 1. DataConsumerScheme – contains DataConsumer which is restricted to a flat list of agencies (i.e., there is no hierarchy).
343 1. OrganisationUnitScheme – contains OrganisationUnit which does inherit the /hierarchy association from Organisation.
344
345 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, MetadataProvider, DataConsumer, OrganisationUnit or Agency, except for limited Contact information.
346
347 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 on //ItemScheme//.
348
349 ==== 4.7.2.2 Definitions ====
350
351 |**Class**|**Feature**|**Description**
352 |//OrganisationScheme//|(((
353 Abstract Class Inherits from
354
355 //ItemScheme//
356
357 Sub classes are:
358
359 AgencyScheme
360
361 DataProviderScheme
362
363 MetadataProviderScheme DataConsumerScheme
364
365 OrganisationUnitScheme
366 )))|A maintained collection of Organisations.
Helena 13.2 367 | |/items|(((
Helena 2.1 368 Association to the
369
370 Organisations in the scheme.
371 )))
372 |//Organisation//|(((
373 Abstract Class
374
375 Inherits from
376
377 //Item//
378
379 Sub classes are:
380
381 Agency
382
383 DataProvider
384
385 MetadataProvider DataConsumer
386
387 OrganisationUnit
388 )))|An organisation is a unique framework of authority within which a person or persons act, or are designated to act, towards some purpose.
Helena 13.2 389 | |+contact|Association to the Contact information.
390 | |/hierarchy|Association to child Organisations.
391 |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.
392 | |name|The designation of the Contact person by a linguistic expression.
393 | |organisationUnit|The designation of the organisational structure by a linguistic expression, within which Contact person works.
394 | |responsibility|The function of the contact person with respect to the organisation role for which this person is the Contact.
395 | |telephone|The telephone number of the Contact.
396 | |fax|The fax number of the Contact.
397 | |email|The Internet e-mail address of the Contact.
398 | |X400|The X400 address of the Contact.
399 | |uri|The URL address of the Contact.
400 |AgencyScheme| |A maintained collection of Maintenance Agencies.
401 | |/items|Association to the Maintenance Agency in the scheme.
402 |DataProviderScheme| |A maintained collection of Data Providers.
403 | |/items|Association to the Data Providers in the scheme.
404 |MetadataProviderScheme| |A maintained collection of Metadata Providers.
405 | |/items|Association to the Metadata Providers in the scheme.
406 |DataConsumerScheme| |A maintained collection of Data Consumers.
407 | |/items|Association to the Data Consumers in the scheme.
408 |OrganisationUnitScheme| |A maintained collection of Organisation Units.
409 | |/items|Association to the Organisation Units in the scheme.
Helena 2.1 410 |Agency|(((
411 Inherits from
412
413 //Organisation//
414 )))|Responsible agency for maintaining artefacts such as statistical classifications, glossaries, structural metadata such as Data and Metadata Structure Definitions, Concepts and Code lists.
415 |DataProvider|(((
416 Inherits from
417
418 //Organisation//
419 )))|An organisation that produces data.
420 |MetadataProvider|(((
421 Inherits from
422
423 //Organisation//
424 )))|An organisation that produces reference metadata.
425 |DataConsumer|(((
426 Inherits from
427
428 //Organisation//
429 )))|An organisation using data as input for further processing.
430 |OrganisationUnit|(((
431 Inherits from
432
Helena 13.2 433 //Organisation//
Helena 2.1 434 )))|A designation in the organisational structure.
Helena 13.2 435 | |/hierarchy|Association to child Organisation Units
Helena 2.1 436
437 == 4.8 Reporting Taxonomy ==
438
439 === 4.8.1 Class Diagram ===
440
441 [[image:SDMX 3-0-0 SECTION 2 FINAL-1.0 (1)_en_b041cf76.jpg||height="763" width="533"]]
442
443 **Figure 26: Class diagram of the Reporting Taxonomy**
444
445 === 4.8.2 Explanation of the Diagram ===
446
447 ==== 4.8.2.1 Narrative ====
448
449 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.
450
451 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, or Metadataflow, 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 Dataflow). 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:
452
453 Section 1
454
455 1. linked to Datafow_1
456 1. linked to Datafow_2
457
458 Section 2
459
460 1. linked to Datafow_3
461 1. linked to Datafow_4
462
463 Here, the nodes of Section 1 and Section 2 would not be linked to Dataflow but the other would be linked to a Dataflow (and hence the DataStructureDefinition).
464
465 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//.
466
467 ==== 4.8.2.2 Definitions ====
468
469 |**Class**|**Feature**|**Description**
470 |ReportingTaxonomy|(((
471 Inherits from
472
Helena 13.2 473 //ItemScheme//
Helena 2.1 474 )))|A scheme which defines the composition structure of a data report where each component can be described by an independent Dataflow or Metadataflow.
Helena 13.2 475 | |/items|Associates the Reporting Category
Helena 2.1 476 |ReportingCategory|(((
477 Inherits from
478
479 //Item//
480 )))|A component that gives structure to the report and links to data and metadata.
Helena 13.2 481 | |/hierarchy|Associates child Reporting Category.
482 | |+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.
483 | |+structure|(((
Helena 2.1 484 Association to the Data Structure
485
486 Definition and Metadata Structure Definitions which define the structural metadata describing the data and metadata that are contained at this part of the report.
487 )))