Interoperability Basis Platform

= 1. Introduction =

The first change in the data and metadata message is one of terminology. In order to foster consistency in the standard, the names and namespaces of the data and metadata message have been changed. The namespaces now have a uniform format of /data/format and /metadata/format, where format is either generic or structured (i.e. the structure specific formats). This also applies to the message names as well, where the names follow the pattern of FormatData (e.g. StructuredData and GenericMetadata).

8

9

The various data messages which existed in the standard have been harmonised into two general formats; generic and structured data. The generic data is much like it has been previously, only slightly modified to conform with the harmonised view on data. The structured data combined the principles of the previous (% style="color:#e74c3c" %)versions(%%) compact and cross sectional formats into one more generalised format.

10

11

The major shift from the previous (% style="color:#e74c3c" %)version(%%) is now that all data can be exchanged as either an un-grouped collection oData structure and metadata structure-specific schemas are each based on one single core construct found in their respective structure-specific namespaces;f observations, each specifying a full key or it can be exchanged as data grouped into series with any single [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] placed at the observation (% style="color:#e74c3c" %)level(%%). This in effect, combined the abilities of the time series and cross sectional formats in the a single data format. This format also allows for multiple [[measure>>doc:sdmx:Glossary.Measure.WebHome]] to be expressed when the observation [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] is the [[measure>>doc:sdmx:Glossary.Measure.WebHome]] [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] defined in the data structured. The key differences from the previous (% style="color:#e74c3c" %)versions(%%) is that this all is possible in a single [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] specific format, as well as being possible in the generic format as well. The goal was to make the structures as homogenous as possible.

12

13

Another shift from the previous (% style="color:#e74c3c" %)version(%%) in the manner in which the base data structure specific format is defined. In previous (% style="color:#e74c3c" %)versions(%%) there was not structure defined, so one had to understand all of the requirements and read the specification in order to understand what could be expected in any structure specific format. In this (% style="color:#e74c3c" %)version(%%), that issue has been addressed. The base structures now impose a strict format on the data structure specific schemas. This is achieved much like the referencing structure in the common namespace through the use of unqualified elements. By the elements not existing in a namespace, the structure specific schemas can place the necessary restrictions of them while still being forced to adhere to prescribed structure. This means that not only are the structures able to perform the validation that is required, but that the messages will be much simpler to process as the format will always use the same element names.

14

15

Finally, in order to allow for systems which wish to not process the new more flexible data format, time series only variations of both the generic and structured [[data sets>>doc:sdmx:Glossary.Data set.WebHome]] exist. It is important to note that these structures are derived via restriction from the more generalised format. This means that a [[data set>>doc:sdmx:Glossary.Data set.WebHome]] in the general format with the time [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] at the observation (% style="color:#e74c3c" %)level(%%) will have exactly the same content as a time series only [[data set>>doc:sdmx:Glossary.Data set.WebHome]]. The result of this is that there is no additional burden for processing the time series specific format it a system can process the more generalised format. These time series only [[data sets>>doc:sdmx:Glossary.Data set.WebHome]] allow for time series only data messages to exist. These messages make it simple for system which, in the previous (% style="color:#e74c3c" %)version(%%) of the standard, only used the time series formats to continue to do so.

16

17

These same principles have been applied to the reference data messages as well. In the previous (% style="color:#e74c3c" %)version(%%) of the standard there were major differences between the generic and metadata structure-specific formats; some of the differences caused some [[metadata sets>>doc:sdmx:Glossary.Metadata set.WebHome]] were incompatible between (% style="color:#e74c3c" %)versions(%%). In this (% style="color:#e74c3c" %)version(%%) the structures of the generic and metadata structure specific formats have been harmonised to the point where they are nearly identical. Yet, the structured format still provides the strong validation against the metadata structure that is intended. And, as with the data, the base metadata structure specific format now imposes a stricter structure on the generated schemas, making the structure specific instance simpler to process in a generic manner.

18

19

= 2. Schema Documentation =

20

21

== 2.1 Generic Data Namespace ==

22

23

**http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/data/generic**

24

25

=== 2.1.1 Summary ===

26

27

Referenced Namespaces:

28

29

(% style="width:610.294px" %)

30

|(% style="width:487px" %)**Namespace**|(% style="width:120px" %)**Prefix**

31

|(% style="width:487px" %)http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/common|(% style="width:120px" %)com

32

|(% style="width:487px" %)http:~/~/www.w3.org/2001/XMLSchema|(% style="width:120px" %)xs

Contents:

13 Complex Types

=== 2.1.2 Complex Types ===

38

39

**DataSetType: **DataSetType defines the structure of the generic [[data set>>doc:sdmx:Glossary.Data set.WebHome]]. Data is organised into either a collection of series (grouped observations) or a collection of un-grouped observations. The organisation used is dependent on the structure specification in the header of the data message (which is referenced via the structureRef [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]). The structure specification states which data occurs at the observation (% style="color:#e74c3c" %)level(%%). If this [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] is "AllDimensions" then the [[data set>>doc:sdmx:Glossary.Data set.WebHome]] must consist of a collection of un-grouped observations; otherwise the [[data set>>doc:sdmx:Glossary.Data set.WebHome]] will contain a collection of series with the observations in the series disambiguated by the specified [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] at the observation (% style="color:#e74c3c" %)level(%%). This [[data set>>doc:sdmx:Glossary.Data set.WebHome]] is capable of containing data (observed values) and/or documentation ([[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] values). 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.

Derivation:

* //com:AnnotableType// (extension)

44

** DataSetType

45

46

[[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]:

47

structureRef, setID?, action?, reportingBeginDate?, reportingEndDate?, validFromDate?, validToDate?, publicationYear?, publicationPeriod?

48

49

Content:

50

com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, DataProvider?, [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]?, Group*, (Series+ | Obs+)?

51

52

[[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation:

53

54

(% style="width:1011.29px" %)

55

|**Name**|**Type**|(% style="width:597px" %)**Documentation**

56

|structureRef|xs:IDREF|(% style="width:597px" %)The structureRef contains a reference to a structural specification in the header of a data or [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] message. The structural specification details which structure the data or [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] conforms to, as well as providing additional information such as how the data is structure (e.g. which [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] occurs at the observation (% style="color:#e74c3c" %)level(%%) for a [[data set>>doc:sdmx:Glossary.Data set.WebHome]]).

57

|setID|com:IDType|(% style="width:597px" %)The setID provides an identification of the data or [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]].

58

|action|com:ActionType|(% style="width:597px" %)The action [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates whether the file is appending, replacing, or deleting.

59

|reportingBeginDate|com: BasicTimePeriodType|(% style="width:597px" %)The reportingBeginDate indicates the inclusive start time of the data reported in the data or [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]].

60

|reportingEndDate|com: BasicTimePeriodType|(% style="width:597px" %)The reportingEndDate indicates the inclusive end time of the data reported in the data or [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]].

61

|validFromDate|xs:dateTime|(% style="width:597px" %)The validFromDate indicates the inclusive start time indicating the validity of the information in the data or [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]].

62

|validToDate|xs:dateTime|(% style="width:597px" %)The validToDate indicates the inclusive end time indicating the validity of the information in the data or [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]].

63

|publicationYear|xs:gYear|(% style="width:597px" %)The publicationYear holds the ISO 8601 four-digit year.

64

|publicationPeriod|com: ObservationalTimePeriodType|(% style="width:597px" %)The publicationPeriod specifies the period of publication of the data or metadata in terms of whatever provisioning agreements might be in force (i.e., "Q1 2005" if that is the time of publication for a [[data set>>doc:sdmx:Glossary.Data set.WebHome]] published on a quarterly basis).

65

66

Element Documentation:

67

68

(% style="width:1016.29px" %)

69

|**Name**|**Type**|(% style="width:642px" %)**Documentation**

70

|com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com:AnnotationsType|(% style="width:642px" %)[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]] is a reusable element the provides for a collection of [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It has been made global so that restrictions of types that extend AnnotatableType my reference it.

71

|DataProvider|com: DataProviderReferenceType|(% style="width:642px" %)DataProvider contains a reference to the provider for the [[data set>>doc:sdmx:Glossary.Data set.WebHome]].

72

|[[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]|ValuesType|(% style="width:642px" %)[[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]] contains the collection of [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] values for [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] defined in the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] which do not have an [[attribute relationship>>doc:sdmx:Glossary.Attribute relationship.WebHome]] with any other [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] [[components>>doc:sdmx:Glossary.Component.WebHome]].

73

|Group|GroupType|(% style="width:642px" %)Group contains a references to a defined group in the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] along with its key (if necessary) and values for the [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] which are associated with the group. An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is associated to a group by either an explicit group relationship or by a group attachment when the [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] has a relationship with a [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] which is a member of this group.

74

|Series|SeriesType|(% style="width:642px" %)Series contains a collection of observations that share a common key (set of [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] values). The key of a series is every [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] defined in the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]], save the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] which is declared in the structure specification to be at the observation (% style="color:#e74c3c" %)level(%%). In addition to the key and observations, the series contains values for [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] which have a relationship with any [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] that is part of the [[series key>>doc:sdmx:Glossary.Series key.WebHome]], so long as the [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] does not specify an attachment group or also has a relationship with the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] declared to be at the observation (% style="color:#e74c3c" %)level(%%).

75

|Obs|ObsOnlyType|(% style="width:642px" %)Obs is an un-grouped observation. This observation has a key which is a set of values for all [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] declared in the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]. In addition to the key, the value of the observation can be provided along with values for all [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] which have an association with the primary [[measure>>doc:sdmx:Glossary.Measure.WebHome]] or any [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] (so long as it does not specify a group attachment).

76

77

**GroupType: **GroupType defines a structure which is used to communicate [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] values for a group defined in a [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]. The group can consist of either a subset of the [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] defined by the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]], or an association to an attachment (% style="color:#e74c3c" %)constraint(%%), which in turn defines key sets to which [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] can be attached. In the case that the group is based on an attachment (% style="color:#e74c3c" %)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 (% style="color:#e74c3c" %)constraint(%%) and apply the values provided for the [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] appropriately.

Derivation:

* //com:AnnotableType// (extension)

82

** GroupType

83

84

[[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]:

type

Content:

com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, GroupKey?, [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]

89

90

[[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation:

91

92

(% style="width:1010.29px" %)

93

|**Name**|**Type**|(% style="width:709px" %)**Documentation**

94

|type|com:IDType|(% style="width:709px" %)The type [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds the identifier assigned to the group in the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] for which [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] values are being provided.

95

96

Element Documentation:

97

98

(% style="width:1014.29px" %)

99

|**Name**|**Type**|(% style="width:704px" %)**Documentation**

100

|com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com:AnnotationsType|(% style="width:704px" %)[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]] is a reusable element the provides for a collection of [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It has been made global so that restrictions of types that extend AnnotatableType my reference it.

101

|GroupKey|ValuesType|(% style="width:704px" %)GroupKey contains the values for each [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] defined as being a member of the referenced group in the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]. A value must be provided for every group [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]. This is optional, and not used if the group is defined as an association to an attachment (% style="color:#e74c3c" %)constraint(%%) rather than a subset of the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]].

102

|[[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]|ValuesType|(% style="width:704px" %)[[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]] contains the set of [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] values which are reported for group. The [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] values provided here apply to all data matching the partial key defined by the [[group key>>doc:sdmx:Glossary.Group key.WebHome]] or the key sets of the associated attachment (% style="color:#e74c3c" %)constraint(%%).

103

104

**SeriesType: **SeriesType 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>>doc:sdmx:Glossary.Dimension.WebHome]] defined in the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]], save the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] declared to be at the observation (% style="color:#e74c3c" %)level(%%) for this [[data set>>doc:sdmx:Glossary.Data set.WebHome]]. In addition to observations, values can be provided for [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] which are associated with the [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] which make up this [[series key>>doc:sdmx:Glossary.Series key.WebHome]] (so long as the [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] do not specify a group attachment or also have an relationship with the observation [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]). It is possible for the series to contain only observations or only [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] values, or both.

Derivation:

* //com:AnnotableType// (extension)

** SeriesType

Content:

com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, SeriesKey, [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]?, Obs*

113

114

Element Documentation:

115

116

(% style="width:999.294px" %)

117

|**Name**|**Type**|(% style="width:689px" %)**Documentation**

118

|com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com:AnnotationsType|(% style="width:689px" %)[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]] is a reusable element the provides for a collection of [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It has been made global so that restrictions of types that extend AnnotatableType my reference it.

119

|SeriesKey|ValuesType|(% style="width:689px" %)SeriesKey contains the values for each all [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] defined in the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]], except for that which is declared to be at the observation (% style="color:#e74c3c" %)level(%%) for this [[data set>>doc:sdmx:Glossary.Data set.WebHome]]. This key is required, and every [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] must be provided a value.

120

|[[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]|ValuesType|(% style="width:689px" %)[[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]] contains the values for [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] which are associated with the [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] which make up the [[series key>>doc:sdmx:Glossary.Series key.WebHome]], so long as the [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] do not also specify an attachment group or have a relationship with the observation [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]].

121

|Obs|ObsType|(% style="width:689px" %)Obs contains an observation which shares the dimensionality of the [[series key>>doc:sdmx:Glossary.Series key.WebHome]]. These observations are disambiguated from one another within this series by a single [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] value provided for each [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]. The [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] which provides this observation key is declared in the structure specification for the [[data set>>doc:sdmx:Glossary.Data set.WebHome]], which is provided in the header of the data message.

122

123

**ObsOnlyType: **ObsOnlyType defines the structure for an un-grouped observation. Unlike a group observation, an un-grouped must provided a full set of values for every [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] declared in the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]. The observation can contain an observed value and/or a collection of [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] values.

Derivation:

* //com:AnnotableType// (extension)

** ObsOnlyType

Content:

com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, ObsKey, ObsValue?, [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]?

132

133

Element Documentation:

134

135

(% style="width:996.294px" %)

136

|**Name**|**Type**|(% style="width:651px" %)**Documentation**

137

|com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com:AnnotationsType|(% style="width:651px" %)[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]] is a reusable element the provides for a collection of [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It has been made global so that restrictions of types that extend AnnotatableType my reference it.

138

|ObsKey|ValuesType|(% style="width:651px" %)ObsKey contains the values for every [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] defined in the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]. A value must be provided for each [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]. This key serves to disambiguate the un-grouped observation within the [[data set>>doc:sdmx:Glossary.Data set.WebHome]].

139

|ObsValue|ObsValueType|(% style="width:651px" %)ObsValue type contains the value for the observation.

140

|[[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]|ValuesType|(% style="width:651px" %)[[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]] contains the set of values reported for the [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] which have an association with the primary [[measure>>doc:sdmx:Glossary.Measure.WebHome]] or any [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] in the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] (so long as an attachment group is not also specified).

141

142

**ObsType: **ObsType defines the structure of a grouped observation. The observation must be provided a value for the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] which is declared to be at the observation (% style="color:#e74c3c" %)level(%%) for this [[data set>>doc:sdmx:Glossary.Data set.WebHome]]. This [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] value should disambiguate the observation within the series in which it is defined (i.e. there should not be another observation with the same [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] value). The observation can contain an observed value and/or [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] values.

Derivation:

* //com:AnnotableType// (extension)

** ObsType

Content:

com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, ObsDimension, ObsValue?, [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]?

151

152

Element Documentation:

153

154

(% style="width:1004.29px" %)

155

|**Name**|**Type**|(% style="width:694px" %)**Documentation**

156

|com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com:AnnotationsType|(% style="width:694px" %)[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]] is a reusable element the provides for a collection of [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It has been made global so that restrictions of types that extend AnnotatableType my reference it.

157

|ObsDimension|BaseValueType|(% style="width:694px" %)ObsDimension holds the key for the grouped observation, i.e. the value of the observation [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]. Note that in this element, the reference to the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] is optional, since it can be inferred from the structure specification for the [[data set>>doc:sdmx:Glossary.Data set.WebHome]]. This saves having to repeat the value unnecessarily. It is assumed that any application processing the [[data set>>doc:sdmx:Glossary.Data set.WebHome]] will have the information from the structure specification available, so that if a [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] identifier is not supplied here, the proper reference can be applied.

158

|ObsValue|ObsValueType|(% style="width:694px" %)ObsValue type contains the value for the observation.

159

|[[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]|ValuesType|(% style="width:694px" %)[[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]] contains the set of values reported for the [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] which have an association with the primary [[measure>>doc:sdmx:Glossary.Measure.WebHome]] or the observations [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] (so long as an attachment group is not also specified).

160

161

**ValuesType: **ValuesType is a general structure which contains a collection of [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] [[component>>doc:sdmx:Glossary.Component.WebHome]] values. This type is used to provide both key and [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] collection values.

Content:

Value+

Element Documentation:

167

168

(% style="width:1008.29px" %)

169

|**Name**|(% style="width:185px" %)**Type**|(% style="width:692px" %)**Documentation**

170

|Value|(% style="width:185px" %)ComponentValueType|(% style="width:692px" %)Value contains a [[component>>doc:sdmx:Glossary.Component.WebHome]] value and a reference to the [[component>>doc:sdmx:Glossary.Component.WebHome]] for which a value is being provided.

171

172

**BaseValueType: **BaseValueType is a general structure which contains a reference to a [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] [[component>>doc:sdmx:Glossary.Component.WebHome]] and a value for that [[component>>doc:sdmx:Glossary.Component.WebHome]]. In this structure the reference to the [[component>>doc:sdmx:Glossary.Component.WebHome]] is optional to allow for usages where the actual reference might be provided in another context.

173

174

[[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]:

id?, value

Content:

{Empty}

[[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation:

181

182

(% style="width:1003.29px" %)

183

|**Name**|(% style="width:194px" %)**Type**|(% style="width:664px" %)**Documentation**

184

|id|(% style="width:194px" %)com:NCNameIDType|(% style="width:664px" %)The id [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] contains the identifier for the [[component>>doc:sdmx:Glossary.Component.WebHome]] for which a value is being provided.

185

|value|(% style="width:194px" %)xs:anySimpleType|(% style="width:664px" %)The value [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] contains the provided [[component>>doc:sdmx:Glossary.Component.WebHome]] value.

186

187

**ObsValueType: **ObsValueType is a derivation of the BaseValueType which is used to provide an [[observation value>>doc:sdmx:Glossary.Observation value.WebHome]]. Since an [[observation value>>doc:sdmx:Glossary.Observation value.WebHome]] is always associated with the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] primary [[measure>>doc:sdmx:Glossary.Measure.WebHome]], and the identifier for the primary [[measure>>doc:sdmx:Glossary.Measure.WebHome]] is fixed, the [[component>>doc:sdmx:Glossary.Component.WebHome]] 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)

192

** ObsValueType

193

194

[[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]:

id?, value

Content:

{Empty}

[[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation:

201

202

(% style="width:1004.29px" %)

203

|(% style="width:190px" %)**Name**|(% style="width:213px" %)**Type**|(% style="width:598px" %)**Documentation**

204

|(% style="width:190px" %)id (fixed: OBS_VALUE)|(% style="width:213px" %)com:NCNameIDType|(% style="width:598px" %)The id [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] contains a fixed reference to the primary [[measure>>doc:sdmx:Glossary.Measure.WebHome]] [[component>>doc:sdmx:Glossary.Component.WebHome]] of the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]].

205

|(% style="width:190px" %)value|(% style="width:213px" %)xs:string|(% style="width:598px" %)The value [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] contains the provided [[component>>doc:sdmx:Glossary.Component.WebHome]] value.

206

207

**ComponentValueType: **ComponentValueType is a derivation of the BaseValueType which requires that the [[component>>doc:sdmx:Glossary.Component.WebHome]] reference be provided. This is used when the identification of the [[component>>doc:sdmx:Glossary.Component.WebHome]] cannot be inferred from another context.

Derivation:

* BaseValueType (restriction)

212

** ComponentValueType

213

214

[[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]:

id, value

Content:

{Empty}

[[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation:

221

222

(% style="width:1008.29px" %)

223

|**Name**|(% style="width:184px" %)**Type**|(% style="width:679px" %)**Documentation**

224

|id|(% style="width:184px" %)com:NCNameIDType|(% style="width:679px" %)The id [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] contains the identifier for the [[component>>doc:sdmx:Glossary.Component.WebHome]] for which a value is being provided.

225

|value|(% style="width:184px" %)xs:string|(% style="width:679px" %)The value [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] contains the provided [[component>>doc:sdmx:Glossary.Component.WebHome]] value.

226

227

**TimeSeriesDataSetType: **TimeSeriesDataSetType is a derivation of the base DataSetType of the generic format the restricts the [[data set>>doc:sdmx:Glossary.Data set.WebHome]] to only allow for grouped observations where the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] at the observation (% style="color:#e74c3c" %)level(%%) is the time [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] of the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]. This means that unlike the base [[data set>>doc:sdmx:Glossary.Data set.WebHome]] structure, there can be no un-grouped observations. Because this derivation is achieved using restriction, [[data sets>>doc:sdmx:Glossary.Data set.WebHome]] conforming to this type will inherently conform to the base [[data set>>doc:sdmx:Glossary.Data set.WebHome]] structure as well. In fact, data structured here will be identical to data in the base [[data set>>doc:sdmx:Glossary.Data set.WebHome]] when the time [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] is the observation [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]. 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)

232

** DataSetType (restriction)

233

*** TimeSeriesDataSetType

234

235

[[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]:

236

structureRef, setID?, action?, reportingBeginDate?, reportingEndDate?, validFromDate?, validToDate?, publicationYear?, publicationPeriod?

237

238

Content:

239

com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, DataProvider?, [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]?, Group*, Series*

240

241

[[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation:

242

243

(% style="width:1004.29px" %)

244

|**Name**|**Type**|(% style="width:590px" %)**Documentation**

245

|structureRef|xs:IDREF|(% style="width:590px" %)The structureRef contains a reference to a structural specification in the header of a data or [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] message. The structural specification details which structure the data or [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] conforms to, as well as providing additional information such as how the data is structure (e.g. which [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] occurs at the observation (% style="color:#e74c3c" %)level(%%) for a [[data set>>doc:sdmx:Glossary.Data set.WebHome]]).

246

|setID|com:IDType|(% style="width:590px" %)The setID provides an identification of the data or [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]].

247

|action|com:ActionType|(% style="width:590px" %)The action [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates whether the file is appending, replacing, or deleting.

248

|reportingBeginDate|com: BasicTimePeriodType|(% style="width:590px" %)The reportingBeginDate indicates the inclusive start time of the data reported in the data or [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]].

249

|reportingEndDate|com: BasicTimePeriodType|(% style="width:590px" %)The reportingEndDate indicates the inclusive end time of the data reported in the data or [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]].

250

|validFromDate|xs:dateTime|(% style="width:590px" %)The validFromDate indicates the inclusive start time indicating the validity of the information in the data or [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]].

251

|validToDate|xs:dateTime|(% style="width:590px" %)The validToDate indicates the inclusive end time indicating the validity of the information in the data or [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]].

252

|publicationYear|xs:gYear|(% style="width:590px" %)The publicationYear holds the ISO 8601 four-digit year.

253

|publicationPeriod|com: ObservationalTimePeriodType|(% style="width:590px" %)The publicationPeriod specifies the period of publication of the data or metadata in terms of whatever provisioning agreements might be in force (i.e., "Q1 2005" if that is the time of publication for a [[data set>>doc:sdmx:Glossary.Data set.WebHome]] published on a quarterly basis).

254

255

Element Documentation:

256

257

(% style="width:999.294px" %)

258

|**Name**|**Type**|(% style="width:622px" %)**Documentation**

259

|com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com:AnnotationsType|(% style="width:622px" %)[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]] is a reusable element the provides for a collection of [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It has been made global so that restrictions of types that extend AnnotatableType my reference it.

260

|DataProvider|com: DataProviderReferenceType|(% style="width:622px" %)DataProvider contains a reference to the provider for the [[data set>>doc:sdmx:Glossary.Data set.WebHome]].

261

|[[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]|ValuesType|(% style="width:622px" %)[[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]] contains the collection of [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] values for [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] defined in the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] which do not have an [[attribute relationship>>doc:sdmx:Glossary.Attribute relationship.WebHome]] with any other [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] [[components>>doc:sdmx:Glossary.Component.WebHome]].

262

|Group|GroupType|(% style="width:622px" %)Group contains a references to a defined group in the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] along with its key (if necessary) and values for the [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] which are associated with the group. An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is associated to a group by either an explicit group relationship or by a group attachment when the [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] has a relationship with a [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] which is a member of this group.

263

|Series|TimeSeriesType|(% style="width:622px" %)Series contains a collection of observations that share a common key (set of [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] values). The key of a series is every [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] defined in the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]], save the time [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]. In addition to the key and observations, the series contains values for [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] which have a relationship with any [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] that is part of the [[series key>>doc:sdmx:Glossary.Series key.WebHome]], so long as the [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] does not specify an attachment group or also has a relationship with the time [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]].

264

265

**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>>doc:sdmx:Glossary.Dimension.WebHome]] defined in the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]], save the time [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]. In addition to observations, values can be provided for [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] which are associated with the [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] which make up this [[series key>>doc:sdmx:Glossary.Series key.WebHome]] (so long as the [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] do not specify a group attachment or also have an relationship with the time [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]). It is possible for the series to contain only observations or only [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] values, or both.

Derivation:

* //com:AnnotableType// (extension)

270

** SeriesType (restriction)

*** TimeSeriesType

Content:

com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, SeriesKey, [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]?, Obs*

275

276

Element Documentation:

277

278

(% style="width:1012.29px" %)

279

|**Name**|**Type**|(% style="width:695px" %)**Documentation**

280

|com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com:AnnotationsType|(% style="width:695px" %)[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]] is a reusable element the provides for a collection of [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It has been made global so that restrictions of types that extend AnnotatableType my reference it.

281

|SeriesKey|ValuesType|(% style="width:695px" %)SeriesKey contains the values for each all [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] defined in the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]], except for that which is declared to be at the observation (% style="color:#e74c3c" %)level(%%) for this [[data set>>doc:sdmx:Glossary.Data set.WebHome]]. This key is required, and every [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] must be provided a value.

282

|[[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]|ValuesType|(% style="width:695px" %)[[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]] contains the values for [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] which are associated with the [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] which make up the [[series key>>doc:sdmx:Glossary.Series key.WebHome]], so long as the [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] do not also specify an attachment group or have a relationship with the observation [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]].

283

|Obs|TimeSeriesObsType|(% style="width:695px" %)Obs contains an observation which shares the dimensionality of the [[series key>>doc:sdmx:Glossary.Series key.WebHome]]. These observations are disambiguated from one another within this series by a time value.

284

285

**TimeSeriesObsType: **TimeSeriesObsType defines the structure of a time series observation. The observation must be provided a value for the time [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]. 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>>doc:sdmx:Glossary.Attribute.WebHome]] values.

Derivation:

* //com:AnnotableType// (extension)

290

** ObsType (restriction)

291

*** TimeSeriesObsType

292

293

Content:

294

com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, ObsDimension, ObsValue?, [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]?

295

296

Element Documentation:

297

298

(% style="width:1019.29px" %)

299

|**Name**|**Type**|(% style="width:709px" %)**Documentation**

300

|com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com:AnnotationsType|(% style="width:709px" %)[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]] is a reusable element the provides for a collection of [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It has been made global so that restrictions of types that extend AnnotatableType my reference it.

301

|ObsDimension|TimeValueType|(% style="width:709px" %)ObsDimension holds the key for the grouped observation, i.e. the value of the observation [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]. Note that in this element, the reference to the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] is optional, since it can be inferred from the structure specification for the [[data set>>doc:sdmx:Glossary.Data set.WebHome]]. This saves having to repeat the value unnecessarily. It is assumed that any application processing the [[data set>>doc:sdmx:Glossary.Data set.WebHome]] will have the information from the structure specification available, so that if a [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] identifier is not supplied here, the proper reference can be applied.

302

|ObsValue|ObsValueType|(% style="width:709px" %)ObsValue type contains the value for the observation.

303

|[[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]|ValuesType|(% style="width:709px" %)[[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]] contains the set of values reported for the [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] which have an association with the primary [[measure>>doc:sdmx:Glossary.Measure.WebHome]] or the time [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] (so long as an attachment group is not also specified).

304

305

**TimeValueType: **TimeValueType is a derivation of the BaseValueType which is used to provide a value for the time [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]. Since the identifier for the time [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] is fixed, the [[component>>doc:sdmx:Glossary.Component.WebHome]] 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)

310

** TimeValueType

311

312

[[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]:

id?, value

Content:

{Empty}

[[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation:

319

320

(% style="width:1013.29px" %)

321

|(% style="width:205px" %)**Name**|(% style="width:277px" %)**Type**|(% style="width:528px" %)**Documentation**

322

|(% style="width:205px" %)id (fixed: TIME_PERIOD)|(% style="width:277px" %)com:NCNameIDType|(% style="width:528px" %)The id [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] contains the identifier for the [[component>>doc:sdmx:Glossary.Component.WebHome]] for which a value is being provided.

323

|(% style="width:205px" %)value|(% style="width:277px" %)com: ObservationalTimePer iodType|(% style="width:528px" %)The value [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] contains the provided [[component>>doc:sdmx:Glossary.Component.WebHome]] value.

324

325

== 2.2 Structure Specific Data Namespace ==

326

327

**http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/data/structurespecific**

328

329

=== 2.2.1 Summary ===

330

331

Referenced Namespaces:

332

333

(% style="width:1027.29px" %)

334

|(% style="width:475px" %)**Namespace**|(% style="width:549px" %)**Prefix**

335

|(% style="width:475px" %)http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/common|(% style="width:549px" %)com

336

|(% style="width:475px" %)http:~/~/www.w3.org/2001/XMLSchema|(% style="width:549px" %)xs

Contents:

7 Complex Types

1 Simple Type

=== 2.2.2 Complex Types ===

343

344

**//DataSetType//: **DataSetType is the abstract type which defines the base structure for any [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] specific [[data set>>doc:sdmx:Glossary.Data set.WebHome]]. A derived [[data set>>doc:sdmx:Glossary.Data set.WebHome]] type will be created that is specific to a [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] and the details of the organisation of the data (i.e. which [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] is the observation [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] and whether explicit [[measures>>doc:sdmx:Glossary.Measure.WebHome]] 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>>doc:sdmx:Glossary.Data set.WebHome]] type will restrict this choice to be either grouped or un-grouped observations. If this [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] is "AllDimensions" then the derived [[data set>>doc:sdmx:Glossary.Data set.WebHome]] type must consist of a collection of un-grouped observations; otherwise the [[data set>>doc:sdmx:Glossary.Data set.WebHome]] will contain a collection of series with the observations in the series disambiguated by the specified [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] at the observation (% style="color:#e74c3c" %)level(%%). This [[data set>>doc:sdmx:Glossary.Data set.WebHome]] is capable of containing data (observed values) and/or documentation ([[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] values) and can be used for [[incremental updates>>doc:sdmx:Glossary.Incremental update.WebHome]] 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>>doc:sdmx:Glossary.Data structure definition.WebHome]] 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>>doc:sdmx:Glossary.Data set.WebHome]] 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>>doc:sdmx:Glossary.Data structure definition.WebHome]] specific schema. The [[data set>>doc:sdmx:Glossary.Data set.WebHome]] can contain values for [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] which do not have an [[attribute relationship>>doc:sdmx:Glossary.Attribute relationship.WebHome]] with any [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] [[components>>doc:sdmx:Glossary.Component.WebHome]]. These [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] values will exist in XML [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] in this element based on this type ([[DataSet>>doc:sdmx:Glossary.Data set.WebHome]]). This is specified in the content model with the declaration of anyAttributes in the "local" namespace. The derived [[data set>>doc:sdmx:Glossary.Data set.WebHome]] type will refine this structure so that the [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] are explicit. The XML [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] will be given a name based on the [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]'s identifier. These XML [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] 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>>doc:sdmx:Glossary.Attribute.WebHome]] in the derived [[data set>>doc:sdmx:Glossary.Data set.WebHome]] type (outside of the standard [[data set>>doc:sdmx:Glossary.Data set.WebHome]] [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]) be for [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] declared in the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]. If additional [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] 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>>doc:sdmx:Glossary.Data structure definition.WebHome]] [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]].

Derivation:

* //com:AnnotableType// (extension)

349

** //DataSetType//

350

351

[[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]:

352

structureRef, setID?, action?, reportingBeginDate?, reportingEndDate?, validFromDate?, validToDate?, publicationYear?, publicationPeriod?, dataScope, REPORTING_YEAR_START_DAY?

353

354

Content:

355

com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, DataProvider?, Group*, (Series+ | Obs+)?

356

357

[[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation:

358

359

(% style="width:1005.29px" %)

360

|(% style="width:199px" %)**Name**|(% style="width:216px" %)**Type**|(% style="width:521px" %)**Documentation**

361

|(% style="width:199px" %)structureRef|(% style="width:216px" %)xs:IDREF|(% style="width:521px" %)The structureRef contains a reference to a structural specification in the header of a data or [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] message. The structural specification details which structure the data or [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] conforms to, as well as providing additional information such as how the data is structure (e.g. which [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] occurs at the observation (% style="color:#e74c3c" %)level(%%) for a [[data set>>doc:sdmx:Glossary.Data set.WebHome]]).

362

|(% style="width:199px" %)setID|(% style="width:216px" %)com:IDType|(% style="width:521px" %)The setID provides an identification of the data or [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]].

363

|(% style="width:199px" %)action|(% style="width:216px" %)com:ActionType|(% style="width:521px" %)The action [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates whether the file is appending, replacing, or deleting.

364

|(% style="width:199px" %)reportingBeginDate|(% style="width:216px" %)com: BasicTimePeriodType|(% style="width:521px" %)The reportingBeginDate indicates the inclusive start time of the data reported in the data or [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]].

365

|(% style="width:199px" %)reportingEndDate|(% style="width:216px" %)com: BasicTimePeriodType|(% style="width:521px" %)The reportingEndDate indicates the inclusive end time of the data reported in the data or [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]].

366

|(% style="width:199px" %)validFromDate|(% style="width:216px" %)xs:dateTime|(% style="width:521px" %)The validFromDate indicates the inclusive start time indicating the validity of the information in the data or [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]].

367

|(% style="width:199px" %)validToDate|(% style="width:216px" %)xs:dateTime|(% style="width:521px" %)The validToDate indicates the inclusive end time indicating the validity of the information in the data or [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]].

368

|(% style="width:199px" %)publicationYear|(% style="width:216px" %)xs:gYear|(% style="width:521px" %)The publicationYear holds the ISO 8601 four-digit year.

369

|(% style="width:199px" %)publicationPeriod|(% style="width:216px" %)com: ObservationalTimePeriodType|(% style="width:521px" %)The publicationPeriod specifies the period of publication of the data or metadata in terms of whatever provisioning agreements might be in force (i.e., "Q1 2005" if that is the time of publication for a [[data set>>doc:sdmx:Glossary.Data set.WebHome]] published on a quarterly basis).

370

|(% style="width:199px" %)dataScope|(% style="width:216px" %)DataScopeType|(% style="width:521px" %)The dataScope [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates the scope at which the data is meant to be validated. These scopes are hierarchical and are (from the top down); DataStructure, ConstrainedDataStructure, [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]], and ProvisionAgreement. the [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]] of these scopes represent the cascading (% style="color:#e74c3c" %)level(%%) of (% style="color:#e74c3c" %)constraints(%%), which can restrict the valid values for [[components>>doc:sdmx:Glossary.Component.WebHome]]. For example, a data structure defines a [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] with a coded [[representation>>doc:sdmx:Glossary.Representation.WebHome]]. A [[data flow>>doc:sdmx:Glossary.Dataflow.WebHome]] might have a (% style="color:#e74c3c" %)constraint(%%) associated with it which further restricts the values allowed from the referenced [[code list>>doc:sdmx:Glossary.Code list.WebHome]] to a subset of the values allowed by the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]. A [[provision agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]] that is based on the [[dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] might also have a (% style="color:#e74c3c" %)constraint(%%), which further restricts the subset of the [[codelist>>doc:sdmx:Glossary.Code list.WebHome]] from the [[dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]]. Therefore, the allowed content becomes stricter lower in the [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]]. Data that is given a scope of one value is stated to be valid at that (% style="color:#e74c3c" %)level(%%) and all (% style="color:#e74c3c" %)levels(%%) below it. Therefore, this scope serves to state that data that is meant to be structured simply against the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] is not meant to be validated against the a [[dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]], where (% style="color:#e74c3c" %)constraints(%%) might be applied.

371

|(% style="width:199px" %)REPORTING_YEAR_START_DAY|(% style="width:216px" %)xs:gMonthDay|(% style="width:521px" %)The REPORTING_YEAR_START_DAY [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is an explict [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] for the reporting year start day, which provides context to the time [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] when its value contains a reporting period (e.g. 2010-Q1). This [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] 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>>doc:sdmx:Glossary.Attribute.WebHome]], 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>>doc:sdmx:Glossary.Representation.WebHome]]. The derived [[data set>>doc:sdmx:Glossary.Data set.WebHome]] type may either require or prohibit this [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], depending on whether the data structure declared the reporting year start day [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] and if so, the [[attribute relationship>>doc:sdmx:Glossary.Attribute relationship.WebHome]] and assignment status assigned to it.

372

373

Element Documentation:

374

375

(% style="width:1005.29px" %)

376

|**Name**|**Type**|(% style="width:630px" %)**Documentation**

377

|com:Annotations|com:AnnotationsType|(% style="width:630px" %)[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]] is a reusable element the provides for a collection of [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It has been made global so that restrictions of types that extend AnnotatableType my reference it.

378

|DataProvider|com: DataProviderReferenceType|(% style="width:630px" %)DataProvider contains a reference to the provider for the [[data set>>doc:sdmx:Glossary.Data set.WebHome]].

379

|Group|//GroupType//|(% style="width:630px" %)Group contains a references to a defined group in the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] along with its key (if necessary) and values for the [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] which are associated with the group. An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is associated to a group by either an explicit group relationship or by a group attachment when the [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] has a relationship with a [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] which is a member of this group.

380

|Series|//SeriesType//|(% style="width:630px" %)Series contains a collection of observations that share a common key (set of [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] values). The key of a series is every [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] defined in the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]], save the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] at the observation (% style="color:#e74c3c" %)level(%%). In addition to the key and observations, the series contains values for [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] which have a relationship with any [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] that is part of the [[series key>>doc:sdmx:Glossary.Series key.WebHome]], so long as the [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] does not specify an attachment group or also has a relationship with the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] declared to be at the observation (% style="color:#e74c3c" %)level(%%).

381

|Obs|//ObsType//|(% style="width:630px" %)Obs is an un-grouped observation. This observation has a key which is a set of values for all [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] declared in the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]. In addition to the key, the value of the observation can be provided along with values for all [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] which have an association with the primary [[measure>>doc:sdmx:Glossary.Measure.WebHome]] or any [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] (so long as it does not specify a group attachment).

382

383

**//GroupType//: **GroupType is the abstract type which defines a structure which is used to communicate [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] values for a group defined in a [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]. The group can consist of either a subset of the [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] defined by the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]], or an association to an attachment (% style="color:#e74c3c" %)constraint(%%), which in turn defines key sets to which [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] can be attached. In the case that the group is based on an attachment (% style="color:#e74c3c" %)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 (% style="color:#e74c3c" %)constraint(%%) and apply the values provided for the [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] appropriately. [[Data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] schemas will drive types based on this for each group defined in the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]. Both the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] values which make up the key (if applicable) and the [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] values associated with the group will be represented with XML [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]. 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>>doc:sdmx:Glossary.Attribute.WebHome]] are explicit. The XML [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] will be given a name based on the [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]'s identifier. These XML [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] will be unqualified (meaning they do not have a namespace associated with them). The [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] XML [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] will be required while the [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] XML [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] will be optional. To allow for generic processing, it is required that the only unqualified XML [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] in the derived group type be for the group [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] and [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] declared in the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]. If additional [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] 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>>doc:sdmx:Glossary.Data structure definition.WebHome]] [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] or [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]].

Derivation:

* //com:AnnotableType// (extension)

** //GroupType//

Attributes:

type?, REPORTING_YEAR_START_DAY?

392

393

Content:

394

com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?

395

396

Attribute Documentation:

397

398

(% style="width:1008.29px" %)

399

|**Name**|**Type**|(% style="width:621px" %)**Documentation**

400

|type|com:IDType|(% style="width:621px" %)The type [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] reference the identifier of the group as defined in the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]. 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.

401

|REPORTING_YEAR_START_DAY|xs:gMonthDay|(% style="width:621px" %)The REPORTING_YEAR_START_DAY [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is an explict [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] for the reporting year start day, which provides context to the time [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] when its value contains a reporting period (e.g. 2010-Q1). This [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] 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>>doc:sdmx:Glossary.Attribute.WebHome]], 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>>doc:sdmx:Glossary.Representation.WebHome]]. The derived group types may either require or prohibit this [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], depending on whether the data structure declared the reporting year start day [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] and if so, the [[attribute relationship>>doc:sdmx:Glossary.Attribute relationship.WebHome]] and assignment status assigned to it.

402

403

Element Documentation:

404

405

|**Name**|**Type**|**Documentation**

406

|com:Annotations|com:AnnotationsType|[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]] is a reusable element the provides for a collection of [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It has been made global so that restrictions of types that extend AnnotatableType my reference it.

407

408

**//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>>doc:sdmx:Glossary.Dimension.WebHome]] defined in the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]], save the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] declared to be at the observation (% style="color:#e74c3c" %)level(%%) for this [[data set>>doc:sdmx:Glossary.Data set.WebHome]]. In addition to observations, values can be provided for [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] which are associated with the [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] which make up this [[series key>>doc:sdmx:Glossary.Series key.WebHome]] (so long as the [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] do not specify a group attachment or also have an relationship with the observation [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]). It is possible for the series to contain only observations or only [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] values, or both. [[Data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] schemas will drive a type based on this that is specific to the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] and the variation of the format being expressed in the schema. Both the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] values which make up the key and the [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] values associated with the key [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] will be represented with XML [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]. 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>>doc:sdmx:Glossary.Attribute.WebHome]] are explicit. The XML [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] will be given a name based on the [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]'s identifier. These XML [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] will be unqualified (meaning they do not have a namespace associated with them). The [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] XML [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] will be required while the [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] XML [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] will be optional. To allow for generic processing, it is required that the only unqualified XML [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] in the derived group type be for the series [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] and [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] declared in the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]. If additional [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] 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>>doc:sdmx:Glossary.Data structure definition.WebHome]] [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] or [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]].

Derivation:

* //com:AnnotableType// (extension)

** //SeriesType//

Attributes:

TIME_PERIOD?, REPORTING_YEAR_START_DAY?

417

418

Content:

419

com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, Obs*

420

421

Attribute Documentation:

422

423

(% style="width:1002.29px" %)

424

|**Name**|**Type**|(% style="width:533px" %)**Documentation**

425

|TIME_PERIOD|com: ObservationalTimePer iodType|(% style="width:533px" %)The TIME_PERIOD [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is an explict [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] for the time [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]. This is declared in the base schema since it has a fixed identifier and [[representation>>doc:sdmx:Glossary.Representation.WebHome]]. The derived series type will either require or prohibit this [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], depending on whether time is the observation [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]. If the time [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] specifies a more specific [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of time the derived type will restrict the type definition to the appropriate type.

426

|REPORTING_YEAR_START_DAY|xs:gMonthDay|(% style="width:533px" %)The REPORTING_YEAR_START_DAY [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is an explict [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] for the reporting year start day, which provides context to the time [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] when its value contains a reporting period (e.g. 2010-Q1). This [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] 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>>doc:sdmx:Glossary.Attribute.WebHome]], 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>>doc:sdmx:Glossary.Representation.WebHome]]. The derived series type may either require or prohibit this [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], depending on whether the data structure declared the reporting year start day [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] and if so, the [[attribute relationship>>doc:sdmx:Glossary.Attribute relationship.WebHome]] and assignment status assigned to it.

427

428

Element Documentation:

429

430

|**Name**|**Type**|**Documentation**

431

|com:Annotations|com:AnnotationsType|[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]] is a reusable element the provides for a collection of [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It has been made global so that restrictions of types that extend AnnotatableType my reference it.

432

|Obs|//ObsType//|

433

434

**//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>>doc:sdmx:Glossary.Dimension.WebHome]] which is declared to be at the observation (% style="color:#e74c3c" %)level(%%) if the observation is grouped, or a full set of values for all [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] in the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] 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>>doc:sdmx:Glossary.Dimension.WebHome]] value in a series). The observation can contain an observed value and/or [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] values. [[Data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] schemas will drive a type or types based on this that is specific to the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] and the variation of the format being expressed in the schema. The [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] value(s) which make up the key and the [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] values associated with the key [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]](s) or the primary [[measure>>doc:sdmx:Glossary.Measure.WebHome]] will be represented with XML [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]. 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>>doc:sdmx:Glossary.Attribute.WebHome]] are explicit. The XML [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] will be given a name based on the [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]'s identifier. These XML [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] will be unqualified (meaning they do not have a namespace associated with them). The [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] XML [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]](s) will be required while the [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] XML [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] will be optional. To allow for generic processing, it is required that the only unqualified XML [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] in the derived observation type be for the observation [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]](s) and [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] declared in the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]. If additional [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] 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>>doc:sdmx:Glossary.Data structure definition.WebHome]] [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] or [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]. If the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] specific schema requires that explicit [[measures>>doc:sdmx:Glossary.Measure.WebHome]] be used (only possible when the [[measure>>doc:sdmx:Glossary.Measure.WebHome]] [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] is specified at the observation), then there will be types derived for each [[measure>>doc:sdmx:Glossary.Measure.WebHome]] defined by the [[measure>>doc:sdmx:Glossary.Measure.WebHome]] [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]. In this case, the types will be specific to each [[measure>>doc:sdmx:Glossary.Measure.WebHome]], which is to say that the [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of the primary [[measure>>doc:sdmx:Glossary.Measure.WebHome]] (i.e. the observed value) will be restricted to that which is specified by the specific [[measure>>doc:sdmx:Glossary.Measure.WebHome]].

Derivation:

* //com:AnnotableType// (extension)

** //ObsType//

Attributes:

type?, TIME_PERIOD?, REPORTING_YEAR_START_DAY?, OBS_VALUE?

443

444

Content:

445

com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?

446

447

Attribute Documentation:

448

449

(% style="width:1014.29px" %)

450

|**Name**|**Type**|(% style="width:505px" %)**Documentation**

451

|type|com:IDType|(% style="width:505px" %)The type [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is used when the derived format requires that explicit [[measure>>doc:sdmx:Glossary.Measure.WebHome]] be used. In this case, the derived type based on the [[measure>>doc:sdmx:Glossary.Measure.WebHome]] will fix this value to be the identification of the [[measure>>doc:sdmx:Glossary.Measure.WebHome]] (% style="color:#e74c3c" %)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>>doc:sdmx:Glossary.Measure.WebHome]] are not used, then the derived type will prohibit the use of this [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]].

452

|TIME_PERIOD|com: ObservationalTimePeriodType|(% style="width:505px" %)The TIME_PERIOD [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is an explicit [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] for the time [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]. This is declared in the base schema since it has a fixed identifier and [[representation>>doc:sdmx:Glossary.Representation.WebHome]]. The derived series type will either require or prohibit this [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], depending on whether time is the observation [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]. If the time [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] specifies a more specific [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of time the derived type will restrict the type definition to the appropriate type.

453

|REPORTING_YEAR_START_DAY|xs:gMonthDay|(% style="width:505px" %)The REPORTING_YEAR_START_DAY [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is an explict [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] for the reporting year start day, which provides context to the time [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] when its value contains a reporting period (e.g. 2010-Q1). This [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] 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>>doc:sdmx:Glossary.Attribute.WebHome]], 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>>doc:sdmx:Glossary.Representation.WebHome]]. The derived observation type may either require or prohibit this [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], depending on whether the data structure declared the reporting year start day [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] and if so, the [[attribute relationship>>doc:sdmx:Glossary.Attribute relationship.WebHome]] and assignment status assigned to it.

454

|OBS_VALUE|xs:anySimpleType|(% style="width:505px" %)The OBS_VALUE [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is an explicit [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] for the primary [[measure>>doc:sdmx:Glossary.Measure.WebHome]], which is intended to hold the value for the observation. This is declared in the base schema since it has a fixed identifier. This [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is un-typed, since the [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of the observed value can vary widely. Derived types will restrict this to be a type based on the [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of the primary [[measure>>doc:sdmx:Glossary.Measure.WebHome]]. In the case that an explicit [[measure>>doc:sdmx:Glossary.Measure.WebHome]] is used, the derived type for a given [[measure>>doc:sdmx:Glossary.Measure.WebHome]] might further restrict the type of the primary [[measure>>doc:sdmx:Glossary.Measure.WebHome]] to be more specific to the core [[representation>>doc:sdmx:Glossary.Representation.WebHome]] for the [[measure>>doc:sdmx:Glossary.Measure.WebHome]] (% style="color:#e74c3c" %)concept(%%). Note that it is required that in the case of multiple [[measures>>doc:sdmx:Glossary.Measure.WebHome]] being used, that the [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of the primary [[measure>>doc:sdmx:Glossary.Measure.WebHome]] is broad enough to handle the various [[representations>>doc:sdmx:Glossary.Representation.WebHome]] of the [[measure>>doc:sdmx:Glossary.Measure.WebHome]] (% style="color:#e74c3c" %)concepts(%%).

455

456

Element Documentation:

457

458

|**Name**|**Type**|**Documentation**

459

|com:Annotations|com:AnnotationsType|[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]] is a reusable element the provides for a collection of [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It has been made global so that restrictions of types that extend AnnotatableType my reference it.

460

461

**//TimeSeriesDataSetType//: **TimeSeriesDataSetType is the abstract type which defines the base structure for any [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] specific time series based [[data set>>doc:sdmx:Glossary.Data set.WebHome]]. A derived [[data set>>doc:sdmx:Glossary.Data set.WebHome]] type will be created that is specific to a [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]. Unlike the base format, only one variation of this is allowed for a [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]. This variation is the time [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] as the observation [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]. Data is organised into a collection of time series. Because this derivation is achieved using restriction, [[data sets>>doc:sdmx:Glossary.Data set.WebHome]] conforming to this type will inherently conform to the base [[data set>>doc:sdmx:Glossary.Data set.WebHome]] structure as well. In fact, data structure specific here will be identical to data in the base [[data set>>doc:sdmx:Glossary.Data set.WebHome]] when the time [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] is the observation [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]], even for the derived [[data set>>doc:sdmx:Glossary.Data set.WebHome]] 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>>doc:sdmx:Glossary.Data set.WebHome]] type apply to this specialized [[data set>>doc:sdmx:Glossary.Data set.WebHome]].

Derivation:

* //com:AnnotableType// (extension)

466

** //DataSetType// (restriction)

467

*** //TimeSeriesDataSetType//

468

469

Attributes:

470

structureRef, setID?, action?, reportingBeginDate?, reportingEndDate?, validFromDate?, validToDate?, publicationYear?, publicationPeriod?, dataScope, REPORTING_YEAR_START_DAY?

471

472

Content:

473

com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, DataProvider?, Group*, Series*

474

475

Attribute Documentation:

476

477

(% style="width:1003.29px" %)

478

|(% style="width:213px" %)**Name**|(% style="width:274px" %)**Type**|(% style="width:461px" %)**Documentation**

479

|(% style="width:213px" %)structureRef|(% style="width:274px" %)xs:IDREF|(% style="width:461px" %)The structureRef contains a reference to a structural specification in the header of a data or [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] message. The structural specification details which structure the data or [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] conforms to, as well as providing additional information such as how the data is structure (e.g. which [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] occurs at the observation (% style="color:#e74c3c" %)level(%%) for a [[data set>>doc:sdmx:Glossary.Data set.WebHome]]).

480

|(% style="width:213px" %)setID|(% style="width:274px" %)com:IDType|(% style="width:461px" %)The setID provides an identification of the data or [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]].

481

|(% style="width:213px" %)action|(% style="width:274px" %)com:ActionType|(% style="width:461px" %)The action [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates whether the file is appending, replacing, or deleting.

482

|(% style="width:213px" %)reportingBeginDate|(% style="width:274px" %)com: BasicTimePeriodType|(% style="width:461px" %)The reportingBeginDate indicates the inclusive start time of the data reported in the data or [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]].

483

|(% style="width:213px" %)reportingEndDate|(% style="width:274px" %)com: BasicTimePeriodType|(% style="width:461px" %)The reportingEndDate indicates the inclusive end time of the data reported in the data or [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]].

484

|(% style="width:213px" %)validFromDate|(% style="width:274px" %)xs:dateTime|(% style="width:461px" %)The validFromDate indicates the inclusive start time indicating the validity of the information in the data or [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]].

485

|(% style="width:213px" %)validToDate|(% style="width:274px" %)xs:dateTime|(% style="width:461px" %)The validToDate indicates the inclusive end time indicating the validity of the information in the data or [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]].

486

|(% style="width:213px" %)publicationYear|(% style="width:274px" %)xs:gYear|(% style="width:461px" %)The publicationYear holds the ISO 8601 four-digit year.

487

|(% style="width:213px" %)publicationPeriod|(% style="width:274px" %)com: ObservationalTimePeriodType|(% style="width:461px" %)The publicationPeriod specifies the period of publication of the data or metadata in terms of whatever provisioning agreements might be in force (i.e., "Q1 2005" if that is the time of publication for a [[data set>>doc:sdmx:Glossary.Data set.WebHome]] published on a quarterly basis).

488

|(% style="width:213px" %)dataScope|(% style="width:274px" %)DataScopeType|(% style="width:461px" %)The dataScope [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates the scope at which the data is meant to be validated. These scopes are hierarchical and are (from the top down); DataStructure, ConstrainedDataStructure, [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]], and ProvisionAgreement. the [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]] of these scopes represent the cascading (% style="color:#e74c3c" %)level(%%) of (% style="color:#e74c3c" %)constraints(%%), which can restrict the valid values for [[components>>doc:sdmx:Glossary.Component.WebHome]]. For example, a data structure defines a [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] with a coded [[representation>>doc:sdmx:Glossary.Representation.WebHome]]. A [[data flow>>doc:sdmx:Glossary.Dataflow.WebHome]] might have a (% style="color:#e74c3c" %)constraint(%%) associated with it which further restricts the values allowed from the referenced [[code list>>doc:sdmx:Glossary.Code list.WebHome]] to a subset of the values allowed by the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]. A [[provision agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]] that is based on the [[dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] might also have a (% style="color:#e74c3c" %)constraint(%%), which further restricts the subset of the [[codelist>>doc:sdmx:Glossary.Code list.WebHome]] from the [[dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]]. Therefore, the allowed content becomes stricter lower in the [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]]. Data that is given a scope of one value is stated to be valid at that (% style="color:#e74c3c" %)level(%%) and all (% style="color:#e74c3c" %)levels(%%) below it. Therefore, this scope serves to state that data that is meant to be structured simply against the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] is not meant to be validated against the a [[dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]], where (% style="color:#e74c3c" %)constraints(%%) might be applied.

489

|(% style="width:213px" %)REPORTING_YEAR_START_DAY|(% style="width:274px" %)xs:gMonthDay|(% style="width:461px" %)The REPORTING_YEAR_START_DAY [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is an explict [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] for the reporting year start day, which provides context to the time [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] when its value contains a reporting period (e.g. 2010-Q1). This [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] 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>>doc:sdmx:Glossary.Attribute.WebHome]], 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>>doc:sdmx:Glossary.Representation.WebHome]]. The derived [[data set>>doc:sdmx:Glossary.Data set.WebHome]] type may either require or prohibit this [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], depending on whether the data structure declared the reporting year start day [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] and if so, the [[attribute relationship>>doc:sdmx:Glossary.Attribute relationship.WebHome]] and assignment status assigned to it.

490

491

Element Documentation:

492

493

(% style="width:1007.29px" %)

494

|**Name**|**Type**|(% style="width:632px" %)**Documentation**

495

|com:Annotations|com:AnnotationsType|(% style="width:632px" %)[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]] is a reusable element the provides for a collection of [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It has been made global so that restrictions of types that extend AnnotatableType my reference it.

496

|DataProvider|com: DataProviderReferenceType|(% style="width:632px" %)DataProvider contains a reference to the provider for the [[data set>>doc:sdmx:Glossary.Data set.WebHome]].

497

|Group|//GroupType//|(% style="width:632px" %)Group contains a references to a defined group in the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] along with its key (if necessary) and values for the [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] which are associated with the group. An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is associated to a group by either an explicit group relationship or by a group attachment when the [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] has a relationship with a [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] which is a member of this group.

498

|Series|TimeSeriesType|(% style="width:632px" %)Series contains a collection of observations that share a common key (set of [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] values). The key of a series is every [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] defined in the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]], save the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] at the observation (% style="color:#e74c3c" %)level(%%). In addition to the key and observations, the series contains values for [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] which have a relationship with any [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] that is part of the [[series key>>doc:sdmx:Glossary.Series key.WebHome]], so long as the [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] does not specify an attachment group or also has a relationship with the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] declared to be at the observation (% style="color:#e74c3c" %)level(%%).

499

500

**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>>doc:sdmx:Glossary.Dimension.WebHome]] defined in the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]], save the time [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]. In addition to observations, values can be provided for [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] which are associated with the [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] which make up this [[series key>>doc:sdmx:Glossary.Series key.WebHome]] (so long as the [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] do not specify a group attachment or also have an relationship with the time [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]). It is possible for the series to contain only observations or only [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] values, or both. The same rules for derivation as the base series type apply to this specialized series.

Derivation:

* //com:AnnotableType// (extension)

505

** //SeriesType// (restriction)

*** TimeSeriesType

Attributes:

REPORTING_YEAR_START_DAY?

510

511

Content:

512

com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, Obs*

513

514

Attribute Documentation:

515

516

(% style="width:1004.29px" %)

517

|**Name**|**Type**|(% style="width:617px" %)**Documentation**

518

|REPORTING_YEAR_START_DAY|xs:gMonthDay|(% style="width:617px" %)The REPORTING_YEAR_START_DAY [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is an explict [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] for the reporting year start day, which provides context to the time [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] when its value contains a reporting period (e.g. 2010-Q1). This [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] 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>>doc:sdmx:Glossary.Attribute.WebHome]], 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>>doc:sdmx:Glossary.Representation.WebHome]]. The derived series type may either require or prohibit this [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], depending on whether the data structure declared the reporting year start day [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] and if so, the [[attribute relationship>>doc:sdmx:Glossary.Attribute relationship.WebHome]] and assignment status assigned to it.

519

520

Element Documentation:

521

522

(% style="width:1003.29px" %)

523

|**Name**|**Type**|(% style="width:593px" %)**Documentation**

524

|com:Annotations|com:AnnotationsType|(% style="width:593px" %)[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]] is a reusable element the provides for a collection of [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It has been made global so that restrictions of types that extend AnnotatableType my reference it.

525

|Obs|//TimeSeriesObsType//|(% style="width:593px" %)

526

527

**//TimeSeriesObsType//: **TimeSeriesObsType defines the abstract structure of a time series observation. The observation must be provided a value for the time [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]. 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>>doc:sdmx:Glossary.Attribute.WebHome]] values. The same rules for derivation as the base observation type apply to this specialized observation.

Derivation:

* //com:AnnotableType// (extension)

532

** //ObsType// (restriction)

533

*** //TimeSeriesObsType//

534

535

Attributes:

536

TIME_PERIOD, REPORTING_YEAR_START_DAY?, OBS_VALUE?

537

538

Content:

539

com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?

540

541

Attribute Documentation:

542

543

(% style="width:1005.29px" %)

544

|**Name**|**Type**|(% style="width:496px" %)**Documentation**

545

|TIME_PERIOD|com: ObservationalTimePeriodType|(% style="width:496px" %)The TIME_PERIOD [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is an explicit [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] for the time [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]. This is declared in the base schema since it has a fixed identifier and [[representation>>doc:sdmx:Glossary.Representation.WebHome]]. Since this data is structured to be time series only, this [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is always required. If the time [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] specifies a more specific [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of time the derived type will restrict the type definition to the appropriate type.

546

|REPORTING_YEAR_START_DAY|xs:gMonthDay|(% style="width:496px" %)The REPORTING_YEAR_START_DAY [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is an explict [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] for the reporting year start day, which provides context to the time [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] when its value contains a reporting period (e.g. 2010-Q1). This [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] 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>>doc:sdmx:Glossary.Attribute.WebHome]], 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>>doc:sdmx:Glossary.Representation.WebHome]]. The derived observation type may either require or prohibit this [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], depending on whether the data structure declared the reporting year start day [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] and if so, the [[attribute relationship>>doc:sdmx:Glossary.Attribute relationship.WebHome]] and assignment status assigned to it.

547

|OBS_VALUE|xs:anySimpleType|(% style="width:496px" %)The OBS_VALUE [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is an explicit [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] for the primary [[measure>>doc:sdmx:Glossary.Measure.WebHome]], which is intended to hold the value for the observation. This is declared in the base schema since it has a fixed identifier. This [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is un-typed, since the [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of the observed value can vary widely. Derived types will restrict this to be a type based on the [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of the primary [[measure>>doc:sdmx:Glossary.Measure.WebHome]]. In the case that an explicit [[measure>>doc:sdmx:Glossary.Measure.WebHome]] is used, the derived type for a given [[measure>>doc:sdmx:Glossary.Measure.WebHome]] might further restrict the type of the primary [[measure>>doc:sdmx:Glossary.Measure.WebHome]] to be more specific to the core [[representation>>doc:sdmx:Glossary.Representation.WebHome]] for the [[measure>>doc:sdmx:Glossary.Measure.WebHome]] (% style="color:#e74c3c" %)concept(%%). Note that it is required that in the case of multiple [[measures>>doc:sdmx:Glossary.Measure.WebHome]] being used, that the [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of the primary [[measure>>doc:sdmx:Glossary.Measure.WebHome]] is broad enough to handle the various [[representations>>doc:sdmx:Glossary.Representation.WebHome]] of the [[measure>>doc:sdmx:Glossary.Measure.WebHome]] (% style="color:#e74c3c" %)concepts(%%).

548

549

Element Documentation:

550

551

(% style="width:1013.29px" %)

552

|**Name**|**Type**|(% style="width:603px" %)**Documentation**

553

|com:Annotations|com:AnnotationsType|(% style="width:603px" %)[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]] is a reusable element the provides for a collection of [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It has been made global so that restrictions of types that extend AnnotatableType my reference it.

554

555

=== 2.2.3 Simple Types ===

556

557

**DataScopeType: **DataScopeType is an enumeration of the possible validity scopes for a [[data set>>doc:sdmx:Glossary.Data set.WebHome]]. These scopes indicate the (% style="color:#e74c3c" %)level(%%) at which the data is stated to be valid.

558

559

Derived by restriction of xs:string .

Enumerations:

(% style="width:1020.29px" %)

564

|(% style="width:208px" %)**Value**|(% style="width:809px" %)**Documentation**

565

|(% style="width:208px" %)DataStructure|(% style="width:809px" %)The [[data set>>doc:sdmx:Glossary.Data set.WebHome]] conforms simply to the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] as it is defined, without regard to any (% style="color:#e74c3c" %)constraints(%%).

566

|(% style="width:208px" %)ConstrainedDataStructure|(% style="width:809px" %)The [[data set>>doc:sdmx:Glossary.Data set.WebHome]] conforms to the known allowable content (% style="color:#e74c3c" %)constraints(%%) applied to the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]].

567

|(% style="width:208px" %)[[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]]|(% style="width:809px" %)The [[data set>>doc:sdmx:Glossary.Data set.WebHome]] conforms to the known allowable content (% style="color:#e74c3c" %)constraints(%%) applied to the [[dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]].

568

|(% style="width:208px" %)ProvisionAgreement|(% style="width:809px" %)The [[data set>>doc:sdmx:Glossary.Data set.WebHome]] conforms to the known allowable content (% style="color:#e74c3c" %)constraints(%%) applied to the [[provision agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]].

569

570

== 2.3 Generic Metadata Namespace ==

571

572

**http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/metadata/generic**

573

574

=== 2.3.1 Summary ===

575

576

Referenced Namespaces:

577

578

(% style="width:694.294px" %)

579

|(% style="width:492px" %)**Namespace**|(% style="width:199px" %)**Prefix**

580

|(% style="width:492px" %)http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/common|(% style="width:199px" %)com

581

|(% style="width:492px" %)http:~/~/www.w3.org/2001/XMLSchema|(% style="width:199px" %)xs

Contents:

6 Complex Types

=== 2.3.2 Complex Types ===

588

589

**MetadataSetType: **MetadataSetType describes the structure for a [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]], which contains a collection of reported metadata against a set of values for a given full or partial target identifier, as described in a [[metadata structure definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]]. The [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]] may contain reported metadata for multiple report structures defined in a [[metadata structure definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]].

Derivation:

* //com:AnnotableType// (extension)

** MetadataSetType

Attributes:

structureRef, setID?, action?, reportingBeginDate?, reportingEndDate?, validFromDate?, validToDate?, publicationYear?, publicationPeriod?

598

599

Content:

600

com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, com:Name*, DataProvider?, Report+

601

602

Attribute Documentation:

603

604

(% style="width:1006.29px" %)

605

|**Name**|**Type**|(% style="width:592px" %)**Documentation**

606

|structureRef|xs:IDREF|(% style="width:592px" %)The structureRef contains a reference to a structural specification in the header of a data or [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] message. The structural specification details which structure the data or [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] conforms to, as well as providing additional information such as how the data is structure (e.g. which [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] occurs at the observation (% style="color:#e74c3c" %)level(%%) for a [[data set>>doc:sdmx:Glossary.Data set.WebHome]]).

607

|setID|com:IDType|(% style="width:592px" %)The setID provides an identification of the data or [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]].

608

|action|com:ActionType|(% style="width:592px" %)The action [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates whether the file is appending, replacing, or deleting.

609

|reportingBeginDate|com: BasicTimePeriodType|(% style="width:592px" %)The reportingBeginDate indicates the inclusive start time of the data reported in the data or [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]].

610

|reportingEndDate|com: BasicTimePeriodType|(% style="width:592px" %)The reportingEndDate indicates the inclusive end time of the data reported in the data or [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]].

611

|validFromDate|xs:dateTime|(% style="width:592px" %)The validFromDate indicates the inclusive start time indicating the validity of the information in the data or [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]].

612

|validToDate|xs:dateTime|(% style="width:592px" %)The validToDate indicates the inclusive end time indicating the validity of the information in the data or [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]].

613

|publicationYear|xs:gYear|(% style="width:592px" %)The publicationYear holds the ISO 8601 four-digit year.

614

|publicationPeriod|com: ObservationalTimePeriodType|(% style="width:592px" %)The publicationPeriod specifies the period of publication of the data or metadata in terms of whatever provisioning agreements might be in force (i.e., "Q1 2005" if that is the time of publication for a [[data set>>doc:sdmx:Glossary.Data set.WebHome]] published on a quarterly basis).

615

616

Element Documentation:

617

618

(% style="width:1006.29px" %)

619

|**Name**|(% style="width:268px" %)**Type**|(% style="width:562px" %)**Documentation**

620

|com:Annotations|(% style="width:268px" %)com:AnnotationsType|(% style="width:562px" %)[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]] is a reusable element the provides for a collection of [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It has been made global so that restrictions of types that extend AnnotatableType my reference it.

621

|com:Name|(% style="width:268px" %)com:TextType|(% style="width:562px" %)Name is a reusable element, used for providing a human-readable name for an object.

622

|DataProvider|(% style="width:268px" %)com: DataProviderReferenceType|(% style="width:562px" %)DataProviderReference provides a references to an organisation with the role of [[data provider>>doc:sdmx:Glossary.Data provider.WebHome]] that is providing this [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]].

623

|Report|(% style="width:268px" %)ReportType|(% style="width:562px" %)Report contains the details of a the reported metadata, including the identification of the target and the report [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]].

624

625

**ReportType: **ReportType contains a set of report [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] and identifies a target objects] to which they apply.

Derivation:

* //com:AnnotableType// (extension)

** ReportType

Attributes:

id

Content:

com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, Target, AttributeSet

637

638

Attribute Documentation:

639

640

(% style="width:1003.29px" %)

641

|**Name**|**Type**|(% style="width:788px" %)**Documentation**

642

|id|com:IDType|(% style="width:788px" %)The id [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds the identifier of the report structure as defined in the [[metadata structure definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]]. This identifies the report structure which defines the structure of metadata that is being reported.

643

644

Element Documentation:

645

646

(% style="width:1003.29px" %)

647

|**Name**|**Type**|(% style="width:593px" %)**Documentation**

648

|com:Annotations|com:AnnotationsType|(% style="width:593px" %)[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]] is a reusable element the provides for a collection of [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It has been made global so that restrictions of types that extend AnnotatableType my reference it.

649

|Target|TargetType|(% style="width:593px" %)Target contains a set of target reference values which when taken together, identify the object or objects to which the reported metadata apply.

650

|AttributeSet|AttributeSetType|(% style="width:593px" %)AttributeSet contains the reported metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] values for the reported metadata.

651

652

**TargetType: **TargetType defines the structure of a target. It contains a set of target reference values which when taken together, identify the object or objects to which the reported metadata apply.

Attributes:

id

Content:

ReferenceValue+

Attribute Documentation:

661

662

(% style="width:1003.29px" %)

663

|**Name**|**Type**|(% style="width:805px" %)**Documentation**

664

|id|com:IDType|(% style="width:805px" %)The id [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds the identifier of the metadata target as defined in the [[metadata structure definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]]. This identifies the metadata target of the report structure that identifies the target object(s) of the reported metadata.

665

666

Element Documentation:

667

668

(% style="width:1009.29px" %)

669

|**Name**|**Type**|(% style="width:710px" %)**Documentation**

670

|ReferenceValue|ReferenceValueType|(% style="width:710px" %)ReferenceValue contains a value for a target reference object reference. When this is taken with its sibling elements, they identify the object or objects to which the reported metadata apply. The content of this will either be a reference to an identifiable object, a data key, a reference to a [[data set>>doc:sdmx:Glossary.Data set.WebHome]], or a report period.

671

672

**ReferenceValueType: **ReferenceValueType defines the structure of a target object reference value. A target reference value will either be a reference to an identifiable object, a data key, a reference to a [[data set>>doc:sdmx:Glossary.Data set.WebHome]], or a report period.

Attributes:

id

Content:

(ObjectReference | DataKey | DataSetReference | ConstraintContentReference | ReportPeriod)

679

680

Attribute Documentation:

681

682

(% style="width:1013.29px" %)

683

|**Name**|**Type**|(% style="width:847px" %)**Documentation**

684

|id|com:IDType|(% style="width:847px" %)The id [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds the identifier of the target reference object as defined in the [[metadata structure definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]]. This identifies the target reference of the metadata target that identifes one of the target references, that when taken together, identify the target of the reported metadata.

685

686

Element Documentation:

687

688

(% style="width:1017.29px" %)

689

|**Name**|**Type**|(% style="width:522px" %)**Documentation**

690

|ObjectReference|com: ObjectReferenceType|(% style="width:522px" %)ObjectReference provides a reference to an identifiable object in the [[SDMX information model>>doc:sdmx:Glossary.SDMX Information Model.WebHome]]. An identifiable object target will utilize this option as the [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of the target reference value.

691

|DataKey|com:DataKeyType|(% style="width:522px" %)ObjectReference provides a set of [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] references and values for those [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] for the purpose of reporting metadata against a set of data. A key descriptor values target will utilize this option as the [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of the target reference value.

692

|DataSetReference|com:SetReferenceType|(% style="width:522px" %)DataSetReference provides a reference to a [[data set>>doc:sdmx:Glossary.Data set.WebHome]] for the purpose of reporting metadata against the data. A [[data set>>doc:sdmx:Glossary.Data set.WebHome]] target will utilize this option as the [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of the target reference value.

693

|ConstraintContentRef erence|com: AttachmentConstraint ReferenceType|(% style="width:522px" %)ConstraintContentReference provides a reference to an attachment (% style="color:#e74c3c" %)constraint(%%) for the purpose of reporting metadata against the data identified in the key sets and/or cube regions identified by the (% style="color:#e74c3c" %)constraint(%%). A (% style="color:#e74c3c" %)constraint(%%) target will utilize this option as the [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of the target reference value.

694

|ReportPeriod|com: ObservationalTimePer iodType|(% style="width:522px" %)ReportPeriod provides a report period for the purpose of qualifying the target reporting period of reported metadata. A report period target will utilize this option as the [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of the target reference value.

695

696

**AttributeSetType: **AttributeSetType defines the structure for a collection of reported metadata [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]].

Content:

ReportedAttribute+

Element Documentation:

702

703

(% style="width:1023.29px" %)

704

|(% style="width:150px" %)**Name**|(% style="width:202px" %)**Type**|(% style="width:668px" %)**Documentation**

705

|(% style="width:150px" %)ReportedAttribute|(% style="width:202px" %)ReportedAttributeType|(% style="width:668px" %)ReportedAttribute provides the details of a reported [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], including a value and/or child reported [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]].

706

707

**ReportedAttributeType: **ReportedAttributeType defines the structure for a reported metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]. A value for the [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] can be supplied as either a single value, or multi-lingual text values (either structured or unstructured). An optional set of child metadata [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] is also available if the metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] definition defines nested metadata [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]].

Derivation:

* //com:AnnotableType// (extension)

712

** ReportedAttributeType

Attributes:

id, value?

Content:

com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, (com:Text+ | com:StructuredText+)?, AttributeSet?

719

720

Attribute Documentation:

721

722

(% style="width:996.294px" %)

723

|**Name**|(% style="width:170px" %)**Type**|(% style="width:657px" %)**Documentation**

724

|id|(% style="width:170px" %)com:IDType|(% style="width:657px" %)The id [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] identifies the metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] that the value is being reported for.

725

|value|(% style="width:170px" %)xs:string|(% style="width:657px" %)The value [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds any simple value for the metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]].

726

727

Element Documentation:

728

729

(% style="width:999.294px" %)

730

|**Name**|**Type**|(% style="width:670px" %)**Documentation**

731

|com:Annotations|com:AnnotationsType|(% style="width:670px" %)[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]] is a reusable element the provides for a collection of [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It has been made global so that restrictions of types that extend AnnotatableType my reference it.

732

|com:Text|com:TextType|(% style="width:670px" %)Text is used to supply parallel multi-lingual textual values for the reported metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]. This will be used if the text format of the metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] has a type of string and the multi-lingual value is set to true.

733

|com:StructuredText|com:XHTMLType|(% style="width:670px" %)StructuredText is used to supply parallel multi-lingual structured (as XHTML) textual values for the reported metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]. This will be used if the text format of the metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] has a type of XHTML and the multi-lingual value is set to true.

734

|AttributeSet|AttributeSetType|(% style="width:670px" %)AttributeSet contains the reported metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] values for the child metadata [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]].

735

736

== 2.4 Structure Specific Metadata Namespace ==

737

738

**http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/metadata/structurespecific**

739

740

=== 2.4.1 Summary ===

741

742

Referenced Namespaces:

743

744

(% style="width:654.294px" %)

745

|(% style="width:492px" %)**Namespace**|(% style="width:159px" %)**Prefix**

746

|(% style="width:492px" %) |(% style="width:159px" %)

747

|(% style="width:492px" %)http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/common|(% style="width:159px" %)com

748

|(% style="width:492px" %)http:~/~/www.w3.org/2001/XMLSchema|(% style="width:159px" %)xs

Contents:

5 Complex Types

=== 2.4.2 Complex Types ===

754

755

**//MetadataSetType//: **MetadataSetType is an abstract base type the forms the basis for a metadata structure specific [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]]. It is restricted by the [[metadata structure definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] specific schema to meet its needs.

Derivation:

* //com:AnnotableType// (extension)

760

** //MetadataSetType//

Attributes:

structureRef, setID?, action?, reportingBeginDate?, reportingEndDate?, validFromDate?, validToDate?, publicationYear?, publicationPeriod?

765

766

Content:

767

com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, com:Name*, DataProvider?, Report+

768

769

Attribute Documentation:

770

771

(% style="width:1003.29px" %)

772

|**Name**|**Type**|(% style="width:607px" %)**Documentation**

773

|structureRef|xs:IDREF|(% style="width:607px" %)The structureRef contains a reference to a structural specification in the header of a data or [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] message. The structural specification details which structure the data or [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] conforms to, as well as providing additional information such as how the data is structure (e.g. which [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] occurs at the observation (% style="color:#e74c3c" %)level(%%) for a [[data set>>doc:sdmx:Glossary.Data set.WebHome]]).

774

|setID|com:IDType|(% style="width:607px" %)The setID provides an identification of the data or [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]].

775

|action|com:ActionType|(% style="width:607px" %)The action [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates whether the file is appending, replacing, or deleting.

776

|reportingBeginDate|com: BasicTimePeriodType|(% style="width:607px" %)The reportingBeginDate indicates the inclusive start time of the data reported in the data or [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]].

777

|reportingEndDate|com: BasicTimePeriodType|(% style="width:607px" %)The reportingEndDate indicates the inclusive end time of the data reported in the data or [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]].

778

|validFromDate|xs:dateTime|(% style="width:607px" %)The validFromDate indicates the inclusive start time indicating the validity of the information in the data or [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]].

779

|validToDate|xs:dateTime|(% style="width:607px" %)The validToDate indicates the inclusive end time indicating the validity of the information in the data or [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]].

780

|publicationYear|xs:gYear|(% style="width:607px" %)The publicationYear holds the ISO 8601 four-digit year.

781

|publicationPeriod|com: ObservationalTimePeriodType|(% style="width:607px" %)The publicationPeriod specifies the period of publication of the data or metadata in terms of whatever provisioning agreements might be in force (i.e., "Q1 2005" if that is the time of publication for a [[data set>>doc:sdmx:Glossary.Data set.WebHome]] published on a quarterly basis).

782

783

Element Documentation:

784

785

(% style="width:1006.29px" %)

786

|**Name**|**Type**|(% style="width:631px" %)**Documentation**

787

|com:Annotations|com:AnnotationsType|(% style="width:631px" %)[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]] is a reusable element the provides for a collection of [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It has been made global so that restrictions of types that extend AnnotatableType my reference it.

788

|com:Name|com:TextType|(% style="width:631px" %)Name is a reusable element, used for providing a human-readable name for an object.

789

|DataProvider|com: DataProviderReferenceType|(% style="width:631px" %)>DataProviderReference provides a references to an organisation with the role of [[data provider>>doc:sdmx:Glossary.Data provider.WebHome]] that is providing this [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]].

790

|Report|//ReportType//|(% style="width:631px" %)Report contains the details of a the reported metadata, including the identification of the target and the report [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]. This element is unqualified so that the [[metadata structure definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] specific schema can refine the type of the element such that it requires types built according to the [[metadata structure definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]]. This allows the [[metadata structure definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] to validate the structure of the reported metadata against the [[metadata structure definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] while still allowing the content to be processed in a generic manner.

791

792

**//ReportType//: **ReportType is an abstract base type the forms the basis for a [[metadata structure definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] specific report, based on the defined report structures. This type is restricted in the [[metadata structure definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] specific schema so that the Target and AttributeSet conform to the prescribed report structure.

Derivation:

* //com:AnnotableType// (extension)

** //ReportType//

Attributes:

id?

Content:

com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, Target, AttributeSet

804

805

Attribute Documentation:

806

807

(% style="width:1003.29px" %)

808

|**Name**|**Type**|(% style="width:837px" %)**Documentation**

809

|id|com:IDType|(% style="width:837px" %)The id [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds the identifier of the report structure as defined in the [[metadata structure definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]]. This identifies the report structure which defines the structure of metadata that is being reported. This is optional and not expected to be supplied as the [[metadata structure definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] specific schema will specify a fixed value such that the reference to the report structure will always be available if required for processing.

810

811

Element Documentation:

812

813

(% style="width:1005.29px" %)

814

|**Name**|**Type**|(% style="width:695px" %)**Documentation**

815

|com:Annotations|com:AnnotationsType|(% style="width:695px" %)[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]] is a reusable element the provides for a collection of [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It has been made global so that restrictions of types that extend AnnotatableType my reference it.

816

|Target|//TargetType//|(% style="width:695px" %)Target contains a set of target reference values which when taken together, identify the object or objects to which the reported metadata apply. This element is unqualified so that the [[metadata structure definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] specific schema can refine the type of the element such that the references values can be validated against those defined in the metadata targets for the report structure.

817

|AttributeSet|xs:anyType|(% style="width:695px" %)AttributeSet contains the reported metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] values for the reported metadata. This element is unqualified and un-typed so that it can refined by the [[metadata structure definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] specific schema to validate that the reported metadata [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] conform to those prescribed by the report structure. The content of this must be element only, and these elements must always represent a reported [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]. Since this can not be strictly enforced in XML Schema, additional steps have been added to make generic processing of this element simpler. When processing this element, any element found with the [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] isMetadataAttribute in this target namespace is assumed to be a reported metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] and can be processed as such.

818

819

**//TargetType//: **TargetType is an abstract base type that forms the basis of a the metadata report's metadata target value. This type is restricted in the [[metadata structure definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] specific schema so that the ReferenceValue elements conform to the targets specified in the metadata target defined in the [[metadata structure definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]].

Attributes:

id?

Content:

ReferenceValue+

Attribute Documentation:

828

829

(% style="width:999.294px" %)

830

|**Name**|**Type**|(% style="width:833px" %)**Documentation**

831

|id|com:IDType|(% style="width:833px" %)The id [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds the identifier of the metadata target as defined in the [[metadata structure definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]]. This identifies the metadata target of the report structure that identifies the target object(s) of the reported metadata. This is optional and not expected to be supplied as the [[metadata structure definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] specific schema will specify a fixed value such that the reference to the metadata target will always be available if required for processing.

832

833

Element Documentation:

834

835

(% style="width:999.294px" %)

836

|**Name**|**Type**|(% style="width:700px" %)**Documentation**

837

|ReferenceValue|//ReferenceValueType//|(% style="width:700px" %)ReferenceValue contains a value for a target reference. When this is taken with its sibling elements, they identify the object or objects to which the reported metadata apply. The content of this will either be a reference to an identifiable object, a data key, a reference to a [[data set>>doc:sdmx:Glossary.Data set.WebHome]], or a report period. This element is unqualified so that the [[metadata structure definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] specific schema can refine the type of the element such that value can be validated against the format defined in the [[metadata structure definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]].

838

839

**//ReferenceValueType//: **ReferenceValueType is an abstract base type that forms the basis of a target reference value. A target reference value will either be a reference to an identifiable object, a data key, a reference to a [[data set>>doc:sdmx:Glossary.Data set.WebHome]], or a report period. The choice of these options will be refined to only one according to the definition of the target in the [[metadata structure definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]].

Attributes:

id?

Content:

(ObjectReference | DataKey | DataSetReference | ConstraintContentReference | ReportPeriod)

846

847

Attribute Documentation:

848

849

(% style="width:1013.29px" %)

850

|**Name**|**Type**|(% style="width:847px" %)**Documentation**

851

|id|com:IDType|(% style="width:847px" %)The id [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds the identifier of the target reference object reference as defined in the [[metadata structure definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]]. This identifies the target reference of the metadata target that identifes one of the target references, that when taken together, identify the target of the reported metadata. This is optional and not expected to be supplied as the [[metadata structure definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] specific schema will specify a fixed value such that the reference to the target object definition will always be available if required for processing.

852

853

Element Documentation:

854

855

(% style="width:1000.29px" %)

856

|**Name**|**Type**|(% style="width:563px" %)**Documentation**

857

|ObjectReference|//com:ReferenceType//|(% style="width:563px" %)ObjectReference provides a reference to an identifiable object in the [[SDMX information model>>doc:sdmx:Glossary.SDMX Information Model.WebHome]]. An identifiable object target will utilize this option as the [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of the target reference value. This element is unqualified so that the [[metadata structure definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] specific schema can refine the type of the element such that the type of reference is valid according to the object type specified in the identifiable object target in the [[metadata structure definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]]. At the very least, the reference will be specific to the type of object being referenced so that a complete set of reference fields must be provided. In cases where an item object is restricted to be from a particular scheme, this type will be further restricted so that only a valid item reference can be supplied. The structure of this reference is such that it can be generically processed without needing to know what the intended target object type is prior to processing, as this information is part of the reference.

858

|DataKey|com:DataKeyType|(% style="width:563px" %)ObjectReference provides a set of [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] references and values for those [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] for the purpose of reporting metadata against a set of data. A key descriptor values target will utilize this option as the [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of the target reference value. It is not expect that the [[metadata structure definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] specific schema would refine this, but none the less, it is an unqualified element.

859

|DataSetReference|com:SetReferenceType|(% style="width:563px" %)DataSetReference provides a reference to a [[data set>>doc:sdmx:Glossary.Data set.WebHome]] for the purpose of reporting metadata against the data. A [[data set>>doc:sdmx:Glossary.Data set.WebHome]] target will utilize this option as the [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of the target reference value.

860

|ConstraintContentRef erence|com: AttachmentConstraint ReferenceType|(% style="width:563px" %)ConstraintContentReference provides a reference to an attachment (% style="color:#e74c3c" %)constraint(%%) for the purpose of reporting metadata against the data identified in the key sets and/or cube regions identified by the (% style="color:#e74c3c" %)constraint(%%). A (% style="color:#e74c3c" %)constraint(%%) target will utilize this option as the [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of the target reference value.

861

|ReportPeriod|com: ObservationalTimePeriodType|(% style="width:563px" %)ReportPeriod provides a report period for the purpose of qualifying the target reporting period of reported metadata. A report period target will utilize this option as the [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of the target reference value. It is not expect that the [[metadata structure definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] specific schema would refine this, but none the less, it is an unqualified element. This element is unqualified so that the [[metadata structure definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] specific schema can refine the type of the element such that the specific type of time value prescribed in the [[metadata structure definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] can be validated.

862

863

**//ReportedAttributeType//: **ReportedAttributeType is an abstract base type that forms the basis for a metadata structure specific metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]. A value for the [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] can be supplied as either a single value, or multi-lingual text values (either structured or unstructured). An optional set of child metadata [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] is also available if the metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] definition defines nested metadata [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]. The [[metadata structure definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] specific schema will refine this type for each metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] such that the content can be validation against what is defined in the [[metadata structure definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]].

Derivation:

* //com:AnnotableType// (extension)

868

** //ReportedAttributeType//

869

870

Attributes:

871

id?, value?, isMetadataAttribute?

872

873

Content:

874

com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, (com:Text+ | com:StructuredText+)?, AttributeSet?

875

876

Attribute Documentation:

877

878

(% style="width:999.294px" %)

879

|**Name**|**Type**|(% style="width:660px" %)**Documentation**

880

|id|com:IDType|(% style="width:660px" %)The id [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] identifies the metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] that the value is being reported for. This is optional and not expected to be supplied as the [[metadata structure definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] specific schema will specify a fixed value such that the reference to the metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] will always be available if required for processing.

881

|value|xs:anySimpleType|(% style="width:660px" %)The value [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds any simple value for the metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]. This [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is un-typed such that the [[metadata structure definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] specific schema can specify any simple type according the text format / local [[representation>>doc:sdmx:Glossary.Representation.WebHome]] defined by the [[metadata structure definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]].

882

|isMetadataAttribute (fixed: true)|xs:boolean|(% style="width:660px" %)The isMetadataAttribute [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is a fixed boolean (true) and is intended to designate to processing applications that a given element represents a reported [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]. This [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is qualified (meaning that it will be qualified in an instance with the target namespace) to ensure that it can be properly identified by applications. The purpose of this is to allow applications to identify elements with unknown names as reported [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] so that they may process a [[metadata structure definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] specific instance without knowledge of the underlying [[metadata structure definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]].

883

884

Element Documentation:

885

886

(% style="width:997.294px" %)

887

|**Name**|**Type**|(% style="width:668px" %)**Documentation**

888

|com:Annotations|com:AnnotationsType|(% style="width:668px" %)[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]] is a reusable element the provides for a collection of [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It has been made global so that restrictions of types that extend AnnotatableType my reference it.

889

|com:Text|com:TextType|(% style="width:668px" %)Text is used to supply parallel multi-lingual textual values for the reported metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]. This will be used if the text format of the metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] has a type of string and the multi-lingual value is set to true.

890

|com:StructuredText|com:XHTMLType|(% style="width:668px" %)StructuredText is used to supply parallel multi-lingual structured (as XHTML) textual values for the reported metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]. This will be used if the text format of the metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] has a type of XHTML and the multi-lingual value is set to true. If the multi-lingual flag is not set to true, it is expected that the maximum occurrence of this will be refined to be 1 in the [[metadata structure definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] specific schema.

891

|AttributeSet|xs:anyType|(% style="width:668px" %)AttributeSet contains the reported metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] values for the child metadata [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]. This element is unqualified and un-typed so that it can refined by the [[metadata structure definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] specific schema to validate that the reported metadata [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] conform to those prescribed by the metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] definition. The content of this must be element only, and these elements must always represent a reported [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]. Since this can not be strictly enforced in XML Schema, additional steps have been added to make generic processing of this element simpler. When processing this element, any element found with the [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] isMetadataAttribute in this target namespace is assumed to be a reported metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] and can be processed as such.

892

893

= 3. Mapping to Structure-Specific Schemas =

== 3.1 General ==

Data structure and metadata structure-specific schemas are each based on one single core construct found in their respective structure-specific namespaces;

898

899

Data - http:~/~/www.SDMX.org/resources/SDMXML/schemas/v2_1/data/structurespecific

900

901

Metadata - http:~/~/www.SDMX.org/resources/SDMXML/schemas/v2_1/data/structurespecific

902

903

For a metadata structure, only a single schema will be created for the entire structure definition. For data structures, many variations of the base schema are possible, each specific as to how the data is organised. This will be discussed in more details in the specific rules for the data structure schemas.

904

905

=== 3.1.1 Basic Terminology ===

906

907

In the subsequent sections, the following namespace prefixes are used:

908

909

(% style="width:763.294px" %)

910

|(% style="width:623px" %)**Namespace**|(% style="width:137px" %)**Prefix**

911

|(% style="width:623px" %)http:~/~/www.w3.org/2001/XMLSchema|(% style="width:137px" %)xs

912

|(% style="width:623px" %)http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/common|(% style="width:137px" %)common

913

|(% style="width:623px" %)http:~/~/www.sdmx.org/resources/sdmxml/schemas/ v2_1/data/structurespecific|(% style="width:137px" %)dsd

914

|(% style="width:623px" %)http:~/~/www.sdmx.org/resources/sdmxml/schemas/ v2_1/metadata/structurespecific|(% style="width:137px" %)msd

915

916

It is assumed that in order to use this guide, the reader is familiar with schema terminology. However, for convenience the following is list of the terminology used here:

917

918

**Schema:** Refers to the format specific schema in general, and in particular the root xs:schema element of that schema file.

919

920

**Global Element:** Refers to an element definition at the top (% style="color:#e74c3c" %)level(%%) of the schema (i.e. an xs:element element in the root xs:schema element). It will define a name and type (name and type [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]) and possibly a substitution group (substitutionGroup [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]).

921

922

**Local Element:** Refers to an element definition within a complex type (i.e. an xs:element element contained within a xs:sequence element that is contained in a xs:complexType element). A local element must define a name and type (name and type [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]) and may also specify a minimum and maximum occurrence (minOccurs and maxOccurs [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]).

923

924

**Qualified/Unqualified Element:** A qualified element is an element that must be referred to by the namespace in which it was defined. An unqualified element does not have a namespace associated with it. The structure specific schemas make use of unqualified elements to that the structure specific schemas can restrict the base content to meet the specific needs of the structure, while maintaining as much of the original document structure as possible.

925

926

**Element Reference:** Refers to an element definition within a complex type that is a reference to a global element (i.e. an xs:element element contained within a xs:sequence element that is contained in a xs:complexType element). An element reference must reference a global element (via its ref [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]) and may also specify a minimum and maximum occurrence (minOccurs and maxOccurs [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]).

927

928

**Complex Type:** Refers to a complex type definition. In this context, all complex type definitions occur at the top (% style="color:#e74c3c" %)level(%%) of the schema (i.e. an xs:complexType element in the root xs:schema element). A complex type must define a name (name [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]) and may be made abstract (via the abstract [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]’s boolean value).

929

930

**Simple Type:** Refers to a simple type definition. In this context, all simple type definitions occur at the top (% style="color:#e74c3c" %)level(%%) of the schema (i.e. an xs:simpleType element in the root xs:schema element). In this context, a simple type will always be defined via a restriction (an xs:restriction element in the xs:simpleType element). The restriction will reference a base type.

931

932

**Anonymous Type:** A complex or simple type definition which occurs within an element definition. The method is sometimes referred to a the "Russian-doll" technique as it creates nested constructs. Anonymous types are not given names and cannot be abstract. The can however, be derived from other types.

933

934

**Content Group:** A group which defines a content model for reuse. This is contained in the xs:group element, and is defined at the root of the schema. It allows for a common sequence or choice of elements to be reused across multiple types without having to redefine the sequence or choice in each type.

935

936

**Uniqueness (% style="color:#e74c3c" %)Constraint(%%):** A uniqueness (% style="color:#e74c3c" %)constraint(%%) is defined within an element and is used to force descendent elements to be unique based on some criteria of it fields (elements or [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]). This is defined in an element, and has content of an and multiple elements. The selector designates the descendants that must be unique (with an xpath [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]) and the field specifies which property of the selected element must be unique (also with an xpath [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]])

937

938

**Extension:** Refers to the definition of a complex type that is an extension of another complex type. The extension will always make a reference to a base. In the schema, this is defined within the xs:complexType element as a child xs:complexContent element containing an xs:extension element (with a base [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]).

939

940

**Restriction:** Refers to the definition of a simple or complex type that is a restriction of another type of the same variety. The restriction will always make a reference to a base. In the schema, this is defined with an xs:restriction element (with a base [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]).

941

942

**Sequence:** Refers to a sequence of elements that may be defined as the root of a complex type content model, or as part of the content of a choice or another sequence. This is defined as an xs:sequence element. The sequence may specify a minimum and maximum occurrence (minOccurs and maxOccurs [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]).

943

944

**Choice:** Refers to a choice of elements that may be defined as the root of a complex type content model, or as part of the content of a sequence or another choice. This is defined as an xs:choice element. The sequence may specify a minimum and maximum occurrence (minOccurs and maxOccurs [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]).

945

946

**[[Facet>>doc:sdmx:Glossary.Facet.WebHome]]:** Refers to a single detail of a simple type restriction. This is represented by elements such as xs:minInclusive, xs:totalDigits, xs:minLength, and is contained in the xs:restriction element of a simple type definition. The value of the [[facet>>doc:sdmx:Glossary.Facet.WebHome]] is contained in a value [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] of the particular element.

947

948

**Enumeration:** Refers to an enumerated value of a simple type definition. It is represented by an xs:enumeration element contained within an xs:restriction element of a simple type definition. An enumeration defines a value (in the value [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]) and documentation (in xs:documentation elements contained in an xs:[[annotation>>doc:sdmx:Glossary.Annotation.WebHome]] element).

949

950

**XML [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]]:** Refers to the definition of an XML [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] for a complex type (i.e. and xs:[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] element in a xs:complexType element). An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] must define a name and type (name and type [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]) and may also specify a usage (use [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]).

951

952

== 3.2 Namespace Rules ==

953

954

Each format specific schema will specify its namespace in the target namespace of the schema (the targetNamespace [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] of the schema). This document also assumes that the root namespace (that which is defined by the xmlns [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]) of the schema will be the same as the target namespace. Therefore any types or global elements referenced in these descriptions without a namespace prefix are assumed to be in the format specific namespace.

955

956

The format specific schemas will incorporate the core format namespace and the common namespace by importing the schemas (via the xs:import element). If necessary, additional namespaces may be imported and referenced.

957

958

For the purpose of the descriptions here, the default element form for the schema (as specified in the elementFormDefault [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] of the schema) is “qualified", and the default [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] form (as specified in the attributeFormDefault [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] of the schema) is "unqualified".

959

960

== 3.3 General Rules ==

961

962

The following section details the general rules which apply to all structure specific schema creation.

963

964

=== 3.3.1 Component Name Determination ===

965

966

When required to create an XML element or [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], the name for a [[component>>doc:sdmx:Glossary.Component.WebHome]] is always its identifier. However, the identifier may be inherited. Therefore, the general rules is as follows:

967

968

1. If the [[component>>doc:sdmx:Glossary.Component.WebHome]] defines an identifier, the element or [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] name is the value of that identifier

969

1. Otherwise, the element or [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] name is the identifier of the (% style="color:#e74c3c" %)concept(%%) from which it takes its semantic (Note that this is technically the [[component>>doc:sdmx:Glossary.Component.WebHome]] identifer).

970

971

=== 3.3.2 Representation Determination ===

972

973

Every [[component>>doc:sdmx:Glossary.Component.WebHome]] has a [[representation>>doc:sdmx:Glossary.Representation.WebHome]] associated with it, whether it is defined as a local [[representation>>doc:sdmx:Glossary.Representation.WebHome]] in the [[component>>doc:sdmx:Glossary.Component.WebHome]] definition, or it is inherited from the (% style="color:#e74c3c" %)concept(%%) from which the [[component>>doc:sdmx:Glossary.Component.WebHome]] takes it semantic (as defined in the (% style="color:#e74c3c" %)concept(%%) identity of the [[component>>doc:sdmx:Glossary.Component.WebHome]]).

974

975

The [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of a [[component>>doc:sdmx:Glossary.Component.WebHome]] is determined by the following precedence:

976

977

1. The local [[representation>>doc:sdmx:Glossary.Representation.WebHome]] defined by the [[component>>doc:sdmx:Glossary.Component.WebHome]]

978

1. The core [[representation>>doc:sdmx:Glossary.Representation.WebHome]] defined in the (% style="color:#e74c3c" %)concept(%%) from which the [[component>>doc:sdmx:Glossary.Component.WebHome]] takes its semantic

979

1. A default [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of an un-faceted text format with a data type of String.

980

981

The [[representation>>doc:sdmx:Glossary.Representation.WebHome]] will either define a text format, or an enumeration with an enumeration format.

982

983

A text format consists of a data type and an optional collection of [[facets>>doc:sdmx:Glossary.Facet.WebHome]]. It is the combination of these which determine the exact nature of the [[component>>doc:sdmx:Glossary.Component.WebHome]] [[representation>>doc:sdmx:Glossary.Representation.WebHome]]. An enumeration consists of a reference to an [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]], for which an enumerated list of possible values can be created.

984

985

=== 3.3.3 Simple / Primitive Type Determination ===

986

987

For any given [[representation>>doc:sdmx:Glossary.Representation.WebHome]], there exist rules for determining the simple or primitive type which should be used to validate the value. There are no specific requirements to how a simple type is named or if it is referenced or used as an anonymous type. This section simply serves to state the requirements of the type for a [[component>>doc:sdmx:Glossary.Component.WebHome]] based on its determined [[representation>>doc:sdmx:Glossary.Representation.WebHome]].

988

989

For example, a [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] may inherit its [[representation>>doc:sdmx:Glossary.Representation.WebHome]] for a (% style="color:#e74c3c" %)concept(%%), and the data type of a [[representation>>doc:sdmx:Glossary.Representation.WebHome]] data type may be a String. The simplest solution would be to use the xs:string primitive type. However, an implementer may have chosen to generate simple types for all (% style="color:#e74c3c" %)concepts(%%) to avoid having to look up the (% style="color:#e74c3c" %)concept(%%) core [[representation>>doc:sdmx:Glossary.Representation.WebHome]] for very [[component>>doc:sdmx:Glossary.Component.WebHome]]. In this case, the type may be given a name based on the (% style="color:#e74c3c" %)concept(%%) and be a simple derivation from the xs:string type that places no further restrictions. The result would be that the type that is actually used for the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]], although named after the (% style="color:#e74c3c" %)concept(%%), is effectively the required xs:string. These rules are meant to allow such flexibility in how types are created. The only requirement is that the type meet the requirements stated here.

990

991

=== 3.3.4 Representation with Enumeration ===

992

993

A [[representation>>doc:sdmx:Glossary.Representation.WebHome]] which defines an enumeration will result in a simple type that is a restriction of the common:IDType. The simple type will define enumerations for each item in the [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]]. The value for these enumerations will be identifier of the item. If desired, the names of the item may be placed in the documentation of the enumeration, but this is not required. Example:

994

995

> <xs:simpleType name="ESTAT.CL_COUNTRY.1.0">

996

> <xs:restriction base="common:IDType">

997

> <xs:enumeration value="BE">

998

> <xs:annotation>

999

> <xs:documentation xml:lang="en">Belgium</xs:documentation>

> </xs:annotation>

> </xs:enumeration>

=== 3.3.5 Representation with Text Format ===

1004

1005

A [[representation>>doc:sdmx:Glossary.Representation.WebHome]] which defines a text format will result in a simple type or primitive type. The first step is to determine the base type from the text format data type:

1006

1007

(% style="width:698.294px" %)

1008

|(% style="width:286px" %)**SDMX Data Type**|(% style="width:409px" %)**XML Schema Data Type**

1009

|(% style="width:286px" %)String|(% style="width:409px" %)xs:string

1010

|(% style="width:286px" %)AlphaNumeric|(% style="width:409px" %)common:AlphaNumericType

1011

|(% style="width:286px" %)Alpha|(% style="width:409px" %)common:AlphaType

1012

|(% style="width:286px" %)Numeric|(% style="width:409px" %)common:NumericType

1013

|(% style="width:286px" %)BigInteger|(% style="width:409px" %)xs:integer

1014

|(% style="width:286px" %)Integer|(% style="width:409px" %)xs:int

1015

|(% style="width:286px" %)Long|(% style="width:409px" %)xs:long

1016

|(% style="width:286px" %)Short|(% style="width:409px" %)xs:short

1017

|(% style="width:286px" %)Decimal|(% style="width:409px" %)xs:decimal

1018

|(% style="width:286px" %)Float|(% style="width:409px" %)xs:float

1019

|(% style="width:286px" %)Double|(% style="width:409px" %)xs:double

1020

|(% style="width:286px" %)Boolean|(% style="width:409px" %)xs:boolean

1021

|(% style="width:286px" %)URI|(% style="width:409px" %)xs:anyURI

1022

|(% style="width:286px" %)Count|(% style="width:409px" %)xs:integer

1023

|(% style="width:286px" %)InclusiveValueRange|(% style="width:409px" %)xs:decimal

1024

|(% style="width:286px" %)ExclusiveValueRange|(% style="width:409px" %)xs: decimal

1025

|(% style="width:286px" %)Incremental|(% style="width:409px" %)xs: decimal

1026

|(% style="width:286px" %)ObservationalTimePeriod|(% style="width:409px" %)common:ObservationalTimePeriodType

1027

|(% style="width:286px" %)StandardTimePeriod|(% style="width:409px" %)common:StandardTimePeriodType

1028

|(% style="width:286px" %)BasicTimePeriod|(% style="width:409px" %)common:BasicTimePeriodType

1029

|(% style="width:286px" %)GregorianTimePeriod|(% style="width:409px" %)common:GregorianTimePeriodType

1030

|(% style="width:286px" %)GregorianYear|(% style="width:409px" %)xs:gYear

1031

|(% style="width:286px" %)GregorianYearMonth|(% style="width:409px" %)xs:gYearMonth

1032

|(% style="width:286px" %)GregorianDay|(% style="width:409px" %)xs:date

1033

|(% style="width:286px" %)ReportingTimePeriod|(% style="width:409px" %)common:ReportingTimePeriodType

1034

|(% style="width:286px" %)ReportingYear|(% style="width:409px" %)common:ReportingYearType

1035

|(% style="width:286px" %)ReportingSemester|(% style="width:409px" %)common:ReportingSemesterType

1036

|(% style="width:286px" %)ReportingTrimester|(% style="width:409px" %)common:ReportingTrimesterType

1037

|(% style="width:286px" %)ReportingQuarter|(% style="width:409px" %)common:ReportingQuarterType

1038

|(% style="width:286px" %)ReportingMonth|(% style="width:409px" %)common:ReportingMonthType

1039

|(% style="width:286px" %)ReportingWeek|(% style="width:409px" %)common:ReportingWeekType

1040

|(% style="width:286px" %)ReportingDay|(% style="width:409px" %)common:ReportingDayType

1041

|(% style="width:286px" %)DateTime|(% style="width:409px" %)xs:dateTime

1042

|(% style="width:286px" %)TimeRange|(% style="width:409px" %)common:TimeRangeType

1043

|(% style="width:286px" %)Month|(% style="width:409px" %)xs:gMonth

1044

|(% style="width:286px" %)MonthDay|(% style="width:409px" %)xs:gMonthDay

1045

|(% style="width:286px" %)Day|(% style="width:409px" %)xs:gDay

1046

|(% style="width:286px" %)Time|(% style="width:409px" %)xs:time

1047

|(% style="width:286px" %)Duration|(% style="width:409px" %)xs:duration

1048

|(% style="width:286px" %)XHTML|(% style="width:409px" %)N/A{{footnote}}These types are only used in complex types and will be discussed within their appropriate context.{{/footnote}}

1049

|(% style="width:286px" %)KeyValues|(% style="width:409px" %)N/A^^1^^

1050

|(% style="width:286px" %)IdentifiableReference|(% style="width:409px" %)N/A^^1^^

1051

|(% style="width:286px" %)DataSetReference|(% style="width:409px" %)N/A^^1^^

1052

|(% style="width:286px" %)AttachmentConstraintReference|(% style="width:409px" %)N/A^^1^^

1053

1054

If the text format does not specify any further [[facets>>doc:sdmx:Glossary.Facet.WebHome]], then the determined type is the listed type or a type which derives from the listed type without placing any addition restrictions on it. However, if one or more [[facets>>doc:sdmx:Glossary.Facet.WebHome]] are specified, then a simple type based on the listed type is necessary. The simple type derives via restriction from the listed type and adds [[facets>>doc:sdmx:Glossary.Facet.WebHome]] according to the following table (the values are (% style="color:#e74c3c" %)mapped(%%) as is):

1055

1056

(% style="width:773.294px" %)

1057

|(% style="width:291px" %)**SDMX Facet**|(% style="width:479px" %)**XML Schema Facet**

1058

|(% style="width:291px" %)minLength|(% style="width:479px" %)xs:minLength

1059

|(% style="width:291px" %)maxLength|(% style="width:479px" %)xs:maxLength

1060

|(% style="width:291px" %)minValue{{footnote}}Note that these options only apply to numeric representations and should be ignored if the data type is non-numeric{{/footnote}}|(% style="width:479px" %)if ExclusiveValueRange: xs:minExclusives, else: xs:minInclusive

1061

|(% style="width:291px" %)maxValue^^2^^|(% style="width:479px" %)if ExclusiveValueRange: xs:maxExclusives, else: xs:maxInclusive

1062

|(% style="width:291px" %)decimals^^2^^|(% style="width:479px" %)xs:fractionDigits

1063

|(% style="width:291px" %)pattern|(% style="width:479px" %)xs:pattern

1064

1065

Any other [[facets>>doc:sdmx:Glossary.Facet.WebHome]] are informational only, and will not affect the determined type.

1066

1067

=== 3.3.6 Type Names ===

1068

1069

These rules will only dictate type names where absolutely necessary. In all other cases, it is the decision of the implementer as to how to name or use the type. It is also the implementer's requirement to ensure that any type name is properly unique within its scope. To assist in this, the following recommendations are offered for naming types such that they are unique.

1070

1071

* It the type is an enumeration from an [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]], the recommended name is ~[[[Item Scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] Class].[Maintenance Agency].~[[[Item Scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] ID].~[[[Item Scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] (% style="color:#e74c3c" %)Version(%%)]

1072

* If the type is based on a text format of a (% style="color:#e74c3c" %)concept(%%) core [[representation>>doc:sdmx:Glossary.Representation.WebHome]], the recommended name is (% style="color:#e74c3c" %)Concept(%%).[Maintenance Agency].~[[[Concept Scheme>>doc:sdmx:Glossary.Concept scheme.WebHome]] ID].~[[[Concept Scheme>>doc:sdmx:Glossary.Concept scheme.WebHome]] (% style="color:#e74c3c" %)Version(%%)].[(% style="color:#e74c3c" %)Concept(%%) ID]

1073

* If the type is based on a text format of a [[component>>doc:sdmx:Glossary.Component.WebHome]] local [[representation>>doc:sdmx:Glossary.Representation.WebHome]], and;

1074

** The [[component>>doc:sdmx:Glossary.Component.WebHome]] id is required to be unique for all [[components>>doc:sdmx:Glossary.Component.WebHome]] within the scope of the structure which defines it (e.g. a [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]), the recommended name is ~[[[Component>>doc:sdmx:Glossary.Component.WebHome]] ID]

1075

** The [[component>>doc:sdmx:Glossary.Component.WebHome]] id is only required to be unique within the [[component>>doc:sdmx:Glossary.Component.WebHome]] list and which defines it (e.g. a metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]), the recommend name is ~[[[Component>>doc:sdmx:Glossary.Component.WebHome]] List ID].[Parent [[Component>>doc:sdmx:Glossary.Component.WebHome]] ID]*.~[[[Component>>doc:sdmx:Glossary.Component.WebHome]] ID]

1076

1077

=== 3.3.7 Type Reuse ===

1078

1079

It is possible that organisations that manage a large number of structure specific schemas my wish to take advantage of the reuse of previously defined type in order to simply the structure specific schema creation and lessen the number of schema elements which are created. The structure specific formats are designed in such a way that this would be allowed without any adverse affects.

1080

1081

For example, an organisation my create predefined types for all of [[codelists>>doc:sdmx:Glossary.Code list.WebHome]] and [[concept schemes>>doc:sdmx:Glossary.Concept scheme.WebHome]] which their structures utilize. These could be contained in a common schema with any namespace deemed appropriate. This would allow the structure specific schemas generation process to recognize the reused [[components>>doc:sdmx:Glossary.Component.WebHome]] and not be concerned with regenerating types. The logical flow for setting the [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of a [[component>>doc:sdmx:Glossary.Component.WebHome]] might be as follows:

1082

1083

> Does the component define a local type?

1084

> Yes: Is that type enumerated?

1085

> Yes: Type is the qualified type name for the item scheme

1086

> No: Generate simple type for text format

1087

> No: Type is the qualified name for the concept from which the component takes its semantic.

1088

1089

Only the constructs that will be detailed in the data and metadata structure-specific rules below are required to be in the specified target namespace of the structure-specific schema. So long as any other generated type conforms to the rules specified, it may exist in any namespace.

1090

1091

== 3.4 Data Structure Specific Schema ==

1092

1093

Separate schemas will be created for the data structure depending on which [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] occurs at the observation (% style="color:#e74c3c" %)level(%%), and whether explicit [[measures>>doc:sdmx:Glossary.Measure.WebHome]] are used in the case that the observation [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] is the [[measure>>doc:sdmx:Glossary.Measure.WebHome]] [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]. The recommended target namespace of the data structured specific schema is: [Data Structure URN]:ObsLevelDim:[Observation [[Dimensions>>doc:sdmx:Glossary.Dimension.WebHome]]](:explicit)?. Note that the explicit trailer is only used when the [[measure>>doc:sdmx:Glossary.Measure.WebHome]] [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] is used at the observation (% style="color:#e74c3c" %)level(%%) and the explicit [[measure>>doc:sdmx:Glossary.Measure.WebHome]] (% style="color:#e74c3c" %)concepts(%%) are to be used.

1094

1095

The rules for generating the data structure specific-schema are broken into sections based on the (% style="color:#e74c3c" %)level(%%) within the structure (i.e. [[data set>>doc:sdmx:Glossary.Data set.WebHome]], group, series, observation). Each section will state the rules for each variation of the structure specific format.

1096

1097

=== 3.4.1 DataSetType ===

1098

1099

A complex type named DataSetType must be created. Its content model will be derived via restriction. If the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] at the observation (% style="color:#e74c3c" %)level(%%) is the time [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] (TIME_PERIOD) the base type of the restriction is [[dsd>>doc:sdmx:Glossary.Data structure definition.WebHome]]:TimeSeriesDataSetType. Otherwise, the base type of the restriction is [[dsd>>doc:sdmx:Glossary.Data structure definition.WebHome]]:DataSetType. The complex type content model will be as follows:

1100

1101

~1. A sequence consisting of:

1102

1103

* a. An element reference to common:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]], with a minimum occurrence of 0

1104

* b. A local element named DataProvider with the type common:DataProviderReferenceType, a form of unqualified and a minimum occurrence of 0

1105

* c. If the data structure defines groups, a local element named Group with a form of unqualified, a minimum occurrence of 0, and a maximum occurrence of unbounded. The type of this element should be the type that is described in the GroupType section which follows.

1106

* d. A choice with a minimum occurrence of 0 consisting of:

1107

** i. If the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] at the observation (% style="color:#e74c3c" %)level(%%) is not AllDimensions, a local element named Series with a form of unqualified, a maximum occurrence of unbounded, and a type of SeriesType (as defined in the SeriesType section which follows)

1108

** ii. If the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] at the observation (% style="color:#e74c3c" %)level(%%) is AllDimensions, a local element named Obs with a form of unqualified, a maximum occurrence of unbounded, and a type of ObsType (as defined in the ObsType section which follows)

1109

1110

2. If the reporting year start day [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is not declared in the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] or if it is declared but does not declare an [[attribute relationship>>doc:sdmx:Glossary.Attribute relationship.WebHome]] of None, an [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] named REPORTING_YEAR_START_DAY with a type of xs:gMonthDay and a usage of prohibited

1111

3. An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] for each [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] defined in the [[data structured definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] that declares an [[attribute relationship>>doc:sdmx:Glossary.Attribute relationship.WebHome]] of None. The XML [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] name and type are defined according to the general rules defined in the previous section, and the usage is optional

1112

1113

=== 3.4.2 GroupType ===

1114

1115

If the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] defines only one group, a complex type with its name taken from the identifier of the lone group must be defined. This type is used for the Group element in the DataSetType. Its content model will be derived via restriction of the [[dsd>>doc:sdmx:Glossary.Data structure definition.WebHome]]:GroupType. The complex type content model will be as follows:

1116

1117

~1. A sequence consisting of:

1118

1119

* a. An element reference to common:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]], with a minimum occurrence of 0

1120

1121

2. An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] for each [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] referenced by the group. The XML [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] name and type are defined according to the general rules defined in the previous section, and the usage is required

1122

3. If the reporting year start day [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is not declared in the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] or if it is declared but does not declare an [[attribute relationship>>doc:sdmx:Glossary.Attribute relationship.WebHome]] with the group and does not specify the group as an attachment group, an [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] named REPORTING_YEAR_START_DAY with a type of xs:gMonthDay and a usage of prohibited

1123

4. An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] for each [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] defined in the data structure that declares an [[attribute relationship>>doc:sdmx:Glossary.Attribute relationship.WebHome]] with the group or specifies the group as an attachment group. The XML [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] name and type are defined according to the general rules defined in the previous section, and the usage is optional

1124

5. An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] named type with a type of common:IDType, usage of optional, and a fixed value of the identifier of the group

1125

1126

If the [[data structure definitions>>doc:sdmx:Glossary.Data structure definition.WebHome]] defines more than one group, an abstract complex type with name GroupType must be created. This type is used for the Group element in the DataSetType. Its content model will be derived via restriction of the [[dsd>>doc:sdmx:Glossary.Data structure definition.WebHome]]:GroupType. The complex type content model will be as follows:

1127

1128

~1. A sequence consisting of:

1129

1130

* a. An element reference to common:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]], with a minimum occurrence of 0

1131

1132

2. An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] named type with a type of Group.ID, and a usage of optional

1133

3. An anyAttribute declaration with a namespace of local

1134

1135

A simple type named Group.ID must be created. This should restrict the common:IDType. For each group defined by the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]], an enumeration will be created within the restriction with a value of the group identifier.

1136

1137

For each group defined in the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]], a complex type with its name taken from the group identifier is defined. Its content model will be derived via restriction of the previously defined GroupType. The complex type content model will be as follows:

1138

1139

~1. A sequence consisting of:

1140

1141

* a. An element reference to common:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]], with a minimum occurrence of 0

1142

1143

2. An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] for each [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] referenced by the group. The XML [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] name and type are defined according to the general rules defined in the previous section, and the usage is required

1144

3. If the reporting year start day [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is not declared in the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] or if it is declared but does not declare an [[attribute relationship>>doc:sdmx:Glossary.Attribute relationship.WebHome]] with the group and does not specify the group as an attachment group, an [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] named REPORTING_YEAR_START_DAY with a type of xs:gMonthDay and a usage of prohibited

1145

4. An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] for each [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] defined in the data structure that declares an [[attribute relationship>>doc:sdmx:Glossary.Attribute relationship.WebHome]] with the group or specifies the group as an attachment group. The XML [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] name and type are defined according to the general rules defined in the previous section, and the usage is optional

1146

5. An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] named type with a type of Group.ID, usage of optional, and a fixed value of the identifier of the group

1147

1148

=== 3.4.3 SeriesType ===

1149

1150

If the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] at the observation is not AllDimensions, a complex type name SeriesType must be created. Its content model will be derived via restriction. If the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] at the observation (% style="color:#e74c3c" %)level(%%) is the time [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] (TIME_PERIOD) the base type of the restriction is [[dsd>>doc:sdmx:Glossary.Data structure definition.WebHome]]:TimeSeriesType. Otherwise, the base type of the restriction is [[dsd>>doc:sdmx:Glossary.Data structure definition.WebHome]]:SeriesType. The complex type content model will be as follows:

1151

1152

~1. A sequence consisting of:

1153

1154

* a. An element reference to common:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]], with a minimum occurrence of 0

1155

1156

2. A local element named Obs with a form of unqualified, a minimum occurrence of 0, a maximum occurrence of unbounded, and a type of ObsType (as defined in the ObsType section which follows)

1157

3. An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] for each [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] defined by the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]], except for the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] at the observation (% style="color:#e74c3c" %)level(%%). The XML [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] name and type are defined according to the general rules defined in the previous section, and the usage is required

1158

4. If the reporting year start day [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is not declared in the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] or if it is declared and declares an [[attribute relationship>>doc:sdmx:Glossary.Attribute relationship.WebHome]] of None, or with a group, or the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] at the observation (% style="color:#e74c3c" %)level(%%), or specifies a group as an attachment group, an [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] named REPORTING_YEAR_START_DAY with a type of xs:gMonthDay and a usage of prohibited

1159

5. An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] for each [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] defined in the data structure that declares an [[attribute relationship>>doc:sdmx:Glossary.Attribute relationship.WebHome]] with any [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] outside of the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] at the observation (% style="color:#e74c3c" %)level(%%) (so long as it does not also declare an attachment group). The XML [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] name and type are defined according to the general rules defined in the previous section, and the usage is optional.

1160

1161

=== 3.4.4 ObsType ===

1162

1163

A complex type name ObsType must be created. Its content model will be derived via restriction. If the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] at the observation (% style="color:#e74c3c" %)level(%%) is the time [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] (TIME_PERIOD) the base type of the restriction is [[dsd>>doc:sdmx:Glossary.Data structure definition.WebHome]]:TimeSeriesObsType. Otherwise, the base type of the restriction is [[dsd>>doc:sdmx:Glossary.Data structure definition.WebHome]]:ObsType. If the explicit [[measure>>doc:sdmx:Glossary.Measure.WebHome]] option is used, this complex type must be abstract. The complex type content model will be as follows:

1164

1165

~1. A sequence consisting of:

1166

1167

* a. An element reference to common:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]], with a minimum occurrence of 0

1168

1169

2. If the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] at the observation (% style="color:#e74c3c" %)level(%%) is not the time [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] (TIME_PERIOD) an [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] named TIME_PERIOD with a type of common:TimePeriodType and a usage of prohibited

1170

3. If the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] at the observation (% style="color:#e74c3c" %)level(%%) is not the time [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] (TIME_PERIOD) an [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] for the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] at the observation (% style="color:#e74c3c" %)level(%%). The XML [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] name and type are defined according to the general rules defined in the previous section, and the usage is required

1171

4. An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] for the primary [[measure>>doc:sdmx:Glossary.Measure.WebHome]] (OBS_VALUE) defined by the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]. The XML [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] name and type is defined according to the general rules defined in the previous section, and the usage is optional

1172

5. An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] for each [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] defined in the data structure that declares an [[attribute relationship>>doc:sdmx:Glossary.Attribute relationship.WebHome]] with the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] at the observation (% style="color:#e74c3c" %)level(%%) or the primary [[measure>>doc:sdmx:Glossary.Measure.WebHome]] (OBS_VALUE). The XML [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] name and type are defined according to the general rules defined in the previous section, and the usage is optional

1173

1174

An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] named type. If the explicit [[measure>>doc:sdmx:Glossary.Measure.WebHome]] option is not used, this [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] must have a type of common:IDType and a usage of prohibited. If the explicit [[measure>>doc:sdmx:Glossary.Measure.WebHome]] option is used, this [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] must have a type of the simple type generated for the [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of the [[measure>>doc:sdmx:Glossary.Measure.WebHome]] [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] that is the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] at the observation (% style="color:#e74c3c" %)level(%%) (this will be an simple type with enumerations with values of the (% style="color:#e74c3c" %)concept(%%) identifiers which make up the [[concept scheme>>doc:sdmx:Glossary.Concept scheme.WebHome]] that is the [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of the [[measure>>doc:sdmx:Glossary.Measure.WebHome]] [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]) a and a usage of optional

1175

1176

If the explicit [[measure>>doc:sdmx:Glossary.Measure.WebHome]] option is used, then complex type must be created for every (% style="color:#e74c3c" %)concept(%%) which make up the [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of the [[measure>>doc:sdmx:Glossary.Measure.WebHome]] [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] which is the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] at the observation (% style="color:#e74c3c" %)level(%%). The name of this complex type will be taken from the identifier of the (% style="color:#e74c3c" %)concept(%%). Its content model will be derived via restriction of the ObsType. The complex type content model will be as follows:

1177

1178

~1. A sequence consisting of:

1179

1180

* a. An element reference to common:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]], with a minimum occurrence of 0

1181

1182

2. If the core [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of the (% style="color:#e74c3c" %)Concept(%%) differs from that of the primary [[measure>>doc:sdmx:Glossary.Measure.WebHome]], an [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] for the primary [[measure>>doc:sdmx:Glossary.Measure.WebHome]] (OBS_VALUE) defined by the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]], except for the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] at the observation (% style="color:#e74c3c" %)level(%%). The XML name is defined according to the general rules defined in the previous section, and the usage is optional. The type of the [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is the type that is generated for the core [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of the [[measure>>doc:sdmx:Glossary.Measure.WebHome]] (% style="color:#e74c3c" %)concept(%%). Note that this [[representation>>doc:sdmx:Glossary.Representation.WebHome]] type must have an explicit derivation from the type resulting from the primary [[measure>>doc:sdmx:Glossary.Measure.WebHome]]. For example, if the primary [[measure>>doc:sdmx:Glossary.Measure.WebHome]] type is xyz:CodeType, then the simple type which is defined for the core [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of the (% style="color:#e74c3c" %)concept(%%) must restrict xyz:CodeType or one another type which restricts it

1183

1184

3. An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] named type with a type of the simple type generated for the [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of the [[measure>>doc:sdmx:Glossary.Measure.WebHome]] [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] that is the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] at the observation (% style="color:#e74c3c" %)level(%%), a usage of optional, and a fixed value of the (% style="color:#e74c3c" %)concept(%%) identifier.

1185

1186

== 3.5 Metadata Structure Specific Schema ==

1187

1188

One schema will be created for each metadata structure. This schema will define the contents of all report structures defined by the metadata structure. The recommended target namespace of the data structured specific schema is the URN of the metadata structure.

1189

1190

The rules for generating the data structure specific-schema are broken into sections based on the (% style="color:#e74c3c" %)level(%%) within the structure (i.e. [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]], metadata targets, reports, metadata [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]). These rules will recommend names for generated types, and will refer back to these names throughout the description. These names are simply recommendations that should produce a unique name, but there is no requirement to use them. When a name is required, it will be made clear this is the case.

1191

1192

=== 3.5.1 MetadataSetType ===

1193

1194

A complex type that must be named MetadataSetType must be created. Its content model will be derived via restriction of the base type, [[msd>>doc:sdmx:Glossary.Metadata structure definition.WebHome]]:MetadataSetType. The complex type content model will be as follows:

1195

1196

~1. A sequence consisting of:

1197

1198

* a. An element reference to common:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]], with a minimum occurrence of 0

1199

* b. An element reference to common:Name, with a minimum occurrence of 0 and a maximum occurrence of unbounded

1200

* c. A local element named DataProvider with the type common:DataProviderReferenceType, a form of unqualified and a minimum occurrence of 0

1201

* d. A local element named Report with a type ReportType, a form of unqualified, a minimum occurrence of 0, and a maximum occurrence of unbounded.

1202

1203

=== 3.5.2 TargetType ===

1204

1205

An abstract complex type with a recommended name of TargetType must be created. Its content model will be derived via restriction of the [[msd>>doc:sdmx:Glossary.Metadata structure definition.WebHome]]:TargetType. The complex type content model will be as follows:

1206

1207

~1. A sequence consisting of:

1208

1209

* a. A local element named ReferenceValue with a type of [[msd>>doc:sdmx:Glossary.Metadata structure definition.WebHome]]:ReferenceValueType, a form of unqualified, and a maximum occurrence of unbounded

1210

1211

2. An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] named id with a type of Target.ID, and a usage of optional

1212

1213

A simple type with a recommended name of Target.ID must be created. This should restrict the common:IDType. For each report structure defined by the [[metadata structure definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]], an enumeration will be created within the restriction with a value of the report structure identifier.

1214

1215

A simple type with a recommended name of [metadata target identifier].TargetObject.ID must be created. This should restrict the Target.ID type. For each target object defined by the metadata target, an enumeration will be created within the restriction with a value of the target object identifier.

1216

1217

An abstract complex type with a recommended name of [metadata target identifier].ReferenceValueType will be created. Its content model will be derived via restriction of the [[msd>>doc:sdmx:Glossary.Metadata structure definition.WebHome]]:ReferenceValueType. The complex type content model will be as follows:

1218

1219

~1. A choice consisting of:

1220

1221

* a. A local element named ObjectReference with a type of common:ReferenceType, and a form of unqualified

1222

* b. A local element named DataKey with a type of common:DataKeyType, and a form of unqualified

1223

* c. A local element named DataSetReference with a type of common:SetReferenceType, and a form of unqualified

1224

* d. A local element named ReportPeriod with a type of common:ObservationalTimePeriodType, and a form of unqualified

1225

1226

2. An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] named id with the type defined previously as [metadata target identifier].TargetObject.ID, and a usage of optional

1227

1228

For each metadata target defined in the [[metadata structure definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]], a content group with a recommended name of [metadata target identifier] with be defined. Its content model will be as follows:

1229

1230

~1. A sequence consisting of:

1231

1232

* a. A local element named ReferenceValue with the type previously defined as [metadata target identifier].ReferenceValueType, a form of unqualified, and a minimum and maximum occurrence of the number of target objects defined within the metadata target

1233

1234

For each target object defined by the metadata target, a complex type that must be named [metadata target identifier].[target object identifier] must be created. Its content model will be derived via restriction of the type previously created as [metadata target identifier].ReferenceValueType type created prior to this. The complex type content model will be as follows:

1235

1236

~1. A choice consisting of:

1237

1238

* a. If the target object is an identifiable object target, a local element named ObjectReference with a type determined as defined in Identifiable Object Target Type Determination:

1239

* b. If the target object is an key descriptor values target, a local element named DataKey with a type of common:DataKeyType, and a form of unqualified

1240

* c. If the target object is a [[data set>>doc:sdmx:Glossary.Data set.WebHome]] target, a local element named DataSetReference with a type of common:SetReferenceType, and a form of unqualified

1241

* d. If the target object is a (% style="color:#e74c3c" %)constraint(%%) target, a local element named ConstraintReference with a type of common:AttachmentConstraintReferenceType, and a form of unqualified

1242

* e. If the target object is report period target, a local element named ReportPeriod with a form of unqualified, and a [[type>>path:#_Simple_/_Primitive]] as defined based on the data type of the local [[representation>>doc:sdmx:Glossary.Representation.WebHome]] according to the general rules defined in the previous section

1243

1244

2. An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] named id with a type previously created as [metadata target identifier].TargetObject.ID, a usage of optional, and fixed value of the target object identifier

1245

1246

The final complex type (which will be the determined type) is derived by restriction from the reference type determined above. The suggested name of this type is [metadata target identifier].[target object identifier].Reference. The content model of this type will be as follows:

1247

1248

~1. A choice consisting of:

1249

1250

* a. A sequence consisting of

1251

** i. A local element named Ref, with a form of unqualified and a the type defined above as is [metadata target].[target object].Ref

1252

** ii. A local element named URN, with a form of unqualified, a minimum occurrence of 0, and the type defined above as ~[[[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] agency].~[[[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] identifier].~[[[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] (% style="color:#e74c3c" %)version(%%)].URN

1253

* b. A local element named URN, with a form of unqualified, and the type defined above as ~[[[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] agency].~[[[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] identifier].~[[[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] (% style="color:#e74c3c" %)version(%%)].URN

1254

1255

==== 3.5.2.1 Identifiable Object Target Type Determination ====

1256

1257

An identifiable object target is meant to reference an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] identifiable object. In the metadata structure specific schema, the complex type which defines the reference is restricted according to the local [[representation>>doc:sdmx:Glossary.Representation.WebHome]] and object type of the identifiable object target. If the identifiable object target does not provide an enumeration in its local [[representation>>doc:sdmx:Glossary.Representation.WebHome]], then the complex type for the target object is the specific reference type from the common namespace, based on the object type defined by the target object. For example, if the object type is DataProivder, the type will be common:DataProviderReferenceType. The general rule for the name of this type is common:[object type]ReferenceType.

1258

1259

If the target object defines an enumeration in its local [[representation>>doc:sdmx:Glossary.Representation.WebHome]], then the declared object type must be for the items contained the enumeration's referenced [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]]. If this is not true, the reference type as defined above is the type for the target object.

1260

1261

If the object type does correspond with the enumeration [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]], then the type is complex type which restricts the reference to the allowable values. In order to construct this type, the following must be created:

1262

1263

A simple type which enumerates with URNs of the items contained in the [[items scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] referenced from the enumeration. The recommended name is ~[[[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] agency].~[[[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] identifier].~[[[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] (% style="color:#e74c3c" %)version(%%)].URN. This simple type should restrict the xs:anyURI type an contain enumerations with values of the URN of every item defined by the scheme.

1264

1265

A second simple type which enumerates the IDs of the items contained in the [[items scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] referenced from the enumeration. The recommended name is ~[[[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] agency].~[[[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] identifier].~[[[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] (% style="color:#e74c3c" %)version(%%)].ID. This simple type should restrict the either the common:NestedIDType for hierarchical items or the common:IDType for flat items. The restriction should contain enumerations with values of the ID of every item defined by the scheme. For hierarchical items (such as [[categories>>doc:sdmx:Glossary.Category.WebHome]]), the id should be nested to reflect the full path (e.g. A.C.D.F).

1266

1267

A complex type which restricts the full set of reference fields for the item to be reference must be created. The recommended name is [metadata target].[target object].Ref. This type is derived via restriction of the type which defines the full set of reference fields for the item referenced by the target object. For example, if the object type is [[Category>>doc:sdmx:Glossary.Category.WebHome]], the type that is the base of the restriction is common:CategoryRefType. . The general rule for the name of this type is common:[object type]RefType. The content model of this type must be as follows:

1268

1269

1. An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] named agencyID with a type of common:NestNCNameIDType, a use of required, and a fixed value of the [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] referenced from the enumeration

1270

1. An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] named maintinableParentID with a type of common:IDType, a use of required, and a fixed value of the identifier of the [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] referenced from the enumeration

1271

1. An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] named maintainableParentVersion with a type of common:VersionType, a use of optional, and a fixed value of the (% style="color:#e74c3c" %)version(%%) of the [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] referenced from the enumeration

1272

1. An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] named id, with a use of option, and the type defined above as ~[[[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] agency].~[[[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] identifier].~[[[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] (% style="color:#e74c3c" %)version(%%)].ID.

1273

1274

=== 3.5.3 ReportType ===

1275

1276

A simple type with a recommend name of Report.ID must be created. This must restrict the common:IDType. For each report structure defined by the [[metadata structure definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]], an enumeration will be created within the restriction with a value of the report structure identifier.

1277

1278

An abstract complex type with a recommended name of ReportType must be created. Its content model will be derived via restriction of the [[msd>>doc:sdmx:Glossary.Metadata structure definition.WebHome]]:ReportType. The complex type content model will be as follows:

1279

1280

~1. A sequence consisting of:

1281

1282

* a. An element reference to common:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]], with a minimum occurrence of 0

1283

* b. A local element named Target with the type previously defined as TargetType and a form of unqualified

1284

* c. A local element named AttributeSet with no type assigned and a form of unqualified

1285

1286

2. An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] named id with a type previously defined as Report.ID, and a usage of optional

1287

1288

For each report structure defined in the [[metadata structure definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]], a complex type with its name taken from the report structure identifier must be defined. In order to construct this type, some other complex type must be defined first.

1289

1290

A simple type with a recommended name of [report structure identifier].Target.ID must be created. This must restrict the type previously created as Target.ID. For each metadata target referenced by the report structure, an enumeration will be created within the restriction with a value of the metadata target identifier.

1291

1292

An abstract complex type must be create, with a recommended name of [report structure identifier].TargetType. Its content model will be derived by restriction of the type previously created as TargetType. The content model of this type must be as follows:

1293

1294

~1. A sequence consisting of:

1295

1296

* a. A local element named ReferenceValue with a type of [[msd>>doc:sdmx:Glossary.Metadata structure definition.WebHome]]:ReferenceValueType, a form of unqualified, and a maximum occurrence of unbounded

1297

1298

2. An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] named id with the type previously created as [report structure identifier].Target.ID, and a use of optional

1299

1300

For each metadata target referenced from the report structure, a complex type that must be named [report structure identifier].[metadata target identifier] must be created. This type must derived its content by restriction of the type previously defined as [report structure identifier].TargetType. The content model is as follows:

1301

1302

1. A reference to the content group that was previously created as [metadata target identifier] for this metadata target

1303

1. An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] named id with the type create previously as [report structure identifier].Target.ID, a use of optional, and a fixed value of [metadata target identifier]

1304

1305

For every metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] defined by the report structure a complex type must be created with the recommended name of [report structure identifier].[nested metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] identifier]. Note that the recommend name assumes the metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] identifier is the nested identifier for the full [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]] in which the metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] was defined. This content model of this type is derived from restriction of the [[msd>>doc:sdmx:Glossary.Metadata structure definition.WebHome]]:ReportedAttributeType. The content of this must consists be as follows:

1306

1307

~1. A sequence consisting of:

1308

1309

* a. An element reference to common:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]], with a minimum occurrence of 0

1310

* b. If the isPresentational flag is not set to true:

1311

* c. If the determined [[representation>>doc:sdmx:Glossary.Representation.WebHome]] has data type of XHTML, an element reference to common:StructuredText with a maximum occurrence of unbounded

1312

** i. If the determined [[representation>>doc:sdmx:Glossary.Representation.WebHome]] has is not XHTML, but has a [[facet>>doc:sdmx:Glossary.Facet.WebHome]] of isMultiLinguale, an element reference to common: Text with a maximum occurrence of unbounded

1313

** ii. If the metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] defines which child metadata [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]], a local element named AttributeSet with a form of unqualified, and a type as defined according to the rules defined in [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Set Complex Type Creation

1314

1315

2. An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] named id with a type of common:IDType, a use of optional, and a fixed value of [metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] identifier], where this identifier is not nested

1316

1317

If the isPresentational flag is not set to true, and the determined [[representation>>doc:sdmx:Glossary.Representation.WebHome]] is not XHTML and does not have a [[facet>>doc:sdmx:Glossary.Facet.WebHome]] of isMultiLingual, an [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] named value where the [[type>>path:#_Simple_/_Primitive]] is defined according to the general rules defined in the previous section, and the use is required

1318

1319

For each report structure defined in the metadata structure, a complex type that must be named [report structure identifier] must be created. Its content model will be derived via restriction of the previously defined ReportType. The complex type content model will be as follows:

1320

1321

~1. A sequence consisting of:

1322

1323

* a. An element reference to common:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]], with a minimum occurrence of 0

1324

* b. A local element named Target with the type previously defined as [report structure identifier].TargetType, and a form of unqualified. This element must define a uniqueness (% style="color:#e74c3c" %)constraint(%%) with a recommended name of [report structure identifier].Target.ReferenceValue.Unique. This uniqueness (% style="color:#e74c3c" %)constraint(%%) must contain:

1325

** i. A selector with an xpath of "*"

1326

** ii. A field with an xpath of "@id"

1327

* c. A local element named AttributeSet with a form of unqualified and a type as defined according to the rules defined in [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Set Complex Type Creation

1328

1329

2. An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] named id with the type previously defined as Report.ID, a use of optional, and a fixed value of [report structure identifier]

1330

1331

==== 3.5.3.1 Attribute Set Complex Type Creation ====

1332

1333

An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] set is created for a report structure or a metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] which contains child metadata [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]. This type is a complex type with a recommend name of [report structure identifier].[nested metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] identifier].AttributeSet, where the metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] section only applies to [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] sets created for metadata [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] and is assumed to consist of the full [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]] of the metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]'s definition. This complex type must consists of:

1334

1335

~1. A sequence consisting of:

1336

1337

* a. A local element for each metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] defined as a direct child of the object for which the [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] set is being created. The recommended name of this element is [metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] identifier] and it has a form of unqualified. If the metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] defines a minOccurs and maxOccurs, these values are translated to this element. The type of this element is the type previously created as [report structure identifier].[nested metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] identifier].

1338

1339

= 4. Special data functions =

== 4.1 Updates ==

Both the generic and the structure-specific data messages allow for incremental updating of data. This purpose is noted in the action for the [[data set>>doc:sdmx:Glossary.Data set.WebHome]], which is either inherited from the header of the data message or explicitly stated at the [[data set>>doc:sdmx:Glossary.Data set.WebHome]] (% style="color:#e74c3c" %)level(%%).

1344

1345

A [[dataset>>doc:sdmx:Glossary.Data set.WebHome]] with an action of Append is assumed to be an [[incremental update>>doc:sdmx:Glossary.Incremental update.WebHome]]. This means that one the information provided explicitly in the message should be altered. Any data [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] or [[observation value>>doc:sdmx:Glossary.Observation value.WebHome]] that is to be changed must be provided. However, the absence of an [[observation value>>doc:sdmx:Glossary.Observation value.WebHome]] or a data [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] at any (% style="color:#e74c3c" %)level(%%) does not imply deletion; instead it is simply implied that the value is to remain unchanged. Therefore, it is valid and acceptable to send a data message with an action of Append which contains only a Series elements with [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] values. In this case, the values for the [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] will be updated. Note that it is not permissible to update data [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] using partial keys (outside of those associated with defined groups). In order to update an [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], a full key must always be provided even if the message format does not require this.

== 4.2 Deletes ==

Both the generic and the structure-specific data messages allow for incremental deletion of data. This purpose is noted in the action for the [[data set>>doc:sdmx:Glossary.Data set.WebHome]], which is either inherited from the header of the data message or explicitly stated at the [[data set>>doc:sdmx:Glossary.Data set.WebHome]] (% style="color:#e74c3c" %)level(%%).

1350

1351

A [[dataset>>doc:sdmx:Glossary.Data set.WebHome]] with an action of Delete is assumed to be an incremental deletion. The deletion is assumed to take place of the lowest (% style="color:#e74c3c" %)level(%%) of detail provided in the message. For example, if a delete message is sent with only a [[data set>>doc:sdmx:Glossary.Data set.WebHome]] element, the entire [[data set>>doc:sdmx:Glossary.Data set.WebHome]] will be deleted. On the other hand, if that [[data set>>doc:sdmx:Glossary.Data set.WebHome]] contains a data [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], only that data [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] value will be deleted. This same dynamic continues through the [[data set>>doc:sdmx:Glossary.Data set.WebHome]] [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]]. A [[data set>>doc:sdmx:Glossary.Data set.WebHome]] containing only a series with no data [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] or observations will result in that entire series (all observations and data [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]) being deleted. If the series contains data [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]], only the supplied data [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] for that series will be deleted. Finally, if a series contains observations, then only the specified observations will be deleted. If an entire observation is to be deleted (value and data [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]), only the observation [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] should be provided. If only the [[observation value>>doc:sdmx:Glossary.Observation value.WebHome]] or particular data [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] are to be deleted, then these should be specified for the observation. Note that a group can only be used to delete the data [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] associated with it. Although the format might not require it, a full key must be provided to delete a series or observation. It is not permissible to wild card a key in order to delete more than one series or observation. Finally, to delete a data [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] or [[observation value>>doc:sdmx:Glossary.Observation value.WebHome]] it is recommended that the value to be deleted be supplied; however, it is only required that any valid value be provided.

----

Wiki source code of Part IV. Data