Changes for page 7 Metadata Structure Definition and Metadata Set

Last modified by Helena K. on 2026/06/08 17:06

From 21.1 to 21.2 From 21.6 to 22.1

From version 21.2

edited by Helena K.
on 2026/06/08 17:00

Change comment: There is no comment for this version

To version 21.6

edited by Helena K.
on 2026/06/08 17:04

Change comment: There is no comment for this version

Raw
Rendered

Summary

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

Details

Page properties

Content

@@ -4,28 +4,28 @@
  == 7.1 Context ==
--Besides the possibility to extend the [[components>>doc:IMElements.components.WebHome]] of Data Structure Definitions by [[metadata>>doc:IMElements.metadata.WebHome]] attributes defined in Metadata Structure Definitions, the SDMX metamodel allows [[metadata>>doc:IMElements.metadata.WebHome]] to describe any identifiable artefact. These [[metadata>>doc:IMElements.metadata.WebHome]] can be:
++Besides the possibility to extend the [[components>>doc:sdmx:Glossary 2\.1.Component.WebHome]] of [[Data Structure Definitions>>doc:sdmx:Glossary 2\.1.Data structure definition.WebHome]] by metadata [[attributes>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]] defined in [[Metadata Structure Definitions>>doc:sdmx:Glossary 2\.1.Metadata structure definition.WebHome]], the [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] metamodel allows metadata to describe any [[identifiable artefact>>doc:sdmx:Glossary 2\.1.Identifiable artefact.WebHome]]. These metadata can be:
 . Exchanged without the need to embed it within the object that it is describing.
--1. Stored separately from the object that it describes, yet be linked to it (for example, an organisation has a metadata repository which supports the dissemination of [[metadata>>doc:IMElements.metadata.WebHome]] resulting from [[metadata>>doc:IMElements.metadata.WebHome]] requests generated by systems or services that have access to the object for which the [[metadata>>doc:IMElements.metadata.WebHome]] pertains. This is common in web dissemination where additional [[metadata>>doc:IMElements.metadata.WebHome]] is available for viewing (and eventually downloading) by clicking on an “information” icon next to the object to which the [[metadata>>doc:IMElements.metadata.WebHome]] is attached).
--1. Versioned and maintained like structural metadata, but from Metadata Providers than Agencies.
--1. Reported according to a defined [[structure>>doc:IMElements.structure.WebHome]].
++1. Stored separately from the object that it describes, yet be linked to it (for example, an organisation has a [[metadata repository>>doc:sdmx:Glossary 2\.1.Metadata repository.WebHome]] which supports the dissemination of metadata resulting from metadata requests generated by systems or services that have access to the object for which the metadata pertains. This is common in web dissemination where additional metadata is available for viewing (and eventually downloading) by clicking on an “information” icon next to the object to which the metadata is attached).
++1. Versioned and maintained like [[structural metadata>>doc:sdmx:Glossary 2\.1.Structural metadata.WebHome]], but from Metadata Providers than Agencies.
++1. Reported according to a defined structure.
  In order to achieve this, the following structures are modelled:
--* The Metadata Structure Definition which comprises the [[metadata>>doc:IMElements.metadata.WebHome]] attributes that can be attached to the various object types (these attributes can be structured in a hierarchy), together with any constraints that may apply (e.g., association to a code list that contains valid values for the attribute when reported in a metadata set),
--* The [[Metadataflow>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.StructureUsage.Metadataflow.WebHome]] and/or Metadata Provision Agreement, which contains the objects to which the [[metadata>>doc:IMElements.metadata.WebHome]] are to be associated (attached),
--* The Metadata Set, which contains reported [[metadata>>doc:IMElements.metadata.WebHome]].
++* The [[Metadata Structure Definition>>doc:sdmx:Glossary 2\.1.Metadata structure definition.WebHome]] which comprises the metadata [[attributes>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]] that can be attached to the various object types (these [[attributes>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]] can be structured in a [[hierarchy>>doc:sdmx:Glossary 2\.1.Hierarchy.WebHome]]), together with any [[constraints>>doc:sdmx:Glossary 2\.1.Constraint.WebHome]] that may apply (e.g., association to a [[code list>>doc:sdmx:Glossary 2\.1.Code list.WebHome]] that contains valid values for the [[attribute>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]] when reported in a [[metadata set>>doc:sdmx:Glossary 2\.1.Metadata set.WebHome]]),
++* The [[Metadataflow>>doc:sdmx:Glossary 2\.1.Metadataflow.WebHome]] and/or Metadata [[Provision Agreement>>doc:sdmx:Glossary 2\.1.Provision agreement.WebHome]], which contains the objects to which the metadata are to be associated (attached),
++* The [[Metadata Set>>doc:sdmx:Glossary 2\.1.Metadata set.WebHome]], which contains reported metadata.
  == 7.2 Inheritance ==
  === 7.2.1 Introduction ===
--As with the Data Structure Definition [[Structure>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.Structure.WebHome]], 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
++As with the [[Data Structure Definition>>doc:sdmx:Glossary 2\.1.Data structure definition.WebHome]] Structure, many of the constructs in this layer of the model inherit from the [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] Base layer. Therefore, it is necessary to study both the inheritance and the relationship diagrams to understand the functionality of individual
--packages. The diagram below shows the full inheritance tree    for the classes concerned with the MetadataStructureDefinition, the MetadataProvisionAgreement, the Metadataflow and the MetadataSet.
++packages. The diagram below shows the full inheritance tree    for the classes concerned with the MetadataStructureDefinition, the MetadataProvisionAgreement, the [[Metadataflow>>doc:sdmx:Glossary 2\.1.Metadataflow.WebHome]] and the MetadataSet.
--There are very few additional classes in the MetadataStructureDefinition package that do not themselves inherit from classes in the SDMX Base. In other words, the SDMX Base gives most of the structure of this sub model both in terms of associations and in terms of attributes. The relationship diagrams shown in this section show clearly when these associations are inherited from the SDMX Base (see the Appendix “A Short Guide to UML in the SDMX Information Model” to see the diagrammatic notation used to depict this).
++There are very few additional classes in the MetadataStructureDefinition package that do not themselves inherit from classes in the [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] Base. In other words, the [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] Base gives most of the structure of this sub model both in terms of associations and in terms of [[attributes>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]]. The relationship diagrams shown in this section show clearly when these associations are inherited from the [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] Base (see the Appendix “A Short Guide to UML in the [[SDMX Information Model>>doc:sdmx:Glossary 2\.1.SDMX Information Model.WebHome]]” to see the diagrammatic notation used to depict this).
  === 7.2.2 Class Diagram - Inheritance ===
@@ -39,15 +39,15 @@
  It is important to the understanding of the relationship class diagrams presented in this section to identify the concrete classes that inherit from the abstract classes.
--The concrete classes in this part of the SDMX metamodel, which require to be maintained by Maintenance Agencies, all inherit from MaintainableArtefact. These are:
++The concrete classes in this part of the [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] metamodel, which require to be maintained by [[Maintenance Agencies>>doc:sdmx:Glossary 2\.1.Maintenance agency.WebHome]], all inherit from MaintainableArtefact. These are:
--//StructureUsage// (concrete class is Metadataflow)
++//StructureUsage// (concrete class is [[Metadataflow>>doc:sdmx:Glossary 2\.1.Metadataflow.WebHome]])
  //Structure// (concrete class is MetadataStructureDefinition)
  MetadataProvisionAgreement
--These classes also inherit the identity and versioning facets of //IdentifiableArtefact//, //NameableArtefact// and //VersionableArtefact//.
++These classes also inherit the identity and versioning [[facets>>doc:sdmx:Glossary 2\.1.Facet.WebHome]] of //IdentifiableArtefact//, //NameableArtefact// and //VersionableArtefact//.
--A //Structure// may contain several lists of components. In this case the MetadataStructureDefinition acts as a list and contains //Component//s, i.e., MetadataAttributes.
++A //Structure// may contain several lists of [[components>>doc:sdmx:Glossary 2\.1.Component.WebHome]]. In this case the MetadataStructureDefinition acts as a list and contains //Component//s, i.e., MetadataAttributes.
  == 7.3 Metadata Structure Definition ==
@@ -57,7 +57,7 @@
  === 7.3.2 Structures Already Described ===
--The MetadataStructureDefinition only contains MetadataAttributes, since target objects are contained in Metadataflow and MetadataProvisionAgreement, since SDMX 3.0.
++The MetadataStructureDefinition only contains MetadataAttributes, since target objects are contained in [[Metadataflow>>doc:sdmx:Glossary 2\.1.Metadataflow.WebHome]] and MetadataProvisionAgreement, since [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] 3.0.
  === 7.3.3 Class Diagram – Relationship ===
@@ -69,56 +69,56 @@
  ==== 7.3.4.1 Narrative ====
--In brief, a MetadataStructureDefinition (MSD) defines the MetadataAttributes, within an MetadataAttributeDescriptor, that can be associated with the objects identified in the Metadataflows and MetadataProvisionAgreements that refer to the MSD. The hierarchy of the MetadataAttributes is specified within the MetadataAttributeDescriptor.
++In brief, a MetadataStructureDefinition ([[MSD>>doc:sdmx:Glossary 2\.1.Metadata structure definition.WebHome]]) defines the MetadataAttributes, within an MetadataAttributeDescriptor, that can be associated with the objects identified in the [[Metadataflows>>doc:sdmx:Glossary 2\.1.Metadataflow.WebHome]] and MetadataProvisionAgreements that refer to the [[MSD>>doc:sdmx:Glossary 2\.1.Metadata structure definition.WebHome]]. The [[hierarchy>>doc:sdmx:Glossary 2\.1.Hierarchy.WebHome]] of the MetadataAttributes is specified within the MetadataAttributeDescriptor.
--The MetadataAttributeDescriptor comprises a set of MetadataAttributes – these can be defined as a hierarchy. Each MetadataAttribute identifies a Concept that is reported or disseminated in a MetadataSet (/conceptIdentity) that uses this MetadataStructureDefinition. Different MetadataAttributes in the same MetadataAttributeDescriptor can use Concepts from different ConceptSchemes. Note that a MetadataAttribute does not link to a Concept that defines its role in this MetadataStructureDefinition (i.e., the MetadataAttribute does not play a role).
++The MetadataAttributeDescriptor comprises a set of MetadataAttributes – these can be defined as a [[hierarchy>>doc:sdmx:Glossary 2\.1.Hierarchy.WebHome]]. Each MetadataAttribute identifies a [[Concept>>doc:sdmx:Glossary 2\.1.Concept.WebHome]] that is reported or disseminated in a MetadataSet (/conceptIdentity) that uses this MetadataStructureDefinition. Different MetadataAttributes in the same MetadataAttributeDescriptor can use [[Concepts>>doc:sdmx:Glossary 2\.1.Concept.WebHome]] from different ConceptSchemes. Note that a MetadataAttribute does not link to a [[Concept>>doc:sdmx:Glossary 2\.1.Concept.WebHome]] that defines its role in this MetadataStructureDefinition (i.e., the MetadataAttribute does not play a role).
--The MetadataAttribute can be specified as having multiple occurrences and/or specified as being mandatory (minOccurs=1 or more) or optional (minOccurs=0). A hierarchical MetadataStructureDefinition can be defined by specifying a hierarchy for a MetadataAttribute.
++The MetadataAttribute can be specified as having multiple occurrences and/or specified as being mandatory (minOccurs=1 or more) or optional (minOccurs=0). A hierarchical MetadataStructureDefinition can be defined by specifying a [[hierarchy>>doc:sdmx:Glossary 2\.1.Hierarchy.WebHome]] for a MetadataAttribute.
--It can be seen from this, that the specification of the objects to which a MetadataAttribute can be attached is indirect: the MetadataAttributes are defined in a MetadataStructureDefinition, but they are attached to one or more IdentifiableArtefacts as defined in the Metadataflows or
++It can be seen from this, that the specification of the objects to which a MetadataAttribute can be attached is indirect: the MetadataAttributes are defined in a MetadataStructureDefinition, but they are attached to one or more IdentifiableArtefacts as defined in the [[Metadataflows>>doc:sdmx:Glossary 2\.1.Metadataflow.WebHome]] or
  MetadataProvisionAgreements. This gives a flexible mechanism by which the actual objects need not be defined in concrete terms in the model but are defined dynamically by the IdentifiableObjectSelection. In this way, the MetadataStructureDefinition can be used to define any set of MetadataAttributes regardless of the objects to which they can be attached.
--Each MetadataAttribute can have a Representation specified (using the /localRepresentation association). If this is not specified in the MetadataStructureDefinition then the Representation is taken from that defined for the Concept (the coreRepresentation association).
++Each MetadataAttribute can have a [[Representation>>doc:sdmx:Glossary 2\.1.Representation.WebHome]] specified (using the /localRepresentation association). If this is not specified in the MetadataStructureDefinition then the [[Representation>>doc:sdmx:Glossary 2\.1.Representation.WebHome]] is taken from that defined for the [[Concept>>doc:sdmx:Glossary 2\.1.Concept.WebHome]] (the coreRepresentation association).
--The definition of the various types of Representation can be found in the specification of the Base constructs. Note that if the Representation is non-enumerated then the association is to the ExtendedFacet (which allows for XHTML as a FacetValueType). If the Representation is enumerated, then is must use a Codelist.
++The definition of the various types of [[Representation>>doc:sdmx:Glossary 2\.1.Representation.WebHome]] can be found in the specification of the Base constructs. Note that if the [[Representation>>doc:sdmx:Glossary 2\.1.Representation.WebHome]] is non-enumerated then the association is to the ExtendedFacet (which allows for XHTML as a FacetValueType). If the [[Representation>>doc:sdmx:Glossary 2\.1.Representation.WebHome]] is enumerated, then is must use a [[Codelist>>doc:sdmx:Glossary 2\.1.Code list.WebHome]].
--The Metadataflow is linked to a MetadataStructureDefinition. The Metadataflow, in addition to the attributes inherited from the Base classes, it also has a list of IdentifiableObjectSelection constructs, which resolve into the IdentifiableArtefacts that the Metadatasets will refer to. The IdentifiableObjectSelection acts like a reference, but it may also include wildcarding part of the reference terms.
++The [[Metadataflow>>doc:sdmx:Glossary 2\.1.Metadataflow.WebHome]] is linked to a MetadataStructureDefinition. The [[Metadataflow>>doc:sdmx:Glossary 2\.1.Metadataflow.WebHome]], in addition to the [[attributes>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]] inherited from the Base classes, it also has a list of IdentifiableObjectSelection constructs, which resolve into the IdentifiableArtefacts that the Metadatasets will refer to. The IdentifiableObjectSelection acts like a reference, but it may also include wildcarding part of the reference terms.
--The MetadataProvisionAgreement is linked to a Metadataflow. The former, like the Metadataflow, may have IdentifiableObjectSelection constructs to be used for specifying the proper targets for reference metadata.
++The MetadataProvisionAgreement is linked to a [[Metadataflow>>doc:sdmx:Glossary 2\.1.Metadataflow.WebHome]]. The former, like the [[Metadataflow>>doc:sdmx:Glossary 2\.1.Metadataflow.WebHome]], may have IdentifiableObjectSelection constructs to be used for specifying the proper targets for [[reference metadata>>doc:sdmx:Glossary 2\.1.Reference metadata.WebHome]].
  ==== 7.3.4.2 Definitions ====
  (% style="width:975.835px" %)
  |**Class**|**Feature**|(% style="width:574px" %)**Description**
--|//StructureUsage//| |(% style="width:574px" %)See “SDMX Base”.
--|Metadataflow|(((
++|//StructureUsage//| |(% style="width:574px" %)See “[[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] Base”.
++|[[Metadataflow>>doc:sdmx:Glossary 2\.1.Metadataflow.WebHome]]|(((
  Inherits from:
  //StructureUsage//
--)))|(% style="width:574px" %)Abstract concept (i.e., the structure without any metadata) of a flow of metadata that providers will provide for different reference periods. Specifies possible targets for metadata, via the Identifiable Object Selection.
--| |/structure|(% style="width:574px" %)Associates a Metadata Structure Definition.
--|MetadataProvisionAgreement| |(% style="width:574px" %)Links the Metadata Provider to the relevant Structure Usage (i.e., Metadataflow) for which the provider supplies metadata. The agreement may constrain the scope of the metadata that can be provided, by means of a Constraint. Specifies possible targets for metadata, via the Identifiable Object Selection.
++)))|(% style="width:574px" %)Abstract concept (i.e., the structure without any metadata) of a flow of metadata that providers will provide for different [[reference periods>>doc:sdmx:Glossary 2\.1.Reference period.WebHome]]. Specifies possible targets for metadata, via the Identifiable Object Selection.
++| |/structure|(% style="width:574px" %)Associates a [[Metadata Structure Definition>>doc:sdmx:Glossary 2\.1.Metadata structure definition.WebHome]].
++|MetadataProvisionAgreement| |(% style="width:574px" %)Links the Metadata Provider to the relevant Structure Usage (i.e., [[Metadataflow>>doc:sdmx:Glossary 2\.1.Metadataflow.WebHome]]) for which the provider supplies metadata. The agreement may constrain the scope of the metadata that can be provided, by means of a [[Constraint>>doc:sdmx:Glossary 2\.1.Constraint.WebHome]]. Specifies possible targets for metadata, via the Identifiable Object Selection.
  |MetadataProvider| |(% style="width:574px" %)See Organisation Scheme.
  |IdentifiableObjectSelection| |(% style="width:574px" %)A list or wildcarded expression resolving into Identifiable Objects that metadata will refer to.
  |MetadataStructureDefinition|(((
  Inherits from:
  //MaintainableArtefact//
--)))|(% style="width:574px" %)A collection of metadata concepts and their structure when used to collect or disseminate reference metadata.
++)))|(% style="width:574px" %)A collection of metadata concepts and their structure when used to collect or disseminate [[reference metadata>>doc:sdmx:Glossary 2\.1.Reference metadata.WebHome]].
  |MetadataAttributeDescriptor|(((
  Inherits from:
  //ComponentList//
--)))|(% style="width:574px" %)Defines a set of concepts that comprises the Metadata Attributes to be reported.
--| |/components|(% style="width:574px" %)An association to the Metadata Attributes relevant to the Metadata Attribute Descriptor.
--|MetadataAttribute|// //|(% style="width:574px" %)Identifies a Concept for which a value may be reported in a Metadata Set.
--| |/hierarchy|(% style="width:574px" %)Association to one or more child Metadata Attribute.
--| |/conceptIdentity|(% style="width:574px" %)An association to the concept which defines the semantic of the attribute.
--| |isPresentational|(% style="width:574px" %)Indication that the Metadata Attribute is present for structural purposes (i.e. it has child attributes) and that no value for this attribute is expected to be reported in a Metadata Set.
++)))|(% style="width:574px" %)Defines a set of concepts that comprises the Metadata [[Attributes>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]] to be reported.
++| |/components|(% style="width:574px" %)An association to the Metadata [[Attributes>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]] relevant to the Metadata [[Attribute>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]] Descriptor.
++|MetadataAttribute|// //|(% style="width:574px" %)Identifies a [[Concept>>doc:sdmx:Glossary 2\.1.Concept.WebHome]] for which a value may be reported in a [[Metadata Set>>doc:sdmx:Glossary 2\.1.Metadata set.WebHome]].
++| |/hierarchy|(% style="width:574px" %)Association to one or more child Metadata [[Attribute>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]].
++| |/conceptIdentity|(% style="width:574px" %)An association to the concept which defines the semantic of the [[attribute>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]].
++| |isPresentational|(% style="width:574px" %)Indication that the Metadata [[Attribute>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]] is present for structural purposes (i.e. it has child [[attributes>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]]) and that no value for this [[attribute>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]] is expected to be reported in a [[Metadata Set>>doc:sdmx:Glossary 2\.1.Metadata set.WebHome]].
  | |minOccurs maxOccurs|(% style="width:574px" %)(((
--Specifies how many occurrences of the Metadata Attribute may be reported at this point in the Metadataset.
++Specifies how many occurrences of the Metadata [[Attribute>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]] may be reported at this point in the Metadataset.
  )))
--| |/localRepresentation|(% style="width:574px" %)Associates a Representation that overrides any core representation specified for the Concept itself.
--|Representation| |(% style="width:574px" %)The representation of the Metadata Attribute.
++| |/localRepresentation|(% style="width:574px" %)Associates a [[Representation>>doc:sdmx:Glossary 2\.1.Representation.WebHome]] that overrides any core [[representation>>doc:sdmx:Glossary 2\.1.Representation.WebHome]] specified for the [[Concept>>doc:sdmx:Glossary 2\.1.Concept.WebHome]] itself.
++|[[Representation>>doc:sdmx:Glossary 2\.1.Representation.WebHome]]| |(% style="width:574px" %)The [[representation>>doc:sdmx:Glossary 2\.1.Representation.WebHome]] of the Metadata [[Attribute>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]].
  == 7.4 Metadata Set ==