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 11.2 to 12.1 From 17.1 to 18.1

From version 12.1

edited by Helena
on 2025/05/14 14:51

Change comment: There is no comment for this version

To version 17.1

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

Change comment: There is no comment for this version

Raw
Rendered

Summary

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

Details

Page properties

Content

@@ -247,8 +247,8 @@
  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"]]
@@ -259,8 +259,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.
@@ -271,58 +271,57 @@
  * 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">
--<!—- 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>
++> <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>
--<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 ==
@@ -329,57 +329,47 @@
  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.
--
--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 ===
--
++(% class="wikigeneratedid" id="HGeospatialInformationtype" %)
++**GeospatialInformation type**
  A new GeospatialInformation string type has been added which can be used as the 214 representation for any dimension, attribute or measure component. The value which is a 215 string expression conforming to the syntax defined in Section 6 of the technical 216 specifications precisely defines a ‘Geo Feature Set’ – a collection of geographical 217 features like points, lines or polygons. Its use is recommended in conjunction with the “GEO_FEATURE_SET” concept role.
--=== Geospatial code lists ===
--
++(% class="wikigeneratedid" id="HGeospatialcodelists" %)
++**Geospatial code lists**
  Two new specialised types of code list have been added where the definition of each code includes additional geospatial information in addition to the standard ID, name and description:
  * 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.
@@ -391,8 +391,8 @@
  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”.
@@ -402,19 +402,18 @@
  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 ==
@@ -463,7 +463,6 @@
  Examples:
  SDMX:CL_AREA(1.0.0)
--
  SDMX:CL_AREA(2.3.2)
  == Dependency management ==
@@ -470,10 +470,9 @@
  Additional constructs are possible for dependency management when referencing structures. For instance:
--2.3+.1 Means the currently latest available version >= “2.3.1” and < “3.0.0” (all backwards compatible versions >= “2.3.1”).
++2.3+.1               Means the currently latest available version >= “2.3.1” and < “3.0.0” (all backwards compatible versions >= “2.3.1”).
++2+.3.1               Means the currently latest available version >= “2.3.1” (even if not backwards compatible).
--2+.3.1 Means the currently latest available version >= “2.3.1” (even if not backwards compatible).
--
  == Draft structures ==
  A key principle is that semantically versioned structures are immutable and must not be changed without a corresponding change to the version number, except where explicitly marked as draft using extensions to the version number.
@@ -480,12 +480,10 @@
  MAJOR.MINOR.PATCH-EXTENSION
--1.10.0-draft Means that version 1.10.0 is still being modified and may change – equivalent to setting isFinal=false in SDMX 2.1.
++1.10.0-draft                Means that version 1.10.0 is still being modified and may change – equivalent to setting isFinal=false in SDMX 2.1.
++1.10.0-unstable          Alternative to -draft.
++1.10.0-notfinal            Alternative to -draft.
--1.10.0-unstable Alternative to -draft.
--
--1.10.0-notfinal Alternative to -draft.
--
  The SDMX 2.1 isFinal property is deprecated in 3.0.
  = 5 REST Web Services API =
@@ -508,8 +508,8 @@
  Data queries have been changed to provide more granular selections from contexts wider than just a Dataflow.
--=== Extend the context of data retrieval ===
--
++(% class="wikigeneratedid" id="HExtendthecontextofdataretrieval" %)
++**Extend the context of data retrieval**
  Version 2.1 data queries always retrieved data from a single specific Dataflow. In version 3.0, the query context may be specified as:
  * Dataflow;
@@ -518,18 +518,20 @@
  Data queries may also search across datasets, for instance “retrieve all data about a country”.
--=== Component-based filters ===
--
++(% class="wikigeneratedid" id="HComponent-basedfilters" %)
++**Component-based filters**
  Expressions filtering on individual components can now be included as part of the data query URL.
  /data/dataflow/ESTAT/ICP?c[REF_AREA]=CH&c[CONF_STATUS]=F
--=== Support for operators ===
--
++(% class="wikigeneratedid" id="HSupportforoperators" %)
++**Support for operators**
  Filter expressions can also include operators.
--/data/dataflow/ESTAT/ICP?c[REF_AREA]=DE&c[ICP_ITEM]=sw:01&c[TIME_PERIOD]=ge:2015 Operators include:
++/data/dataflow/ESTAT/ICP?c[REF_AREA]=DE&c[ICP_ITEM]=sw:01&c[TIME_PERIOD]=ge:2015
++Operators include:
++
  (% style="width:531.039px" %)
  |(% style="width:151px" %)eq|(% style="width:378px" %)Equals
  |(% style="width:151px" %)ne|(% style="width:378px" %)Not equal to
@@ -537,10 +537,11 @@
  |(% style="width:151px" %)ge|(% style="width:378px" %)Greater than or equal to
  |(% style="width:151px" %)sw|(% style="width:378px" %)Starts with
--=== Support for multiple keys ===
--
++(% class="wikigeneratedid" id="HSupportformultiplekeys" %)
++**Support for multiple keys**
  Queries can now specify multiple series keys.
++(% class="wikigeneratedid" %)
  /data/dataflow/ESTAT/ICP/1.0.0/M…A.ANR,M…A.INX,M…B.CTG
  == 5.3 Improved reference metadata queries ==
@@ -571,8 +571,8 @@
  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.
--=== Structure message ===
--
++(% class="wikigeneratedid" id="HStructuremessage" %)
++**Structure message**
  The SDMX-ML structure message is used for transmission of structural metadata. It closely reflects the SDMX information model and has therefore been significantly updated for version 3.0 with the addition of new structures, modifications where structures have changed, and removal of deprecated structures like Structure Set.
  Additionally, the way the individual artefacts are organised into ‘collections’ within the message has been significantly revised with a simpler flat structure adopted as set out in the following table:
@@ -623,8 +623,8 @@
  From version 3.0, collections can appear in any order within a structure message.
--=== Data messages ===
--
++(% class="wikigeneratedid" id="HDatamessages" %)
++**Data messages**
  All legacy SDMX-ML data messages have been deprecated with the exception of Structure Specific Data which becomes the sole standard format for transmission of SDMX data in XML in version 3.0.
  Specifically, the following data messages are not supported in version 3.0:
@@ -641,16 +641,16 @@
  The time series variant of the Structure Specific Data message is no longer used.
--=== Reference metadata message ===
--
++(% class="wikigeneratedid" id="HReferencemetadatamessage" %)
++**Reference metadata message**
  The Generic Metadata message remains the standard format for transmission of reference metadata sets in XML but has been modified to support the revised version 3.0 reference metadata model.
--=== Registry structural metadata ‘query’ messages ===
--
++(% class="wikigeneratedid" id="HRegistrystructuralmetadata2018query2019messages" %)
++**Registry structural metadata ‘query’ messages**
  As a consequence of the deprecation of the SOAP API and standardisation on REST, the structural metadata ‘query’ messages have all been removed. In version 3.0, querying an SDMX Registry for structural metadata is performed solely using REST GET.
--=== Structure referencing ===
--
++(% class="wikigeneratedid" id="HStructurereferencing" %)
++**Structure referencing**
  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 ==
@@ -657,20 +657,20 @@
  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.
--=== Structure message ===
--
++(% class="wikigeneratedid" id="HStructuremessage-1" %)
++**Structure message**
  The SDMX-JSON structure message closely replicates the SDMX-ML equivalent. Like that of SDMX-ML it has been updated to align it with the version 3.0 information model with addition, deletion and modification of artefacts as required. The organisation of the structure collections has also been revised as detailed in paragraph 6.1.
--=== Data message ===
--
++(% class="wikigeneratedid" id="HDatamessage" %)
++**Data message**
  The SDMX-JSON data message has similarly be updated. Additional changes have been made to allow a single message to carry data from multiple datasets with potentially different Data Structure Definitions to support REST data queries of the form “retrieve all data about a country”. For this reason, the version 3.0 SDMX-JSON is not backwardly compatible with version 2.1 data messages. Support has been added for the transmission of microdata and reporting of reference metadata on data as an integral part of the dataset.
--=== Reference metadata message ===
--
++(% class="wikigeneratedid" id="HReferencemetadatamessage-1" %)
++**Reference metadata message**
  The SDMX-JSON metadata message has also been updated to support the version 3.0 reference metadata and Metadataset specifications.
--=== Structure referencing ===
--
++(% class="wikigeneratedid" id="HStructurereferencing-1" %)
++**Structure referencing**
  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 ==
@@ -677,8 +677,8 @@
  CSV in SDMX is used transmission of data and reference metadata only.
--=== Data message ===
--
++(% class="wikigeneratedid" id="HDatamessage-1" %)
++**Data message**
  The SDMX-CSV data message has been modified to align with the version 3.0 information model, support the enhanced REST API and ensure that data can be freely converted to and from the XML and JSON formats without loss. These changes include:
  * An additional column identifying the type if the artefact defining the structure of the data: “dataflow”, “datastructure” or “dataprovision”; • A column for the structure artefact’s identification of the form
@@ -687,8 +687,8 @@
  * A column for the dataset action: information, append, replace or delete, which is consistent with both the the SDMX-ML and SDMX-JSON data messages.
--=== Reference metadata message ===
--
++(% class="wikigeneratedid" id="HReferencemetadatamessage-2" %)
++**Reference metadata message**
  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 ===