Changes for page SDMX 2.1 Standards. Section 6. Technical Notes

Last modified by Artur on 2025/08/19 10:43

From 5.1 to 5.2 From 5.7 to 6.1

From version 5.2

edited by Helena
on 2025/05/21 21:41

Change comment: There is no comment for this version

To version 5.7

edited by Helena
on 2025/05/21 21:55

Change comment: There is no comment for this version

Raw
Rendered

Summary

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

Details

Page properties

Content

@@ -371,50 +371,47 @@
  The hierarchy of time formats is as follows (**bold** indicates a category which is made up of multiple formats, //italic// indicates a distinct format):
--* **Observational Time Period **o **Standard Time Period**
++* **Observational Time Period**
++** **Standard Time Period**
++*** **Basic Time Period**
++**** **Gregorian Time Period**
++**** //Date Time//
++*** **Reporting Time Period**
++** //Time Range//
--                                                        §    **Basic Time Period**
--
--* **Gregorian Time Period**
--* //Date Time//
--
--§   **Reporting Time Period **o //Time Range//
--
  The details of these time period categories and of the distinct formats which make them up are detailed in the sections to follow.
--==== 4.2.2 Observational Time Period ====
++=== 4.2.2 Observational Time Period ===
  This is the superset of all time representations in SDMX. This allows for time to be expressed as any of the allowable formats.
--==== 4.2.3 Standard Time Period ====
++=== 4.2.3 Standard Time Period ===
  This is the superset of any predefined time period or a distinct point in time. A time period consists of a distinct start and end point. If the start and end of a period are expressed as date instead of a complete date time, then it is implied that the start of the period is the beginning of the start day (i.e. 00:00:00) and the end of the period is the end of the end day (i.e. 23:59:59).
--==== 4.2.4 Gregorian Time Period ====
++=== 4.2.4 Gregorian Time Period ===
  A Gregorian time period is always represented by a Gregorian year, year-month, or day. These are all based on ISO 8601 dates. The representation in SDMX-ML messages and the period covered by each of the Gregorian time periods are as follows:
--**Gregorian Year:**
--
++**Gregorian Year:**
  Representation: xs:gYear (YYYY)
++Period: the start of January 1 to the end of December 31
--Period: the start of January 1 to the end of December 31 **Gregorian Year Month**:
--
++**Gregorian Year Month**:
  Representation: xs:gYearMonth (YYYY-MM)
++Period: the start of the first day of the month to end of the last day of the month
--Period: the start of the first day of the month to end of the last day of the month **Gregorian Day**:
--
++**Gregorian Day**:
  Representation: xs:date (YYYY-MM-DD)
--
  Period: the start of the day (00:00:00) to the end of the day (23:59:59)
--==== 4.2.5 Date Time ====
++=== 4.2.5 Date Time ===
  This is used to unambiguously state that a date-time represents an observation at a single point in time. Therefore, if one wants to use SDMX for data which is measured at a distinct point in time rather than being reported over a period, the date-time representation can be used.
  Representation: xs:dateTime (YYYY-MM-DDThh:mm:ss)[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^~[1~]^^>>path:#_ftn1]]
--==== 4.2.6 Standard Reporting Period ====
++=== 4.2.6 Standard Reporting Period ===
  Standard reporting periods are periods of time in relation to a reporting year. Each of these standard reporting periods has a duration (based on the ISO 8601 definition) associated with it. The general format of a reporting period is as follows:
@@ -421,75 +421,52 @@
  [REPORTING_YEAR]-[PERIOD_INDICATOR][PERIOD_VALUE]
  Where:
--
  REPORTING_YEAR represents the reporting year as four digits (YYYY) PERIOD_INDICATOR identifies the type of period which determines the duration of the period
--
  PERIOD_VALUE indicates the actual period within the year
  The following section details each of the standard reporting periods defined in SDMX:
--**Reporting Year**:
--
--                           Period Indicator: A
--
++**Reporting Year**:
++Period Indicator: A
  Period Duration: P1Y (one year)
--
  Limit per year: 1
++Representation: common:ReportingYearType (YYYY-A1, e.g. 2000-A1)
--Representation: common:ReportingYearType (YYYY-A1, e.g. 2000-A1) **Reporting Semester:**
--
--                           Period Indicator: S
--
++**Reporting Semester:**
++Period Indicator: S
  Period Duration: P6M (six months)
--
  Limit per year: 2
++Representation: common:ReportingSemesterType (YYYY-Ss, e.g. 2000-S2)
--Representation: common:ReportingSemesterType (YYYY-Ss, e.g. 2000-S2) **Reporting Trimester:**
--
--                           Period Indicator: T
--
++**Reporting Trimester:**
++Period Indicator: T
  Period Duration: P4M (four months)
--
  Limit per year: 3
++Representation: common:ReportingTrimesterType (YYYY-Tt, e.g. 2000-T3)
--Representation: common:ReportingTrimesterType (YYYY-Tt, e.g. 2000-T3) **Reporting Quarter:**
--
--                           Period Indicator: Q
--
++**Reporting Quarter:**
++Period Indicator: Q
  Period Duration: P3M (three months)
--
  Limit per year: 4
++Representation: common:ReportingQuarterType (YYYY-Qq, e.g. 2000-Q4)
--Representation: common:ReportingQuarterType (YYYY-Qq, e.g. 2000-Q4) **Reporting Month**:
--
++**Reporting Month**:
  Period Indicator: M
--
  Period Duration: P1M (one month)
--
  Limit per year: 1
--
  Representation: common:ReportingMonthType (YYYY-Mmm, e.g. 2000-M12) Notes: The reporting month is always represented as two digits, therefore 1-9 are 0 padded (e.g. 01). This allows the values to be sorted chronologically using textual sorting methods.
  **Reporting Week**:
--
  Period Indicator: W
--
  Period Duration: P7D (seven days)
--
  Limit per year: 53
--
  Representation: common:ReportingWeekType (YYYY-Www, e.g. 2000-W53)
--
  Notes: There are either 52 or 53 weeks in a reporting year. This is based on the ISO 8601 definition of a week (Monday - Saturday), where the first week of a reporting year is defined as the week with the first Thursday on or after the reporting year start day.[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^~[2~]^^>>path:#_ftn2]](%%) The reporting week is always represented as two digits, therefore 1-9 are 0 padded (e.g. 01). This allows the values to be sorted chronologically using textual sorting methods.
  **Reporting Day**:
--
  Period Indicator: D
--
  Period Duration: P1D (one day)
--
  Limit per year: 366
--
  Representation: common:ReportingDayType (YYYY-Dddd, e.g. 2000-D366) Notes: There are either 365 or 366 days in a reporting year, depending on whether the reporting year includes leap day (February 29). The reporting day is always represented as three digits, therefore 1-99 are 0 padded (e.g. 001).
  This allows the values to be sorted chronologically using textual sorting methods.
@@ -500,143 +500,109 @@
  Since the duration and the reporting year start day are known for any reporting period, it is possible to relate any reporting period to a distinct calendar period. The actual Gregorian calendar period covered by the reporting period can be computed as follows (based on the standard format of [REPROTING_YEAR][PERIOD_INDICATOR][PERIOD_VALUE] and the reporting year start day as [REPORTING_YEAR_START_DAY]):
--1. **Determine [REPORTING_YEAR_BASE]:**
--
++**~1. Determine [REPORTING_YEAR_BASE]:**
  Combine [REPORTING_YEAR] of the reporting period value (YYYY) with [REPORTING_YEAR_START_DAY] (MM-DD) to get a date (YYYY-MM-DD).
--
  This is the [REPORTING_YEAR_START_DATE]
--
--**a) If the [PERIOD_INDICATOR] is W:**
--
--1.
--11.
--111.
--1111. **If [REPORTING_YEAR_START_DATE] is a Friday, Saturday, or Sunday:**
--
++**a) If the [PERIOD_INDICATOR] is W:
++~1. If [REPORTING_YEAR_START_DATE] is a Friday, Saturday, or Sunday:**
  Add^^3^^ (P3D, P2D, or P1D respectively) to the [REPORTING_YEAR_START_DATE]. The result is the [REPORTING_YEAR_BASE].
--1.
--11.
--111.
--1111. **If [REPORTING_YEAR_START_DATE] is a Monday, Tuesday, Wednesday, or Thursday:**
--
++2. **If [REPORTING_YEAR_START_DATE] is a Monday, Tuesday, Wednesday, or Thursday:**
  Add^^3^^ (P0D, -P1D, -P2D, or -P3D respectively) to the [REPORTING_YEAR_START_DATE]. The result is the [REPORTING_YEAR_BASE].
++b) **Else:**
++The [REPORTING_YEAR_START_DATE] is the [REPORTING_YEAR_BASE]
--b) **Else:**
++**2. Determine [PERIOD_DURATION]:**
--The [REPORTING_YEAR_START_DATE] is the [REPORTING_YEAR_BASE].
++a) If the [PERIOD_INDICATOR] is A, the [PERIOD_DURATION] is P1Y.
++b) If the [PERIOD_INDICATOR] is S, the [PERIOD_DURATION] is P6M.
++c) If the [PERIOD_INDICATOR] is T, the [PERIOD_DURATION] is P4M.
++d) If the [PERIOD_INDICATOR] is Q, the [PERIOD_DURATION] is P3M.
++e) If the [PERIOD_INDICATOR] is M, the [PERIOD_DURATION] is P1M.
++f) If the [PERIOD_INDICATOR] is W, the [PERIOD_DURATION] is P7D.
++g) If the [PERIOD_INDICATOR] is D, the [PERIOD_DURATION] is P1D.
--1. **Determine [PERIOD_DURATION]:**
--11.
--111. If the [PERIOD_INDICATOR] is A, the [PERIOD_DURATION] is P1Y.
--111. If the [PERIOD_INDICATOR] is S, the [PERIOD_DURATION] is P6M.
--111. If the [PERIOD_INDICATOR] is T, the [PERIOD_DURATION] is P4M.
--111. If the [PERIOD_INDICATOR] is Q, the [PERIOD_DURATION] is P3M.
--111. If the [PERIOD_INDICATOR] is M, the [PERIOD_DURATION] is P1M.
--111. If the [PERIOD_INDICATOR] is W, the [PERIOD_DURATION] is P7D.
--111. If the [PERIOD_INDICATOR] is D, the [PERIOD_DURATION] is P1D.
--1. **Determine [PERIOD_START]:**
--
++**3. Determine [PERIOD_START]:**
  Subtract one from the [PERIOD_VALUE] and multiply this by the [PERIOD_DURATION]. Add[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^~[3~]^^>>path:#_ftn3]](%%) this to the [REPORTING_YEAR_BASE]. The result is the [PERIOD_START].
--1. **Determine the [PERIOD_END]:**
--
++**4. Determine the [PERIOD_END]:**
  Multiply the [PERIOD_VALUE] by the [PERIOD_DURATION]. Add^^3^^ this to the [REPORTING_YEAR_BASE] add^^3^^ -P1D. The result is the [PERIOD_END].
  For all of these ranges, the bounds include the beginning of the [PERIOD_START] (i.e. 00:00:00) and the end of the [PERIOD_END] (i.e. 23:59:59).
--**Examples: **
++**Examples:**
  **2010-Q2, REPORTING_YEAR_START_DAY = ~-~-07-01 (July 1)**
--
  ~1. [REPORTING_YEAR_START_DATE] = 2010-07-01
--
  b) [REPORTING_YEAR_BASE] = 2010-07-01
--
--1. [PERIOD_DURATION] = P3M
--1. (2-1) * P3M = P3M
--
++[PERIOD_DURATION] = P3M
++(2-1) * P3M = P3M
 -07-01 + P3M = 2010-10-01
--
  [PERIOD_START] = 2010-10-01
--
 . 2 * P3M = P6M
--
 -07-01 + P6M = 2010-13-01 = 2011-01-01
--
 -01-01 + -P1D = 2010-12-31
--
  [PERIOD_END] = 2011-12-31
  The actual calendar range covered by 2010-Q2 (assuming the reporting year begins July 1) is 2010-10-01T00:00:00/2010-12-31T23:59:59
  **2011-W36, REPORTING_YEAR_START_DAY = ~-~-07-01 (July 1)**
--
  ~1. [REPORTING_YEAR_START_DATE] = 2010-07-01
--
  a) 2011-07-01 = Friday
--
 -07-01 + P3D = 2011-07-04
--
  [REPORTING_YEAR_BASE] = 2011-07-04
--
--1. [PERIOD_DURATION] = P7D
--1. (36-1) * P7D = P245D
--
++2. [PERIOD_DURATION] = P7D
++3. (36-1) * P7D = P245D
 -07-04 + P245D = 2012-03-05
--
  [PERIOD_START] = 2012-03-05
--
 . 36 * P7D = P252D
--
 -07-04 + P252D =2012-03-12
--
 -03-12 + -P1D = 2012-03-11
--
  [PERIOD_END] = 2012-03-11
  The actual calendar range covered by 2011-W36 (assuming the reporting year begins July 1) is 2012-03-05T00:00:00/2012-03-11T23:59:59
--==== 4.2.7 Distinct Range ====
++=== 4.2.7 Distinct Range ===
  In the case that the reporting period does not fit into one of the prescribe periods above, a distinct time range can be used. The value of these ranges is based on the ISO 8601 time interval format of start/duration. Start can be expressed as either an ISO 8601 date or a date-time, and duration is expressed as an ISO 8601 duration. However, the duration can only be postive.
--==== 4.2.8 Time Format ====
++=== 4.2.8 Time Format ===
  In version 2.0 of SDMX there is a recommendation to use the time format attribute to gives additional information on the way time is represented in the message. Following an appraisal of its usefulness this is no longer required. However, it is still possible, if required , to include the time format attribute in SDMX-ML.
--|**Code**|**Format**
--|**OTP**|Observational Time Period: Superset of all SDMX time formats (Gregorian Time Period, Reporting Time Period, and Time Range)
--|**STP**|Standard Time Period: Superset of Gregorian and Reporting Time Periods
--|**GTP**|Superset of all Gregorian Time Periods and date-time
--|**RTP**|Superset of all Reporting Time Periods
--|**TR**|Time Range: Start time and duration (YYYY-MMDD(Thh:mm:ss)?/<duration>)
--|**GY**|Gregorian Year (YYYY)
--|**GTM**|Gregorian Year Month (YYYY-MM)
--|**GD**|Gregorian Day (YYYY-MM-DD)
--|**DT**|Distinct Point: date-time (YYYY-MM-DDThh:mm:ss)
--|**RY**|Reporting Year (YYYY-A1)
--|**RS**|Reporting Semester (YYYY-Ss)
--|**RT**|Reporting Trimester (YYYY-Tt)
--|**RQ**|Reporting Quarter (YYYY-Qq)
--|**RM**|Reporting Month (YYYY-Mmm)
--|**Code**|**Format**
--|**RW**|Reporting Week (YYYY-Www)
--|**RD**|Reporting Day (YYYY-Dddd)
++(% style="width:1049.29px" %)
++|**Code**|(% style="width:926px" %)**Format**
++|**OTP**|(% style="width:926px" %)Observational Time Period: Superset of all SDMX time formats (Gregorian Time Period, Reporting Time Period, and Time Range)
++|**STP**|(% style="width:926px" %)Standard Time Period: Superset of Gregorian and Reporting Time Periods
++|**GTP**|(% style="width:926px" %)Superset of all Gregorian Time Periods and date-time
++|**RTP**|(% style="width:926px" %)Superset of all Reporting Time Periods
++|**TR**|(% style="width:926px" %)Time Range: Start time and duration (YYYY-MMDD(Thh:mm:ss)?/<duration>)
++|**GY**|(% style="width:926px" %)Gregorian Year (YYYY)
++|**GTM**|(% style="width:926px" %)Gregorian Year Month (YYYY-MM)
++|**GD**|(% style="width:926px" %)Gregorian Day (YYYY-MM-DD)
++|**DT**|(% style="width:926px" %)Distinct Point: date-time (YYYY-MM-DDThh:mm:ss)
++|**RY**|(% style="width:926px" %)Reporting Year (YYYY-A1)
++|**RS**|(% style="width:926px" %)Reporting Semester (YYYY-Ss)
++|**RT**|(% style="width:926px" %)Reporting Trimester (YYYY-Tt)
++|**RQ**|(% style="width:926px" %)Reporting Quarter (YYYY-Qq)
++|**RM**|(% style="width:926px" %)Reporting Month (YYYY-Mmm)
++|**Code**|(% style="width:926px" %)**Format**
++|**RW**|(% style="width:926px" %)Reporting Week (YYYY-Www)
++|**RD**|(% style="width:926px" %)Reporting Day (YYYY-Dddd)
--  **Table 1: SDMX-ML Time Format Codes**
++**Table 1: SDMX-ML Time Format Codes**
--==== 4.2.9 Transformation between SDMX-ML and SDMX-EDI ====
++=== 4.2.9 Transformation between SDMX-ML and SDMX-EDI ===
  When converting SDMX-ML data structure definitions to SDMX-EDI data structure definitions, only the identifier of the time format attribute will be retained. The representation of the attribute will be converted from the SDMX-ML format to the fixed SDMX-EDI code list. If the SDMX-ML data structure definition does not define a time format attribute, then one will be automatically created with the identifier "TIME_FORMAT".
--When converting SDMX-ML data to SDMX-EDI, the source time format attribute will be irrelevant. Since the SDMX-ML time representation types are not ambiguous, the target time format can be determined from the source time value directly. For example, if the SDMX-ML time is 2000-Q2 the SDMX-EDI format will always be 608/708 (depending on whether the target series contains one observation or a range of observations)
++When converting SDMX-ML data to SDMX-EDI, the source time format attribute will be irrelevant. Since the SDMX-ML time representation types are not ambiguous, the target time format can be determined from the source time value directly. For example, if the SDMX-ML time is 2000-Q2 the SDMX-EDI format will always be 608/708 (depending on whether the target series contains one observation or a range of observations).
  When converting a data structure definition originating in SDMX-EDI, the time format attribute should be ignored, as it serves no purpose in SDMX-ML.
  When converting data from SDMX-EDI to SDMX-ML, the source time format is only necessary to determine the format of the target time value. For example, a source time format of will result in a target time in the format YYYY-Ss whereas a source format of will result in a target time value in the format YYYY-Qq.
--==== 4.2.10    Time Zones ====
++=== 4.2.10 Time Zones ===
  In alignment with ISO 8601, SDMX allows the specification of a time zone on all time periods and on the reporting year start day. If a time zone is provided on a reporting year start day, then the same time zone (or none) should be reported for each reporting time period. If the reporting year start day and the reporting period time zone differ, the time zone of the reporting period will take precedence. Examples of each format with time zones are as follows (time zone indicated in bold):
@@ -657,7 +657,7 @@
  According to ISO 8601, a date without a time-zone is considered "local time". SDMX assumes that local time is that of the sender of the message. In this version of SDMX, an optional field is added to the sender definition in the header for specifying a time zone. This field has a default value of 'Z' (UTC). This determination of local time applies for all dates in a message.
--==== 4.2.11    Representing Time Spans Elsewhere ====
++=== 4.2.11 Representing Time Spans Elsewhere ===
  It has been possible since SDMX 2.0 for a Component to specify a representation of a time span. Depending on the format of the data message, this resulted in either an element with 2 XML attributes for holding the start time and the duration or two separate XML attributes based on the underlying Component identifier. For example if REF_PERIOD were given a representation of time span, then in the Compact data format, it would be represented by two XML attributes; REF_PERIODStartTime (holding the start) and REF_PERIOD (holding the duration). If a new simple type is introduced in the SDMX schemas that can hold ISO 8601 time intervals, then this will no longer be necessary. What was represented as this:
@@ -667,30 +667,29 @@
  <Series REF_PERIOD="2000-01-01T00:00:00/P2M"/>
--==== 4.2.12    Notes on Formats ====
++=== 4.2.12 Notes on Formats ===
  There is no ambiguity in these formats so that for any given value of time, the category of the period (and thus the intended time period range) is always clear. It should also be noted that by utilizing the ISO 8601 format, and a format loosely based on it for the report periods, the values of time can easily be sorted chronologically without additional parsing.
--==== 4.2.13    Effect on Time Ranges ====
++=== 4.2.13 Effect on Time Ranges ===
  All SDMX-ML data messages are capable of functioning in a manner similar to SDMX-EDI if the Dimension at the observation level is time: the time period for the first observation can be stated and the rest of the observations can omit the time value as it can be derived from the start time and the frequency. Since the frequency can be determined based on the actual format of the time value for everything but distinct points in time and time ranges, this makes is even simpler to process as the interval between time ranges is known directly from the time value.
--==== 4.2.14 Time in Query Messages ====
++=== 4.2.14 Time in Query Messages ===
  When querying for time values, the value of a time parameter can be provided as any of the Observational Time Period formats and must be paired with an operator. In addition, an explicit value for the reporting year start day can be provided, or this can be set to "Any". This section will detail how systems processing query messages should interpret these parameters.
  Fundamental to processing a time value parameter in a query message is understanding that all time periods should be handled as a distinct range of time. Since the time parameter in the query is paired with an operator, this is also effectively represents a distinct range of time. Therefore, a system processing the query must simply match the data where the time period for requested parameter is encompassed by the time period resulting from value of the query parameter. The following table details how the operators should be interpreted for any time period provided as a parameter.
--|**Operator**|**Rule**
--|Greater Than|Any data after the last moment of the period
--|Less Than|Any data before the first moment of the period
--|Greater Than or Equal To|(((
--Any data on or after the first moment of
--
--the period
++(% style="width:1024.29px" %)
++|(% style="width:238px" %)**Operator**|(% style="width:782px" %)**Rule**
++|(% style="width:238px" %)Greater Than|(% style="width:782px" %)Any data after the last moment of the period
++|(% style="width:238px" %)Less Than|(% style="width:782px" %)Any data before the first moment of the period
++|(% style="width:238px" %)Greater Than or Equal To|(% style="width:782px" %)(((
++Any data on or after the first moment of the period
  )))
--|Less Than or Equal To|Any data on or before the last moment of the period
--|Equal To|Any data which falls on or after the first moment of the period and before or on the last moment of the period
++|(% style="width:238px" %)Less Than or Equal To|(% style="width:782px" %)Any data on or before the last moment of the period
++|(% style="width:238px" %)Equal To|(% style="width:782px" %)Any data which falls on or after the first moment of the period and before or on the last moment of the period
  Reporting Time Periods as query parameters are handled based on whether the value of the reportingYearStartDay XML attribute is an explicit month and day or "Any":