Skip to Content
Last modified by Elena on 2025/09/10 11:19
From version 5.6
edited by Helena
on 2025/06/08 11:30
Change comment: There is no comment for this version
To version 2.1
edited by Helena
on 2025/06/07 00:55
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,9 +1,5 @@
1 -{{box title="**Contents**"}}
2 -{{toc/}}
3 -{{/box}}
1 +=== 5.1 Introduction ===
4 4  
5 -== 5.1 Introduction ==
6 -
7 7  The DataStructureDefiniton is the class name for a structure definition for data. Some organisations know this type of definition as a “Key Family” and so the two names are synonymous. The term Data Structure Definition (also referred to as DSD) is used in this specification.
8 8  
9 9  Many of the constructs in this layer of the model inherit from the SDMX Base Layer. Therefore, it is necessary to study both the inheritance and the relationship diagrams to understand the functionality of individual packages. In simple sub models these are shown in the same diagram but are omitted from the more complex sub models for the sake of clarity. In these cases, the inheritance diagram below shows the full inheritance tree for the classes concerned with data structure definitions.
... ... @@ -13,41 +13,51 @@
13 13  The actual SDMX Base construct from which the concrete classes inherit depends upon the requirements of the class for:
14 14  
15 15  Annotation – //AnnotableArtefact//
12 +
16 16  Identification – //IdentifiableArtefact//
14 +
17 17  Naming – //NameableArtefact//
16 +
18 18  Versioning – //VersionableArtefact//
18 +
19 19  Maintenance – //MaintainableArtefact//
20 20  
21 -== 5.2 Inheritance View ==
21 +=== 5.2 Inheritance View ===
22 22  
23 -=== 5.2.1 Class Diagram ===
23 +==== 5.2.1 Class Diagram ====
24 24  
25 25  [[image:1749246368774-202.jpeg]]
26 26  
27 27  **Figure 27 Class inheritance in the Data Structure Definition and Data Set Packages**
28 28  
29 -=== 5.2.2 Explanation of the Diagram ===
29 +===== 5.2.2 Explanation of the Diagram =====
30 30  
31 -==== 5.2.2.1 Narrative ====
31 +====== 5.2.2.1 Narrative ======
32 32  
33 33  Those classes in the SDMX metamodel which require annotations inherit from //AnnotableArtefact//. These are:
34 34  
35 -//IdentifiableArtefact
36 -DataSet
37 -Key// (and therefore //SeriesKey// and //GroupKey//)
35 +//IdentifiableArtefact//
36 +
37 +//DataSet//
38 +
39 +//Key// (and therefore //SeriesKey// and //GroupKey//)
40 +
38 38  //Observation//
39 39  
40 40  Those classes in the SDMX metamodel which require annotations and global identity are derived from //IdentifiableArtefact//. These are:
41 41  
42 -//NameableArtefact
43 -ComponentList
44 -Component//
45 +//NameableArtefact//
45 45  
47 +//ComponentList//
48 +
49 +//Component//
50 +
46 46  Those classes in the SDMX metamodel which require annotations, global identity, multilingual name and multilingual description are derived from //NameableArtefact//. These are:
47 47  
48 -//VersionableArtefact
49 -Item//
53 +//VersionableArtefact//
50 50  
55 +//Item//
56 +
51 51  The classes in the SDMX metamodel which require annotations, global identity, multilingual name and multilingual description, and versioning are derived from //VersionableArtefact//. These are:
52 52  
53 53  //MaintainableArtefact//
... ... @@ -54,17 +54,22 @@
54 54  
55 55  Abstract classes which represent information that is maintained by Maintenance Agencies all inherit from //MaintainableArtefact//, they also inherit all the features of a //VersionableArtefact//, and are:
56 56  
57 -//StructureUsage
58 -Structure
59 -ItemScheme//
63 +//StructureUsage//
60 60  
65 +//Structure//
66 +
67 +//ItemScheme//
68 +
61 61  All the above classes are abstract. The key to understanding the class diagrams presented in this section are the concrete classes that inherit from these abstract classes.
62 62  
63 63  Those concrete classes in the SDMX Data Structure Definition and Dataset packages of the metamodel which require to be maintained by Agencies all inherit (via other abstract classes) from //MaintainableArtefact//, these are:
64 64  
65 65  Dataflow
74 +
66 66  DataStructureDefinition
76 +
67 67  The component structures that are lists of lists, inherit directly from //Structure//. A //Structure// contains several lists of components. The concrete class that inherits from //Structure// is:
78 +
68 68  DataStructureDefinition
69 69  
70 70  A DataStructureDefinition contains a list of dimensions, a list of measures and a list of attributes.
... ... @@ -72,29 +72,34 @@
72 72  The concrete classes which inherit from //ComponentList// and are subcomponents of the DataStructureDefinition are:
73 73  
74 74  DimensionDescriptor – content is Dimension and TimeDimension
86 +
75 75  DimensionGroupDescriptor – content is an association to Dimension, TimeDimension
88 +
76 76  MeasureDescriptor – content is Measure
90 +
77 77  AttributeDescriptor – content is DataAttribute and an association to MetadataAttribute
78 78  
79 79  The classes that inherit from //Component// are:
80 80  
81 81  Measure
96 +
82 82  //DimensionComponent// and thereby its sub classes of Dimension and TimeDimension
98 +
83 83  //Attribute// and thereby its sub classes of DataAttribute and MetadataAttribute
84 84  
85 85  The concrete classes identified above are the majority of the classes required to define the metamodel for the DataStructureDefinition. The diagrams and explanations in the rest of this section show how these concrete classes are related in order to support the functionality required.
86 86  
87 -== 5.3 Data Structure Definition – Relationship View ==
103 +==== //5.3 Data Structure Definition – Relationship View// ====
88 88  
89 -=== 5.3.1 Class Diagram ===
105 +===== 5.3.1 Class Diagram =====
90 90  
91 91  [[image:1749246368782-690.jpeg]]
92 92  
93 93  **Figure 28 Relationship class diagram of the Data Structure Definition excluding representation**
94 94  
95 -=== 5.3.2 Explanation of the Diagrams ===
111 +===== 5.3.2 Explanation of the Diagrams =====
96 96  
97 -==== 5.3.2.1 Narrative ====
113 +====== 5.3.2.1 Narrative ======
98 98  
99 99  A DataStructureDefinition defines the Dimensions, TimeDimension, DataAttributes, and Measures, and associated Representations, that comprise the valid structure of data and related attributes that are contained in a DataSet, which is defined by a Dataflow. In addition, a DataStructureDefinition may be related to one MetadataStructureDefinition, in order to use the latter’s MetadataAttributes, by relating them to other //Components// within the DSD, as explained below.
100 100  
... ... @@ -139,12 +139,11 @@
139 139  
140 140  The following table details the possible relationships a DataAttribute may specify. Note that these relationships are mutually exclusive, and therefore only one of the following is possible.
141 141  
142 -(% style="width:1142.83px" %)
143 -|**Relationship**|(% style="width:537px" %)**Meaning**|(% style="width:434px" %)**Location in Data Set at which the Attribute is reported**
144 -|DataflowRelationship|(% style="width:537px" %)The value of the attribute is fixed for all data contained in the dataset. The Attribute value applies to all data defined by the underlying Dataflow.|(% style="width:434px" %)The attribute is reported at the Dataset level.
145 -|Dimension (1..n)|(% style="width:537px" %)The value of the attribute will vary with the value(s) of the referenced Dimension(s). In this case, Group(s) to which the attribute should be attached may optionally be specified.|(% style="width:434px" %)The attribute is reported at the lowest level of the Dimension to which the Attribute is related, otherwise at the level of the Group if Attachment Group(s) is specified.
146 -|Group|(% style="width:537px" %)The value of the Attribute varies with combination of values for all of the Dimensions contained in the Group. This is added as a convenience to listing all Dimensions and the attachment Group, but should only be used when the Attribute value varies based on all Group Dimension values.|(% style="width:434px" %)The attribute is reported at the level of Group.
147 -|Observation|(% style="width:537px" %)The value of the Attribute varies with the observed value.|(% style="width:434px" %)The attribute is reported at the level of Observation.
158 +|**Relationship**|**Meaning**|**Location in Data Set at which the Attribute is reported**
159 +|DataflowRelationship|The value of the attribute is fixed for all data contained in the dataset. The Attribute value applies to all data defined by the underlying Dataflow.|The attribute is reported at the Dataset level.
160 +|Dimension (1..n)|The value of the attribute will vary with the value(s) of the referenced Dimension(s). In this case, Group(s) to which the attribute should be attached may optionally be specified.|The attribute is reported at the lowest level of the Dimension to which the Attribute is related, otherwise at the level of the Group if Attachment Group(s) is specified.
161 +|Group|The value of the Attribute varies with combination of values for all of the Dimensions contained in the Group. This is added as a convenience to listing all Dimensions and the attachment Group, but should only be used when the Attribute value varies based on all Group Dimension values.|The attribute is reported at the level of Group.
162 +|Observation|The value of the Attribute varies with the observed value.|The attribute is reported at the level of Observation.
148 148  
149 149  [[image:1749246368790-555.jpeg]]
150 150  
... ... @@ -154,7 +154,7 @@
154 154  
155 155  A DataStructureDefinition can be extended to form a derived DataStructureDefinition. This is supported in the StructureMap.
156 156  
157 -==== 5.3.2.2 Definitions ====
172 +**5.3.2.2 Definitions**
158 158  
159 159  |**Class**|**Feature**|**Description**
160 160  |StructureUsage| |See “SDMX Base”.
... ... @@ -164,7 +164,7 @@
164 164  //StructureUsage//
165 165  )))|Abstract concept (i.e., the structure without any data) of a flow of data that providers will provide for different reference periods.
166 166  | |/structure|Associates a Dataflow to the Data Structure Definition.
167 -| |dimensionConstraint|A list of Dimensions which the Dataflow uses. This is only required when the referenced DataStructureDefinition has the evolvingStructure property set to true and when the association to the DataStructureDefinition in on the latest minor version{{footnote}}Referencing the latest minor version of the Data Structure is achieved by the reference including the plus operator on the minor version to indicate it links to the latest stable version, for example 2.0+.0 will resolve to the highest version 2.x.y.{{/footnote}}.
182 +| |dimensionConstraint|A list of Dimensions which the Dataflow uses. This is only required when the referenced DataStructureDefinition has the evolvingStructure property set to true and when the association to the DataStructureDefinition in on the latest minor version[[^^~[1~]^^>>path:#_ftn1]].
168 168  |DataStructureDefiniti on| |A collection of metadata concepts, their structure and usage when used to collect or disseminate data.
169 169  | |/grouping|An association to a set of metadata concepts that have an identified structural role in a Data Structure Definition.
170 170  | |evolvingStructure|An optional boolean property, defaulting to false. When true the DataStructureDefinition may have new Dimensions added without having to change its major version number.
... ... @@ -185,7 +185,7 @@
185 185  
186 186  //ComponentList//
187 187  )))|A set metadata concepts that define the Attributes of a Data Structure Definition.
188 -| |/components|An association to a Data Attribute component.
203 +| |/////components|An association to a Data Attribute component.
189 189  |MeasureDescriptor|(((
190 190  Inherits from
191 191  
... ... @@ -204,74 +204,84 @@
204 204  TimeDimension
205 205  )))|An abstract class representing any Component that can be used for identifying observations.
206 206  
207 -(% style="width:981.835px" %)
208 -|(% style="width:202px" %)**Class**|(% style="width:240px" %)**Feature**|(% style="width:537px" %)**Description**
209 -|(% style="width:202px" %) |(% style="width:240px" %)Order|(% style="width:537px" %)Specifies the order of the Dimension Components within the DSD. The property is used to indicate the position of the Dimension Component and determines the Key for identifying observations, or series. The Time Dimension, when specified, must be the last within the Dimension Descriptor.
210 -|(% style="width:202px" %)Dimension|(% style="width:240px" %)(((
222 +
223 +
224 +
225 +|**Class**|**Feature**|**Description**
226 +| |Order|Specifies the order of the Dimension Components within the DSD. The property is used to indicate the position of the Dimension Component and determines the Key for identifying observations, or series. The Time Dimension, when specified, must be the last within the Dimension Descriptor.
227 +|Dimension|(((
211 211  Inherits from
229 +
212 212  //DimensionComponent//
213 -)))|(% style="width:537px" %)A metadata concept used (most probably together with other metadata concepts) to classify a statistical series, e.g., a statistical concept indicating a certain economic activity or a geographical reference area.
214 -|(% style="width:202px" %) |(% style="width:240px" %)/role|(% style="width:537px" %)Association to the Concept that specifies the role that that the Dimension plays in the Data Structure Definition.
215 -|(% style="width:202px" %) |(% style="width:240px" %)/conceptIdentity|(% style="width:537px" %)An association to the metadata concept which defines the semantic of the Dimension.
216 -|(% style="width:202px" %)TimeDimension|(% style="width:240px" %)(((
231 +)))|A metadata concept used (most probably together with other metadata concepts) to classify a statistical series, e.g., a statistical concept indicating a certain economic activity or a geographical reference area.
232 +| |/role|Association to the Concept that specifies the role that that the Dimension plays in the Data Structure Definition.
233 +| |/conceptIdentity|An association to the metadata concept which defines the semantic of the Dimension.
234 +|TimeDimension|(((
217 217  Inherits from
236 +
218 218  //DimensionComponent//
219 -)))|(% style="width:537px" %)A metadata concept that identifies the component in the key structure that has the role of “time”.
220 -|(% style="width:202px" %)DataAttribute|(% style="width:240px" %)(((
238 +)))|A metadata concept that identifies the component in the key structure that has the role of “time”.
239 +|DataAttribute|(((
221 221  Inherits from
241 +
222 222  //Component//
223 -)))|(% style="width:537px" %)A characteristic of an object or entity.
224 -|(% style="width:202px" %) |(% style="width:240px" %)/role|(% style="width:537px" %)Association to the Concept that specifies the role that that the Data Attribute plays in the Data Structure Definition.
225 -|(% style="width:202px" %) |(% style="width:240px" %)minOccurs|(% style="width:537px" %)Defines the minimum required occurrences for the Attribute. When equals to zero, the Attribute is conditional.
226 -|(% style="width:202px" %) |(% style="width:240px" %)maxOccurs|(% style="width:537px" %)Defines the maximum allowed occurrences for the Attribute.
227 -|(% style="width:202px" %) |(% style="width:240px" %)Usage|(% style="width:537px" %)Defines whether a Data Attribute must be reported or not.
228 -|(% style="width:202px" %) |(% style="width:240px" %)+relatedTo|(% style="width:537px" %)Association to an Attribute Relationship.
229 -|(% style="width:202px" %) |(% style="width:240px" %)/conceptIdentity|(% style="width:537px" %)An association to the Concept which defines the semantic of the component.
230 -|(% style="width:202px" %)Measure|(% style="width:240px" %)(((
243 +)))|A characteristic of an object or entity.
244 +| |/role|Association to the Concept that specifies the role that that the Data Attribute plays in the Data Structure Definition.
245 +| |minOccurs|Defines the minimum required occurrences for the Attribute. When equals to zero, the Attribute is conditional.
246 +| |maxOccurs|Defines the maximum allowed occurrences for the Attribute.
247 +| |Usage|Defines whether a Data Attribute must be reported or not.
248 +| |+relatedTo|Association to an Attribute Relationship.
249 +| |/conceptIdentity|An association to the Concept which defines the semantic of the component.
250 +|Measure|(((
231 231  Inherits from
232 232  
233 233  //Component//
234 -)))|(% style="width:537px" %)The metadata concept that is the phenomenon to be measured in a data set. In a data set the instance of the measure is often called the observation.
235 -|(% style="width:202px" %) |(% style="width:240px" %)/conceptIdentity|(% style="width:537px" %)An association to the Concept which carries the values of the measures.
236 -|(% style="width:202px" %) |(% style="width:240px" %)minOccurs|(% style="width:537px" %)Defines the minimum required occurrences for the Measure. When equals to zero, the Measure is conditional.
237 -|(% style="width:202px" %) |(% style="width:240px" %)maxOccurs|(% style="width:537px" %)Defines the maximum allowed occurrences for the Measure.
238 -|(% style="width:202px" %) |(% style="width:240px" %)Usage|(% style="width:537px" %)Defines whether a Measure must be reported or not.
239 -|(% style="width:202px" %)//AttributeRelationship//|(% style="width:240px" %)(((
254 +)))|The metadata concept that is the phenomenon to be measured in a data set. In a data set the instance of the measure is often called the observation.
255 +| |/conceptIdentity|An association to the Concept which carries the values of the measures.
256 +| |minOccurs|Defines the minimum required occurrences for the Measure. When equals to zero, the Measure is conditional.
257 +| |maxOccurs|Defines the maximum allowed occurrences for the Measure.
258 +| |Usage|Defines whether a Measure must be reported or not.
259 +|//AttributeRelationship//|(((
240 240  Abstract Class
261 +
241 241  Sub classes
242 -ObservationRelationship
243 -GroupRelationship DimensionRelationship
244 -)))|(% style="width:537px" %)Specifies the type of artefact to which a Data Attribute can be attached in a Data Set.
245 -|(% style="width:202px" %)ObservationRelationship|(% style="width:240px" %) |(% style="width:537px" %)The Data Attribute is related to the observations of the Data Set.
246 -|(% style="width:202px" %)GroupRelationship|(% style="width:240px" %) |(% style="width:537px" %)The Data Attribute is related to a Group Dimension Descriptor construct.
247 -|(% style="width:202px" %) |(% style="width:240px" %)+groupKey|(% style="width:537px" %)An association to the Group Dimension Descriptor
248 -|(% style="width:202px" %)DimensionRelationship|(% style="width:240px" %) |(% style="width:537px" %)The Data Attribute is related to a set of Dimensions.
249 -|(% style="width:202px" %) |(% style="width:240px" %)+dimensions|(% style="width:537px" %)Association to the set of Dimensions to which the Data Attribute is related.
250 -|(% style="width:202px" %) |(% style="width:240px" %)+groupKey|(% style="width:537px" %)Association to the Group Dimension Descriptor which specifies the set of Dimensions to which the Data Attribute is attached.
251 -|(% style="width:202px" %)MeasureRelationship|(% style="width:240px" %) |(% style="width:537px" %)The Measures that a Data Attribute is reported for.
252 -|(% style="width:202px" %) |(% style="width:240px" %)+measures|(% style="width:537px" %)Association to the set of Measures to which a Data Attribute is related to.
253 -|(% style="width:202px" %)SentinelValuesType|(% style="width:240px" %) |(% style="width:537px" %)This facet indicates that an Attribute or a Measure has sentinel values with special meaning within their data type. This is realised by providing such values within the TextFormat, in addition to any textType or other Facet.
254 -|(% style="width:202px" %)SentinelValue|(% style="width:240px" %) |(% style="width:537px" %)A value that has a special meaning within the text format representation of the Component.
255 -|(% style="width:202px" %) |(% style="width:240px" %)+name|(% style="width:537px" %)An association of a Sentinel Value to a multilingual name.
256 -|(% style="width:202px" %) |(% style="width:240px" %)+description|(% style="width:537px" %)An association of a Sentinel Value to a multilingual description.
257 257  
264 +ObservationRelations hip
265 +
266 +GroupRelationship DimensionRelationshi p
267 +)))|Specifies the type of artefact to which a Data Attribute can be attached in a Data Set.
268 +|ObservationRelationsh ip| |The Data Attribute is related to the observations of the Data Set.
269 +|GroupRelationship| |The Data Attribute is related to a Group Dimension Descriptor construct.
270 +| |+groupKey|An association to the Group Dimension Descriptor
271 +|DimensionRelationship| |The Data Attribute is related to a set of Dimensions.
272 +| |+dimensions|Association to the set of Dimensions to which the Data Attribute is related.
273 +| |+groupKey|Association to the Group Dimension Descriptor which specifies the set of Dimensions to which the Data Attribute is attached.
274 +|MeasureRelationship| |The Measures that a Data Attribute is reported for.
275 +| |+measures|Association to the set of Measures to which a Data Attribute is related to.
276 +|SentinelValuesType| |This facet indicates that an Attribute or a Measure has sentinel values with special meaning within their data type. This is realised by providing such values within the TextFormat, in addition to any textType or other Facet.
277 +|SentinelValue| |A value that has a special meaning within the text format representation of the Component.
278 +| |+name|An association of a Sentinel Value to a multilingual name.
279 +| |+description|An association of a Sentinel Value to a multilingual description.
280 +
281 +
282 +
258 258  The explanation of the classes, attributes, and associations comprising the Representation is described in the section on the SDMX Base.
259 259  
260 260  ==== //5.4 Data Set – Relationship View// ====
261 261  
262 -=== 5.4.1 Context ===
287 +===== 5.4.1 Context =====
263 263  
264 264  A data set comprises the collection of data values and associated metadata that are collected or disseminated according to a known DataStructureDefinition.
265 265  
266 -=== 5.4.2 Class Diagram ===
291 +===== 5.4.2 Class Diagram =====
267 267  
268 268  [[image:1749246368794-672.jpeg]]
269 269  
270 270  **Figure 31: Class Diagram of the Data Set**
271 271  
272 -=== 5.4.3 Explanation of the Diagram ===
297 +====== 5.4.3 Explanation of the Diagram ======
273 273  
274 -==== 5.4.3.1 Narrative – Data Set ====
299 +5.4.3.1 Narrative – Data Set
275 275  
276 276  Note that the //DataSet// must conform to the DataStructureDefinition associated to the Dataflow for which this DataSet is an “instance of data”. Whilst the model shows the association to the classes of the DataStructureDefinition, this is for conceptual purposes to show the link to the DataStructureDefinition. In the actual //DataSet// as exchanged there must, of course, be a reference to the DataStructureDefinition and optionally a Dataflow or a ProvisionAgreement, but the DataStructureDefinition is not necessarily exchanged with the data. Therefore, the DataStructureDefinition classes are shown in the grey areas, as these are not a part of the //DataSet// when the //DataSet// is exchanged. However, the structural metadata in the DataStructureDefinition can be used by an application to validate the contents of the //DataSet// in terms of the valid content of a //KeyValue// as defined by the Representation in the DataStructureDefinition.
277 277  
... ... @@ -289,169 +289,214 @@
289 289  
290 290  The GroupKey is a subunit of the //Key// that has the same dimensionality as the SeriesKey but defines a subset of the KeyValues of the SeriesKey. Its sub dimension structure is defined in the GroupDimensionDescriptor of the DataStructureDefinition identified by the same id as the GroupKey. The id identifies a “type” of group and the purpose of the GroupKey is to report one or more //AttributeValue// that are contained at this group level. The GroupKey is present when the GroupDimensionDescriptor is related to the GroupRelationship in the DataStructureDefinition. There can be many types of groups in a //DataSet//. If the Group is related to the DimensionRelationship in the DataStructureDefinition then the //AttributeValue// will be reported with the appropriate dimension in the SeriesKey or Observation.
291 291  
292 -In this way each of SeriesKey, GroupKey, and Observation can have zero or more //AttributeValue//s that define some metadata about the object to which it is associated. The //AttributeValue// may be either a //DataAttributeValue// or a //MetadataAttributeValue//, representing values of DataAttributes defined in the DSD or MetadataAttributes of the linked MSD, respectively. The allowable Concepts and the objects to which these metadata can be associated (attached) are defined in the DataStructureDefinition and the linked MetadataStructureDefinition.
317 +In this way each of SeriesKey, GroupKey, and Observation can have zero or more //AttributeValue//s that define some metadata about the object to which it is associated. The //AttributeValue// may be either a //DataAttributeValue// or a //MetadataAttributeValue//, representing values of DataAttributes defined in the DSD or MetadataAttributes of the linked MSD, respectively. The allowable Concepts and the objects to which these metadata can be associated (attached) are defined in the DataStructureDefinition and the linked MetadataStructureDefinition.
293 293  
294 294  The //AttributeValue// links to the object type (SeriesKey, GroupKey, Observation) to which it is associated.
295 295  
296 -==== 5.4.3.2 Definitions ====
321 +5.4.3.2 Definitions
297 297  
298 -(% style="width:964.835px" %)
299 -|(% style="width:200px" %)**Class**|(% style="width:285px" %)**Feature**|(% style="width:454px" %)**Description**
300 -|(% style="width:200px" %)//DataSet//|(% style="width:285px" %)(((
323 +|**Class**|**Feature**|**Description**
324 +|//DataSet//|(((
301 301  Abstract Class
326 +
302 302  Sub classes
328 +
303 303  StructureSpecificData
330 +
304 304  Set
305 -)))|(% style="width:454px" %)An organised collection of data.
306 -|(% style="width:200px" %) |(% style="width:285px" %)reportingBegin|(% style="width:454px" %)A specific time period in a known system of time periods that identifies the start period of a report.
307 -|(% style="width:200px" %) |(% style="width:285px" %)reportingEnd|(% style="width:454px" %)A specific time period in a known system of time periods that identifies the end period of a report.
308 -|(% style="width:200px" %) |(% style="width:285px" %)dataExtractionDate|(% style="width:454px" %)A specific time period that identifies the date and time that the data are extracted from a data source.
309 -|(% style="width:200px" %) |(% style="width:285px" %)validFrom|(% style="width:454px" %)Indicates the inclusive start time indicating the validity of the information in the data set.
310 -|(% style="width:200px" %) |(% style="width:285px" %)validTo|(% style="width:454px" %)Indicates the inclusive end time indicating the validity of the information in the data set.
311 -|(% style="width:200px" %) |(% style="width:285px" %)publicationYear|(% style="width:454px" %)Specifies the year of publication of the data or metadata in terms of whatever provisioning agreements might be in force.
312 -|(% style="width:200px" %) |(% style="width:285px" %)publicationPeriod|(% style="width:454px" %)Specifies the period of publication of the data or metadata in terms of whatever provisioning agreements might be in force.
313 -|(% style="width:200px" %) |(% style="width:285px" %)setId|(% style="width:454px" %)Provides an identification of the data set.
314 -|(% style="width:200px" %) |(% style="width:285px" %)action|(% style="width:454px" %)Defines the action to be taken by the recipient system (information, append, replace, delete)
315 -|(% style="width:200px" %) |(% style="width:285px" %)describedBy|(% style="width:454px" %)(((
316 -Associates a Dataflow and thereby a Data Structure Definition to the data set.
332 +)))|An organised collection of data.
333 +| |reportingBegin|A specific time period in a known system of time periods that identifies the start period of a report.
334 +| |reportingEnd|A specific time period in a known system of time periods that identifies the end period of a report.
335 +| |dataExtractionDate|A specific time period that identifies the date and time that the data are extracted from a data source.
336 +| |validFrom|Indicates the inclusive start time indicating the validity of the information in the data set.
337 +| |validTo|Indicates the inclusive end time indicating the validity of the information in the data set.
338 +| |publicationYear|Specifies the year of publication of the data or metadata in terms of whatever provisioning agreements might be in force.
339 +| |publicationPeriod|Specifies the period of publication of the data or metadata in terms of whatever provisioning agreements might be in force.
340 +| |setId|Provides an identification of the data set.
341 +| |action|Defines the action to be taken by the recipient system (information, append, replace, delete)
342 +| |describedBy|(((
343 +Associates a Dataflow and thereby a Data Structure
344 +
345 +Definition to the data set.
317 317  )))
318 -|(% style="width:200px" %) |(% style="width:285px" %)+structuredBy|(% style="width:454px" %)(((
319 -Associates the Data Structure Definition that defines the structure of the Data Set. Note that the Data Structure Definition is the same as that associated (non-mandatory) to the Dataflow.
347 +| |+structuredBy|(((
348 +Associates the Data Structure Definition that defines the structure of the Data Set. Note that the Data Structure Definition is the same as that associated
349 +
350 +(non-mandatory) to the Dataflow.
320 320  )))
321 -|(% style="width:200px" %) |(% style="width:285px" %)+publishedBy|(% style="width:454px" %)Associates the Data Provider that reports/publishes the data.
322 -|(% style="width:200px" %)StructureSpecificDataSet|(% style="width:285px" %) |(% style="width:454px" %)An XML specific data format structure that contains data corresponding to one specific Data Structure Definition.
323 -|(% style="width:200px" %)//Key//|(% style="width:285px" %)(((
352 +| |+publishedBy|Associates the Data Provider that reports/publishes the data.
353 +|StructureSpecific DataSet| |An XML specific data format structure that contains data corresponding to one specific Data Structure Definition.
354 +|//Key//|(((
324 324  Abstract class
356 +
325 325  Sub classes
358 +
326 326  SeriesKey
360 +
327 327  GroupKey
328 -)))|(% style="width:454px" %)Comprises the cross product of values of dimensions that identify uniquely an Observation.
329 -|(% style="width:200px" %) |(% style="width:285px" %)keyValues|(% style="width:454px" %)Association to the individual Key Values that comprise the Key.
330 -|(% style="width:200px" %) |(% style="width:285px" %)+attachedAttribute|(% style="width:454px" %)Association to the Attribute Values relating to the Series Key or Group Key.
331 -|(% style="width:200px" %)//KeyValue//|(% style="width:285px" %)(((
362 +)))|Comprises the cross product of values of dimensions that identify uniquely an Observation.
363 +| |keyValues|Association to the individual Key Values that comprise the Key.
364 +| |+attachedAttribute|Association to the Attribute Values relating to the Series Key or Group Key.
365 +|//KeyValue//|(((
332 332  Abstract class
367 +
333 333  Sub classes
369 +
334 334  TimeKeyValue
371 +
335 335  CodedKeyValue
373 +
336 336  UncodedKeyValue
337 -)))|(% style="width:454px" %)The value of a component of a key such as the value of the instance a Dimension in a Dimension Descriptor of a Data Structure Definition.
338 -|(% style="width:200px" %) |(% style="width:285px" %)+valueFor|(% style="width:454px" %)(((
375 +)))|The value of a component of a key such as the value of the instance a Dimension in a Dimension Descriptor of a Data Structure Definition.
376 +| |+valueFor|(((
339 339  Association to the key component in the Data Structure Definition for which this Key Value is a valid representation.
378 +
340 340  Note that this is conceptual association as the key component is identified explicitly in the data set.
341 341  )))
342 -|(% style="width:200px" %)TimeKeyValue|(% style="width:285px" %)(((
381 +|TimeKeyValue|(((
343 343  Inherits from
383 +
344 344  //KeyValue//
345 -)))|(% style="width:454px" %)The value of the Time Dimension component of the key.
346 -|(% style="width:200px" %)CodedKeyValue|(% style="width:285px" %)(((
385 +)))|The value of the Time Dimension component of the key.
386 +|CodedKeyValue|(((
347 347  Inherits from
388 +
348 348  //KeyValue//
349 -)))|(% style="width:454px" %)The value of a coded component of the key. The value is the Code to which this class is associated.
350 -|(% style="width:200px" %) |(% style="width:285px" %)+valueOf|(% style="width:454px" %)Association to the Code. Note that this is a conceptual association showing that the Code must exist in the Code list associated with the Dimension in the Data Structure Definition. In the actual Data Set the value of the Code is placed in the Key Value.
351 -|(% style="width:200px" %)UnCodedKeyValue|(% style="width:285px" %)(((
390 +)))|The value of a coded component of the key. The value is the Code to which this class is associated.
391 +| |+valueOf|Association to the Code. Note that this is a conceptual association showing that the Code must exist in the Code list associated with the Dimension in the Data Structure Definition. In the actual Data Set the value of the Code is placed in the Key Value.
392 +|UnCodedKeyValue|(((
352 352  Inherits from
394 +
353 353  //KeyValue//
354 -)))|(% style="width:454px" %)The value of an uncoded component of the key.
355 -|(% style="width:200px" %) |(% style="width:285px" %)value|(% style="width:454px" %)The value of the key component.
356 -|(% style="width:200px" %) |(% style="width:285px" %)startTime|(% style="width:454px" %)This attribute is only used if the textFormat of the attribute is of the Timespan type in the Data Structure Definition (in which case the value field takes a duration).
357 -|(% style="width:200px" %)GroupKey|(% style="width:285px" %)(((
396 +)))|The value of an uncoded component of the key.
397 +| |value|The value of the key component.
398 +| |startTime|This attribute is only used if the textFormat of the attribute is of the Timespan type in the Data Structure Definition (in which case the value field takes a duration).
399 +|GroupKey|(((
358 358  Inherits from
401 +
359 359  //Key//
360 -)))|(% style="width:454px" %)A set of Key Values that comprise a partial key, of the same dimensionality as the Time Series Key for the purpose of attaching Data Attributes.
361 -|(% style="width:200px" %) |(% style="width:285px" %)+describedBy|(% style="width:454px" %)Associates the Group Dimension Descriptor defined in the Data Structure Definition.
362 -|(% style="width:200px" %)SeriesKey|(% style="width:285px" %)(((
403 +)))|A set of Key Values that comprise a partial key, of the same dimensionality as the Time Series Key for the purpose of attaching Data Attributes.
404 +| |+describedBy|Associates the Group Dimension Descriptor defined in the Data Structure Definition.
405 +|SeriesKey|(((
363 363  Inherits from
407 +
364 364  //Key//
365 -)))|(% style="width:454px" %)Comprises the cross product of values of all the Key Values that, together with the Key Value of the +observation Dimension identify uniquely an Observation.
366 -|(% style="width:200px" %) |(% style="width:285px" %)+describedBy|(% style="width:454px" %)Associates the Dimension Descriptor defined in the Data Structure Definition.
367 -|(% style="width:200px" %)Observation|(% style="width:285px" %) |(% style="width:454px" %)The value(s) of the observed phenomenon in the context of the Key Values comprising the key.
368 -|(% style="width:200px" %) |(% style="width:285px" %)+valueFor|(% style="width:454px" %)(((
409 +)))|Comprises the cross product of values of all the Key Values that, together with the Key Value of the +observation Dimension identify uniquely an Observation.
410 +| |+describedBy|Associates the Dimension Descriptor defined in the Data Structure Definition.
411 +|Observation| |The value(s) of the observed phenomenon in the context of the Key Values comprising the key.
412 +| |+valueFor|(((
369 369  Associates the Measure(s) defined in the Data Structure Definition.
370 370  
371 371  The source multiplicity (1..*) indicates that more than one values may be provided for a Measure, if the latter allows it.
372 372  )))
373 -|(% style="width:200px" %) |(% style="width:285px" %)+attachedAttribute|(% style="width:454px" %)Association to the Attribute Values relating to the Observation.
374 -|(% style="width:200px" %) |(% style="width:285px" %)+observationDimension|(% style="width:454px" %)Association to the Key Value that holds the value of the “Dimension at the Observation Level”.
375 -|(% style="width:200px" %)//ObservationValue//|(% style="width:285px" %)(((
417 +| |+attachedAttribute|Association to the Attribute Values relating to the Observation.
418 +| |+observationDimension|Association to the Key Value that holds the value of the “Dimension at the Observation Level”.
419 +|//ObservationValue//|(((
376 376  Abstract class
377 377  
378 378  Sub classes
379 379  
380 -//UncodedObservationValue//
424 +//UncodedObservationVal ue//
381 381  
382 382  CodedObservation
383 -)))|(% style="width:454px" %)
384 -|(% style="width:200px" %)//UncodedObservationValue//|(% style="width:285px" %)(((
427 +)))|
428 +|//UncodedObservatio nValue//|(((
385 385  Abstract class
430 +
386 386  Inherits from
432 +
387 387  //ObservationValue//
434 +
388 388  Sub classes
389 -OtherUncodedMeasureValue
436 +
437 +OtherUncodedMeasureVa lue
438 +
390 390  TextMeasureValue
391 -)))|(% style="width:454px" %)
392 -|(% style="width:200px" %)OtherUncodedMeasureValue|(% style="width:285px" %)(((
440 +)))|
441 +|OtherUncodedMeasu reValue|(((
393 393  Inherits from
394 -//UncodedObservationValue//
395 -)))|(% style="width:454px" %)An observation that has a text value.
396 -|(% style="width:200px" %) |(% style="width:285px" %)value|(% style="width:454px" %)The value of the Uncoded Observation.
397 -|(% style="width:200px" %) |(% style="width:285px" %)startTime|(% style="width:454px" %)This attribute is only used if the textFormat of the Measure is of the Timespan type in the Data Structure Definition (in which case the value field takes a duration).
398 -|(% style="width:200px" %)TextMeasureValue|(% style="width:285px" %)(((
443 +
444 +//UncodedObservationVal ue//
445 +)))|An observation that has a text value.
446 +| |value|The value of the Uncoded Observation.
447 +| |startTime|This attribute is only used if the textFormat of the Measure is of the Timespan type in the Data Structure Definition (in which case the value field takes a duration).
448 +|TextMeasureValue|(((
399 399  Inherits from
400 -//UncodedObservationValue//
401 -)))|(% style="width:454px" %)An observation that has a localised text value
402 -|(% style="width:200px" %) |(% style="width:285px" %)text|(% style="width:454px" %)The localised text values.
403 -|(% style="width:200px" %)CodedObservation|(% style="width:285px" %)(((
450 +
451 +//UncodedObservationVal ue//
452 +)))|An observation that has a localised text value
453 +| |text|The localised text values.
454 +|CodedObservation|(((
404 404  Inherits from
456 +
405 405  //ObservationValue//
406 -)))|(% style="width:454px" %)An Observation that takes its value from a code in a Code list.
407 -|(% style="width:200px" %) |(% style="width:285px" %)+valueOf|(% style="width:454px" %)Association to the Code that is the value of the Observation. Note that this is a conceptual association showing that the Code must exist in the Codelist(s) associated with the Measure(s) in the Data Structure Definition. In the actual Data Set the value of the Code is placed in the Observation.
408 -|(% style="width:200px" %)//AttributeValue//|(% style="width:285px" %)(((
458 +)))|An Observation that takes its value from a code in a Code list.
459 +| |+valueOf|Association to the Code that is the value of the Observation. Note that this is a conceptual association showing that the Code must exist in the Codelist(s) associated with the Measure(s) in the Data Structure Definition. In the actual Data Set the value of the Code is placed in the Observation.
460 +|//AttributeValue//|(((
409 409  Abstract class
462 +
410 410  Sub classes
411 -//DataAttributeValue// //MetadataAttributeValue//
412 -)))|(% style="width:454px" %)Represents the value for any Attribute reported in the Dataset, i.e., Data or Metadata Attribute.
413 -|(% style="width:200px" %)//DataAttributeValue//|(% style="width:285px" %)(((
464 +
465 +//DataAttributeValue// //MetadataAttributeValu e//
466 +)))|Represents the value for any Attribute reported in the Dataset, i.e., Data or Metadata Attribute.
467 +|//DataAttributeValu e//|(((
414 414  Abstract class
469 +
415 415  Inherits from
471 +
416 416  //AttributeValue//
473 +
417 417  Sub classes
418 -//UncodedAttributeValue
419 -CodedAttributeValue//
420 -)))|(% style="width:454px" %)The value of a Data Attribute, such as the instance of a Coded Attribute or of an Uncoded Attribute in a structure such as a Data Structure Definition.
421 -|(% style="width:200px" %) |(% style="width:285px" %)+valueFor|(% style="width:454px" %)(((
475 +
476 +//UncodedAttributeValue//
477 +
478 +//CodedAttributeValue//
479 +)))|The value of a Data Attribute, such as the instance of a Coded Attribute or of an Uncoded Attribute in a structure such as a Data Structure Definition.
480 +| |+valueFor|(((
422 422  Association to the Data Attribute defined in the Data Structure Definition. Note that this is conceptual association as the Concept is identified explicitly in the data set.
482 +
423 423  The source multiplicity (1..*) indicates the possibility to provide more than one values for a Data Attribute, if the latter allows it.
424 424  )))
425 -|(% style="width:200px" %)//MetadataAttributeValue//|(% style="width:285px" %)(((
485 +|//MetadataAttribute Value//|(((
426 426  (explained further in section
427 427  
428 428  “Metadata Set”)
429 -)))|(% style="width:454px" %)The value of a Metadata Attribute, as specified in the Metadata Structure Definition, which is linked in the Data Structure Definition
430 -|(% style="width:200px" %)//UncodedAttributeValue//|(% style="width:285px" %)(((
489 +)))|The value of a Metadata Attribute, as specified in the Metadata Structure Definition, which is linked in the Data Structure Definition
490 +|//UncodedAttributeV alue//|(((
431 431  Inherits from
492 +
432 432  //AttributeValue//
494 +
433 433  Sub classes
496 +
434 434  OtherUncodedAttribute
498 +
435 435  Value
500 +
436 436  TextAttributeValue
437 -)))|(% style="width:454px" %)
438 -|(% style="width:200px" %)OtherUncodedAttributeValue|(% style="width:285px" %)(((
502 +)))|
503 +|OtherUncodedAttri buteValue|(((
439 439  Inherits from
440 -//UncodedObservationValue//
441 -)))|(% style="width:454px" %)An attribute value that has a text value
442 -|(% style="width:200px" %) |(% style="width:285px" %)value|(% style="width:454px" %)The value of the Uncoded attribute.
443 -|(% style="width:200px" %) |(% style="width:285px" %)startTime|(% style="width:454px" %)This attribute is only used if the textFormat of the attribute is of the Timespan type in the Data Structure Definition (in which case the value field takes a duration).
444 -|(% style="width:200px" %)TextAttributeValue|(% style="width:285px" %)(((
505 +
506 +//UncodedObservationVal ue//
507 +)))|An attribute value that has a text value
508 +| |value|The value of the Uncoded attribute.
509 +| |startTime|This attribute is only used if the textFormat of the attribute is of the Timespan type in the Data Structure Definition (in which case the value field takes a duration).
510 +|TextAttributeValu e|(((
445 445  Inherits from
512 +
446 446  //UncodedAttributeValue//
447 -)))|(% style="width:454px" %)An attribute that has a localised text value
448 -|(% style="width:200px" %) |(% style="width:285px" %)text|(% style="width:454px" %)The localised text values.
449 -|(% style="width:200px" %)CodedAttributeValue|(% style="width:285px" %)(((
514 +)))|An attribute that has a localised text value
515 +| |text|The localised text values.
516 +|CodedAttributeVal ue|(((
450 450  Inherits from
518 +
451 451  //AttributeValue//
452 -)))|(% style="width:454px" %)An attribute that takes it value from a Code in Code list.
453 -|(% style="width:200px" %) |(% style="width:285px" %)+valueOf|(% style="width:454px" %)Association to the Code that is the value of the Attribute Value. Note that this is a conceptual association showing that the Code must exist in the Code list associated with the Data Attribute in the Data Structure Definition. In the actual Data Set the value of the Code is placed in the Attribute Value.
520 +)))|An attribute that takes it value from a Code in Code list.
521 +| |+valueOf|Association to the Code that is the value of the Attribute Value. Note that this is a conceptual association showing that the Code must exist in the Code list associated with the Data Attribute in the Data Structure Definition. In the actual Data Set the value of the Code is placed in the Attribute Value.
454 454  
523 +
524 +
455 455  ----
456 456  
457 -{{putFootnotes/}}
527 +[[~[1~]>>path:#_ftnref1]] Referencing the latest minor version of the Data Structure is achieved by the reference including the plus operator on the minor version to indicate it links to the latest stable version, for example 2.0+.0 will resolve to the highest version 2.x.y.
SUZ.Methodology.Code.MethodologyClass[0]
index
... ... @@ -1,1 +1,1 @@
1 -6
1 +13