Changes for page SDMX 3.0 Standards. Summary of Major Changes and New Functionality

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

From 7.4 to 7.5 From 16.2 to 16.3

From version 7.5

edited by Helena
on 2025/05/14 13:36

Change comment: There is no comment for this version

To version 16.2

edited by Helena
on 2025/05/16 13:18

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (4 modified, 0 added, 0 removed)
Objects (0 modified, 1 added, 0 removed)
- SUZ.Methodology.Code.MethodologyClass[0]

Details

Page properties

Title

@@ -1,1 +1,1 @@
--1 Overview
++SDMX STANDARDS

Parent

...	...	@@ -1,0 +1,1 @@
	1	+Methodology.WebHome

Content

@@ -65,7 +65,7 @@
  Version 3.0 introduces breaking changes into the web services API, transmission formats and information model. A summary is given in the table below.
--== //2.1 Web Services API// ==
++== 2.1 Web Services API ==
  (% style="width:948.039px" %)
  |**REST API**|(% style="width:818px" %)(((
@@ -86,10 +86,8 @@
  )))
  |**SOAP API**|(% style="width:818px" %)The SOAP API has been deprecated.
--== //2.2 Transmission Formats// ==
++== 2.2 Transmission Formats ==
--:
--
  (((
  (% style="width:952.039px" %)
  |(% style="width:130px" %)**SDMX-ML**|(% style="width:820px" %)(((
@@ -117,20 +117,15 @@
  The JSON structure message is not backwardly compatible primarily due to:
  * Changes to the information model
--* Changes to the way the structures are organised into
--
--‘collections’ within the message
--
++* Changes to the way the structures are organised into ‘collections’ within the message
  * Deprecation of the Agency, ID, Version option for referencing of structures in messages
  )))
  |(% style="width:130px" %)**SDMX-EDI**|(% style="width:820px" %)The EDI format for both structures and data has been deprecated.
--|(% style="width:130px" %)**SDMX-CSV**|(% style="width:820px" %)The CSV data and reference metadata messages are not backwardly compatible with those under version 2.1 due to changes to the structure of the messages needed to support new features such as the improved REST API data queries.** &nbsp;&nbsp;&nbsp;&nbsp;**
++|(% style="width:130px" %)**SDMX-CSV**|(% style="width:820px" %)The CSV data and reference metadata messages are not backwardly compatible with those under version 2.1 due to changes to the structure of the messages needed to support new features such as the improved REST API data queries.
  )))
--== //2.3 Information Model// ==
++== 2.3 Information Model ==
--:
--
  (((
  (% style="width:955.039px" %)
  |(% style="width:132px" %)**Data Structure Definition**|(% style="width:819px" %)(((
@@ -158,10 +158,7 @@
  //Conversion guidance for implementors//
--A version 2.1 Metadata Structure Definition can be converted to the version 3.0 model under some circumstances, but target information is either lost or has to be translated into a metadataflow. Further, conversion of a Data Structure Definition for collecting reference metadata against a dataset would need to make changes to the dataset’s Data Structure Definition. As the Data Structure Definition may not actually be specified, judgement would need to be taken, perhaps determining the most likely candidate by examining which
--)))
--|(% style="width:132px" %) |(% style="width:819px" %)(((
--already have metadata reported against their datasets. A 2.1 metadata report could be converted to a version 3.0 Metadataset if it is attached to a structure, but requires a Metadata Provision Agreement which would need to be created if not already in existence.
++A version 2.1 Metadata Structure Definition can be converted to the version 3.0 model under some circumstances, but target information is either lost or has to be translated into a metadataflow. Further, conversion of a Data Structure Definition for collecting reference metadata against a dataset would need to make changes to the dataset’s Data Structure Definition. As the Data Structure Definition may not actually be specified, judgement would need to be taken, perhaps determining the most likely candidate by examining which already have metadata reported against their datasets. A 2.1 metadata report could be converted to a version 3.0 Metadataset if it is attached to a structure, but requires a Metadata Provision Agreement which would need to be created if not already in existence.
  Conversion from the version 3.0 model to version 2.1 cannot be performed reliably. The process would need target information to be derived from analysis of the Metadataflows and Metadata Provision Agreements. Depending on the complexity it may not be possible to express that information in a version 2.1 Data Structure Definition.
  )))
@@ -187,7 +187,7 @@
  = 3 Information Model =
--== //3.1 Version 3.0 Information Model// ==
++== 3.1 Version 3.0 Information Model ==
  [[image:SDMX 3-0-0 Major Changes FINAL-1.0_en_6fc573fe.png||height="404" width="718"]]
@@ -197,7 +197,7 @@
  A number of ancillary structures including organisation schemes, process and reporting taxonomy are unchanged and have not been shown. Similarly, Organisation Scheme Map and Reporting Taxonomy Map have been omitted for simplicity. A schematic of the 2.1 model is given in Appendix A for comparison purposes.
--== //3.2 Key Changes from Version 2.1// ==
++== 3.2 Key Changes from Version 2.1 ==
  New Maintainable Artefacts
@@ -225,7 +225,8 @@
  Removed Maintainable Artefacts
  * Structure Set – replaced by Structure Map and the four item scheme maps
--* Hierarchical Codelist – replaced by Hierarchy and Hierarchy Association • Constraint – replaced by Data Constraint and Metadata Constraint
++* Hierarchical Codelist – replaced by Hierarchy and Hierarchy Association
++* Constraint – replaced by Data Constraint and Metadata Constraint
  Changed Maintainable Artefacts
@@ -239,7 +239,7 @@
  * GeospatialInformation – a string type where the value is an expression defining a set of geographical features using a purpose-designed syntax
--== //3.3 Areas Unchanged from Version 2.1// ==
++== 3.3 Areas Unchanged from Version 2.1 ==
  The following areas of the information model are unchanged from version 2.1:
@@ -252,12 +252,12 @@
  * Reporting taxonomy
  * Process
--== //3.4 Reference Metadata// ==
++== 3.4 Reference Metadata ==
  Reference metadata has been substantially re-designed for version 3.0 to simplify the model and better support practical use cases.
--=== Simplify Metadata Structure Definition ===
--
++(% class="wikigeneratedid" id="HSimplifyMetadataStructureDefinition" %)
++**Simplify Metadata Structure Definition**
  The Metadata Structure Definition (MSD) has been simplified to remove target information, and the support of multiple report structures. The MSD now only contains Metadata Attributes which are used to define the structure of a report.
  [[image:SDMX 3-0-0 Major Changes FINAL-1.0_en_ad5f5c97.png||height="346" width="494"]]
@@ -268,8 +268,8 @@
  //Figure 3 the simplified version 3.0 MSD//
--=== Change to reference metadata reported against data ===
--
++(% class="wikigeneratedid" id="HChangetoreferencemetadatareportedagainstdata" %)
++**Change to reference metadata reported against data**
  Reference metadata associated with datasets, data series or observations are now reported with the data. The dataset’s DSD must reference an MSD to define the structure of its reference metadata. In practice reference metadata for data are transmitted as part of the data message. The metadata attributes are treated in a similar way to the data attributes appearing in the message at the dataset, data series or individual observation level as appropriate. In contrast to simple data attributes, metadata attributes defined by an MSD can be organised into a hierarchical structure as illustrated in Figure 3 above. For this reason, metadata attributes appear in data messages structured in the same way as metadata messages.
  The SDMX-ML example below is an excerpt from a structure specific data message illustrating reporting of reference metadata with a hierarchical structure at the observation level.
@@ -280,158 +280,96 @@
  * TITLE – a multi-lingual data attribute
  * SOURCE_AGENCY – a multi-value data attribute
--<Obs xsi:type="dsd:ObsType" OBS_VALUE="112" OBS_STAUS=”A” TIME_PERIOD="2010-09">
++> <Obs xsi:type="dsd:ObsType" OBS_VALUE="112" OBS_STAUS=”A” TIME_PERIOD="2010-09">
++>     <!—- complex multi-value and multi-lingual data attributes ~-~->
++>     <Comp id="TITLE" xsi:type="ns1:TITLE_ATTRIBUTE">
++>         <Value>
++>         <common:Text xml:lang="en">Some English Text</common:Text>
++>         <common:Text xml:lang="fr">Quelques textes en anglais</common:Text>
++>         </Value>
++>     </Comp>
++>     <Comp id="SOURCE_AGENCY" xsi:type="ns1:SOURCE_AGENCY_ATTRIBUTE">
++>         <Value>4F0</Value>
++>         <Value>4D0</Value>
++>         <Value>CZ2</Value>
++>     </Comp>
++> <!—- metadata attributes are reported like in metadata messages ~-~->
++> <Metadata>
++>     <Attribute id="COLLECTION">
++>         <Attribute id="METHOD">
++>             <Text lang="en">AAA</Text>
++>         </Attribute>
++>     </Attribute>
++>     <Attribute id="CONTACT">
++>          <Value>CONTACT 1</Value>
++>          <Attribute id="NAME">
++>             <Value>Contact 1 Name 1</Value>
++>      </Attribute>
++>      <Attribute id="NAME">
++>             <Value>Contact 1 Name 2</Value>
++>         </Attribute>
++>     </Attribute>
++>     <Attribute id="CONTACT">
++>           <Value>CONTACT 2</Value>
++>         <Attribute id="NAME">
++>             <Value>Contact 2 Name 1</Value>
++>       </Attribute>
++>       <Attribute id="NAME">
++>                 <Value>Contact 2 Name 2</Value>
++>                </Attribute>
++>           </Attribute>
++>       </Metadata>
++> </Obs>
--<!—- complex multi-value and multi-lingual data attributes ~-~->
--
--<Comp id="TITLE" xsi:type="ns1:TITLE_ATTRIBUTE">
--
--<Value>
--
--<common:Text xml:lang="en">Some English Text</common:Text>
--
--<common:Text xml:lang="fr">Quelques textes en anglais</common:Text>
--
--</Value>
--
--</Comp>
--
--<Comp id="SOURCE_AGENCY" xsi:type="ns1:SOURCE_AGENCY_ATTRIBUTE">
--
--<Value>4F0</Value>
--
--<Value>4D0</Value>
--
--<Value>CZ2</Value>
--
--</Comp>
--
--<!—- metadata attributes are reported like in metadata messages ~-~->
--
--<Metadata>
--
--<Attribute id="COLLECTION">
--
--<Attribute id="METHOD">
--
--<Text lang="en">AAA</Text>
--
--</Attribute>
--
--</Attribute>
--
--<Attribute id="CONTACT">
--
--<Value>CONTACT 1</Value>
--
--<Attribute id="NAME">
--
--<Value>Contact 1 Name 1</Value>
--
--</Attribute>
--
--<Attribute id="NAME">
--
--<Value>Contact 1 Name 2</Value>
--
--</Attribute>
--
--</Attribute>
--
--<Attribute id="CONTACT">
--
--<Value>CONTACT 2</Value>
--
--<Attribute id="NAME">
--
--<Value>Contact 2 Name 1</Value>
--
--</Attribute>
--
--<Attribute id="NAME">
--
--<Value>Contact 2 Name 2</Value>
--
--</Attribute>
--
--</Attribute>
--
--</Metadata>
--
--</Obs>
--
--=== New - Metadata Provision Agreement ===
--
++(% class="wikigeneratedid" id="HNew-MetadataProvisionAgreement" %)
++**New - Metadata Provision Agreement**
  In version 2.1 a Provision Agreement could be used to report information against a Dataflow or Metadataflow. From version 3.0 this is managed by two separate structures, the Data Provision Agreement and the Metadata Provision Agreement.
--=== Move target to Metadataflow and Metadata Provision Agreement ===
--
++(% class="wikigeneratedid" id="HMovetargettoMetadataflowandMetadataProvisionAgreement" %)
++**Move target to Metadataflow and Metadata Provision Agreement**
  For reference metadata that is reported against structures, the allowable targets information which is used to specify what structures the reference metadata can be reported against, has moved to the Metadataflow and can be further refined in the Metadata Provision Agreement.
--=== Add maintainable properties to reference metadata ===
--
++(% class="wikigeneratedid" id="HAddmaintainablepropertiestoreferencemetadata" %)
++**Add maintainable properties to reference metadata**
  A Metadataset now has mandatory identification information, (owner id, id, version) enabling metadata providers to uniquely identify their reports for create, update or delete maintenance operations.
--== //3.5 Microdata Exchange// ==
++== 3.5 Microdata Exchange ==
  Several changes have been made the Data Structure Definition to support microdata use cases in addition to aggregated time series.
--=== Multiple measures ===
++(% class="wikigeneratedid" id="HMultiplemeasures" %)
++**Multiple measures**
++Multiple measures are a common characteristic of microdatasets. To support this use case, the MeasureDimension has been deprecated and replaced with the option to define zero or more measures. Measures now act like any other component in that they use concepts, can have their own local coded or uncoded representation defined within the Data Structure Definition, and can be either mandatory or conditional. Creating a measure with the “MEASURE” concept role applied emulates the version 2.1 MeasureDimension behaviour as illustrated in the SDMX-ML example below:
--Multiple measures are a common characteristic of microdatasets. To support this use case, the MeasureDimension has been deprecated and replaced with the option to define zero or more measures. Measures now act like any other component in that they use concepts, can have their own local coded or uncoded representation defined within the
++> <str:MeasureList id=”MeasureDescriptor”>
++>     <str:Measure id=”OBS_VALUE” minOccurs=”1” maxOccurs=”1” usage=”mandatory” > <str:ConceptIdentity>
++>         <Ref id=”OBS_VALUE” maintainableParentID=”CONCEPTS” agencyID=”SDMX” maintainableParentVersion=”1.0.0” />
++>     </str:ConceptIdentity>
++>     <str:LocalRepresentation>
++>         <str:TextFormat textType=”String” isMultiLingual=”true” />
++>     </str:LocalRepresentation>
++>     <str:ConceptRole>
++>         <Ref id=”MEASURE” maintainableParentID=”SDMX_CONCEPT_ROLES” agencyID=”SDMX” maintainableParentVersion=”1.0.0” />
++>     </str:ConceptRole>
++>  </str:Measure>
++>         ...
++>     <str:Measure>
++> </str:MeasureList>
--Data Structure Definition, and can be either mandatory or conditional. Creating a measure with the “MEASURE” concept role applied emulates the version 2.1
++(% class="wikigeneratedid" id="HMulti-valuemeasuresandattributes" %)
++**Multi-value measures and attributes**
++Both measures and attributes have been extended with the option to take ‘arrays’ of 193 multiple coded or uncoded values. This supports use cases like multiple observation 194 status flags. New //minOccurs// and //maxOccurs// properties define the valid number of 195 values. The //usage// property separately defines whether the measure or attribute is //mandatory// or optional. In the SDMX-ML measure example above, the properties //minOccurs=”1” maxOccurs=”1” usage=”mandatory”// specify that OBS_VALUE must be 198 reported, and can only consist of a single value.
--MeasureDimension behaviour as illustrated in the SDMX-ML example below:
--
--<str:MeasureList id=”MeasureDescriptor”>
--
--<str:Measure id=”OBS_VALUE” minOccurs=”1” maxOccurs=”1” usage=”mandatory” > <str:ConceptIdentity>
--
--<Ref id=”OBS_VALUE” maintainableParentID=”CONCEPTS” agencyID=”SDMX” maintainableParentVersion=”1.0.0” />
--
--</str:ConceptIdentity>
--
--<str:LocalRepresentation>
--
--<str:TextFormat textType=”String” isMultiLingual=”true” />
--
--</str:LocalRepresentation>
--
--<str:ConceptRole>
--
--<Ref id=”MEASURE” maintainableParentID=”SDMX_CONCEPT_ROLES” agencyID=”SDMX” maintainableParentVersion=”1.0.0” />
--
--</str:ConceptRole>
--
--</str:Measure>
--
--...
--
--<str:Measure>
--
--</str:MeasureList>
--
--=== Multi-value measures and attributes ===
--
--Both measures and attributes have been extended with the option to take ‘arrays’ of 193 multiple coded or uncoded values. This supports use cases like multiple observation 194 status flags. New //minOccurs// and //maxOccurs// properties define the valid number of 195 values. The //usage// property separately defines whether the measure or attribute is
--
--//mandatory// or optional. In the SDMX-ML measure example above, the properties
--
--//minOccurs=”1” maxOccurs=”1” usage=”mandatory”// specify that OBS_VALUE must be 198 reported, and can only consist of a single value.
--
--=== Attributes relationship to measures ===
--
++(% class="wikigeneratedid" id="HAttributesrelationshiptomeasures" %)
++**Attributes relationship to measures**
  In addition to attaching attributes to a specific level within the dataset, their relationship 202 to measures can also be defined.
--=== Value lists ===
++(% class="wikigeneratedid" id="HValuelists" %)
++**Value lists**
++Value lists help in modelling microdata by providing an enumeration similar to code lists 206 but allowing any string values without being restricted to the rules of SDMX identifiers. That allows ValueItems (the equivalent to Code) to contain symbols like ‘¥’ and ‘€’, but also means they are not identifiable.
--Value lists help in modelling microdata by providing an enumeration similar to code lists 206 but allowing any string values without being restricted to the rules of SDMX identifiers.
++== 3.6 Geospatial Data Exchange ==
--That allows ValueItems (the equivalent to Code) to contain symbols like ‘¥’ and ‘€’, but 208 also means they are not identifiable.
--
--== //3.6 Geospatial Data Exchange// ==
--
  The version 3.0 model has been extended to provide explicit support for geospatial data.
  === GeospatialInformation type ===
@@ -445,14 +445,14 @@
  * GeographicCodelist – each item includes an element to represent a specific Geo Feature Set which is described using the same expression syntax as for GeospatialInformation type.
  * GeoGridCodelist – A code list defining a geographical grid composed of cells representing regular squared portions of the Earth. Each item references a cell within the grid.
--=== //3.7 Structure Mapping// ===
++== 3.7 Structure Mapping ==
  The Structure Set in version 2.1 is a container for many mapping structures including Data Structure Map, Codelist Map and Concept Map. For version 3.0 the Structure Set artefact has been deprecated and replaced with a number of new maintainables giving better flexibility and reusability, specifically: Structure Map, Concept Scheme Map, Representation Map, Reporting Taxonomy Map, Category Scheme Map and Organisation Scheme Map.
  The version 2.1 Codelist Map been replaced with Representation Map which allows mappings to be defined between any combination of Code Lists, Value Lists and noncoded representations such as text strings and numbers.
--==== Many-to-many source and target components ====
--
++(% class="wikigeneratedid" id="HMany-to-manysourceandtargetcomponents" %)
++**Many-to-many source and target components**
  Structure mapping rules may be defined with both multiple source components and multiple target components in contrast to version 2.1 where only one source and target was allowed. That supports many-to-many (n-n) mapping use cases where the output of a mapping rule may be dependent on the combination of a number of input components. For instance:
  Set the output component INDICATOR=”DE_A” if the input components are FREQ=”A” and REF_AREA=”DE”.
@@ -462,22 +462,21 @@
  Set the output components FREQ=”A”, REF_AREA=”DE” if the input component INDICATOR=”DE_A”.
  **Fixed source and target**
--
  The Structure Map may now define input or output components which have a fixed value.
--==== Time representations mapping ====
--
++(% class="wikigeneratedid" id="HTimerepresentationsmapping" %)
++**Time representations mapping**
  Non SDMX time representations may now be described in a Structure Map, allowing them to be mapped into SDMX time formats.
--==== Regular expression and substring mappings ====
--
++(% class="wikigeneratedid" id="HRegularexpressionandsubstringmappings" %)
++**Regular expression and substring mappings**
  All item maps allow the use of regular expressions and substrings to match source values, specifically: Concept Scheme Map, Reporting Taxonomy Map, Category Scheme Map and Organisation Scheme Map.
--==== Item maps validity period ====
--
++(% class="wikigeneratedid" id="HItemmapsvalidityperiod" %)
++**Item maps validity period**
  Item maps may further define the period for which the mapping is valid, meaning the mapping rule will only be applied if the row of information being mapped is within the period.
--=== //3.8 Constraints// ===
++== 3.8 Constraints ==
  Constraints in version 3.0 are modelled using two separate artefacts which replace the version 2.1 content constraint:
@@ -492,17 +492,17 @@
  Attachment constraints have been deprecated due to a lack of use cases.
--=== //3.9 Code List Extension// ===
++== 3.9 Code List Extension ==
  In addition to the two new specialised geospatial forms, the option has been added to define a code list as an extension of, or by inheriting codes from, other lists. An optional prefix can be added to inherited codes to disambiguate duplicates.
  This feature allows new code lists to be easily derived from existing lists without the need to make and manually maintain copies. When querying for extended code list structures using the REST API, the option has been added to retrieve either the definition or the materialised list. Traditional literal lists of codes continue to be supported.
--=== //3.10 Discriminated Union of Code Lists// ===
++== 3.10 Discriminated Union of Code Lists ==
  Combining code list extension with wildcarded constraints solves the discriminated union of code lists problem where a classification or breakdown has multiple “variants” which are all valid but mutually exclusive. A common example is economic activity where several alternative classification schemes are in use including ISIC revisions 1 to 4 and NACE as used in the European Community.
--=== //3.11 Code Hierarchies// ===
++== 3.11 Code Hierarchies ==
  Code hierarchies allow the definition of complex hierarchies of codes from potentially multiple lists for data discovery purposes. Hierarchical Codelist has been deprecated and replaced by two new artefacts: Hierarchy – the actual hierarchy of codes, and Hierarchy Association links hierarchies directly to any other identifiable object, a capability missing 312 from the version 2.1 model. Further, the linkage can be within a particular context, for instance linking a hierarchy to a dimension within the context of a specific Dataflow (dimension REF_AREA in the context of the ECB:EXR Dataflow).
@@ -550,7 +550,7 @@
  = 5 REST Web Services API =
--== //5.1 Simplified list of resources// ==
++== 5.1 Simplified list of resources ==
  The version 3.0 REST API has just five main resources:
@@ -564,7 +564,7 @@
  This and changes in the URLs and query parameters on the data, availability and metadata resources means that, with the exception of schema queries, the version 3.0 API is not backwardly compatible.
--== //5.2 Improved data queries// ==
++== 5.2 Improved data queries ==
  Data queries have been changed to provide more granular selections from contexts wider than just a Dataflow.
@@ -603,7 +603,7 @@
  /data/dataflow/ESTAT/ICP/1.0.0/M…A.ANR,M…A.INX,M…B.CTG
--== //5.3 Improved reference metadata queries// ==
++== 5.3 Improved reference metadata queries ==
  Reference metadata queries have been improved with a number of new options to retrieve metadata reports.
@@ -619,7 +619,7 @@
  /metadata/structure/datastructure/BIS/BIS_CBS/1.0
--== //5.4 Structural metadata maintenance// ==
++== 5.4 Structural metadata maintenance ==
  Support has been added for maintenance of structural metadata.
@@ -627,7 +627,7 @@
  = 6 XML, JSON, CSV and EDI Transmission formats =
--== //6.1 SDMX-ML// ==
++== 6.1 SDMX-ML ==
  The SDMX-ML XML messages have been modified and updated for version 3.0. While they broadly follow the same principles, there have been significant changes which break backward compatibility.
@@ -713,7 +713,7 @@
  The option to reference structures using Agency, ID and Version has been removed. From SDMX version 3.0 URN is used for all referencing purposes with the exception of local references such as where groups reference dimensions within a DSD.
--== //6.2 SDMX-JSON// ==
++== 6.2 SDMX-JSON ==
  Like SDMX-ML, the SDMX-JSON messages have been significantly modified and updated for version 3.0. They are not backwardly compatible with version 2.1.
@@ -733,7 +733,7 @@
  As for SDMX-ML, the option to reference structures using Agency, ID and Version has been removed with URN used for all non-local referencing purposes.
--== //6.3 SDMX-CSV// ==
++== 6.3 SDMX-CSV ==
  CSV in SDMX is used transmission of data and reference metadata only.
@@ -751,7 +751,7 @@
  The SDMX-CSV metadata message is new for version 3.0 and, like the SDMX-ML and SDMX-JSON equivalents, is used for the transmission reference metadata sets.
--=== //6.4 EDI deprecation// ===
++=== 6.4 EDI deprecation ===
  The EDI format for transmission of both structures and data has been deprecated. Version 3.0 is therefore not backwardly compatible with legacy EDI messages.

SUZ.Methodology.Code.MethodologyClass[0]