Skip to Content
Last modified by Artur on 2025/09/10 11:19
From version 8.6
edited by Helena
on 2025/05/16 13:51
Change comment: There is no comment for this version
To version 7.1
edited by Helena
on 2025/05/15 09:59
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,6 +1,4 @@
1 -{{box title="**Contents**"}}
2 -{{toc/}}
3 -{{/box}}
1 += 5 Data Structure Definition and Dataset =
4 4  
5 5  == 5.1 Introduction ==
6 6  
... ... @@ -13,9 +13,13 @@
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//
14 +
16 16  Identification – //IdentifiableArtefact//
16 +
17 17  Naming – //NameableArtefact//
18 +
18 18  Versioning – //VersionableArtefact//
20 +
19 19  Maintenance – //MaintainableArtefact//
20 20  
21 21  == 5.2 Inheritance View ==
... ... @@ -32,22 +32,28 @@
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//)
37 +//IdentifiableArtefact//
38 +
39 +//DataSet//
40 +
41 +//Key// (and therefore //SeriesKey// and //GroupKey//)
42 +
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//
47 +//NameableArtefact//
45 45  
49 +//ComponentList//
50 +
51 +//Component//
52 +
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//
55 +//VersionableArtefact//
50 50  
57 +//Item//
58 +
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,15 +54,18 @@
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//
65 +//StructureUsage//
60 60  
67 +//Structure//
68 +
69 +//ItemScheme//
70 +
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
76 +
66 66  DataStructureDefinition
67 67  
68 68  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:
... ... @@ -74,8 +74,11 @@
74 74  The concrete classes which inherit from //ComponentList// and are subcomponents of the DataStructureDefinition are:
75 75  
76 76  DimensionDescriptor – content is Dimension and TimeDimension
88 +
77 77  DimensionGroupDescriptor – content is an association to Dimension, TimeDimension
90 +
78 78  MeasureDescriptor – content is Measure
92 +
79 79  AttributeDescriptor – content is DataAttribute and an association to MetadataAttribute
80 80  
81 81  The classes that inherit from //Component// are:
... ... @@ -83,6 +83,7 @@
83 83  Measure
84 84  
85 85  //DimensionComponent// and thereby its sub classes of Dimension and TimeDimension
100 +
86 86  //Attribute// and thereby its sub classes of DataAttribute and MetadataAttribute
87 87  
88 88  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.
... ... @@ -142,115 +142,132 @@
142 142  
143 143  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.
144 144  
145 -(% style="width:839.039px" %)
146 -|**Relationship**|(% style="width:384px" %)**Meaning**|(% style="width:303px" %)**Location in Data Set at which the Attribute is reported**
147 -|DataflowRelationship|(% style="width:384px" %)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:303px" %)The attribute is reported at the Dataset level.
148 -|Dimension (1..n)|(% style="width:384px" %)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:303px" %)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.
149 -|Group|(% style="width:384px" %)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:303px" %)The attribute is reported at the level of Group.
150 -|Observation|(% style="width:384px" %)The value of the Attribute varies with the observed value.|(% style="width:303px" %)The attribute is reported at the level of Observation.
160 +|**Relationship**|**Meaning**|**Location in Data Set at which the Attribute is reported**
161 +|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.
162 +|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.
163 +|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.
164 +|Observation|The value of the Attribute varies with the observed value.|The attribute is reported at the level of Observation.
151 151  
152 152  [[image:SDMX 3-0-0 SECTION 2 FINAL-1.0 (1)_en_42ff01fb.jpg||height="380" width="590"]]
153 153  
154 154  **Figure 30: Representation of DSD Components**
155 155  
156 -Each of Dimension, TimeDimension, Measure, DataAttribute and MetadataAttribute can have a Representation specified (using the localRepresentation association). If this is not specified in the DataStructureDefinition then the representation specified for Concept (coreRepresentation) is used. Measure, and DataAttribute may be also represented by multilingual text (as seen in the DataSet diagram further down). An exception is the MetadataAttribute, where its Representation is specified in the MetadataStructureDefinition.
170 +Each of Dimension, TimeDimension, Measure, DataAttribute and MetadataAttribute can have a Representation specified (using the localRepresentation association). If this is not specified in the DataStructureDefinition then the representation specified for Concept
157 157  
172 +(coreRepresentation) is used. Measure, and DataAttribute may be also represented by multilingual text (as seen in the DataSet diagram further down). An exception is the MetadataAttribute, where its Representation is specified in the MetadataStructureDefinition.
173 +
158 158  A DataStructureDefinition can be extended to form a derived DataStructureDefinition. This is supported in the StructureMap.
159 159  
160 160  ==== 5.3.2.2 Definitions ====
161 161  
162 -:
178 +:
163 163  
164 164  (((
165 -(% style="width:834.039px" %)
166 -|**Class**|(% style="width:194px" %)**Feature**|(% style="width:454px" %)**Description**
167 -|StructureUsage|(% style="width:194px" %) |(% style="width:454px" %)See “SDMX Base”.
168 -|Dataflow|(% style="width:194px" %)(((
181 +|**Class**|**Feature**|**Description**
182 +|StructureUsage||See “SDMX Base”.
183 +|Dataflow|(((
169 169  Inherits from
185 +
170 170  //StructureUsage//
171 -)))|(% style="width:454px" %)Abstract concept (i.e., the structure without any data) of a flow of data that providers will provide for different reference periods.
172 -| |(% style="width:194px" %)/structure|(% style="width:454px" %)Associates a Dataflow to the Data Structure Definition.
173 -|DataStructureDefiniti on|(% style="width:194px" %) |(% style="width:454px" %)A collection of metadata concepts, their structure and usage when used to collect or disseminate data.
174 -| |(% style="width:194px" %)/grouping|(% style="width:454px" %)An association to a set of metadata concepts that have an identified structural role in a Data Structure Definition.
175 -|GroupDimensionDescrip tor|(% style="width:194px" %)(((
187 +)))|Abstract concept (i.e., the structure without any data) of a flow of data that providers will provide for different reference periods.
188 +||/structure|Associates a Dataflow to the Data Structure Definition.
189 +|DataStructureDefiniti on||A collection of metadata concepts, their structure and usage when used to collect or disseminate data.
190 +||/grouping|An association to a set of metadata concepts that have an identified structural role in a Data Structure Definition.
191 +|GroupDimensionDescrip tor|(((
176 176  Inherits from
193 +
177 177  //ComponentList//
178 -)))|(% style="width:454px" %)A set of metadata concepts that define a partial key derived from the Dimension Descriptor in a Data Structure Definition.
179 -| |(% style="width:194px" %)/components|(% style="width:454px" %)An association to the Dimension components that comprise the group.
180 -|DimensionDescriptor|(% style="width:194px" %)(((
195 +)))|A set of metadata concepts that define a partial key derived from the Dimension Descriptor in a Data Structure Definition.
196 +||/components|An association to the Dimension components that comprise the group.
197 +|DimensionDescriptor|(((
181 181  Inherits from
199 +
182 182  //ComponentList//
183 -)))|(% style="width:454px" %)An ordered set of metadata concepts that, combined, classify a statistical series, and whose values, when combined (the key) in an instance such as a data set, uniquely identify a specific observation.
184 -| |(% style="width:194px" %)/components|(% style="width:454px" %)(((
185 -An association to the Dimension and Time Dimension comprising the Key Descriptor.
201 +)))|An ordered set of metadata concepts that, combined, classify a statistical series, and whose values, when combined (the key) in an instance such as a data set, uniquely identify a specific observation.
202 +||/components|(((
203 +An association to the Dimension and Time
204 +
205 +Dimension comprising the Key Descriptor.
186 186  )))
187 -|AttributeDescriptor|(% style="width:194px" %)(((
207 +|AttributeDescriptor|(((
188 188  Inherits from
209 +
189 189  //ComponentList//
190 -)))|(% style="width:454px" %)A set metadata concepts that define the Attributes of a Data Structure Definition.
191 -| |(% style="width:194px" %)/components|(% style="width:454px" %)An association to a Data Attribute component.
192 -|MeasureDescriptor|(% style="width:194px" %)(((
211 +)))|A set metadata concepts that define the Attributes of a Data Structure Definition.
212 +||/////components//     //|An association to a Data Attribute component.
213 +|MeasureDescriptor|(((
193 193  Inherits from
215 +
194 194  //ComponentList//
195 -)))|(% style="width:454px" %)A metadata concept that defines the Measures of a Data Structure Definition.
196 -| |(% style="width:194px" %)/components|(% style="width:454px" %)An association to a Measure component.
197 -|//DimensionComponent//|(% style="width:194px" %)(((
217 +)))|A metadata concept that defines the Measures of a Data Structure Definition.
218 +||/components|An association to a Measure component.
219 +|//DimensionComponent//|(((
198 198  Inherits from
221 +
199 199  //Component//
200 200  
201 201  Sub class Dimension
225 +
202 202  TimeDimension
203 -)))|(% style="width:454px" %)An abstract class representing any Component that can be used for identifying observations.
204 -| |(% style="width:194px" %)order|(% style="width:454px" %)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.
205 -|Dimension|(% style="width:194px" %)(((
227 +)))|An abstract class representing any Component that can be used for identifying observations.
228 +||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.
229 +|Dimension|(((
206 206  Inherits from
231 +
207 207  //DimensionComponent//
208 -)))|(% style="width:454px" %)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.
209 -| |(% style="width:194px" %)/role|(% style="width:454px" %)Association to the Concept that specifies the role that that the Dimension plays in the Data Structure Definition.
210 -| |(% style="width:194px" %)/conceptIdentity|(% style="width:454px" %)An association to the metadata concept which defines the semantic of the Dimension.
211 -|TimeDimension|(% style="width:194px" %)(((
233 +)))|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.
234 +||/role|Association to the Concept that specifies the role that that the Dimension plays in the Data Structure Definition.
235 +||/conceptIdentity|An association to the metadata concept which defines the semantic of the Dimension.
236 +|TimeDimension|(((
212 212  Inherits from
238 +
213 213  //DimensionComponent//
214 -)))|(% style="width:454px" %)A metadata concept that identifies the component in the key structure that has the role of “time”.
215 -|DataAttribute|(% style="width:194px" %)(((
240 +)))|A metadata concept that identifies the component in the key structure that has the role of “time”.
241 +|DataAttribute|(((
216 216  Inherits from
217 217  
218 218  //Component//
219 -)))|(% style="width:454px" %)A characteristic of an object or entity.
220 -| |(% style="width:194px" %)/role|(% style="width:454px" %)Association to the Concept that specifies the role that that the Data Attribute plays in the Data Structure Definition.
221 -| |(% style="width:194px" %)minOccurs|(% style="width:454px" %)Defines the minimum required occurrences for the Attribute. When equals to zero, the Attribute is conditional.
222 -| |(% style="width:194px" %)maxOccurs|(% style="width:454px" %)Defines the maximum allowed occurrences for the Attribute.
223 -| |(% style="width:194px" %)usage|(% style="width:454px" %)Defines whether a Data Attribute must be reported or not.
224 -| |(% style="width:194px" %)+relatedTo|(% style="width:454px" %)Association to an Attribute Relationship.
225 -| |(% style="width:194px" %)/conceptIdentity|(% style="width:454px" %)An association to the Concept which defines the semantic of the component.
226 -|Measure|(% style="width:194px" %)(((
245 +)))|A characteristic of an object or entity.
246 +||/role|Association to the Concept that specifies the role that that the Data Attribute plays in the Data Structure Definition.
247 +||minOccurs|Defines the minimum required occurrences for the Attribute. When equals to zero, the Attribute is conditional.
248 +||maxOccurs|Defines the maximum allowed occurrences for the Attribute.
249 +||usage|Defines whether a Data Attribute must be reported or not.
250 +||+relatedTo|Association to an Attribute Relationship.
251 +||/conceptIdentity|An association to the Concept which defines the semantic of the component.
252 +|Measure|(((
227 227  Inherits from
254 +
228 228  //Component//
229 -)))|(% style="width:454px" %)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.
230 -| |(% style="width:194px" %)/conceptIdentity|(% style="width:454px" %)An association to the Concept which carries the values of the measures.
231 -| |(% style="width:194px" %)minOccurs|(% style="width:454px" %)Defines the minimum required occurrences for the Measure. When equals to zero, the Measure is conditional.
232 -| |(% style="width:194px" %)maxOccurs|(% style="width:454px" %)Defines the maximum allowed occurrences for the Measure.
233 -| |(% style="width:194px" %)usage|(% style="width:454px" %)Defines whether a Measure must be reported or not.
234 -|//AttributeRelationship//|(% style="width:194px" %)(((
256 +)))|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.
257 +||/conceptIdentity|An association to the Concept which carries the values of the measures.
258 +||minOccurs|Defines the minimum required occurrences for the Measure. When equals to zero, the Measure is conditional.
259 +||maxOccurs|Defines the maximum allowed occurrences for the Measure.
260 +||usage|Defines whether a Measure must be reported or not.
261 +|//AttributeRelationship//|(((
235 235  Abstract Class
263 +
236 236  Sub classes
265 +
237 237  ObservationRelationship
267 +
238 238  GroupRelationship DimensionRelationshi p
239 -)))|(% style="width:454px" %)Specifies the type of artefact to which a Data Attribute can be attached in a Data Set.
240 -|ObservationRelationsh ip|(% style="width:194px" %) |(% style="width:454px" %)The Data Attribute is related to the observations of the Data Set.
241 -|GroupRelationship|(% style="width:194px" %) |(% style="width:454px" %)The Data Attribute is related to a Group Dimension Descriptor construct.
242 -| |(% style="width:194px" %)+groupKey|(% style="width:454px" %)An association to the Group Dimension Descriptor
243 -|DimensionRelationship|(% style="width:194px" %) |(% style="width:454px" %)The Data Attribute is related to a set of Dimensions.
244 -| |(% style="width:194px" %)+dimensions|(% style="width:454px" %)Association to the set of Dimensions to which the Data Attribute is related.
245 -| |(% style="width:194px" %)+groupKey|(% style="width:454px" %)Association to the Group Dimension Descriptor which specifies the set of Dimensions to which the Data Attribute is attached.
246 -|MeasureRelationship|(% style="width:194px" %) |(% style="width:454px" %)The Measures that a Data Attribute is reported for.
247 -| |(% style="width:194px" %)+measures|(% style="width:454px" %)Association to the set of Measures to which a Data Attribute is related to.
248 -|SentinelValuesType|(% style="width:194px" %) |(% style="width:454px" %)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.
249 -|SentinelValue|(% style="width:194px" %) |(% style="width:454px" %)A value that has a special meaning within the text format representation of the Component.
250 -| |(% style="width:194px" %)+name|(% style="width:454px" %)An association of a Sentinel Value to a multilingual name.
251 -| |(% style="width:194px" %)+description|(% style="width:454px" %)An association of a Sentinel Value to a multilingual description.
269 +)))|Specifies the type of artefact to which a Data Attribute can be attached in a Data Set.
270 +|ObservationRelationsh ip||The Data Attribute is related to the observations of the Data Set.
271 +|GroupRelationship||The Data Attribute is related to a Group Dimension Descriptor construct.
272 +||+groupKey|An association to the Group Dimension Descriptor
273 +|DimensionRelationship||The Data Attribute is related to a set of Dimensions.
274 +||+dimensions|Association to the set of Dimensions to which the Data Attribute is related.
275 +||+groupKey|Association to the Group Dimension Descriptor which specifies the set of Dimensions to which the Data Attribute is attached.
276 +|MeasureRelationship||The Measures that a Data Attribute is reported for.
277 +||+measures|Association to the set of Measures to which a Data Attribute is related to.
278 +|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.
279 +|SentinelValue||A value that has a special meaning within the text format representation of the Component.
280 +||+name|An association of a Sentinel Value to a multilingual name.
281 +||+description|An association of a Sentinel Value to a multilingual description.
252 252  )))
253 253  
284 +
285 +
254 254  The explanation of the classes, attributes, and associations comprising the Representation is described in the section on the SDMX Base.
255 255  
256 256  == 5.4 Data Set – Relationship View ==
... ... @@ -275,8 +275,10 @@
275 275  
276 276  A //DataSet// is formatted as a DataStructureDefinition specific data set (StructureSpecificDataSet). The structured data set is structured according to one specific DataStructureDefinition; hence the latter is required for validation at the syntax level.
277 277  
278 -A //DataSet// is a collection of a set of //Observation//s that share the same dimensionality, which is specified by a set of unique components (Dimension, TimeDimension) defined in the DimensionDescriptor of the DataStructureDefinition, together with associated
310 +A //DataSet// is a collection of a set of //Observation//s that share the same dimensionality, which is specified by a set of unique components (Dimension, TimeDimension) defined in the
279 279  
312 +DimensionDescriptor of the DataStructureDefinition, together with associated
313 +
280 280  //AttributeValue//s that define specific characteristics about the artefact to which it is attached – //Observation//s, set of Dimensions. It can be structured in terms of a SeriesKey to which //Observation//s are reported.
281 281  
282 282  The //Observation// can be the value(s) of the variable(s) being measured for the Concept associated to the Measure(s) in the MeasureDescriptor of the DataStructureDefinition. Each //Observation// associates one or more //ObservationValue//s with a KeyValue (+observationDimension) which is the value for the “Dimension at the Observation Level”. Any Dimension can be specified as being the “Dimension at the Observation Level”, and this specification is made at the level of the //DataSet// (i.e., it must be the same Dimension for the entire //DataSet//).
... ... @@ -293,9 +293,8 @@
293 293  
294 294  ==== 5.4.3.2 Definitions ====
295 295  
296 -(% style="width:812.039px" %)
297 -|(% style="width:147px" %)**Class**|(% style="width:222px" %)**Feature**|(% style="width:437px" %)**Description**
298 -|(% style="width:147px" %)//DataSet//|(% style="width:222px" %)(((
330 +|**Class**|**Feature**|**Description**
331 +|//DataSet//|(((
299 299  Abstract Class
300 300  
301 301  Sub classes
... ... @@ -303,30 +303,30 @@
303 303  StructureSpecificData
304 304  
305 305  Set
306 -)))|(% style="width:437px" %)An organised collection of data.
307 -|(% style="width:147px" %) |(% style="width:222px" %)reportingBegin|(% style="width:437px" %)A specific time period in a known system of time periods that identifies the start period of a report.
308 -|(% style="width:147px" %) |(% style="width:222px" %)reportingEnd|(% style="width:437px" %)A specific time period in a known system of time periods that identifies the end period of a report.
309 -|(% style="width:147px" %) |(% style="width:222px" %)dataExtractionDate|(% style="width:437px" %)A specific time period that identifies the date and time that the data are extracted from a data source.
310 -|(% style="width:147px" %) |(% style="width:222px" %)validFrom|(% style="width:437px" %)Indicates the inclusive start time indicating the validity of the information in the data set.
311 -|(% style="width:147px" %) |(% style="width:222px" %)validTo|(% style="width:437px" %)Indicates the inclusive end time indicating the validity of the information in the data set.
312 -|(% style="width:147px" %) |(% style="width:222px" %)publicationYear|(% style="width:437px" %)Specifies the year of publication of the data or metadata in terms of whatever provisioning agreements might be in force.
313 -|(% style="width:147px" %) |(% style="width:222px" %)publicationPeriod|(% style="width:437px" %)Specifies the period of publication of the data or metadata in terms of whatever provisioning agreements might be in force.
314 -|(% style="width:147px" %) |(% style="width:222px" %)setId|(% style="width:437px" %)Provides an identification of the data set.
315 -|(% style="width:147px" %) |(% style="width:222px" %)action|(% style="width:437px" %)Defines the action to be taken by the recipient system (information, append, replace, delete)
316 -|(% style="width:147px" %) |(% style="width:222px" %)describedBy|(% style="width:437px" %)Associates a Dataflow and thereby a Data Structure Definition to the data set.
317 -|(% style="width:147px" %) |(% style="width:222px" %)+structuredBy|(% style="width:437px" %)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.
318 -|(% style="width:147px" %) |(% style="width:222px" %)+publishedBy|(% style="width:437px" %)Associates the Data Provider that reports/publishes the data.
319 -|(% style="width:147px" %)StructureSpecific DataSet|(% style="width:222px" %) |(% style="width:437px" %)An XML specific data format structure that contains data corresponding to one specific Data Structure Definition.
320 -|(% style="width:147px" %)//Key//|(% style="width:222px" %)(((
339 +)))|An organised collection of data.
340 +||reportingBegin|A specific time period in a known system of time periods that identifies the start period of a report.
341 +||reportingEnd|A specific time period in a known system of time periods that identifies the end period of a report.
342 +||dataExtractionDate|A specific time period that identifies the date and time that the data are extracted from a data source.
343 +||validFrom|Indicates the inclusive start time indicating the validity of the information in the data set.
344 +||validTo|Indicates the inclusive end time indicating the validity of the information in the data set.
345 +||publicationYear|Specifies the year of publication of the data or metadata in terms of whatever provisioning agreements might be in force.
346 +||publicationPeriod|Specifies the period of publication of the data or metadata in terms of whatever provisioning agreements might be in force.
347 +||setId|Provides an identification of the data set.
348 +||action|Defines the action to be taken by the recipient system (information, append, replace, delete)
349 +||describedBy|Associates a Dataflow and thereby a Data Structure Definition to the data set.
350 +||+structuredBy|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.
351 +||+publishedBy|Associates the Data Provider that reports/publishes the data.
352 +|StructureSpecific DataSet||An XML specific data format structure that contains data corresponding to one specific Data Structure Definition.
353 +|//Key//|(((
321 321  Abstract class Sub classes
322 322  
323 323  SeriesKey
324 324  
325 325  GroupKey
326 -)))|(% style="width:437px" %)Comprises the cross product of values of dimensions that identify uniquely an Observation.
327 -|(% style="width:147px" %) |(% style="width:222px" %)keyValues|(% style="width:437px" %)Association to the individual Key Values that comprise the Key.
328 -|(% style="width:147px" %) |(% style="width:222px" %)+attachedAttribute|(% style="width:437px" %)Association to the Attribute Values relating to the Series Key or Group Key.
329 -|(% style="width:147px" %)//KeyValue//|(% style="width:222px" %)(((
359 +)))|Comprises the cross product of values of dimensions that identify uniquely an Observation.
360 +||keyValues|Association to the individual Key Values that comprise the Key.
361 +||+attachedAttribute|Association to the Attribute Values relating to the Series Key or Group Key.
362 +|//KeyValue//|(((
330 330  Abstract class Sub classes
331 331  
332 332  TimeKeyValue
... ... @@ -334,50 +334,51 @@
334 334  CodedKeyValue
335 335  
336 336  UncodedKeyValue
337 -)))|(% style="width:437px" %)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:147px" %) |(% style="width:222px" %)+valueFor|(% style="width:437px" %)(((
370 +)))|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.
371 +||+valueFor|(((
339 339  Association to the key component in the Data Structure Definition for which this Key Value is a valid representation.
373 +
340 340  Note that this is conceptual association as the key component is identified explicitly in the data set.
341 341  )))
342 -|(% style="width:147px" %)TimeKeyValue|(% style="width:222px" %)(((
376 +|TimeKeyValue|(((
343 343  Inherits from
344 344  
345 345  //KeyValue//
346 -)))|(% style="width:437px" %)The value of the Time Dimension component of the key.
347 -|(% style="width:147px" %)CodedKeyValue|(% style="width:222px" %)(((
380 +)))|The value of the Time Dimension component of the key.
381 +|CodedKeyValue|(((
348 348  Inherits from
349 349  
350 350  //KeyValue//
351 -)))|(% style="width:437px" %)The value of a coded component of the key. The value is the Code to which this class is associated.
352 -|(% style="width:147px" %) |(% style="width:222px" %)+valueOf|(% style="width:437px" %)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.
353 -|(% style="width:147px" %)UnCodedKeyValue|(% style="width:222px" %)(((
385 +)))|The value of a coded component of the key. The value is the Code to which this class is associated.
386 +||+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.
387 +|UnCodedKeyValue|(((
354 354  Inherits from
355 355  
356 356  //KeyValue//
357 -)))|(% style="width:437px" %)The value of an uncoded component of the key.
358 -|(% style="width:147px" %) |(% style="width:222px" %)value|(% style="width:437px" %)The value of the key component.
359 -|(% style="width:147px" %) |(% style="width:222px" %)startTime|(% style="width:437px" %)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).
360 -|(% style="width:147px" %)GroupKey|(% style="width:222px" %)(((
391 +)))|The value of an uncoded component of the key.
392 +||value|The value of the key component.
393 +||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).
394 +|GroupKey|(((
361 361  Inherits from
362 362  
363 363  //Key//
364 -)))|(% style="width:437px" %)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.
365 -|(% style="width:147px" %) |(% style="width:222px" %)+describedBy|(% style="width:437px" %)Associates the Group Dimension Descriptor defined in the Data Structure Definition.
366 -|(% style="width:147px" %)SeriesKey|(% style="width:222px" %)(((
398 +)))|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.
399 +||+describedBy|Associates the Group Dimension Descriptor defined in the Data Structure Definition.
400 +|SeriesKey|(((
367 367  Inherits from
368 368  
369 369  //Key//
370 -)))|(% style="width:437px" %)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.
371 -|(% style="width:147px" %) |(% style="width:222px" %)+describedBy|(% style="width:437px" %)Associates the Dimension Descriptor defined in the Data Structure Definition.
372 -|(% style="width:147px" %)Observation|(% style="width:222px" %) |(% style="width:437px" %)The value(s) of the observed phenomenon in the context of the Key Values comprising the key.
373 -|(% style="width:147px" %) |(% style="width:222px" %)+valueFor|(% style="width:437px" %)(((
404 +)))|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.
405 +||+describedBy|Associates the Dimension Descriptor defined in the Data Structure Definition.
406 +|Observation||The value(s) of the observed phenomenon in the context of the Key Values comprising the key.
407 +||+valueFor|(((
374 374  Associates the Measure(s) defined in the Data Structure Definition.
375 375  
376 376  The source multiplicity (1..*) indicates that more than one values may be provided for a Measure, if the latter allows it.
377 377  )))
378 -|(% style="width:147px" %) |(% style="width:222px" %)+attachedAttribute|(% style="width:437px" %)Association to the Attribute Values relating to the Observation.
379 -|(% style="width:147px" %) |(% style="width:222px" %)+observationDimension|(% style="width:437px" %)Association to the Key Value that holds the value of the “Dimension at the Observation Level”.
380 -|(% style="width:147px" %)//ObservationValue//|(% style="width:222px" %)(((
412 +||+attachedAttribute|Association to the Attribute Values relating to the Observation.
413 +||+observationDimension|Association to the Key Value that holds the value of the “Dimension at the Observation Level”.
414 +|//ObservationValue//|(((
381 381  Abstract class
382 382  
383 383  Sub classes
... ... @@ -387,8 +387,8 @@
387 387  //ue//
388 388  
389 389  CodedObservation
390 -)))|(% style="width:437px" %)
391 -|(% style="width:147px" %)//UncodedObservatio nValue//|(% style="width:222px" %)(((
424 +)))|
425 +|//UncodedObservatio nValue//|(((
392 392  Abstract class
393 393  
394 394  Inherits from
... ... @@ -400,34 +400,34 @@
400 400  OtherUncodedMeasureVa lue
401 401  
402 402  TextMeasureValue
403 -)))|(% style="width:437px" %)
404 -|(% style="width:147px" %)OtherUncodedMeasu reValue|(% style="width:222px" %)(((
437 +)))|
438 +|OtherUncodedMeasu reValue|(((
405 405  Inherits from
406 406  
407 407  //UncodedObservationVal ue//
408 -)))|(% style="width:437px" %)An observation that has a text value.
409 -|(% style="width:147px" %) |(% style="width:222px" %)value|(% style="width:437px" %)The value of the Uncoded Observation.
410 -|(% style="width:147px" %) |(% style="width:222px" %)startTime|(% style="width:437px" %)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).
411 -|(% style="width:147px" %)TextMeasureValue|(% style="width:222px" %)(((
442 +)))|An observation that has a text value.
443 +||value|The value of the Uncoded Observation.
444 +||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).
445 +|TextMeasureValue|(((
412 412  Inherits from
413 413  
414 414  //UncodedObservationVal ue//
415 -)))|(% style="width:437px" %)An observation that has a localised text value
416 -|(% style="width:147px" %) |(% style="width:222px" %)text|(% style="width:437px" %)The localised text values.
417 -|(% style="width:147px" %)CodedObservation|(% style="width:222px" %)(((
449 +)))|An observation that has a localised text value
450 +||text|The localised text values.
451 +|CodedObservation|(((
418 418  Inherits from
419 419  
420 420  //ObservationValue//
421 -)))|(% style="width:437px" %)An Observation that takes its value from a code in a Code list.
422 -|(% style="width:147px" %) |(% style="width:222px" %)+valueOf|(% style="width:437px" %)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.
423 -|(% style="width:147px" %)//AttributeValue//|(% style="width:222px" %)(((
455 +)))|An Observation that takes its value from a code in a Code list.
456 +||+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.
457 +|//AttributeValue//|(((
424 424  Abstract class
425 425  
426 426  Sub classes
427 427  
428 428  //DataAttributeValue// //MetadataAttributeValu e//
429 -)))|(% style="width:437px" %)Represents the value for any Attribute reported in the Dataset, i.e., Data or Metadata Attribute.
430 -|(% style="width:147px" %)//DataAttributeValu e//|(% style="width:222px" %)(((
463 +)))|Represents the value for any Attribute reported in the Dataset, i.e., Data or Metadata Attribute.
464 +|//DataAttributeValu e//|(((
431 431  Abstract class
432 432  
433 433  Inherits from
... ... @@ -439,21 +439,22 @@
439 439  //UncodedAttributeValue//
440 440  
441 441  //CodedAttributeValue//
442 -)))|(% style="width:437px" %)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.
443 -|(% style="width:147px" %) |(% style="width:222px" %)+valueFor|(% style="width:437px" %)(((
476 +)))|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.
477 +||+valueFor|(((
444 444  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.
479 +
445 445  The source multiplicity (1..*) indicates the possibility to provide more than one values for a Data Attribute, if the latter allows it.
446 446  )))
447 -|(% style="width:147px" %)//MetadataAttribute Value//|(% style="width:222px" %)(((
482 +|//MetadataAttribute Value//|(((
448 448  (explained further in section
449 449  
450 450  “Metadata Set”)
451 -)))|(% style="width:437px" %)(((
486 +)))|(((
452 452  The value of a Metadata Attribute, as specified in the Metadata Structure Definition, which is linked in the Data Structure
453 453  
454 454  Definition
455 455  )))
456 -|(% style="width:147px" %)//UncodedAttributeV alue//|(% style="width:222px" %)(((
491 +|//UncodedAttributeV alue//|(((
457 457  Inherits from
458 458  
459 459  //AttributeValue//
... ... @@ -463,25 +463,27 @@
463 463  OtherUncodedAttribute Value
464 464  
465 465  TextAttributeValue
466 -)))|(% style="width:437px" %)
467 -|(% style="width:147px" %)OtherUncodedAttri buteValue|(% style="width:222px" %)(((
501 +)))|
502 +|OtherUncodedAttri buteValue|(((
468 468  Inherits from
469 469  
470 470  //UncodedObservationVal ue//
471 -)))|(% style="width:437px" %)An attribute value that has a text value
472 -|(% style="width:147px" %) |(% style="width:222px" %)value|(% style="width:437px" %)The value of the Uncoded attribute.
473 -|(% style="width:147px" %) |(% style="width:222px" %)startTime|(% style="width:437px" %)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).
474 -|(% style="width:147px" %)TextAttributeValu e|(% style="width:222px" %)(((
506 +)))|An attribute value that has a text value
507 +||value|The value of the Uncoded attribute.
508 +||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).
509 +|TextAttributeValu e|(((
475 475  Inherits from
476 476  
477 477  //UncodedAttributeValue//
478 -)))|(% style="width:437px" %)An attribute that has a localised text value
479 -|(% style="width:147px" %) |(% style="width:222px" %)text|(% style="width:437px" %)The localised text values.
480 -|(% style="width:147px" %)CodedAttributeVal ue|(% style="width:222px" %)(((
513 +)))|An attribute that has a localised text value
514 +||text|The localised text values.
515 +|CodedAttributeVal ue|(((
481 481  Inherits from
482 482  
483 483  //AttributeValue//
484 -)))|(% style="width:437px" %)An attribute that takes it value from a Code in Code list.
485 -|(% style="width:147px" %) |(% style="width:222px" %)+valueOf|(% style="width:437px" %)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.
519 +)))|An attribute that takes it value from a Code in Code list.
520 +||+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.
486 486  
487 -
522 +
523 +
524 +