Changes for page 5 Data Structure Definition and Dataset

Last modified by Elena on 2025/09/10 11:19

From 3.1 to 2.1 From 5.6 to 5.5

From version 5.5

edited by Helena
on 2025/06/08 11:30

Change comment: There is no comment for this version

To version 3.1

edited by Helena
on 2025/06/07 00:56

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (1 modified, 0 added, 0 removed)

Details

Page properties

Content

@@ -1,9 +1,5 @@
--{{box title="**Contents**"}}
--{{toc/}}
--{{/box}}
++=== 5.1 Introduction ===
--== 5.1 Introduction ==
--
  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.
  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 @@
  The actual SDMX Base construct from which the concrete classes inherit depends upon the requirements of the class for:
  Annotation – //AnnotableArtefact//
++
  Identification – //IdentifiableArtefact//
++
  Naming – //NameableArtefact//
++
  Versioning – //VersionableArtefact//
++
  Maintenance – //MaintainableArtefact//
--== 5.2 Inheritance View ==
++=== 5.2 Inheritance View ===
--=== 5.2.1 Class Diagram ===
++==== 5.2.1 Class Diagram ====
  [[image:1749246368774-202.jpeg]]
  **Figure 27 Class inheritance in the Data Structure Definition and Data Set Packages**
--=== 5.2.2 Explanation of the Diagram ===
++===== 5.2.2 Explanation of the Diagram =====
--==== 5.2.2.1 Narrative ====
++====== 5.2.2.1 Narrative ======
  Those classes in the SDMX metamodel which require annotations inherit from //AnnotableArtefact//. These are:
--//IdentifiableArtefact
--DataSet
--Key// (and therefore //SeriesKey// and //GroupKey//)
++//IdentifiableArtefact//
++
++//DataSet//
++
++//Key// (and therefore //SeriesKey// and //GroupKey//)
++
  //Observation//
  Those classes in the SDMX metamodel which require annotations and global identity are derived from //IdentifiableArtefact//. These are:
--//NameableArtefact
--ComponentList
--Component//
++//NameableArtefact//
++//ComponentList//
++
++//Component//
++
  Those classes in the SDMX metamodel which require annotations, global identity, multilingual name and multilingual description are derived from //NameableArtefact//. These are:
--//VersionableArtefact
--Item//
++//VersionableArtefact//
++//Item//
++
  The classes in the SDMX metamodel which require annotations, global identity, multilingual name and multilingual description, and versioning are derived from //VersionableArtefact//. These are:
  //MaintainableArtefact//
@@ -54,17 +54,22 @@
  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:
--//StructureUsage
--Structure
--ItemScheme//
++//StructureUsage//
++//Structure//
++
++//ItemScheme//
++
  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.
  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:
  Dataflow
++
  DataStructureDefinition
++
  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:
++
  DataStructureDefinition
  A DataStructureDefinition contains a list of dimensions, a list of measures and a list of attributes.
@@ -72,29 +72,34 @@
  The concrete classes which inherit from //ComponentList// and are subcomponents of the DataStructureDefinition are:
  DimensionDescriptor – content is Dimension and TimeDimension
++
  DimensionGroupDescriptor – content is an association to Dimension, TimeDimension
++
  MeasureDescriptor – content is Measure
++
  AttributeDescriptor – content is DataAttribute and an association to MetadataAttribute
  The classes that inherit from //Component// are:
  Measure
++
  //DimensionComponent// and thereby its sub classes of Dimension and TimeDimension
++
  //Attribute// and thereby its sub classes of DataAttribute and MetadataAttribute
  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.
--== 5.3 Data Structure Definition – Relationship View ==
++==== //5.3 Data Structure Definition – Relationship View// ====
--=== 5.3.1 Class Diagram ===
++===== 5.3.1 Class Diagram =====
  [[image:1749246368782-690.jpeg]]
  **Figure 28 Relationship class diagram of the Data Structure Definition excluding representation**
--=== 5.3.2 Explanation of the Diagrams ===
++===== 5.3.2 Explanation of the Diagrams =====
--==== 5.3.2.1 Narrative ====
++====== 5.3.2.1 Narrative ======
  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.
@@ -139,12 +139,11 @@
  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.
--(% style="width:1142.83px" %)
--|**Relationship**|(% style="width:537px" %)**Meaning**|(% style="width:434px" %)**Location in Data Set at which the Attribute is reported**
--|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.
--|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.
--|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.
--|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.
++|**Relationship**|**Meaning**|**Location in Data Set at which the Attribute is reported**
++|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.
++|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.
++|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.
++|Observation|The value of the Attribute varies with the observed value.|The attribute is reported at the level of Observation.
  [[image:1749246368790-555.jpeg]]
@@ -154,7 +154,7 @@
  A DataStructureDefinition can be extended to form a derived DataStructureDefinition. This is supported in the StructureMap.
--==== 5.3.2.2 Definitions ====
++**5.3.2.2 Definitions**
  |**Class**|**Feature**|**Description**
  |StructureUsage| |See “SDMX Base”.
@@ -164,7 +164,7 @@
  //StructureUsage//
  )))|Abstract concept (i.e., the structure without any data) of a flow of data that providers will provide for different reference periods.
  | |/structure|Associates a Dataflow to the Data Structure Definition.
--| |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}}.
++| |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]].
  |DataStructureDefiniti on| |A collection of metadata concepts, their structure and usage when used to collect or disseminate data.
  | |/grouping|An association to a set of metadata concepts that have an identified structural role in a Data Structure Definition.
  | |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 @@
  //ComponentList//
  )))|A set metadata concepts that define the Attributes of a Data Structure Definition.
--| |/components|An association to a Data Attribute component.
++| |/////components|An association to a Data Attribute component.
  |MeasureDescriptor|(((
  Inherits from
@@ -204,76 +204,84 @@
  TimeDimension
  )))|An abstract class representing any Component that can be used for identifying observations.
--(% style="width:981.835px" %)
--|(% style="width:202px" %)**Class**|(% style="width:240px" %)**Feature**|(% style="width:537px" %)**Description**
--|(% 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.
--|(% style="width:202px" %)Dimension|(% style="width:240px" %)(((
++
++
++
++|**Class**|**Feature**|**Description**
++| |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.
++|Dimension|(((
  Inherits from
++
  //DimensionComponent//
--)))|(% 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.
--|(% 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.
--|(% style="width:202px" %) |(% style="width:240px" %)/conceptIdentity|(% style="width:537px" %)An association to the metadata concept which defines the semantic of the Dimension.
--|(% style="width:202px" %)TimeDimension|(% style="width:240px" %)(((
++)))|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.
++| |/role|Association to the Concept that specifies the role that that the Dimension plays in the Data Structure Definition.
++| |/conceptIdentity|An association to the metadata concept which defines the semantic of the Dimension.
++|TimeDimension|(((
  Inherits from
++
  //DimensionComponent//
--)))|(% style="width:537px" %)A metadata concept that identifies the component in the key structure that has the role of “time”.
--|(% style="width:202px" %)DataAttribute|(% style="width:240px" %)(((
++)))|A metadata concept that identifies the component in the key structure that has the role of “time”.
++|DataAttribute|(((
  Inherits from
++
  //Component//
--)))|(% style="width:537px" %)A characteristic of an object or entity.
--|(% 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.
--|(% 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.
--|(% style="width:202px" %) |(% style="width:240px" %)maxOccurs|(% style="width:537px" %)Defines the maximum allowed occurrences for the Attribute.
--|(% style="width:202px" %) |(% style="width:240px" %)Usage|(% style="width:537px" %)Defines whether a Data Attribute must be reported or not.
--|(% style="width:202px" %) |(% style="width:240px" %)+relatedTo|(% style="width:537px" %)Association to an Attribute Relationship.
--|(% style="width:202px" %) |(% style="width:240px" %)/conceptIdentity|(% style="width:537px" %)An association to the Concept which defines the semantic of the component.
--|(% style="width:202px" %)Measure|(% style="width:240px" %)(((
++)))|A characteristic of an object or entity.
++| |/role|Association to the Concept that specifies the role that that the Data Attribute plays in the Data Structure Definition.
++| |minOccurs|Defines the minimum required occurrences for the Attribute. When equals to zero, the Attribute is conditional.
++| |maxOccurs|Defines the maximum allowed occurrences for the Attribute.
++| |Usage|Defines whether a Data Attribute must be reported or not.
++| |+relatedTo|Association to an Attribute Relationship.
++| |/conceptIdentity|An association to the Concept which defines the semantic of the component.
++|Measure|(((
  Inherits from
  //Component//
--)))|(% 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.
--|(% style="width:202px" %) |(% style="width:240px" %)/conceptIdentity|(% style="width:537px" %)An association to the Concept which carries the values of the measures.
--|(% 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.
--|(% style="width:202px" %) |(% style="width:240px" %)maxOccurs|(% style="width:537px" %)Defines the maximum allowed occurrences for the Measure.
--|(% style="width:202px" %) |(% style="width:240px" %)Usage|(% style="width:537px" %)Defines whether a Measure must be reported or not.
--|(% style="width:202px" %)//AttributeRelationship//|(% style="width:240px" %)(((
++)))|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.
++| |/conceptIdentity|An association to the Concept which carries the values of the measures.
++| |minOccurs|Defines the minimum required occurrences for the Measure. When equals to zero, the Measure is conditional.
++| |maxOccurs|Defines the maximum allowed occurrences for the Measure.
++| |Usage|Defines whether a Measure must be reported or not.
++|//AttributeRelationship//|(((
  Abstract Class
++
  Sub classes
--ObservationRelationship
--GroupRelationship DimensionRelationship
--)))|(% style="width:537px" %)Specifies the type of artefact to which a Data Attribute can be attached in a Data Set.
--|(% style="width:202px" %)ObservationRelationship|(% style="width:240px" %) |(% style="width:537px" %)The Data Attribute is related to the observations of the Data Set.
--|(% style="width:202px" %)GroupRelationship|(% style="width:240px" %) |(% style="width:537px" %)The Data Attribute is related to a Group Dimension Descriptor construct.
--|(% style="width:202px" %) |(% style="width:240px" %)+groupKey|(% style="width:537px" %)An association to the Group Dimension Descriptor
--|(% style="width:202px" %)DimensionRelationship|(% style="width:240px" %) |(% style="width:537px" %)The Data Attribute is related to a set of Dimensions.
--|(% style="width:202px" %) |(% style="width:240px" %)+dimensions|(% style="width:537px" %)Association to the set of Dimensions to which the Data Attribute is related.
--|(% 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.
--|(% style="width:202px" %)MeasureRelationship|(% style="width:240px" %) |(% style="width:537px" %)The Measures that a Data Attribute is reported for.
--|(% style="width:202px" %) |(% style="width:240px" %)+measures|(% style="width:537px" %)Association to the set of Measures to which a Data Attribute is related to.
--|(% 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.
--|(% 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.
--|(% style="width:202px" %) |(% style="width:240px" %)+name|(% style="width:537px" %)An association of a Sentinel Value to a multilingual name.
--|(% style="width:202px" %) |(% style="width:240px" %)+description|(% style="width:537px" %)An association of a Sentinel Value to a multilingual description.
++ObservationRelations hip
++GroupRelationship DimensionRelationshi p
++)))|Specifies the type of artefact to which a Data Attribute can be attached in a Data Set.
++|ObservationRelationsh ip| |The Data Attribute is related to the observations of the Data Set.
++|GroupRelationship| |The Data Attribute is related to a Group Dimension Descriptor construct.
++| |+groupKey|An association to the Group Dimension Descriptor
++|DimensionRelationship| |The Data Attribute is related to a set of Dimensions.
++| |+dimensions|Association to the set of Dimensions to which the Data Attribute is related.
++| |+groupKey|Association to the Group Dimension Descriptor which specifies the set of Dimensions to which the Data Attribute is attached.
++|MeasureRelationship| |The Measures that a Data Attribute is reported for.
++| |+measures|Association to the set of Measures to which a Data Attribute is related to.
++|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.
++|SentinelValue| |A value that has a special meaning within the text format representation of the Component.
++| |+name|An association of a Sentinel Value to a multilingual name.
++| |+description|An association of a Sentinel Value to a multilingual description.
++
++
  The explanation of the classes, attributes, and associations comprising the Representation is described in the section on the SDMX Base.
  ==== //5.4 Data Set – Relationship View// ====
--=== 5.4.1 Context ===
++===== 5.4.1 Context =====
  A data set comprises the collection of data values and associated metadata that are collected or disseminated according to a known DataStructureDefinition.
--=== 5.4.2 Class Diagram ===
++===== 5.4.2 Class Diagram =====
  [[image:1749246368794-672.jpeg]]
  **Figure 31: Class Diagram of the Data Set**
--=== 5.4.3 Explanation of the Diagram ===
++====== 5.4.3 Explanation of the Diagram ======
--==== 5.4.3.1 Narrative – Data Set ====
++5.4.3.1 Narrative – Data Set
  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.
@@ -291,169 +291,214 @@
  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.
--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.
++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.
  The //AttributeValue// links to the object type (SeriesKey, GroupKey, Observation) to which it is associated.
--==== 5.4.3.2 Definitions ====
++5.4.3.2 Definitions
--(% style="width:964.835px" %)
--|(% style="width:200px" %)**Class**|(% style="width:285px" %)**Feature**|(% style="width:454px" %)**Description**
--|(% style="width:200px" %)//DataSet//|(% style="width:285px" %)(((
++|**Class**|**Feature**|**Description**
++|//DataSet//|(((
  Abstract Class
++
  Sub classes
++
  StructureSpecificData
++
  Set
--)))|(% style="width:454px" %)An organised collection of data.
--|(% 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.
--|(% 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.
--|(% 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.
--|(% 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.
--|(% 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.
--|(% 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.
--|(% 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.
--|(% style="width:200px" %) |(% style="width:285px" %)setId|(% style="width:454px" %)Provides an identification of the data set.
--|(% style="width:200px" %) |(% style="width:285px" %)action|(% style="width:454px" %)Defines the action to be taken by the recipient system (information, append, replace, delete)
--|(% style="width:200px" %) |(% style="width:285px" %)describedBy|(% style="width:454px" %)(((
--Associates a Dataflow and thereby a Data Structure Definition to the data set.
++)))|An organised collection of data.
++| |reportingBegin|A specific time period in a known system of time periods that identifies the start period of a report.
++| |reportingEnd|A specific time period in a known system of time periods that identifies the end period of a report.
++| |dataExtractionDate|A specific time period that identifies the date and time that the data are extracted from a data source.
++| |validFrom|Indicates the inclusive start time indicating the validity of the information in the data set.
++| |validTo|Indicates the inclusive end time indicating the validity of the information in the data set.
++| |publicationYear|Specifies the year of publication of the data or metadata in terms of whatever provisioning agreements might be in force.
++| |publicationPeriod|Specifies the period of publication of the data or metadata in terms of whatever provisioning agreements might be in force.
++| |setId|Provides an identification of the data set.
++| |action|Defines the action to be taken by the recipient system (information, append, replace, delete)
++| |describedBy|(((
++Associates a Dataflow and thereby a Data Structure
++
++Definition to the data set.
  )))
--|(% style="width:200px" %) |(% style="width:285px" %)+structuredBy|(% style="width:454px" %)(((
--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.
++| |+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.
  )))
--|(% style="width:200px" %) |(% style="width:285px" %)+publishedBy|(% style="width:454px" %)Associates the Data Provider that reports/publishes the data.
--|(% 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.
--|(% style="width:200px" %)//Key//|(% style="width:285px" %)(((
++| |+publishedBy|Associates the Data Provider that reports/publishes the data.
++|StructureSpecific DataSet| |An XML specific data format structure that contains data corresponding to one specific Data Structure Definition.
++|//Key//|(((
  Abstract class
++
  Sub classes
++
  SeriesKey
++
  GroupKey
--)))|(% style="width:454px" %)Comprises the cross product of values of dimensions that identify uniquely an Observation.
--|(% style="width:200px" %) |(% style="width:285px" %)keyValues|(% style="width:454px" %)Association to the individual Key Values that comprise the Key.
--|(% style="width:200px" %) |(% style="width:285px" %)+attachedAttribute|(% style="width:454px" %)Association to the Attribute Values relating to the Series Key or Group Key.
--|(% style="width:200px" %)//KeyValue//|(% style="width:285px" %)(((
++)))|Comprises the cross product of values of dimensions that identify uniquely an Observation.
++| |keyValues|Association to the individual Key Values that comprise the Key.
++| |+attachedAttribute|Association to the Attribute Values relating to the Series Key or Group Key.
++|//KeyValue//|(((
  Abstract class
++
  Sub classes
++
  TimeKeyValue
++
  CodedKeyValue
++
  UncodedKeyValue
--)))|(% 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.
--|(% style="width:200px" %) |(% style="width:285px" %)+valueFor|(% 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.
++| |+valueFor|(((
  Association to the key component in the Data Structure Definition for which this Key Value is a valid representation.
++
  Note that this is conceptual association as the key component is identified explicitly in the data set.
  )))
--|(% style="width:200px" %)TimeKeyValue|(% style="width:285px" %)(((
++|TimeKeyValue|(((
  Inherits from
++
  //KeyValue//
--)))|(% style="width:454px" %)The value of the Time Dimension component of the key.
--|(% style="width:200px" %)CodedKeyValue|(% style="width:285px" %)(((
++)))|The value of the Time Dimension component of the key.
++|CodedKeyValue|(((
  Inherits from
++
  //KeyValue//
--)))|(% style="width:454px" %)The value of a coded component of the key. The value is the Code to which this class is associated.
--|(% 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.
--|(% style="width:200px" %)UnCodedKeyValue|(% style="width:285px" %)(((
++)))|The value of a coded component of the key. The value is the Code to which this class is associated.
++| |+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.
++|UnCodedKeyValue|(((
  Inherits from
++
  //KeyValue//
--)))|(% style="width:454px" %)The value of an uncoded component of the key.
--|(% style="width:200px" %) |(% style="width:285px" %)value|(% style="width:454px" %)The value of the key component.
--|(% 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).
--|(% style="width:200px" %)GroupKey|(% style="width:285px" %)(((
++)))|The value of an uncoded component of the key.
++| |value|The value of the key component.
++| |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).
++|GroupKey|(((
  Inherits from
++
  //Key//
--)))|(% 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.
--|(% style="width:200px" %) |(% style="width:285px" %)+describedBy|(% style="width:454px" %)Associates the Group Dimension Descriptor defined in the Data Structure Definition.
--|(% style="width:200px" %)SeriesKey|(% style="width:285px" %)(((
++)))|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.
++| |+describedBy|Associates the Group Dimension Descriptor defined in the Data Structure Definition.
++|SeriesKey|(((
  Inherits from
++
  //Key//
--)))|(% 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.
--|(% style="width:200px" %) |(% style="width:285px" %)+describedBy|(% style="width:454px" %)Associates the Dimension Descriptor defined in the Data Structure Definition.
--|(% 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.
--|(% style="width:200px" %) |(% style="width:285px" %)+valueFor|(% 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.
++| |+describedBy|Associates the Dimension Descriptor defined in the Data Structure Definition.
++|Observation| |The value(s) of the observed phenomenon in the context of the Key Values comprising the key.
++| |+valueFor|(((
  Associates the Measure(s) defined in the Data Structure Definition.
  The source multiplicity (1..*) indicates that more than one values may be provided for a Measure, if the latter allows it.
  )))
--|(% style="width:200px" %) |(% style="width:285px" %)+attachedAttribute|(% style="width:454px" %)Association to the Attribute Values relating to the Observation.
--|(% 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”.
--|(% style="width:200px" %)//ObservationValue//|(% style="width:285px" %)(((
++| |+attachedAttribute|Association to the Attribute Values relating to the Observation.
++| |+observationDimension|Association to the Key Value that holds the value of the “Dimension at the Observation Level”.
++|//ObservationValue//|(((
  Abstract class
  Sub classes
--//UncodedObservationValue//
++//UncodedObservationVal ue//
  CodedObservation
--)))|(% style="width:454px" %)
--|(% style="width:200px" %)//UncodedObservationValue//|(% style="width:285px" %)(((
++)))|
++|//UncodedObservatio nValue//|(((
  Abstract class
++
  Inherits from
++
  //ObservationValue//
++
  Sub classes
--OtherUncodedMeasureValue
++
++OtherUncodedMeasureVa lue
++
  TextMeasureValue
--)))|(% style="width:454px" %)
--|(% style="width:200px" %)OtherUncodedMeasureValue|(% style="width:285px" %)(((
++)))|
++|OtherUncodedMeasu reValue|(((
  Inherits from
--//UncodedObservationValue//
--)))|(% style="width:454px" %)An observation that has a text value.
--|(% style="width:200px" %) |(% style="width:285px" %)value|(% style="width:454px" %)The value of the Uncoded Observation.
--|(% 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).
--|(% style="width:200px" %)TextMeasureValue|(% style="width:285px" %)(((
++
++//UncodedObservationVal ue//
++)))|An observation that has a text value.
++| |value|The value of the Uncoded Observation.
++| |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).
++|TextMeasureValue|(((
  Inherits from
--//UncodedObservationValue//
--)))|(% style="width:454px" %)An observation that has a localised text value
--|(% style="width:200px" %) |(% style="width:285px" %)text|(% style="width:454px" %)The localised text values.
--|(% style="width:200px" %)CodedObservation|(% style="width:285px" %)(((
++
++//UncodedObservationVal ue//
++)))|An observation that has a localised text value
++| |text|The localised text values.
++|CodedObservation|(((
  Inherits from
++
  //ObservationValue//
--)))|(% style="width:454px" %)An Observation that takes its value from a code in a Code list.
--|(% 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.
--|(% style="width:200px" %)//AttributeValue//|(% style="width:285px" %)(((
++)))|An Observation that takes its value from a code in a Code list.
++| |+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.
++|//AttributeValue//|(((
  Abstract class
++
  Sub classes
--//DataAttributeValue// //MetadataAttributeValue//
--)))|(% style="width:454px" %)Represents the value for any Attribute reported in the Dataset, i.e., Data or Metadata Attribute.
--|(% style="width:200px" %)//DataAttributeValue//|(% style="width:285px" %)(((
++
++//DataAttributeValue// //MetadataAttributeValu e//
++)))|Represents the value for any Attribute reported in the Dataset, i.e., Data or Metadata Attribute.
++|//DataAttributeValu e//|(((
  Abstract class
++
  Inherits from
++
  //AttributeValue//
++
  Sub classes
--//UncodedAttributeValue
--CodedAttributeValue//
--)))|(% 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.
--|(% style="width:200px" %) |(% style="width:285px" %)+valueFor|(% style="width:454px" %)(((
++
++//UncodedAttributeValue//
++
++//CodedAttributeValue//
++)))|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.
++| |+valueFor|(((
  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.
++
  The source multiplicity (1..*) indicates the possibility to provide more than one values for a Data Attribute, if the latter allows it.
  )))
--|(% style="width:200px" %)//MetadataAttributeValue//|(% style="width:285px" %)(((
++|//MetadataAttribute Value//|(((
  (explained further in section
  “Metadata Set”)
--)))|(% style="width:454px" %)The value of a Metadata Attribute, as specified in the Metadata Structure Definition, which is linked in the Data Structure Definition
--|(% style="width:200px" %)//UncodedAttributeValue//|(% style="width:285px" %)(((
++)))|The value of a Metadata Attribute, as specified in the Metadata Structure Definition, which is linked in the Data Structure Definition
++|//UncodedAttributeV alue//|(((
  Inherits from
++
  //AttributeValue//
++
  Sub classes
++
  OtherUncodedAttribute
++
  Value
++
  TextAttributeValue
--)))|(% style="width:454px" %)
--|(% style="width:200px" %)OtherUncodedAttributeValue|(% style="width:285px" %)(((
++)))|
++|OtherUncodedAttri buteValue|(((
  Inherits from
--//UncodedObservationValue//
--)))|(% style="width:454px" %)An attribute value that has a text value
--|(% style="width:200px" %) |(% style="width:285px" %)value|(% style="width:454px" %)The value of the Uncoded attribute.
--|(% 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).
--|(% style="width:200px" %)TextAttributeValue|(% style="width:285px" %)(((
++
++//UncodedObservationVal ue//
++)))|An attribute value that has a text value
++| |value|The value of the Uncoded attribute.
++| |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).
++|TextAttributeValu e|(((
  Inherits from
++
  //UncodedAttributeValue//
--)))|(% style="width:454px" %)An attribute that has a localised text value
--|(% style="width:200px" %) |(% style="width:285px" %)text|(% style="width:454px" %)The localised text values.
--|(% style="width:200px" %)CodedAttributeValue|(% style="width:285px" %)(((
++)))|An attribute that has a localised text value
++| |text|The localised text values.
++|CodedAttributeVal ue|(((
  Inherits from
++
  //AttributeValue//
--)))|(% style="width:454px" %)An attribute that takes it value from a Code in Code list.
--|(% 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.
++)))|An attribute that takes it value from a Code in Code list.
++| |+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.
++
++
  ----
--{{putFootnotes/}}
++[[~[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.