Skip to Content
Version 7.2 by Artur on 2025/09/13 19:12
Show last authors
1 {{box title="**Contents**"}}
2 {{toc/}}
3 {{/box}}
4
5 = 1. Overview =
6
7 [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 3.1 is a minor revision to the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 3.0 Standard which introduces a limited set of changes, which cover the following:
8
9 **Information Model**
10
11 * Support for [[Dataflows>>doc:sdmx:Glossary.Dataflow.WebHome]] to reference a subset of [[Dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] from a [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]
12 * Simplification to Data (% style="color:#e74c3c" %)[[Constraints>>doc:sdmx:Glossary.Constraint.WebHome]]
13 * Addition of Availability (% style="color:#e74c3c" %)[[Constraints>>doc:sdmx:Glossary.Constraint.WebHome]]
14
15 **Documentation**
16
17 Registering [[Reference Metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] removed from documentation, to align with XML Registration object which is unable to reference a Metadata Provision, and REST API which is unable to query for registered [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] sources.
18
19 **Breaking Changes**
20
21 * Remove (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%) property on Categorisation
22 * Removal of Advanced [[Release Calendar>>doc:sdmx:Glossary.Release policy - release calendar.WebHome]]
23
24 **Content of the Document**
25
26 The remainder of this document contains a summary of the changes. More detailed information can be found in the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 3.1 Technical Specifications, in particular:
27
28 Section 2 – Information Model
29
30 Section 5 – Registry Specification
31
32 Section 6 – Technical Notes
33
34 [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] TWG GitHub for the REST API and the XML and JSON formats
35
36 = 2. Summary of Breaking Changes in 3.1 =
37
38 Version 3.1 introduces breaking changes, in the model in the following areas:
39
40 == 2.1 Removal of Advanced Release Calendar ==
41
42 The Data (% style="color:#e74c3c" %)[[Constraint>>doc:sdmx:Glossary.Constraint.WebHome]](%%) was simplified to become a cohesive structural [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] focussed solely on the restriction of values that can be reported. As part of this remodelling the Advanced [[Release Calendar>>doc:sdmx:Glossary.Release policy - release calendar.WebHome]] was removed as it does not play a restrictive role.
43
44 //Guidance for Implementors//
45 [[Reference Metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] reported against a [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] and / or [[Provision Agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]] can be used as an alternative to the Advanced [[Release Calendar>>doc:sdmx:Glossary.Release policy - release calendar.WebHome]].
46
47 == 2.2 Removal of Version on Categorisation ==
48
49 The Categorisation structural [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] has no use case for undergoing (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%) changes, the (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%) was therefore removed.
50
51 //Guidance for Implementors//
52 If multiple (% style="color:#e74c3c" %)[[versions>>doc:sdmx:Glossary.Version.WebHome]](%%) of a Categorisation exist where the source or target differs, these Categorisations should be given a unique ID.
53
54 = 3. Information Model =
55
56 The changes to the information model support two distinct use cases:
57
58 1. Horizontally complex [[Data Structure Definitions>>doc:sdmx:Glossary.Data structure definition.WebHome]] (DSDs)
59 1. Additional cohesion to the Data (% style="color:#e74c3c" %)[[Constraints>>doc:sdmx:Glossary.Constraint.WebHome]](%%) model
60
61 These changes are described in below.
62
63 == 3.1 Horizontally Complex Data Structure Definitions ==
64
65 An explanation of this use case, with additional details can be found under Section 6 - Technical Notes, under heading ‘10.3 [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] (% style="color:#e74c3c" %)[[Constraint>>doc:sdmx:Glossary.Constraint.WebHome]](%%)’.
66
67 The following changes to the model have been made to satisfy this use case.
68
69 **Data Structure Definition**
70
71 The [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] has a new ‘evolving structure’ property, this is a Boolean property, when set to ‘true’ it indicates to the users of the [[DSD>>doc:sdmx:Glossary.Data structure definition.WebHome]] that new [[Dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] may be added without the [[DSD>>doc:sdmx:Glossary.Data structure definition.WebHome]] undergoing a change to its major (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%) number.
72
73 **Dataflow**
74
75 The [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] has a new [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] (% style="color:#e74c3c" %)[[Constraint>>doc:sdmx:Glossary.Constraint.WebHome]](%%) property, which is used to reference a subset of [[Dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] which it uses from the referenced [[DSD>>doc:sdmx:Glossary.Data structure definition.WebHome]].
76
77 The [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] (% style="color:#e74c3c" %)[[Constraint>>doc:sdmx:Glossary.Constraint.WebHome]](%%) fixes the [[Dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] of the [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] enabling the referenced [[DSD>>doc:sdmx:Glossary.Data structure definition.WebHome]] to have new [[Dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] added without the need to change the major (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%) number.
78
79 The [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] (% style="color:#e74c3c" %)[[Constraint>>doc:sdmx:Glossary.Constraint.WebHome]](%%) property is only required if the [[DSD>>doc:sdmx:Glossary.Data structure definition.WebHome]] sets the evolving structure property to true.
80
81 == 3.2 Constraint Cohesion ==
82
83 The (% style="color:#e74c3c" %)[[Constraint>>doc:sdmx:Glossary.Constraint.WebHome]](%%) model in [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 3.1 has been made more cohesive by separating the Data (% style="color:#e74c3c" %)[[Constraint>>doc:sdmx:Glossary.Constraint.WebHome]](%%) into two distinct structures; the Data (% style="color:#e74c3c" %)[[Constraint>>doc:sdmx:Glossary.Constraint.WebHome]](%%) which describes reporting restrictions, and the Availability (% style="color:#e74c3c" %)[[Constraint>>doc:sdmx:Glossary.Constraint.WebHome]](%%), which describes data content from a [[data source>>doc:sdmx:Glossary.Data source.WebHome]]. In [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 3.0 these distinctions were made using the ‘type’ property on a Data (% style="color:#e74c3c" %)[[Constraint>>doc:sdmx:Glossary.Constraint.WebHome]](%%).
84
85 **Data [[Constraint>>doc:sdmx:Glossary.Constraint.WebHome]]**
86
87 The Data (% style="color:#e74c3c" %)[[Constraint>>doc:sdmx:Glossary.Constraint.WebHome]](%%) has had the ‘type’ property removed; the Data (% style="color:#e74c3c" %)[[Constraint>>doc:sdmx:Glossary.Constraint.WebHome]](%%) in [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 3.1 is always used to describe restrictions on content for data reporting purposes.
88
89 The attachment of the Data (% style="color:#e74c3c" %)[[Constraint>>doc:sdmx:Glossary.Constraint.WebHome]](%%) in [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 3.0 included [[Data Sources>>doc:sdmx:Glossary.Data source.WebHome]], in [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 3.1 these attachments have been removed as these are not relevant for restricting reported data.
90
91 **Availability [[Constraint>>doc:sdmx:Glossary.Constraint.WebHome]]**
92
93 The Availability (% style="color:#e74c3c" %)[[Constraint>>doc:sdmx:Glossary.Constraint.WebHome]](%%) is a new Structure introduced to describe data that exists, it is generated in the response to the Availability REST API. It is not a maintained structure, and as such has no [[maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]], identity or (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]]