Skip to Content

Wiki source code of Part II.Common

Version 11.18 by Helena K. on 2025/06/29 21:47
Show last authors
1 {{box title="**Contents**"}}
2 {{toc/}}
3 {{/box}}
4
5 = 1. Introduction =
6
7 The common namespace defines a collection of constructs that are reused across the various [[components>>doc:sdmx:Glossary.Component.WebHome]] of [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]]. Most important of these are the referencing mechanism. The goal of the reference construct was to define a generic structure that could be processed uniformly regardless of the context where the reference was used. But it was also important that references be required to be complete whenever possible.
8
9 Any object can be referenced either explicitly with a URN or by a set of complete reference fields. To meet the previously stated requirements, and very general mechanism was created based on the URN structure of [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] objects for these reference fields.
10
11 There was also a requirement that the references be able to be refined to meet particular needs outside of the common namespace. An example of this is in the metadata structure specific schemas. It is a requirement that if an target object is specified as having to come from a particular scheme, that a type based on the reference structure be created that enforced the requirement.
12
13 Typically, this would not have been an issues as all of the [[components>>doc:sdmx:Glossary.Component.WebHome]] which make up the references are of atomic types, and therefore can be expressed as XML [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] which are easily refined and restricted since the XML Schema design principles in [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] always treats [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] as unqualified.
14
15 However, the requirement to allow both a URN and/or a complete set of reference field necessitate that these properties be contained in elements. The fact that they are elements typically would mean that the only way a refinement outside of the namespace could happen was if the element were global and allowed for substitutions. This however would mean that every distinct type of referenced object would have a unique set of elements. This moved away from the requirement that the structure be easy to process regardless of context.
16
17 The solution to this problem was to deviate from the normal [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] XML Schema design principle of always using qualified elements and allowing for these to be unqualified. Doing so allows other namespace to derive from these types and place further restrictions on what can be referenced. The deviation from this principle was justified in that it met the all of the requirements and was not deemed to major of a shift since these properties normally would have been expressed as unqualified [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] if it weren't for the complete reference requirement.
18
19 = 2Schema Documentation =
20
21 == 2.1Common Namespace ==
22
23 **http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/common**
24
25 === 2.1.1Summary ===
26
27 Referenced Namespaces:
28
29 |**Namespace**|**Prefix**
30 | |
31 |http:~/~/www.w3.org/1999/xhtml|
32 |http:~/~/www.w3.org/2001/XMLSchema|xs
33
34 Contents:
35
36 81 Global Elements
37 292 Complex Types
38 77 Simple Types
39
40 === 2.1.2Global Elements ===
41
42 **Name (TextType): **Name is a reusable element, used for providing a human-readable name for an object.
43
44 **Description (TextType): **Description is a reusable element, used for providing a longer human-readable description of an object.
45
46 **Text (TextType): **Text is a reusable element, used for providing a language specific text value for general purposes (i.e. not for a name or description).
47
48 **StructuredText (XHTMLType): **StructuredText is a reusable element, used for providing a language specific text value structured as XHTML.
49
50 **Annotations (AnnotationsType): **Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
51
52 **Any (EmptyType): **Any is an empty element that denotes an object of any type.
53
54 **Agency (EmptyType): **Agency is an empty element that denotes an agency object.
55
56 **AgencyScheme (EmptyType): **AgencyScheme is an empty element that denotes an agency scheme object.
57
58 **AttachmentConstraint (EmptyType): **AttachmentConstraint is an empty element that denotes an attachment constraint object.
59
60 **Attribute (EmptyType): **Attribute is an empty element that denotes an attribute object.
61
62 **AttributeDescriptor (EmptyType): **AttributeDescriptor is an empty element that denotes an attribute descriptor object.
63
64 **Categorisation (EmptyType): **Categorisation is an empty element that denotes a categorisation object.
65
66 **Category (EmptyType): **Category is an empty element that denotes a category object.
67
68 **CategorySchemeMap (EmptyType): **CategorySchemeMap is an empty element that denotes a category scheme map object.
69
70 **CategoryScheme (EmptyType): **CategoryScheme is an empty element that denotes a category scheme object.
71
72 **Code (EmptyType): **Code is an empty element that denotes a code object.
73
74 **CodeMap (EmptyType): **CodeMap is an empty element that denotes a code map object.
75
76 **Codelist (EmptyType): **Codelist is an empty element that denotes a code list object.
77
78 **CodelistMap (EmptyType): **CodelistMap is an empty element that denotes a code list map object.
79
80 **ComponentMap (EmptyType): **ComponentMap is an empty element that denotes a component map object.
81
82 **Concept (EmptyType): **Concept is an empty element that denotes a concept object.
83
84 **ConceptMap (EmptyType): **ConceptMap is an empty element that denotes a concept map object.
85
86 **ConceptScheme (EmptyType): **ConceptScheme is an empty element that denotes a concept scheme object.
87
88 **ConceptSchemeMap (EmptyType): **ConceptSchemeMap is an empty element that denotes a concept scheme map object.
89
90 **ConstraintTarget (EmptyType): **ConstraintTarget is an empty element that denotes a constraint target object.
91
92 **ContentConstraint (EmptyType): **ContentConstraint is an empty element that denotes a content constraint object.
93
94 **CustomType (EmptyType): **CustomType is an empty element that denotes a custom type object.
95
96 **CustomTypeScheme (EmptyType): **CustomTypeScheme is an empty element that denotes a custom type scheme object.
97
98 **Dataflow (EmptyType): **Dataflow is an empty element that denotes a data flow object.
99
100 **DataConsumer (EmptyType): **DataConsumer is an empty element that denotes a data consumer object.
101
102 **DataConsumerScheme (EmptyType): **DataConsumerScheme is an empty element that denotes a data consumer scheme object.
103
104 **DataProvider (EmptyType): **DataProvider is an empty element that denotes a data provider object.
105
106 **DataProviderScheme (EmptyType): **DataProviderScheme is an empty element that denotes a data provider scheme object.
107
108 **DataSetTarget (EmptyType): **DataSetTarget is an empty element that denotes a data set target object.
109
110 **DataStructure (EmptyType): **DataStructure is an empty element that denotes a data structure definition object.
111
112 **Dimension (EmptyType): **Dimension is an empty element that denotes a dimension object.
113
114 **DimensionDescriptor (EmptyType): **DimensionDescriptor is an empty element that denotes a dimension descriptor object.
115
116 **DimensionDescriptorValuesTarget (EmptyType): **DimensionDescriptorValuesTarget is an empty element that denotes a dimension descriptor values target object.
117
118 **GroupDimensionDescriptor (EmptyType): **GroupDimensionDescriptor is an empty element that denotes a group dimension descriptor object.
119
120 **HierarchicalCode (EmptyType): **HierarchicalCode is an empty element that denotes a hierarchical code object.
121
122 **HierarchicalCodelist (EmptyType): **HierarchicalCodelist is an empty element that denotes a hierarchical codelist object.
123
124 **Hierarchy (EmptyType): **Hierarchy is an empty element that denotes a hierarchy within a hiearcharchical codelist.
125
126 **HybridCodelistMap (EmptyType): **HybridCodelistMap is an empty element that denotes a hybrid codelist map object.
127
128 **HybridCodeMap (EmptyType): **HybridCodeMap is an empty element that denotes a hybrid code map object.
129
130 **IdentifiableObjectTarget (EmptyType): **IdentifiableObjectTarget is an empty element that denotes an identifiable object target object.
131
132 **Level (EmptyType): **Level is an empty element that denotes a level object.
133
134 **MeasureDescriptor (EmptyType): **MeasureDescriptor is an empty element that denotes a measure descriptor object.
135
136 **MeasureDimension (EmptyType): **MeasureDimension is an empty element that denotes a measure dimension object.
137
138 **Metadataflow (EmptyType): **Metadataflow is an empty element that denotes a metadata flow object.
139
140 **MetadataAttribute (EmptyType): **MetadataAttribute is an empty element that denotes a metadata attribute object.
141
142 **MetadataSet (EmptyType): **MetadataSet is an empty element that denotes a metadata set object.
143
144 **MetadataStructure (EmptyType): **MetadataStructure is an empty element that denotes a metadata structure definition object.
145
146 **MetadataTarget (EmptyType): **MetadataTarget is an empty element that denotes a metadata target object.
147
148 **NamePersonalisation (EmptyType): **NamePersonalisation is an empty element that denotes a name personalisation object.
149
150 **NamePersonalisationScheme (EmptyType): **NamePersonalisationScheme is an empty element that denotes a name personalisation scheme object.
151
152 **OrganisationMap (EmptyType): **OrganisationMap is an empty element that denotes an organisation map object.
153
154 **OrganisationSchemeMap (EmptyType): **OrganisationSchemeMap is an empty element that denotes an organisation scheme map object.
155
156 **OrganisationUnit (EmptyType): **OrganisationUnit is an empty element that denotes an organisation unit object.
157
158 **OrganisationUnitScheme (EmptyType): **OrganisationUnitScheme is an empty element that denotes an organisation unit scheme object.
159
160 **PrimaryMeasure (EmptyType): **PrimaryMeasure is an empty element that denotes a primary measure object.
161
162 **Process (EmptyType): **Process is an empty element that denotes a process object.
163
164 **ProcessStep (EmptyType): **ProcessStep is an empty element that denotes a process step object.
165
166 **ProvisionAgreement (EmptyType): **ProvisionAgreement is an empty element that denotes a provision agreement object.
167
168 **ReportingCategory (EmptyType): **ReportingCategory is an empty element that denotes a reporting category object.
169
170 **ReportingCategoryMap (EmptyType): **ReportingCategoryMap is an empty element that denotes a reporting category map object.
171
172 **ReportingTaxonomy (EmptyType): **ReportingTaxonomy is an empty element that denotes a reporting taxonomy object.
173
174 **ReportingTaxonomyMap (EmptyType): **ReportingTaxonomyMap is an empty element that denotes a reporting taxonomy map object.
175
176 **ReportPeriodTarget (EmptyType): **ReportPeriodTarget is an empty element that denotes a report period target object.
177
178 **ReportStructure (EmptyType): **ReportStructure is an empty element that denotes a report structure object.
179
180 **Ruleset (EmptyType): **Ruleset is an empty element that denotes a ruleset object.
181
182 **RulesetScheme (EmptyType): **RulesetScheme is an empty element that denotes a ruleset scheme object.
183
184 **StructureMap (EmptyType): **StructureMap is an empty element that denotes a structure map object.
185
186 **StructureSet (EmptyType): **StructureSet is an empty element that denotes a structure set object.
187
188 **TimeDimension (EmptyType): **TimeDimension is an empty element that denotes a time dimension object.
189
190 **Transformation (EmptyType): **Transformation is an empty element that denotes a transformation object.
191
192 **TransformationScheme (EmptyType): **TransformationScheme is an empty element that denotes a transformation scheme object.
193
194 **Transition (EmptyType): **Transition is an empty element that denotes a transition object.
195
196 **UserDefinedOperator (EmptyType): **UserDefinedOperator is an empty element that denotes an user defined operator object.
197
198 **UserDefinedOperatorScheme (EmptyType): **UserDefinedOperatorScheme is an empty element that denotes an user defined operator scheme object.
199
200 **VtlMapping (EmptyType): **VtlMapping is an empty element that denotes a VTL Mapping object.
201
202 **VtlMappingScheme (EmptyType): **VtlMappingScheme is an empty element that denotes a VTL mapping scheme object.
203
204 === 2.1.3Complex Types ===
205
206 **TextType: **TextType provides for a set of language-specific alternates to be provided for any human-readable constructs in the instance.
207
208 Derivation:
209
210 * xs:anySimpleType (restriction)
211 ** xs:string (extension)
212 *** TextType
213
214 Attributes:
215 xml:lang?
216
217 Content:
218
219 Attribute Documentation:
220
221 |**Name**|**Type**|**Documentation**
222 |xml:lang (default: en)|xs:language|The xml:lang attribute specifies a language code for the text. If not supplied, the default language is assumed to be English.
223
224 **StatusMessageType: **StatusMessageType describes the structure of an error or warning message. A message contains the text of the message, as well as an optional language indicator and an optional code.
225
226 Attributes:
227 code?
228
229 Content:
230 Text+
231
232 Attribute Documentation:
233
234 |**Name**|**Type**|**Documentation**
235 |code|xs:string|The code attribute holds an optional code identifying the underlying error that generated the message. This should be used if parallel language descriptions of the error are supplied, to distinguish which of the multiple error messages are for the same underlying error.
236
237 Element Documentation:
238
239 |**Name**|**Type**|**Documentation**
240 |Text|TextType|Text contains the text of the message, in parallel language values.
241
242 **CodedStatusMessageType: **CodedStatusMessageType describes the structure of an error or warning message which required a code.
243
244 Derivation:
245
246 * StatusMessageType (restriction)
247 ** CodedStatusMessageType
248
249 Attributes:
250 code
251
252 Content:
253 Text+
254
255 Attribute Documentation:
256
257 |**Name**|**Type**|**Documentation**
258 |code|xs:string|The code attribute holds an optional code identifying the underlying error that generated the message. This should be used if parallel language descriptions of the error are supplied, to distinguish which of the multiple error messages are for the same underlying error.
259
260 Element Documentation:
261
262 |**Name**|**Type**|**Documentation**
263 |Text|TextType|Text contains the text of the message, in parallel language values.
264
265 //**AnnotableType**//**: **AnnotableType is an abstract base type used for all annotable artefacts. Any type that provides for annotations should extend this type.
266
267 Content:
268 Annotations?
269
270 Element Documentation:
271
272 |**Name**|**Type**|**Documentation**
273 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
274
275 **AnnotationsType: **AnnotationsType provides for a list of annotations to be attached to data and structure messages.
276
277 Content:
278 Annotation+
279
280 Element Documentation:
281
282 |**Name**|**Type**|**Documentation**
283 |Annotation|AnnotationType|
284
285 **AnnotationType: **AnnotationType provides for non-documentation notes and annotations to be embedded in data and structure messages. It provides optional fields for providing a title, a type description, a URI, and the text of the annotation.
286
287 Attributes:
288 id?
289
290 Content:
291 AnnotationTitle?, AnnotationType?, AnnotationURL?, AnnotationText*
292
293 Attribute Documentation:
294
295 |**Name**|**Type**|**Documentation**
296 |id|xs:string|The id attribute provides a non-standard identification of an annotation. It can be used to disambiguate annotations.
297
298 Element Documentation:
299
300 |**Name**|**Type**|**Documentation**
301 |AnnotationTitle|xs:string|AnnotationTitle provides a title for the annotation.
302 |AnnotationType|xs:string|AnnotationType is used to distinguish between annotations designed to support various uses. The types are not enumerated, as these can be specified by the user or creator of the annotations. The definitions and use of annotation types should be documented by their creator.
303 |AnnotationURL|xs:anyURI|AnnotationURL is a URI - typically a URL - which points to an external resource which may contain or supplement the annotation. If a specific behavior is desired, an annotation type should be defined which specifies the use of this field more exactly.
304 |AnnotationText|TextType|AnnotationText holds a language-specific string containing the text of the annotation.
305
306 **ReferencePeriodType: **Specifies the inclusive start and end times.
307
308 Attributes:
309 startTime, endTime
310
311 Content:
312 {Empty}
313
314 Attribute Documentation:
315
316 |**Name**|**Type**|**Documentation**
317 |startTime|xs:dateTime|The startTime attributes contains the inclusive start date for the reference period.
318 |endTime|xs:dateTime|The endTime attributes contains the inclusive end date for the reference period.
319
320 **QueryableDataSourceType: **QueryableDataSourceType describes a data source which is accepts an standard SDMX Query message and responds appropriately.
321
322 Attributes:
323 isRESTDatasource, isWebServiceDatasource
324
325 Content:
326 DataURL, WSDLURL?, WADLURL?
327
328 Attribute Documentation:
329
330 |**Name**|**Type**|**Documentation**
331 |isRESTDatasource|xs:boolean|The isRESTDatasource attribute indicates, if true, that the queryable data source is accessible via the REST protocol.
332 |isWebServiceDatasource|xs:boolean|The isWebServiceDatasource attribute indicates, if true, that the queryable data source is accessible via Web Services protocols.
333
334 Element Documentation:
335
336 |**Name**|**Type**|**Documentation**
337 |DataURL|xs:anyURI|DataURL contains the URL of the data source.
338 |WSDLURL|xs:anyURI|WSDLURL provides the location of a WSDL instance on the internet which describes the queryable data source.
339 |WADLURL|xs:anyURI|WADLURL provides the location of a WADL instance on the internet which describes the REST protocol of the queryable data source.
340
341 **XHTMLType: **XHTMLType allows for mixed content of text and XHTML tags. When using this type, one will have to provide a reference to the XHTML schema, since the processing of the tags within this type is strict, meaning that they are validated against the XHTML schema provided.
342
343 Attributes:
344 xml:lang?
345
346 Content:
347 {text} x {any element with namespace of http:~/~/www.w3.org/1999/xhtml}*
348
349 Attribute Documentation:
350
351 |**Name**|**Type**|**Documentation**
352 |xml:lang (default: en)|xs:language|
353
354 //**RegionType**//**: **RegionType is an abstract type which defines a generic constraint region. This type can be refined to define regions for data or metadata sets. A region is defined by a collection of key values - each of which a collection of values for a component which disambiguates data or metadata (i.e. dimensions or the target objects of a metadata target). For each region, as collection of attribute values can be provided. Taken together, the key values and attributes serve to identify or describe a subset of a data or metadata set. Finally, the region can flagged as being included or excluded, although this flag only makes sense when the region is used in a particular context.
355
356 Attributes:
357 include?
358
359 Content:
360 KeyValue*, Attribute*
361
362 Attribute Documentation:
363
364 |**Name**|**Type**|**Documentation**
365 |include (default: true)|xs:boolean|The include attribute indicates that the region is to be included or excluded within the context in which it is defined. For example, if the regions is defined as part of a content constraint, the exclude flag would mean the data identified by the region is not present.
366
367 Element Documentation:
368
369 |**Name**|**Type**|**Documentation**
370 |KeyValue|//ComponentValueSetTyp e//|KeyValue contains a reference to a component which disambiguates the data or metadata (i.e. a dimension or target object) and provides a collection of values for the component. The collection of values can be flagged as being inclusive or exclusive to the region being defined. Any key component that is not included is assumed to be wild carded, which is to say that the cube includes all possible values for the un-referenced key components. Further, this assumption applies to the values of the components as well. The values for any given component can only be sub-setted in the region by explicit inclusion or exclusion. For example, a dimension X which has the possible values of 1, 2, 3 is assumed to have all of these values if a key value is not defined. If a key value is defined with an inclusion attribute of true and the values of 1 and 2, the only the values of 1 and 2 for dimension X are included in the definition of the region. If the key value is defined with an inclusion attribute of false and the value of 1, then the values of 2 and 3 for dimension X are included in the definition of the region. Note that any given key component must only be referenced once in the region.
371 |Attribute|//ComponentValueSetTyp e//|Attributes contains a reference to an attribute component (data or metadata) and provides a collection of values for the referenced attribute. This serves to state that for the key which defines the region, the attributes that are specified here have or do not have (depending to the include attribute of the value set) the values provided. It is possible to provide and attribute reference without specifying values, for the purpose of stating the attribute is absent (include = false) or present with an unbounded set of values. As opposed to key components, which are assumed to be wild carded if absent, no assumptions are made about the absence of an attribute. Only attributes which are explicitly stated to be present or absent from the region will be know. All unstated attributes for the set cannot be assumed to absent or present.
372
373 //**ComponentValueSetType**//**: **ComponentValueSetType is an abstract base type which is used to provide a set of value for a referenced component. Implementations of this type will be based on a particular component type and refine the allowed values to reflect the types of values that are possible for that type of component.
374
375 Attributes:
376 id, include?
377
378 Content:
379 (Value+ | DataSet+ | DataKey+ | Object+ | TimeRange)?
380
381 Attribute Documentation:
382
383 |**Name**|**Type**|**Documentation**
384 |id|NestedNCNameIDType|The id attribute provides the identifier for the component for which values are being provided. This base type allows for a nested identifier to be provided, for the purpose of referencing a nested component (i.e. a metadata attribute). However, specific implementations will restrict this representation to only allow single level identifiers where appropriate.
385 |include (default: true)|xs:boolean|The include attribute indicates whether the values provided for the referenced component are to be included are excluded from the region in which they are defined.
386
387 Element Documentation:
388
389 |**Name**|**Type**|**Documentation**
390 |Value|SimpleValueType|Value provides a simple value for the component, such as a coded, numeric, or simple text value. This type of component value is applicable for dimensions and attributes.
391 |DataSet|SetReferenceType|DataSet provides a reference to a data set and is used to state a value for the data set target component in a metadata target.
392 |DataKey|DataKeyType|DataKey provides a set of dimension references and value, which form a full or partial data key. This is used to state a value for the key descriptor values target component in a metadata target.
393 |Object|ObjectReferenceType|Object provides a reference to an Identifiable object in the SDMX Information Model. This is used to state a value for an identifiable target component in a metadata target.
394 |TimeRange|TimeRangeValueType|TimeValue provides a value for a component which has a time representation. This is repeatable to allow for a range to be specified, although a single value can also be provided. An operator is available on this to indicate whether the specified value indicates an exact value or the beginning/end of a range (inclusive or exclusive).
395
396 //**DistinctKeyType**//**: **DistinctKeyType is an abstract base type which is a special type of region that only defines a distinct region of data or metadata. For each component defined in the region, only a single values is provided. However, the same rules that apply to the general region about unstated components being wild carded apply here as well. Thus, this type can define a distinct full or partial key for data or metadata.
397
398 Derivation:
399
400 * //RegionType// (restriction)
401 ** //DistinctKeyType//
402
403 Attributes:
404 include?
405
406 Content:
407 KeyValue+
408
409 Attribute Documentation:
410
411 |**Name**|**Type**|**Documentation**
412 |include (fixed: true)|xs:boolean|The include attribute has a fixed value of true for a distinct key, since such a key is always assumed to identify existing data or metadata.
413
414 Element Documentation:
415
416 |**Name**|**Type**|**Documentation**
417 |KeyValue|//DinstinctKeyValueTyp e//|KeyValue contains a reference to a component which disambiguates the data or metadata (i.e. a dimension or target object) and provides a collection of values for the component. The collection of values can be flagged as being inclusive or exclusive to the region being defined. Any key component that is not included is assumed to be wild carded, which is to say that the cube includes all possible values for the un-referenced key components. Further, this assumption applies to the values of the components as well. The values for any given component can only be sub-setted in the region by explicit inclusion or exclusion. For example, a dimension X which has the possible values of 1, 2, 3 is assumed to have all of these values if a key value is not defined. If a key value is defined with an inclusion attribute of true and the values of 1 and 2, the only the values of 1 and 2 for dimension X are included in the definition of the region. If the key value is defined with an inclusion attribute of false and the value of 1, then the values of 2 and 3 for dimension X are included in the definition of the region. Note that any given key component must only be referenced once in the region.
418
419 //**DinstinctKeyValueType**//**: **DinstinctKeyValueType is an abstract base type which defines a singular, required value for a key component.
420
421 Derivation:
422
423 * //ComponentValueSetType// (restriction)
424 ** //DinstinctKeyValueType//
425
426 Attributes:
427 id, include?
428
429 Content:
430 (Value | DataSet | DataKey | Object)
431
432 Attribute Documentation:
433
434 |**Name**|**Type**|**Documentation**
435 |id|SingleNCNameIDType|The id attribute provides the identifier for the component for which values are being provided. This base type allows for a nested identifier to be provided, for the purpose of referencing a nested component (i.e. a metadata attribute). However, specific implementations will restrict this representation to only allow single level identifiers where appropriate.
436 |include (fixed: true)|xs:boolean|The include attribute indicates whether the values provided for the referenced component are to be included are excluded from the region in which they are defined.
437
438 Element Documentation:
439
440 |**Name**|**Type**|**Documentation**
441 |Value|SimpleKeyValueType|Value provides a simple value for the component, such as a coded, numeric, or simple text value. This type of component value is applicable for dimensions and attributes.
442 |DataSet|SetReferenceType|DataSet provides a reference to a data set and is used to state a value for the data set target component in a metadata target.
443 |DataKey|DataKeyType|DataKey provides a set of dimension references and value, which form a full or partial data key. This is used to state a value for the key descriptor values target component in a metadata target.
444 |Object|ObjectReferenceType|Object provides a reference to an Identifiable object in the SDMX Information Model. This is used to state a value for an identifiable target component in a metadata target.
445
446 **DataKeyType: **DataKeyType is a region which defines a distinct full or partial data key. The key consists of a set of values, each referencing a dimension and providing a single value for that dimension. The purpose of the key is to define a subset of a data set (i.e. the observed value and data attribute) which have the dimension values provided in this definition. Any dimension not stated explicitly in this key is assumed to be wild carded, thus allowing for the definition of partial data keys.
447
448 Derivation:
449
450 * //RegionType// (restriction)
451 ** //DistinctKeyType// (restriction)
452 *** DataKeyType
453
454 Attributes:
455 include?
456
457 Content:
458 KeyValue+
459
460 Attribute Documentation:
461
462 |**Name**|**Type**|**Documentation**
463 |include (fixed: true)|xs:boolean|The include attribute has a fixed value of true for a distinct key, since such a key is always assumed to identify existing data or metadata.
464
465 Element Documentation:
466
467 |**Name**|**Type**|**Documentation**
468 |KeyValue|DataKeyValueType|KeyValue contains a reference to a component which disambiguates the data or metadata (i.e. a dimension or target object) and provides a collection of values for the component. The collection of values can be flagged as being inclusive or exclusive to the region being defined. Any key component that is not included is assumed to be wild carded, which is to say that the cube includes all possible values for the un-referenced key components. Further, this assumption applies to the values of the components as well. The values for any given component can only be sub-setted in the region by explicit inclusion or exclusion. For example, a dimension X which has the possible values of 1, 2, 3 is assumed to have all of these values if a key value is not defined. If a key value is defined with an inclusion attribute of true and the values of 1 and 2, the only the values of 1 and 2 for dimension X are included in the definition of the region. If the key value is defined with an inclusion attribute of false and the value of 1, then the values of 2 and 3 for dimension X are included in the definition of the region. Note that any given key component must only be referenced once in the region.
469
470 **DataKeyValueType: **DataKeyValueType is a type for providing a dimension value for the purpose of defining a distinct data key. Only a single value can be provided for the dimension.
471
472 Derivation:
473
474 * //ComponentValueSetType// (restriction)
475 ** //DinstinctKeyValueType// (restriction)
476 *** DataKeyValueType
477
478 Attributes:
479 id, include?
480
481 Content:
482 Value
483
484 Attribute Documentation:
485
486 |**Name**|**Type**|**Documentation**
487 |id|SingleNCNameIDType|The id attribute provides the identifier for the component for which values are being provided. This base type allows for a nested identifier to be provided, for the purpose of referencing a nested component (i.e. a metadata attribute). However, specific implementations will restrict this representation to only allow single level identifiers where appropriate.
488 |include (fixed: true)|xs:boolean|The include attribute indicates whether the values provided for the referenced component are to be included are excluded from the region in which they are defined.
489
490 Element Documentation:
491
492 |**Name**|**Type**|**Documentation**
493 |Value|SimpleKeyValueType|Value provides a simple value for the component, such as a coded, numeric, or simple text value. This type of component value is applicable for dimensions and attributes.
494
495 **MetadataKeyType: **MetadataKeyType is a region which defines a distinct full or partial metadata key. The key consists of a set of values, each referencing a target object for the metadata target referenced in the metadataTarget attribute, which must be defined in the report structure referenced in the report attribute. Each target object can be assigned a single value. If an target object from the reference metadata target is not included in this key, the value of that is assumed to be all known objects for a reference target object, all possible keys for a key descriptor values target object, or all dates for report period target object. The purpose of this key reference a metadata conforming to a particular report structure for given object or set of objects.
496
497 Derivation:
498
499 * //RegionType// (restriction)
500 ** //DistinctKeyType// (restriction)
501 *** MetadataKeyType
502
503 Attributes:
504 include?, report, metadataTarget
505
506 Content:
507 KeyValue+
508
509 Attribute Documentation:
510
511 |**Name**|**Type**|**Documentation**
512 |include (fixed: true)|xs:boolean|The include attribute has a fixed value of true for a distinct key, since such a key is always assumed to identify existing data or metadata.
513 |report|IDType|The report attribute is required and holds the identifier of the report structure which the reference metadata being defined by this key is based on.
514 |metadataTarget|IDType|The metadataTarget attribute is required and identifies the metadata target for the report structure which this key is based upon. Note that a report structure can have multiple metadata targets, so to properly determine the object or objects for which the key applies, the proper metadata target must be identified.
515
516 Element Documentation:
517
518 |**Name**|**Type**|**Documentation**
519 |KeyValue|MetadataKeyValueType|KeyValue contains a reference to a component which disambiguates the data or metadata (i.e. a dimension or target object) and provides a collection of values for the component. The collection of values can be flagged as being inclusive or exclusive to the region being defined. Any key component that is not included is assumed to be wild carded, which is to say that the cube includes all possible values for the un-referenced key components. Further, this assumption applies to the values of the components as well. The values for any given component can only be sub-setted in the region by explicit inclusion or exclusion. For example, a dimension X which has the possible values of 1, 2, 3 is assumed to have all of these values if a key value is not defined. If a key value is defined with an inclusion attribute of true and the values of 1 and 2, the only the values of 1 and 2 for dimension X are included in the definition of the region. If the key value is defined with an inclusion attribute of false and the value of 1, then the values of 2 and 3 for dimension X are included in the definition of the region. Note that any given key component must only be referenced once in the region.
520
521 **MetadataKeyValueType: **MetadataKeyValueType is a type for providing a target object value for the purpose of defining a distinct metadata key. Only a single value can be provided for the target object.
522
523 Derivation:
524
525 * //ComponentValueSetType// (restriction)
526 ** //DinstinctKeyValueType// (restriction)
527 *** MetadataKeyValueType
528
529 Attributes:
530 id, include?
531
532 Content:
533 (Value | DataSet | DataKey | Object)
534
535 Attribute Documentation:
536
537 |**Name**|**Type**|**Documentation**
538 |id|SingleNCNameIDType|The id attribute provides the identifier for the component for which values are being provided. This base type allows for a nested identifier to be provided, for the purpose of referencing a nested component (i.e. a metadata attribute). However, specific implementations will restrict this representation to only allow single level identifiers where appropriate.
539 |include (fixed: true)|xs:boolean|The include attribute indicates whether the values provided for the referenced component are to be included are excluded from the region in which they are defined.
540
541 Element Documentation:
542
543 |**Name**|**Type**|**Documentation**
544 |Value|SimpleKeyValueType|Value provides a simple value for the component, such as a coded, numeric, or simple text value. This type of component value is applicable for dimensions and attributes.
545 |DataSet|SetReferenceType|DataSet provides a reference to a data set and is used to state a value for the data set target component in a metadata target.
546 |DataKey|DataKeyType|DataKey provides a set of dimension references and value, which form a full or partial data key. This is used to state a value for the key descriptor values target component in a metadata target.
547 |Object|ObjectReferenceType|Object provides a reference to an Identifiable object in the SDMX Information Model. This is used to state a value for an identifiable target component in a metadata target.
548
549 **CubeRegionType: **CubeRegionType defines the structure of a data cube region. This is based on the abstract RegionType and simply refines the key and attribute values to conform with what is applicable for dimensions and attributes, respectively. See the documentation of the base type for more details on how a region is defined.
550
551 Derivation:
552
553 * //RegionType// (restriction)
554 ** CubeRegionType
555
556 Attributes:
557 include?
558
559 Content:
560 KeyValue*, Attribute*
561
562 Attribute Documentation:
563
564 |**Name**|**Type**|**Documentation**
565 |include (default: true)|xs:boolean|The include attribute indicates that the region is to be included or excluded within the context in which it is defined. For example, if the regions is defined as part of a content constraint, the exclude flag would mean the data identified by the region is not present.
566
567 Element Documentation:
568
569 |**Name**|**Type**|**Documentation**
570 |KeyValue|CubeRegionKeyType|KeyValue contains a reference to a component which disambiguates the data or metadata (i.e. a dimension or target object) and provides a collection of values for the component. The collection of values can be flagged as being inclusive or exclusive to the region being defined. Any key component that is not included is assumed to be wild carded, which is to say that the cube includes all possible values for the un-referenced key components. Further, this assumption applies to the values of the components as well. The values for any given component can only be sub-setted in the region by explicit inclusion or exclusion. For example, a dimension X which has the possible values of 1, 2, 3 is assumed to have all of these values if a key value is not defined. If a key value is defined with an inclusion attribute of true and the values of 1 and 2, the only the values of 1 and 2 for dimension X are included in the definition of the region. If the key value is defined with an inclusion attribute of false and the value of 1, then the values of 2 and 3 for dimension X are included in the definition of the region. Note that any given key component must only be referenced once in the region.
571 |Attribute|AttributeValueSetTyp e|Attributes contains a reference to an attribute component (data or metadata) and provides a collection of values for the referenced attribute. This serves to state that for the key which defines the region, the attributes that are specified here have or do not have (depending to the include attribute of the value set) the values provided. It is possible to provide and attribute reference without specifying values, for the purpose of stating the attribute is absent (include = false) or present with an unbounded set of values. As opposed to key components, which are assumed to be wild carded if absent, no assumptions are made about the absence of an attribute. Only attributes which are explicitly stated to be present or absent from the region will be know. All unstated attributes for the set cannot be assumed to absent or present.
572
573 **MetadataTargetRegionType: **MetadataTargetRegionType defines the structure of a metadata target region. A metadata target region must define the report structure and the metadata target from that structure on which the region is based. This type is based on the abstract RegionType and simply refines the key and attribute values to conform with what is applicable for target objects and metadata attributes, respectively. See the documentation of the base type for more details on how a region is defined.
574
575 Derivation:
576
577 * //RegionType// (restriction)
578 ** MetadataTargetRegionType
579
580 Attributes:
581 include?, report, metadataTarget
582
583 Content:
584 KeyValue*, Attribute*
585
586 Attribute Documentation:
587
588 |**Name**|**Type**|**Documentation**
589 |include (default: true)|xs:boolean|The include attribute indicates that the region is to be included or excluded within the context in which it is defined. For example, if the regions is defined as part of a content constraint, the exclude flag would mean the data identified by the region is not present.
590 |report|IDType|The report attribute is required and holds the identifier of the report structure which the reference metadata being defined by this region is based on.
591 |metadataTarget|IDType|The metadataTarget attribute is required and identifies the metadata target for the report structure which this region is based upon. Note that a report structure can have multiple metadata targets, so to properly determine the object or objects for which the region applies, the proper metadata target must be identified.
592
593 Element Documentation:
594
595 |**Name**|**Type**|**Documentation**
596 |KeyValue|MetadataTargetRegion KeyType|KeyValue contains a reference to a component which disambiguates the data or metadata (i.e. a dimension or target object) and provides a collection of values for the component. The collection of values can be flagged as being inclusive or exclusive to the region being defined. Any key component that is not included is assumed to be wild carded, which is to say that the cube includes all possible values for the un-referenced key components. Further, this assumption applies to the values of the components as well. The values for any given component can only be sub-setted in the region by explicit inclusion or exclusion. For example, a dimension X which has the possible values of 1, 2, 3 is assumed to have all of these values if a key value is not defined. If a key value is defined with an inclusion attribute of true and the values of 1 and 2, the only the values of 1 and 2 for dimension X are included in the definition of the region. If the key value is defined with an inclusion attribute of false and the value of 1, then the values of 2 and 3 for dimension X are included in the definition of the region. Note that any given key component must only be referenced once in the region.
597 |Attribute|MetadataAttributeVal ueSetType|Attributes contains a reference to an attribute component (data or metadata) and provides a collection of values for the referenced attribute. This serves to state that for the key which defines the region, the attributes that are specified here have or do not have (depending to the include attribute of the value set) the values provided. It is possible to provide and attribute reference without specifying values, for the purpose of stating the attribute is absent (include = false) or present with an unbounded set of values. As opposed to key components, which are assumed to be wild carded if absent, no assumptions are made about the absence of an attribute. Only attributes which are explicitly stated to be present or absent from the region will be know. All unstated attributes for the set cannot be assumed to absent or present.
598
599 **CubeRegionKeyType: **CubeRegionKeyType is a type for providing a set of values for a dimension for the purpose of defining a data cube region. A set of distinct value can be provided, or if this dimension is represented as time, and time range can be specified.
600
601 Derivation:
602
603 * //ComponentValueSetType// (restriction)
604 ** CubeRegionKeyType
605
606 Attributes:
607 id, include?
608
609 Content:
610 (Value+ | TimeRange)
611
612 Attribute Documentation:
613
614 |**Name**|**Type**|**Documentation**
615 |id|SingleNCNameIDType|The id attribute provides the identifier for the component for which values are being provided. This base type allows for a nested identifier to be provided, for the purpose of referencing a nested component (i.e. a metadata attribute). However, specific implementations will restrict this representation to only allow single level identifiers where appropriate.
616 |include (default: true)|xs:boolean|The include attribute indicates whether the values provided for the referenced component are to be included are excluded from the region in which they are defined.
617
618 Element Documentation:
619
620 |**Name**|**Type**|**Documentation**
621 |Value|SimpleValueType|Value provides a simple value for the component, such as a coded, numeric, or simple text value. This type of component value is applicable for dimensions and attributes.
622 |TimeRange|TimeRangeValueType|TimeValue provides a value for a component which has a time representation. This is repeatable to allow for a range to be specified, although a single value can also be provided. An operator is available on this to indicate whether the specified value indicates an exact value or the beginning/end of a range (inclusive or exclusive).
623
624 **MetadataTargetRegionKeyType: **MetadataTargetRegionKeyType is a type for providing a set of values for a target object in a metadata target of a re fence metadata report. A set of values or a time range can be provided for a report period target object. A collection of the respective types of references can be provided for data set reference and identifiable object reference target objects. For a key descriptor values target object, a collection of data keys can be provided.
625
626 Derivation:
627
628 * //ComponentValueSetType// (restriction)
629 ** MetadataTargetRegionKeyType
630
631 Attributes:
632 id, include?
633
634 Content:
635 (Value+ | DataSet+ | DataKey+ | Object+ | TimeRange)
636
637 Attribute Documentation:
638
639 |**Name**|**Type**|**Documentation**
640 |id|SingleNCNameIDType|The id attribute provides the identifier for the component for which values are being provided. This base type allows for a nested identifier to be provided, for the purpose of referencing a nested component (i.e. a metadata attribute). However, specific implementations will restrict this representation to only allow single level identifiers where appropriate.
641 |include (default: true)|xs:boolean|The include attribute indicates whether the values provided for the referenced component are to be included are excluded from the region in which they are defined.
642
643 Element Documentation:
644
645 |**Name**|**Type**|**Documentation**
646 |Value|SimpleKeyValueType|Value provides a simple value for the component, such as a coded, numeric, or simple text value. This type of component value is applicable for dimensions and attributes.
647 |DataSet|SetReferenceType|DataSet provides a reference to a data set and is used to state a value for the data set target component in a metadata target.
648 |DataKey|DataKeyType|DataKey provides a set of dimension references and value, which form a full or partial data key. This is used to state a value for the key descriptor values target component in a metadata target.
649 |Object|ObjectReferenceType|Object provides a reference to an Identifiable object in the SDMX Information Model. This is used to state a value for an identifiable target component in a metadata target.
650 |TimeRange|TimeRangeValueType|TimeValue provides a value for a component which has a time representation. This is repeatable to allow for a range to be specified, although a single value can also be provided. An operator is available on this to indicate whether the specified value indicates an exact value or the beginning/end of a range (inclusive or exclusive).
651
652 **AttributeValueSetType: **AttributeValueSetType defines the structure for providing values for a data attribute. If no values are provided, the attribute is implied to include/excluded from the region in which it is defined, with no regard to the value of the data attribute. Note that for metadata attributes which occur within other metadata attributes, a nested identifier can be provided. For example, a value of CONTACT.ADDRESS.STREET refers to the metadata attribute with the identifier STREET which exists in the ADDRESS metadata attribute in the CONTACT metadata attribute, which is defined at the root of the report structure.
653
654 Derivation:
655
656 * //ComponentValueSetType// (restriction)
657 ** AttributeValueSetType
658
659 Attributes:
660 id, include?
661
662 Content:
663 (Value+ | TimeRange)?
664
665 Attribute Documentation:
666
667 |**Name**|**Type**|**Documentation**
668 |id|SingleNCNameIDType|The id attribute provides the identifier for the component for which values are being provided. This base type allows for a nested identifier to be provided, for the purpose of referencing a nested component (i.e. a metadata attribute). However, specific implementations will restrict this representation to only allow single level identifiers where appropriate.
669 |include (default: true)|xs:boolean|The include attribute indicates whether the values provided for the referenced component are to be included are excluded from the region in which they are defined.
670
671 Element Documentation:
672
673 |**Name**|**Type**|**Documentation**
674 |Value|SimpleValueType|Value provides a simple value for the component, such as a coded, numeric, or simple text value. This type of component value is applicable for dimensions and attributes.
675 |TimeRange|TimeRangeValueType|TimeValue provides a value for a component which has a time representation. This is repeatable to allow for a range to be specified, although a single value can also be provided. An operator is available on this to indicate whether the specified value indicates an exact value or the beginning/end of a range (inclusive or exclusive).
676
677 **MetadataAttributeValueSetType: **MetadataAttributeValueSetType defines the structure for providing values for a metadata attribute. If no values are provided, the attribute is implied to include/excluded from the region in which it is defined, with no regard to the value of the metadata attribute.
678
679 Derivation:
680
681 * //ComponentValueSetType// (restriction)
682 ** MetadataAttributeValueSetType
683
684 Attributes:
685 id, include?
686
687 Content:
688 (Value+ | TimeRange)?
689
690 Attribute Documentation:
691
692 |**Name**|**Type**|**Documentation**
693 |id|NestedNCNameIDType|The id attribute provides the identifier for the component for which values are being provided. This base type allows for a nested identifier to be provided, for the purpose of referencing a nested component (i.e. a metadata attribute). However, specific implementations will restrict this representation to only allow single level identifiers where appropriate.
694 |include (default: true)|xs:boolean|The include attribute indicates whether the values provided for the referenced component are to be included are excluded from the region in which they are defined.
695
696 Element Documentation:
697
698 |**Name**|**Type**|**Documentation**
699 |Value|SimpleValueType|Value provides a simple value for the component, such as a coded, numeric, or simple text value. This type of component value is applicable for dimensions and attributes.
700 |TimeRange|TimeRangeValueType|TimeValue provides a value for a component which has a time representation. This is repeatable to allow for a range to be specified, although a single value can also be provided. An operator is available on this to indicate whether the specified value indicates an exact value or the beginning/end of a range (inclusive or exclusive).
701
702 **SimpleValueType: **SimpleValueType contains a simple value for a component, and if that value is from a code list, the ability to indicate that child codes in a simple hierarchy are part of the value set of the component for the region.
703
704 Derivation:
705
706 * xs:anySimpleType (restriction)
707 ** xs:string (extension)
708 *** SimpleValueType
709
710 Attributes:
711 cascadeValues?
712
713 Content:
714
715 Attribute Documentation:
716
717 |**Name**|**Type**|**Documentation**
718 |cascadeValues (default: false)|xs:boolean|The cascadeValues attribute, if true, indicates that if the value is taken from a code all child codes in a simple hierarchy are understood be included in the region.
719
720 **SimpleKeyValueType: **SimpleKeyValueType derives from the SimpleValueType, but does not allow for the cascading of value in the hierarchy, as keys are meant to describe a distinct full or partial key.
721
722 Derivation:
723
724 * xs:anySimpleType (restriction)
725 **
726 *** xs:string (extension)
727 **** SimpleValueType (restriction)
728 ***** SimpleKeyValueType
729
730 Content:
731 **TimeRangeValueType: **TimeRangeValueType allows a time period value to be expressed as a range. It can be expressed as the period before a period, after a period, or between two periods. Each of these properties can specify their inclusion in regards to the range.
732
733 Content:
734 (BeforePeriod | AfterPeriod | (StartPeriod, EndPeriod))
735
736 Element Documentation:
737
738 |**Name**|**Type**|**Documentation**
739 |BeforePeriod|TimePeriodRangeType|BeforePeriod is the period before which the period is meant to cover. This date may be inclusive or exclusive in the range.
740 |AfterPeriod|TimePeriodRangeType|AfterPeriod is the period after which the period is meant to cover. This date may be inclusive or exclusive in the range.
741 |StartPeriod|TimePeriodRangeType|StartPeriod is the start date or the range that the queried date must occur within. This date may be inclusive or exclusive in the range.
742 |EndPeriod|TimePeriodRangeType|EndPeriod is the end period of the range. This date may be inclusive or exclusive in the range.
743
744 **TimePeriodRangeType: **TimePeriodRangeType defines a time period, and indicates whether it is inclusive in a range.
745
746 Derivation:
747
748 * xs:anySimpleType (restriction)
749 ** ObservationalTimePeriodType (extension)
750 *** TimePeriodRangeType
751
752 Attributes:
753 isInclusive?
754
755 Content:
756 Attribute Documentation:
757
758 |**Name**|**Type**|**Documentation**
759 |isInclusive (default: true)|xs:boolean|The isInclusive attribute, when true, indicates that the time period specified is included in the range.
760
761 //**PayloadStructureType**//**: **PayloadStructureType is an abstract base type used to define the structural information for data or metadata sets. A reference to the structure is provided (either explicitly or through a reference to a structure usage).
762
763 Attributes:
764 structureID, schemaURL?, namespace?, dimensionAtObservation?, explicitMeasures?, serviceURL?, structureURL?
765
766 Content:
767 (ProvisionAgrement | StructureUsage | Structure)
768
769 Attribute Documentation:
770
771 |**Name**|**Type**|**Documentation**
772 |structureID|xs:ID|The structureID attribute uniquely identifies the structure for the purpose of referencing it from the payload. This is only used in structure specific formats. Although it is required, it is only useful when more than one data set is present in the message.
773 |schemaURL|xs:anyURI|The schemaURL attribute provides a location from which the structure specific schema can be located.
774 |namespace|xs:anyURI|The namespace attribute is used to provide the namespace for structure-specific formats. By communicating this information in the header, it is possible to generate the structure specific schema while processing the message.
775 |dimensionAtObservation|ObservationDimension Type|The dimensionAtObservation is used to reference the dimension at the observation level for data messages. This can also be given the explicit value of "AllDimensions" which denotes that the cross sectional data is in the flat format.
776 |explicitMeasures|xs:boolean|The explicitMeasures indicates whether explicit measures are used in the cross sectional format. This is only applicable for the measure dimension as the dimension at the observation level or the flat structure.
777 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
778 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
779
780 Element Documentation:
781
782 |**Name**|**Type**|**Documentation**
783 |ProvisionAgrement|ProvisionAgreementRe ferenceType|ProvisionAgreement references a provision agreement which the data or metadata is reported against.
784 |StructureUsage|//StructureUsageRefere nceBaseType//|StructureUsage references a flow which the data or metadata is reported against.
785 |Structure|//StructureReferenceBa seType//|Structure references the structure which defines the structure of the data or metadata set.
786
787 //**DataStructureType**//**: **DataStructureType is an abstract base type the forms the basis for the structural information for a data set.
788
789 Derivation:
790
791 * //PayloadStructureType// (restriction)
792 ** //DataStructureType//
793
794 Attributes:
795 structureID, schemaURL?, namespace?, dimensionAtObservation?, explicitMeasures?, serviceURL?, structureURL?
796
797 Content:
798 (ProvisionAgrement | StructureUsage | Structure)
799
800 Attribute Documentation:
801
802 |**Name**|**Type**|**Documentation**
803 |structureID|xs:ID|The structureID attribute uniquely identifies the structure for the purpose of referencing it from the payload. This is only used in structure specific formats. Although it is required, it is only useful when more than one data set is present in the message.
804 |schemaURL|xs:anyURI|The schemaURL attribute provides a location from which the structure specific schema can be located.
805 |namespace|xs:anyURI|The namespace attribute is used to provide the namespace for structure-specific formats. By communicating this information in the header, it is possible to generate the structure specific schema while processing the message.
806 |dimensionAtObservation|ObservationDimension Type|The dimensionAtObservation is used to reference the dimension at the observation level for data messages. This can also be given the explicit value of "AllDimensions" which denotes that the cross sectional data is in the flat format.
807 |explicitMeasures|xs:boolean|The explicitMeasures indicates whether explicit measures are used in the cross sectional format. This is only applicable for the measure dimension as the dimension at the observation level or the flat structure.
808 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
809 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
810
811 Element Documentation:
812
813 |**Name**|**Type**|**Documentation**
814 |ProvisionAgrement|ProvisionAgreementRe ferenceType|ProvisionAgreement references a provision agreement which the data is reported against.
815 |StructureUsage|DataflowReferenceTyp e|StructureUsage references a dataflow which the data is reported against.
816 |Structure|DataStructureReferen ceType|Structure references the data structure definition which defines the structure of the data.
817
818 **DataStructureRequestType: **DataStructureRequestType is a variation of a the DataStructureType for querying purposes. Only the observation dimension and the explicit measures flag are allowed.
819
820 Derivation:
821
822 * //PayloadStructureType// (restriction)
823 ** //DataStructureType// (restriction)
824 *** DataStructureRequestType
825
826 Attributes:
827 structureID, dimensionAtObservation, explicitMeasures?, serviceURL?, structureURL?
828
829 Content:
830 (ProvisionAgrement | StructureUsage | Structure)
831
832 Attribute Documentation:
833
834 |**Name**|**Type**|**Documentation**
835 |structureID|xs:ID|The structureID attribute uniquely identifies the structure for the purpose of referencing it from the payload. This is only used in structure specific formats. Although it is required, it is only useful when more than one data set is present in the message.
836 |dimensionAtObservation|ObservationDimension Type|The dimensionAtObservation is used to reference the dimension at the observation level for data messages. This can also be given the explicit value of "AllDimensions" which denotes that the cross sectional data is in the flat format.
837 |explicitMeasures (default: false)|xs:boolean|The explicitMeasures indicates whether explicit measures are used in the cross sectional format. This is only applicable for the measure dimension as the dimension at the observation level or the flat structure.
838 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
839 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
840
841 Element Documentation:
842
843 |**Name**|**Type**|**Documentation**
844 |ProvisionAgrement|ProvisionAgreementRe ferenceType|ProvisionAgreement references a provision agreement which the data is reported against.
845 |StructureUsage|DataflowReferenceTyp e|StructureUsage references a dataflow which the data is reported against.
846 |Structure|DataStructureReferen ceType|Structure references the data structure definition which defines the structure of the data.
847
848 **GenericDataStructureRequestType: **GenericDataStructureRequestType is a variation of a the DataStructureRequestType for querying purposes. The explicit measure flag in not allowed.
849
850 Derivation:
851
852 * //PayloadStructureType// (restriction)
853 ** //DataStructureType// (restriction)
854 *** DataStructureRequestType (restriction)
855 **** GenericDataStructureRequestType
856
857 Attributes:
858 structureID, dimensionAtObservation, serviceURL?, structureURL?
859
860 Content:
861 (ProvisionAgrement | StructureUsage | Structure)
862
863 Attribute Documentation:
864
865 |**Name**|**Type**|**Documentation**
866 |structureID|xs:ID|The structureID attribute uniquely identifies the structure for the purpose of referencing it from the payload. This is only used in structure specific formats. Although it is required, it is only useful when more than one data set is present in the message.
867 |dimensionAtObservation|ObservationDimension Type|The dimensionAtObservation is used to reference the dimension at the observation level for data messages. This can also be given the explicit value of "AllDimensions" which denotes that the cross sectional data is in the flat format.
868 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
869 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
870
871 Element Documentation:
872
873 |**Name**|**Type**|**Documentation**
874 |ProvisionAgrement|ProvisionAgreementRe ferenceType|ProvisionAgreement references a provision agreement which the data is reported against.
875 |StructureUsage|DataflowReferenceTyp e|StructureUsage references a dataflow which the data is reported against.
876 |Structure|DataStructureReferen ceType|Structure references the data structure definition which defines the structure of the data.
877
878 **TimeSeriesDataStructureRequestType: **TimeSeriesDataStructureRequestType is a variation of a the DataStructureRequestType for querying purposes. The observation dimension is fixed to TIME_PERIOD
879
880 Derivation:
881
882 * //PayloadStructureType// (restriction)
883 ** //DataStructureType// (restriction)
884 ***
885 **** DataStructureRequestType (restriction)
886 ***** TimeSeriesDataStructureRequestType
887
888 Attributes:
889 structureID, dimensionAtObservation, explicitMeasures?, serviceURL?, structureURL?
890
891 Content:
892 (ProvisionAgrement | StructureUsage | Structure)
893
894 Attribute Documentation:
895
896 |**Name**|**Type**|**Documentation**
897 |structureID|xs:ID|The structureID attribute uniquely identifies the structure for the purpose of referencing it from the payload. This is only used in structure specific formats. Although it is required, it is only useful when more than one data set is present in the message.
898 |dimensionAtObservation (fixed: TIME_PERIOD)|ObservationDimension Type|The dimensionAtObservation is used to reference the dimension at the observation level for data messages. This can also be given the explicit value of "AllDimensions" which denotes that the cross sectional data is in the flat format.
899 |explicitMeasures (default: false)|xs:boolean|The explicitMeasures indicates whether explicit measures are used in the cross sectional format. This is only applicable for the measure dimension as the dimension at the observation level or the flat structure.
900 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
901 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
902
903 Element Documentation:
904
905 |**Name**|**Type**|**Documentation**
906 |ProvisionAgrement|ProvisionAgreementRe ferenceType|ProvisionAgreement references a provision agreement which the data is reported against.
907 |StructureUsage|DataflowReferenceTyp e|StructureUsage references a dataflow which the data is reported against.
908 |Structure|DataStructureReferen ceType|Structure references the data structure definition which defines the structure of the data.
909
910 **TimeSeriesGenericDataStructureRequestType: **TimeSeriesGenericDataStructureRequestType is a variation of a the GenericDataStructureRequestType for querying purposes. The observation dimension is fixed to TIME_PERIOD.
911
912 Derivation:
913
914 * //PayloadStructureType// (restriction)
915 ** //DataStructureType// (restriction)
916 *** DataStructureRequestType (restriction)
917 **** GenericDataStructureRequestType (restriction)
918 ***** TimeSeriesGenericDataStructureRequestType
919
920 Attributes:
921 structureID, dimensionAtObservation, serviceURL?, structureURL?
922
923 Content:
924 (ProvisionAgrement | StructureUsage | Structure)
925
926 Attribute Documentation:
927
928 |**Name**|**Type**|**Documentation**
929 |structureID|xs:ID|The structureID attribute uniquely identifies the structure for the purpose of referencing it from the payload. This is only used in structure specific formats. Although it is required, it is only useful when more than one data set is present in the message.
930 |dimensionAtObservation (fixed: TIME_PERIOD)|ObservationDimension Type|The dimensionAtObservation is used to reference the dimension at the observation level for data messages. This can also be given the explicit value of "AllDimensions" which denotes that the cross sectional data is in the flat format.
931 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
932 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
933
934 Element Documentation:
935
936 |**Name**|**Type**|**Documentation**
937 |ProvisionAgrement|ProvisionAgreementRe ferenceType|ProvisionAgreement references a provision agreement which the data is reported against.
938 |StructureUsage|DataflowReferenceTyp e|StructureUsage references a dataflow which the data is reported against.
939 |Structure|DataStructureReferen ceType|Structure references the data structure definition which defines the structure of the data.
940
941 **GenericDataStructureType: **GenericDataStructureType defines the structural information for a generic data set. A reference to the structure, either explicitly or through a dataflow or provision agreement is required as well as the dimension which occurs at the observation level.
942
943 Derivation:
944
945 * //PayloadStructureType// (restriction)
946 ** //DataStructureType// (restriction)
947 *** GenericDataStructureType
948
949 Attributes:
950 structureID, dimensionAtObservation, serviceURL?, structureURL?
951
952 Content:
953 (ProvisionAgrement | StructureUsage | Structure)
954
955 Attribute Documentation:
956
957 |**Name**|**Type**|**Documentation**
958 |structureID|xs:ID|The structureID attribute uniquely identifies the structure for the purpose of referencing it from the payload. This is only used in structure specific formats. Although it is required, it is only useful when more than one data set is present in the message.
959 |dimensionAtObservation|ObservationDimension Type|The dimensionAtObservation is used to reference the dimension at the observation level for data messages. This can also be given the explicit value of "AllDimensions" which denotes that the cross sectional data is in the flat format.
960 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
961 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
962
963 Element Documentation:
964
965 |**Name**|**Type**|**Documentation**
966 |ProvisionAgrement|ProvisionAgreementRe ferenceType|ProvisionAgreement references a provision agreement which the data is reported against.
967 |StructureUsage|DataflowReferenceTyp e|StructureUsage references a dataflow which the data is reported against.
968 |Structure|DataStructureReferen ceType|Structure references the data structure definition which defines the structure of the data.
969
970 **GenericTimeSeriesDataStructureType: **GenericTimeSeriesDataStructureType defines the structural information for a generic time series based data set. The dimension at the observation level is fixed to be TIME_PERIOD.
971
972 Derivation:
973
974 * //PayloadStructureType// (restriction)
975 ** //DataStructureType// (restriction)
976 *** GenericDataStructureType (restriction)
977 **** GenericTimeSeriesDataStructureType
978
979 Attributes:
980 structureID, dimensionAtObservation, serviceURL?, structureURL?
981
982 Content:
983 (ProvisionAgrement | StructureUsage | Structure)
984
985 Attribute Documentation:
986
987 |**Name**|**Type**|**Documentation**
988 |structureID|xs:ID|The structureID attribute uniquely identifies the structure for the purpose of referencing it from the payload. This is only used in structure specific formats. Although it is required, it is only useful when more than one data set is present in the message.
989 |dimensionAtObservation (fixed: TIME_PERIOD)|ObservationDimension Type|The dimensionAtObservation is used to reference the dimension at the observation level for data messages. This can also be given the explicit value of "AllDimensions" which denotes that the cross sectional data is in the flat format.
990 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
991 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
992
993 Element Documentation:
994
995 |**Name**|**Type**|**Documentation**
996 |ProvisionAgrement|ProvisionAgreementRe ferenceType|ProvisionAgreement references a provision agreement which the data is reported against.
997 |StructureUsage|DataflowReferenceTyp e|StructureUsage references a dataflow which the data is reported against.
998 |Structure|DataStructureReferen ceType|Structure references the data structure definition which defines the structure of the data.
999
1000 **StructureSpecificDataStructureType: **StructureSpecificDataStructureType defines the structural information for a structured data set. In addition to referencing the data structure or dataflow which defines the structure of the data, the namespace for the data structure specific schema as well as which dimension is used at the observation level must be provided. It is also necessary to state whether the format uses explicit measures, although this is technically only applicable is the dimension at the observation level is the measure dimension or the flat data format is used.
1001
1002 Derivation:
1003
1004 * //PayloadStructureType// (restriction)
1005 ** //DataStructureType// (restriction)
1006 *** StructureSpecificDataStructureType
1007
1008 Attributes:
1009 structureID, schemaURL?, namespace, dimensionAtObservation, explicitMeasures?, serviceURL?, structureURL?
1010
1011 Content:
1012 (ProvisionAgrement | StructureUsage | Structure)
1013
1014 Attribute Documentation:
1015
1016 |**Name**|**Type**|**Documentation**
1017 |structureID|xs:ID|The structureID attribute uniquely identifies the structure for the purpose of referencing it from the payload. This is only used in structure specific formats. Although it is required, it is only useful when more than one data set is present in the message.
1018 |schemaURL|xs:anyURI|The schemaURL attribute provides a location from which the structure specific schema can be located.
1019 |namespace|xs:anyURI|The namespace attribute is used to provide the namespace for structure-specific formats. By communicating this information in the header, it is possible to generate the structure specific schema while processing the message.
1020 |dimensionAtObservation|ObservationDimension Type|The dimensionAtObservation is used to reference the dimension at the observation level for data messages. This can also be given the explicit value of "AllDimensions" which denotes that the cross sectional data is in the flat format.
1021 |explicitMeasures (default: false)|xs:boolean|The explicitMeasures indicates whether explicit measures are used in the cross sectional format. This is only applicable for the measure dimension as the dimension at the observation level or the flat structure.
1022 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
1023 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
1024
1025 Element Documentation:
1026
1027 |**Name**|**Type**|**Documentation**
1028 |ProvisionAgrement|ProvisionAgreementRe ferenceType|ProvisionAgreement references a provision agreement which the data is reported against.
1029 |StructureUsage|DataflowReferenceTyp e|StructureUsage references a dataflow which the data is reported against.
1030 |Structure|DataStructureReferen ceType|Structure references the data structure definition which defines the structure of the data.
1031
1032 **StructureSpecificDataTimeSeriesStructureType: **StructureSpecificDataTimeSeriesStructureType defines the structural information for a structure definition specific time series data set. The dimension at the observation level is fixed to be TIME_PERIOD.
1033
1034 Derivation:
1035
1036 * //PayloadStructureType// (restriction)
1037 ** //DataStructureType// (restriction)
1038 *** StructureSpecificDataStructureType (restriction)
1039 **** StructureSpecificDataTimeSeriesStructureType
1040
1041 Attributes:
1042 structureID, schemaURL?, namespace, dimensionAtObservation, serviceURL?, structureURL?
1043
1044 Content:
1045 (ProvisionAgrement | StructureUsage | Structure)
1046
1047 Attribute Documentation:
1048
1049 |**Name**|**Type**|**Documentation**
1050 |structureID|xs:ID|The structureID attribute uniquely identifies the structure for the purpose of referencing it from the payload. This is only used in structure specific formats. Although it is required, it is only useful when more than one data set is present in the message.
1051 |schemaURL|xs:anyURI|The schemaURL attribute provides a location from which the structure specific schema can be located.
1052 |namespace|xs:anyURI|The namespace attribute is used to provide the namespace for structure-specific formats. By communicating this information in the header, it is possible to generate the structure specific schema while processing the message.
1053 |dimensionAtObservation (fixed: TIME_PERIOD)|ObservationDimension Type|The dimensionAtObservation is used to reference the dimension at the observation level for data messages. This can also be given the explicit value of "AllDimensions" which denotes that the cross sectional data is in the flat format.
1054 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
1055 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
1056
1057 Element Documentation:
1058
1059 |**Name**|**Type**|**Documentation**
1060 |ProvisionAgrement|ProvisionAgreementRe ferenceType|ProvisionAgreement references a provision agreement which the data is reported against.
1061 |StructureUsage|DataflowReferenceTyp e|StructureUsage references a dataflow which the data is reported against.
1062 |Structure|DataStructureReferen ceType|Structure references the data structure definition which defines the structure of the data.
1063
1064 //**MetadataStructureType**//**: **MetadataStructureType is an abstract base type the forms the basis of the structural information for any metadata message. A reference to the metadata structure definition or a metadataflow must be provided. This can be used to determine the structure of the message.
1065
1066 Derivation:
1067
1068 * //PayloadStructureType// (restriction)
1069 ** //MetadataStructureType//
1070
1071 Attributes:
1072 structureID, schemaURL?, namespace?, serviceURL?, structureURL?
1073
1074 Content:
1075 (ProvisionAgrement | StructureUsage | Structure)
1076
1077 Attribute Documentation:
1078
1079 |**Name**|**Type**|**Documentation**
1080 |structureID|xs:ID|The structureID attribute uniquely identifies the structure for the purpose of referencing it from the payload. This is only used in structure specific formats. Although it is required, it is only useful when more than one data set is present in the message.
1081 |schemaURL|xs:anyURI|The schemaURL attribute provides a location from which the structure specific schema can be located.
1082 |namespace|xs:anyURI|The namespace attribute is used to provide the namespace for structure-specific formats. By communicating this information in the header, it is possible to generate the structure specific schema while processing the message.
1083 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
1084 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
1085
1086 Element Documentation:
1087
1088 |**Name**|**Type**|**Documentation**
1089 |ProvisionAgrement|ProvisionAgreementRe ferenceType|ProvisionAgreement references a provision agreement which the metadata is reported against.
1090 |StructureUsage|MetadataflowReferenc eType|StructureUsage references a metadataflow which the metadata is reported against.
1091 |Structure|MetadataStructureRef erenceType|Structure references the metadata structure definition which defines the structure of the metadata.
1092
1093 **StructureSpecificMetadataStructureType: **StructureSpecificMetadataStructureType defines the structural information for a structured metadata message.
1094
1095 Derivation:
1096
1097 * //PayloadStructureType// (restriction)
1098 ** //MetadataStructureType// (restriction)
1099 *** StructureSpecificMetadataStructureType
1100
1101 Attributes:
1102 structureID, schemaURL?, namespace, serviceURL?, structureURL?
1103
1104 Content:
1105 (ProvisionAgrement | StructureUsage | Structure)
1106
1107 Attribute Documentation:
1108
1109 |**Name**|**Type**|**Documentation**
1110 |structureID|xs:ID|The structureID attribute uniquely identifies the structure for the purpose of referencing it from the payload. This is only used in structure specific formats. Although it is required, it is only useful when more than one data set is present in the message.
1111 |schemaURL|xs:anyURI|The schemaURL attribute provides a location from which the structure specific schema can be located.
1112 |namespace|xs:anyURI|The namespace attribute is used to provide the namespace for structure-specific formats. By communicating this information in the header, it is possible to generate the structure specific schema while processing the message.
1113 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
1114 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
1115
1116 Element Documentation:
1117
1118 |**Name**|**Type**|**Documentation**
1119 |ProvisionAgrement|ProvisionAgreementRe ferenceType|ProvisionAgreement references a provision agreement which the metadata is reported against.
1120 |StructureUsage|MetadataflowReferenc eType|StructureUsage references a metadataflow which the metadata is reported against.
1121 |Structure|MetadataStructureRef erenceType|Structure references the metadata structure definition which defines the structure of the metadata.
1122
1123 **GenericMetadataStructureType: **GenericMetadataStructureType defines the structural information for a generic metadata message.
1124
1125 Derivation:
1126
1127 * //PayloadStructureType// (restriction)
1128 ** //MetadataStructureType// (restriction)
1129 *** GenericMetadataStructureType
1130
1131 Attributes:
1132 structureID, schemaURL?, serviceURL?, structureURL?
1133
1134 Content:
1135 (ProvisionAgrement | StructureUsage | Structure)
1136
1137 Attribute Documentation:
1138
1139 |**Name**|**Type**|**Documentation**
1140 |structureID|xs:ID|The structureID attribute uniquely identifies the structure for the purpose of referencing it from the payload. This is only used in structure specific formats. Although it is required, it is only useful when more than one data set is present in the message.
1141 |schemaURL|xs:anyURI|The schemaURL attribute provides a location from which the structure specific schema can be located.
1142 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
1143 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
1144
1145 Element Documentation:
1146
1147 |**Name**|**Type**|**Documentation**
1148 |ProvisionAgrement|ProvisionAgreementRe ferenceType|ProvisionAgreement references a provision agreement which the metadata is reported against.
1149 |StructureUsage|MetadataflowReferenc eType|StructureUsage references a metadataflow which the metadata is reported against.
1150 |Structure|MetadataStructureRef erenceType|Structure references the metadata structure definition which defines the structure of the metadata.
1151
1152 **EmptyType: **EmptyType is an empty complex type for elements where the presence of the tag indicates all that is necessary.
1153
1154 Content:
1155 {Empty}
1156
1157 //**ReferenceType**//**: **ReferenceType is an abstract base type. It is used as the basis for all references, to all for a top level generic object reference that can be substituted with an explicit reference to any object. Any reference can consist of a Ref (which contains all required reference fields separately) and/or a URN. These must result in the identification of the same object. Note that the Ref and URN elements are local and unqualified in order to allow for refinement of this structure outside of the namespace. This allows any reference to further refined by a different namespace. For example, a metadata structure definition specific metadata set might wish to restrict the URN to only allow for a value from an enumerated list. The general URN structure, for the purpose of mapping the reference fields is as follows: urn:sdmx:org.package-name.class-name=agency-id:(maintainable-parent-object-id[maintainable-parent-object-version].)?(container-object-id.)?object-id([object-version])?.
1158
1159 Content:
1160 ( (Ref, URN?) | URN)
1161
1162 Element Documentation:
1163
1164 |**Name**|**Type**|**Documentation**
1165 |Ref|//RefBaseType//|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
1166 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
1167 |URN|xs:anyURI|URN is used to hold the URN of the referenced object.
1168
1169 //**RefBaseType**//**: **RefBaseType is an abstract base type the defines the basis for any set of complete reference fields. This should be refined by derived types so that only the necessary fields are available and required as necessary. This can be used for both full and local references (when some of the values are implied from another context). A local reference is indicated with the local attribute. The values in this type correspond directly to the components of the URN structure, and thus can be used to compose a URN when the local attribute value is false. As this is the case, any reference components which are not part of the URN structure should not be present in the derived types.
1170
1171 Attributes:
1172 agencyID?, maintainableParentID?, maintainableParentVersion?, containerID?, id, version?, local?, class?, package?
1173
1174 Content:
1175 {Empty}
1176
1177 Attribute Documentation:
1178
1179 |**Name**|**Type**|**Documentation**
1180 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
1181 |maintainableParentID|IDType|The maintainableParentID attribute identifies the maintainable object in which the referenced object is defined, if applicable (maintainable-parent-object-id in the URN structure). This is only used in references where the referenced object is not itself maintainable.
1182 |maintainableParentVersion|VersionType|The maintainableParentVersion attribute identifies the version of the maintainable object in which the referenced object is defined (maintainable-parent-object-version in the URN structure). This is only used in references where the referenced object is not itself maintainable. This should only be used when the maintainableParentID is present. If this is available, a default of 1.0 will always apply.
1183 |containerID|NestedIDType|The containerID attribute identifies the object within a maintainable object in which the referenced object is defined (container-object-id in the URN structure). This is only used in references where the referenced object is not contained directly within a maintainable object (e.g. a Component within a ComponentList, within a maintainable Structure). If the container has a fixed identifier, this attribute will not be present.
1184 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
1185 |version|VersionType|The version attribute identifies the version of the object being reference, if applicable. If this is available, a default value of 1.0 will always apply.
1186 |local|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
1187 |class|ObjectTypeCodelistTy pe|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1188 |package|PackageTypeCodelistT ype|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1189
1190 **ObjectReferenceType: **ObjectReferenceType is a generic reference which allows for any object to be referenced. The type of object actually referenced can be determined from the URN or from the class attribute of the full set of reference fields.
1191
1192 Derivation:
1193
1194 * //ReferenceType// (restriction)
1195 ** ObjectReferenceType
1196
1197 Content:
1198 ( (Ref, URN?) | URN)
1199
1200 Element Documentation:
1201
1202 |**Name**|**Type**|**Documentation**
1203 |Ref|ObjectRefType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
1204 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
1205 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
1206
1207 **ObjectRefType: **ObjectRefType contains a set of reference fields for the purpose of referencing any object. This cannot be a local reference, therefore the agency identifier is required. It is also required that the class and package be supplied for the referenced object such that a complete URN reference can be built from the values provided. Note that this is not capable of fully validating that all necessary fields are supplied for a given object type.
1208
1209 Derivation:
1210
1211 * //RefBaseType// (restriction)
1212 ** ObjectRefType
1213
1214 Attributes:
1215 agencyID, maintainableParentID?, maintainableParentVersion?, containerID?, id, version?, local?, class, package
1216
1217 Content:
1218 {Empty}
1219
1220 Attribute Documentation:
1221
1222 |**Name**|**Type**|**Documentation**
1223 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
1224 |maintainableParentID|IDType|The maintainableParentID attribute identifies the maintainable object in which the referenced object is defined, if applicable (maintainable-parent-object-id in the URN structure). This is only used in references where the referenced object is not itself maintainable.
1225 |maintainableParentVersion|VersionType|The maintainableParentVersion attribute identifies the version of the maintainable object in which the referenced object is defined (maintainable-parent-object-version in the URN structure). This is only used in references where the referenced object is not itself maintainable. This should only be used when the maintainableParentID is present. If this is available, a default of 1.0 will always apply.
1226 |containerID|NestedIDType|The containerID attribute identifies the object within a maintainable object in which the referenced object is defined (container-object-id in the URN structure). This is only used in references where the referenced object is not contained directly within a maintainable object (e.g. a Component within a ComponentList, within a maintainable Structure). If the container has a fixed identifier, this attribute will not be present.
1227 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
1228 |version|VersionType|The version attribute identifies the version of the object being reference, if applicable. If this is available, a default value of 1.0 will always apply.
1229 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
1230 |class|ObjectTypeCodelistTy pe|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1231 |package|PackageTypeCodelistT ype|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1232
1233 //**MaintainableRefBaseType**//**: **MaintainableRefBaseType is an abstract base type for referencing a maintainable object.
1234
1235 Derivation:
1236
1237 * //RefBaseType// (restriction)
1238 ** //MaintainableRefBaseType//
1239
1240 Attributes:
1241 agencyID, id, version?, local?, class?, package?
1242
1243 Content:
1244 {Empty}
1245
1246 Attribute Documentation:
1247
1248 |**Name**|**Type**|**Documentation**
1249 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
1250 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
1251 |version (default: 1.0)|VersionType|The version attribute identifies the version of the object being reference, if applicable. If this is available, a default value of 1.0 will always apply.
1252 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
1253 |class|MaintainableTypeCode listType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1254 |package|PackageTypeCodelistT ype|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1255
1256 **MaintainableRefType: **MaintainableRefType contains a complete set of reference fields for referencing any maintainable object.
1257
1258 Derivation:
1259
1260 * //RefBaseType// (restriction)
1261 ** //MaintainableRefBaseType// (restriction)
1262 *** MaintainableRefType
1263
1264 Attributes:
1265 agencyID, id, version?, local?, class, package
1266
1267 Content:
1268 {Empty}
1269
1270 Attribute Documentation:
1271
1272 |**Name**|**Type**|**Documentation**
1273 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
1274 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
1275 |version (default: 1.0)|VersionType|The version attribute identifies the version of the object being reference, if applicable. If this is available, a default value of 1.0 will always apply.
1276 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
1277 |class|ConcreteMaintainable TypeCodelistType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1278 |package|PackageTypeCodelistT ype|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1279
1280 //**ItemSchemeRefBaseType**//**: **ItemSchemeRefBaseType is an abstract base type for referencing an item scheme.
1281
1282 Derivation:
1283
1284 * //RefBaseType// (restriction)
1285 ** //MaintainableRefBaseType// (restriction)
1286 *** //ItemSchemeRefBaseType//
1287
1288 Attributes:
1289 agencyID, id, version?, local?, class?, package?
1290
1291 Content:
1292 {Empty}
1293
1294 Attribute Documentation:
1295
1296 |**Name**|**Type**|**Documentation**
1297 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
1298 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
1299 |version (default: 1.0)|VersionType|The version attribute identifies the version of the object being reference, if applicable. If this is available, a default value of 1.0 will always apply.
1300 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
1301 |class|ItemSchemeTypeCodeli stType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1302 |package|ItemSchemePackageTyp eCodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1303
1304 **ItemSchemeRefType: **ItemSchemeRefType contains a complete set of reference fields for referencing any item scheme. The class and package a required so that the reference is explicit as to the exact object being referenced.
1305
1306 Derivation:
1307
1308 * //RefBaseType// (restriction)
1309 ** //MaintainableRefBaseType// (restriction)
1310 *** //ItemSchemeRefBaseType// (restriction)
1311 **** ItemSchemeRefType
1312
1313 Attributes:
1314 agencyID, id, version?, local?, class, package
1315
1316 Content:
1317 {Empty}
1318
1319 Attribute Documentation:
1320
1321 |**Name**|**Type**|**Documentation**
1322 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
1323 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
1324 |version (default: 1.0)|VersionType|The version attribute identifies the version of the object being reference, if applicable. If this is available, a default value of 1.0 will always apply.
1325 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
1326 |class|ItemSchemeTypeCodeli stType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1327 |package|ItemSchemePackageTyp eCodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1328
1329 //**StructureOrUsageRefBaseType**//**: **StructureOrUsageRefBaseType is an abstract base type for referencing a structure or structure usage.
1330
1331 Derivation:
1332
1333 * //RefBaseType// (restriction)
1334 ** //MaintainableRefBaseType// (restriction)
1335 *** //StructureOrUsageRefBaseType//
1336
1337 Attributes:
1338 agencyID, id, version?, local?, class?, package?
1339
1340 Content:
1341 {Empty}
1342
1343 Attribute Documentation:
1344
1345 |**Name**|**Type**|**Documentation**
1346 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
1347 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
1348 |version (default: 1.0)|VersionType|The version attribute identifies the version of the object being reference, if applicable. If this is available, a default value of 1.0 will always apply.
1349 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
1350 |class|StructureOrUsageType CodelistType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1351 |package|StructurePackageType CodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1352
1353 //**StructureRefBaseType**//**: **StructureRefBaseType is an abstract base type for referencing a structure.
1354
1355 Derivation:
1356
1357 * //RefBaseType// (restriction)
1358 ** //MaintainableRefBaseType// (restriction)
1359 *** //StructureOrUsageRefBaseType// (restriction)
1360 **** //StructureRefBaseType//
1361
1362 Attributes:
1363 agencyID, id, version?, local?, class?, package?
1364
1365 Content:
1366 {Empty}
1367
1368 Attribute Documentation:
1369
1370 |**Name**|**Type**|**Documentation**
1371 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
1372 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
1373 |version (default: 1.0)|VersionType|The version attribute identifies the version of the object being reference, if applicable. If this is available, a default value of 1.0 will always apply.
1374 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
1375 |class|StructureTypeCodelis tType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1376 |package|StructurePackageType CodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1377
1378 **StructureRefType: **StructureRefType contains a set of reference fields for referencing any structure.
1379
1380 Derivation:
1381
1382 * //RefBaseType// (restriction)
1383 ** //MaintainableRefBaseType// (restriction)
1384 *** //StructureOrUsageRefBaseType// (restriction)
1385 **** //StructureRefBaseType// (restriction)
1386 ***** StructureRefType
1387
1388 Attributes:
1389 agencyID, id, version?, local?, class, package
1390
1391 Content:
1392 {Empty}
1393
1394 Attribute Documentation:
1395
1396 |**Name**|**Type**|**Documentation**
1397 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
1398 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
1399 |version (default: 1.0)|VersionType|The version attribute identifies the version of the object being reference, if applicable. If this is available, a default value of 1.0 will always apply.
1400 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
1401 |class|StructureTypeCodelis tType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1402 |package|StructurePackageType CodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1403
1404 //**StructureUsageRefBaseType**//**: **StructureUsageRefBaseType is an abstract base type for referencing a structure usage.
1405
1406 Derivation:
1407
1408 * //RefBaseType// (restriction)
1409 ** //MaintainableRefBaseType// (restriction)
1410 *** //StructureOrUsageRefBaseType// (restriction)
1411 **** //StructureUsageRefBaseType//
1412
1413 Attributes:
1414 agencyID, id, version?, local?, class?, package?
1415
1416 Content:
1417 {Empty}
1418
1419 Attribute Documentation:
1420
1421 |**Name**|**Type**|**Documentation**
1422 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
1423 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
1424 |version (default: 1.0)|VersionType|The version attribute identifies the version of the object being reference, if applicable. If this is available, a default value of 1.0 will always apply.
1425 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
1426 |class|StructureUsageTypeCo delistType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1427 |package|StructurePackageType CodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1428
1429 **StructureUsageRefType: **StructureUsageRefType contains a set of reference fields for referencing any structure usage.
1430
1431 Derivation:
1432
1433 * //RefBaseType// (restriction)
1434 ** //MaintainableRefBaseType// (restriction)
1435 *** //StructureOrUsageRefBaseType// (restriction)
1436 **** //StructureUsageRefBaseType// (restriction)
1437 ***** StructureUsageRefType
1438
1439 Attributes:
1440 agencyID, id, version?, local?, class, package
1441
1442 Content:
1443 {Empty}
1444
1445 Attribute Documentation:
1446
1447 |**Name**|**Type**|**Documentation**
1448 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
1449 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
1450 |version (default: 1.0)|VersionType|The version attribute identifies the version of the object being reference, if applicable. If this is available, a default value of 1.0 will always apply.
1451 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
1452 |class|StructureUsageTypeCo delistType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1453 |package|StructurePackageType CodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1454
1455 //**ChildObjectRefBaseType**//**: **ChildObjectRefBaseType is an abstract base type for referencing any child object defined directly within a maintainable object.
1456
1457 Derivation:
1458
1459 * //RefBaseType// (restriction)
1460 ** //ChildObjectRefBaseType//
1461
1462 Attributes:
1463 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
1464
1465 Content:
1466 {Empty}
1467
1468 Attribute Documentation:
1469
1470 |**Name**|**Type**|**Documentation**
1471 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
1472 |maintainableParentID|IDType|The maintainableParentID attribute identifies the maintainable object in which the referenced object is defined, if applicable (maintainable-parent-object-id in the URN structure). This is only used in references where the referenced object is not itself maintainable.
1473 |maintainableParentVersion (default: 1.0)|VersionType|The maintainableParentVersion attribute identifies the version of the maintainable object in which the referenced object is defined (maintainable-parent-object-version in the URN structure). This is only used in references where the referenced object is not itself maintainable. This should only be used when the maintainableParentID is present. If this is available, a default of 1.0 will always apply.
1474 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
1475 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
1476 |class|ObjectTypeCodelistTy pe|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1477 |package|PackageTypeCodelistT ype|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1478
1479 //**ContainerChildObjectRefBaseType**//**: **ContainerChildObjectRefBaseType is an abstract base type for referencing any child object within container defined in a maintainable object.
1480
1481 Derivation:
1482
1483 * //RefBaseType// (restriction)
1484 ** //ContainerChildObjectRefBaseType//
1485
1486 Attributes:
1487 agencyID, maintainableParentID, maintainableParentVersion?, containerID?, id, version?, local?, class?, package?
1488
1489 Content:
1490 {Empty}
1491
1492 Attribute Documentation:
1493
1494 |**Name**|**Type**|**Documentation**
1495 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
1496 |maintainableParentID|IDType|The maintainableParentID attribute identifies the maintainable object in which the referenced object is defined, if applicable (maintainable-parent-object-id in the URN structure). This is only used in references where the referenced object is not itself maintainable.
1497 |maintainableParentVersion (default: 1.0)|VersionType|The maintainableParentVersion attribute identifies the version of the maintainable object in which the referenced object is defined (maintainable-parent-object-version in the URN structure). This is only used in references where the referenced object is not itself maintainable. This should only be used when the maintainableParentID is present. If this is available, a default of 1.0 will always apply.
1498 |containerID|NestedIDType|The containerID attribute identifies the object within a maintainable object in which the referenced object is defined (container-object-id in the URN structure). This is only used in references where the referenced object is not contained directly within a maintainable object (e.g. a Component within a ComponentList, within a maintainable Structure). If the container has a fixed identifier, this attribute will not be present.
1499 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
1500 |version|VersionType|The version attribute identifies the version of the object being reference, if applicable. If this is available, a default value of 1.0 will always apply.
1501 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
1502 |class|ObjectTypeCodelistTy pe|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1503 |package|PackageTypeCodelistT ype|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1504
1505 //**ItemRefBaseType**//**: **ItemRefBaseType is an abstract base type for referencing an item within an item scheme.
1506
1507 Derivation:
1508
1509 * //RefBaseType// (restriction)
1510 ** //ChildObjectRefBaseType// (restriction)
1511 *** //ItemRefBaseType//
1512
1513 Attributes:
1514 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
1515
1516 Content:
1517 {Empty}
1518
1519 Attribute Documentation:
1520
1521 |**Name**|**Type**|**Documentation**
1522 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
1523 |maintainableParentID|IDType|The maintainableParentID references the item scheme in which the item being referenced is defined.
1524 |maintainableParentVersion (default: 1.0)|VersionType|The maintainableParentVersion attribute references the version of the item scheme in which the item being referenced is defined. If not supplied, a default value of 1.0 is assumed.
1525 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
1526 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
1527 |class|ItemTypeCodelistType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1528 |package|ItemSchemePackageTyp eCodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1529
1530 //**ComponentListRefBaseType**//**: **ComponentListRefBaseType is an abstract base type for referencing a component list within a structure.
1531
1532 Derivation:
1533
1534 * //RefBaseType// (restriction)
1535 ** //ChildObjectRefBaseType// (restriction)
1536 *** //ComponentListRefBaseType//
1537
1538 Attributes:
1539 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
1540
1541 Content:
1542 {Empty}
1543
1544 Attribute Documentation:
1545
1546 |**Name**|**Type**|**Documentation**
1547 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
1548 |maintainableParentID|IDType|The maintainableParentID references the structure in which the component list being referenced is defined.
1549 |maintainableParentVersion (default: 1.0)|VersionType|The maintainableParentVersion attribute references the version of the structure in which the component list being referenced is defined. If not supplied, a default value of 1.0 is assumed.
1550 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
1551 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
1552 |class|ComponentListTypeCod elistType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1553 |package|StructurePackageType CodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1554
1555 //**ComponentRefBaseType**//**: **ComponentRefBaseType is an abstract base type for referencing a component contained in a component list within a structure.
1556
1557 Derivation:
1558
1559 * //RefBaseType// (restriction)
1560 ** //ContainerChildObjectRefBaseType// (restriction)
1561 *** //ComponentRefBaseType//
1562
1563 Attributes:
1564 agencyID, maintainableParentID, maintainableParentVersion?, containerID?, id, version?, local?, class?, package?
1565
1566 Content:
1567 {Empty}
1568
1569 Attribute Documentation:
1570
1571 |**Name**|**Type**|**Documentation**
1572 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
1573 |maintainableParentID|IDType|The maintainableParentID references the structure in which the component being referenced is defined.
1574 |maintainableParentVersion (default: 1.0)|VersionType|The maintainableParentVersion attribute references the version of the structure in which the component being referenced is defined. If not supplied, a default value of 1.0 is assumed.
1575 |containerID|NestedIDType|The containerID attribute references the component list of that contains the component being referenced. It is optional for the cases where the component list has a fixed identifier. Specific implementations of this will prohibit or require this accordingly.
1576 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
1577 |version|VersionType|The version attribute identifies the version of the object being reference, if applicable. If this is available, a default value of 1.0 will always apply.
1578 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
1579 |class|ComponentTypeCodelis tType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1580 |package|StructurePackageType CodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1581
1582 **AnyCodelistRefType: **AnyCodelistRefType is a type for referencing any codelist object (either a codelist or a hierarchical codelist).
1583
1584 Derivation:
1585
1586 * //RefBaseType// (restriction)
1587 ** //MaintainableRefBaseType// (restriction)
1588 *** AnyCodelistRefType
1589
1590 Attributes:
1591 agencyID, id, version?, local?, class, package?
1592
1593 Content:
1594 {Empty}
1595
1596 Attribute Documentation:
1597
1598 |**Name**|**Type**|**Documentation**
1599 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
1600 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
1601 |version (default: 1.0)|VersionType|The version attribute identifies the version of the object being reference, if applicable. If this is available, a default value of 1.0 will always apply.
1602 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
1603 |class|CodelistTypeCodelist Type|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1604 |package (fixed: codelist)|PackageTypeCodelistT ype|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1605
1606 **StructureOrUsageRefType: **StructureOrUsageRefType is a type for referencing a structure or structure usage.
1607
1608 Derivation:
1609
1610 * //RefBaseType// (restriction)
1611 ** //MaintainableRefBaseType// (restriction)
1612 *** //StructureOrUsageRefBaseType// (restriction)
1613 **** StructureOrUsageRefType
1614
1615 Attributes:
1616 agencyID, id, version?, local?, class, package
1617
1618 Content:
1619 {Empty}
1620
1621 Attribute Documentation:
1622
1623 |**Name**|**Type**|**Documentation**
1624 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
1625 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
1626 |version (default: 1.0)|VersionType|The version attribute identifies the version of the object being reference, if applicable. If this is available, a default value of 1.0 will always apply.
1627 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
1628 |class|StructureOrUsageType CodelistType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1629 |package|StructurePackageType CodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1630
1631 //**LocalIdentifiableRefBaseType**//**: **LocalIdentifiableRefBaseType is an abstract base type which provides a local reference to any identifiable object.
1632
1633 Derivation:
1634
1635 * //RefBaseType// (restriction)
1636 ** //LocalIdentifiableRefBaseType//
1637
1638 Attributes:
1639 containerID?, id, local?, class?, package?
1640
1641 Content:
1642 {Empty}
1643
1644 Attribute Documentation:
1645
1646 |**Name**|**Type**|**Documentation**
1647 |containerID|NestedIDType|The containerID attribute identifies the object within a maintainable object in which the referenced object is defined (container-object-id in the URN structure). This is only used in references where the referenced object is not contained directly within a maintainable object (e.g. a Component within a ComponentList, within a maintainable Structure). If the container has a fixed identifier, this attribute will not be present.
1648 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
1649 |local (fixed: true)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
1650 |class|ObjectTypeCodelistTy pe|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1651 |package|PackageTypeCodelistT ype|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1652
1653 //**LocalItemRefBaseType**//**: **LocalItemRefBaseType is an abstract base type which provides a local reference to a item object.
1654
1655 Derivation:
1656
1657 * //RefBaseType// (restriction)
1658 ** //LocalIdentifiableRefBaseType// (restriction)
1659 *** //LocalItemRefBaseType//
1660
1661 Attributes:
1662 id, local?, class?, package?
1663
1664 Content:
1665 {Empty}
1666
1667 Attribute Documentation:
1668
1669 |**Name**|**Type**|**Documentation**
1670 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
1671 |local (fixed: true)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
1672 |class|ItemTypeCodelistType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1673 |package|ItemSchemePackageTyp eCodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1674
1675 //**LocalComponentListRefBaseType**//**: **LocalComponentListRefBaseType is an abstract base type which provides a local reference to a component list object.
1676
1677 Derivation:
1678
1679 * //RefBaseType// (restriction)
1680 ** //LocalIdentifiableRefBaseType// (restriction)
1681 *** //LocalComponentListRefBaseType//
1682
1683 Attributes:
1684 id, local?, class?, package?
1685
1686 Content:
1687 {Empty}
1688
1689 Attribute Documentation:
1690
1691 |**Name**|**Type**|**Documentation**
1692 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
1693 |local (fixed: true)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
1694 |class|ComponentListTypeCod elistType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1695 |package|StructurePackageType CodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1696
1697 //**LocalComponentListComponentRefBaseType**//**: **LocalComponentRefBaseType is an abstract base type which provides a local reference to a component object.
1698
1699 Derivation:
1700
1701 * //RefBaseType// (restriction)
1702 ** //LocalIdentifiableRefBaseType// (restriction)
1703 *** //LocalComponentListComponentRefBaseType//
1704
1705 Attributes:
1706 containerID?, id, local?, class?, package?
1707
1708 Content:
1709 {Empty}
1710
1711 Attribute Documentation:
1712
1713 |**Name**|**Type**|**Documentation**
1714 |containerID|IDType|The containerID attribute identifies the object within a maintainable object in which the referenced object is defined (container-object-id in the URN structure). This is only used in references where the referenced object is not contained directly within a maintainable object (e.g. a Component within a ComponentList, within a maintainable Structure). If the container has a fixed identifier, this attribute will not be present.
1715 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
1716 |local (fixed: true)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
1717 |class|ObjectTypeCodelistTy pe|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1718 |package|PackageTypeCodelistT ype|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1719
1720 **LocalComponentListComponentRefType: **LocalComponentListComponentRefType provides a local reference to any component object within a specific component list. References for both of these are required as well as an indication of which type of type of component is being referenced via the class attribute.
1721
1722 Derivation:
1723
1724 * //RefBaseType// (restriction)
1725 ** //LocalIdentifiableRefBaseType// (restriction)
1726 *** //LocalComponentListComponentRefBaseType// (restriction)
1727 **** LocalComponentListComponentRefType
1728
1729 Attributes:
1730 containerID, id, local?, class, package
1731
1732 Content:
1733 {Empty}
1734
1735 Attribute Documentation:
1736
1737 |**Name**|**Type**|**Documentation**
1738 |containerID|IDType|The containerID attribute identifies the object within a maintainable object in which the referenced object is defined (container-object-id in the URN structure). This is only used in references where the referenced object is not contained directly within a maintainable object (e.g. a Component within a ComponentList, within a maintainable Structure). If the container has a fixed identifier, this attribute will not be present.
1739 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
1740 |local (fixed: true)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
1741 |class|ComponentTypeCodelis tType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1742 |package|StructurePackageType CodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1743
1744 //**LocalComponentRefBaseType**//**: **LocalComponentRefBaseType is an abstract base type which provides a local reference to a component object.
1745
1746 Derivation:
1747
1748 * //RefBaseType// (restriction)
1749 ** //LocalIdentifiableRefBaseType// (restriction)
1750 *** //LocalComponentListComponentRefBaseType// (restriction)
1751 **** //LocalComponentRefBaseType//
1752
1753 Attributes:
1754 id, local?, class?, package?
1755
1756 Content:
1757 {Empty}
1758
1759 Attribute Documentation:
1760
1761 |**Name**|**Type**|**Documentation**
1762 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
1763 |local (fixed: true)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
1764 |class|ObjectTypeCodelistTy pe|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1765 |package|PackageTypeCodelistT ype|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1766
1767 **LocalComponentRefType: **LocalComponentRefType provides a local reference to any type component object.
1768
1769 Derivation:
1770
1771 * //RefBaseType// (restriction)
1772 ** //LocalIdentifiableRefBaseType// (restriction)
1773 *** //LocalComponentListComponentRefBaseType// (restriction)
1774 **** //LocalComponentRefBaseType// (restriction)
1775 ***** LocalComponentRefType
1776
1777 Attributes:
1778 id, local?, class, package
1779
1780 Content:
1781 {Empty}
1782
1783 Attribute Documentation:
1784
1785 |**Name**|**Type**|**Documentation**
1786 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
1787 |local (fixed: true)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
1788 |class|ComponentTypeCodelis tType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1789 |package|StructurePackageType CodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1790
1791 **AnyLocalCodeRefType: **AnyLocalCodeRefType provides a local reference to any code object.
1792
1793 Derivation:
1794
1795 * //RefBaseType// (restriction)
1796 ** AnyLocalCodeRefType
1797
1798 Attributes:
1799 containerID?, id, version?, local?, class?, package?
1800
1801 Content:
1802 {Empty}
1803
1804 Attribute Documentation:
1805
1806 |**Name**|**Type**|**Documentation**
1807 |containerID|IDType|The containerID attribute references the hierarchy which defines the hierarchical code in the case that this reference is for a hierarchical code.
1808 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
1809 |version|VersionType|The version attribute identifies the version of the object being reference, if applicable. If this is available, a default value of 1.0 will always apply.
1810 |local (fixed: true)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
1811 |class|CodeTypeCodelistType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1812 |package (fixed: codelist)|PackageTypeCodelistT ype|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1813
1814 **URNReferenceType: **URNReferenceType is a type referencing any object via its URN. The exact type of object is not specified, although it can be determined from the URN value.
1815
1816 Derivation:
1817
1818 * //ReferenceType// (restriction)
1819 ** URNReferenceType
1820
1821 Content:
1822 URN
1823
1824 Element Documentation:
1825
1826 |**Name**|**Type**|**Documentation**
1827 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
1828
1829 //**MaintainableReferenceBaseType**//**: **MaintainableReferenceBaseType is an abstract base type for referencing a maintainable object. It consists of a URN and/or a complete set of reference fields; agency, id, and version.
1830
1831 Derivation:
1832
1833 * //ReferenceType// (restriction)
1834 ** //MaintainableReferenceBaseType//
1835
1836 Content:
1837 ( (Ref, URN?) | URN)
1838
1839 Element Documentation:
1840
1841 |**Name**|**Type**|**Documentation**
1842 |Ref|//MaintainableRefBaseT ype//|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
1843 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
1844 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
1845
1846 **MaintainableReferenceType: **MaintainableReferenceType is a type for referencing any maintainable object. It consists of a URN and/or a complete set of reference fields; agency, id, and version.
1847
1848 Derivation:
1849
1850 * //ReferenceType// (restriction)
1851 ** //MaintainableReferenceBaseType// (restriction)
1852 *** MaintainableReferenceType
1853
1854 Content:
1855 ( (Ref, URN?) | URN)
1856
1857 Element Documentation:
1858
1859 |**Name**|**Type**|**Documentation**
1860 |Ref|MaintainableRefType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
1861 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
1862 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
1863
1864 //**LocalIdentifiableReferenceType**//**: **LocalIdentifiableReferenceType is an abstract base type for referencing an identifiable object locally, where the maintainable object in which it is defined is referenced in another context..
1865
1866 Derivation:
1867
1868 * //ReferenceType// (restriction)
1869 ** //LocalIdentifiableReferenceType//
1870
1871 Content:
1872 Ref
1873
1874 Element Documentation:
1875
1876 |**Name**|**Type**|**Documentation**
1877 |Ref|//LocalIdentifiableRef BaseType//|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
1878
1879 //**StructureReferenceBaseType**//**: **StructureReferneceBaseType is a specific type of MaintainableReference that is used for referencing structure definitions. It consists of a URN and/or a complete set of reference fields; agency, id, and version.
1880
1881 Derivation:
1882
1883 * //ReferenceType// (restriction)
1884 ** //MaintainableReferenceBaseType// (restriction)
1885 *** //StructureReferenceBaseType//
1886
1887 Content:
1888 ( (Ref, URN?) | URN)
1889
1890 Element Documentation:
1891
1892 |**Name**|**Type**|**Documentation**
1893 |Ref|//StructureRefBaseType//|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
1894 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
1895 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
1896
1897 **StructureReferenceType: **StructureReferenceType is a specific type of MaintainableReference that is used for referencing any structure. It consists of a URN and/or a complete set of reference fields; agency, id, and version.
1898
1899 Derivation:
1900
1901 * //ReferenceType// (restriction)
1902 ** //MaintainableReferenceBaseType// (restriction)
1903 *** //StructureReferenceBaseType// (restriction)
1904 **** StructureReferenceType
1905
1906 Content:
1907 ( (Ref, URN?) | URN)
1908
1909 Element Documentation:
1910
1911 |**Name**|**Type**|**Documentation**
1912 |Ref|StructureRefType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
1913 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
1914 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
1915
1916 //**StructureUsageReferenceBaseType**//**: **StructureUsageReferenceBaseType is a specific type of MaintainableReference that is used for referencing structure usages. It consists of a URN and/or a complete set of reference fields; agency, id, and version.
1917
1918 Derivation:
1919
1920 * //ReferenceType// (restriction)
1921 ** //MaintainableReferenceBaseType// (restriction)
1922 *** //StructureUsageReferenceBaseType//
1923
1924 Content:
1925 ( (Ref, URN?) | URN)
1926
1927 Element Documentation:
1928
1929 |**Name**|**Type**|**Documentation**
1930 |Ref|//StructureUsageRefBas eType//|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
1931 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
1932 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
1933
1934 **StructureUsageReferenceType: **StructureUsageReferenceType is a specific type of MaintainableReference that is used for referencing any structure usages. It consists of a URN and/or a complete set of reference fields; agency, id, and version.
1935
1936 Derivation:
1937
1938 * //ReferenceType// (restriction)
1939 ** //MaintainableReferenceBaseType// (restriction)
1940 *** //StructureUsageReferenceBaseType// (restriction)
1941 **** StructureUsageReferenceType
1942
1943 Content:
1944 ( (Ref, URN?) | URN)
1945
1946 Element Documentation:
1947
1948 |**Name**|**Type**|**Documentation**
1949 |Ref|StructureUsageRefTyp e|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
1950 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
1951 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
1952
1953 //**ItemSchemeReferenceBaseType**//**: **ItemSchemeReferenceBaseType is a specific type of MaintainableReference that is used for referencing item schemes. It consists of a URN and/or a complete set of reference fields; agency, id, and version.
1954
1955 Derivation:
1956
1957 * //ReferenceType// (restriction)
1958 ** //MaintainableReferenceBaseType// (restriction)
1959 *** //ItemSchemeReferenceBaseType//
1960
1961 Content:
1962 ( (Ref, URN?) | URN)
1963
1964 Element Documentation:
1965
1966 |**Name**|**Type**|**Documentation**
1967 |Ref|//ItemSchemeRefBaseTyp e//|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
1968 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
1969 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
1970
1971 **ItemSchemeReferenceType: **ItemSchemeReferenceType is a reference that is used for referencing any type of item scheme. It consists of a URN and/or a complete set of reference fields; agency, id, and version.
1972
1973 Derivation:
1974
1975 * //ReferenceType// (restriction)
1976 ** //MaintainableReferenceBaseType// (restriction)
1977 *** //ItemSchemeReferenceBaseType// (restriction)
1978 **** ItemSchemeReferenceType
1979
1980 Content:
1981 ( (Ref, URN?) | URN)
1982
1983 Element Documentation:
1984
1985 |**Name**|**Type**|**Documentation**
1986 |Ref|ItemSchemeRefType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
1987 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
1988 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
1989
1990 //**ChildObjectReferenceType**//**: **ChildObjectReferenceType is an abstract base type used for referencing a particular object defined directly within a maintainable object. It consists of a URN and/or a complete set of reference fields; agency, maintainable id (maintainableParentID), maintainable version (maintainableParentVersion), the object id (which can be nested), and optionally the object version (if applicable).
1991
1992 Derivation:
1993
1994 * //ReferenceType// (restriction)
1995 ** //ChildObjectReferenceType//
1996
1997 Content:
1998 ( (Ref, URN?) | URN)
1999
2000 Element Documentation:
2001
2002 |**Name**|**Type**|**Documentation**
2003 |Ref|//ChildObjectRefBaseTy pe//|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
2004 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2005 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2006
2007 //**ContainerChildObjectReferenceType**//**: **ContainerChildObjectReferenceType is an abstract base type used for referencing a particular object defined in a container object within a maintainable object. It consists of a URN and/or a complete set of reference fields; agency, maintainable id (maintainableParentID), maintainable version (maintainableParentVersion), container id (which is optional in order to allow for containers with fixed values to be omitted), container version (if applicable), the object id (which can be nested), and optionally the object version (if applicable).
2008
2009 Derivation:
2010
2011 * //ReferenceType// (restriction)
2012 ** //ContainerChildObjectReferenceType//
2013
2014 Content:
2015 ( (Ref, URN?) | URN)
2016
2017 Element Documentation:
2018
2019 |**Name**|**Type**|**Documentation**
2020 |Ref|//ContainerChildObject RefBaseType//|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
2021 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2022 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2023
2024 //**ItemReferenceType**//**: **ItemReferenceType is an abstract base type used for referencing a particular item within an item scheme. Note that this reference also has the ability to reference items contained within other items inside of the item scheme. It consists of a URN and/or a complete set of reference fields; agency, scheme id (maintainableParentID), scheme version (maintainableParentVersion), and item id (which can be nested).
2025
2026 Derivation:
2027
2028 * //ReferenceType// (restriction)
2029 ** //ChildObjectReferenceType// (restriction)
2030 *** //ItemReferenceType//
2031
2032 Content:
2033 ( (Ref, URN?) | URN)
2034
2035 Element Documentation:
2036
2037 |**Name**|**Type**|**Documentation**
2038 |Ref|//ItemRefBaseType//|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
2039 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2040 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2041
2042 //**ComponentListReferenceType**//**: **ComponentListReferenceType is an abstract base type used for referencing component lists within a structure. It consists of a URN and/or a complete set of reference fields (structure agency, structure id, structure version, and component list id).
2043
2044 Derivation:
2045
2046 * //ReferenceType// (restriction)
2047 ** //ChildObjectReferenceType// (restriction)
2048 *** //ComponentListReferenceType//
2049
2050 Content:
2051 ( (Ref, URN?) | URN)
2052
2053 Element Documentation:
2054
2055 |**Name**|**Type**|**Documentation**
2056 |Ref|//ComponentListRefBase Type//|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
2057 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2058 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2059
2060 //**ComponentReferenceType**//**: **ComponentReferenceType is an abstract base type used for referencing components within a structure definition. It consists of a URN and/or a complete set of reference fields (structure agency, structure id, structure version, component list id, and component id).
2061
2062 Derivation:
2063
2064 * //ReferenceType// (restriction)
2065 ** //ContainerChildObjectReferenceType// (restriction)
2066 *** //ComponentReferenceType//
2067
2068 Content:
2069 ( (Ref, URN?) | URN)
2070
2071 Element Documentation:
2072
2073 |**Name**|**Type**|**Documentation**
2074 |Ref|//ComponentRefBaseType//|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
2075 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2076 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2077
2078 //**LocalItemReferenceType**//**: **LocalItemReferenceType is an abstract base type which provides a simple reference to an item where the reference to the item scheme which defines it are provided in another context.
2079
2080 Derivation:
2081
2082 * //ReferenceType// (restriction)
2083 ** //LocalItemReferenceType//
2084
2085 Content:
2086 Ref
2087
2088 Element Documentation:
2089
2090 |**Name**|**Type**|**Documentation**
2091 |Ref|//LocalItemRefBaseType//|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
2092
2093 //**LocalComponentListReferenceType**//**: **LocalComponentListReferenceType is an abstract base type which provides a simple reference to a component list where the reference to the structure which defines it is provided in another context.
2094
2095 Derivation:
2096
2097 * //ReferenceType// (restriction)
2098 ** //LocalComponentListReferenceType//
2099
2100 Content:
2101 Ref
2102
2103 Element Documentation:
2104
2105 |**Name**|**Type**|**Documentation**
2106 |Ref|//LocalComponentListRe fBaseType//|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
2107
2108 //**LocalComponentListComponentReferenceBaseType**//**: **LocalComponentListComponentReferenceBaseType is an abstract base type which provides a simple reference to any type of component in a specific component list where the reference to the structure which defines it are provided in another context, and the component list may or may not be defined in another context.
2109
2110 Derivation:
2111
2112 * //ReferenceType// (restriction)
2113 ** //LocalComponentListComponentReferenceBaseType//
2114
2115 Content:
2116 Ref
2117
2118 Element Documentation:
2119
2120 |**Name**|**Type**|**Documentation**
2121 |Ref|//LocalComponentListCo mponentRefBaseType//|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
2122
2123 **LocalComponentListComponentReferenceType: **LocalComponentListComponentReferenceType provides a simple reference to any type of component in a specific component list where the reference to the structure which defines it are provided in another context.
2124
2125 Derivation:
2126
2127 * //ReferenceType// (restriction)
2128 ** //LocalComponentListComponentReferenceBaseType// (restriction)
2129 *** LocalComponentListComponentReferenceType
2130
2131 Content:
2132 Ref
2133
2134 Element Documentation:
2135
2136 |**Name**|**Type**|**Documentation**
2137 |Ref|LocalComponentListCo mponentRefType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
2138
2139 //**LocalComponentReferenceBaseType**//**: **LocalComponentReferenceBaseType is an abstract base type which provides a simple reference to a component where the references to the component list which contains it and the structure which defines it are provided in another context.
2140
2141 Derivation:
2142
2143 * //ReferenceType// (restriction)
2144 ** //LocalComponentListComponentReferenceBaseType// (restriction)
2145 *** //LocalComponentReferenceBaseType//
2146
2147 Content:
2148 Ref
2149
2150 Element Documentation:
2151
2152 |**Name**|**Type**|**Documentation**
2153 |Ref|//LocalComponentRefBas eType//|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
2154
2155 **LocalComponentReferenceType: **LocalComponentReferenceType provides a simple reference to any type of component in a component list where the references to the component list and the structure which defines them are provided in another context.
2156
2157 Derivation:
2158
2159 * //ReferenceType// (restriction)
2160 ** //LocalComponentListComponentReferenceBaseType// (restriction)
2161 *** LocalComponentReferenceType
2162
2163 Content:
2164 Ref
2165
2166 Element Documentation:
2167
2168 |**Name**|**Type**|**Documentation**
2169 |Ref|LocalComponentRefTyp e|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
2170
2171 **StructureOrUsageReferenceType: **StructureOrUsageReferenceType is a specific type of a reference for referencing either a structure or a structure usage. It consists of a URN and/or a complete set of reference fields; agency, id and version. If the complete set of reference fields is used, it is required that a class and package be provided so that the type of object referenced is clear.
2172
2173 Derivation:
2174
2175 * //ReferenceType// (restriction)
2176 ** //MaintainableReferenceBaseType// (restriction)
2177 *** StructureOrUsageReferenceType
2178
2179 Content:
2180 ( (Ref, URN?) | URN)
2181
2182 Element Documentation:
2183
2184 |**Name**|**Type**|**Documentation**
2185 |Ref|StructureOrUsageRefT ype|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
2186 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2187 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2188
2189 **CategorisationReferenceType: **CategorisationReferenceType is a type for referencing a categorisation object. It consists of a URN and/or a complete set of reference fields.
2190
2191 Derivation:
2192
2193 * //ReferenceType// (restriction)
2194 ** //MaintainableReferenceBaseType// (restriction)
2195 *** CategorisationReferenceType
2196
2197 Content:
2198 ( (Ref, URN?) | URN)
2199
2200 Element Documentation:
2201
2202 |**Name**|**Type**|**Documentation**
2203 |Ref|CategorisationRefTyp e|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
2204 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2205 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2206
2207 **CategorisationRefType: **CategorisationRefType provides a reference to a categorisation via a complete set of reference fields.
2208
2209 Derivation:
2210
2211 * //RefBaseType// (restriction)
2212 ** //MaintainableRefBaseType// (restriction)
2213 *** CategorisationRefType
2214
2215 Attributes:
2216 agencyID, id, version?, local?, class?, package?
2217
2218 Content:
2219 {Empty}
2220
2221 Attribute Documentation:
2222
2223 |**Name**|**Type**|**Documentation**
2224 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
2225 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
2226 |version (default: 1.0)|VersionType|The version attribute identifies the version of the object being reference, if applicable. If this is available, a default value of 1.0 will always apply.
2227 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
2228 |class (fixed: Categorisation)|MaintainableTypeCode listType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
2229 |package (fixed: categoryscheme)|PackageTypeCodelistT ype|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
2230
2231 **CategorySchemeReferenceType: **CategorySchemeReferenceType is a type for referencing a category scheme object. It consists of a URN and/or a complete set of reference fields.
2232
2233 Derivation:
2234
2235 * //ReferenceType// (restriction)
2236 ** //MaintainableReferenceBaseType// (restriction)
2237 *** //ItemSchemeReferenceBaseType// (restriction)
2238 **** CategorySchemeReferenceType
2239
2240 Content:
2241 ( (Ref, URN?) | URN)
2242
2243 Element Documentation:
2244
2245 |**Name**|**Type**|**Documentation**
2246 |Ref|CategorySchemeRefTyp e|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
2247 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2248 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2249
2250 **CategorySchemeRefType: **CategorySchemeRefType provides a reference to a category scheme via a complete set of reference fields.
2251
2252 Derivation:
2253
2254 * //RefBaseType// (restriction)
2255 ** //MaintainableRefBaseType// (restriction)
2256 *** //ItemSchemeRefBaseType// (restriction)
2257 **** CategorySchemeRefType
2258
2259 Attributes:
2260 agencyID, id, version?, local?, class?, package?
2261
2262 Content:
2263 {Empty}
2264
2265 Attribute Documentation:
2266
2267 |**Name**|**Type**|**Documentation**
2268 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
2269 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
2270 |version (default: 1.0)|VersionType|The version attribute identifies the version of the object being reference, if applicable. If this is available, a default value of 1.0 will always apply.
2271 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
2272 |class (fixed: CategoryScheme)|ItemSchemeTypeCodeli stType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
2273 |package (fixed: categoryscheme)|ItemSchemePackageTyp eCodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
2274
2275 **CategoryReferenceType: **CategoryReferenceType is a type for referencing a category object. It consists of a URN and/or a complete set of reference fields.
2276
2277 Derivation:
2278
2279 * //ReferenceType// (restriction)
2280 ** //ChildObjectReferenceType// (restriction)
2281 *** //ItemReferenceType// (restriction)
2282 **** CategoryReferenceType
2283
2284 Content:
2285 ( (Ref, URN?) | URN)
2286
2287 Element Documentation:
2288
2289 |**Name**|**Type**|**Documentation**
2290 |Ref|CategoryRefType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
2291 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2292 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2293
2294 **CategoryRefType: **CategoryRefType references a category from within a category scheme. Reference fields are required for both the scheme and the item.
2295
2296 Derivation:
2297
2298 * //RefBaseType// (restriction)
2299 ** //ChildObjectRefBaseType// (restriction)
2300 *** //ItemRefBaseType// (restriction)
2301 **** CategoryRefType
2302
2303 Attributes:
2304 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
2305
2306 Content:
2307 {Empty}
2308
2309 Attribute Documentation:
2310
2311 |**Name**|**Type**|**Documentation**
2312 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
2313 |maintainableParentID|IDType|The maintainableParentID references the category scheme in which the category being referenced is defined.
2314 |maintainableParentVersion (default: 1.0)|VersionType|The maintainableParentVersion attribute references the version of the category scheme in which the category being referenced is defined. If not supplied, a default value of 1.0 is assumed.
2315 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
2316 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
2317 |class (fixed: Category)|ItemTypeCodelistType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
2318 |package (fixed: categoryscheme)|ItemSchemePackageTyp eCodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
2319
2320 **LocalCategoryReferenceType: **LocalCategoryReferenceType provides a simple references to a category where the identification of the category scheme which defines it is contained in another context.
2321
2322 Derivation:
2323
2324 * //ReferenceType// (restriction)
2325 ** //LocalItemReferenceType// (restriction)
2326 *** LocalCategoryReferenceType
2327
2328 Content:
2329 Ref
2330
2331 Element Documentation:
2332
2333 |**Name**|**Type**|**Documentation**
2334 |Ref|LocalCategoryRefType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
2335
2336 **LocalCategoryRefType: **LocalCategoryRefType references a category locally where the references to the category scheme which defines it is provided elsewhere.
2337
2338 Derivation:
2339
2340 * //RefBaseType// (restriction)
2341 ** //LocalIdentifiableRefBaseType// (restriction)
2342 *** //LocalItemRefBaseType// (restriction)
2343 **** LocalCategoryRefType
2344
2345 Attributes:
2346 id, local?, class?, package?
2347
2348 Content:
2349 {Empty}
2350
2351 Attribute Documentation:
2352
2353 |**Name**|**Type**|**Documentation**
2354 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
2355 |local (fixed: true)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
2356 |class (fixed: Category)|ItemTypeCodelistType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
2357 |package (fixed: categoryscheme)|ItemSchemePackageTyp eCodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
2358
2359 **CodelistReferenceType: **CodelistReferenceType is a type for referencing a codelist object. It consists of a URN and/or a complete set of reference fields.
2360
2361 Derivation:
2362
2363 * //ReferenceType// (restriction)
2364 ** //MaintainableReferenceBaseType// (restriction)
2365 *** //ItemSchemeReferenceBaseType// (restriction)
2366 **** CodelistReferenceType
2367
2368 Content:
2369 ( (Ref, URN?) | URN)
2370
2371 Element Documentation:
2372
2373 |**Name**|**Type**|**Documentation**
2374 |Ref|CodelistRefType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
2375 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2376 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2377
2378 **CodelistRefType: **CodelistRefType provides a reference to a codelist via a complete set of reference fields.
2379
2380 Derivation:
2381
2382 * //RefBaseType// (restriction)
2383 ** //MaintainableRefBaseType// (restriction)
2384 *** //ItemSchemeRefBaseType// (restriction)
2385 **** CodelistRefType
2386
2387 Attributes:
2388 agencyID, id, version?, local?, class?, package?
2389
2390 Content:
2391 {Empty}
2392
2393 Attribute Documentation:
2394
2395 |**Name**|**Type**|**Documentation**
2396 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
2397 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
2398 |version (default: 1.0)|VersionType|The version attribute identifies the version of the object being reference, if applicable. If this is available, a default value of 1.0 will always apply.
2399 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
2400 |class (fixed: Codelist)|ItemSchemeTypeCodeli stType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
2401 |package (fixed: codelist)|ItemSchemePackageTyp eCodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
2402
2403 **CodeReferenceType: **CodeReferenceType is a type for referencing a code object. It consists of a URN and/or a complete set of reference fields.
2404
2405 Derivation:
2406
2407 * //ReferenceType// (restriction)
2408 ** //ChildObjectReferenceType// (restriction)
2409 *** //ItemReferenceType// (restriction)
2410 **** CodeReferenceType
2411
2412 Content:
2413 ( (Ref, URN?) | URN)
2414
2415 Element Documentation:
2416
2417 |**Name**|**Type**|**Documentation**
2418 |Ref|CodeRefType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
2419 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2420 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2421
2422 **CodeRefType: **CodeRefType references a code from within a codelist. Reference fields are required for both the scheme and the item.
2423
2424 Derivation:
2425
2426 * //RefBaseType// (restriction)
2427 ** //ChildObjectRefBaseType// (restriction)
2428 *** //ItemRefBaseType// (restriction)
2429 **** CodeRefType
2430
2431 Attributes:
2432 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
2433
2434 Content:
2435 {Empty}
2436
2437 Attribute Documentation:
2438
2439 |**Name**|**Type**|**Documentation**
2440 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
2441 |maintainableParentID|IDType|The maintainableParentID references the codelist in which the code being referenced is defined.
2442 |maintainableParentVersion (default: 1.0)|VersionType|The maintainableParentVersion attribute references the version of the codelist in which the code being referenced is defined. If not supplied, a default value of 1.0 is assumed.
2443 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
2444 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
2445 |class (fixed: Code)|ItemTypeCodelistType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
2446 |package (fixed: codelist)|ItemSchemePackageTyp eCodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
2447
2448 **LocalCodeReferenceType: **LocalCodeReferenceType provides a simple references to a code where the identification of the codelist which defines it is contained in another context.
2449
2450 Derivation:
2451
2452 * //ReferenceType// (restriction)
2453 ** //LocalItemReferenceType// (restriction)
2454 *** LocalCodeReferenceType
2455
2456 Content:
2457 Ref
2458
2459 Element Documentation:
2460
2461 |**Name**|**Type**|**Documentation**
2462 |Ref|LocalCodeRefType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
2463
2464 **LocalCodeRefType: **LocalCodeRefType references a code locally where the references to the codelist which defines it is provided elsewhere.
2465
2466 Derivation:
2467
2468 * //RefBaseType// (restriction)
2469 ** //LocalIdentifiableRefBaseType// (restriction)
2470 *** //LocalItemRefBaseType// (restriction)
2471 **** LocalCodeRefType
2472
2473 Attributes:
2474 id, local?, class?, package?
2475
2476 Content:
2477 {Empty}
2478
2479 Attribute Documentation:
2480
2481 |**Name**|**Type**|**Documentation**
2482 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
2483 |local (fixed: true)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
2484 |class (fixed: Code)|ItemTypeCodelistType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
2485 |package (fixed: codelist)|ItemSchemePackageTyp eCodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
2486
2487 **AnyCodelistReferenceType: **AnyCodelistReferenceType is a specific type of a reference for referencing either a codelist or a hierarchical codelist usage. It consists of a URN and/or a complete set of reference fields; agency, id and version. If the complete set of reference fields is used, it is required that a class be provided so that the type of object referenced is clear.
2488
2489 Derivation:
2490
2491 * //ReferenceType// (restriction)
2492 ** //MaintainableReferenceBaseType// (restriction)
2493 *** AnyCodelistReferenceType
2494
2495 Content:
2496 ( (Ref, URN?) | URN)
2497
2498 Element Documentation:
2499
2500 |**Name**|**Type**|**Documentation**
2501 |Ref|AnyCodelistRefType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
2502 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2503 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2504
2505 **AnyLocalCodeReferenceType: **AnyLocalCodeReferenceType provides a simple references to any code or hierarchical code where the identification of the codelist or hierarchical codelist which defines it is contained in another context.
2506
2507 Derivation:
2508
2509 * //ReferenceType// (restriction)
2510 ** AnyLocalCodeReferenceType
2511
2512 Content:
2513 ( (Ref, URN?) | URN)
2514
2515 Element Documentation:
2516
2517 |**Name**|**Type**|**Documentation**
2518 |Ref|AnyLocalCodeRefType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
2519 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2520 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2521
2522 **ConceptSchemeReferenceType: **ConceptSchemeReferenceType is a type for referencing a concept scheme object. It consists of a URN and/or a complete set of reference fields.
2523
2524 Derivation:
2525
2526 * //ReferenceType// (restriction)
2527 ** //MaintainableReferenceBaseType// (restriction)
2528 *** //ItemSchemeReferenceBaseType// (restriction)
2529 **** ConceptSchemeReferenceType
2530
2531 Content:
2532 ( (Ref, URN?) | URN)
2533
2534 Element Documentation:
2535
2536 |**Name**|**Type**|**Documentation**
2537 |Ref|ConceptSchemeRefType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
2538 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2539 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2540
2541 **ConceptSchemeRefType: **ConceptSchemeRefType provides a reference to a concept scheme via a complete set of reference fields.
2542
2543 Derivation:
2544
2545 * //RefBaseType// (restriction)
2546 ** //MaintainableRefBaseType// (restriction)
2547 *** //ItemSchemeRefBaseType// (restriction)
2548 **** ConceptSchemeRefType
2549
2550 Attributes:
2551 agencyID, id, version?, local?, class?, package?
2552
2553 Content:
2554 {Empty}
2555
2556 Attribute Documentation:
2557
2558 |**Name**|**Type**|**Documentation**
2559 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
2560 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
2561 |version (default: 1.0)|VersionType|The version attribute identifies the version of the object being reference, if applicable. If this is available, a default value of 1.0 will always apply.
2562 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
2563 |class (fixed: ConceptScheme)|ItemSchemeTypeCodeli stType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
2564 |package (fixed: conceptscheme)|ItemSchemePackageTyp eCodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
2565
2566 **ConceptReferenceType: **ConceptReferenceType is a type for referencing a concept object. It consists of a URN and/or a complete set of reference fields.
2567
2568 Derivation:
2569
2570 * //ReferenceType// (restriction)
2571 ** //ChildObjectReferenceType// (restriction)
2572 *** //ItemReferenceType// (restriction)
2573 **** ConceptReferenceType
2574
2575 Content:
2576 ( (Ref, URN?) | URN)
2577
2578 Element Documentation:
2579
2580 |**Name**|**Type**|**Documentation**
2581 |Ref|ConceptRefType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
2582 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2583 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2584
2585 **ConceptRefType: **ConceptRefType references a concept from within a concept scheme. Reference fields are required for both the scheme and the item.
2586
2587 Derivation:
2588
2589 * //RefBaseType// (restriction)
2590 ** //ChildObjectRefBaseType// (restriction)
2591 *** //ItemRefBaseType// (restriction)
2592 **** ConceptRefType
2593
2594 Attributes:
2595 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
2596
2597 Content:
2598 {Empty}
2599
2600 Attribute Documentation:
2601
2602 |**Name**|**Type**|**Documentation**
2603 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
2604 |maintainableParentID|IDType|The maintainableParentID references the concept scheme in which the concept being referenced is defined.
2605 |maintainableParentVersion (default: 1.0)|VersionType|The maintainableParentVersion attribute references the version of the concept scheme in which the concept being referenced is defined. If not supplied, a default value of 1.0 is assumed.
2606 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
2607 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
2608 |class (fixed: Concept)|ItemTypeCodelistType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
2609 |package (fixed: conceptscheme)|ItemSchemePackageTyp eCodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
2610
2611 **LocalConceptReferenceType: **LocalConceptReferenceType provides a simple references to a concept where the identification of the concept scheme which defines it is contained in another context.
2612
2613 Derivation:
2614
2615 * //ReferenceType// (restriction)
2616 ** //LocalItemReferenceType// (restriction)
2617 *** LocalConceptReferenceType
2618
2619 Content:
2620 Ref
2621
2622 Element Documentation:
2623
2624 |**Name**|**Type**|**Documentation**
2625 |Ref|LocalConceptRefType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
2626
2627 **LocalConceptRefType: **LocalConceptRefType references a concept locally where the references to the concept scheme which defines it is provided elsewhere.
2628
2629 Derivation:
2630
2631 * //RefBaseType// (restriction)
2632 ** //LocalIdentifiableRefBaseType// (restriction)
2633 *** //LocalItemRefBaseType// (restriction)
2634 **** LocalConceptRefType
2635
2636 Attributes:
2637 id, local?, class?, package?
2638
2639 Content:
2640 {Empty}
2641
2642 Attribute Documentation:
2643
2644 |**Name**|**Type**|**Documentation**
2645 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
2646 |local (fixed: true)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
2647 |class (fixed: Concept)|ItemTypeCodelistType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
2648 |package (fixed: conceptscheme)|ItemSchemePackageTyp eCodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
2649
2650 //**OrganisationSchemeReferenceBaseType**//**: **OrganisationSchemeReferenceBaseType is a type for referencing a organisation scheme object. It consists of a URN and/or a complete set of reference fields.
2651
2652 Derivation:
2653
2654 * //ReferenceType// (restriction)
2655 ** //MaintainableReferenceBaseType// (restriction)
2656 *** //ItemSchemeReferenceBaseType// (restriction)
2657 **** //OrganisationSchemeReferenceBaseType//
2658
2659 Content:
2660 ( (Ref, URN?) | URN)
2661
2662 Element Documentation:
2663
2664 |**Name**|**Type**|**Documentation**
2665 |Ref|//OrganisationSchemeRe fBaseType//|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
2666 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2667 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2668
2669 //**OrganisationSchemeRefBaseType**//**: **OrganisationSchemeRefBaseType contains a set of reference fields for an organisation scheme.
2670
2671 Derivation:
2672
2673 * //RefBaseType// (restriction)
2674 ** //MaintainableRefBaseType// (restriction)
2675 *** //ItemSchemeRefBaseType// (restriction)
2676 **** //OrganisationSchemeRefBaseType//
2677
2678 Attributes:
2679 agencyID, id, version?, local?, class?, package?
2680
2681 Content:
2682 {Empty}
2683
2684 Attribute Documentation:
2685
2686 |**Name**|**Type**|**Documentation**
2687 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
2688 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
2689 |version (default: 1.0)|VersionType|The version attribute identifies the version of the object being reference, if applicable. If this is available, a default value of 1.0 will always apply.
2690 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
2691 |class|OrganisationSchemeTy peCodelistType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
2692 |package (fixed: base)|ItemSchemePackageTyp eCodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
2693
2694 **OrganisationSchemeReferenceType: **OrganisationSchemeReferenceType references an organisation scheme regardless of the specific type. It consists of a URN and/or a complete set of reference fields.
2695
2696 Derivation:
2697
2698 * //ReferenceType// (restriction)
2699 ** //MaintainableReferenceBaseType// (restriction)
2700 *** //ItemSchemeReferenceBaseType// (restriction)
2701 **** //OrganisationSchemeReferenceBaseType// (restriction)
2702 ***** OrganisationSchemeReferenceType
2703
2704 Content:
2705 ( (Ref, URN?) | URN)
2706
2707 Element Documentation:
2708
2709 |**Name**|**Type**|**Documentation**
2710 |Ref|OrganisationSchemeRe fType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
2711 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2712 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2713
2714 **OrganisationSchemeRefType: **OrganisationSchemeRefType provides a reference to an organisation scheme via a complete set of reference fields. It is required that the class (i.e. the type) of organisation scheme being referenced be specified.
2715
2716 Derivation:
2717
2718 * //RefBaseType// (restriction)
2719 ** //MaintainableRefBaseType// (restriction)
2720 *** //ItemSchemeRefBaseType// (restriction)
2721 **** //OrganisationSchemeRefBaseType// (restriction)
2722 ***** OrganisationSchemeRefType
2723
2724 Attributes:
2725 agencyID, id, version?, local?, class, package?
2726
2727 Content:
2728 {Empty}
2729
2730 Attribute Documentation:
2731
2732 |**Name**|**Type**|**Documentation**
2733 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
2734 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
2735 |version (default: 1.0)|VersionType|The version attribute identifies the version of the object being reference, if applicable. If this is available, a default value of 1.0 will always apply.
2736 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
2737 |class|OrganisationSchemeTy peCodelistType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
2738 |package (fixed: base)|ItemSchemePackageTyp eCodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
2739
2740 //**OrganisationReferenceBaseType**//**: **OrganisationReferenceBaseType is a type for referencing any organisation object, regardless of its type. It consists of a URN and/or a complete set of reference fields.
2741
2742 Derivation:
2743
2744 * //ReferenceType// (restriction)
2745 ** //ChildObjectReferenceType// (restriction)
2746 *** //ItemReferenceType// (restriction)
2747 **** //OrganisationReferenceBaseType//
2748
2749 Content:
2750 ( (Ref, URN?) | URN)
2751
2752 Element Documentation:
2753
2754 |**Name**|**Type**|**Documentation**
2755 |Ref|//OrganisationRefBaseT ype//|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
2756 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2757 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2758
2759 //**OrganisationRefBaseType**//**: **OrganisationRefBaseType is an abstract base type which references an organisation from within a organisation scheme. Reference fields are required for both the scheme and the organisation.
2760
2761 Derivation:
2762
2763 * //RefBaseType// (restriction)
2764 ** //ChildObjectRefBaseType// (restriction)
2765 *** //ItemRefBaseType// (restriction)
2766 **** //OrganisationRefBaseType//
2767
2768 Attributes:
2769 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
2770
2771 Content:
2772 {Empty}
2773
2774 Attribute Documentation:
2775
2776 |**Name**|**Type**|**Documentation**
2777 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
2778 |maintainableParentID|IDType|The maintainableParentID references the organisation scheme in which the organisation being referenced is defined.
2779 |maintainableParentVersion (default: 1.0)|VersionType|The maintainableParentVersion attribute references the version of the organisation scheme in which the organisation being referenced is defined. If not supplied, a default value of 1.0 is assumed.
2780 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
2781 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
2782 |class|OrganisationTypeCode listType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
2783 |package (fixed: base)|ItemSchemePackageTyp eCodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
2784
2785 **OrganisationReferenceType: **OrganisationReferenceType references an organisation regardless of the specific type. It consists of a URN and/or a complete set of reference fields.
2786
2787 Derivation:
2788
2789 * //ReferenceType// (restriction)
2790 ** //ChildObjectReferenceType// (restriction)
2791 *** //ItemReferenceType// (restriction)
2792 **** //OrganisationReferenceBaseType// (restriction)
2793 ***** OrganisationReferenceType
2794
2795 Content:
2796 ( (Ref, URN?) | URN)
2797
2798 Element Documentation:
2799
2800 |**Name**|**Type**|**Documentation**
2801 |Ref|//OrganisationRefBaseT ype//|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
2802 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2803 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2804
2805 **OrganisationRefType: **OrganisationRefType provides a reference to any organisation via a complete set of reference fields. It is required that the class (i.e. the type) of organisation being referenced be specified.
2806
2807 Derivation:
2808
2809 * //RefBaseType// (restriction)
2810 ** //ChildObjectRefBaseType// (restriction)
2811 *** //ItemRefBaseType// (restriction)
2812 **** //OrganisationRefBaseType// (restriction)
2813 ***** OrganisationRefType
2814
2815 Attributes:
2816 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class, package?
2817
2818 Content:
2819 {Empty}
2820
2821 Attribute Documentation:
2822
2823 |**Name**|**Type**|**Documentation**
2824 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
2825 |maintainableParentID|IDType|The maintainableParentID references the organisation scheme in which the organisation being referenced is defined.
2826 |maintainableParentVersion (default: 1.0)|VersionType|The maintainableParentVersion attribute references the version of the organisation scheme in which the organisation being referenced is defined. If not supplied, a default value of 1.0 is assumed.
2827 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
2828 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
2829 |class|OrganisationTypeCode listType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
2830 |package (fixed: base)|ItemSchemePackageTyp eCodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
2831
2832 //**LocalOrganisationReferenceBaseType**//**: **LocalOrganisationReferenceBaseType is an abstract base type which provides a simple references to an organisation, regardless of type, where the identification of the organisation scheme which defines it is contained in another context.
2833
2834 Derivation:
2835
2836 * //ReferenceType// (restriction)
2837 ** //LocalItemReferenceType// (restriction)
2838 *** //LocalOrganisationReferenceBaseType//
2839
2840 Content:
2841 Ref
2842
2843 Element Documentation:
2844
2845 |**Name**|**Type**|**Documentation**
2846 |Ref|//LocalOrganisationRef BaseType//|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
2847
2848 //**LocalOrganisationRefBaseType**//**: **LocalOrganisationRefBaseType is an abstract base type that references an organisation locally where the reference to the organisation scheme which defines it is provided elsewhere.
2849
2850 Derivation:
2851
2852 * //RefBaseType// (restriction)
2853 ** //LocalIdentifiableRefBaseType// (restriction)
2854 *** //LocalItemRefBaseType// (restriction)
2855 **** //LocalOrganisationRefBaseType//
2856
2857 Attributes:
2858 id, local?, class?, package?
2859
2860 Content:
2861 {Empty}
2862
2863 Attribute Documentation:
2864
2865 |**Name**|**Type**|**Documentation**
2866 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
2867 |local (fixed: true)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
2868 |class|OrganisationTypeCode listType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
2869 |package (fixed: base)|ItemSchemePackageTyp eCodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
2870
2871 **LocalOrganisationReferenceType: **LocalOrganisationReferenceType provides a simple reference to an organisation, regardless of type, where the identification of the organisation scheme which defines it is contained in another context.
2872
2873 Derivation:
2874
2875 * //ReferenceType// (restriction)
2876 ** //LocalItemReferenceType// (restriction)
2877 *** //LocalOrganisationReferenceBaseType// (restriction)
2878 **** LocalOrganisationReferenceType
2879
2880 Content:
2881 Ref
2882
2883 Element Documentation:
2884
2885 |**Name**|**Type**|**Documentation**
2886 |Ref|LocalOrganisationRef Type|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
2887
2888 **LocalOrganisationRefType: **LocalOrganisationRefType references an organisation locally where the reference to the organisation scheme which defines it is provided elsewhere. The reference requires that the class (i.e. the type) or the organisation being reference be provided.
2889
2890 Derivation:
2891
2892 * //RefBaseType// (restriction)
2893 ** //LocalIdentifiableRefBaseType// (restriction)
2894 *** //LocalItemRefBaseType// (restriction)
2895 **** //LocalOrganisationRefBaseType// (restriction)
2896 ***** LocalOrganisationRefType
2897
2898 Attributes:
2899 id, local?, class?, package?
2900
2901 Content:
2902 {Empty}
2903
2904 Attribute Documentation:
2905
2906 |**Name**|**Type**|**Documentation**
2907 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
2908 |local (fixed: true)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
2909 |class|OrganisationTypeCode listType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
2910 |package (fixed: base)|ItemSchemePackageTyp eCodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
2911
2912 **OrganisationUnitSchemeReferenceType: **OrganisationUnitSchemeReferenceType is a type for referencing an organisation unit scheme object. It consists of a URN and/or a complete set of reference fields.
2913
2914 Derivation:
2915
2916 * //ReferenceType// (restriction)
2917 ** //MaintainableReferenceBaseType// (restriction)
2918 *** //ItemSchemeReferenceBaseType// (restriction)
2919 **** //OrganisationSchemeReferenceBaseType// (restriction)
2920 ***** OrganisationUnitSchemeReferenceType
2921
2922 Content:
2923 ( (Ref, URN?) | URN)
2924
2925 Element Documentation:
2926
2927 |**Name**|**Type**|**Documentation**
2928 |Ref|OrganisationUnitSche meRefType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
2929 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2930 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2931
2932 **OrganisationUnitSchemeRefType: **OrganisationUnitSchemeRefType contains a set of reference fields for an organisation unit scheme.
2933
2934 Derivation:
2935
2936 * //RefBaseType// (restriction)
2937 ** //MaintainableRefBaseType// (restriction)
2938 *** //ItemSchemeRefBaseType// (restriction)
2939 **** //OrganisationSchemeRefBaseType// (restriction)
2940 ***** OrganisationUnitSchemeRefType
2941
2942 Attributes:
2943 agencyID, id, version?, local?, class?, package?
2944
2945 Content:
2946 {Empty}
2947
2948 Attribute Documentation:
2949
2950 |**Name**|**Type**|**Documentation**
2951 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
2952 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
2953 |version (default: 1.0)|VersionType|The version attribute identifies the version of the object being reference, if applicable. If this is available, a default value of 1.0 will always apply.
2954 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
2955 |class (fixed: OrganisationUnitScheme)|OrganisationSchemeTy peCodelistType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
2956 |package (fixed: base)|ItemSchemePackageTyp eCodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
2957
2958 **OrganisationUnitReferenceType: **OrganisationUnitReferenceType is a type for referencing an organisation unit. It consists of a URN and/or a complete set of reference fields.
2959
2960 Derivation:
2961
2962 * //ReferenceType// (restriction)
2963 ** //ChildObjectReferenceType// (restriction)
2964 *** //ItemReferenceType// (restriction)
2965 **** //OrganisationReferenceBaseType// (restriction)
2966 ***** OrganisationUnitReferenceType
2967
2968 Content:
2969 ( (Ref, URN?) | URN)
2970
2971 Element Documentation:
2972
2973 |**Name**|**Type**|**Documentation**
2974 |Ref|OrganisationUnitRefT ype|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
2975 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2976 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2977
2978 **OrganisationUnitRefType: **OrganisationUnitRefType contains a set of reference fields for referencing an organisation unit within an organisation unit scheme.
2979
2980 Derivation:
2981
2982 * //RefBaseType// (restriction)
2983 ** //ChildObjectRefBaseType// (restriction)
2984 *** //ItemRefBaseType// (restriction)
2985 **** //OrganisationRefBaseType// (restriction)
2986 ***** OrganisationUnitRefType
2987
2988 Attributes:
2989 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
2990
2991 Content:
2992 {Empty}
2993
2994 Attribute Documentation:
2995
2996 |**Name**|**Type**|**Documentation**
2997 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
2998 |maintainableParentID|IDType|The maintainableParentID references the organisation scheme in which the organisation being referenced is defined.
2999 |maintainableParentVersion (default: 1.0)|VersionType|The maintainableParentVersion attribute references the version of the organisation scheme in which the organisation being referenced is defined. If not supplied, a default value of 1.0 is assumed.
3000 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
3001 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
3002 |class (fixed: OrganisationUnit)|OrganisationTypeCode listType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
3003 |package (fixed: base)|ItemSchemePackageTyp eCodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
3004
3005 **LocalOrganisationUnitReferenceType: **LocalOrganisationUnitReferenceType provides a simple reference to an organisation unit, where the reference to the organisation unit scheme which defines it is provided in another context.
3006
3007 Derivation:
3008
3009 * //ReferenceType// (restriction)
3010 ** //LocalItemReferenceType// (restriction)
3011 *** //LocalOrganisationReferenceBaseType// (restriction)
3012 **** LocalOrganisationUnitReferenceType
3013
3014 Content:
3015 Ref
3016
3017 Element Documentation:
3018
3019 |**Name**|**Type**|**Documentation**
3020 |Ref|LocalOrganisationUni tRefType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
3021
3022 **LocalOrganisationUnitRefType: **LocalOrganisationUnitRefType references an organisation unit locally where the reference to the organisation unit scheme which defines it is provided elsewhere.
3023
3024 Derivation:
3025
3026 * //RefBaseType// (restriction)
3027 ** //LocalIdentifiableRefBaseType// (restriction)
3028 *** //LocalItemRefBaseType// (restriction)
3029 **** //LocalOrganisationRefBaseType// (restriction)
3030 ***** LocalOrganisationUnitRefType
3031
3032 Attributes:
3033 id, local?, class?, package?
3034
3035 Content:
3036 {Empty}
3037
3038 Attribute Documentation:
3039
3040 |**Name**|**Type**|**Documentation**
3041 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
3042 |local (fixed: true)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
3043 |class (fixed: OrganisationUnit)|OrganisationTypeCode listType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
3044 |package (fixed: base)|ItemSchemePackageTyp eCodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
3045
3046 **AgencySchemeReferenceType: **AgencySchemeReferenceType is a type for referencing an agency scheme object. It consists of a URN and/or a complete set of reference fields.
3047
3048 Derivation:
3049
3050 * //ReferenceType// (restriction)
3051 ** //MaintainableReferenceBaseType// (restriction)
3052 *** //ItemSchemeReferenceBaseType// (restriction)
3053 **** //OrganisationSchemeReferenceBaseType// (restriction)
3054 ***** AgencySchemeReferenceType
3055
3056 Content:
3057 ( (Ref, URN?) | URN)
3058
3059 Element Documentation:
3060
3061 |**Name**|**Type**|**Documentation**
3062 |Ref|AgencySchemeRefType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
3063 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3064 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3065
3066 **AgencySchemeRefType: **AgencySchemeRefType contains a set of reference fields for an agency scheme.
3067
3068 Derivation:
3069
3070 * //RefBaseType// (restriction)
3071 ** //MaintainableRefBaseType// (restriction)
3072 *** //ItemSchemeRefBaseType// (restriction)
3073 **** //OrganisationSchemeRefBaseType// (restriction)
3074 ***** AgencySchemeRefType
3075
3076 Attributes:
3077 agencyID, id, version?, local?, class?, package?
3078
3079 Content:
3080 {Empty}
3081
3082 Attribute Documentation:
3083
3084 |**Name**|**Type**|**Documentation**
3085 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
3086 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
3087 |version (default: 1.0)|VersionType|The version attribute identifies the version of the object being reference, if applicable. If this is available, a default value of 1.0 will always apply.
3088 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
3089 |class (fixed: AgencyScheme)|OrganisationSchemeTy peCodelistType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
3090 |package (fixed: base)|ItemSchemePackageTyp eCodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
3091
3092 **AgencyReferenceType: **AgencyReferenceType is a type for referencing an agency. It consists of a URN and/or a complete set of reference fields.
3093
3094 Derivation:
3095
3096 * //ReferenceType// (restriction)
3097 ** //ChildObjectReferenceType// (restriction)
3098 *** //ItemReferenceType// (restriction)
3099 **** //OrganisationReferenceBaseType// (restriction)
3100 ***** AgencyReferenceType
3101
3102 Content:
3103 ( (Ref, URN?) | URN)
3104
3105 Element Documentation:
3106
3107 |**Name**|**Type**|**Documentation**
3108 |Ref|AgencyRefType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
3109 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3110 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3111
3112 **AgencyRefType: **AgencyRefType contains a set of reference fields for referencing an agency within an agency scheme.
3113
3114 Derivation:
3115
3116 * //RefBaseType// (restriction)
3117 ** //ChildObjectRefBaseType// (restriction)
3118 *** //ItemRefBaseType// (restriction)
3119 **** //OrganisationRefBaseType// (restriction)
3120 ***** AgencyRefType
3121
3122 Attributes:
3123 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
3124
3125 Content:
3126 {Empty}
3127
3128 Attribute Documentation:
3129
3130 |**Name**|**Type**|**Documentation**
3131 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
3132 |maintainableParentID|IDType|The maintainableParentID references the organisation scheme in which the organisation being referenced is defined.
3133 |maintainableParentVersion (default: 1.0)|VersionType|The maintainableParentVersion attribute references the version of the organisation scheme in which the organisation being referenced is defined. If not supplied, a default value of 1.0 is assumed.
3134 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
3135 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
3136 |class (fixed: Agency)|OrganisationTypeCode listType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
3137 |package (fixed: base)|ItemSchemePackageTyp eCodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
3138
3139 **LocalAgencyReferenceType: **LocalAgencyReferenceType provides a simple reference to an agency, where the reference to the agency scheme which defines it is provided in another context.
3140
3141 Derivation:
3142
3143 * //ReferenceType// (restriction)
3144 ** //LocalItemReferenceType// (restriction)
3145 *** //LocalOrganisationReferenceBaseType// (restriction)
3146 **** LocalAgencyReferenceType
3147
3148 Content:
3149 Ref
3150
3151 Element Documentation:
3152
3153 |**Name**|**Type**|**Documentation**
3154 |Ref|LocalAgencyRefType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
3155
3156 **LocalAgencyRefType: **LocalAgencyRefType references an agency locally where the reference to the agency scheme which defines it is provided elsewhere.
3157
3158 Derivation:
3159
3160 * //RefBaseType// (restriction)
3161 ** //LocalIdentifiableRefBaseType// (restriction)
3162 *** //LocalItemRefBaseType// (restriction)
3163 **** //LocalOrganisationRefBaseType// (restriction)
3164 ***** LocalAgencyRefType
3165
3166 Attributes:
3167 id, local?, class?, package?
3168
3169 Content:
3170 {Empty}
3171
3172 Attribute Documentation:
3173
3174 |**Name**|**Type**|**Documentation**
3175 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
3176 |local (fixed: true)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
3177 |class (fixed: Agency)|OrganisationTypeCode listType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
3178 |package (fixed: base)|ItemSchemePackageTyp eCodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
3179
3180 **DataConsumerSchemeReferenceType: **DataConsumerSchemeReferenceType is a type for referencing a data consumer scheme object. It consists of a URN and/or a complete set of reference fields.
3181
3182 Derivation:
3183
3184 * //ReferenceType// (restriction)
3185 ** //MaintainableReferenceBaseType// (restriction)
3186 *** //ItemSchemeReferenceBaseType// (restriction)
3187 **** //OrganisationSchemeReferenceBaseType// (restriction)
3188 ***** DataConsumerSchemeReferenceType
3189
3190 Content:
3191 ( (Ref, URN?) | URN)
3192
3193 Element Documentation:
3194
3195 |**Name**|**Type**|**Documentation**
3196 |Ref|DataConsumerSchemeRe fType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
3197 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3198 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3199
3200 **DataConsumerSchemeRefType: **DataConsumerSchemeRefType contains a set of reference fields for a data consumer scheme.
3201
3202 Derivation:
3203
3204 * //RefBaseType// (restriction)
3205 ** //MaintainableRefBaseType// (restriction)
3206 *** //ItemSchemeRefBaseType// (restriction)
3207 **** //OrganisationSchemeRefBaseType// (restriction)
3208 ***** DataConsumerSchemeRefType
3209
3210 Attributes:
3211 agencyID, id, version?, local?, class?, package?
3212
3213 Content:
3214 {Empty}
3215
3216 Attribute Documentation:
3217
3218 |**Name**|**Type**|**Documentation**
3219 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
3220 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
3221 |version (default: 1.0)|VersionType|The version attribute identifies the version of the object being reference, if applicable. If this is available, a default value of 1.0 will always apply.
3222 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
3223 |class (fixed: DataConsumerScheme)|OrganisationSchemeTy peCodelistType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
3224 |package (fixed: base)|ItemSchemePackageTyp eCodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
3225
3226 **DataConsumerReferenceType: **DataConsumerReferenceType is a type for referencing a data consumer. It consists of a URN and/or a complete set of reference fields.
3227
3228 Derivation:
3229
3230 * //ReferenceType// (restriction)
3231 ** //ChildObjectReferenceType// (restriction)
3232 *** //ItemReferenceType// (restriction)
3233 **** //OrganisationReferenceBaseType// (restriction)
3234 ***** DataConsumerReferenceType
3235
3236 Content:
3237 ( (Ref, URN?) | URN)
3238
3239 Element Documentation:
3240
3241 |**Name**|**Type**|**Documentation**
3242 |Ref|DataConsumerRefType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
3243 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3244 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3245
3246 **DataConsumerRefType: **DataConsumerRefType contains a set of reference fields for referencing a data consumer within a data consumer scheme.
3247
3248 Derivation:
3249
3250 * //RefBaseType// (restriction)
3251 ** //ChildObjectRefBaseType// (restriction)
3252 *** //ItemRefBaseType// (restriction)
3253 **** //OrganisationRefBaseType// (restriction)
3254 ***** DataConsumerRefType
3255
3256 Attributes:
3257 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
3258
3259 Content:
3260 {Empty}
3261
3262 Attribute Documentation:
3263
3264 |**Name**|**Type**|**Documentation**
3265 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
3266 |maintainableParentID|IDType|The maintainableParentID references the organisation scheme in which the organisation being referenced is defined.
3267 |maintainableParentVersion (default: 1.0)|VersionType|The maintainableParentVersion attribute references the version of the organisation scheme in which the organisation being referenced is defined. If not supplied, a default value of 1.0 is assumed.
3268 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
3269 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
3270 |class (fixed: DataConsumer)|OrganisationTypeCode listType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
3271 |package (fixed: base)|ItemSchemePackageTyp eCodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
3272
3273 **LocalDataConsumerReferenceType: **LocalDataConsumerReferenceType provides a simple reference to a data consumer, where the reference to the data consumer scheme which defines it is provided in another context.
3274
3275 Derivation:
3276
3277 * //ReferenceType// (restriction)
3278 ** //LocalItemReferenceType// (restriction)
3279 *** //LocalOrganisationReferenceBaseType// (restriction)
3280 **** LocalDataConsumerReferenceType
3281
3282 Content:
3283 Ref
3284
3285 Element Documentation:
3286
3287 |**Name**|**Type**|**Documentation**
3288 |Ref|LocalDataConsumerRef Type|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
3289
3290 **LocalDataConsumerRefType: **LocalDataConsumerRefType references a data consumer locally where the reference to the data consumer scheme which defines it is provided elsewhere.
3291
3292 Derivation:
3293
3294 * //RefBaseType// (restriction)
3295 ** //LocalIdentifiableRefBaseType// (restriction)
3296 *** //LocalItemRefBaseType// (restriction)
3297 **** //LocalOrganisationRefBaseType// (restriction)
3298 ***** LocalDataConsumerRefType
3299
3300 Attributes:
3301 id, local?, class?, package?
3302
3303 Content:
3304 {Empty}
3305
3306 Attribute Documentation:
3307
3308 |**Name**|**Type**|**Documentation**
3309 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
3310 |local (fixed: true)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
3311 |class (fixed: DataConsumer)|OrganisationTypeCode listType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
3312 |package (fixed: base)|ItemSchemePackageTyp eCodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
3313
3314 **DataProviderSchemeReferenceType: **DataProviderSchemeReferenceType is a type for referencing a data provider scheme object. It consists of a URN and/or a complete set of reference fields.
3315
3316 Derivation:
3317
3318 * //ReferenceType// (restriction)
3319 ** //MaintainableReferenceBaseType// (restriction)
3320 *** //ItemSchemeReferenceBaseType// (restriction)
3321 **** //OrganisationSchemeReferenceBaseType// (restriction)
3322 ***** DataProviderSchemeReferenceType
3323
3324 Content:
3325 ( (Ref, URN?) | URN)
3326
3327 Element Documentation:
3328
3329 |**Name**|**Type**|**Documentation**
3330 |Ref|DataProviderSchemeRe fType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
3331 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3332 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3333
3334 **DataProviderSchemeRefType: **DataProviderSchemeRefType contains a set of reference fields for a data provider scheme.
3335
3336 Derivation:
3337
3338 * //RefBaseType// (restriction)
3339 ** //MaintainableRefBaseType// (restriction)
3340 *** //ItemSchemeRefBaseType// (restriction)
3341 **** //OrganisationSchemeRefBaseType// (restriction)
3342 ***** DataProviderSchemeRefType
3343
3344 Attributes:
3345 agencyID, id, version?, local?, class?, package?
3346
3347 Content:
3348 {Empty}
3349
3350 Attribute Documentation:
3351
3352 |**Name**|**Type**|**Documentation**
3353 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
3354 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
3355 |version (default: 1.0)|VersionType|The version attribute identifies the version of the object being reference, if applicable. If this is available, a default value of 1.0 will always apply.
3356 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
3357 |class (fixed: DataProviderScheme)|OrganisationSchemeTy peCodelistType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
3358 |package (fixed: base)|ItemSchemePackageTyp eCodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
3359
3360 **DataProviderReferenceType: **DataProviderReferenceType is a type for referencing a data provider. It consists of a URN and/or a complete set of reference fields.
3361
3362 Derivation:
3363
3364 * //ReferenceType// (restriction)
3365 ** //ChildObjectReferenceType// (restriction)
3366 *** //ItemReferenceType// (restriction)
3367 **** //OrganisationReferenceBaseType// (restriction)
3368 ***** DataProviderReferenceType
3369
3370 Content:
3371 ( (Ref, URN?) | URN)
3372
3373 Element Documentation:
3374
3375 |**Name**|**Type**|**Documentation**
3376 |Ref|DataProviderRefType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
3377 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3378 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3379
3380 **DataProviderRefType: **DataProviderRefType contains a set of reference fields for referencing a data provider within a data provider scheme.
3381
3382 Derivation:
3383
3384 * //RefBaseType// (restriction)
3385 ** //ChildObjectRefBaseType// (restriction)
3386 *** //ItemRefBaseType// (restriction)
3387 **** //OrganisationRefBaseType// (restriction)
3388 ***** DataProviderRefType
3389
3390 Attributes:
3391 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
3392
3393 Content:
3394 {Empty}
3395
3396 Attribute Documentation:
3397
3398 |**Name**|**Type**|**Documentation**
3399 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
3400 |maintainableParentID|IDType|The maintainableParentID references the organisation scheme in which the organisation being referenced is defined.
3401 |maintainableParentVersion (default: 1.0)|VersionType|The maintainableParentVersion attribute references the version of the organisation scheme in which the organisation being referenced is defined. If not supplied, a default value of 1.0 is assumed.
3402 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
3403 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
3404 |class (fixed: DataProvider)|OrganisationTypeCode listType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
3405 |package (fixed: base)|ItemSchemePackageTyp eCodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
3406
3407 **LocalDataProviderReferenceType: **LocalDataProviderReferenceType provides a simple reference to a data provider, where the reference to the data provider scheme which defines it is provided in another context.
3408
3409 Derivation:
3410
3411 * //ReferenceType// (restriction)
3412 ** //LocalItemReferenceType// (restriction)
3413 *** //LocalOrganisationReferenceBaseType// (restriction)
3414 **** LocalDataProviderReferenceType
3415
3416 Content:
3417 Ref
3418
3419 Element Documentation:
3420
3421 |**Name**|**Type**|**Documentation**
3422 |Ref|LocalDataProviderRef Type|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
3423
3424 **LocalDataProviderRefType: **LocalDataProviderRefType references a data provider locally where the reference to the data provider scheme which defines it is provided elsewhere.
3425
3426 Derivation:
3427
3428 * //RefBaseType// (restriction)
3429 ** //LocalIdentifiableRefBaseType// (restriction)
3430 *** //LocalItemRefBaseType// (restriction)
3431 **** //LocalOrganisationRefBaseType// (restriction)
3432 ***** LocalDataProviderRefType
3433
3434 Attributes:
3435 id, local?, class?, package?
3436
3437 Content:
3438 {Empty}
3439
3440 Attribute Documentation:
3441
3442 |**Name**|**Type**|**Documentation**
3443 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
3444 |local (fixed: true)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
3445 |class (fixed: DataProvider)|OrganisationTypeCode listType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
3446 |package (fixed: base)|ItemSchemePackageTyp eCodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
3447
3448 **ReportingTaxonomyReferenceType: **ReportingTaxonomyReferenceType is a type for referencing a reporting taxonomy object. It consists of a URN and/or a complete set of reference fields.
3449
3450 Derivation:
3451
3452 * //ReferenceType// (restriction)
3453 ** //MaintainableReferenceBaseType// (restriction)
3454 *** //ItemSchemeReferenceBaseType// (restriction)
3455 **** ReportingTaxonomyReferenceType
3456
3457 Content:
3458 ( (Ref, URN?) | URN)
3459
3460 Element Documentation:
3461
3462 |**Name**|**Type**|**Documentation**
3463 |Ref|ReportingTaxonomyRef Type|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
3464 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3465 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3466
3467 **ReportingTaxonomyRefType: **ReportingTaxonomyRefType provides a reference to a reporting taxonomy via a complete set of reference fields.
3468
3469 Derivation:
3470
3471 * //RefBaseType// (restriction)
3472 ** //MaintainableRefBaseType// (restriction)
3473 *** //ItemSchemeRefBaseType// (restriction)
3474 **** ReportingTaxonomyRefType
3475
3476 Attributes:
3477 agencyID, id, version?, local?, class?, package?
3478
3479 Content:
3480 {Empty}
3481
3482 Attribute Documentation:
3483
3484 |**Name**|**Type**|**Documentation**
3485 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
3486 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
3487 |version (default: 1.0)|VersionType|The version attribute identifies the version of the object being reference, if applicable. If this is available, a default value of 1.0 will always apply.
3488 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
3489 |class (fixed: ReportingTaxonomy)|ItemSchemeTypeCodeli stType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
3490 |package (fixed: categoryscheme)|ItemSchemePackageTyp eCodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
3491
3492 **ReportingCategoryReferenceType: **ReportingCategoryReferenceType is a type for referencing a reporting category object. It consists of a URN and/or a complete set of reference fields.
3493
3494 Derivation:
3495
3496 * //ReferenceType// (restriction)
3497 ** //ChildObjectReferenceType// (restriction)
3498 *** //ItemReferenceType// (restriction)
3499 **** ReportingCategoryReferenceType
3500
3501 Content:
3502 ( (Ref, URN?) | URN)
3503
3504 Element Documentation:
3505
3506 |**Name**|**Type**|**Documentation**
3507 |Ref|ReportCategoryRefTyp e|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
3508 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3509 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3510
3511 **ReportCategoryRefType: **ReportCategoryRefType contains a set of fields for referencing a reporting category within a reporting taxonomy.
3512
3513 Derivation:
3514
3515 * //RefBaseType// (restriction)
3516 ** //ChildObjectRefBaseType// (restriction)
3517 *** //ItemRefBaseType// (restriction)
3518 **** ReportCategoryRefType
3519
3520 Attributes:
3521 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
3522
3523 Content:
3524 {Empty}
3525
3526 Attribute Documentation:
3527
3528 |**Name**|**Type**|**Documentation**
3529 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
3530 |maintainableParentID|IDType|The maintainableParentID references the reporting taxonomy in which the reporting category being referenced is defined.
3531 |maintainableParentVersion (default: 1.0)|VersionType|The maintainableParentVersion attribute references the version of the reporting taxonomy in which the reporting category being referenced is defined. If not supplied, a default value of 1.0 is assumed.
3532 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
3533 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
3534 |class (fixed: ReportingCategory)|ItemTypeCodelistType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
3535 |package (fixed: categoryscheme)|ItemSchemePackageTyp eCodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
3536
3537 **LocalReportingCategoryReferenceType: **LocalReportingCategoryReferenceType provides a simple references to a reporting category where the identification of the reporting taxonomy which defines it is contained in another context.
3538
3539 Derivation:
3540
3541 * //ReferenceType// (restriction)
3542 ** //LocalItemReferenceType// (restriction)
3543 *** LocalReportingCategoryReferenceType
3544
3545 Content:
3546 Ref
3547
3548 Element Documentation:
3549
3550 |**Name**|**Type**|**Documentation**
3551 |Ref|LocalReportingCatego ryRefType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
3552
3553 **LocalReportingCategoryRefType: **LocalReportingCategoryRefType references a reporting category locally where the references to the reporting taxonomy which defines it is provided elsewhere.
3554
3555 Derivation:
3556
3557 * //RefBaseType// (restriction)
3558 ** //LocalIdentifiableRefBaseType// (restriction)
3559 *** //LocalItemRefBaseType// (restriction)
3560 **** LocalReportingCategoryRefType
3561
3562 Attributes:
3563 id, local?, class?, package?
3564
3565 Content:
3566 {Empty}
3567
3568 Attribute Documentation:
3569
3570 |**Name**|**Type**|**Documentation**
3571 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
3572 |local (fixed: true)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
3573 |class (fixed: ReportingCategory)|ItemTypeCodelistType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
3574 |package (fixed: categoryscheme)|ItemSchemePackageTyp eCodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
3575
3576 **HierarchicalCodelistReferenceType: **HierarchicalCodelistReferenceType is a type for referencing a hierarchical codelist object. It consists of a URN and/or a complete set of reference fields.
3577
3578 Derivation:
3579
3580 * //ReferenceType// (restriction)
3581 ** //MaintainableReferenceBaseType// (restriction)
3582 *** HierarchicalCodelistReferenceType
3583
3584 Content:
3585 ( (Ref, URN?) | URN)
3586
3587 Element Documentation:
3588
3589 |**Name**|**Type**|**Documentation**
3590 |Ref|HierarchicalCodelist RefType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
3591 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3592 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3593
3594 **HierarchicalCodelistRefType: **HierarchicalCodelistRefType contains a set of reference fields for a hierarchical codelist.
3595
3596 Derivation:
3597
3598 * //RefBaseType// (restriction)
3599 ** //MaintainableRefBaseType// (restriction)
3600 *** HierarchicalCodelistRefType
3601
3602 Attributes:
3603 agencyID, id, version?, local?, class?, package?
3604
3605 Content:
3606 {Empty}
3607
3608 Attribute Documentation:
3609
3610 |**Name**|**Type**|**Documentation**
3611 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
3612 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
3613 |version (default: 1.0)|VersionType|The version attribute identifies the version of the object being reference, if applicable. If this is available, a default value of 1.0 will always apply.
3614 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
3615 |class (fixed: HierarchicalCodelist)|MaintainableTypeCode listType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
3616 |package (fixed: codelist)|ItemSchemePackageTyp eCodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
3617
3618 **HierarchyReferenceType: **HierarchyReferenceType is a type for referencing a hierarchy within a hierarchical codelist.
3619
3620 Derivation:
3621
3622 * //ReferenceType// (restriction)
3623 ** //ChildObjectReferenceType// (restriction)
3624 *** HierarchyReferenceType
3625
3626 Content:
3627 ( (Ref, URN?) | URN)
3628
3629 Element Documentation:
3630
3631 |**Name**|**Type**|**Documentation**
3632 |Ref|HierarchyRefType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
3633 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3634 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3635
3636 **HierarchyRefType: **HierarchyRefType is type which references a hierarchy from within a hierarchical codelist. Reference fields are required for both the hierarchy and the codelist.
3637
3638 Derivation:
3639
3640 * //RefBaseType// (restriction)
3641 ** //ChildObjectRefBaseType// (restriction)
3642 *** HierarchyRefType
3643
3644 Attributes:
3645 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
3646
3647 Content:
3648 {Empty}
3649
3650 Attribute Documentation:
3651
3652 |**Name**|**Type**|**Documentation**
3653 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
3654 |maintainableParentID|IDType|The maintainableParentID attribute identifies the maintainable object in which the referenced object is defined, if applicable (maintainable-parent-object-id in the URN structure). This is only used in references where the referenced object is not itself maintainable.
3655 |maintainableParentVersion (default: 1.0)|VersionType|The maintainableParentVersion attribute identifies the version of the maintainable object in which the referenced object is defined (maintainable-parent-object-version in the URN structure). This is only used in references where the referenced object is not itself maintainable. This should only be used when the maintainableParentID is present. If this is available, a default of 1.0 will always apply.
3656 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
3657 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
3658 |class (fixed: Hierarchy)|ObjectTypeCodelistTy pe|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
3659 |package (fixed: codelist)|PackageTypeCodelistT ype|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
3660
3661 **LevelReferenceType: **LevelReferenceType is a type for referencing a level object. It consists of a URN and/or a complete set of reference fields.
3662
3663 Derivation:
3664
3665 * //ReferenceType// (restriction)
3666 ** //ChildObjectReferenceType// (restriction)
3667 *** LevelReferenceType
3668
3669 Content:
3670 ( (Ref, URN?) | URN)
3671
3672 Element Documentation:
3673
3674 |**Name**|**Type**|**Documentation**
3675 |Ref|LevelRefType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
3676 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3677 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3678
3679 **LevelRefType: **LevelRefType references a level from within a hierarchical codelist. Reference fields are required for both the level and the codelist.
3680
3681 Derivation:
3682
3683 * //RefBaseType// (restriction)
3684 ** //ChildObjectRefBaseType// (restriction)
3685 *** LevelRefType
3686
3687 Attributes:
3688 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
3689
3690 Content:
3691 {Empty}
3692
3693 Attribute Documentation:
3694
3695 |**Name**|**Type**|**Documentation**
3696 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
3697 |maintainableParentID|IDType|The maintainableParentID attribute identifies the maintainable object in which the referenced object is defined, if applicable (maintainable-parent-object-id in the URN structure). This is only used in references where the referenced object is not itself maintainable.
3698 |maintainableParentVersion (default: 1.0)|VersionType|The maintainableParentVersion attribute identifies the version of the maintainable object in which the referenced object is defined (maintainable-parent-object-version in the URN structure). This is only used in references where the referenced object is not itself maintainable. This should only be used when the maintainableParentID is present. If this is available, a default of 1.0 will always apply.
3699 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
3700 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
3701 |class (fixed: Level)|ObjectTypeCodelistTy pe|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
3702 |package (fixed: codelist)|PackageTypeCodelistT ype|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
3703
3704 **LocalLevelReferenceType: **LocalLevelReferenceType is a type for referencing a level object where the reference to the hierarchical codelist and the hierarchy in which it is defined is provided in another context (e.g. is inferred from the hierarchy in which the reference is defined).
3705
3706 Derivation:
3707
3708 * //ReferenceType// (restriction)
3709 ** LocalLevelReferenceType
3710
3711 Content:
3712 Ref
3713
3714 Element Documentation:
3715
3716 |**Name**|**Type**|**Documentation**
3717 |Ref|LocalLevelRefType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
3718
3719 **LocalLevelRefType: **LocalLevelRefType references a level object where the reference to the hierarchy in which it is contained and the hierarchical codelist which define it are provided in another context.
3720
3721 Derivation:
3722
3723 * //RefBaseType// (restriction)
3724 ** //LocalIdentifiableRefBaseType// (restriction)
3725 *** LocalLevelRefType
3726
3727 Attributes:
3728 containerID?, id, local?, class?, package?
3729
3730 Content:
3731 {Empty}
3732
3733 Attribute Documentation:
3734
3735 |**Name**|**Type**|**Documentation**
3736 |containerID|NestedIDType|The containerID attribute identifies the object within a maintainable object in which the referenced object is defined (container-object-id in the URN structure). This is only used in references where the referenced object is not contained directly within a maintainable object (e.g. a Component within a ComponentList, within a maintainable Structure). If the container has a fixed identifier, this attribute will not be present.
3737 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
3738 |local (fixed: true)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
3739 |class (fixed: Level)|ObjectTypeCodelistTy pe|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
3740 |package|PackageTypeCodelistT ype|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
3741
3742 **HierarchicalCodeReferenceType: **HierarchicalCodeReferenceType is a type for referencing a hierarchical code object. It consists of a URN and/or a complete set of reference fields.
3743
3744 Derivation:
3745
3746 * //ReferenceType// (restriction)
3747 ** //ContainerChildObjectReferenceType// (restriction)
3748 *** HierarchicalCodeReferenceType
3749
3750 Content:
3751 ( (Ref, URN?) | URN)
3752
3753 Element Documentation:
3754
3755 |**Name**|**Type**|**Documentation**
3756 |Ref|HierarchicalCodeRefT ype|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
3757 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3758 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3759
3760 **HierarchicalCodeRefType: **HierarchicalCodeRefType references a code from within a hierarchical codelist. Reference fields are required for both the code and the codelist.
3761
3762 Derivation:
3763
3764 * //RefBaseType// (restriction)
3765 ** //ContainerChildObjectRefBaseType// (restriction)
3766 *** HierarchicalCodeRefType
3767
3768 Attributes:
3769 agencyID, maintainableParentID, maintainableParentVersion?, containerID, id, version?, local?, class?, package?
3770
3771 Content:
3772 {Empty}
3773
3774 Attribute Documentation:
3775
3776 |**Name**|**Type**|**Documentation**
3777 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
3778 |maintainableParentID|IDType|The maintainableParentID references the hierarchical codelist in which the code being referenced is defined.
3779 |maintainableParentVersion (default: 1.0)|VersionType|The maintainableParentVersion attribute references the version of the hierarchical codelist in which the code being referenced is defined. If not supplied, a default value of 1.0 is assumed.
3780 |containerID|IDType|The containerID references the hierarchy which contains the code being referenced is defined.
3781 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
3782 |version|VersionType|The version attribute identifies the version of the object being reference, if applicable. If this is available, a default value of 1.0 will always apply.
3783 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
3784 |class (fixed: HierarchicalCode)|ObjectTypeCodelistTy pe|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
3785 |package (fixed: codelist)|PackageTypeCodelistT ype|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
3786
3787 **ConstraintReferenceType: **ConstraintReferenceType is a type for referencing a constraint object. It consists of a URN and/or a complete set of reference fields.
3788
3789 Derivation:
3790
3791 * //ReferenceType// (restriction)
3792 ** //MaintainableReferenceBaseType// (restriction)
3793 *** ConstraintReferenceType
3794
3795 Content:
3796 ( (Ref, URN?) | URN)
3797
3798 Element Documentation:
3799
3800 |**Name**|**Type**|**Documentation**
3801 |Ref|//ConstraintRefType//|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
3802 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3803 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3804
3805 //**ConstraintRefType**//**: **ConstraintRefType contains a set of reference fields for a constraint.
3806
3807 Derivation:
3808
3809 * //RefBaseType// (restriction)
3810 ** //MaintainableRefBaseType// (restriction)
3811 *** //ConstraintRefType//
3812
3813 Attributes:
3814 agencyID, id, version?, local?, class?, package?
3815
3816 Content:
3817 {Empty}
3818
3819 Attribute Documentation:
3820
3821 |**Name**|**Type**|**Documentation**
3822 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
3823 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
3824 |version (default: 1.0)|VersionType|The version attribute identifies the version of the object being reference, if applicable. If this is available, a default value of 1.0 will always apply.
3825 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
3826 |class|ConstraintTypeCodeli stType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
3827 |package (fixed: registry)|PackageTypeCodelistT ype|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
3828
3829 **AttachmentConstraintReferenceType: **AttachmentConstraintReferenceType is a type for referencing a attachment constraint object. It consists of a URN and/or a complete set of reference fields.
3830
3831 Derivation:
3832
3833 * //ReferenceType// (restriction)
3834 ** //MaintainableReferenceBaseType// (restriction)
3835 *** ConstraintReferenceType (restriction)
3836 **** AttachmentConstraintReferenceType
3837
3838 Content:
3839 ( (Ref, URN?) | URN)
3840
3841 Element Documentation:
3842
3843 |**Name**|**Type**|**Documentation**
3844 |Ref|AttachmentConstraint RefType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
3845 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3846 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3847
3848 **AttachmentConstraintRefType: **AttachmentConstraintRefType contains a set of reference fields for an attachment constraint.
3849
3850 Derivation:
3851
3852 * //RefBaseType// (restriction)
3853 ** //MaintainableRefBaseType// (restriction)
3854 *** //ConstraintRefType// (restriction)
3855 **** AttachmentConstraintRefType
3856
3857 Attributes:
3858 agencyID, id, version?, local?, class?, package?
3859
3860 Content:
3861 {Empty}
3862
3863 Attribute Documentation:
3864
3865 |**Name**|**Type**|**Documentation**
3866 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
3867 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
3868 |version (default: 1.0)|VersionType|The version attribute identifies the version of the object being reference, if applicable. If this is available, a default value of 1.0 will always apply.
3869 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
3870 |class (fixed: AttachmentConstraint)|ConstraintTypeCodeli stType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
3871 |package (fixed: registry)|PackageTypeCodelistT ype|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
3872
3873 **ContentConstraintReferenceType: **ContentConstraintReferenceType is a type for referencing a content constraint object. It consists of a URN and/or a complete set of reference fields.
3874
3875 Derivation:
3876
3877 * //ReferenceType// (restriction)
3878 ** //MaintainableReferenceBaseType// (restriction)
3879 *** ConstraintReferenceType (restriction)
3880 **** ContentConstraintReferenceType
3881
3882 Content:
3883 ( (Ref, URN?) | URN)
3884
3885 Element Documentation:
3886
3887 |**Name**|**Type**|**Documentation**
3888 |Ref|ContentConstraintRef Type|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
3889 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3890 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3891
3892 **ContentConstraintRefType: **ContentConstraintRefType contains a set of reference fields for a content constraint.
3893
3894 Derivation:
3895
3896 * //RefBaseType// (restriction)
3897 ** //MaintainableRefBaseType// (restriction)
3898 *** //ConstraintRefType// (restriction)
3899 **** ContentConstraintRefType
3900
3901 Attributes:
3902 agencyID, id, version?, local?, class?, package?
3903
3904 Content:
3905 {Empty}
3906
3907 Attribute Documentation:
3908
3909 |**Name**|**Type**|**Documentation**
3910 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
3911 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
3912 |version (default: 1.0)|VersionType|The version attribute identifies the version of the object being reference, if applicable. If this is available, a default value of 1.0 will always apply.
3913 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
3914 |class (fixed: ContentConstraint)|ConstraintTypeCodeli stType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
3915 |package (fixed: registry)|PackageTypeCodelistT ype|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
3916
3917 **DataflowReferenceType: **DataflowReferenceType is a type for referencing a dataflow object. It consists of a URN and/or a complete set of reference fields.
3918
3919 Derivation:
3920
3921 * //ReferenceType// (restriction)
3922 ** //MaintainableReferenceBaseType// (restriction)
3923 *** //StructureUsageReferenceBaseType// (restriction)
3924 **** DataflowReferenceType
3925
3926 Content:
3927 ( (Ref, URN?) | URN)
3928
3929 Element Documentation:
3930
3931 |**Name**|**Type**|**Documentation**
3932 |Ref|DataflowRefType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
3933 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3934 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3935
3936 **DataflowRefType: **DataflowRefType contains a set of reference fields for a data flow.
3937
3938 Derivation:
3939 * //RefBaseType// (restriction)
3940 ** //MaintainableRefBaseType// (restriction)
3941 *** //StructureOrUsageRefBaseType// (restriction)
3942 **** //StructureUsageRefBaseType// (restriction)
3943 ***** DataflowRefType
3944
3945 Attributes:
3946 agencyID, id, version?, local?, class?, package?
3947
3948 Content:
3949 {Empty}
3950
3951 Attribute Documentation:
3952
3953 |**Name**|**Type**|**Documentation**
3954 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
3955 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
3956 |version (default: 1.0)|VersionType|The version attribute identifies the version of the object being reference, if applicable. If this is available, a default value of 1.0 will always apply.
3957 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
3958 |class (fixed: Dataflow)|StructureUsageTypeCo delistType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
3959 |package (fixed: datastructure)|StructurePackageType CodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
3960
3961 **MetadataflowReferenceType: **MetadataflowReferenceType is a type for referencing a metadata flow object. It consists of a URN and/or a complete set of reference fields.
3962
3963 Derivation:
3964 * //ReferenceType// (restriction)
3965 ** //MaintainableReferenceBaseType// (restriction)
3966 *** //StructureUsageReferenceBaseType// (restriction)
3967 **** MetadataflowReferenceType
3968
3969 Content:
3970 ( (Ref, URN?) | URN)
3971
3972 Element Documentation:
3973
3974 |**Name**|**Type**|**Documentation**
3975 |Ref|MetadataflowRefType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
3976 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3977 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3978
3979 **MetadataflowRefType: **MetadataflowRefType contains a set of reference fields for a metadata flow.
3980
3981 Derivation:
3982 * //RefBaseType// (restriction)
3983 ** //MaintainableRefBaseType// (restriction)
3984 *** //StructureOrUsageRefBaseType// (restriction)
3985 **** //StructureUsageRefBaseType// (restriction)
3986 ***** MetadataflowRefType
3987
3988 Attributes:
3989 agencyID, id, version?, local?, class?, package?
3990
3991 Content:
3992 {Empty}
3993
3994 Attribute Documentation:
3995
3996 |**Name**|**Type**|**Documentation**
3997 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
3998 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
3999 |version (default: 1.0)|VersionType|The version attribute identifies the version of the object being reference, if applicable. If this is available, a default value of 1.0 will always apply.
4000 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
4001 |class (fixed: Metadataflow)|StructureUsageTypeCo delistType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
4002 |package (fixed: metadatastructure)|StructurePackageType CodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
4003
4004 **DataStructureReferenceType: **DataStructureReferenceType is a type for referencing a data structure definition object. It consists of a URN and/or a complete set of reference fields.
4005
4006 Derivation:
4007 * //ReferenceType// (restriction)
4008 ** //MaintainableReferenceBaseType// (restriction)
4009 *** //StructureReferenceBaseType// (restriction)
4010 **** DataStructureReferenceType
4011
4012 Content:
4013 ( (Ref, URN?) | URN)
4014
4015 Element Documentation:
4016
4017 |**Name**|**Type**|**Documentation**
4018 |Ref|DataStructureRefType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
4019 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4020 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4021
4022 **DataStructureRefType: **DataStructureRefType contains a set of reference fields for a data structure definition.
4023
4024 Derivation:
4025 * //RefBaseType// (restriction)
4026 ** //MaintainableRefBaseType// (restriction)
4027 *** //StructureOrUsageRefBaseType// (restriction)
4028 **** //StructureRefBaseType// (restriction)
4029 ***** DataStructureRefType
4030
4031 Attributes:
4032 agencyID, id, version?, local?, class?, package?
4033
4034 Content:
4035 {Empty}
4036
4037 Attribute Documentation:
4038
4039 |**Name**|**Type**|**Documentation**
4040 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
4041 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
4042 |version (default: 1.0)|VersionType|The version attribute identifies the version of the object being reference, if applicable. If this is available, a default value of 1.0 will always apply.
4043 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
4044 |class (fixed: DataStructure)|StructureTypeCodelis tType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
4045 |package (fixed: datastructure)|StructurePackageType CodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
4046
4047 **KeyDescriptorReferenceType: **KeyDescriptorReferenceType is a type for referencing a key descriptor object. It consists of a URN and/or a complete set of reference fields.
4048
4049 Derivation:
4050 * //ReferenceType// (restriction)
4051 ** //ChildObjectReferenceType// (restriction)
4052 *** //ComponentListReferenceType// (restriction)
4053 **** KeyDescriptorReferenceType
4054
4055 Content:
4056 ( (Ref, URN?) | URN)
4057
4058 Element Documentation:
4059
4060 |**Name**|**Type**|**Documentation**
4061 |Ref|KeyDescriptorRefType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
4062 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4063 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4064
4065 **KeyDescriptorRefType: **KeyDescriptorRefType contains a reference to the key descriptor within a data structure definition.
4066
4067 Derivation:
4068 * //RefBaseType// (restriction)
4069 ** //ChildObjectRefBaseType// (restriction)
4070 *** //ComponentListRefBaseType// (restriction)
4071 **** KeyDescriptorRefType
4072
4073 Attributes:
4074 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
4075
4076 Content:
4077 {Empty}
4078
4079 Attribute Documentation:
4080
4081 |**Name**|**Type**|**Documentation**
4082 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
4083 |maintainableParentID|IDType|The maintainableParentID references the structure in which the component list being referenced is defined.
4084 |maintainableParentVersion (default: 1.0)|VersionType|The maintainableParentVersion attribute references the version of the structure in which the component list being referenced is defined. If not supplied, a default value of 1.0 is assumed.
4085 |id (fixed: DIMENSION_DESCRIPTOR)|IDType|The id attribute identifies the object being referenced, and is therefore always required.
4086 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
4087 |class (fixed: DimensionDescriptor)|ComponentListTypeCod elistType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
4088 |package (fixed: datastructure)|StructurePackageType CodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
4089
4090 **AttributeDescriptorReferenceType: **AttributeDescriptorReferenceType is a type for referencing an attribute descriptor object. It consists of a URN and/or a complete set of reference fields.
4091
4092 Derivation:
4093 * //ReferenceType// (restriction)
4094 ** //ChildObjectReferenceType// (restriction)
4095 *** //ComponentListReferenceType// (restriction)
4096 **** AttributeDescriptorReferenceType
4097
4098 Content:
4099 ( (Ref, URN?) | URN)
4100
4101 Element Documentation:
4102
4103 |**Name**|**Type**|**Documentation**
4104 |Ref|AttributeDescriptorR efType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
4105 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4106 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4107
4108 **AttributeDescriptorRefType: **AttributeDescriptorRefType contains a reference to the attribute descriptor within a data structure definition.
4109
4110 Derivation:
4111 * //RefBaseType// (restriction)
4112 ** //ChildObjectRefBaseType// (restriction)
4113 *** //ComponentListRefBaseType// (restriction)
4114 **** AttributeDescriptorRefType
4115
4116 Attributes:
4117 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
4118
4119 Content:
4120 {Empty}
4121
4122 Attribute Documentation:
4123
4124 |**Name**|**Type**|**Documentation**
4125 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
4126 |maintainableParentID|IDType|The maintainableParentID references the structure in which the component list being referenced is defined.
4127 |maintainableParentVersion (default: 1.0)|VersionType|The maintainableParentVersion attribute references the version of the structure in which the component list being referenced is defined. If not supplied, a default value of 1.0 is assumed.
4128 |id (fixed: ATTRIBUTE_DESCRIPTOR)|IDType|The id attribute identifies the object being referenced, and is therefore always required.
4129 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
4130 |class (fixed: AttributeDescriptor)|ComponentListTypeCod elistType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
4131 |package (fixed: datastructure)|StructurePackageType CodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
4132
4133 **MeasureDescriptorReferenceType: **MeasureDescriptorReferenceType is a type for referencing a measure descriptor object. It consists of a URN and/or a complete set of reference fields.
4134
4135 Derivation:
4136 * //ReferenceType// (restriction)
4137 ** //ChildObjectReferenceType// (restriction)
4138 *** //ComponentListReferenceType// (restriction)
4139 **** MeasureDescriptorReferenceType
4140
4141 Content:
4142 ( (Ref, URN?) | URN)
4143
4144 Element Documentation:
4145
4146 |**Name**|**Type**|**Documentation**
4147 |Ref|MeasureDescriptorRef Type|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
4148 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4149 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4150
4151 **MeasureDescriptorRefType: **MeasureDescriptorRefType contains a reference to the measure descriptor within a data structure definition.
4152
4153 Derivation:
4154 * //RefBaseType// (restriction)
4155 ** //ChildObjectRefBaseType// (restriction)
4156 *** //ComponentListRefBaseType// (restriction)
4157 **** MeasureDescriptorRefType
4158
4159 Attributes:
4160 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
4161
4162 Content:
4163 {Empty}
4164
4165 Attribute Documentation:
4166
4167 |**Name**|**Type**|**Documentation**
4168 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
4169 |maintainableParentID|IDType|The maintainableParentID references the structure in which the component list being referenced is defined.
4170 |maintainableParentVersion (default: 1.0)|VersionType|The maintainableParentVersion attribute references the version of the structure in which the component list being referenced is defined. If not supplied, a default value of 1.0 is assumed.
4171 |id (fixed: MEASURE_DESCRIPTOR)|IDType|The id attribute identifies the object being referenced, and is therefore always required.
4172 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
4173 |class (fixed: MeasureDescriptor)|ComponentListTypeCod elistType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
4174 |package (fixed: datastructure)|StructurePackageType CodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
4175
4176 **GroupKeyDescriptorReferenceType: **GroupKeyDescriptorReferenceType is a type for referencing a group key descriptor object. It consists of a URN and/or a complete set of reference fields.
4177
4178 Derivation:
4179 * //ReferenceType// (restriction)
4180 ** //ChildObjectReferenceType// (restriction)
4181 *** //ComponentListReferenceType// (restriction)
4182 **** GroupKeyDescriptorReferenceType
4183
4184 Content:
4185 ( (Ref, URN?) | URN)
4186
4187 Element Documentation:
4188
4189 |**Name**|**Type**|**Documentation**
4190 |Ref|GroupKeyDescriptorRe fType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
4191 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4192 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4193
4194 **GroupKeyDescriptorRefType: **GroupKeyDescriptorRefType contains a reference to a group key descriptor within a data structure definition.
4195
4196 Derivation:
4197 * //RefBaseType// (restriction)
4198 ** //ChildObjectRefBaseType// (restriction)
4199 *** //ComponentListRefBaseType// (restriction)
4200 **** GroupKeyDescriptorRefType
4201
4202 Attributes:
4203 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
4204
4205 Content:
4206 {Empty}
4207
4208 Attribute Documentation:
4209
4210 |**Name**|**Type**|**Documentation**
4211 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
4212 |maintainableParentID|IDType|The maintainableParentID references the structure in which the component list being referenced is defined.
4213 |maintainableParentVersion (default: 1.0)|VersionType|The maintainableParentVersion attribute references the version of the structure in which the component list being referenced is defined. If not supplied, a default value of 1.0 is assumed.
4214 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
4215 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
4216 |class (fixed: GroupDimensionDescriptor)|ComponentListTypeCod elistType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
4217 |package (fixed: datastructure)|StructurePackageType CodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
4218
4219 **LocalGroupKeyDescriptorReferenceType: **LocalGroupKeyDescriptorReferenceType is a type for referencing a group key descriptor locally, where the reference to the data structure definition which defines it is provided in another context (for example the data structure definition in which the reference occurs).
4220
4221 Derivation:
4222 * //ReferenceType// (restriction)
4223 ** //LocalComponentListReferenceType// (restriction)
4224 *** LocalGroupKeyDescriptorReferenceType
4225
4226 Content:
4227 Ref
4228
4229 Element Documentation:
4230
4231 |**Name**|**Type**|**Documentation**
4232 |Ref|LocalGroupKeyDescrip torRefType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
4233
4234 **LocalGroupKeyDescriptorRefType: **LocalGroupKeyDescriptorRefType contains a local reference to a group key descriptor.
4235
4236 Derivation:
4237 * //RefBaseType// (restriction)
4238 ** //LocalIdentifiableRefBaseType// (restriction)
4239 *** //LocalComponentListRefBaseType// (restriction)
4240 **** LocalGroupKeyDescriptorRefType
4241
4242 Attributes:
4243 id, local?, class?, package?
4244
4245 Content:
4246 {Empty}
4247
4248 Attribute Documentation:
4249
4250 |**Name**|**Type**|**Documentation**
4251 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
4252 |local (fixed: true)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
4253 |class (fixed: GroupDimensionDescriptor)|ComponentListTypeCod elistType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
4254 |package (fixed: datastructure)|StructurePackageType CodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
4255
4256 **DimensionReferenceType: **DimensionReferenceType is a type for referencing a dimension object. It consists of a URN and/or a complete set of reference fields.
4257
4258 Derivation:
4259 * //ReferenceType// (restriction)
4260 ** //ContainerChildObjectReferenceType// (restriction)
4261 *** //ComponentReferenceType// (restriction)
4262 **** DimensionReferenceType
4263
4264 Content:
4265 ( (Ref, URN?) | URN)
4266
4267 Element Documentation:
4268
4269 |**Name**|**Type**|**Documentation**
4270 |Ref|DimensionRefType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
4271 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4272 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4273
4274 **DimensionRefType: **DimensionRefType contains a reference to a dimension within a data structure definition. Note that since there is only one key descriptor, the container reference fields are prohibited.
4275
4276 Derivation:
4277 * //RefBaseType// (restriction)
4278 ** //ContainerChildObjectRefBaseType// (restriction)
4279 *** //ComponentRefBaseType// (restriction)
4280 **** DimensionRefType
4281
4282 Attributes:
4283 agencyID, maintainableParentID, maintainableParentVersion?, id, version?, local?, class?, package?
4284
4285 Content:
4286 {Empty}
4287
4288 Attribute Documentation:
4289
4290 |**Name**|**Type**|**Documentation**
4291 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
4292 |maintainableParentID|IDType|The maintainableParentID references the structure in which the component being referenced is defined.
4293 |maintainableParentVersion (default: 1.0)|VersionType|The maintainableParentVersion attribute references the version of the structure in which the component being referenced is defined. If not supplied, a default value of 1.0 is assumed.
4294 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
4295 |version|VersionType|The version attribute identifies the version of the object being reference, if applicable. If this is available, a default value of 1.0 will always apply.
4296 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
4297 |class (fixed: Dimension)|DimensionTypeCodelis tType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
4298 |package (fixed: datastructure)|StructurePackageType CodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
4299
4300 **MeasureDimensionReferenceType: **MeasureDimensionReferenceType is a type for referencing a measure dimension object. It consists of a URN and/or a complete set of reference fields.
4301
4302 Derivation:
4303 * //ReferenceType// (restriction)
4304 ** //ContainerChildObjectReferenceType// (restriction)
4305 *** //ComponentReferenceType// (restriction)
4306 **** MeasureDimensionReferenceType
4307
4308 Content:
4309 ( (Ref, URN?) | URN)
4310
4311 Element Documentation:
4312
4313 |**Name**|**Type**|**Documentation**
4314 |Ref|MeasureDimensionRefT ype|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
4315 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4316 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4317
4318 **MeasureDimensionRefType: **MeasureDimensionRefType contains a reference to the measure dimension within a data structure definition. Note that since there is only one key descriptor, the container reference fields are prohibited.
4319
4320 Derivation:
4321 * //RefBaseType// (restriction)
4322 ** //ContainerChildObjectRefBaseType// (restriction)
4323 *** //ComponentRefBaseType// (restriction)
4324 **** MeasureDimensionRefType
4325
4326 Attributes:
4327 agencyID, maintainableParentID, maintainableParentVersion?, id, version?, local?, class?, package?
4328
4329 Content:
4330 {Empty}
4331
4332 Attribute Documentation:
4333
4334 |**Name**|**Type**|**Documentation**
4335 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
4336 |maintainableParentID|IDType|The maintainableParentID references the structure in which the component being referenced is defined.
4337 |maintainableParentVersion (default: 1.0)|VersionType|The maintainableParentVersion attribute references the version of the structure in which the component being referenced is defined. If not supplied, a default value of 1.0 is assumed.
4338 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
4339 |version|VersionType|The version attribute identifies the version of the object being reference, if applicable. If this is available, a default value of 1.0 will always apply.
4340 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
4341 |class (fixed: MeasureDimension)|DimensionTypeCodelis tType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
4342 |package (fixed: datastructure)|StructurePackageType CodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
4343
4344 **TimeDimensionReferenceType: **TimeDimensionReferenceType is a type for referencing a time dimension object. It consists of a URN and/or a complete set of reference fields.
4345
4346 Derivation:
4347 * //ReferenceType// (restriction)
4348 ** //ContainerChildObjectReferenceType// (restriction)
4349 *** //ComponentReferenceType// (restriction)
4350 **** TimeDimensionReferenceType
4351
4352 Content:
4353 ( (Ref, URN?) | URN)
4354
4355 Element Documentation:
4356
4357 |**Name**|**Type**|**Documentation**
4358 |Ref|TimeDimensionRefType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
4359 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4360 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4361
4362 **TimeDimensionRefType: **TimeDimensionRefType contains a reference to the time dimension within a data structure definition. Note that since there is only one key descriptor, the container reference fields are prohibited.
4363
4364 Derivation:
4365 * //RefBaseType// (restriction)
4366 ** //ContainerChildObjectRefBaseType// (restriction)
4367 *** //ComponentRefBaseType// (restriction)
4368 **** TimeDimensionRefType
4369
4370 Attributes:
4371 agencyID, maintainableParentID, maintainableParentVersion?, id, version?, local?, class?, package?
4372
4373 Content:
4374 {Empty}
4375
4376 Attribute Documentation:
4377
4378 |**Name**|**Type**|**Documentation**
4379 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
4380 |maintainableParentID|IDType|The maintainableParentID references the structure in which the component being referenced is defined.
4381 |maintainableParentVersion (default: 1.0)|VersionType|The maintainableParentVersion attribute references the version of the structure in which the component being referenced is defined. If not supplied, a default value of 1.0 is assumed.
4382 |id (fixed: TIME_PERIOD)|IDType|The id attribute identifies the object being referenced, and is therefore always required.
4383 |version|VersionType|The version attribute identifies the version of the object being reference, if applicable. If this is available, a default value of 1.0 will always apply.
4384 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
4385 |class (fixed: TimeDimension)|DimensionTypeCodelis tType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
4386 |package (fixed: datastructure)|StructurePackageType CodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
4387
4388 **LocalDimensionReferenceType: **LocalDimensionReferenceType is a type for referencing any type of dimension locally, where the reference to the data structure definition which defines the dimension is provided in another context (for example the data structure definition in which the reference occurs).
4389
4390 Derivation:
4391 * //ReferenceType// (restriction)
4392 ** //LocalComponentListComponentReferenceBaseType// (restriction)
4393 *** //LocalComponentReferenceBaseType// (restriction)
4394 **** LocalDimensionReferenceType
4395
4396 Content:
4397 Ref
4398
4399 Element Documentation:
4400
4401 |**Name**|**Type**|**Documentation**
4402 |Ref|LocalDimensionRefTyp e|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
4403
4404 **LocalDimensionRefType: **LocalDimensionRefType contains the reference fields for referencing a dimension locally.
4405
4406 Derivation:
4407 * //RefBaseType// (restriction)
4408 ** //LocalIdentifiableRefBaseType// (restriction)
4409 *** //LocalComponentListComponentRefBaseType// (restriction)
4410 **** //LocalComponentRefBaseType// (restriction)
4411 ***** LocalDimensionRefType
4412
4413 Attributes:
4414 id, local?, class?, package?
4415
4416 Content:
4417 {Empty}
4418
4419 Attribute Documentation:
4420
4421 |**Name**|**Type**|**Documentation**
4422 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
4423 |local (fixed: true)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
4424 |class (default: Dimension)|DimensionTypeCodelis tType|The class attribute is optional and provided a default value of Dimension. It is strongly recommended that if the time or measure dimension is referenced, that the proper value be set for this field. However, this is not absolutely necessary since all data structure definition components must have a unique identifier within the scope of the entire data structure. It does, however, allow systems which will treat such a reference as a URN to easily construct the URN without having to verify the object class of the referenced dimension.
4425 |package (fixed: datastructure)|StructurePackageType CodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
4426
4427 **AttributeReferenceType: **AttributeReferenceType is a type for referencing an attribute object. It consists of a URN and/or a complete set of reference fields.
4428
4429 Derivation:
4430 * //ReferenceType// (restriction)
4431 ** //ContainerChildObjectReferenceType// (restriction)
4432 *** //ComponentReferenceType// (restriction)
4433 **** AttributeReferenceType
4434
4435 Content:
4436 ( (Ref, URN?) | URN)
4437
4438 Element Documentation:
4439
4440 |**Name**|**Type**|**Documentation**
4441 |Ref|AttributeRefType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
4442 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4443 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4444
4445 **AttributeRefType: **AttributeRefType contains a reference to an attribute within a data structure definition. Note that since there is only one attribute descriptor, the container reference fields are prohibited.
4446
4447 Derivation:
4448 * //RefBaseType// (restriction)
4449 ** //ContainerChildObjectRefBaseType// (restriction)
4450 *** //ComponentRefBaseType// (restriction)
4451 **** AttributeRefType
4452
4453 Attributes:
4454 agencyID, maintainableParentID, maintainableParentVersion?, id, version?, local?, class?, package?
4455
4456 Content:
4457 {Empty}
4458
4459 Attribute Documentation:
4460
4461 |**Name**|**Type**|**Documentation**
4462 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
4463 |maintainableParentID|IDType|The maintainableParentID references the structure in which the component being referenced is defined.
4464 |maintainableParentVersion (default: 1.0)|VersionType|The maintainableParentVersion attribute references the version of the structure in which the component being referenced is defined. If not supplied, a default value of 1.0 is assumed.
4465 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
4466 |version|VersionType|The version attribute identifies the version of the object being reference, if applicable. If this is available, a default value of 1.0 will always apply.
4467 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
4468 |class (fixed: Attribute)|ComponentTypeCodelis tType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
4469 |package (fixed: datastructure)|StructurePackageType CodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
4470
4471 **PrimaryMeasureReferenceType: **PrimaryMeasureReferenceType is a type for referencing a primary measure object. It consists of a URN and/or a complete set of reference fields.
4472
4473 Derivation:
4474 * //ReferenceType// (restriction)
4475 ** //ContainerChildObjectReferenceType// (restriction)
4476 *** //ComponentReferenceType// (restriction)
4477 **** PrimaryMeasureReferenceType
4478
4479 Content:
4480 ( (Ref, URN?) | URN)
4481
4482 Element Documentation:
4483
4484 |**Name**|**Type**|**Documentation**
4485 |Ref|PrimaryMeasureRefTyp e|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
4486 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4487 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4488
4489 **PrimaryMeasureRefType: **PrimaryMeasureRefType contains a reference to the primary measure within a data structure definition. Note that since there is only one key descriptor, the container reference fields are prohibited.
4490
4491 Derivation:
4492
4493 * //RefBaseType// (restriction)
4494 ** //ContainerChildObjectRefBaseType// (restriction)
4495 *** //ComponentRefBaseType// (restriction)
4496 **** PrimaryMeasureRefType
4497
4498 Attributes:
4499 agencyID, maintainableParentID, maintainableParentVersion?, id, version?, local?, class?, package?
4500
4501 Content:
4502 {Empty}
4503
4504 Attribute Documentation:
4505
4506 |**Name**|**Type**|**Documentation**
4507 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
4508 |maintainableParentID|IDType|The maintainableParentID references the structure in which the component being referenced is defined.
4509 |maintainableParentVersion (default: 1.0)|VersionType|The maintainableParentVersion attribute references the version of the structure in which the component being referenced is defined. If not supplied, a default value of 1.0 is assumed.
4510 |id (fixed: OBS_VALUE)|IDType|The id attribute identifies the object being referenced, and is therefore always required.
4511 |version|VersionType|The version attribute identifies the version of the object being reference, if applicable. If this is available, a default value of 1.0 will always apply.
4512 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
4513 |class (fixed: PrimaryMeasure)|ComponentTypeCodelis tType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
4514 |package (fixed: datastructure)|StructurePackageType CodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
4515
4516 **LocalPrimaryMeasureReferenceType: **LocalPrimaryMeasureReferenceType is a type for referencing a primary measure locally, where the reference to the data structure definition which defines the primary measure is provided in another context (for example the data structure definition in which the reference occurs).
4517
4518 Derivation:
4519 * //ReferenceType// (restriction)
4520 ** //LocalComponentListComponentReferenceBaseType// (restriction)
4521 *** //LocalComponentReferenceBaseType// (restriction)
4522 **** LocalPrimaryMeasureReferenceType
4523
4524 Content:
4525 Ref
4526
4527 Element Documentation:
4528
4529 |**Name**|**Type**|**Documentation**
4530 |Ref|LocalPrimaryMeasureR efType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
4531
4532 **LocalPrimaryMeasureRefType: **LocalPrimaryMeasureRefType contains the reference fields for referencing a primary measure locally.
4533
4534 Derivation:
4535 * //RefBaseType// (restriction)
4536 ** //LocalIdentifiableRefBaseType// (restriction)
4537 *** //LocalComponentListComponentRefBaseType// (restriction)
4538 **** //LocalComponentRefBaseType// (restriction)
4539 ***** LocalPrimaryMeasureRefType
4540
4541 Attributes:
4542 id, local?, class?, package?
4543
4544 Content:
4545 {Empty}
4546
4547 Attribute Documentation:
4548
4549 |**Name**|**Type**|**Documentation**
4550 |id (fixed: OBS_VALUE)|IDType|The id attribute identifies the object being referenced, and is therefore always required.
4551 |local (fixed: true)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
4552 |class (fixed: PrimaryMeasure)|ComponentTypeCodelis tType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
4553 |package (fixed: datastructure)|StructurePackageType CodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
4554
4555 **LocalDataStructureComponentReferenceType: **LocalDataStructureComponentReferenceType is a type for referencing any type of data structure component locally, where the reference for the data structure definition which defines the components is available in another context.
4556
4557 Derivation:
4558 * //ReferenceType// (restriction)
4559 ** //LocalComponentListComponentReferenceBaseType// (restriction)
4560 *** LocalDataStructureComponentReferenceType
4561
4562 Content:
4563 Ref
4564
4565 Element Documentation:
4566
4567 |**Name**|**Type**|**Documentation**
4568 |Ref|LocalDataStructureCo mponentRefType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
4569
4570 **LocalDataStructureComponentRefType: **LocalDataStructureComponentRefType contains the reference fields for referencing any data structure component locally. This reference must specify the class of the component being referenced.
4571
4572 Derivation:
4573 * //RefBaseType// (restriction)
4574 ** //LocalIdentifiableRefBaseType// (restriction)
4575 *** //LocalComponentListComponentRefBaseType// (restriction)
4576 **** LocalDataStructureComponentRefType
4577
4578 Attributes:
4579 id, local?, class, package?
4580
4581 Content:
4582 {Empty}
4583
4584 Attribute Documentation:
4585
4586 |**Name**|**Type**|**Documentation**
4587 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
4588 |local (fixed: true)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
4589 |class|DataStructureCompone ntTypeCodelistType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
4590 |package (fixed: datastructure)|StructurePackageType CodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
4591
4592 **DataStructureEnumerationSchemeReferenceType: **DataStructureEnumerationSchemeReferenceType is a type for referencing any type of item scheme that is allowable as the enumeration of the representation of a data structure definition component. It consists of a URN and/or a complete set of reference fields.
4593
4594 Derivation:
4595 * //ReferenceType// (restriction)
4596 ** //MaintainableReferenceBaseType// (restriction)
4597 *** //ItemSchemeReferenceBaseType// (restriction)
4598 **** ItemSchemeReferenceType (restriction)
4599 ***** DataStructureEnumerationSchemeReferenceType
4600
4601 Content:
4602 ( (Ref, URN?) | URN)
4603
4604 Element Documentation:
4605
4606 |**Name**|**Type**|**Documentation**
4607 |Ref|DataStructureEnumera tionSchemeRefType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
4608 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4609 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4610
4611 **DataStructureEnumerationSchemeRefType: **DataStructureEnumerationSchemeRefType contains the reference fields for referencing any item scheme that is allowable as the enumeration of the representation of a data structure definition component.
4612
4613 Derivation:
4614 * //RefBaseType// (restriction)
4615 ** //MaintainableRefBaseType// (restriction)
4616 *** //ItemSchemeRefBaseType// (restriction)
4617 **** ItemSchemeRefType (restriction)
4618 ***** DataStructureEnumerationSchemeRefType
4619
4620 Attributes:
4621 agencyID, id, version?, local?, class, package
4622
4623 Content:
4624 {Empty}
4625
4626 Attribute Documentation:
4627
4628 |**Name**|**Type**|**Documentation**
4629 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
4630 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
4631 |version (default: 1.0)|VersionType|The version attribute identifies the version of the object being reference, if applicable. If this is available, a default value of 1.0 will always apply.
4632 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
4633 |class|DimensionEumerationS chemeTypeCodelistTyp e|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
4634 |package|ItemSchemePackageTyp eCodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
4635
4636 **MetadataStructureReferenceType: **MetadataStructureReferenceType is a type for referencing a metadata structure definition object. It consists of a URN and/or a complete set of reference fields.
4637
4638 Derivation:
4639 * //ReferenceType// (restriction)
4640 ** //MaintainableReferenceBaseType// (restriction)
4641 *** //StructureReferenceBaseType// (restriction)
4642 **** MetadataStructureReferenceType
4643
4644 Content:
4645 ( (Ref, URN?) | URN)
4646
4647 Element Documentation:
4648
4649 |**Name**|**Type**|**Documentation**
4650 |Ref|MetadataStructureRef Type|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
4651 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4652 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4653
4654 **MetadataStructureRefType: **MetadataStructureRefType contains a set of reference fields for a metadata structure definition.
4655
4656 Derivation:
4657 * //RefBaseType// (restriction)
4658 ** //MaintainableRefBaseType// (restriction)
4659 *** //StructureOrUsageRefBaseType// (restriction)
4660 **** //StructureRefBaseType// (restriction)
4661 ***** MetadataStructureRefType
4662
4663 Attributes:
4664 agencyID, id, version?, local?, class?, package?
4665
4666 Content:
4667 {Empty}
4668
4669 Attribute Documentation:
4670
4671 |**Name**|**Type**|**Documentation**
4672 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
4673 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
4674 |version (default: 1.0)|VersionType|The version attribute identifies the version of the object being reference, if applicable. If this is available, a default value of 1.0 will always apply.
4675 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
4676 |class (fixed: MetadataStructure)|StructureTypeCodelis tType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
4677 |package (fixed: metadatastructure)|StructurePackageType CodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
4678
4679 **MetadataTargetReferenceType: **MetadataTargetReferenceType is a type for referencing a metadata target object. It consists of a URN and/or a complete set of reference fields.
4680
4681 Derivation:
4682 * //ReferenceType// (restriction)
4683 ** //ChildObjectReferenceType// (restriction)
4684 *** //ComponentListReferenceType// (restriction)
4685 **** MetadataTargetReferenceType
4686
4687 Content:
4688 ( (Ref, URN?) | URN)
4689
4690 Element Documentation:
4691
4692 |**Name**|**Type**|**Documentation**
4693 |Ref|MetadataTargetRefTyp e|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
4694 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4695 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4696
4697 **MetadataTargetRefType: **MetadataTargetRefType contains a reference to a metadata target within a metadata structure definition.
4698
4699 Derivation:
4700 * //RefBaseType// (restriction)
4701 ** //ChildObjectRefBaseType// (restriction)
4702 *** //ComponentListRefBaseType// (restriction)
4703 **** MetadataTargetRefType
4704
4705 Attributes:
4706 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
4707
4708 Content:
4709 {Empty}
4710
4711 Attribute Documentation:
4712
4713 |**Name**|**Type**|**Documentation**
4714 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
4715 |maintainableParentID|IDType|The maintainableParentID references the structure in which the component list being referenced is defined.
4716 |maintainableParentVersion (default: 1.0)|VersionType|The maintainableParentVersion attribute references the version of the structure in which the component list being referenced is defined. If not supplied, a default value of 1.0 is assumed.
4717 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
4718 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
4719 |class (fixed: MetadataTarget)|ComponentListTypeCod elistType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
4720 |package (fixed: metadatastructure)|StructurePackageType CodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
4721
4722 **LocalMetadataTargetReferenceType: **LocalMetadataTargetReferenceType is a type for referencing a metadata target locally, where the reference to the metadata structure definition which defines it is provided in another context (for example the metadata structure definition in which the reference occurs).
4723
4724 Derivation:
4725 * //ReferenceType// (restriction)
4726 ** //LocalComponentListReferenceType// (restriction)
4727 *** LocalMetadataTargetReferenceType
4728
4729 Content:
4730 Ref
4731
4732 Element Documentation:
4733
4734 |**Name**|**Type**|**Documentation**
4735 |Ref|LocalMetadataTargetR efType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
4736
4737 **LocalMetadataTargetRefType: **LocalMetadataTargetRefType contains a local reference to a metadata target object.
4738
4739 Derivation:
4740 * //RefBaseType// (restriction)
4741 ** //LocalIdentifiableRefBaseType// (restriction)
4742 *** //LocalComponentListRefBaseType// (restriction)
4743 **** LocalMetadataTargetRefType
4744
4745 Attributes:
4746 id, local?, class?, package?
4747
4748 Content:
4749 {Empty}
4750
4751 Attribute Documentation:
4752
4753 |**Name**|**Type**|**Documentation**
4754 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
4755 |local (fixed: true)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
4756 |class (fixed: MetadataTarget)|ComponentListTypeCod elistType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
4757 |package (fixed: metadatastructure)|StructurePackageType CodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
4758
4759 **ConstraintTargetReferenceType: **ConstraintTargetReferenceType is a type for referencing a constraint target object. It consists of a URN and/or a complete set of reference fields.
4760
4761 Derivation:
4762 * //ReferenceType// (restriction)
4763 ** //ContainerChildObjectReferenceType// (restriction)
4764 *** //ComponentReferenceType// (restriction)
4765 **** ConstraintTargetReferenceType
4766
4767 Content:
4768 ( (Ref, URN?) | URN)
4769
4770 Element Documentation:
4771
4772 |**Name**|**Type**|**Documentation**
4773 |Ref|ConstraintTargetRefT ype|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
4774 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4775 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4776
4777 **ConstraintTargetRefType: **ConstraintTargetRefType contains a reference to a constraint target within a metadata target of a data structure definition.
4778
4779 Derivation:
4780 * //RefBaseType// (restriction)
4781 ** //ContainerChildObjectRefBaseType// (restriction)
4782 *** //ComponentRefBaseType// (restriction)
4783 **** ConstraintTargetRefType
4784
4785 Attributes:
4786 agencyID, maintainableParentID, maintainableParentVersion?, containerID, id, version?, local?, class?, package?
4787
4788 Content:
4789 {Empty}
4790
4791 Attribute Documentation:
4792
4793 |**Name**|**Type**|**Documentation**
4794 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
4795 |maintainableParentID|IDType|The maintainableParentID references the structure in which the component being referenced is defined.
4796 |maintainableParentVersion (default: 1.0)|VersionType|The maintainableParentVersion attribute references the version of the structure in which the component being referenced is defined. If not supplied, a default value of 1.0 is assumed.
4797 |containerID|IDType|The containerID attribute references the component list of that contains the component being referenced. It is optional for the cases where the component list has a fixed identifier. Specific implementations of this will prohibit or require this accordingly.
4798 |id (fixed: CONSTRAINT_TARGET)|IDType|The id attribute identifies the object being referenced, and is therefore always required.
4799 |version|VersionType|The version attribute identifies the version of the object being reference, if applicable. If this is available, a default value of 1.0 will always apply.
4800 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
4801 |class (fixed: ConstraintTarget)|ComponentTypeCodelis tType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
4802 |package (fixed: metadatastructure)|StructurePackageType CodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
4803
4804 **DataSetTargetReferenceType: **DataSetTargetReferenceType is a type for referencing a data set target object. It consists of a URN and/or a complete set of reference fields.
4805
4806 Derivation:
4807 * //ReferenceType// (restriction)
4808 ** //ContainerChildObjectReferenceType// (restriction)
4809 *** //ComponentReferenceType// (restriction)
4810 **** DataSetTargetReferenceType
4811
4812 Content:
4813 ( (Ref, URN?) | URN)
4814
4815 Element Documentation:
4816
4817 |**Name**|**Type**|**Documentation**
4818 |Ref|DataSetTargetRefType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
4819 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4820 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4821
4822 **DataSetTargetRefType: **DataSetTargetRefType contains a reference to a data set target within a metadata target of a data structure definition.
4823
4824 Derivation:
4825 * //RefBaseType// (restriction)
4826 ** //ContainerChildObjectRefBaseType// (restriction)
4827 *** //ComponentRefBaseType// (restriction)
4828 **** DataSetTargetRefType
4829
4830 Attributes:
4831 agencyID, maintainableParentID, maintainableParentVersion?, containerID, id, version?, local?, class?, package?
4832
4833 Content:
4834 {Empty}
4835
4836 Attribute Documentation:
4837
4838 |**Name**|**Type**|**Documentation**
4839 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
4840 |maintainableParentID|IDType|The maintainableParentID references the structure in which the component being referenced is defined.
4841 |maintainableParentVersion (default: 1.0)|VersionType|The maintainableParentVersion attribute references the version of the structure in which the component being referenced is defined. If not supplied, a default value of 1.0 is assumed.
4842 |containerID|IDType|The containerID attribute references the component list of that contains the component being referenced. It is optional for the cases where the component list has a fixed identifier. Specific implementations of this will prohibit or require this accordingly.
4843 |id (fixed: DATA_SET_TARGET)|IDType|The id attribute identifies the object being referenced, and is therefore always required.
4844 |version|VersionType|The version attribute identifies the version of the object being reference, if applicable. If this is available, a default value of 1.0 will always apply.
4845 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
4846 |class (fixed: DataSetTarget)|ComponentTypeCodelis tType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
4847 |package (fixed: metadatastructure)|StructurePackageType CodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
4848
4849 **KeyDescriptorValuesTargetReferenceType: **KeyDescriptorValuesTargetType is a type for referencing a key descriptor values target object. It consists of a URN and/or a complete set of reference fields.
4850
4851 Derivation:
4852 * //ReferenceType// (restriction)
4853 ** //ContainerChildObjectReferenceType// (restriction)
4854 *** //ComponentReferenceType// (restriction)
4855 **** KeyDescriptorValuesTargetReferenceType
4856
4857 Content:
4858 ( (Ref, URN?) | URN)
4859
4860 Element Documentation:
4861
4862 |**Name**|**Type**|**Documentation**
4863 |Ref|KeyDescriptorValuesT argetRefType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
4864 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4865 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4866
4867 **KeyDescriptorValuesTargetRefType: **KeyDescriptorValuesTargetRefType contains a reference to a key descriptor values target within a metadata target of a data structure definition.
4868
4869 Derivation:
4870 * //RefBaseType// (restriction)
4871 ** //ContainerChildObjectRefBaseType// (restriction)
4872 *** //ComponentRefBaseType// (restriction)
4873 **** KeyDescriptorValuesTargetRefType
4874
4875 Attributes:
4876 agencyID, maintainableParentID, maintainableParentVersion?, containerID, id, version?, local?, class?, package?
4877
4878 Content:
4879 {Empty}
4880
4881 Attribute Documentation:
4882
4883 |**Name**|**Type**|**Documentation**
4884 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
4885 |maintainableParentID|IDType|The maintainableParentID references the structure in which the component being referenced is defined.
4886 |maintainableParentVersion (default: 1.0)|VersionType|The maintainableParentVersion attribute references the version of the structure in which the component being referenced is defined. If not supplied, a default value of 1.0 is assumed.
4887 |containerID|IDType|The containerID attribute references the component list of that contains the component being referenced. It is optional for the cases where the component list has a fixed identifier. Specific implementations of this will prohibit or require this accordingly.
4888 |id (fixed: DIMENSION_DESCRIPTOR_VALUES_TARGET)|IDType|The id attribute identifies the object being referenced, and is therefore always required.
4889 |version|VersionType|The version attribute identifies the version of the object being reference, if applicable. If this is available, a default value of 1.0 will always apply.
4890 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
4891 |class (fixed: DimensionDescriptorValuesTarget)|ComponentTypeCodelis tType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
4892 |package (fixed: metadatastructure)|StructurePackageType CodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
4893
4894 **ReportPeriodTargetReferenceType: **ReportPeriodTargetReferenceType is a type for referencing a report period target object. It consists of a URN and/or a complete set of reference fields.
4895
4896 Derivation:
4897 * //ReferenceType// (restriction)
4898 ** //ContainerChildObjectReferenceType// (restriction)
4899 *** //ComponentReferenceType// (restriction)
4900 **** ReportPeriodTargetReferenceType
4901
4902 Content:
4903 ( (Ref, URN?) | URN)
4904
4905 Element Documentation:
4906
4907 |**Name**|**Type**|**Documentation**
4908 |Ref|ReportPeriodTargetRe fType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
4909 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4910 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4911
4912 **ReportPeriodTargetRefType: **ReportPeriodTargetRefType contains a reference to a report period target within a metadata target of a data structure definition.
4913
4914 Derivation:
4915 * //RefBaseType// (restriction)
4916 ** //ContainerChildObjectRefBaseType// (restriction)
4917 *** //ComponentRefBaseType// (restriction)
4918 **** ReportPeriodTargetRefType
4919
4920 Attributes:
4921 agencyID, maintainableParentID, maintainableParentVersion?, containerID, id, version?, local?, class?, package?
4922
4923 Content:
4924 {Empty}
4925
4926 Attribute Documentation:
4927
4928 |**Name**|**Type**|**Documentation**
4929 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
4930 |maintainableParentID|IDType|The maintainableParentID references the structure in which the component being referenced is defined.
4931 |maintainableParentVersion (default: 1.0)|VersionType|The maintainableParentVersion attribute references the version of the structure in which the component being referenced is defined. If not supplied, a default value of 1.0 is assumed.
4932 |containerID|IDType|The containerID attribute references the component list of that contains the component being referenced. It is optional for the cases where the component list has a fixed identifier. Specific implementations of this will prohibit or require this accordingly.
4933 |id (fixed: REPORT_PERIOD_TARGET)|IDType|The id attribute identifies the object being referenced, and is therefore always required.
4934 |version|VersionType|The version attribute identifies the version of the object being reference, if applicable. If this is available, a default value of 1.0 will always apply.
4935 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
4936 |class (fixed: ReportPeriodTarget)|ComponentTypeCodelis tType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
4937 |package (fixed: metadatastructure)|StructurePackageType CodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
4938
4939 **IdentifiableObjectTargetReferenceType: **IdentifiableObjectTargetReferenceType is a type for referencing an identifiable object target object. It consists of a URN and/or a complete set of reference fields.
4940
4941 Derivation:
4942 * //ReferenceType// (restriction)
4943 ** //ContainerChildObjectReferenceType// (restriction)
4944 *** //ComponentReferenceType// (restriction)
4945 **** IdentifiableObjectTargetReferenceType
4946
4947 Content:
4948 ( (Ref, URN?) | URN)
4949
4950 Element Documentation:
4951
4952 |**Name**|**Type**|**Documentation**
4953 |Ref|IdentifiableObjectTa rgetRefType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
4954 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4955 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4956
4957 **IdentifiableObjectTargetRefType: **IdentifiableObjectTargetRefType contains a reference to an identifiable object target within a metadata target of a data structure definition.
4958
4959 Derivation:
4960 * //RefBaseType// (restriction)
4961 ** //ContainerChildObjectRefBaseType// (restriction)
4962 *** //ComponentRefBaseType// (restriction)
4963 **** IdentifiableObjectTargetRefType
4964
4965 Attributes:
4966 agencyID, maintainableParentID, maintainableParentVersion?, containerID?, id, version?, local?, class?, package?
4967
4968 Content:
4969 {Empty}
4970
4971 Attribute Documentation:
4972
4973 |**Name**|**Type**|**Documentation**
4974 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
4975 |maintainableParentID|IDType|The maintainableParentID references the structure in which the component being referenced is defined.
4976 |maintainableParentVersion (default: 1.0)|VersionType|The maintainableParentVersion attribute references the version of the structure in which the component being referenced is defined. If not supplied, a default value of 1.0 is assumed.
4977 |containerID|NestedIDType|The containerID attribute references the component list of that contains the component being referenced. It is optional for the cases where the component list has a fixed identifier. Specific implementations of this will prohibit or require this accordingly.
4978 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
4979 |version|VersionType|The version attribute identifies the version of the object being reference, if applicable. If this is available, a default value of 1.0 will always apply.
4980 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
4981 |class (fixed: IdentifiableObjectTarget)|ComponentTypeCodelis tType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
4982 |package (fixed: metadatastructure)|StructurePackageType CodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
4983
4984 **LocalTargetObjectReferenceType: **LocalTargetObjectReferenceType is a type for referencing any type of target object within a metadata target locally, where the references to the metadata target and the metadata structure definition which defines the target reference are provided in another context.
4985
4986 Derivation:
4987 * //ReferenceType// (restriction)
4988 ** //LocalComponentListComponentReferenceBaseType// (restriction)
4989 *** //LocalComponentReferenceBaseType// (restriction)
4990 **** LocalTargetObjectReferenceType
4991
4992 Content:
4993 Ref
4994
4995 Element Documentation:
4996
4997 |**Name**|**Type**|**Documentation**
4998 |Ref|LocalTargetObjectRef Type|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
4999
5000 **LocalTargetObjectRefType: **LocalTargetObjectRefType contains the reference fields for referencing a target object locally.
5001
5002 Derivation:
5003 * //RefBaseType// (restriction)
5004 ** //LocalIdentifiableRefBaseType// (restriction)
5005 *** //LocalComponentListComponentRefBaseType// (restriction)
5006 **** //LocalComponentRefBaseType// (restriction)
5007 ***** LocalTargetObjectRefType
5008
5009 Attributes:
5010 id, local?, class, package?
5011
5012 Content:
5013 {Empty}
5014
5015 Attribute Documentation:
5016
5017 |**Name**|**Type**|**Documentation**
5018 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
5019 |local (fixed: true)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
5020 |class|TargetObjectTypeCode listType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
5021 |package (fixed: metadatastructure)|StructurePackageType CodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
5022
5023 **ReportStructureReferenceType: **ReportStructureReferenceType is a type for referencing a report structure object. It consists of a URN and/or a complete set of reference fields.
5024
5025 Derivation:
5026 * //ReferenceType// (restriction)
5027 ** //ChildObjectReferenceType// (restriction)
5028 *** //ComponentListReferenceType// (restriction)
5029 **** ReportStructureReferenceType
5030
5031 Content:
5032 ( (Ref, URN?) | URN)
5033
5034 Element Documentation:
5035
5036 |**Name**|**Type**|**Documentation**
5037 |Ref|ReportStructureRefTy pe|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
5038 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5039 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5040
5041 **ReportStructureRefType: **ReportStructureRefType contains a reference to a report structure within a metadata structure definition.
5042
5043 Derivation:
5044 * //RefBaseType// (restriction)
5045 ** //ChildObjectRefBaseType// (restriction)
5046 *** //ComponentListRefBaseType// (restriction)
5047 **** ReportStructureRefType
5048
5049 Attributes:
5050 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
5051
5052 Content:
5053 {Empty}
5054
5055 Attribute Documentation:
5056
5057 |**Name**|**Type**|**Documentation**
5058 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
5059 |maintainableParentID|IDType|The maintainableParentID references the structure in which the component list being referenced is defined.
5060 |maintainableParentVersion (default: 1.0)|VersionType|The maintainableParentVersion attribute references the version of the structure in which the component list being referenced is defined. If not supplied, a default value of 1.0 is assumed.
5061 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
5062 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
5063 |class (fixed: ReportStructure)|ComponentListTypeCod elistType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
5064 |package (fixed: metadatastructure)|StructurePackageType CodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
5065
5066 **LocalReportStructureReferenceType: **LocalReportStructureReferenceType is a type for referencing a report structure locally, where the reference to the metadata structure definition which defines it is provided in another context (for example the metadata structure definition in which the reference occurs).
5067
5068 Derivation:
5069 * //ReferenceType// (restriction)
5070 ** //LocalComponentListReferenceType// (restriction)
5071 *** LocalReportStructureReferenceType
5072
5073 Content:
5074 Ref
5075
5076 Element Documentation:
5077
5078 |**Name**|**Type**|**Documentation**
5079 |Ref|LocalReportStructure RefType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
5080
5081 **LocalReportStructureRefType: **LocalReportStructureRefType contains a local reference to a report structure object.
5082
5083 Derivation:
5084 * //RefBaseType// (restriction)
5085 ** //LocalIdentifiableRefBaseType// (restriction)
5086 *** //LocalComponentListRefBaseType// (restriction)
5087 **** LocalReportStructureRefType
5088
5089 Attributes:
5090 id, local?, class?, package?
5091
5092 Content:
5093 {Empty}
5094
5095 Attribute Documentation:
5096
5097 |**Name**|**Type**|**Documentation**
5098 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
5099 |local (fixed: true)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
5100 |class (fixed: ReportStructure)|ComponentListTypeCod elistType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
5101 |package (fixed: metadatastructure)|StructurePackageType CodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
5102
5103 **MetadataAttributeReferenceType: **MetadataAttributeReferenceType is a type for referencing a metadata attribute object. It consists of a URN and/or a complete set of reference fields.
5104
5105 Derivation:
5106 * //ReferenceType// (restriction)
5107 ** //ContainerChildObjectReferenceType// (restriction)
5108 *** //ComponentReferenceType// (restriction)
5109 **** MetadataAttributeReferenceType
5110
5111 Content:
5112 ( (Ref, URN?) | URN)
5113
5114 Element Documentation:
5115
5116 |**Name**|**Type**|**Documentation**
5117 |Ref|MetadataAttributeRef Type|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
5118 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5119 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5120
5121 **MetadataAttributeRefType: **MetadataAttributeRefType contains a reference to a metadata attribute within a report structure in a metadata structure definition.
5122
5123 Derivation:
5124 * //RefBaseType// (restriction)
5125 ** //ContainerChildObjectRefBaseType// (restriction)
5126 *** //ComponentRefBaseType// (restriction)
5127 **** MetadataAttributeRefType
5128
5129 Attributes:
5130 agencyID, maintainableParentID, maintainableParentVersion?, containerID, id, version?, local?, class?, package?
5131
5132 Content:
5133 {Empty}
5134
5135 Attribute Documentation:
5136
5137 |**Name**|**Type**|**Documentation**
5138 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
5139 |maintainableParentID|IDType|The maintainableParentID references the structure in which the component being referenced is defined.
5140 |maintainableParentVersion (default: 1.0)|VersionType|The maintainableParentVersion attribute references the version of the structure in which the component being referenced is defined. If not supplied, a default value of 1.0 is assumed.
5141 |containerID|IDType|The containerID attribute references the component list of that contains the component being referenced. It is optional for the cases where the component list has a fixed identifier. Specific implementations of this will prohibit or require this accordingly.
5142 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
5143 |version|VersionType|The version attribute identifies the version of the object being reference, if applicable. If this is available, a default value of 1.0 will always apply.
5144 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
5145 |class (fixed: MetadataAttribute)|ComponentTypeCodelis tType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
5146 |package (fixed: metadatastructure)|StructurePackageType CodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
5147
5148 **LocalMetadataStructureComponentReferenceType: **LocalMetadataStructureComponentReferenceType is a type for referencing any type of metadata structure component locally, where the reference for the metadata structure definition which defines the components is available in another context.
5149
5150 Derivation:
5151 * //ReferenceType// (restriction)
5152 ** //LocalComponentListComponentReferenceBaseType// (restriction)
5153 *** LocalMetadataStructureComponentReferenceType
5154
5155 Content:
5156 Ref
5157
5158 Element Documentation:
5159
5160 |**Name**|**Type**|**Documentation**
5161 |Ref|LocalMetadataStructu reComponentRefType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
5162
5163 **LocalMetadataStructureComponentRefType: **LocalMetadataStructureComponentRefType contains the reference fields for referencing any metadata structure component locally. This reference must specify the class of the component being referenced.
5164
5165 Derivation:
5166 * //RefBaseType// (restriction)
5167 ** //LocalIdentifiableRefBaseType// (restriction)
5168 *** //LocalComponentListComponentRefBaseType// (restriction)
5169 **** LocalMetadataStructureComponentRefType
5170
5171 Attributes:
5172 containerID, id, local?, class, package?
5173
5174 Content:
5175 {Empty}
5176
5177 Attribute Documentation:
5178
5179 |**Name**|**Type**|**Documentation**
5180 |containerID|IDType|The containerID attribute identifies the object within a maintainable object in which the referenced object is defined (container-object-id in the URN structure). This is only used in references where the referenced object is not contained directly within a maintainable object (e.g. a Component within a ComponentList, within a maintainable Structure). If the container has a fixed identifier, this attribute will not be present.
5181 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
5182 |local (fixed: true)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
5183 |class|MetadataStructureCom ponentTypeCodelistTy pe|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
5184 |package (fixed: metadatastructure)|StructurePackageType CodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
5185
5186 **ProvisionAgreementReferenceType: **ProvisionAgreementReferenceType is a type for referencing a provision agreement. It consists of a URN and/or a complete set of reference fields.
5187
5188 Derivation:
5189 * //ReferenceType// (restriction)
5190 ** //MaintainableReferenceBaseType// (restriction)
5191 *** ProvisionAgreementReferenceType
5192
5193 Content:
5194 ( (Ref, URN?) | URN)
5195
5196 Element Documentation:
5197
5198 |**Name**|**Type**|**Documentation**
5199 |Ref|ProvisionAgreementRe fType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
5200 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5201 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5202
5203 **ProvisionAgreementRefType: **ProvisionAgreementRefType contains a set of reference fields for a provision agreement.
5204
5205 Derivation:
5206 * //RefBaseType// (restriction)
5207 ** //MaintainableRefBaseType// (restriction)
5208 *** ProvisionAgreementRefType
5209
5210 Attributes:
5211 agencyID, id, version?, local?, class?, package?
5212
5213 Content:
5214 {Empty}
5215
5216 Attribute Documentation:
5217
5218 |**Name**|**Type**|**Documentation**
5219 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
5220 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
5221 |version (default: 1.0)|VersionType|The version attribute identifies the version of the object being reference, if applicable. If this is available, a default value of 1.0 will always apply.
5222 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
5223 |class (fixed: ProvisionAgreement)|MaintainableTypeCode listType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
5224 |package (fixed: registry)|PackageTypeCodelistT ype|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
5225
5226 **ProcessReferenceType: **ProcessReferenceType is a type for referencing a process object. It consists of a URN and/or a complete set of reference fields.
5227
5228 Derivation:
5229 * //ReferenceType// (restriction)
5230 ** //MaintainableReferenceBaseType// (restriction)
5231 *** ProcessReferenceType
5232
5233 Content:
5234 ( (Ref, URN?) | URN)
5235
5236 Element Documentation:
5237
5238 |**Name**|**Type**|**Documentation**
5239 |Ref|ProcessRefType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
5240 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5241 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5242
5243 **ProcessRefType: **ProcessRefType contains a set of reference fields for a process.
5244
5245 Derivation:
5246 * //RefBaseType// (restriction)
5247 ** //MaintainableRefBaseType// (restriction)
5248 *** ProcessRefType
5249
5250 Attributes:
5251 agencyID, id, version?, local?, class?, package?
5252
5253 Content:
5254 {Empty}
5255
5256 Attribute Documentation:
5257
5258 |**Name**|**Type**|**Documentation**
5259 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
5260 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
5261 |version (default: 1.0)|VersionType|The version attribute identifies the version of the object being reference, if applicable. If this is available, a default value of 1.0 will always apply.
5262 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
5263 |class (fixed: Process)|MaintainableTypeCode listType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
5264 |package (fixed: process)|PackageTypeCodelistT ype|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
5265
5266 **ProcessStepReferenceType: **ProcessStepReferenceType is a type for referencing a process step object. It consists of a URN and/or a complete set of reference fields.
5267
5268 Derivation:
5269 * //ReferenceType// (restriction)
5270 ** //ChildObjectReferenceType// (restriction)
5271 *** ProcessStepReferenceType
5272
5273 Content:
5274 ( (Ref, URN?) | URN)
5275
5276 Element Documentation:
5277
5278 |**Name**|**Type**|**Documentation**
5279 |Ref|ProcessStepRefType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
5280 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5281 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5282
5283 **ProcessStepRefType: **ProcessStepRefType provides for a reference to a process step through its id. Support for referencing nested process steps is provided through a nested identifier.
5284
5285 Derivation:
5286 * //RefBaseType// (restriction)
5287 ** //ChildObjectRefBaseType// (restriction)
5288 *** ProcessStepRefType
5289
5290 Attributes:
5291 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
5292
5293 Content:
5294 {Empty}
5295
5296 Attribute Documentation:
5297
5298 |**Name**|**Type**|**Documentation**
5299 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
5300 |maintainableParentID|IDType|The maintainableParentID attribute identifies the maintainable object in which the referenced object is defined, if applicable (maintainable-parent-object-id in the URN structure). This is only used in references where the referenced object is not itself maintainable.
5301 |maintainableParentVersion (default: 1.0)|VersionType|The maintainableParentVersion attribute identifies the version of the maintainable object in which the referenced object is defined (maintainable-parent-object-version in the URN structure). This is only used in references where the referenced object is not itself maintainable. This should only be used when the maintainableParentID is present. If this is available, a default of 1.0 will always apply.
5302 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
5303 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
5304 |class (fixed: ProcessStep)|ObjectTypeCodelistTy pe|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
5305 |package (fixed: process)|PackageTypeCodelistT ype|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
5306
5307 **LocalProcessStepReferenceType: **LocalProcessStepReferenceType is a type for referencing a process step locally, where the reference to the process which defines it is provided in another context (for example the metadata structure definition in which the reference occurs).
5308
5309 Derivation:
5310 * //ReferenceType// (restriction)
5311 ** //LocalIdentifiableReferenceType// (restriction)
5312 *** LocalProcessStepReferenceType
5313
5314 Content:
5315 Ref
5316
5317 Element Documentation:
5318
5319 |**Name**|**Type**|**Documentation**
5320 |Ref|LocalProcessStepRefT ype|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
5321
5322 **LocalProcessStepRefType: **LocalProcessStepRefType contains a local reference to a process step object.
5323
5324 Derivation:
5325 * //RefBaseType// (restriction)
5326 ** //LocalIdentifiableRefBaseType// (restriction)
5327 *** LocalProcessStepRefType
5328
5329 Attributes:
5330 containerID?, id, local?, class?, package?
5331
5332 Content:
5333 {Empty}
5334
5335 Attribute Documentation:
5336
5337 |**Name**|**Type**|**Documentation**
5338 |containerID|NestedIDType|The containerID attribute identifies the object within a maintainable object in which the referenced object is defined (container-object-id in the URN structure). This is only used in references where the referenced object is not contained directly within a maintainable object (e.g. a Component within a ComponentList, within a maintainable Structure). If the container has a fixed identifier, this attribute will not be present.
5339 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
5340 |local (fixed: true)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
5341 |class (fixed: ProcessStep)|ObjectTypeCodelistTy pe|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
5342 |package (fixed: process)|PackageTypeCodelistT ype|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
5343
5344 **TransitionReferenceType: **TransiationReferenceType is a type for referencing a process step object. It consists of a URN and/or a complete set of reference fields.
5345
5346 Derivation:
5347 * //ReferenceType// (restriction)
5348 ** //ContainerChildObjectReferenceType// (restriction)
5349 *** TransitionReferenceType
5350
5351 Content:
5352 ( (Ref, URN?) | URN)
5353
5354 Element Documentation:
5355
5356 |**Name**|**Type**|**Documentation**
5357 |Ref|TransitionRefType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
5358 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5359 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5360
5361 **TransitionRefType: **TransitionRefType provides for a reference to a transition definition in process step through its id.
5362
5363 Derivation:
5364 * //RefBaseType// (restriction)
5365 ** //ContainerChildObjectRefBaseType// (restriction)
5366 *** TransitionRefType
5367
5368 Attributes:
5369 agencyID, maintainableParentID, maintainableParentVersion?, containerID, id, version?, local?, class?, package?
5370
5371 Content:
5372 {Empty}
5373
5374 Attribute Documentation:
5375
5376 |**Name**|**Type**|**Documentation**
5377 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
5378 |maintainableParentID|IDType|The maintainableParentID attribute identifies the maintainable object in which the referenced object is defined, if applicable (maintainable-parent-object-id in the URN structure). This is only used in references where the referenced object is not itself maintainable.
5379 |maintainableParentVersion (default: 1.0)|VersionType|The maintainableParentVersion attribute identifies the version of the maintainable object in which the referenced object is defined (maintainable-parent-object-version in the URN structure). This is only used in references where the referenced object is not itself maintainable. This should only be used when the maintainableParentID is present. If this is available, a default of 1.0 will always apply.
5380 |containerID|NestedIDType|The containerID attribute identifies the object within a maintainable object in which the referenced object is defined (container-object-id in the URN structure). This is only used in references where the referenced object is not contained directly within a maintainable object (e.g. a Component within a ComponentList, within a maintainable Structure). If the container has a fixed identifier, this attribute will not be present.
5381 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
5382 |version|VersionType|The version attribute identifies the version of the object being reference, if applicable. If this is available, a default value of 1.0 will always apply.
5383 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
5384 |class (fixed: Transition)|ObjectTypeCodelistTy pe|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
5385 |package (fixed: process)|PackageTypeCodelistT ype|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
5386
5387 **StructureSetReferenceType: **StructureSetReferenceType is a type for referencing a structure set object. It consists of a URN and/or a complete set of reference fields.
5388
5389 Derivation:
5390 * //ReferenceType// (restriction)
5391 ** //MaintainableReferenceBaseType// (restriction)
5392 *** StructureSetReferenceType
5393
5394 Content:
5395 ( (Ref, URN?) | URN)
5396
5397 Element Documentation:
5398
5399 |**Name**|**Type**|**Documentation**
5400 |Ref|StructureSetRefType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
5401 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5402 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5403
5404 **StructureSetRefType: **StructureSetRefType contains a set of reference fields for a structure set.
5405
5406 Derivation:
5407 * //RefBaseType// (restriction)
5408 ** //MaintainableRefBaseType// (restriction)
5409 *** StructureSetRefType
5410
5411 Attributes:
5412 agencyID, id, version?, local?, class?, package?
5413
5414 Content:
5415 {Empty}
5416
5417 Attribute Documentation:
5418
5419 |**Name**|**Type**|**Documentation**
5420 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
5421 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
5422 |version (default: 1.0)|VersionType|The version attribute identifies the version of the object being reference, if applicable. If this is available, a default value of 1.0 will always apply.
5423 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
5424 |class (fixed: StructureSet)|MaintainableTypeCode listType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
5425 |package (fixed: mapping)|PackageTypeCodelistT ype|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
5426
5427 **StructureMapReferenceType: **StructureMapReferenceType is a type for referencing a structure map object. It consists of a URN and/or a complete set of reference fields.
5428
5429 Derivation:
5430 * //ReferenceType// (restriction)
5431 ** //ChildObjectReferenceType// (restriction)
5432 *** StructureMapReferenceType
5433
5434 Content:
5435 ( (Ref, URN?) | URN)
5436
5437 Element Documentation:
5438
5439 |**Name**|**Type**|**Documentation**
5440 |Ref|StructureMapRefType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
5441 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5442 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5443
5444 **StructureMapRefType: **StructureMapRefType contains fields for referencing a structure map within a structure set.
5445
5446 Derivation:
5447 * //RefBaseType// (restriction)
5448 ** //ChildObjectRefBaseType// (restriction)
5449 *** StructureMapRefType
5450
5451 Attributes:
5452 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
5453
5454 Content:
5455 {Empty}
5456
5457 Attribute Documentation:
5458
5459 |**Name**|**Type**|**Documentation**
5460 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
5461 |maintainableParentID|IDType|The maintainableParentID attribute identifies the maintainable object in which the referenced object is defined, if applicable (maintainable-parent-object-id in the URN structure). This is only used in references where the referenced object is not itself maintainable.
5462 |maintainableParentVersion (default: 1.0)|VersionType|The maintainableParentVersion attribute identifies the version of the maintainable object in which the referenced object is defined (maintainable-parent-object-version in the URN structure). This is only used in references where the referenced object is not itself maintainable. This should only be used when the maintainableParentID is present. If this is available, a default of 1.0 will always apply.
5463 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
5464 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
5465 |class (fixed: StructureMap)|ObjectTypeCodelistTy pe|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
5466 |package (fixed: mapping)|PackageTypeCodelistT ype|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
5467
5468 **CategorySchemeMapReferenceType: **CategorySchemeMapReferenceType is a type for referencing a category scheme map object. It consists of a URN and/or a complete set of reference fields.
5469
5470 Derivation:
5471 * //ReferenceType// (restriction)
5472 ** //ChildObjectReferenceType// (restriction)
5473 *** CategorySchemeMapReferenceType
5474
5475 Content:
5476 ( (Ref, URN?) | URN)
5477
5478 Element Documentation:
5479
5480 |**Name**|**Type**|**Documentation**
5481 |Ref|CategorySchemeMapRef Type|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
5482 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5483 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5484
5485 **CategorySchemeMapRefType: **CategorySchemeMapRefType contains a set of reference fields for a category scheme map.
5486
5487 Derivation:
5488 * //RefBaseType// (restriction)
5489 ** //ChildObjectRefBaseType// (restriction)
5490 *** CategorySchemeMapRefType
5491
5492 Attributes:
5493 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
5494
5495 Content:
5496 {Empty}
5497
5498 Attribute Documentation:
5499
5500 |**Name**|**Type**|**Documentation**
5501 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
5502 |maintainableParentID|IDType|The maintainableParentID attribute identifies the maintainable object in which the referenced object is defined, if applicable (maintainable-parent-object-id in the URN structure). This is only used in references where the referenced object is not itself maintainable.
5503 |maintainableParentVersion (default: 1.0)|VersionType|The maintainableParentVersion attribute identifies the version of the maintainable object in which the referenced object is defined (maintainable-parent-object-version in the URN structure). This is only used in references where the referenced object is not itself maintainable. This should only be used when the maintainableParentID is present. If this is available, a default of 1.0 will always apply.
5504 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
5505 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
5506 |class (fixed: CategorySchemeMap)|ObjectTypeCodelistTy pe|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
5507 |package (fixed: mapping)|PackageTypeCodelistT ype|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
5508
5509 **CodelistMapReferenceType: **CodelistMapReferenceType is a type for referencing a codelist map object. It consists of a URN and/or a complete set of reference fields.
5510
5511 Derivation:
5512 * //ReferenceType// (restriction)
5513 ** //ChildObjectReferenceType// (restriction)
5514 *** CodelistMapReferenceType
5515
5516 Content:
5517 ( (Ref, URN?) | URN)
5518
5519 Element Documentation:
5520
5521 |**Name**|**Type**|**Documentation**
5522 |Ref|CodelistMapRefType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
5523 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5524 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5525
5526 **CodelistMapRefType: **CodelistMapRefType contains a set of reference fields for a codelist map.
5527
5528 Derivation:
5529 * //RefBaseType// (restriction)
5530 ** //ChildObjectRefBaseType// (restriction)
5531 *** CodelistMapRefType
5532
5533 Attributes:
5534 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
5535
5536 Content:
5537 {Empty}
5538
5539 Attribute Documentation:
5540
5541 |**Name**|**Type**|**Documentation**
5542 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
5543 |maintainableParentID|IDType|The maintainableParentID attribute identifies the maintainable object in which the referenced object is defined, if applicable (maintainable-parent-object-id in the URN structure). This is only used in references where the referenced object is not itself maintainable.
5544 |maintainableParentVersion (default: 1.0)|VersionType|The maintainableParentVersion attribute identifies the version of the maintainable object in which the referenced object is defined (maintainable-parent-object-version in the URN structure). This is only used in references where the referenced object is not itself maintainable. This should only be used when the maintainableParentID is present. If this is available, a default of 1.0 will always apply.
5545 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
5546 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
5547 |class (fixed: CodelistMap)|ObjectTypeCodelistTy pe|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
5548 |package (fixed: mapping)|PackageTypeCodelistT ype|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
5549
5550 **LocalCodelistMapReferenceType: **LocalCodelistMapReferenceType is a type for referencing a codelist map object where the reference to the structure set which defines it is provided in another context (e.g. the structure set in which this reference occurs).
5551
5552 Derivation:
5553 * //ReferenceType// (restriction)
5554 ** LocalCodelistMapReferenceType
5555
5556 Content:
5557 Ref
5558
5559 Element Documentation:
5560
5561 |**Name**|**Type**|**Documentation**
5562 |Ref|LocalCodelistMapRefT ype|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
5563
5564 **LocalCodelistMapRefType: **LocalCodelistMapRefType contains a set of reference fields for a codelist map locally.
5565
5566 Derivation:
5567 * //RefBaseType// (restriction)
5568 ** //LocalIdentifiableRefBaseType// (restriction)
5569 *** LocalCodelistMapRefType
5570
5571 Attributes:
5572 id, local?, class?, package?
5573
5574 Content:
5575 {Empty}
5576
5577 Attribute Documentation:
5578
5579 |**Name**|**Type**|**Documentation**
5580 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
5581 |local (fixed: true)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
5582 |class (fixed: CodelistMap)|ObjectTypeCodelistTy pe|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
5583 |package (fixed: mapping)|PackageTypeCodelistT ype|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
5584
5585 **ConceptSchemeMapReferenceType: **ConceptSchemeMapReferenceType is a type for referencing a concept scheme map object. It consists of a URN and/or a complete set of reference fields.
5586
5587 Derivation:
5588 * //ReferenceType// (restriction)
5589 ** //ChildObjectReferenceType// (restriction)
5590 *** ConceptSchemeMapReferenceType
5591
5592 Content:
5593 ( (Ref, URN?) | URN)
5594
5595 Element Documentation:
5596
5597 |**Name**|**Type**|**Documentation**
5598 |Ref|ConceptSchemeMapRefT ype|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
5599 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5600 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5601
5602 **ConceptSchemeMapRefType: **ConceptSchemeMapRefType contains a set of reference fields for a concept scheme map.
5603
5604 Derivation:
5605 * //RefBaseType// (restriction)
5606 ** //ChildObjectRefBaseType// (restriction)
5607 *** ConceptSchemeMapRefType
5608
5609 Attributes:
5610 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
5611
5612 Content:
5613 {Empty}
5614
5615 Attribute Documentation:
5616
5617 |**Name**|**Type**|**Documentation**
5618 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
5619 |maintainableParentID|IDType|The maintainableParentID attribute identifies the maintainable object in which the referenced object is defined, if applicable (maintainable-parent-object-id in the URN structure). This is only used in references where the referenced object is not itself maintainable.
5620 |maintainableParentVersion (default: 1.0)|VersionType|The maintainableParentVersion attribute identifies the version of the maintainable object in which the referenced object is defined (maintainable-parent-object-version in the URN structure). This is only used in references where the referenced object is not itself maintainable. This should only be used when the maintainableParentID is present. If this is available, a default of 1.0 will always apply.
5621 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
5622 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
5623 |class (fixed: ConceptSchemeMap)|ObjectTypeCodelistTy pe|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
5624 |package (fixed: mapping)|PackageTypeCodelistT ype|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
5625
5626 **OrganisationSchemeMapReferenceType: **OrganisationSchemeMapReferenceType is a type for referencing a organisation scheme map object. It consists of a URN and/or a complete set of reference fields.
5627
5628 Derivation:
5629 * //ReferenceType// (restriction)
5630 ** //ChildObjectReferenceType// (restriction)
5631 *** OrganisationSchemeMapReferenceType
5632
5633 Content:
5634 ( (Ref, URN?) | URN)
5635
5636 Element Documentation:
5637
5638 |**Name**|**Type**|**Documentation**
5639 |Ref|OrganisationSchemeMa pRefType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
5640 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5641 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5642
5643 **OrganisationSchemeMapRefType: **OrganisationSchemeMapRefType contains a set of reference fields for an organisation scheme map.
5644
5645 Derivation:
5646 * //RefBaseType// (restriction)
5647 ** //ChildObjectRefBaseType// (restriction)
5648 *** OrganisationSchemeMapRefType
5649
5650 Attributes:
5651 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
5652
5653 Content:
5654 {Empty}
5655
5656 Attribute Documentation:
5657
5658 |**Name**|**Type**|**Documentation**
5659 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
5660 |maintainableParentID|IDType|The maintainableParentID attribute identifies the maintainable object in which the referenced object is defined, if applicable (maintainable-parent-object-id in the URN structure). This is only used in references where the referenced object is not itself maintainable.
5661 |maintainableParentVersion (default: 1.0)|VersionType|The maintainableParentVersion attribute identifies the version of the maintainable object in which the referenced object is defined (maintainable-parent-object-version in the URN structure). This is only used in references where the referenced object is not itself maintainable. This should only be used when the maintainableParentID is present. If this is available, a default of 1.0 will always apply.
5662 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
5663 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
5664 |class (fixed: OrganisationSchemeMap)|ObjectTypeCodelistTy pe|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
5665 |package (fixed: mapping)|PackageTypeCodelistT ype|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
5666
5667 **VtlMappingSchemeReferenceType: **VtlMappingSchemeReferenceType is a type for referencing a VTL mapping scheme object. It consists of a URN and/or a complete set of reference fields.
5668
5669 Derivation:
5670 * //ReferenceType// (restriction)
5671 ** //MaintainableReferenceBaseType// (restriction)
5672 *** //ItemSchemeReferenceBaseType// (restriction)
5673 **** VtlMappingSchemeReferenceType
5674
5675 Content:
5676 ( (Ref, URN?) | URN)
5677
5678 Element Documentation:
5679
5680 |**Name**|**Type**|**Documentation**
5681 |Ref|VtlMappingSchemeRefT ype|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
5682 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5683 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5684
5685 **VtlMappingSchemeRefType: **VtlMappingSchemeRefType provides a reference to a VTL mapping scheme via a complete set of reference fields.
5686
5687 Derivation:
5688 * //RefBaseType// (restriction)
5689 ** //MaintainableRefBaseType// (restriction)
5690 *** //ItemSchemeRefBaseType// (restriction)
5691 **** VtlMappingSchemeRefType
5692
5693 Attributes:
5694 agencyID, id, version?, local?, class?, package?
5695
5696 Content:
5697 {Empty}
5698
5699 Attribute Documentation:
5700
5701 |**Name**|**Type**|**Documentation**
5702 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
5703 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
5704 |version (default: 1.0)|VersionType|The version attribute identifies the version of the object being reference, if applicable. If this is available, a default value of 1.0 will always apply.
5705 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
5706 |class (fixed: VtlMappingScheme)|ItemSchemeTypeCodeli stType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
5707 |package (fixed: transformation)|ItemSchemePackageTyp eCodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
5708
5709 **VtlMappingReferenceType: **VtlMappingReferenceType is a type for referencing a VTL mapping object. It consists of a URN and/or a complete set of reference fields.
5710
5711 Derivation:
5712 * //ReferenceType// (restriction)
5713 ** //ChildObjectReferenceType// (restriction)
5714 *** //ItemReferenceType// (restriction)
5715 **** VtlMappingReferenceType
5716
5717 Content:
5718 ( (Ref, URN?) | URN)
5719
5720 Element Documentation:
5721
5722 |**Name**|**Type**|**Documentation**
5723 |Ref|VtlMappingRefType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
5724 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5725 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5726
5727 **VtlMappingRefType: **VtlMappingRefType references a VTL mapping from within a VTL mapping scheme. Reference fields are required for both the scheme and the item.
5728
5729 Derivation:
5730 * //RefBaseType// (restriction)
5731 ** //ChildObjectRefBaseType// (restriction)
5732 *** //ItemRefBaseType// (restriction)
5733 **** VtlMappingRefType
5734
5735 Attributes:
5736 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
5737
5738 Content:
5739 {Empty}
5740
5741 Attribute Documentation:
5742
5743 |**Name**|**Type**|**Documentation**
5744 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
5745 |maintainableParentID|IDType|The maintainableParentID references the VTL mapping scheme in which the VTL mapping being referenced is defined.
5746 |maintainableParentVersion (default: 1.0)|VersionType|The maintainableParentVersion attribute references the version of the VTL mapping scheme in which the VTL mapping being referenced is defined. If not supplied, a default value of 1.0 is assumed.
5747 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
5748 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
5749 |class (fixed: VtlMapping)|ItemTypeCodelistType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
5750 |package (fixed: transformation)|ItemSchemePackageTyp eCodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
5751
5752 **LocalVtlMappingReferenceType: **LocalVtlMappingReferenceType provides a simple reference to a VTL mapping where the identification of the VTL mapping scheme which defines it is contained in another context.
5753
5754 Derivation:
5755 //ReferenceType// (restriction)
5756 [[image:inherit.gif||height="9" width="9"]] //LocalItemReferenceType// (restriction)
5757 [[image:inherit.gif||height="9" width="9"]] LocalVtlMappingReferenceType
5758
5759 Content:
5760 Ref
5761
5762 Element Documentation:
5763
5764 |**Name**|**Type**|**Documentation**
5765 |Ref|LocalVtlMappingRefTy pe|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
5766
5767 **LocalVtlMappingRefType: **LocalVtlMappingRefType references a VTL mapping locally where the references to the VTL mapping scheme which defines it is provided elsewhere.
5768
5769 Derivation:
5770 * //RefBaseType// (restriction)
5771 ** //LocalIdentifiableRefBaseType// (restriction)
5772 *** //LocalItemRefBaseType// (restriction)
5773 **** LocalVtlMappingRefType
5774
5775 Attributes:
5776 id, local?, class?, package?
5777
5778 Content:
5779 {Empty}
5780
5781 Attribute Documentation:
5782
5783 |**Name**|**Type**|**Documentation**
5784 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
5785 |local (fixed: true)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
5786 |class (fixed: VtlMapping)|ItemTypeCodelistType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
5787 |package (fixed: transformation)|ItemSchemePackageTyp eCodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
5788
5789 **NamePersonalisationSchemeReferenceType: **NamePersonalisationSchemeReferenceType is a type for referencing a name personalisation scheme object. It consists of a URN and/or a complete set of reference fields.
5790
5791 Derivation:
5792 * //ReferenceType// (restriction)
5793 ** //MaintainableReferenceBaseType// (restriction)
5794 *** //ItemSchemeReferenceBaseType// (restriction)
5795 **** NamePersonalisationSchemeReferenceType
5796
5797 Content:
5798 ( (Ref, URN?) | URN)
5799
5800 Element Documentation:
5801
5802 |**Name**|**Type**|**Documentation**
5803 |Ref|NamePersonalisationS chemeRefType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
5804 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5805 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5806
5807 **NamePersonalisationSchemeRefType: **NamePersonalisationSchemeRefType provides a reference to a name personalisation scheme via a complete set of reference fields.
5808
5809 Derivation:
5810 * //RefBaseType// (restriction)
5811 ** //MaintainableRefBaseType// (restriction)
5812 *** //ItemSchemeRefBaseType// (restriction)
5813 **** NamePersonalisationSchemeRefType
5814
5815 Attributes:
5816 agencyID, id, version?, local?, class?, package?
5817
5818 Content:
5819 {Empty}
5820
5821 Attribute Documentation:
5822
5823 |**Name**|**Type**|**Documentation**
5824 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
5825 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
5826 |version (default: 1.0)|VersionType|The version attribute identifies the version of the object being reference, if applicable. If this is available, a default value of 1.0 will always apply.
5827 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
5828 |class (fixed: NamePersonalisationScheme)|ItemSchemeTypeCodeli stType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
5829 |package (fixed: transformation)|ItemSchemePackageTyp eCodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
5830
5831 **NamePersonalisationReferenceType: **NamePersonalisationReferenceType is a type for referencing a name personalisation object. It consists of a URN and/or a complete set of reference fields.
5832
5833 Derivation:
5834 * //ReferenceType// (restriction)
5835 ** //ChildObjectReferenceType// (restriction)
5836 *** //ItemReferenceType// (restriction)
5837 **** NamePersonalisationReferenceType
5838
5839 Content:
5840 ( (Ref, URN?) | URN)
5841
5842 Element Documentation:
5843
5844 |**Name**|**Type**|**Documentation**
5845 |Ref|NamePersonalisationR efType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
5846 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5847 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5848
5849 **NamePersonalisationRefType: **NamePersonalisationRefType references a name personalisation from within a name personalisation scheme. Reference fields are required for both the scheme and the item.
5850
5851 Derivation:
5852 * //RefBaseType// (restriction)
5853 ** //ChildObjectRefBaseType// (restriction)
5854 *** //ItemRefBaseType// (restriction)
5855 **** NamePersonalisationRefType
5856
5857 Attributes:
5858 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
5859
5860 Content:
5861 {Empty}
5862
5863 Attribute Documentation:
5864
5865 |**Name**|**Type**|**Documentation**
5866 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
5867 |maintainableParentID|IDType|The maintainableParentID references the name personalisation scheme in which the name personalisation being referenced is defined.
5868 |maintainableParentVersion (default: 1.0)|VersionType|The maintainableParentVersion attribute references the version of the name personalisation scheme in which the name personalisation being referenced is defined. If not supplied, a default value of 1.0 is assumed.
5869 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
5870 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
5871 |class (fixed: NamePersonalisation)|ItemTypeCodelistType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
5872 |package (fixed: transformation)|ItemSchemePackageTyp eCodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
5873
5874 **LocalNamePersonalisationReferenceType: **LocalNamePersonalisationReferenceType provides a simple reference to a name personalisation where the identification of the name personalisation scheme which defines it is contained in another context.
5875
5876 Derivation:
5877 * //ReferenceType// (restriction)
5878 ** //LocalItemReferenceType// (restriction)
5879 *** LocalNamePersonalisationReferenceType
5880
5881 Content:
5882 Ref
5883
5884 Element Documentation:
5885
5886 |**Name**|**Type**|**Documentation**
5887 |Ref|LocalNamePersonalisa tionRefType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
5888
5889 **LocalNamePersonalisationRefType: **LocalNamePersonalisationRefType references a name personalisation locally where the references to the name personalisation scheme which defines it is provided elsewhere.
5890
5891 Derivation:
5892 * //RefBaseType// (restriction)
5893 ** //LocalIdentifiableRefBaseType// (restriction)
5894 *** //LocalItemRefBaseType// (restriction)
5895 **** LocalNamePersonalisationRefType
5896
5897 Attributes:
5898 id, local?, class?, package?
5899
5900 Content:
5901 {Empty}
5902
5903 Attribute Documentation:
5904
5905 |**Name**|**Type**|**Documentation**
5906 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
5907 |local (fixed: true)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
5908 |class (fixed: NamePersonalisation)|ItemTypeCodelistType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
5909 |package (fixed: transformation)|ItemSchemePackageTyp eCodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
5910
5911 **RulesetSchemeReferenceType: **RulesetSchemeReferenceType is a type for referencing a ruleset scheme object. It consists of a URN and/or a complete set of reference fields.
5912
5913 Derivation:
5914 * //ReferenceType// (restriction)
5915 ** //MaintainableReferenceBaseType// (restriction)
5916 *** //ItemSchemeReferenceBaseType// (restriction)
5917 **** RulesetSchemeReferenceType
5918
5919 Content:
5920 ( (Ref, URN?) | URN)
5921
5922 Element Documentation:
5923
5924 |**Name**|**Type**|**Documentation**
5925 |Ref|RulesetSchemeRefType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
5926 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5927 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5928
5929 **RulesetSchemeRefType: **RulesetSchemeRefType provides a reference to a ruleset scheme via a complete set of reference fields.
5930
5931 Derivation:
5932 * //RefBaseType// (restriction)
5933 ** //MaintainableRefBaseType// (restriction)
5934 *** //ItemSchemeRefBaseType// (restriction)
5935 **** RulesetSchemeRefType
5936
5937 Attributes:
5938 agencyID, id, version?, local?, class?, package?
5939
5940 Content:
5941 {Empty}
5942
5943 Attribute Documentation:
5944
5945 |**Name**|**Type**|**Documentation**
5946 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
5947 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
5948 |version (default: 1.0)|VersionType|The version attribute identifies the version of the object being reference, if applicable. If this is available, a default value of 1.0 will always apply.
5949 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
5950 |class (fixed: RulesetScheme)|ItemSchemeTypeCodeli stType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
5951 |package (fixed: transformation)|ItemSchemePackageTyp eCodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
5952
5953 **RulesetReferenceType: **RulesetReferenceType is a type for referencing a ruleset object. It consists of a URN and/or a complete set of reference fields.
5954
5955 Derivation:
5956 * //ReferenceType// (restriction)
5957 ** //ChildObjectReferenceType// (restriction)
5958 *** //ItemReferenceType// (restriction)
5959 **** RulesetReferenceType
5960
5961 Content:
5962 ( (Ref, URN?) | URN)
5963
5964 Element Documentation:
5965
5966 |**Name**|**Type**|**Documentation**
5967 |Ref|RulesetRefType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
5968 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5969 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5970
5971 **RulesetRefType: **RulesetRefType references a rule set from within an rule set scheme. Reference fields are required for both the scheme and the item.
5972
5973 Derivation:
5974 * //RefBaseType// (restriction)
5975 ** //ChildObjectRefBaseType// (restriction)
5976 *** //ItemRefBaseType// (restriction)
5977 **** RulesetRefType
5978
5979 Attributes:
5980 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
5981
5982 Content:
5983 {Empty}
5984
5985 Attribute Documentation:
5986
5987 |**Name**|**Type**|**Documentation**
5988 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
5989 |maintainableParentID|IDType|The maintainableParentID references the ruleset scheme in which the concept being referenced is defined.
5990 |maintainableParentVersion (default: 1.0)|VersionType|The maintainableParentVersion attribute references the version of the ruleset scheme in which the ruleset being referenced is defined. If not supplied, a default value of 1.0 is assumed.
5991 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
5992 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
5993 |class (fixed: Ruleset)|ItemTypeCodelistType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
5994 |package (fixed: transformation)|ItemSchemePackageTyp eCodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
5995
5996 **LocalRulesetReferenceType: **LocalRulesetReferenceType provides a simple reference to a ruleset where the identification of the ruleset scheme which defines it is contained in another context.
5997
5998 Derivation:
5999 * //ReferenceType// (restriction)
6000 ** //LocalItemReferenceType// (restriction)
6001 *** LocalRulesetReferenceType
6002
6003 Content:
6004 Ref
6005
6006 Element Documentation:
6007
6008 |**Name**|**Type**|**Documentation**
6009 |Ref|LocalRulesetRefType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
6010
6011 **LocalRulesetRefType: **LocalRulesetRefType references a ruleset locally where the references to the ruleset scheme which defines it is provided elsewhere.
6012
6013 Derivation:
6014 * //RefBaseType// (restriction)
6015 ** //LocalIdentifiableRefBaseType// (restriction)
6016 *** //LocalItemRefBaseType// (restriction)
6017 **** LocalRulesetRefType
6018
6019 Attributes:
6020 id, local?, class?, package?
6021
6022 Content:
6023 {Empty}
6024
6025 Attribute Documentation:
6026
6027 |**Name**|**Type**|**Documentation**
6028 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
6029 |local (fixed: true)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
6030 |class (fixed: Ruleset)|ItemTypeCodelistType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
6031 |package (fixed: transformation)|ItemSchemePackageTyp eCodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
6032
6033 **TransformationSchemeReferenceType: **TransformationSchemeReferenceType is a type for referencing a transformation scheme object. It consists of a URN and/or a complete set of reference fields.
6034
6035 Derivation:
6036 * //ReferenceType// (restriction)
6037 ** //MaintainableReferenceBaseType// (restriction)
6038 *** //ItemSchemeReferenceBaseType// (restriction)
6039 **** TransformationSchemeReferenceType
6040
6041 Content:
6042 ( (Ref, URN?) | URN)
6043
6044 Element Documentation:
6045
6046 |**Name**|**Type**|**Documentation**
6047 |Ref|TransformationScheme RefType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
6048 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
6049 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
6050
6051 **TransformationSchemeRefType: **TransformationSchemeRefType provides a reference to a transformation scheme via a complete set of reference fields.
6052
6053 Derivation:
6054 * //RefBaseType// (restriction)
6055 ** //MaintainableRefBaseType// (restriction)
6056 *** //ItemSchemeRefBaseType// (restriction)
6057 **** TransformationSchemeRefType
6058
6059 Attributes:
6060 agencyID, id, version?, local?, class?, package?
6061
6062 Content:
6063 {Empty}
6064
6065 Attribute Documentation:
6066
6067 |**Name**|**Type**|**Documentation**
6068 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
6069 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
6070 |version (default: 1.0)|VersionType|The version attribute identifies the version of the object being reference, if applicable. If this is available, a default value of 1.0 will always apply.
6071 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
6072 |class (fixed: TransformationScheme)|ItemSchemeTypeCodeli stType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
6073 |package (fixed: transformation)|ItemSchemePackageTyp eCodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
6074
6075 **TransformationReferenceType: **TransformationReferenceType is a type for referencing a transformation object. It consists of a URN and/or a complete set of reference fields.
6076
6077 Derivation:
6078 * //ReferenceType// (restriction)
6079 ** //ChildObjectReferenceType// (restriction)
6080 *** //ItemReferenceType// (restriction)
6081 **** TransformationReferenceType
6082
6083 Content:
6084 ( (Ref, URN?) | URN)
6085
6086 Element Documentation:
6087
6088 |**Name**|**Type**|**Documentation**
6089 |Ref|TransformationRefTyp e|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
6090 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
6091 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
6092
6093 **TransformationRefType: **TransformationRefType references a transformation from within a transformation scheme. Reference fields are required for both the scheme and the item.
6094
6095 Derivation:
6096 * //RefBaseType// (restriction)
6097 ** //ChildObjectRefBaseType// (restriction)
6098 *** //ItemRefBaseType// (restriction)
6099 **** TransformationRefType
6100
6101 Attributes:
6102 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
6103
6104 Content:
6105 {Empty}
6106
6107 Attribute Documentation:
6108
6109 |**Name**|**Type**|**Documentation**
6110 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
6111 |maintainableParentID|IDType|The maintainableParentID references the transformation scheme in which the transformation being referenced is defined.
6112 |maintainableParentVersion (default: 1.0)|VersionType|The maintainableParentVersion attribute references the version of the transformation scheme in which the transformation being referenced is defined. If not supplied, a default value of 1.0 is assumed.
6113 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
6114 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
6115 |class (fixed: Transformation)|ItemTypeCodelistType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
6116 |package (fixed: transformation)|ItemSchemePackageTyp eCodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
6117
6118 **LocalTransformationReferenceType: **LocalTransformationReferenceType provides a simple references to a transformation where the identification of the transformation scheme which defines it is contained in another context.
6119
6120 Derivation:
6121 //ReferenceType// (restriction)
6122 [[image:inherit.gif||height="9" width="9"]] //LocalItemReferenceType// (restriction)
6123 [[image:inherit.gif||height="9" width="9"]] LocalTransformationReferenceType
6124
6125 Content:
6126 Ref
6127
6128 Element Documentation:
6129
6130 |**Name**|**Type**|**Documentation**
6131 |Ref|LocalTransformationR efType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
6132
6133 **LocalTransformationRefType: **LocalTransformationRefType references a transformation locally where the references to the transformation scheme which defines it is provided elsewhere.
6134
6135 Derivation:
6136 * //RefBaseType// (restriction)
6137 ** //LocalIdentifiableRefBaseType// (restriction)
6138 *** //LocalItemRefBaseType// (restriction)
6139 **** LocalTransformationRefType
6140
6141 Attributes:
6142 id, local?, class?, package?
6143
6144 Content:
6145 {Empty}
6146
6147 Attribute Documentation:
6148
6149 |**Name**|**Type**|**Documentation**
6150 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
6151 |local (fixed: true)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
6152 |class (fixed: Transformation)|ItemTypeCodelistType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
6153 |package (fixed: transformation)|ItemSchemePackageTyp eCodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
6154
6155 **UserDefinedOperatorSchemeReferenceType: **UserDefinedOperatorSchemeReferenceType is a type for referencing a user defined operator scheme object. It consists of a URN and/or a complete set of reference fields.
6156
6157 Derivation:
6158 * //ReferenceType// (restriction)
6159 ** //MaintainableReferenceBaseType// (restriction)
6160 *** //ItemSchemeReferenceBaseType// (restriction)
6161 **** UserDefinedOperatorSchemeReferenceType
6162
6163 Content:
6164 ( (Ref, URN?) | URN)
6165
6166 Element Documentation:
6167
6168 |**Name**|**Type**|**Documentation**
6169 |Ref|UserDefinedOperatorS chemeRefType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
6170 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
6171 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
6172
6173 **UserDefinedOperatorSchemeRefType: **UserDefinedOperatorSchemeRefType provides a reference to a user defined operator scheme via a complete set of reference fields.
6174
6175 Derivation:
6176 * //RefBaseType// (restriction)
6177 ** //MaintainableRefBaseType// (restriction)
6178 *** //ItemSchemeRefBaseType// (restriction)
6179 **** UserDefinedOperatorSchemeRefType
6180
6181 Attributes:
6182 agencyID, id, version?, local?, class?, package?
6183
6184 Content:
6185 {Empty}
6186
6187 Attribute Documentation:
6188
6189 |**Name**|**Type**|**Documentation**
6190 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
6191 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
6192 |version (default: 1.0)|VersionType|The version attribute identifies the version of the object being reference, if applicable. If this is available, a default value of 1.0 will always apply.
6193 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
6194 |class (fixed: UserDefinedOperatorScheme)|ItemSchemeTypeCodeli stType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
6195 |package (fixed: transformation)|ItemSchemePackageTyp eCodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
6196
6197 **UserDefinedOperatorReferenceType: **UserDefinedOperatorReferenceType is a type for referencing a user defined operator object. It consists of a URN and/or a complete set of reference fields.
6198
6199 Derivation:
6200 * //ReferenceType// (restriction)
6201 ** //ChildObjectReferenceType// (restriction)
6202 *** //ItemReferenceType// (restriction)
6203 **** UserDefinedOperatorReferenceType
6204
6205 Content:
6206 ( (Ref, URN?) | URN)
6207
6208 Element Documentation:
6209
6210 |**Name**|**Type**|**Documentation**
6211 |Ref|UserDefinedOperatorR efType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
6212 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
6213 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
6214
6215 **UserDefinedOperatorRefType: **UserDefinedOperatorRefType references a user defined operator from within a user defined operator scheme. Reference fields are required for both the scheme and the item.
6216
6217 Derivation:
6218 * //RefBaseType// (restriction)
6219 ** //ChildObjectRefBaseType// (restriction)
6220 *** //ItemRefBaseType// (restriction)
6221 **** UserDefinedOperatorRefType
6222
6223 Attributes:
6224 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
6225
6226 Content:
6227 {Empty}
6228
6229 Attribute Documentation:
6230
6231 |**Name**|**Type**|**Documentation**
6232 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
6233 |maintainableParentID|IDType|The maintainableParentID references the user defined operator scheme in which the user defined operator being referenced is defined.
6234 |maintainableParentVersion (default: 1.0)|VersionType|The maintainableParentVersion attribute references the version of the user defined operator scheme in which the user defined operator being referenced is defined. If not supplied, a default value of 1.0 is assumed.
6235 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
6236 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
6237 |class (fixed: UserDefinedOperator)|ItemTypeCodelistType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
6238 |package (fixed: transformation)|ItemSchemePackageTyp eCodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
6239
6240 **LocalUserDefinedOperatorReferenceType: **LocalUserDefinedOperatorReferenceType provides a simple reference to a user operator where the identification of the user defined operator scheme which defines it is contained in another context.
6241
6242 Derivation:
6243 * //ReferenceType// (restriction)
6244 ** //LocalItemReferenceType// (restriction)
6245 *** LocalUserDefinedOperatorReferenceType
6246
6247 Content:
6248 Ref
6249
6250 Element Documentation:
6251
6252 |**Name**|**Type**|**Documentation**
6253 |Ref|LocalUserDefinedOper atorRefType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
6254
6255 **LocalUserDefinedOperatorRefType: **LocalUserDefinedOperatorRefType references a user defined operator locally where the references to the user defined operator scheme which defines it is provided elsewhere.
6256
6257 Derivation:
6258 * //RefBaseType// (restriction)
6259 ** //LocalIdentifiableRefBaseType// (restriction)
6260 *** //LocalItemRefBaseType// (restriction)
6261 **** LocalUserDefinedOperatorRefType
6262
6263 Attributes:
6264 id, local?, class?, package?
6265
6266 Content:
6267 {Empty}
6268
6269 Attribute Documentation:
6270
6271 |**Name**|**Type**|**Documentation**
6272 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
6273 |local (fixed: true)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
6274 |class (fixed: UserDefinedOperator)|ItemTypeCodelistType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
6275 |package (fixed: transformation)|ItemSchemePackageTyp eCodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
6276
6277 **CustomTypeSchemeReferenceType: **CustomTypeSchemeReferenceType is a type for referencing a custom type scheme object. It consists of a URN and/or a complete set of reference fields.
6278
6279 Derivation:
6280 * //ReferenceType// (restriction)
6281 ** //MaintainableReferenceBaseType// (restriction)
6282 *** //ItemSchemeReferenceBaseType// (restriction)
6283 **** CustomTypeSchemeReferenceType
6284
6285 Content:
6286 ( (Ref, URN?) | URN)
6287
6288 Element Documentation:
6289
6290 |**Name**|**Type**|**Documentation**
6291 |Ref|CustomTypeSchemeRefT ype|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
6292 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
6293 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
6294
6295 **CustomTypeSchemeRefType: **CustomTypeSchemeRefType provides a reference to a custom type scheme via a complete set of reference fields.
6296
6297 Derivation:
6298 * //RefBaseType// (restriction)
6299 ** //MaintainableRefBaseType// (restriction)
6300 *** //ItemSchemeRefBaseType// (restriction)
6301 **** CustomTypeSchemeRefType
6302
6303 Attributes:
6304 agencyID, id, version?, local?, class?, package?
6305
6306 Content:
6307 {Empty}
6308
6309 Attribute Documentation:
6310
6311 |**Name**|**Type**|**Documentation**
6312 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
6313 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
6314 |version (default: 1.0)|VersionType|The version attribute identifies the version of the object being reference, if applicable. If this is available, a default value of 1.0 will always apply.
6315 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
6316 |class (fixed: CustomTypeScheme)|ItemSchemeTypeCodeli stType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
6317 |package (fixed: transformation)|ItemSchemePackageTyp eCodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
6318
6319 **CustomTypeReferenceType: **CustomTypeReferenceType is a type for referencing a custom type object. It consists of a URN and/or a complete set of reference fields.
6320
6321 Derivation:
6322 * //ReferenceType// (restriction)
6323 ** //ChildObjectReferenceType// (restriction)
6324 *** //ItemReferenceType// (restriction)
6325 **** CustomTypeReferenceType
6326
6327 Content:
6328 ( (Ref, URN?) | URN)
6329
6330 Element Documentation:
6331
6332 |**Name**|**Type**|**Documentation**
6333 |Ref|CustomTypeRefType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
6334 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
6335 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
6336
6337 **CustomTypeRefType: **CustomTypeRefType references a custom type from within a user defined custom type scheme. Reference fields are required for both the scheme and the item.
6338
6339 Derivation:
6340 * //RefBaseType// (restriction)
6341 ** //ChildObjectRefBaseType// (restriction)
6342 *** //ItemRefBaseType// (restriction)
6343 **** CustomTypeRefType
6344
6345 Attributes:
6346 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
6347
6348 Content:
6349 {Empty}
6350
6351 Attribute Documentation:
6352
6353 |**Name**|**Type**|**Documentation**
6354 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
6355 |maintainableParentID|IDType|The maintainableParentID references the custom mask scheme in which the custom type being referenced is defined.
6356 |maintainableParentVersion (default: 1.0)|VersionType|The maintainableParentVersion attribute references the version of the custom type scheme in which the custom type being referenced is defined. If not supplied, a default value of 1.0 is assumed.
6357 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
6358 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
6359 |class (fixed: CustomType)|ItemTypeCodelistType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
6360 |package (fixed: transformation)|ItemSchemePackageTyp eCodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
6361
6362 **LocalCustomTypeReferenceType: **LocalCustomTypeReferenceType provides a simple reference to a custom type where the identification of the custom type scheme which defines it is contained in another context.
6363
6364 Derivation:
6365 //ReferenceType// (restriction)
6366 //LocalItemReferenceType// (restriction)
6367 LocalCustomTypeReferenceType
6368
6369 Content:
6370 Ref
6371
6372 Element Documentation:
6373
6374 |**Name**|**Type**|**Documentation**
6375 |Ref|LocalCustomTypeRefTy pe|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
6376
6377 **LocalCustomTypeRefType: **LocalCustomTypeRefType references a custom type locally where the references to the custom type scheme which defines it is provided elsewhere.
6378
6379 Derivation:
6380 * //RefBaseType// (restriction)
6381 ** //LocalIdentifiableRefBaseType// (restriction)
6382 *** //LocalItemRefBaseType// (restriction)
6383 **** LocalCustomTypeRefType
6384
6385 Attributes:
6386 id, local?, class?, package?
6387
6388 Content:
6389 {Empty}
6390
6391 Attribute Documentation:
6392
6393 |**Name**|**Type**|**Documentation**
6394 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
6395 |local (fixed: true)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
6396 |class (fixed: CustomType)|ItemTypeCodelistType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
6397 |package (fixed: transformation)|ItemSchemePackageTyp eCodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
6398
6399 **SetReferenceType: **SetReferenceType defines the structure of a reference to a data/metadata set. A full reference to a data provider and the identifier for the data set must be provided. Note that this is not derived from the base reference structure since data/metadata sets are not technically identifiable.
6400
6401 Content:
6402 DataProvider, ID
6403
6404 Element Documentation:
6405
6406 |**Name**|**Type**|**Documentation**
6407 |DataProvider|DataProviderReferenc eType|DataProvider references a the provider of the data/metadata set. A URN and/or a complete set of reference fields must be provided.
6408 |ID|IDType|ID contains the identifier of the data/metadata set being referenced.
6409
6410 **ObjectTypeListType: **ObjectTypeListType provides a means for enumerating object types.
6411
6412 Content:
6413 (Any?, Agency?, AgencyScheme?, AttachmentConstraint?, Attribute?, AttributeDescriptor?, Categorisation?, Category?, CategorySchemeMap?, CategoryScheme?, Code?, CodeMap?, Codelist?, CodelistMap?, ComponentMap?, Concept?, ConceptMap?, ConceptScheme?, ConceptSchemeMap?, ContentConstraint?, CustomType?, CustomTypeScheme?, Dataflow?, DataConsumer?, DataConsumerScheme?, DataProvider?, DataProviderScheme?, DataSetTarget?, DataStructure?, Dimension?, DimensionDescriptor?, DimensionDescriptorValuesTarget?, GroupDimensionDescriptor?, HierarchicalCode?, HierarchicalCodelist?, Hierarchy?, HybridCodelistMap?, HybridCodeMap?, IdentifiableObjectTarget?, Level?, MeasureDescriptor?, MeasureDimension?, Metadataflow?, MetadataAttribute?, MetadataSet?, MetadataStructure?, MetadataTarget?, NamePersonalisation?, NamePersonalisationScheme?, OrganisationMap?, OrganisationSchemeMap?, OrganisationUnit?, OrganisationUnitScheme?, PrimaryMeasure?, Process?, ProcessStep?, ProvisionAgreement?, ReportingCategory?, ReportingCategoryMap?, ReportingTaxonomy?, ReportingTaxonomyMap?, ReportPeriodTarget?, ReportStructure?, Ruleset?, RulesetScheme?, StructureMap?, StructureSet?, TimeDimension?, Transformation?, TransformationScheme?, Transition?, UserDefinedOperator?, UserDefinedOperatorScheme?, VtlMapping?, VtlMappingScheme?)
6414
6415 Element Documentation:
6416
6417 |**Name**|**Type**|**Documentation**
6418 |Any|EmptyType|Any is an empty element that denotes an object of any type.
6419 |Agency|EmptyType|Agency is an empty element that denotes an agency object.
6420 |AgencyScheme|EmptyType|AgencyScheme is an empty element that denotes an agency scheme object.
6421 |AttachmentConstraint|EmptyType|AttachmentConstraint is an empty element that denotes an attachment constraint object.
6422 |Attribute|EmptyType|Attribute is an empty element that denotes an attribute object.
6423 |AttributeDescriptor|EmptyType|AttributeDescriptor is an empty element that denotes an attribute descriptor object.
6424 |Categorisation|EmptyType|Categorisation is an empty element that denotes a categorisation object.
6425 |Category|EmptyType|Category is an empty element that denotes a category object.
6426 |CategorySchemeMap|EmptyType|CategorySchemeMap is an empty element that denotes a category scheme map object.
6427 |CategoryScheme|EmptyType|CategoryScheme is an empty element that denotes a category scheme object.
6428 |Code|EmptyType|Code is an empty element that denotes a code object.
6429 |CodeMap|EmptyType|CodeMap is an empty element that denotes a code map object.
6430 |Codelist|EmptyType|Codelist is an empty element that denotes a code list object.
6431 |CodelistMap|EmptyType|CodelistMap is an empty element that denotes a code list map object.
6432 |ComponentMap|EmptyType|ComponentMap is an empty element that denotes a component map object.
6433 |Concept|EmptyType|Concept is an empty element that denotes a concept object.
6434 |ConceptMap|EmptyType|ConceptMap is an empty element that denotes a concept map object.
6435 |ConceptScheme|EmptyType|ConceptScheme is an empty element that denotes a concept scheme object.
6436 |ConceptSchemeMap|EmptyType|ConceptSchemeMap is an empty element that denotes a concept scheme map object.
6437 |ContentConstraint|EmptyType|ContentConstraint is an empty element that denotes a content constraint object.
6438 |CustomType|EmptyType|CustomType is an empty element that denotes a custom type object.
6439 |CustomTypeScheme|EmptyType|CustomTypeScheme is an empty element that denotes a custom type scheme object.
6440 |Dataflow|EmptyType|Dataflow is an empty element that denotes a data flow object.
6441 |DataConsumer|EmptyType|DataConsumer is an empty element that denotes a data consumer object.
6442 |DataConsumerScheme|EmptyType|DataConsumerScheme is an empty element that denotes a data consumer scheme object.
6443 |DataProvider|EmptyType|DataProvider is an empty element that denotes a data provider object.
6444 |DataProviderScheme|EmptyType|DataProviderScheme is an empty element that denotes a data provider scheme object.
6445 |DataSetTarget|EmptyType|DataSetTarget is an empty element that denotes a data set target object.
6446 |DataStructure|EmptyType|DataStructure is an empty element that denotes a data structure definition object.
6447 |Dimension|EmptyType|Dimension is an empty element that denotes a dimension object.
6448 |DimensionDescriptor|EmptyType|DimensionDescriptor is an empty element that denotes a dimension descriptor object.
6449 |DimensionDescriptorV aluesTarget|EmptyType|DimensionDescriptorValuesTarget is an empty element that denotes a dimension descriptor values target object.
6450 |GroupDimensionDescri ptor|EmptyType|GroupDimensionDescriptor is an empty element that denotes a group dimension descriptor object.
6451 |HierarchicalCode|EmptyType|HierarchicalCode is an empty element that denotes a hierarchical code object.
6452 |HierarchicalCodelist|EmptyType|HierarchicalCodelist is an empty element that denotes a hierarchical codelist object.
6453 |Hierarchy|EmptyType|Hierarchy is an empty element that denotes a hierarchy within a hiearcharchical codelist.
6454 |HybridCodelistMap|EmptyType|HybridCodelistMap is an empty element that denotes a hybrid codelist map object.
6455 |HybridCodeMap|EmptyType|HybridCodeMap is an empty element that denotes a hybrid code map object.
6456 |IdentifiableObjectTa rget|EmptyType|IdentifiableObjectTarget is an empty element that denotes an identifiable object target object.
6457 |Level|EmptyType|Level is an empty element that denotes a level object.
6458 |MeasureDescriptor|EmptyType|MeasureDescriptor is an empty element that denotes a measure descriptor object.
6459 |MeasureDimension|EmptyType|MeasureDimension is an empty element that denotes a measure dimension object.
6460 |Metadataflow|EmptyType|Metadataflow is an empty element that denotes a metadata flow object.
6461 |MetadataAttribute|EmptyType|MetadataAttribute is an empty element that denotes a metadata attribute object.
6462 |MetadataSet|EmptyType|MetadataSet is an empty element that denotes a metadata set object.
6463 |MetadataStructure|EmptyType|MetadataStructure is an empty element that denotes a metadata structure definition object.
6464 |MetadataTarget|EmptyType|MetadataTarget is an empty element that denotes a metadata target object.
6465 |NamePersonalisation|EmptyType|NamePersonalisation is an empty element that denotes a name personalisation object.
6466 |NamePersonalisationS cheme|EmptyType|NamePersonalisationScheme is an empty element that denotes a name personalisation scheme object.
6467 |OrganisationMap|EmptyType|OrganisationMap is an empty element that denotes an organisation map object.
6468 |OrganisationSchemeMa p|EmptyType|OrganisationSchemeMap is an empty element that denotes an organisation scheme map object.
6469 |OrganisationUnit|EmptyType|OrganisationUnit is an empty element that denotes an organisation unit object.
6470 |OrganisationUnitSche me|EmptyType|OrganisationUnitScheme is an empty element that denotes an organisation unit scheme object.
6471 |PrimaryMeasure|EmptyType|PrimaryMeasure is an empty element that denotes a primary measure object.
6472 |Process|EmptyType|Process is an empty element that denotes a process object.
6473 |ProcessStep|EmptyType|ProcessStep is an empty element that denotes a process step object.
6474 |ProvisionAgreement|EmptyType|ProvisionAgreement is an empty element that denotes a provision agreement object.
6475 |ReportingCategory|EmptyType|ReportingCategory is an empty element that denotes a reporting category object.
6476 |ReportingCategoryMap|EmptyType|ReportingCategoryMap is an empty element that denotes a reporting category map object.
6477 |ReportingTaxonomy|EmptyType|ReportingTaxonomy is an empty element that denotes a reporting taxonomy object.
6478 |ReportingTaxonomyMap|EmptyType|ReportingTaxonomyMap is an empty element that denotes a reporting taxonomy map object.
6479 |ReportPeriodTarget|EmptyType|ReportPeriodTarget is an empty element that denotes a report period target object.
6480 |ReportStructure|EmptyType|ReportStructure is an empty element that denotes a report structure object.
6481 |Ruleset|EmptyType|Ruleset is an empty element that denotes a ruleset object.
6482 |RulesetScheme|EmptyType|RulesetScheme is an empty element that denotes a ruleset scheme object.
6483 |StructureMap|EmptyType|StructureMap is an empty element that denotes a structure map object.
6484 |StructureSet|EmptyType|StructureSet is an empty element that denotes a structure set object.
6485 |TimeDimension|EmptyType|TimeDimension is an empty element that denotes a time dimension object.
6486 |Transformation|EmptyType|Transformation is an empty element that denotes a transformation object.
6487 |TransformationScheme|EmptyType|TransformationScheme is an empty element that denotes a transformation scheme object.
6488 |Transition|EmptyType|Transition is an empty element that denotes a transition object.
6489 |UserDefinedOperator|EmptyType|UserDefinedOperator is an empty element that denotes an user defined operator object.
6490 |UserDefinedOperatorS cheme|EmptyType|UserDefinedOperatorScheme is an empty element that denotes an user defined operator scheme object.
6491 |VtlMapping|EmptyType|VtlMapping is an empty element that denotes a VTL Mapping object.
6492 |VtlMappingScheme|EmptyType|VtlMappingScheme is an empty element that denotes a VTL mapping scheme object.
6493
6494 **MaintainableObjectTypeListType: **MaintainableObjectTypeListType provides a means for enumerating maintainable object types.
6495
6496 Derivation:
6497 * ObjectTypeListType (restriction)
6498 ** MaintainableObjectTypeListType
6499
6500 Content:
6501 (AgencyScheme?, AttachmentConstraint?, Categorisation?, CategoryScheme?, Codelist?, ConceptScheme?, ContentConstraint?, Dataflow?, DataConsumerScheme?, DataProviderScheme?, DataStructure?, HierarchicalCodelist?, Metadataflow?, MetadataStructure?, NamePersonalisationScheme?, OrganisationUnitScheme?, Process?, ProvisionAgreement?, ReportingTaxonomy?, RulesetScheme?, StructureSet?, TransformationScheme?, UserDefinedOperatorScheme?, VtlMappingScheme?)
6502
6503 Element Documentation:
6504
6505 |**Name**|**Type**|**Documentation**
6506 |AgencyScheme|EmptyType|AgencyScheme is an empty element that denotes an agency scheme object.
6507 |AttachmentConstraint|EmptyType|AttachmentConstraint is an empty element that denotes an attachment constraint object.
6508 |Categorisation|EmptyType|Categorisation is an empty element that denotes a categorisation object.
6509 |CategoryScheme|EmptyType|CategoryScheme is an empty element that denotes a category scheme object.
6510 |Codelist|EmptyType|Codelist is an empty element that denotes a code list object.
6511 |ConceptScheme|EmptyType|ConceptScheme is an empty element that denotes a concept scheme object.
6512 |ContentConstraint|EmptyType|ContentConstraint is an empty element that denotes a content constraint object.
6513 |Dataflow|EmptyType|Dataflow is an empty element that denotes a data flow object.
6514 |DataConsumerScheme|EmptyType|DataConsumerScheme is an empty element that denotes a data consumer scheme object.
6515 |DataProviderScheme|EmptyType|DataProviderScheme is an empty element that denotes a data provider scheme object.
6516 |DataStructure|EmptyType|DataStructure is an empty element that denotes a data structure definition object.
6517 |HierarchicalCodelist|EmptyType|HierarchicalCodelist is an empty element that denotes a hierarchical codelist object.
6518 |Metadataflow|EmptyType|Metadataflow is an empty element that denotes a metadata flow object.
6519 |MetadataStructure|EmptyType|MetadataStructure is an empty element that denotes a metadata structure definition object.
6520 |NamePersonalisationS cheme|EmptyType|NamePersonalisationScheme is an empty element that denotes a name personalisation scheme object.
6521 |OrganisationUnitSche me|EmptyType|OrganisationUnitScheme is an empty element that denotes an organisation unit scheme object.
6522 |Process|EmptyType|Process is an empty element that denotes a process object.
6523 |ProvisionAgreement|EmptyType|ProvisionAgreement is an empty element that denotes a provision agreement object.
6524 |ReportingTaxonomy|EmptyType|ReportingTaxonomy is an empty element that denotes a reporting taxonomy object.
6525 |RulesetScheme|EmptyType|RulesetScheme is an empty element that denotes a ruleset scheme object.
6526 |StructureSet|EmptyType|StructureSet is an empty element that denotes a structure set object.
6527 |TransformationScheme|EmptyType|TransformationScheme is an empty element that denotes a transformation scheme object.
6528 |UserDefinedOperatorS cheme|EmptyType|UserDefinedOperatorScheme is an empty element that denotes an user defined operator scheme object.
6529 |VtlMappingScheme|EmptyType|VtlMappingScheme is an empty element that denotes a VTL mapping scheme object.
6530
6531 === 2.1.4Simple Types ===
6532
6533 **AlphaNumericType: **AlphaNumericType is a reusable simple type that allows for only mixed-case alphabetical and numeric characters.
6534
6535 Derived by restriction of xs:string .
6536 Regular Expression Pattern: [A-Za-z0-9]+
6537
6538 **AlphaType: **AlphaType is a reusable simple type that allows for only mixed-case alphabetical characters. This is derived from the AlphaNumericType.
6539
6540 Derived by restriction of AlphaNumericType .
6541 Regular Expression Pattern: [A-Za-z]+
6542
6543 **NumericType: **NumericType is a reusable simple type that allows for only numeric characters. This is not to be confused with an integer, as this may be used to numeric strings which have leading zeros. These leading zeros are not ignored. This is derived from the AlphaNumericType.
6544
6545 Derived by restriction of AlphaNumericType .
6546 Regular Expression Pattern: [0-9]+
6547
6548 **ObservationalTimePeriodType: **ObservationalTimePeriodType specifies a distinct time period or point in time in SDMX. The time period can either be a Gregorian calendar period, a standard reporting period, a distinct point in time, or a time range with a specific date and duration.
6549
6550 Union of:
6551 xs:gYear, xs:gYearMonth, xs:date, xs:dateTime, ReportingYearType, ReportingSemesterType, ReportingTrimesterType, ReportingQuarterType, ReportingMonthType, ReportingWeekType, ReportingDayType, TimeRangeType.
6552
6553 **StandardTimePeriodType: **StandardTimePeriodType defines the set of standard time periods in SDMX. This includes the reporting time periods and the basic date type (i.e. the calendar time periods and the dateTime format).
6554
6555 Union of:
6556 xs:gYear, xs:gYearMonth, xs:date, xs:dateTime, ReportingYearType, ReportingSemesterType, ReportingTrimesterType, ReportingQuarterType, ReportingMonthType, ReportingWeekType, ReportingDayType.
6557
6558 **BasicTimePeriodType: **BasicTimePeriodType contains the basic dates and calendar periods. It is a combination of the Gregorian time periods and the date time type..
6559
6560 Union of:
6561 xs:gYear, xs:gYearMonth, xs:date, xs:dateTime.
6562
6563 **GregorianTimePeriodType: **GregorianTimePeriodType defines the set of standard calendar periods in SDMX.
6564
6565 Union of:
6566 xs:gYear, xs:gYearMonth, xs:date.
6567
6568 **ReportingTimePeriodType: **ReportingTimePeriodType defines standard reporting periods in SDMX, which are all in relation to the start day (day-month) of a reporting year which is specified in the specialized reporting year start day attribute. If the reporting year start day is not defined, a day of January 1 is assumed. The reporting year must be epxressed as the year at the beginning of the period. Therfore, if the reproting year runs from April to March, any given reporting year is expressed as the year for April. The general format of a report period can be described as [year]-[period][time zone]?, where the type of period is designated with a single character followed by a number representing the period. Note that all periods allow for an optional time zone offset. See the details of each member type for the specifics of its format.
6569
6570 Union of:
6571 ReportingYearType, ReportingSemesterType, ReportingTrimesterType, ReportingQuarterType, ReportingMonthType, ReportingWeekType, ReportingDayType.
6572
6573 **BaseReportPeriodType: **BaseReportPeriodType is a simple type which frames the general pattern of a reporting period for validation purposes. This regular expression is only a general validation which is meant to validate the following structure [year]-[period][time zone]?. This type is meant to be derived from for further validation.
6574
6575 Derived by restriction of xs:string .
6576 Regular Expression Pattern: \d{4}\-([ASTQ]\d{1}|[MW]\d{2}|[D]\d{3})(Z|((\+|\-)\d{2}:\d{2}))?
6577
6578 **ReportPeriodValidTimeZoneType: **ReportPeriodValidTimeZoneType is a derivation of the BaseReportPeriodType which validates that the time zone provided in the base type is valid. The base type will have provided basic validation already. The patterns below validate that the time zone is "Z" or that it is between -14:00 and +14:00, or that there is no time zone provided. This type is meant to be derived from for further validation.
6579
6580 Derived by restriction of BaseReportPeriodType .
6581 Regular Expression Pattern: .+Z.{5}.*(\+|\-)(14:00|((0[0-9]|1[0-3]):[0-5][0-9])).{5}[^\+\-Z]+
6582
6583 **ReportingYearType: **ReportingYearType defines a time period of 1 year (P1Y) in relation to a reporting year which has a start day (day-month) specified in the specialized reporting year start day attribute. In the absence of a start day for the reporting year, a day of January 1 is assumed. In this case a reporting year will coincide with a calendar year. The format of a reporting year is YYYY-A1 (e.g. 2000-A1). Note that the period value of 1 is fixed.
6584
6585 Derived by restriction of ReportPeriodValidTimeZoneType .
6586 Regular Expression Pattern: .{5}A1.*
6587
6588 **ReportingSemesterType: **ReportingSemesterType defines a time period of 6 months (P6M) in relation to a reporting year which has a start day (day-month) specified in the specialized reporting year start day attribute. In the absence of a start day for the reporting year, a day of January 1 is assumed. The format of a reporting semester is YYYY-Ss (e.g. 2000-S1), where s is either 1 or 2.
6589
6590 Derived by restriction of ReportPeriodValidTimeZoneType .
6591 Regular Expression Pattern: .{5}S[1-2].*
6592
6593 **ReportingTrimesterType: **ReportingTrimesterType defines a time period of 4 months (P4M) in relation to a reporting year which has a start day (day-month) specified in the specialized reporting year start day attribute. In the absence of a start day for the reporting year, a day of January 1 is assumed. The format of a reporting trimester is YYYY-Tt (e.g. 2000-T1), where s is either 1, 2, or 3.
6594
6595 Derived by restriction of ReportPeriodValidTimeZoneType .
6596 Regular Expression Pattern: .{5}T[1-3].*
6597
6598 **ReportingQuarterType: **ReportingQuarterType defines a time period of 3 months (P3M) in relation to a reporting year which has a start day (day-month) specified in the specialized reporting year start day attribute. In the absence of a start day for the reporting year, a day of January 1 is assumed. The format of a reporting quarter is YYYY-Qq (e.g. 2000-Q1), where q is a value between 1 and 4.
6599
6600 Derived by restriction of ReportPeriodValidTimeZoneType .
6601 Regular Expression Pattern: .{5}Q[1-4].*
6602
6603 **ReportingMonthType: **ReportingMonthType defines a time period of 1 month (P1M) in relation to a reporting year which has a start day (day-month) specified in the specialized reporting year start day attribute. In the absence of a start day for the reporting year, a day of January 1 is assumed. In this case a reporting month will coincide with a calendar month. The format of a reporting month is YYYY-Mmm (e.g. 2000-M01), where mm is a two digit month (i.e. 01-12).
6604
6605 Derived by restriction of ReportPeriodValidTimeZoneType .
6606 Regular Expression Pattern: .{5}M(0[1-9]|1[0-2]).*
6607
6608 **ReportingWeekType: **ReportingWeekType defines a time period of 7 days (P7D) in relation to a reporting year which has a start day (day-month) specified in the specialized reporting year start day attribute. A standard reporting week is based on the ISO 8601 defintion of a week date, in relation to the reporting period start day. The first week is defined as the week with the first Thursday on or after the reporting year start day. An equivalent definition is the week starting with the Monday nearest in time to the reporting year start day. There are other equivalent defintions, all of which should be adjusted based on the reporting year start day. In the absence of a start day for the reporting year, a day of January 1 is assumed. The format of a reporting week is YYYY-Www (e.g. 2000-W01), where mm is a two digit week (i.e. 01-53).
6609
6610 Derived by restriction of ReportPeriodValidTimeZoneType .
6611 Regular Expression Pattern: .{5}W(0[1-9]|[1-4][0-9]|5[0-3]).*
6612
6613 **ReportingDayType: **ReportingDayType defines a time period of 1 day (P1D) in relation to a reporting year which has a start day (day-month) specified in the specialized reporting year start day attribute. In the absence of a start day for the reporting year, a day of January 1 is assumed. The format of a reporting day is YYYY-Dddd (e.g. 2000-D001), where ddd is a three digit day (i.e. 001-366).
6614
6615 Derived by restriction of ReportPeriodValidTimeZoneType .
6616 Regular Expression Pattern: .{5}D(0[0-9][1-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-6]).*
6617
6618 **BaseTimeRangeType: **BaseTimeRangeType is a simple type which frames the general pattern for a time range in SDMX. A time range pattern is generally described as [xs:date or xs:dateTime]\[xs:duration], where the referenced types are defined by XML Schema. This type is meant to be derived from for further validation.
6619
6620 Derived by restriction of xs:string .
6621 Regular Expression Pattern: \d{4}\-\d{2}\-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?)?(Z|((\+|\-)\d{2}:\d{2}))?/P.+
6622
6623 **RangeValidMonthDayType: **RangeValidMonthDayType is a derivation of the BaseTimeRangeType which validates that the day provided is valid for the month, without regard to leap years. The base type will have provided basic validation already. The patterns below validate that there are up to 29 days in February, up to 30 days in April, June, September, and November and up to 31 days in January, March, May, July, August, October, and December. This type is meant to be derived from for further validation.
6624
6625 Derived by restriction of BaseTimeRangeType .
6626 Regular Expression Pattern: .{5}02\-(0[1-9]|[1-2][0-9]).+.{5}(04|06|09|11)\-(0[1-9]|[1-2][0-9]|30).+.{5}(01|03|05|07|08|10|12)\-(0[1-9]|[1-2][0-9]|3[0-1]).+
6627
6628 **RangeValidLeapYearType: **RangeValidLeapYearType is a derivation of the RangeValidMonthDayType which validates that a date of February 29 occurs in a valid leap year (i.e. if the year is divisible 4 and not by 100, unless it is also divisible by 400). This type is meant to be derived from for further validation.
6629
6630 Derived by restriction of RangeValidMonthDayType .
6631 Regular Expression Pattern: ((\d{2}(04|08|12|16|20|24|28|32|36|40|44|48|52|56|60|64|68|72|76|80|84|88|92|96))|((00|04|08|12|16|20|24|28|32|36|40|44|48|52|56|60|64|68|72|76|80|84|88|92|96)00))\-02\-29.+.{5}02\-(([0-1][0-9])|(2[^9])).+.{5}((0[1,3-9])|1[0-2]).+
6632
6633 **RangeValidTimeType: **RangeValidTimeType is a derivation of the RangeValidLeapYearType which validates that the time (if provided) is validly formatted. The base type will have provided basic validation already. The patterns below validate that the time falls between 00:00:00 and 24:00:00. Note that as the XML dateTime type does, seconds are required. It is also permissible to have fractions of seconds, but only within the boundaries of the range specified. This type is meant to be derived from for further validation.
6634
6635 Derived by restriction of RangeValidLeapYearType .
6636 Regular Expression Pattern: .{10}T(24:00:00(\.[0]+)?|~(~(~([0-1][0-9])|(2[0-3])):[0-5][0-9]:[0-5][0-9](\.\d+)?))(/|Z|\+|\-).+[^T]+/.+
6637
6638 **RangeValidTimeZoneType: **RangeValidMonthDayType is a derivation of the RangeValidTimeType which validates that the time zone provided in the base type is valid. The base type will have provided basic validation already. The patterns below validate that the time zone is "Z" or that it is between -14:00 and +14:00, or that there is no time zone provided. This type is meant to be derived from for further validation.
6639
6640 Derived by restriction of RangeValidTimeType .
6641 Regular Expression Pattern: .+Z/.+.{10}.*(\+|\-)(14:00|((0[0-9]|1[0-3]):[0-5][0-9]))/.+.{10}[^\+\-Z]+
6642
6643 **TimeRangeValidDateDurationType: **TimeRangeValidDateDurationType is an abstract derivation of the RangeValidTimeType which validates that duration provided is generally valid, up to the time component.
6644
6645 Derived by restriction of RangeValidTimeZoneType .
6646 Regular Expression Pattern: .+/P(\d+Y)?(\d+M)?(\d+D)?(T.+)?
6647
6648 **TimeRangeType: **TimeRangeType defines the structure of a time range in SDMX. The pattern of a time range can be generally described as [start date]\[duration], where start date is an date or dateTime type as defined in XML Schema and duration is a time duration as defined in XML Schema. Note that it is permissible for a time zone offset to be provided on the date or date time.
6649
6650 Derived by restriction of TimeRangeValidDateDurationType.
6651 Regular Expression Pattern: .+/P.*T(\d+H)?(\d+M)?(\d+(.\d+)?S)?.+/P[^T]+
6652
6653 **TimezoneType: **TimezoneType defines the pattern for a time zone. An offset of -14:00 to +14:00 or Z can be specified.
6654
6655 Derived by restriction of xs:string.
6656 Regular Expression Pattern: Z(\+|\-)(14:00|((0[0-9]|1[0-3]):[0-5][0-9]))
6657
6658 **OccurenceType: **OccurenceType is used to express the maximum occurrence of an object. It combines an integer, greater than 1, and the literal text, "unbounded", for objects which have no upper limit on its occurrence.
6659
6660 Union of:
6661 MaxOccursNumberType, UnboundedCodeType.
6662
6663 **MaxOccursNumberType: **MaxOccursNumberType is a base type used to restrict an integer to be greater than 1, for the purpose of expressing the maximum number of occurrences of an object.
6664
6665 Derived by restriction of xs:nonNegativeInteger.
6666 Minimum (inclusive): 1
6667 Fraction Digits: 0
6668
6669 **UnboundedCodeType: **UnboundedCodeType provides single textual value of "unbounded", for use in OccurentType.
6670
6671 Derived by restriction of xs:string .
6672
6673 Enumerations:
6674
6675 |**Value**|**Documentation**
6676 |unbounded|Object has no upper limit on occurrences.
6677
6678 **ActionType: **ActionType provides a list of actions, describing the intention of the data transmission from the sender's side. Each action provided at the data or metadata set level applies to the entire data set for which it is given. Note that the actions indicated in the Message Header are optional, and used to summarize specific actions indicated with this data type for all registry interactions. The "Informational" value is used when the message contains information in response to a query, rather than being used to invoke a maintenance activity.
6679
6680 Derived by restriction of xs:NMTOKEN .
6681
6682 Enumerations:
6683
6684 |**Value**|**Documentation**
6685 |Append|Append - this is an incremental update for an existing data/metadata set or the provision of new data or documentation (attribute values) formerly absent. If any of the supplied data or metadata is already present, it will not replace that data or metadata. This corresponds to the "Update" value found in version 1.0 of the SDMX Technical Standards.
6686 |Replace|Replace - data/metadata is to be replaced, and may also include additional data/metadata to be appended. The replacement occurs at the level of the observation - that is, it is not possible to replace an entire series.
6687 |Delete|Delete - data/metadata is to be deleted. Deletion occurs at the lowest level object. For instance, if a delete data message contains a series with no observations, then the entire series will be deleted. If the series contains observations, then only those observations specified will be deleted. The same basic concept applies for attributes. If a series or observation in a delete message contains attributes, then only those attributes will be deleted.
6688 |Information|Informational - data/metadata is being exchanged for informational purposes only, and not meant to update a system.
6689
6690 **WildCardValueType: **WildCardValueType is a single value code list, used to include the '%' character - indicating that an entire field is wild carded.
6691
6692 Derived by restriction of xs:string .
6693
6694 Enumerations:
6695
6696 (% style="width:913.294px" %)
6697 |(% style="width:183px" %)**Value**|(% style="width:727px" %)**Documentation**
6698 |(% style="width:183px" %)%|(% style="width:727px" %)Indicates a wild card value.
6699
6700 **DimensionTypeType: **DimensionTypeType enumerates the sub-classes of a dimension.
6701
6702 Derived by restriction of xs:string .
6703
6704 Enumerations:
6705
6706 |**Value**|**Documentation**
6707 |Dimension|An ordinary dimension.
6708 |MeasureDimension|A measure dimension.
6709 |TimeDimension|The time dimension.
6710
6711 **ContentConstraintTypeCodeType: **ContentConstraintTypeCodeType defines a list of types for a content constraint. A content constraint can state which data is present or which content is allowed for the constraint attachment.
6712
6713 Derived by restriction of xs:string .
6714
6715 Enumerations:
6716
6717 |**Value**|**Documentation**
6718 |Allowed|The constraint contains the allowed values for attachable object.
6719 |Actual|The constraints contains the actual data present for the attachable object.
6720
6721 **SimpleOperatorType: **SimpleOperatorType provides an enumeration of simple operators to be applied to any value.
6722
6723 Derived by restriction of xs:string .
6724
6725 Enumerations:
6726
6727 |**Value**|**Documentation**
6728 |notEqual|(~!=) - value must not be equal to the value supplied.
6729 |equal|(=) - value must be exactly equal to the value supplied.
6730
6731 **RangeOperatorType: **RangeOperatorType provides an enumeration of range operators to be applied to an ordered value.
6732
6733 Derived by restriction of xs:string .
6734
6735 Enumerations:
6736
6737 |**Value**|**Documentation**
6738 |greaterThanOrEqual|(>=) - value must be greater than or equal to the value supplied.
6739 |lessThanOrEqual|(<=) - value must be less than or equal to the value supplied.
6740 |greaterThan|(>) - value must be greater than the value supplied.
6741 |lessThan|(<) - value must be less than the value supplied.
6742
6743 **TextSearchOperatorType: **TextSearchOperatorType provides an enumeration of text search operators.
6744
6745 Derived by restriction of xs:string .
6746
6747 Enumerations:
6748
6749 |**Value**|**Documentation**
6750 |contains|The text being searched must contain the supplied text.
6751 |startsWith|The text being searched must start with the supplied text.
6752 |endsWith|The text being searched must end with the supplied text.
6753 |doesNotContain|The text being searched cannot contain the supplied text.
6754 |doesNotStartWith|The text being searched cannot start with the supplied text.
6755 |doesNotEndWith|The text being searched cannot end with the supplied text.
6756
6757 **OrderedOperatorType: **OrderedOperatorType combines the SimpleOperatorType and the RangeOperatorType to provide a full range or operators for any ordered value.
6758
6759 Union of:
6760 SimpleOperatorType, RangeOperatorType.
6761
6762 **TextOperatorType:**
6763
6764 Union of:
6765 SimpleOperatorType, TextSearchOperatorType.
6766
6767 **TimeOperatorType: **TimeOperatorType derives from the OrderedOperatorType to remove the notEqual operator.
6768
6769 Derived by restriction of OrderedOperatorType .
6770
6771 Enumerations:
6772
6773 |**Value**|**Documentation**
6774 |equal|
6775 |greaterThanOrEqual|
6776 |lessThanOrEqual|
6777 |greaterThan|
6778 |lessThan|
6779
6780 **ObservationDimensionType: **ObservationDimensionType allows for the dimension at the observation level to be specified by either providing the dimension identifier or using the explicit value "AllDimensions".
6781
6782 Union of:
6783 NCNameIDType, ObsDimensionsCodeType.
6784
6785 **ObsDimensionsCodeType: **ObsDimensionsCodeType is an enumeration containing the values "TimeDimension" and "AllDimensions"
6786
6787 Derived by restriction of xs:string .
6788
6789 Enumerations:
6790
6791 |**Value**|**Documentation**
6792 |AllDimensions|AllDimensions notes that the cross sectional format shall be flat; that is all dimensions should be contained at the observation level.
6793 |TIME_PERIOD|TIME_PERIOD refers to the fixed identifier for the time dimension.
6794
6795 **DataType: **DataTypeType provides an enumerated list of the types of data formats allowed as the for the representation of an object.
6796
6797 Derived by restriction of xs:NMTOKEN .
6798
6799 Enumerations:
6800
6801 |**Value**|**Documentation**
6802 |String|A string datatype corresponding to W3C XML Schema's xs:string datatype.
6803 |Alpha|A string datatype which only allows for the simple aplhabetic charcter set of A-Z, a-z.
6804 |AlphaNumeric|A string datatype which only allows for the simple alphabetic character set of A-Z, a-z plus the simple numeric character set of 0-9.
6805 |Numeric|A string datatype which only allows for the simple numeric character set of 0-9. This format is not treated as an integer, and therefore can having leading zeros.
6806 |BigInteger|An integer datatype corresponding to W3C XML Schema's xs:integer datatype.
6807 |Integer|An integer datatype corresponding to W3C XML Schema's xs:int datatype.
6808 |Long|A numeric datatype corresponding to W3C XML Schema's xs:long datatype.
6809 |Short|A numeric datatype corresponding to W3C XML Schema's xs:short datatype.
6810 |Decimal|A numeric datatype corresponding to W3C XML Schema's xs:decimal datatype.
6811 |Float|A numeric datatype corresponding to W3C XML Schema's xs:float datatype.
6812 |Double|A numeric datatype corresponding to W3C XML Schema's xs:double datatype.
6813 |Boolean|A datatype corresponding to W3C XML Schema's xs:boolean datatype.
6814 |URI|A datatype corresponding to W3C XML Schema's xs:anyURI datatype.
6815 |Count|A simple incrementing Integer type. The isSequence facet must be set to true, and the interval facet must be set to "1".
6816 |InclusiveValueRange|This value indicates that the startValue and endValue attributes provide the inclusive boundaries of a numeric range of type xs:decimal.
6817 |ExclusiveValueRange|This value indicates that the startValue and endValue attributes provide the exclusive boundaries of a numeric range, of type xs:decimal.
6818 |Incremental|This value indicates that the value increments according to the value provided in the interval facet, and has a true value for the isSequence facet.
6819 |ObservationalTimePeriod|Observational time periods are the superset of all time periods in SDMX. It is the union of the standard time periods (i.e. Gregorian time periods, the reporting time periods, and date time) and a time range.
6820 |StandardTimePeriod|Standard time periods is a superset of distinct time period in SDMX. It is the union of the basic time periods (i.e. the Gregorian time periods and date time) and the reporting time periods.
6821 |BasicTimePeriod|BasicTimePeriod time periods is a superset of the Gregorian time periods and a date time.
6822 |GregorianTimePeriod|Gregorian time periods correspond to calendar periods and are represented in ISO-8601 formats. This is the union of the year, year month, and date formats.
6823 |GregorianYear|A Gregorian time period corresponding to W3C XML Schema's xs:gYear datatype, which is based on ISO-8601.
6824 |GregorianYearMonth|A time datatype corresponding to W3C XML Schema's xs:gYearMonth datatype, which is based on ISO-8601.
6825 |GregorianDay|A time datatype corresponding to W3C XML Schema's xs:date datatype, which is based on ISO-8601.
6826 |ReportingTimePeriod|Reporting time periods represent periods of a standard length within a reporting year, where to start of the year (defined as a month and day) must be defined elsewhere or it is assumed to be January 1. This is the union of the reporting year, semester, trimester, quarter, month, week, and day.
6827 |ReportingYear|A reporting year represents a period of 1 year (P1Y) from the start date of the reporting year. This is expressed as using the SDMX specific ReportingYearType.
6828 |ReportingSemester|A reporting semester represents a period of 6 months (P6M) from the start date of the reporting year. This is expressed as using the SDMX specific ReportingSemesterType.
6829 |ReportingTrimester|A reporting trimester represents a period of 4 months (P4M) from the start date of the reporting year. This is expressed as using the SDMX specific ReportingTrimesterType.
6830 |ReportingQuarter|A reporting quarter represents a period of 3 months (P3M) from the start date of the reporting year. This is expressed as using the SDMX specific ReportingQuarterType.
6831 |ReportingMonth|A reporting month represents a period of 1 month (P1M) from the start date of the reporting year. This is expressed as using the SDMX specific ReportingMonthType.
6832 |ReportingWeek|A reporting week represents a period of 7 days (P7D) from the start date of the reporting year. This is expressed as using the SDMX specific ReportingWeekType.
6833 |ReportingDay|A reporting day represents a period of 1 day (P1D) from the start date of the reporting year. This is expressed as using the SDMX specific ReportingDayType.
6834 |DateTime|A time datatype corresponding to W3C XML Schema's xs:dateTime datatype.
6835 |TimeRange|TimeRange defines a time period by providing a distinct start (date or date time) and a duration.
6836 |Month|A time datatype corresponding to W3C XML Schema's xs:gMonth datatype.
6837 |MonthDay|A time datatype corresponding to W3C XML Schema's xs:gMonthDay datatype.
6838 |Day|A time datatype corresponding to W3C XML Schema's xs:gDay datatype.
6839 |Time|A time datatype corresponding to W3C XML Schema's xs:time datatype.
6840 |Duration|A time datatype corresponding to W3C XML Schema's xs:duration datatype.
6841 |XHTML|This value indicates that the content of the component can contain XHTML markup.
6842 |KeyValues|This value indicates that the content of the component will be data key (a set of dimension references and values for the dimensions).
6843 |IdentifiableReference|This value indicates that the content of the component will be complete reference (either URN or full set of reference fields) to an Identifiable object in the SDMX Information Model.
6844 |DataSetReference|This value indicates that the content of the component will be reference to a data provider, which is actually a formal reference to a data provider and a data set identifier value.
6845 |AttachmentConstraintReference|This value indicates that the content of the component will be reference to an attachment constraint, which is actually a combination of a collection of full or partial key values and a reference to a data set or data structure, usage, or provision agreement.
6846
6847 **BasicComponentDataType: **BasicComponentDataType provides an enumerated list of the types of characters allowed in the textType attribute for all non-target object components.
6848
6849 Derived by restriction of DataType .
6850
6851 Enumerations:
6852
6853 |**Value**|**Documentation**
6854 |String|A string datatype corresponding to W3C XML Schema's xs:string datatype.
6855 |Alpha|A string datatype which only allows for the simple aplhabetic charcter set of A-Z, a-z.
6856 |AlphaNumeric|A string datatype which only allows for the simple alphabetic character set of A-Z, a-z plus the simple numeric character set of 0-9.
6857 |Numeric|A string datatype which only allows for the simple numeric character set of 0-9. This format is not treated as an integer, and therefore can having leading zeros.
6858 |BigInteger|An integer datatype corresponding to W3C XML Schema's xs:integer datatype.
6859 |Integer|An integer datatype corresponding to W3C XML Schema's xs:int datatype.
6860 |Long|A numeric datatype corresponding to W3C XML Schema's xs:long datatype.
6861 |Short|A numeric datatype corresponding to W3C XML Schema's xs:short datatype.
6862 |Decimal|A numeric datatype corresponding to W3C XML Schema's xs:decimal datatype.
6863 |Float|A numeric datatype corresponding to W3C XML Schema's xs:float datatype.
6864 |Double|A numeric datatype corresponding to W3C XML Schema's xs:double datatype.
6865 |Boolean|A datatype corresponding to W3C XML Schema's xs:boolean datatype.
6866 |URI|A datatype corresponding to W3C XML Schema's xs:anyURI datatype.
6867 |Count|A simple incrementing Integer type. The isSequence facet must be set to true, and the interval facet must be set to "1".
6868 |InclusiveValueRange|This value indicates that the startValue and endValue attributes provide the inclusive boundaries of a numeric range of type xs:decimal.
6869 |ExclusiveValueRange|This value indicates that the startValue and endValue attributes provide the exclusive boundaries of a numeric range, of type xs:decimal.
6870 |Incremental|This value indicates that the value increments according to the value provided in the interval facet, and has a true value for the isSequence facet.
6871 |ObservationalTimePeriod|Observational time periods are the superset of all time periods in SDMX. It is the union of the standard time periods (i.e. Gregorian time periods, the reporting time periods, and date time) and a time range.
6872 |StandardTimePeriod|Standard time periods is a superset of distinct time period in SDMX. It is the union of the basic time periods (i.e. the Gregorian time periods and date time) and the reporting time periods.
6873 |BasicTimePeriod|BasicTimePeriod time periods is a superset of the Gregorian time periods and a date time.
6874 |GregorianTimePeriod|Gregorian time periods correspond to calendar periods and are represented in ISO-8601 formats. This is the union of the year, year month, and date formats.
6875 |GregorianYear|A Gregorian time period corresponding to W3C XML Schema's xs:gYear datatype, which is based on ISO-8601.
6876 |GregorianYearMonth|A time datatype corresponding to W3C XML Schema's xs:gYearMonth datatype, which is based on ISO-8601.
6877 |GregorianDay|A time datatype corresponding to W3C XML Schema's xs:date datatype, which is based on ISO-8601.
6878 |ReportingTimePeriod|Reporting time periods represent periods of a standard length within a reporting year, where to start of the year (defined as a month and day) must be defined elsewhere or it is assumed to be January 1. This is the union of the reporting year, semester, trimester, quarter, month, week, and day.
6879 |ReportingYear|A reporting year represents a period of 1 year (P1Y) from the start date of the reporting year. This is expressed as using the SDMX specific ReportingYearType.
6880 |ReportingSemester|A reporting semester represents a period of 6 months (P6M) from the start date of the reporting year. This is expressed as using the SDMX specific ReportingSemesterType.
6881 |ReportingTrimester|A reporting trimester represents a period of 4 months (P4M) from the start date of the reporting year. This is expressed as using the SDMX specific ReportingTrimesterType.
6882 |ReportingQuarter|A reporting quarter represents a period of 3 months (P3M) from the start date of the reporting year. This is expressed as using the SDMX specific ReportingQuarterType.
6883 |ReportingMonth|A reporting month represents a period of 1 month (P1M) from the start date of the reporting year. This is expressed as using the SDMX specific ReportingMonthType.
6884 |ReportingWeek|A reporting week represents a period of 7 days (P7D) from the start date of the reporting year. This is expressed as using the SDMX specific ReportingWeekType.
6885 |ReportingDay|A reporting day represents a period of 1 day (P1D) from the start date of the reporting year. This is expressed as using the SDMX specific ReportingDayType.
6886 |DateTime|A time datatype corresponding to W3C XML Schema's xs:dateTime datatype.
6887 |TimeRange|TimeRange defines a time period by providing a distinct start (date or date time) and a duration.
6888 |Month|A time datatype corresponding to W3C XML Schema's xs:gMonth datatype.
6889 |MonthDay|A time datatype corresponding to W3C XML Schema's xs:gMonthDay datatype.
6890 |Day|A time datatype corresponding to W3C XML Schema's xs:gDay datatype.
6891 |Time|A time datatype corresponding to W3C XML Schema's xs:time datatype.
6892 |Duration|A time datatype corresponding to W3C XML Schema's xs:duration datatype.
6893 |XHTML|This value indicates that the content of the component can contain XHTML markup.
6894
6895 **SimpleDataType: **SimpleDataType restricts BasicComponentDataType to specify the allowable data types for a data structure definition component. The XHTML representation is removed as a possible type.
6896
6897 Derived by restriction of BasicComponentDataType .
6898
6899 Enumerations:
6900
6901 |**Value**|**Documentation**
6902 |String|A string datatype corresponding to W3C XML Schema's xs:string datatype.
6903 |Alpha|A string datatype which only allows for the simple aplhabetic charcter set of A-Z, a-z.
6904 |AlphaNumeric|A string datatype which only allows for the simple alphabetic character set of A-Z, a-z plus the simple numeric character set of 0-9.
6905 |Numeric|A string datatype which only allows for the simple numeric character set of 0-9. This format is not treated as an integer, and therefore can having leading zeros.
6906 |BigInteger|An integer datatype corresponding to W3C XML Schema's xs:integer datatype.
6907 |Integer|An integer datatype corresponding to W3C XML Schema's xs:int datatype.
6908 |Long|A numeric datatype corresponding to W3C XML Schema's xs:long datatype.
6909 |Short|A numeric datatype corresponding to W3C XML Schema's xs:short datatype.
6910 |Decimal|A numeric datatype corresponding to W3C XML Schema's xs:decimal datatype.
6911 |Float|A numeric datatype corresponding to W3C XML Schema's xs:float datatype.
6912 |Double|A numeric datatype corresponding to W3C XML Schema's xs:double datatype.
6913 |Boolean|A datatype corresponding to W3C XML Schema's xs:boolean datatype.
6914 |URI|A datatype corresponding to W3C XML Schema's xs:anyURI datatype.
6915 |Count|A simple incrementing Integer type. The isSequence facet must be set to true, and the interval facet must be set to "1".
6916 |InclusiveValueRange|This value indicates that the startValue and endValue attributes provide the inclusive boundaries of a numeric range of type xs:decimal.
6917 |ExclusiveValueRange|This value indicates that the startValue and endValue attributes provide the exclusive boundaries of a numeric range, of type xs:decimal.
6918 |Incremental|This value indicates that the value increments according to the value provided in the interval facet, and has a true value for the isSequence facet.
6919 |ObservationalTimePeriod|Observational time periods are the superset of all time periods in SDMX. It is the union of the standard time periods (i.e. Gregorian time periods, the reporting time periods, and date time) and a time range.
6920 |StandardTimePeriod|Standard time periods is a superset of distinct time period in SDMX. It is the union of the basic time periods (i.e. the Gregorian time periods and date time) and the reporting time periods.
6921 |BasicTimePeriod|BasicTimePeriod time periods is a superset of the Gregorian time periods and a date time.
6922 |GregorianTimePeriod|Gregorian time periods correspond to calendar periods and are represented in ISO-8601 formats. This is the union of the year, year month, and date formats.
6923 |GregorianYear|A Gregorian time period corresponding to W3C XML Schema's xs:gYear datatype, which is based on ISO-8601.
6924 |GregorianYearMonth|A time datatype corresponding to W3C XML Schema's xs:gYearMonth datatype, which is based on ISO-8601.
6925 |GregorianDay|A time datatype corresponding to W3C XML Schema's xs:date datatype, which is based on ISO-8601.
6926 |ReportingTimePeriod|Reporting time periods represent periods of a standard length within a reporting year, where to start of the year (defined as a month and day) must be defined elsewhere or it is assumed to be January 1. This is the union of the reporting year, semester, trimester, quarter, month, week, and day.
6927 |ReportingYear|A reporting year represents a period of 1 year (P1Y) from the start date of the reporting year. This is expressed as using the SDMX specific ReportingYearType.
6928 |ReportingSemester|A reporting semester represents a period of 6 months (P6M) from the start date of the reporting year. This is expressed as using the SDMX specific ReportingSemesterType.
6929 |ReportingTrimester|A reporting trimester represents a period of 4 months (P4M) from the start date of the reporting year. This is expressed as using the SDMX specific ReportingTrimesterType.
6930 |ReportingQuarter|A reporting quarter represents a period of 3 months (P3M) from the start date of the reporting year. This is expressed as using the SDMX specific ReportingQuarterType.
6931 |ReportingMonth|A reporting month represents a period of 1 month (P1M) from the start date of the reporting year. This is expressed as using the SDMX specific ReportingMonthType.
6932 |ReportingWeek|A reporting week represents a period of 7 days (P7D) from the start date of the reporting year. This is expressed as using the SDMX specific ReportingWeekType.
6933 |ReportingDay|A reporting day represents a period of 1 day (P1D) from the start date of the reporting year. This is expressed as using the SDMX specific ReportingDayType.
6934 |DateTime|A time datatype corresponding to W3C XML Schema's xs:dateTime datatype.
6935 |TimeRange|TimeRange defines a time period by providing a distinct start (date or date time) and a duration.
6936 |Month|A time datatype corresponding to W3C XML Schema's xs:gMonth datatype.
6937 |MonthDay|A time datatype corresponding to W3C XML Schema's xs:gMonthDay datatype.
6938 |Day|A time datatype corresponding to W3C XML Schema's xs:gDay datatype.
6939 |Time|A time datatype corresponding to W3C XML Schema's xs:time datatype.
6940 |Duration|A time datatype corresponding to W3C XML Schema's xs:duration datatype.
6941
6942 **TimeDataType: **TimeDataType restricts SimpleDataType to specify the allowable data types for representing a time value.
6943
6944 Derived by restriction of SimpleDataType .
6945
6946 Enumerations:
6947
6948 (% style="width:968.835px" %)
6949 |**Value**|(% style="width:769px" %)**Documentation**
6950 |ObservationalTimePeriod|(% style="width:769px" %)Observational time periods are the superset of all time periods in SDMX. It is the union of the standard time periods (i.e. Gregorian time periods, the reporting time periods, and date time) and a time range.
6951 |StandardTimePeriod|(% style="width:769px" %)Standard time periods is a superset of distinct time period in SDMX. It is the union of the basic time periods (i.e. the Gregorian time periods and date time) and the reporting time periods.
6952 |BasicTimePeriod|(% style="width:769px" %)BasicTimePeriod time periods is a superset of the Gregorian time periods and a date time.
6953 |GregorianTimePeriod|(% style="width:769px" %)Gregorian time periods correspond to calendar periods and are represented in ISO-8601 formats. This is the union of the year, year month, and date formats.
6954 |GregorianYear|(% style="width:769px" %)A Gregorian time period corresponding to W3C XML Schema's xs:gYear datatype, which is based on ISO-8601.
6955 |GregorianYearMonth|(% style="width:769px" %)A time datatype corresponding to W3C XML Schema's xs:gYearMonth datatype, which is based on ISO-8601.
6956 |GregorianDay|(% style="width:769px" %)A time datatype corresponding to W3C XML Schema's xs:date datatype, which is based on ISO-8601.
6957 |ReportingTimePeriod|(% style="width:769px" %)Reporting time periods represent periods of a standard length within a reporting year, where to start of the year (defined as a month and day) must be defined elsewhere or it is assumed to be January 1. This is the union of the reporting year, semester, trimester, quarter, month, week, and day.
6958 |ReportingYear|(% style="width:769px" %)A reporting year represents a period of 1 year (P1Y) from the start date of the reporting year. This is expressed as using the SDMX specific ReportingYearType.
6959 |ReportingSemester|(% style="width:769px" %)A reporting semester represents a period of 6 months (P6M) from the start date of the reporting year. This is expressed as using the SDMX specific ReportingSemesterType.
6960 |ReportingTrimester|(% style="width:769px" %)A reporting trimester represents a period of 4 months (P4M) from the start date of the reporting year. This is expressed as using the SDMX specific ReportingTrimesterType.
6961 |ReportingQuarter|(% style="width:769px" %)A reporting quarter represents a period of 3 months (P3M) from the start date of the reporting year. This is expressed as using the SDMX specific ReportingQuarterType.
6962 |ReportingMonth|(% style="width:769px" %)A reporting month represents a period of 1 month (P1M) from the start date of the reporting year. This is expressed as using the SDMX specific ReportingMonthType.
6963 |ReportingWeek|(% style="width:769px" %)A reporting week represents a period of 7 days (P7D) from the start date of the reporting year. This is expressed as using the SDMX specific ReportingWeekType.
6964 |ReportingDay|(% style="width:769px" %)A reporting day represents a period of 1 day (P1D) from the start date of the reporting year. This is expressed as using the SDMX specific ReportingDayType.
6965 |DateTime|(% style="width:769px" %)A time datatype corresponding to W3C XML Schema's xs:dateTime datatype.
6966 |TimeRange|(% style="width:769px" %)TimeRange defines a time period by providing a distinct start (date or date time) and a duration.
6967
6968 **NestedIDType: **NestedIDType is the least restrictive form of an identifier used throughout all SDMX-ML messages. It allows for a hierarchical identifier, with each portion separated by the '.' character. For the identifier portions, valid characters include A-Z, a-z, @, 0-9, _, -, $.
6969
6970 Derived by restriction of xs:string .
6971 Regular Expression Pattern: [A-Za-z0-9_@$\-]+(\.[A-Za-z0-9_@$\-]+)*
6972
6973 **TwoLevelIDType: **TwoLevelIDType defines an identifier with exactly two levels.
6974
6975 Derived by restriction of NestedIDType .
6976 Regular Expression Pattern: [A-Za-z0-9_@$\-]+\.[A-Za-z0-9_@$\-]+
6977
6978 **IDType: **IDType provides a type which is used for restricting the characters in codes and IDs throughout all SDMX-ML messages. Valid characters include A-Z, a-z, @, 0-9, _, -, $.
6979
6980 Derived by restriction of NestedIDType .
6981 Regular Expression Pattern: [A-Za-z0-9_@$\-]+
6982
6983 **NCNameIDType: **NCNameIDType restricts the IDType, so that the id may be used to generate valid XML components. IDs created from this type conform to the W3C XML Schema NCNAME type, and therefore can be used as element or attribute names.
6984
6985 Derived by restriction of IDType .
6986 Regular Expression Pattern: [A-Za-z][A-Za-z0-9_\-]*
6987
6988 **NestedNCNameIDType: **NestedNCNameIDType restricts the NestedIDType, so that the id may be used to generate valid XML components. IDs created from this type conform to the W3C XML Schema NCNAME type, and therefore can be used as element or attribute names.
6989
6990 Derived by restriction of NestedIDType .
6991 Regular Expression Pattern: [A-Za-z][A-Za-z0-9_\-]*(\.[A-Za-z][A-Za-z0-9_\-]*)*
6992
6993 **SingleNCNameIDType: **SingleNCNameIDType restricts the NestedNCNameIDType to allow only one level. Note that this is the same pattern as the NCNameIDType, but can be used when the base type to be restricted is a nested NCNameIDType (where as the NCNameIDType could only restrict the IDType).
6994
6995 Derived by restriction of NestedNCNameIDType .
6996 Regular Expression Pattern: [A-Za-z][A-Za-z0-9_\-]*
6997
6998 **VersionType: **VersionType is used to communicate version information. The format is restricted to allow for simple incrementing and sorting of version number. The version consists of an unlimited set of numeric components, separated by the '.' character. When processing version, each numeric component (the number preceding and following any '.' character) should be parsed as an integer. Thus, a version of 1.3 and 1.03 would be equivalent, as both the '3' component and the '03' component would parse to an integer value of 3.
6999
7000 Derived by restriction of xs:string .
7001 Regular Expression Pattern: [0-9]+(\.[0-9]+)*
7002
7003 **VersionQueryType: **VersionQueryType combines the VersionType and LateBoundVersionType to allow one to query for either a specific version of an object, or the latest version by specifying the '*' value.
7004
7005 Union of:
7006 VersionType, LateBoundVersionType.
7007
7008 **LateBoundVersionType: **LateBoundVersionType is a single value code list, used to include the '*' character - indicating that the latest version of an object is required.
7009
7010 Derived by restriction of xs:string .
7011
7012 Enumerations:
7013
7014 |**Value**|**Documentation**
7015 |*|Indicates that the latest version of an object is requested.
7016
7017 **PackageTypeCodelistType: **PackageTypeCodelistType provides an enumeration of all SDMX package names.
7018
7019 Derived by restriction of xs:string .
7020
7021 Enumerations:
7022
7023 |**Value**|**Documentation**
7024 |base|
7025 |datastructure|
7026 |metadatastructure|
7027 |process|
7028 |registry|
7029 |mapping|
7030 |codelist|
7031 |categoryscheme|
7032 |conceptscheme|
7033 |transformation|
7034
7035 **ItemSchemePackageTypeCodelistType: **ItemSchemePackageTypeCodelistType provides an enumeration of all SDMX packages which contain item schemes.
7036
7037 Derived by restriction of PackageTypeCodelistType .
7038
7039 Enumerations:
7040
7041 |**Value**|**Documentation**
7042 |base|
7043 |codelist|
7044 |categoryscheme|
7045 |conceptscheme|
7046 |transformation|
7047
7048 **StructurePackageTypeCodelistType: **StructurePackageTypeCodelistType provides an enumeration of all SDMX packages which contain structure and structure usages.
7049
7050 Derived by restriction of PackageTypeCodelistType .
7051
7052 Enumerations:
7053
7054 |**Value**|**Documentation**
7055 |datastructure|
7056 |metadatastructure|
7057
7058 **ObjectTypeCodelistType: **ObjectTypeCodelistType provides an enumeration of all objects outside of the base infomration model class. This includes some abstract object types such as Organsiation and Constraint.
7059
7060 Derived by restriction of xs:string .
7061
7062 Enumerations:
7063
7064 |**Value**|**Documentation**
7065 |Any|
7066 |Agency|
7067 |AgencyScheme|
7068 |AttachmentConstraint|
7069 |Attribute|
7070 |AttributeDescriptor|
7071 |Categorisation|
7072 |Category|
7073 |CategorySchemeMap|
7074 |CategoryScheme|
7075 |Code|
7076 |CodeMap|
7077 |Codelist|
7078 |CodelistMap|
7079 |ComponentMap|
7080 |Concept|
7081 |ConceptMap|
7082 |ConceptScheme|
7083 |ConceptSchemeMap|
7084 |Constraint|
7085 |ConstraintTarget|
7086 |ContentConstraint|
7087 |CustomType|
7088 |CustomTypeScheme|
7089 |Dataflow|
7090 |DataConsumer|
7091 |DataConsumerScheme|
7092 |DataProvider|
7093 |DataProviderScheme|
7094 |DataSetTarget|
7095 |DataStructure|
7096 |DefinitionScheme|
7097 |Dimension|
7098 |DimensionDescriptor|
7099 |DimensionDescriptorValuesTarget|
7100 |GroupDimensionDescriptor|
7101 |HierarchicalCode|
7102 |HierarchicalCodelist|
7103 |Hierarchy|
7104 |HybridCodelistMap|
7105 |HybridCodeMap|
7106 |IdentifiableObjectTarget|
7107 |Level|
7108 |MeasureDescriptor|
7109 |MeasureDimension|
7110 |Metadataflow|
7111 |MetadataAttribute|
7112 |MetadataSet|
7113 |MetadataStructure|
7114 |MetadataTarget|
7115 |NamePersonalisation|
7116 |NamePersonalisationScheme|
7117 |Organisation|
7118 |OrganisationMap|
7119 |OrganisationScheme|
7120 |OrganisationSchemeMap|
7121 |OrganisationUnit|
7122 |OrganisationUnitScheme|
7123 |PrimaryMeasure|
7124 |Process|
7125 |ProcessStep|
7126 |ProvisionAgreement|
7127 |ReportingCategory|
7128 |ReportingCategoryMap|
7129 |ReportingTaxonomy|
7130 |ReportingTaxonomyMap|
7131 |ReportingYearStartDay|
7132 |ReportPeriodTarget|
7133 |ReportStructure|
7134 |Ruleset|
7135 |RulesetScheme|
7136 |StructureMap|
7137 |StructureSet|
7138 |TimeDimension|
7139 |Transformation|
7140 |TransformationScheme|
7141 |Transition|
7142 |UserDefinedOperator|
7143 |UserDefinedOperatorScheme|
7144 |VtlMapping|
7145 |VtlMappingScheme|
7146
7147 **MaintainableTypeCodelistType: **MaintainableTypeCodelistType provides an enumeration of all maintainable objects.
7148
7149 Derived by restriction of ObjectTypeCodelistType .
7150
7151 Enumerations:
7152
7153 |**Value**|**Documentation**
7154 |Any|
7155 |AgencyScheme|
7156 |AttachmentConstraint|
7157 |Categorisation|
7158 |CategoryScheme|
7159 |Codelist|
7160 |ConceptScheme|
7161 |Constraint|
7162 |ContentConstraint|
7163 |CustomTypeScheme|
7164 |Dataflow|
7165 |DataConsumerScheme|
7166 |DataProviderScheme|
7167 |DataStructure|
7168 |DefinitionScheme|
7169 |HierarchicalCodelist|
7170 |Metadataflow|
7171 |MetadataStructure|
7172 |NamePersonalisationScheme|
7173 |OrganisationScheme|
7174 |OrganisationUnitScheme|
7175 |Process|
7176 |ProvisionAgreement|
7177 |ReportingTaxonomy|
7178 |RulesetScheme|
7179 |StructureSet|
7180 |TransformationScheme|
7181 |UserDefinedOperatorScheme|
7182 |VtlMappingScheme|
7183
7184 **ConcreteMaintainableTypeCodelistType: **ConcreteMaintainableTypeCodelistType provides an enumeration of all concrete maintainable objects.
7185
7186 Derived by restriction of MaintainableTypeCodelistType .
7187
7188 Enumerations:
7189
7190 |**Value**|**Documentation**
7191 |AgencyScheme|
7192 |AttachmentConstraint|
7193 |Categorisation|
7194 |CategoryScheme|
7195 |Codelist|
7196 |ConceptScheme|
7197 |ContentConstraint|
7198 |CustomTypeScheme|
7199 |Dataflow|
7200 |DataConsumerScheme|
7201 |DataProviderScheme|
7202 |DataStructure|
7203 |HierarchicalCodelist|
7204 |Metadataflow|
7205 |MetadataStructure|
7206 |NamePersonalisationScheme|
7207 |OrganisationUnitScheme|
7208 |Process|
7209 |ProvisionAgreement|
7210 |ReportingTaxonomy|
7211 |RulesetScheme|
7212 |StructureSet|
7213 |TransformationScheme|
7214 |UserDefinedOperatorScheme|
7215 |VtlMappingScheme|
7216
7217 **CodelistTypeCodelistType: **CodelistTypeCodelistType provides an enumeration of all codelist objects.
7218
7219 Derived by restriction of MaintainableTypeCodelistType .
7220
7221 Enumerations:
7222
7223 |**Value**|**Documentation**
7224 |Codelist|
7225 |HierarchicalCodelist|
7226
7227 **CodeTypeCodelistType: **CodeTypeCodelistType provides an enumeration of all code objects.
7228
7229 Derived by restriction of ObjectTypeCodelistType .
7230
7231 Enumerations:
7232
7233 |**Value**|**Documentation**
7234 |Code|
7235 |HierarchicalCode|
7236
7237 **ConstraintTypeCodelistType: **ConstraintTypeCodelistType provides an enumeration of all constraint objects.
7238
7239 Derived by restriction of MaintainableTypeCodelistType .
7240
7241 Enumerations:
7242
7243 |**Value**|**Documentation**
7244 |AttachmentConstraint|
7245 |ContentConstraint|
7246
7247 **ItemSchemeTypeCodelistType: **ItemSchemeTypeCodelistType provides an enumeration of all item scheme objects.
7248
7249 Derived by restriction of MaintainableTypeCodelistType .
7250
7251 Enumerations:
7252
7253 |**Value**|**Documentation**
7254 |AgencyScheme|
7255 |CategoryScheme|
7256 |Codelist|
7257 |ConceptScheme|
7258 |CustomTypeScheme|
7259 |DataConsumerScheme|
7260 |DataProviderScheme|
7261 |NamePersonalisationScheme|
7262 |OrganisationUnitScheme|
7263 |ReportingTaxonomy|
7264 |RulesetScheme|
7265 |TransformationScheme|
7266 |UserDefinedOperatorScheme|
7267 |VtlMappingScheme|
7268
7269 **DefinitionSchemeTypeCodelistType: **DefinitionSchemeTypeCodelistType provides an enumeration of all definition scheme objects.
7270
7271 Derived by restriction of ItemSchemeTypeCodelistType .
7272
7273 Enumerations:
7274
7275 |**Value**|**Documentation**
7276 |CustomTypeScheme|
7277 |NamePersonalisationScheme|
7278 |RulesetScheme|
7279 |TransformationScheme|
7280 |UserDefinedOperatorScheme|
7281
7282 **OrganisationSchemeTypeCodelistType: **OrganisationSchemeTypeCodelistType provides an enumeration of all organisation scheme objects.
7283
7284 Derived by restriction of ItemSchemeTypeCodelistType .
7285
7286 Enumerations:
7287
7288 |**Value**|**Documentation**
7289 |AgencyScheme|
7290 |DataConsumerScheme|
7291 |DataProviderScheme|
7292 |OrganisationUnitScheme|
7293
7294 **OrganisationTypeCodelistType: **OrganisationTypeCodelistType provides an enumeration of all organisation objects.
7295
7296 Derived by restriction of ItemTypeCodelistType .
7297
7298 Enumerations:
7299
7300 |**Value**|**Documentation**
7301 |Agency|
7302 |DataConsumer|
7303 |DataProvider|
7304 |OrganisationUnit|
7305
7306 **StructureOrUsageTypeCodelistType: **StructureOrUsageTypeCodelistType provides an enumeration all structure and structure usage objects
7307
7308 Derived by restriction of MaintainableTypeCodelistType .
7309
7310 Enumerations:
7311
7312 |**Value**|**Documentation**
7313 |Dataflow|
7314 |DataStructure|
7315 |Metadataflow|
7316 |MetadataStructure|
7317
7318 **StructureTypeCodelistType: **StructureTypeCodelistType provides an enumeration all structure objects
7319
7320 Derived by restriction of StructureOrUsageTypeCodelistType .
7321
7322 Enumerations:
7323
7324 |**Value**|**Documentation**
7325 |DataStructure|
7326 |MetadataStructure|
7327
7328 **StructureUsageTypeCodelistType: **StructureUsageTypeCodelistType provides an enumeration all structure usage objects
7329
7330 Derived by restriction of StructureOrUsageTypeCodelistType .
7331
7332 Enumerations:
7333
7334 |**Value**|**Documentation**
7335 |Dataflow|
7336 |Metadataflow|
7337
7338 **ItemTypeCodelistType: **ItemTypeCodelistType provides an enumeration of all item objects.
7339
7340 Derived by restriction of ObjectTypeCodelistType .
7341
7342 Enumerations:
7343
7344 |**Value**|**Documentation**
7345 |Agency|
7346 |Category|
7347 |Code|
7348 |Concept|
7349 |CustomType|
7350 |DataConsumer|
7351 |DataProvider|
7352 |NamePersonalisation|
7353 |OrganisationUnit|
7354 |ReportingCategory|
7355 |Ruleset|
7356 |Transformation|
7357 |UserDefinedOperator|
7358 |VtlMapping|
7359
7360 **ComponentListTypeCodelistType: **ComponentListTypeCodelistType provides an enumeration of all component list objects.
7361
7362 Derived by restriction of ObjectTypeCodelistType .
7363
7364 Enumerations:
7365
7366 |**Value**|**Documentation**
7367 |AttributeDescriptor|
7368 |DimensionDescriptor|
7369 |GroupDimensionDescriptor|
7370 |MeasureDescriptor|
7371 |MetadataTarget|
7372 |ReportStructure|
7373
7374 **ComponentTypeCodelistType: **ComponentTypeCodelistType provides an enumeration of all component objects.
7375
7376 Derived by restriction of ObjectTypeCodelistType .
7377
7378 Enumerations:
7379
7380 |**Value**|**Documentation**
7381 |Attribute|
7382 |ConstraintTarget|
7383 |DataSetTarget|
7384 |Dimension|
7385 |IdentifiableObjectTarget|
7386 |DimensionDescriptorValuesTarget|
7387 |MeasureDimension|
7388 |MetadataAttribute|
7389 |PrimaryMeasure|
7390 |ReportingYearStartDay|
7391 |ReportPeriodTarget|
7392 |TimeDimension|
7393
7394 **DataStructureComponentTypeCodelistType: **DataStructureComponentTypeCodelistType provides an enumeration of all data structure component objects, except for the primary measure.
7395
7396 Derived by restriction of ComponentTypeCodelistType .
7397
7398 Enumerations:
7399
7400 (% style="width:960.294px" %)
7401 |(% style="width:333px" %)**Value**|(% style="width:624px" %)**Documentation**
7402 |(% style="width:333px" %)Attribute|(% style="width:624px" %)
7403 |(% style="width:333px" %)Dimension|(% style="width:624px" %)
7404 |(% style="width:333px" %)MeasureDimension|(% style="width:624px" %)
7405 |(% style="width:333px" %)PrimaryMeasure|(% style="width:624px" %)
7406 |(% style="width:333px" %)ReportingYearStartDay|(% style="width:624px" %)
7407 |(% style="width:333px" %)TimeDimension|(% style="width:624px" %)
7408
7409 **DimensionEumerationSchemeTypeCodelistType: **DimensionEumerationSchemeTypeCodelistType provides an enumeration of all item schemes which are allowable as the representation of a data structure definition component.
7410
7411 Derived by restriction of ItemSchemeTypeCodelistType .
7412
7413 Enumerations:
7414
7415 |**Value**|**Documentation**
7416 |Codelist|
7417 |ConceptScheme|
7418
7419 **MetadataStructureComponentTypeCodelistType: **MetadataStructureComponentTypeCodelistType provides an enumeration of all metadata structure component objects.
7420
7421 Derived by restriction of ComponentTypeCodelistType .
7422
7423 Enumerations:
7424
7425 |**Value**|**Documentation**
7426 |ConstraintTarget|
7427 |DataSetTarget|
7428 |IdentifiableObjectTarget|
7429 |DimensionDescriptorValuesTarget|
7430 |MetadataAttribute|
7431 |ReportPeriodTarget|
7432
7433 **DimensionTypeCodelistType: **DimensionTypeCodelistType provides an enumeration of all dimension objects.
7434
7435 Derived by restriction of ComponentTypeCodelistType .
7436
7437 Enumerations:
7438
7439 |**Value**|**Documentation**
7440 |Dimension|
7441 |MeasureDimension|
7442 |TimeDimension|
7443
7444 **TargetObjectTypeCodelistType: **TargetObjectTypeCodelistType provides an enumeration of all target object objects.
7445
7446 Derived by restriction of ComponentTypeCodelistType .
7447
7448 Enumerations:
7449
7450 |**Value**|**Documentation**
7451 |ConstraintTarget|
7452 |DataSetTarget|
7453 |IdentifiableObjectTarget|
7454 |DimensionDescriptorValuesTarget|
7455 |ReportPeriodTarget|
© Semantic R&D Group, 2026