Changes for page Part IV. Data and Metadata Namespaces

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

From 4.2 to 4.1 From 4.6 to 4.5

From version 4.5

edited by Helena
on 2025/06/24 14:51

Change comment: There is no comment for this version

To version 4.2

edited by Helena
on 2025/06/24 14:47

Change comment: There is no comment for this version

Raw
Rendered

Summary

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

Details

Page properties

Content

@@ -158,12 +158,15 @@
  **BaseValueType: **BaseValueType is a general structure which contains a reference to a data structure definition component and a value for that component. In this structure the reference to the component is optional to allow for usages where the actual reference might be provided in another context.
  Attributes:
++
  id?, value
  Content:
++
  {Empty}
  Attribute Documentation:
++
  |**Name**|**Type**|**Documentation**
  |id|com:NCNameIDType|The id attribute contains the identifier for the component for which a value is being provided.
  |value|xs:anySimpleType|The value attribute contains the provided component value.
@@ -172,16 +172,19 @@
  Derivation:
--* BaseValueType (restriction)
--** ObsValueType
++BaseValueType (restriction)
++   [[image:1750765436897-317.png]]ObsValueType
  Attributes:
++
  id?, value
  Content:
++
  {Empty}
  Attribute Documentation:
++
  |**Name**|**Type**|**Documentation**
  |id (fixed: OBS_VALUE)|com:NCNameIDType|The id attribute contains a fixed reference to the primary measure component of the data structure definition.
  |value|xs:string|The value attribute contains the provided component value.
@@ -189,16 +189,20 @@
  **ComponentValueType: **ComponentValueType is a derivation of the BaseValueType which requires that the component reference be provided. This is used when the identification of the component cannot be inferred from another context.
  Derivation:
--* BaseValueType (restriction)
--** ComponentValueType
++BaseValueType (restriction)
++   [[image:1750765436899-296.png]]ComponentValueType
++
  Attributes:
++
  id, value
  Content:
++
  {Empty}
  Attribute Documentation:
++
  |**Name**|**Type**|**Documentation**
  |id|com:NCNameIDType|The id attribute contains the identifier for the component for which a value is being provided.
  |value|xs:string|The value attribute contains the provided component value.
@@ -206,17 +206,21 @@
  **TimeSeriesDataSetType: **TimeSeriesDataSetType is a derivation of the base DataSetType of the generic format the restricts the data set to only allow for grouped observations where the dimension at the observation level is the time dimension of the data structure definition. This means that unlike the base data set structure, there can be no un-grouped observations. Because this derivation is achieved using restriction, data sets conforming to this type will inherently conform to the base data set structure as well. In fact, data structured here will be identical to data in the base data set when the time dimension is the observation dimension. This means that the data contained in this structure can be processed in exactly the same manner as the base structure.
  Derivation:
--* //com:AnnotableType// (extension)
--** DataSetType (restriction)
--*** TimeSeriesDataSetType
++//com:AnnotableType// (extension)
++   [[image:1750765436901-853.png]]DataSetType (restriction)
++         [[image:1750765436906-461.png]]TimeSeriesDataSetType
++
  Attributes:
++
  structureRef, setID?, action?, reportingBeginDate?, reportingEndDate?, validFromDate?, validToDate?, publicationYear?, publicationPeriod?
  Content:
++
  com:Annotations?, DataProvider?, Attributes?, Group*, Series*
  Attribute Documentation:
++
  |**Name**|**Type**|**Documentation**
  |structureRef|xs:IDREF|The structureRef contains a reference to a structural specification in the header of a data or reference metadata message. The structural specification details which structure the data or reference metadata conforms to, as well as providing additional information such as how the data is structure (e.g. which dimension occurs at the observation level for a data set).
  |setID|com:IDType|The setID provides an identification of the data or metadata set.
@@ -240,14 +240,17 @@
  **TimeSeriesType: **TimeSeriesType defines a structure which is used to group a collection of observations which have a key in common, organised by time. The key for a series is every dimension defined in the data structure definition, save the time dimension. In addition to observations, values can be provided for attributes which are associated with the dimensions which make up this series key (so long as the attributes do not specify a group attachment or also have an relationship with the time dimension). It is possible for the series to contain only observations or only attribute values, or both.
  Derivation:
--* //com:AnnotableType// (extension)
--** SeriesType (restriction)
--*** TimeSeriesType
++//com:AnnotableType// (extension)
++   [[image:1750765436911-979.png]]SeriesType (restriction)
++         [[image:1750765436912-452.png]]TimeSeriesType
++
  Content:
++
  com:Annotations?, SeriesKey, Attributes?, Obs*
  Element Documentation:
++
  |**Name**|**Type**|**Documentation**
  |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType my reference it.
  |SeriesKey|ValuesType|SeriesKey contains the values for each all dimensions defined in the data structure definition, except for that which is declared to be at the observation level for this data set. This key is required, and every dimension must be provided a value.
@@ -257,14 +257,17 @@
  **TimeSeriesObsType: **TimeSeriesObsType defines the structure of a time series observation. The observation must be provided a value for the time dimension. This time value should disambiguate the observation within the series in which it is defined (i.e. there should not be another observation with the same time value). The observation can contain an observed value and/or attribute values.
  Derivation:
--* //com:AnnotableType// (extension)
--** ObsType (restriction)
--*** TimeSeriesObsType
++//com:AnnotableType// (extension)
++   [[image:1750765436913-909.png]]ObsType (restriction)
++         [[image:1750765436914-333.png]]TimeSeriesObsType
++
  Content:
++
  com:Annotations?, ObsDimension, ObsValue?, Attributes?
  Element Documentation:
++
  |**Name**|**Type**|**Documentation**
  |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType my reference it.
  |ObsDimension|TimeValueType|ObsDimension holds the key for the grouped observation, i.e. the value of the observation dimension. Note that in this element, the reference to the dimension is optional, since it can be inferred from the structure specification for the data set. This saves having to repeat the value unnecessarily. It is assumed that any application processing the data set will have the information from the structure specification available, so that if a dimension identifier is not supplied here, the proper reference can be applied.
@@ -274,27 +274,35 @@
  **TimeValueType: **TimeValueType is a derivation of the BaseValueType which is used to provide a value for the time dimension. Since the identifier for the time dimension is fixed, the component reference for this structure is fixed. Note that this means that it is not necessary to provide a value in an instance as the fixed value will be provided in the post validation information set.
  Derivation:
--* BaseValueType (restriction)
--** TimeValueType
++BaseValueType (restriction)
++   [[image:1750765436914-771.png]]TimeValueType
++
  Attributes:
++
  id?, value
  Content:
++
  {Empty}
  Attribute Documentation:
++
  |**Name**|**Type**|**Documentation**
  |id (fixed: TIME_PERIOD)|com:NCNameIDType|The id attribute contains the identifier for the component for which a value is being provided.
  |value|com: ObservationalTimePer iodType|The value attribute contains the provided component value.
--== 2.2 Structure Specific Data Namespace ==
++1.
++11. Structure Specific Data Namespace
  **http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/data/structurespecific**
--=== Summary ===
++1.
++11.
++111. Summary
  Referenced Namespaces:
++
  |**Namespace**|**Prefix**
  | |
  |http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/common|com
@@ -301,24 +301,31 @@
  |http:~/~/www.w3.org/2001/XMLSchema|xs
  Contents:
++
 Complex Types
 Simple Type
--=== Complex Types ===
++1.
++11.
++111. Complex Types
  **//DataSetType//: **DataSetType is the abstract type which defines the base structure for any data structure definition specific data set. A derived data set type will be created that is specific to a data structure definition and the details of the organisation of the data (i.e. which dimension is the observation dimension and whether explicit measures should be used). Data is organised into either a collection of series (grouped observations) or a collection of un-grouped observations. The derived data set type will restrict this choice to be either grouped or un-grouped observations. If this dimension is "AllDimensions" then the derived data set type must consist of a collection of un-grouped observations; otherwise the data set will contain a collection of series with the observations in the series disambiguated by the specified dimension at the observation level. This data set is capable of containing data (observed values) and/or documentation (attribute values) and can be used for incremental updates and deletions (i.e. only the relevant updates or deletes are exchanged). It is assumed that each series or un-grouped observation will be distinct in its purpose. For example, if series contains both data and documentation, it assumed that each series will have a unique key. If the series contains only data or only documentation, then it is possible that another series with the same key might exist, but with not with the same purpose (i.e. to provide data or documentation) as the first series. This base type is designed such that derived types can be processed in a generic manner; it assures that data structure definition specific data will have a consistent structure. The group, series, and observation elements are unqualified, meaning that they are not qualified with a namespace in an instance. This means that in the derived data set types, the elements will always be the same, regardless of the target namespace of the schemas which defines these derived types. This allows for consistent processing of the structure without regard to what the namespace might be for the data structure definition specific schema. The data set can contain values for attributes which do not have an attribute relationship with any data structure definition components. These attribute values will exist in XML attributes in this element based on this type (DataSet). This is specified in the content model with the declaration of anyAttributes in the "local" namespace. The derived data set type will refine this structure so that the attributes are explicit. The XML attributes will be given a name based on the attribute's identifier. These XML attributes will be unqualified (meaning they do not have a namespace associated with them). To allow for generic processing, it is required that the only unqualified XML attributes in the derived data set type (outside of the standard data set attributes) be for attributes declared in the data structure definition. If additional attributes are required, these should be qualified with a namespace so that a generic application can easily distinguish them as not being meant to represent a data structure definition attribute.
  Derivation:
--* //com:AnnotableType// (extension)
--** //DataSetType//
++//com:AnnotableType// (extension)
++   [[image:1750765436915-836.png]]//DataSetType//
++
  Attributes:
++
  structureRef, setID?, action?, reportingBeginDate?, reportingEndDate?, validFromDate?, validToDate?, publicationYear?, publicationPeriod?, dataScope, REPORTING_YEAR_START_DAY?
  Content:
++
  com:Annotations?, DataProvider?, Group*, (Series+ | Obs+)?
  Attribute Documentation:
++
  |**Name**|**Type**|**Documentation**
  |structureRef|xs:IDREF|The structureRef contains a reference to a structural specification in the header of a data or reference metadata message. The structural specification details which structure the data or reference metadata conforms to, as well as providing additional information such as how the data is structure (e.g. which dimension occurs at the observation level for a data set).
  |setID|com:IDType|The setID provides an identification of the data or metadata set.
@@ -344,16 +344,20 @@
  **//GroupType//: **GroupType is the abstract type which defines a structure which is used to communicate attribute values for a group defined in a data structure definition. The group can consist of either a subset of the dimensions defined by the data structure definition, or an association to an attachment constraint, which in turn defines key sets to which attributes can be attached. In the case that the group is based on an attachment constraint, only the identification of group is provided. It is expected that a system which is processing this will relate that identifier to the key sets defined in the constraint and apply the values provided for the attributes appropriately. Data structure definition schemas will drive types based on this for each group defined in the data structure definition. Both the dimension values which make up the key (if applicable) and the attribute values associated with the group will be represented with XML attributes. This is specified in the content model with the declaration of anyAttributes in the "local" namespace. The derived group type will refine this structure so that the attributes are explicit. The XML attributes will be given a name based on the attribute's identifier. These XML attributes will be unqualified (meaning they do not have a namespace associated with them). The dimension XML attributes will be required while the attribute XML attributes will be optional. To allow for generic processing, it is required that the only unqualified XML attributes in the derived group type be for the group dimensions and attributes declared in the data structure definition. If additional attributes are required, these should be qualified with a namespace so that a generic application can easily distinguish them as not being meant to represent a data structure definition dimension or attribute.
  Derivation:
--* //com:AnnotableType// (extension)
--** //GroupType//
++//com:AnnotableType// (extension)
++   [[image:1750765436916-983.png]]//GroupType//
++
  Attributes:
++
  type?, REPORTING_YEAR_START_DAY?
  Content:
++
  com:Annotations?
  Attribute Documentation:
++
  |**Name**|**Type**|**Documentation**
  |type|com:IDType|The type attribute reference the identifier of the group as defined in the data structure definition. This is optional, but derived group types will provide a fixed value for this so that it always available in the post validation information set. This allows the group to be processed in a generic manner.
  |REPORTING_YEAR_START_DAY|xs:gMonthDay|The REPORTING_YEAR_START_DAY attribute is an explict attribute for the reporting year start day, which provides context to the time dimension when its value contains a reporting period (e.g. 2010-Q1). This attribute is used to state the month and day that the reporting year begins (e.g. ~-~-07-01 for July 1st). In the absence of an explicit value provided in this attribute, all reporting period values will be assumed to be based on a reporting year start day of January 1. This is declared in the base schema since it has a fixed identifier and representation. The derived group types may either require or prohibit this attribute, depending on whether the data structure declared the reporting year start day attribute and if so, the attribute relationship and assignment status assigned to it.
@@ -366,16 +366,20 @@
  **//SeriesType//: **SeriesType is the abstract type which defines a structure which is used to group a collection of observations which have a key in common. The key for a series is every dimension defined in the data structure definition, save the dimension declared to be at the observation level for this data set. In addition to observations, values can be provided for attributes which are associated with the dimensions which make up this series key (so long as the attributes do not specify a group attachment or also have an relationship with the observation dimension). It is possible for the series to contain only observations or only attribute values, or both. Data structure definition schemas will drive a type based on this that is specific to the data structure definition and the variation of the format being expressed in the schema. Both the dimension values which make up the key and the attribute values associated with the key dimensions will be represented with XML attributes. This is specified in the content model with the declaration of anyAttributes in the "local" namespace. The derived series type will refine this structure so that the attributes are explicit. The XML attributes will be given a name based on the attribute's identifier. These XML attributes will be unqualified (meaning they do not have a namespace associated with them). The dimension XML attributes will be required while the attribute XML attributes will be optional. To allow for generic processing, it is required that the only unqualified XML attributes in the derived group type be for the series dimensions and attributes declared in the data structure definition. If additional attributes are required, these should be qualified with a namespace so that a generic application can easily distinguish them as not being meant to represent a data structure definition dimension or attribute.
  Derivation:
--* //com:AnnotableType// (extension)
--** //SeriesType//
++//com:AnnotableType// (extension)
++   //SeriesType//
++
  Attributes:
++
  TIME_PERIOD?, REPORTING_YEAR_START_DAY?
  Content:
++
  com:Annotations?, Obs*
  Attribute Documentation:
++
  |**Name**|**Type**|**Documentation**
  |TIME_PERIOD|com: ObservationalTimePer iodType|The TIME_PERIOD attribute is an explict attribute for the time dimension. This is declared in the base schema since it has a fixed identifier and representation. The derived series type will either require or prohibit this attribute, depending on whether time is the observation dimension. If the time dimension specifies a more specific representation of time the derived type will restrict the type definition to the appropriate type.
  |REPORTING_YEAR_START_DAY|xs:gMonthDay|The REPORTING_YEAR_START_DAY attribute is an explict attribute for the reporting year start day, which provides context to the time dimension when its value contains a reporting period (e.g. 2010-Q1). This attribute is used to state the month and day that the reporting year begins (e.g. ~-~-07-01 for July 1st). In the absence of an explicit value provided in this attribute, all reporting period values will be assumed to be based on a reporting year start day of January 1. This is declared in the base schema since it has a fixed identifier and representation. The derived series type may either require or prohibit this attribute, depending on whether the data structure declared the reporting year start day attribute and if so, the attribute relationship and assignment status assigned to it.
@@ -389,16 +389,20 @@
  **//ObsType//: **ObsType is the abstract type which defines the structure of a grouped or un-grouped observation. The observation must be provided a key, which is either a value for the dimension which is declared to be at the observation level if the observation is grouped, or a full set of values for all dimensions in the data structure definition if the observation is un-grouped. This key should disambiguate the observation within the context in which it is defined (e.g. there should not be another observation with the same dimension value in a series). The observation can contain an observed value and/or attribute values. Data structure definition schemas will drive a type or types based on this that is specific to the data structure definition and the variation of the format being expressed in the schema. The dimension value(s) which make up the key and the attribute values associated with the key dimension(s) or the primary measure will be represented with XML attributes. This is specified in the content model with the declaration of anyAttributes in the "local" namespace. The derived observation type will refine this structure so that the attributes are explicit. The XML attributes will be given a name based on the attribute's identifier. These XML attributes will be unqualified (meaning they do not have a namespace associated with them). The dimension XML attribute(s) will be required while the attribute XML attributes will be optional. To allow for generic processing, it is required that the only unqualified XML attributes in the derived observation type be for the observation dimension(s) and attributes declared in the data structure definition. If additional attributes are required, these should be qualified with a namespace so that a generic application can easily distinguish them as not being meant to represent a data structure definition dimension or attribute. If the data structure definition specific schema requires that explicit measures be used (only possible when the measure dimension is specified at the observation), then there will be types derived for each measure defined by the measure dimension. In this case, the types will be specific to each measure, which is to say that the representation of the primary measure (i.e. the observed value) will be restricted to that which is specified by the specific measure.
  Derivation:
--* //com:AnnotableType// (extension)
--** //ObsType//
++//com:AnnotableType// (extension)
++   //ObsType//
++
  Attributes:
++
  type?, TIME_PERIOD?, REPORTING_YEAR_START_DAY?, OBS_VALUE?
  Content:
++
  com:Annotations?
  Attribute Documentation:
++
  |**Name**|**Type**|**Documentation**
  |type|com:IDType|The type attribute is used when the derived format requires that explicit measure be used. In this case, the derived type based on the measure will fix this value to be the identification of the measure concept. This will not be required, but since it is fixed it will be available in the post validation information set which will allow for generic processing of the data. If explicit measures are not used, then the derived type will prohibit the use of this attribute.
  |TIME_PERIOD|com: ObservationalTimePer iodType|The TIME_PERIOD attribute is an explicit attribute for the time dimension. This is declared in the base schema since it has a fixed identifier and representation. The derived series type will either require or prohibit this attribute, depending on whether time is the observation dimension. If the time dimension specifies a more specific representation of time the derived type will restrict the type definition to the appropriate type.
@@ -413,17 +413,21 @@
  **//TimeSeriesDataSetType//: **TimeSeriesDataSetType is the abstract type which defines the base structure for any data structure definition specific time series based data set. A derived data set type will be created that is specific to a data structure definition. Unlike the base format, only one variation of this is allowed for a data structure definition. This variation is the time dimension as the observation dimension. Data is organised into a collection of time series. Because this derivation is achieved using restriction, data sets conforming to this type will inherently conform to the base data set structure as well. In fact, data structure specific here will be identical to data in the base data set when the time dimension is the observation dimension, even for the derived data set types. This means that the data contained in this structure can be processed in exactly the same manner as the base structure. The same rules for derivation as the base data set type apply to this specialized data set.
  Derivation:
--* //com:AnnotableType// (extension)
--** //DataSetType// (restriction)
--*** //TimeSeriesDataSetType//
++//com:AnnotableType// (extension)
++   //DataSetType// (restriction)
++         //TimeSeriesDataSetType//
++
  Attributes:
++
  structureRef, setID?, action?, reportingBeginDate?, reportingEndDate?, validFromDate?, validToDate?, publicationYear?, publicationPeriod?, dataScope, REPORTING_YEAR_START_DAY?
  Content:
++
  com:Annotations?, DataProvider?, Group*, Series*
  Attribute Documentation:
++
  |**Name**|**Type**|**Documentation**
  |structureRef|xs:IDREF|The structureRef contains a reference to a structural specification in the header of a data or reference metadata message. The structural specification details which structure the data or reference metadata conforms to, as well as providing additional information such as how the data is structure (e.g. which dimension occurs at the observation level for a data set).
  |setID|com:IDType|The setID provides an identification of the data or metadata set.
@@ -448,17 +448,21 @@
  **TimeSeriesType: **TimeSeriesType defines an abstract structure which is used to group a collection of observations which have a key in common, organised by time. The key for a series is every dimension defined in the data structure definition, save the time dimension. In addition to observations, values can be provided for attributes which are associated with the dimensions which make up this series key (so long as the attributes do not specify a group attachment or also have an relationship with the time dimension). It is possible for the series to contain only observations or only attribute values, or both. The same rules for derivation as the base series type apply to this specialized series.
  Derivation:
--* //com:AnnotableType// (extension)
--** //SeriesType// (restriction)
--*** TimeSeriesType
++//com:AnnotableType// (extension)
++   //SeriesType// (restriction)
++         TimeSeriesType
++
  Attributes:
++
  REPORTING_YEAR_START_DAY?
  Content:
++
  com:Annotations?, Obs*
  Attribute Documentation:
++
  |**Name**|**Type**|**Documentation**
  |REPORTING_YEAR_START_DAY|xs:gMonthDay|The REPORTING_YEAR_START_DAY attribute is an explict attribute for the reporting year start day, which provides context to the time dimension when its value contains a reporting period (e.g. 2010-Q1). This attribute is used to state the month and day that the reporting year begins (e.g. ~-~-07-01 for July 1st). In the absence of an explicit value provided in this attribute, all reporting period values will be assumed to be based on a reporting year start day of January 1. This is declared in the base schema since it has a fixed identifier and representation. The derived series type may either require or prohibit this attribute, depending on whether the data structure declared the reporting year start day attribute and if so, the attribute relationship and assignment status assigned to it.