Skip to Content
Last modified by Artur on 2025/09/30 13:28
From version 21.3
edited by Helena
on 2025/06/08 16:28
Change comment: There is no comment for this version
To version 21.1
edited by Helena
on 2025/06/08 16:26
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,0 +1,1 @@
1 +1 Introduction
Content
... ... @@ -1,16 +5,15 @@
1 -{{box title="**Contents**"}}
2 -{{toc/}}
3 -{{/box}}
4 -
5 5  **Revision History**
6 6  
7 -(% style="width:824.835px" %)
8 -|(% style="width:184px" %)**Revision**|(% style="width:195px" %)**Date**|(% style="width:442px" %)**Contents**
9 -|(% style="width:184px" %)DRAFT 1.0|(% style="width:195px" %)December 2024|(% style="width:442px" %)Draft release updated for SDMX 3.1 for public consultation
10 -|(% style="width:184px" %)1.0|(% style="width:195px" %)May 2025|(% style="width:442px" %)Public release for SDMX 3.1
3 +:
11 11  
12 -= 1 Introduction =
5 +(((
6 +|**Revision**|**Date**|**Contents**
7 +|DRAFT 1.0|December 2024|Draft release updated for SDMX 3.1 for public consultation
8 +|1.0|May 2025|Public release for SDMX 3.1
9 +)))
13 13  
11 += {{id name="_Toc90780"/}}1 Introduction =
12 +
14 14  The business vision for SDMX envisages the promotion of a “data sharing” model to facilitate low-cost, high-quality statistical data and metadata exchange. Data sharing reduces the reporting burden of organisations by allowing them to publish data once and let their counterparties “pull” data and related metadata as required. The scenario is based on:
15 15  
16 16  * the availability of an abstract information model capable of supporting time series and cross-sectional data, structural metadata, and reference metadata (SDMX-IM)
... ... @@ -31,10 +31,12 @@
31 31  
32 32  These architectural standards address the ‘how’, rather than the ‘what’, and are aimed at enabling existing SDMX standards to achieve their mission. The architectural standards address registry services, which initially comprise:
33 33  
34 -* structural metadata repository
35 -* data and metadata registration
36 -* query
33 +• structural metadata repository
37 37  
35 +• data and metadata registration
36 +
37 +• query
38 +
38 38  The registry services outlined in this specification are designed to help the SDMX community manage the proliferation of SDMX assets and to support data sharing for reporting and dissemination.
39 39  
40 40  = {{id name="_Toc90781"/}}2 Scope and Normative Status =
... ... @@ -270,7 +270,7 @@
270 270  
271 271  1. Be a draft version.
272 272  
273 -b) Not be explicitly^^[[(% class="wikiinternallink wikiinternallink" %)^^1^^>>path:#sdfootnote1sym||name="sdfootnote1anc"]](%%)^^ referenced from any other object in the Registry.
274 +b) Not be explicitly^^[[^^1^^>>path:#sdfootnote1sym||name="sdfootnote1anc"]]^^ referenced from any other object in the Registry.
274 274  
275 275  4) The semantic versioning rules in the SDMX documentation MUST be obeyed.
276 276  )))
... ... @@ -308,47 +308,47 @@
308 308  
309 309  • //Maintainable//
310 310  
311 -| |(% colspan="2" %)**Object Type**|(% colspan="2" %)**Data Attributes**|(% colspan="2" %)**Status**|(% colspan="2" %)**Data type**|(% colspan="2" %)**Notes**
312 -| |(% colspan="2" rowspan="4" %)//Annotable//|(% colspan="2" %)AnnotationTitle|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %)
313 -| |(% colspan="2" %)AnnotationType|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %)
314 -| |(% colspan="2" %)AnnotationURN|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %)
315 -| |(% colspan="2" %)(((
312 +||(% colspan="2" %)**Object Type**|(% colspan="2" %)**Data Attributes**|(% colspan="2" %)**Status**|(% colspan="2" %)**Data type**|(% colspan="2" %)**Notes**
313 +||(% colspan="2" rowspan="4" %)//Annotable//|(% colspan="2" %)AnnotationTitle|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %)
314 +||(% colspan="2" %)AnnotationType|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %)
315 +||(% colspan="2" %)AnnotationURN|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %)
316 +||(% colspan="2" %)(((
316 316  AnnotationText in the form of
317 317  
318 318  InternationalString
319 -)))|(% colspan="2" %)C|(% colspan="2" %) |(% colspan="2" %)This can have languagespecific variants
320 -| |(% colspan="2" rowspan="4" %)//Identifiable//|(% colspan="2" %)All content as for //Annotable// plus|(% colspan="2" %) |(% colspan="2" %) |(% colspan="2" %)
321 -| |(% colspan="2" %)id|(% colspan="2" %)M|(% colspan="2" %)string|(% colspan="2" %)
322 -| |(% colspan="2" %)uri|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %)
323 -| |(% colspan="2" %)urn|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %)Although the urn is computable and therefore may not be submitted or stored physically, the Registry must return the urn for each object, and must be able to service a query on an object referenced solely by its urn.
324 -| |(% colspan="2" rowspan="3" %)//Nameable//|(% colspan="2" %)(((
320 +)))|(% colspan="2" %)C|(% colspan="2" %)|(% colspan="2" %)This can have languagespecific variants
321 +||(% colspan="2" rowspan="4" %)//Identifiable//|(% colspan="2" %)All content as for //Annotable// plus|(% colspan="2" %)|(% colspan="2" %)|(% colspan="2" %)
322 +||(% colspan="2" %)id|(% colspan="2" %)M|(% colspan="2" %)string|(% colspan="2" %)
323 +||(% colspan="2" %)uri|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %)
324 +||(% colspan="2" %)urn|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %)Although the urn is computable and therefore may not be submitted or stored physically, the Registry must return the urn for each object, and must be able to service a query on an object referenced solely by its urn.
325 +||(% colspan="2" rowspan="3" %)//Nameable//|(% colspan="2" %)(((
325 325  All content as for
326 326  
327 327  //Identifiable// plus
328 -)))|(% colspan="2" %) |(% colspan="2" %) |(% colspan="2" %)
329 -| |(% colspan="2" %)(((
329 +)))|(% colspan="2" %)|(% colspan="2" %)|(% colspan="2" %)
330 +||(% colspan="2" %)(((
330 330  Name in the form of
331 331  
332 332  InternationalString
333 333  )))|(% colspan="2" %)M|(% colspan="2" %)string|(% colspan="2" %)This can have language specific variants.
334 -| |(% colspan="2" %)(((
335 +||(% colspan="2" %)(((
335 335  Description in the form of
336 336  
337 337  InternationalString
338 338  )))|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %)This can have language specific variants.
339 -| |(% colspan="2" rowspan="4" %)//Versionable//|(% colspan="2" %)(((
340 +||(% colspan="2" rowspan="4" %)//Versionable//|(% colspan="2" %)(((
340 340  All content as for
341 341  
342 342  //Identifiable// plus
343 -)))|(% colspan="2" %) |(% colspan="2" %) |(% colspan="2" %)
344 -| |(% colspan="2" %)version|(% colspan="2" %)M|(% colspan="2" %)string|(% colspan="2" %)This is the version number according to SDMX versioning rules.
345 -| |(% colspan="2" %)validFrom|(% colspan="2" %)C|(% colspan="2" %)Date/time|(% colspan="2" %)
346 -| |(% colspan="2" %)validTo|(% colspan="2" %)C|(% colspan="2" %)Date/time|(% colspan="2" %)
347 -|(% colspan="2" rowspan="5" %)//Maintainable//|(% colspan="2" %)All content as for //Versionable// plus|(% colspan="2" %) |(% colspan="2" %) |(% colspan="2" %) |
348 -|(% colspan="2" %)isExternalReference|(% colspan="2" %)C|(% colspan="2" %)boolean|(% colspan="2" %)Value of “true” indicates that the actual resource is held outside of this registry. The actual reference is given in the registry URI or the structureURL, each of which must return a valid SDMX-ML file.|
349 -|(% colspan="2" %)serviceURL|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %)The url of the service that can be queried for this resource.|
350 -|(% colspan="2" %)structureURL|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %)The url of the resource.|
351 -|(% colspan="2" %)(Maintenance) organisationId|(% colspan="2" %)M|(% colspan="2" %)string|(% colspan="2" %)The object must be linked to a maintenance organisation, i.e., Agency or Metadata Provider.|
344 +)))|(% colspan="2" %)|(% colspan="2" %)|(% colspan="2" %)
345 +||(% colspan="2" %)version|(% colspan="2" %)M|(% colspan="2" %)string|(% colspan="2" %)This is the version number according to SDMX versioning rules.
346 +||(% colspan="2" %)validFrom|(% colspan="2" %)C|(% colspan="2" %)Date/time|(% colspan="2" %)
347 +||(% colspan="2" %)validTo|(% colspan="2" %)C|(% colspan="2" %)Date/time|(% colspan="2" %)
348 +|(% colspan="2" rowspan="5" %)//Maintainable//|(% colspan="2" %)All content as for //Versionable// plus|(% colspan="2" %)|(% colspan="2" %)|(% colspan="2" %)|
349 +|(% colspan="2" %)isExternalReference|(% colspan="2" %)C|(% colspan="2" %)boolean|(% colspan="2" %)Value of “true” indicates that the actual resource is held outside of this registry. The actual reference is given in the registry URI or the structureURL, each of which must return a valid SDMX-ML file.|
350 +|(% colspan="2" %)serviceURL|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %)The url of the service that can be queried for this resource.|
351 +|(% colspan="2" %)structureURL|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %)The url of the resource.|
352 +|(% colspan="2" %)(Maintenance) organisationId|(% colspan="2" %)M|(% colspan="2" %)string|(% colspan="2" %)The object must be linked to a maintenance organisation, i.e., Agency or Metadata Provider.|
352 352  
353 353  **Table 1: Common Attributes of Object Types**
354 354  
... ... @@ -510,92 +510,92 @@
510 510  
511 511  |**Package**|**URN class name (model class name where this is different)**
512 512  |base|Agency
513 -| |AgencyScheme
514 -| |DataConsumer
515 -| |DataConsumerScheme
516 -| |DataProvider
517 -| |DataProviderScheme
518 -| |MetadataProvider
519 -| |MetadataProviderScheme
520 -| |OrganisationUnit
521 -| |OrganisationUnitScheme
522 -| |
514 +||AgencyScheme
515 +||DataConsumer
516 +||DataConsumerScheme
517 +||DataProvider
518 +||DataProviderScheme
519 +||MetadataProvider
520 +||MetadataProviderScheme
521 +||OrganisationUnit
522 +||OrganisationUnitScheme
523 +||
523 523  |datastructure|AttributeDescriptor
524 -| |DataAttribute
525 -| |Dataflow
526 -| |DataStructure (DataStructureDefinition)
527 -| |Dimension
528 -| |DimensionDescriptor
529 -| |GroupDimensionDescriptor
530 -| |Measure
531 -| |MeasureDescriptor
532 -| |TimeDimension
533 -| |
525 +||DataAttribute
526 +||Dataflow
527 +||DataStructure (DataStructureDefinition)
528 +||Dimension
529 +||DimensionDescriptor
530 +||GroupDimensionDescriptor
531 +||Measure
532 +||MeasureDescriptor
533 +||TimeDimension
534 +||
534 534  |metadatastructure|MetadataAttribute
535 -| |MetadataAttributeDescriptor
536 -| |(((
536 +||MetadataAttributeDescriptor
537 +||(((
537 537  MetadataStructure
538 538  
539 539  (MetadataStructureDefinition)
540 540  )))
541 541  
542 -:
543 +:
543 543  
544 544  (((
545 545  |**Package**|**URN class name (model class name where this is different)**
546 -| |Metadataflow
547 -| |MetadataSet
548 -| |
547 +||Metadataflow
548 +||MetadataSet
549 +||
549 549  |process|Process
550 -| |ProcessStep
551 -| |Transition
552 -| |
551 +||ProcessStep
552 +||Transition
553 +||
553 553  |registry|DataConstraint
554 -| |MetadataConstraint
555 -| |MetadataProvisionAgreement
556 -| |ProvisionAgreement
557 -| |Subscription
558 -| |
555 +||MetadataConstraint
556 +||MetadataProvisionAgreement
557 +||ProvisionAgreement
558 +||Subscription
559 +||
559 559  |structuremapping|CategorySchemeMap
560 -| |ConceptSchemeMap
561 -| |OrganisationSchemeMap
562 -| |ReportingTaxonomyMap
563 -| |RepresentationMap
564 -| |StructureMap
565 -| |
561 +||ConceptSchemeMap
562 +||OrganisationSchemeMap
563 +||ReportingTaxonomyMap
564 +||RepresentationMap
565 +||StructureMap
566 +||
566 566  |codelist|Code
567 -| |Codelist
568 -| |HierarchicalCode
569 -| |Hierarchy
570 -| |HierarchyAssociation
571 -| |Level
572 -| |ValueList
573 -| |
568 +||Codelist
569 +||HierarchicalCode
570 +||Hierarchy
571 +||HierarchyAssociation
572 +||Level
573 +||ValueList
574 +||
574 574  |categoryscheme|Categorisation
575 -| |Category
576 -| |CategoryScheme
577 -| |ReportingCategory
578 -| |ReportingTaxonomy
576 +||Category
577 +||CategoryScheme
578 +||ReportingCategory
579 +||ReportingTaxonomy
579 579  |**Package**|**URN class name (model class name where this is different)**
580 -| |
581 +||
581 581  |conceptscheme|Concept
582 -| |ConceptScheme
583 -| |
583 +||ConceptScheme
584 +||
584 584  |transformation|CustomType
585 -| |CustomTypeScheme
586 -| |NamePersonalisation
587 -| |NamePersonalisationScheme
588 -| |Ruleset
589 -| |RulesetScheme
590 -| |Transformation
591 -| |TransformationScheme
592 -| |UserDefinedOperator
593 -| |UserDefinedOperatorScheme
594 -| |VtlCodelistMapping
595 -| |VtlConceptMapping
596 -| |VtlDataflowMapping
597 -| |VtlMappingScheme
598 -| |
586 +||CustomTypeScheme
587 +||NamePersonalisation
588 +||NamePersonalisationScheme
589 +||Ruleset
590 +||RulesetScheme
591 +||Transformation
592 +||TransformationScheme
593 +||UserDefinedOperator
594 +||UserDefinedOperatorScheme
595 +||VtlCodelistMapping
596 +||VtlConceptMapping
597 +||VtlDataflowMapping
598 +||VtlMappingScheme
599 +||
599 599  )))
600 600  
601 601  **Table 2: SDMX-IM Packages and Contained Classes**
... ... @@ -609,7 +609,7 @@
609 609  urn:sdmx.org.sdmx.infomodel.{package}.{classname}=
610 610  
611 611  |**Classname**|**Ending URN pattern**|**Example**
612 -|Agency^^[[(% class="wikiinternallink wikiinternallink" %)^^2^^>>path:#sdfootnote2sym||name="sdfootnote2anc"]](%%)^^|agencySchemeAgencyId:**AGENCIES**(**1.0**).agencyId|ECB:**AGENCIES**(**1.0**).AA
613 +|Agency^^[[^^2^^>>path:#sdfootnote2sym||name="sdfootnote2anc"]]^^|agencySchemeAgencyId:**AGENCIES**(**1.0**).agencyId|ECB:**AGENCIES**(**1.0**).AA
613 613  |//AgencyScheme//|agencySchemeAgencyId:**AGENCIES**(**1.0**)|ECB:**AGENCIES**(**1.0**)
614 614  |//Categorisation//|categorisationAgencyId:categorisationId(version)|IMF:cat001(1.0.0)
615 615  |Category|categorySchemeAgencyId:categorySchemeId(versi on).categoryId.categoryId.categoryId etc.|IMF:SDDS(1.0.0):level_1_category.level_2_category …
... ... @@ -768,22 +768,22 @@
768 768  The following table lists the Maintainable Artefacts.
769 769  
770 770  |(% colspan="2" %)**Maintainable Artefacts**|**Content**
771 -|**Abstract Class**|**Concrete Class**|
772 +|**Abstract Class**|**Concrete Class**|
772 772  |Item Scheme|Codelist|Code
773 -| |Concept Scheme|Concept
774 -| |Category Scheme|Category
775 -| |Organisation Unit Scheme|Organisation Unit
776 -| |Agency Scheme|Agency
777 -| |Data Provider Scheme|Data Provider
778 -| |Metadata Provider Scheme|Metadata Provider
779 -| |Data Consumer Scheme|Data Consumer
780 -| |Reporting Taxonomy|Reporting Category
781 -| |Transformation Scheme|Transformation
782 -| |Custom Type Scheme|Custom Type
783 -| |Name Personalisation Scheme|Name Personalisation
784 -| |Vtl Mapping Scheme|Vtl Codelist Mapping Vtl Concept Mapping
785 -| |Ruleset Scheme|Ruleset
786 -| |User Defined Operator Scheme|User Defined Operator
774 +||Concept Scheme|Concept
775 +||Category Scheme|Category
776 +||Organisation Unit Scheme|Organisation Unit
777 +||Agency Scheme|Agency
778 +||Data Provider Scheme|Data Provider
779 +||Metadata Provider Scheme|Metadata Provider
780 +||Data Consumer Scheme|Data Consumer
781 +||Reporting Taxonomy|Reporting Category
782 +||Transformation Scheme|Transformation
783 +||Custom Type Scheme|Custom Type
784 +||Name Personalisation Scheme|Name Personalisation
785 +||Vtl Mapping Scheme|Vtl Codelist Mapping Vtl Concept Mapping
786 +||Ruleset Scheme|Ruleset
787 +||User Defined Operator Scheme|User Defined Operator
787 787  |Enumerated List|ValueList|Value Item
788 788  |Structure|Data Structure Definition|(((
789 789  Dimension Descriptor
... ... @@ -802,9 +802,9 @@
802 802  
803 803  Measure
804 804  )))
805 -| |Metadata Structure Definition|Metadata Attribute Descriptor Metadata Attribute
806 -|Structure Usage|Dataflow|
807 -| |Metadataflow|
806 +||Metadata Structure Definition|Metadata Attribute Descriptor Metadata Attribute
807 +|Structure Usage|Dataflow|
808 +||Metadataflow|
808 808  |None|Process|Process Step
809 809  |None|Structure Map|(((
810 810  Component Map
... ... @@ -815,16 +815,16 @@
815 815  )))
816 816  |None|Representation Map|Representation Mapping
817 817  |Item Scheme Map|Organisation Scheme Map|Item Map
818 -| |Concept Scheme Map|Item Map
819 -| |Category Scheme Map|Item Map
820 -| |Reporting Taxonomy Map|Item Map
821 -|None|Provision Agreement|
822 -|None|Metadata Provision Agreement|
819 +||Concept Scheme Map|Item Map
820 +||Category Scheme Map|Item Map
821 +||Reporting Taxonomy Map|Item Map
822 +|None|Provision Agreement|
823 +|None|Metadata Provision Agreement|
823 823  |None|Hierarchy|Hierarchical Code
824 -|None|Hierarchy Association|
825 -|None|Categorisation|
825 +|None|Hierarchy Association|
826 +|None|Categorisation|
826 826  |Constraint|Data Constraint|DataKeySet
827 -| | |CubeRegion
828 +|||CubeRegion
828 828  |Constraint|Metadata Constraint|MetadataTargetRegion
829 829  
830 830  **Table 4: Table of Maintainable Artefacts for Structural Definition Metadata**
... ... @@ -834,7 +834,7 @@
834 834  The artefacts included in the structural definitions are:
835 835  
836 836  * All types of Item Scheme (Codelist, Concept Scheme, Category Scheme, Organisation Scheme, Agency Scheme, Data Provider Scheme, Metadata Provider Scheme, Data Consumer Scheme, Organisation Unit Scheme, Transformation Scheme, Name Personalisation Scheme, Custom Type Scheme, Vtl Mapping Scheme, Ruleset Scheme, User Defined Operator Scheme)
837 -* All types of Enumerated List (ValueList)^^[[(% class="wikiinternallink wikiinternallink" %)^^3^^>>path:#sdfootnote3sym||name="sdfootnote3anc"]](%%)^^
838 +* All types of Enumerated List (ValueList)^^[[^^3^^>>path:#sdfootnote3sym||name="sdfootnote3anc"]]^^
838 838  * All types of Structure (Data Structure Definition, Metadata Structure Definition)
839 839  * All types of Structure Usage (Dataflow, Metadataflow)
840 840  
... ... @@ -970,7 +970,7 @@
970 970  
971 971  The Registration has an action attribute which takes one of the following values:
972 972  
973 -:
974 +:
974 974  
975 975  (((
976 976  |**Action Attribute Value**|**Behaviour**
... ... @@ -995,7 +995,7 @@
995 995  
996 996  https:~/~/github.com/sdmx-twg/sdmx-rest/blob/master/doc/availability.md
997 997  
998 -:
999 +:
999 999  
1000 1000  (((
1001 1001  |**Indexing Required**|**Registration Process Activity**
... ... @@ -1018,7 +1018,7 @@
1018 1018  Components of the Constraints model in the
1019 1019  )))
1020 1020  |**Indexing Required**|**Registration Process Activity**
1021 -| |SDMX-IM. Note that the content is not stored in the Selection Value.
1022 +||SDMX-IM. Note that the content is not stored in the Selection Value.
1022 1022  )))
1023 1023  
1024 1024  Constraints that specify the contents of a //QueryDatasource// are submitted to the Registry via the structure submission service (i.e., the RESTful API).
... ... @@ -1061,7 +1061,7 @@
1061 1061  1. A selector which specifies which type of events are of interest. The set of event types is:
1062 1062  
1063 1063  :
1064 -::
1065 +::
1065 1065  
1066 1066  (((
1067 1067  |**Event Type**|**Comment**
... ... @@ -1135,7 +1135,7 @@
1135 1135  
1136 1136  Whenever a dataset or metadata-set is registered a registration event is created. A subscription may be observing all data or metadata registrations, or it may focus on specific registrations as shown in the table below:
1137 1137  
1138 -:
1139 +:
1139 1139  
1140 1140  (((
1141 1141  |**Selector**|**Comment**