Skip to Content

Wiki source code of Part II.Common

Version 10.2 by Helena K. on 2025/06/28 00:24
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 of SDMX. 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 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 which make up the references are of atomic types, and therefore can be expressed as XML attributes which are easily refined and restricted since the XML Schema design principles in SDMX always treats attributes 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 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 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 ***
1336 **** //StructureOrUsageRefBaseType//
1337
1338 Attributes:
1339 agencyID, id, version?, local?, class?, package?
1340
1341 Content:
1342 {Empty}
1343
1344 Attribute Documentation:
1345
1346 |**Name**|**Type**|**Documentation**
1347 |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.
1348 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
1349 |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.
1350 |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.
1351 |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.
1352 |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.
1353
1354 //**StructureRefBaseType**//**: **StructureRefBaseType is an abstract base type for referencing a structure.
1355
1356 Derivation:
1357
1358 * //RefBaseType// (restriction)
1359 ** //MaintainableRefBaseType// (restriction)
1360 *** //StructureOrUsageRefBaseType// (restriction)
1361 **** //StructureRefBaseType//
1362
1363 Attributes:
1364 agencyID, id, version?, local?, class?, package?
1365
1366 Content:
1367 {Empty}
1368
1369 Attribute Documentation:
1370
1371 |**Name**|**Type**|**Documentation**
1372 |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.
1373 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
1374 |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.
1375 |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.
1376 |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.
1377 |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.
1378
1379 **StructureRefType: **StructureRefType contains a set of reference fields for referencing any structure.
1380
1381 Derivation:
1382
1383 * //RefBaseType// (restriction)
1384 ** //MaintainableRefBaseType// (restriction)
1385 *** //StructureOrUsageRefBaseType// (restriction)
1386 **** //StructureRefBaseType// (restriction)
1387 ***** StructureRefType
1388
1389 Attributes:
1390 agencyID, id, version?, local?, class, package
1391
1392 Content:
1393 {Empty}
1394
1395 Attribute Documentation:
1396
1397 |**Name**|**Type**|**Documentation**
1398 |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.
1399 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
1400 |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.
1401 |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.
1402 |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.
1403 |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.
1404
1405 //**StructureUsageRefBaseType**//**: **StructureUsageRefBaseType is an abstract base type for referencing a structure usage.
1406
1407 Derivation:
1408
1409 * //RefBaseType// (restriction)
1410 ** //MaintainableRefBaseType// (restriction)
1411 *** //StructureOrUsageRefBaseType// (restriction)
1412 **** //StructureUsageRefBaseType//
1413
1414 Attributes:
1415 agencyID, id, version?, local?, class?, package?
1416
1417 Content:
1418 {Empty}
1419
1420 Attribute Documentation:
1421
1422 |**Name**|**Type**|**Documentation**
1423 |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.
1424 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
1425 |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.
1426 |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.
1427 |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.
1428 |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.
1429
1430 **StructureUsageRefType: **StructureUsageRefType contains a set of reference fields for referencing any structure usage.
1431
1432 Derivation:
1433
1434 * //RefBaseType// (restriction)
1435 ** //MaintainableRefBaseType// (restriction)
1436 *** //StructureOrUsageRefBaseType// (restriction)
1437 **** //StructureUsageRefBaseType// (restriction)
1438 *StructureUsageRefType
1439
1440 Attributes:
1441 agencyID, id, version?, local?, class, package
1442
1443 Content:
1444 {Empty}
1445
1446 Attribute Documentation:
1447
1448 |**Name**|**Type**|**Documentation**
1449 |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.
1450 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
1451 |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.
1452 |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.
1453 |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.
1454 |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.
1455
1456 //**ChildObjectRefBaseType**//**: **ChildObjectRefBaseType is an abstract base type for referencing any child object defined directly within a maintainable object.
1457
1458 Derivation:
1459
1460 * //RefBaseType// (restriction)
1461 ** //ChildObjectRefBaseType//
1462
1463 Attributes:
1464 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
1465
1466 Content:
1467 {Empty}
1468
1469 Attribute Documentation:
1470
1471 |**Name**|**Type**|**Documentation**
1472 |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.
1473 |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.
1474 |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.
1475 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
1476 |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.
1477 |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.
1478 |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.
1479
1480 //**ContainerChildObjectRefBaseType**//**: **ContainerChildObjectRefBaseType is an abstract base type for referencing any child object within container defined in a maintainable object.
1481
1482 Derivation:
1483
1484 * //RefBaseType// (restriction)
1485 ** //ContainerChildObjectRefBaseType//
1486
1487 Attributes:
1488 agencyID, maintainableParentID, maintainableParentVersion?, containerID?, id, version?, local?, class?, package?
1489
1490 Content:
1491 {Empty}
1492
1493 Attribute Documentation:
1494
1495 |**Name**|**Type**|**Documentation**
1496 |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.
1497 |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.
1498 |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.
1499 |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.
1500 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
1501 |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.
1502 |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.
1503 |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.
1504 |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.
1505
1506 //**ItemRefBaseType**//**: **ItemRefBaseType is an abstract base type for referencing an item within an item scheme.
1507
1508 Derivation:
1509
1510 * //RefBaseType// (restriction)
1511 ** //ChildObjectRefBaseType// (restriction)
1512 *** //ItemRefBaseType//
1513
1514 Attributes:
1515 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
1516
1517 Content:
1518 {Empty}
1519
1520 Attribute Documentation:
1521
1522 |**Name**|**Type**|**Documentation**
1523 |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.
1524 |maintainableParentID|IDType|The maintainableParentID references the item scheme in which the item being referenced is defined.
1525 |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.
1526 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
1527 |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.
1528 |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.
1529 |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.
1530
1531 //**ComponentListRefBaseType**//**: **ComponentListRefBaseType is an abstract base type for referencing a component list within a structure.
1532
1533 Derivation:
1534
1535 * //RefBaseType// (restriction)
1536 ** //ChildObjectRefBaseType// (restriction)
1537 *** //ComponentListRefBaseType//
1538
1539 Attributes:
1540 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
1541
1542 Content:
1543 {Empty}
1544
1545 Attribute Documentation:
1546
1547 |**Name**|**Type**|**Documentation**
1548 |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.
1549 |maintainableParentID|IDType|The maintainableParentID references the structure in which the component list being referenced is defined.
1550 |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.
1551 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
1552 |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.
1553 |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.
1554 |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.
1555
1556 //**ComponentRefBaseType**//**: **ComponentRefBaseType is an abstract base type for referencing a component contained in a component list within a structure.
1557
1558 Derivation:
1559
1560 * //RefBaseType// (restriction)
1561 ** //ContainerChildObjectRefBaseType// (restriction)
1562 *** //ComponentRefBaseType//
1563
1564 Attributes:
1565 agencyID, maintainableParentID, maintainableParentVersion?, containerID?, id, version?, local?, class?, package?
1566
1567 Content:
1568 {Empty}
1569
1570 Attribute Documentation:
1571
1572 |**Name**|**Type**|**Documentation**
1573 |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.
1574 |maintainableParentID|IDType|The maintainableParentID references the structure in which the component being referenced is defined.
1575 |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.
1576 |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.
1577 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
1578 |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.
1579 |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.
1580 |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.
1581 |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.
1582
1583 **AnyCodelistRefType: **AnyCodelistRefType is a type for referencing any codelist object (either a codelist or a hierarchical codelist).
1584
1585 Derivation:
1586
1587 * //RefBaseType// (restriction)
1588 ** //MaintainableRefBaseType// (restriction)
1589 *** AnyCodelistRefType
1590
1591 Attributes:
1592 agencyID, id, version?, local?, class, package?
1593
1594 Content:
1595 {Empty}
1596
1597 Attribute Documentation:
1598
1599 |**Name**|**Type**|**Documentation**
1600 |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.
1601 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
1602 |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.
1603 |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.
1604 |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.
1605 |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.
1606
1607 **StructureOrUsageRefType: **StructureOrUsageRefType is a type for referencing a structure or structure usage.
1608
1609 Derivation:
1610
1611 * //RefBaseType// (restriction)
1612 ** //MaintainableRefBaseType// (restriction)
1613 *** //StructureOrUsageRefBaseType// (restriction)
1614 **** StructureOrUsageRefType
1615
1616 Attributes:
1617 agencyID, id, version?, local?, class, package
1618
1619 Content:
1620 {Empty}
1621
1622 Attribute Documentation:
1623
1624 |**Name**|**Type**|**Documentation**
1625 |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.
1626 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
1627 |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.
1628 |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.
1629 |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.
1630 |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.
1631
1632 //**LocalIdentifiableRefBaseType**//**: **LocalIdentifiableRefBaseType is an abstract base type which provides a local reference to any identifiable object.
1633
1634 Derivation:
1635
1636 * //RefBaseType// (restriction)
1637 ** //LocalIdentifiableRefBaseType//
1638
1639 Attributes:
1640 containerID?, id, local?, class?, package?
1641
1642 Content:
1643 {Empty}
1644
1645 Attribute Documentation:
1646
1647 |**Name**|**Type**|**Documentation**
1648 |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.
1649 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
1650 |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.
1651 |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.
1652 |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.
1653
1654 //**LocalItemRefBaseType**//**: **LocalItemRefBaseType is an abstract base type which provides a local reference to a item object.
1655
1656 Derivation:
1657
1658 * //RefBaseType// (restriction)
1659 ** //LocalIdentifiableRefBaseType// (restriction)
1660 *** //LocalItemRefBaseType//
1661
1662 Attributes:
1663 id, local?, class?, package?
1664
1665 Content:
1666 {Empty}
1667
1668 Attribute Documentation:
1669
1670 |**Name**|**Type**|**Documentation**
1671 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
1672 |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.
1673 |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.
1674 |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.
1675
1676 //**LocalComponentListRefBaseType**//**: **LocalComponentListRefBaseType is an abstract base type which provides a local reference to a component list object.
1677
1678 Derivation:
1679
1680 * //RefBaseType// (restriction)
1681 ** //LocalIdentifiableRefBaseType// (restriction)
1682 *** //LocalComponentListRefBaseType//
1683
1684 Attributes:
1685 id, local?, class?, package?
1686
1687 Content:
1688 {Empty}
1689
1690 Attribute Documentation:
1691
1692 |**Name**|**Type**|**Documentation**
1693 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
1694 |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.
1695 |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.
1696 |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.
1697
1698 //**LocalComponentListComponentRefBaseType**//**: **LocalComponentRefBaseType is an abstract base type which provides a local reference to a component object.
1699
1700 Derivation:
1701
1702 * //RefBaseType// (restriction)
1703 ** //LocalIdentifiableRefBaseType// (restriction)
1704 *** //LocalComponentListComponentRefBaseType//
1705
1706 Attributes:
1707 containerID?, id, local?, class?, package?
1708
1709 Content:
1710 {Empty}
1711
1712 Attribute Documentation:
1713
1714 |**Name**|**Type**|**Documentation**
1715 |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.
1716 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
1717 |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.
1718 |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.
1719 |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.
1720
1721 **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.
1722
1723 Derivation:
1724
1725 * //RefBaseType// (restriction)
1726 ** //LocalIdentifiableRefBaseType// (restriction)
1727 *** //LocalComponentListComponentRefBaseType// (restriction)
1728 **** LocalComponentListComponentRefType
1729
1730 Attributes:
1731 containerID, id, local?, class, package
1732
1733 Content:
1734 {Empty}
1735
1736 Attribute Documentation:
1737
1738 |**Name**|**Type**|**Documentation**
1739 |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.
1740 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
1741 |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.
1742 |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.
1743 |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.
1744
1745 //**LocalComponentRefBaseType**//**: **LocalComponentRefBaseType is an abstract base type which provides a local reference to a component object.
1746
1747 Derivation:
1748
1749 * //RefBaseType// (restriction)
1750 ** //LocalIdentifiableRefBaseType// (restriction)
1751 *** //LocalComponentListComponentRefBaseType// (restriction)
1752 **** //LocalComponentRefBaseType//
1753
1754 Attributes:
1755 id, local?, class?, package?
1756
1757 Content:
1758 {Empty}
1759
1760 Attribute Documentation:
1761
1762 |**Name**|**Type**|**Documentation**
1763 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
1764 |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.
1765 |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.
1766 |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.
1767
1768 **LocalComponentRefType: **LocalComponentRefType provides a local reference to any type component object.
1769
1770 Derivation:
1771
1772 * //RefBaseType// (restriction)
1773 ** //LocalIdentifiableRefBaseType// (restriction)
1774 *** //LocalComponentListComponentRefBaseType// (restriction)
1775 **** //LocalComponentRefBaseType// (restriction)
1776 ***** LocalComponentRefType
1777
1778 Attributes:
1779 id, local?, class, package
1780
1781 Content:
1782 {Empty}
1783
1784 Attribute Documentation:
1785
1786 |**Name**|**Type**|**Documentation**
1787 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
1788 |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.
1789 |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.
1790 |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.
1791
1792 **AnyLocalCodeRefType: **AnyLocalCodeRefType provides a local reference to any code object.
1793
1794 Derivation:
1795
1796 * //RefBaseType// (restriction)
1797 ** AnyLocalCodeRefType
1798
1799 Attributes:
1800 containerID?, id, version?, local?, class?, package?
1801
1802 Content:
1803 {Empty}
1804
1805 Attribute Documentation:
1806
1807 |**Name**|**Type**|**Documentation**
1808 |containerID|IDType|The containerID attribute references the hierarchy which defines the hierarchical code in the case that this reference is for a hierarchical code.
1809 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
1810 |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.
1811 |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.
1812 |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.
1813 |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.
1814
1815 **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.
1816
1817 Derivation:
1818
1819 * //ReferenceType// (restriction)
1820 ** URNReferenceType
1821
1822 Content:
1823 URN
1824
1825 Element Documentation:
1826
1827 |**Name**|**Type**|**Documentation**
1828 |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.
1829
1830 //**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.
1831
1832 Derivation:
1833
1834 * //ReferenceType// (restriction)
1835 ** //MaintainableReferenceBaseType//
1836
1837 Content:
1838 ( (Ref, URN?) | URN)
1839
1840 Element Documentation:
1841
1842 |**Name**|**Type**|**Documentation**
1843 |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.
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 |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.
1846
1847 **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.
1848
1849 Derivation:
1850
1851 * //ReferenceType// (restriction)
1852 ** //MaintainableReferenceBaseType// (restriction)
1853 *** MaintainableReferenceType
1854
1855 Content:
1856 ( (Ref, URN?) | URN)
1857
1858 Element Documentation:
1859
1860 |**Name**|**Type**|**Documentation**
1861 |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.
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 |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.
1864
1865 //**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..
1866
1867 Derivation:
1868
1869 //ReferenceType// (restriction)
1870 [[image:inherit.gif||height="9" width="9"]] //LocalIdentifiableReferenceType//
1871
1872 Content:
1873 Ref
1874
1875 Element Documentation:
1876
1877 |**Name**|**Type**|**Documentation**
1878 |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.
1879
1880 //**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.
1881
1882 Derivation:
1883
1884 * //ReferenceType// (restriction)
1885 ** //MaintainableReferenceBaseType// (restriction)
1886 *** //StructureReferenceBaseType//
1887
1888 Content:
1889 ( (Ref, URN?) | URN)
1890
1891 Element Documentation:
1892
1893 |**Name**|**Type**|**Documentation**
1894 |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.
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 |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.
1897
1898 **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.
1899
1900 Derivation:
1901
1902 * //ReferenceType// (restriction)
1903 ** //MaintainableReferenceBaseType// (restriction)
1904 *** //StructureReferenceBaseType// (restriction)
1905 **** StructureReferenceType
1906
1907 Content:
1908 ( (Ref, URN?) | URN)
1909
1910 Element Documentation:
1911
1912 |**Name**|**Type**|**Documentation**
1913 |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.
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 |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.
1916
1917 //**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.
1918
1919 Derivation:
1920
1921 * //ReferenceType// (restriction)
1922 ** //MaintainableReferenceBaseType// (restriction)
1923 *** //StructureUsageReferenceBaseType//
1924
1925 Content:
1926 ( (Ref, URN?) | URN)
1927
1928 Element Documentation:
1929
1930 |**Name**|**Type**|**Documentation**
1931 |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.
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 |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.
1934
1935 **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.
1936
1937 Derivation:
1938
1939 * //ReferenceType// (restriction)
1940 ** //MaintainableReferenceBaseType// (restriction)
1941 *** //StructureUsageReferenceBaseType// (restriction)
1942 **** StructureUsageReferenceType
1943
1944 Content:
1945 ( (Ref, URN?) | URN)
1946
1947 Element Documentation:
1948
1949 |**Name**|**Type**|**Documentation**
1950 |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.
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 |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.
1953
1954 //**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.
1955
1956 Derivation:
1957
1958 * //ReferenceType// (restriction)
1959 ** //MaintainableReferenceBaseType// (restriction)
1960 *** //ItemSchemeReferenceBaseType//
1961
1962 Content:
1963 ( (Ref, URN?) | URN)
1964
1965 Element Documentation:
1966
1967 |**Name**|**Type**|**Documentation**
1968 |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.
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 |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.
1971
1972 **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.
1973
1974 Derivation:
1975
1976 * //ReferenceType// (restriction)
1977 ** //MaintainableReferenceBaseType// (restriction)
1978 *** //ItemSchemeReferenceBaseType// (restriction)
1979 **** ItemSchemeReferenceType
1980
1981 Content:
1982 ( (Ref, URN?) | URN)
1983
1984 Element Documentation:
1985
1986 |**Name**|**Type**|**Documentation**
1987 |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.
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 |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.
1990
1991 //**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).
1992
1993 Derivation:
1994
1995 * //ReferenceType// (restriction)
1996 ** //ChildObjectReferenceType//
1997
1998 Content:
1999 ( (Ref, URN?) | URN)
2000
2001 Element Documentation:
2002
2003 |**Name**|**Type**|**Documentation**
2004 |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.
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 |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.
2007
2008 //**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).
2009
2010 Derivation:
2011
2012 * //ReferenceType// (restriction)
2013 ** //ContainerChildObjectReferenceType//
2014
2015 Content:
2016 ( (Ref, URN?) | URN)
2017
2018 Element Documentation:
2019
2020 |**Name**|**Type**|**Documentation**
2021 |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.
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 |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.
2024
2025 //**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).
2026
2027 Derivation:
2028
2029 * //ReferenceType// (restriction)
2030 ** //ChildObjectReferenceType// (restriction)
2031 *** //ItemReferenceType//
2032
2033 Content:
2034 ( (Ref, URN?) | URN)
2035
2036 Element Documentation:
2037
2038 |**Name**|**Type**|**Documentation**
2039 |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.
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 |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.
2042
2043 //**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).
2044
2045 Derivation:
2046
2047 * //ReferenceType// (restriction)
2048 ** //ChildObjectReferenceType// (restriction)
2049 *** //ComponentListReferenceType//
2050
2051 Content:
2052 ( (Ref, URN?) | URN)
2053
2054 Element Documentation:
2055
2056 |**Name**|**Type**|**Documentation**
2057 |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.
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 |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.
2060
2061 //**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).
2062
2063 Derivation:
2064
2065 * //ReferenceType// (restriction)
2066 ** //ContainerChildObjectReferenceType// (restriction)
2067 *** //ComponentReferenceType//
2068
2069 Content:
2070 ( (Ref, URN?) | URN)
2071
2072 Element Documentation:
2073
2074 |**Name**|**Type**|**Documentation**
2075 |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.
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 |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.
2078
2079 //**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.
2080
2081 Derivation:
2082
2083 * //ReferenceType// (restriction)
2084 ** //LocalItemReferenceType//
2085
2086 Content:
2087 Ref
2088
2089 Element Documentation:
2090
2091 |**Name**|**Type**|**Documentation**
2092 |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.
2093
2094 //**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.
2095
2096 Derivation:
2097
2098 * //ReferenceType// (restriction)
2099 ** //LocalComponentListReferenceType//
2100
2101 Content:
2102 Ref
2103
2104 Element Documentation:
2105
2106 |**Name**|**Type**|**Documentation**
2107 |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.
2108
2109 //**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.
2110
2111 Derivation:
2112
2113 * //ReferenceType// (restriction)
2114 ** //LocalComponentListComponentReferenceBaseType//
2115
2116 Content:
2117 Ref
2118
2119 Element Documentation:
2120
2121 |**Name**|**Type**|**Documentation**
2122 |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.
2123
2124 **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.
2125
2126 Derivation:
2127
2128 * //ReferenceType// (restriction)
2129 ** //LocalComponentListComponentReferenceBaseType// (restriction)
2130 *** LocalComponentListComponentReferenceType
2131
2132 Content:
2133 Ref
2134
2135 Element Documentation:
2136
2137 |**Name**|**Type**|**Documentation**
2138 |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.
2139
2140 //**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.
2141
2142 Derivation:
2143
2144 * //ReferenceType// (restriction)
2145 ** //LocalComponentListComponentReferenceBaseType// (restriction)
2146 *** //LocalComponentReferenceBaseType//
2147
2148 Content:
2149 Ref
2150
2151 Element Documentation:
2152
2153 |**Name**|**Type**|**Documentation**
2154 |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.
2155
2156 **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.
2157
2158 Derivation:
2159
2160 * //ReferenceType// (restriction)
2161 ** //LocalComponentListComponentReferenceBaseType// (restriction)
2162 *** LocalComponentReferenceType
2163
2164 Content:
2165 Ref
2166
2167 Element Documentation:
2168
2169 |**Name**|**Type**|**Documentation**
2170 |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.
2171
2172 **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.
2173
2174 Derivation:
2175
2176 * //ReferenceType// (restriction)
2177 ** //MaintainableReferenceBaseType// (restriction)
2178 *** StructureOrUsageReferenceType
2179
2180 Content:
2181 ( (Ref, URN?) | URN)
2182
2183 Element Documentation:
2184
2185 |**Name**|**Type**|**Documentation**
2186 |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.
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 |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.
2189
2190 **CategorisationReferenceType: **CategorisationReferenceType is a type for referencing a categorisation object. It consists of a URN and/or a complete set of reference fields.
2191
2192 Derivation:
2193
2194 * //ReferenceType// (restriction)
2195 ** //MaintainableReferenceBaseType// (restriction)
2196 *** CategorisationReferenceType
2197
2198 Content:
2199 ( (Ref, URN?) | URN)
2200
2201 Element Documentation:
2202
2203 |**Name**|**Type**|**Documentation**
2204 |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.
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 |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.
2207
2208 **CategorisationRefType: **CategorisationRefType provides a reference to a categorisation via a complete set of reference fields.
2209
2210 Derivation:
2211
2212 * //RefBaseType// (restriction)
2213 ** //MaintainableRefBaseType// (restriction)
2214 *** CategorisationRefType
2215
2216 Attributes:
2217 agencyID, id, version?, local?, class?, package?
2218
2219 Content:
2220 {Empty}
2221
2222 Attribute Documentation:
2223
2224 |**Name**|**Type**|**Documentation**
2225 |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.
2226 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
2227 |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.
2228 |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.
2229 |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.
2230 |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.
2231
2232 **CategorySchemeReferenceType: **CategorySchemeReferenceType is a type for referencing a category scheme object. It consists of a URN and/or a complete set of reference fields.
2233
2234 Derivation:
2235
2236 * //ReferenceType// (restriction)
2237 ** //MaintainableReferenceBaseType// (restriction)
2238 *** //ItemSchemeReferenceBaseType// (restriction)
2239 **** CategorySchemeReferenceType
2240
2241 Content:
2242 ( (Ref, URN?) | URN)
2243
2244 Element Documentation:
2245
2246 |**Name**|**Type**|**Documentation**
2247 |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.
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 |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.
2250
2251 **CategorySchemeRefType: **CategorySchemeRefType provides a reference to a category scheme via a complete set of reference fields.
2252
2253 Derivation:
2254
2255 * //RefBaseType// (restriction)
2256 ** //MaintainableRefBaseType// (restriction)
2257 *** //ItemSchemeRefBaseType// (restriction)
2258 **** CategorySchemeRefType
2259
2260 Attributes:
2261 agencyID, id, version?, local?, class?, package?
2262
2263 Content:
2264 {Empty}
2265
2266 Attribute Documentation:
2267
2268 |**Name**|**Type**|**Documentation**
2269 |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.
2270 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
2271 |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.
2272 |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.
2273 |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.
2274 |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.
2275
2276 **CategoryReferenceType: **CategoryReferenceType is a type for referencing a category object. It consists of a URN and/or a complete set of reference fields.
2277
2278 Derivation:
2279
2280 * //ReferenceType// (restriction)
2281 ** //ChildObjectReferenceType// (restriction)
2282 *** //ItemReferenceType// (restriction)
2283 **** CategoryReferenceType
2284
2285 Content:
2286 ( (Ref, URN?) | URN)
2287
2288 Element Documentation:
2289
2290 |**Name**|**Type**|**Documentation**
2291 |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.
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 |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.
2294
2295 **CategoryRefType: **CategoryRefType references a category from within a category scheme. Reference fields are required for both the scheme and the item.
2296
2297 Derivation:
2298
2299 * //RefBaseType// (restriction)
2300 ** //ChildObjectRefBaseType// (restriction)
2301 *** //ItemRefBaseType// (restriction)
2302 **** CategoryRefType
2303
2304 Attributes:
2305 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
2306
2307 Content:
2308 {Empty}
2309
2310 Attribute Documentation:
2311
2312 |**Name**|**Type**|**Documentation**
2313 |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.
2314 |maintainableParentID|IDType|The maintainableParentID references the category scheme in which the category being referenced is defined.
2315 |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.
2316 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
2317 |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.
2318 |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.
2319 |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.
2320
2321 **LocalCategoryReferenceType: **LocalCategoryReferenceType provides a simple references to a category where the identification of the category scheme which defines it is contained in another context.
2322
2323 Derivation:
2324
2325 * //ReferenceType// (restriction)
2326 ** //LocalItemReferenceType// (restriction)
2327 *** LocalCategoryReferenceType
2328
2329 Content:
2330 Ref
2331
2332 Element Documentation:
2333
2334 |**Name**|**Type**|**Documentation**
2335 |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.
2336
2337 **LocalCategoryRefType: **LocalCategoryRefType references a category locally where the references to the category scheme which defines it is provided elsewhere.
2338
2339 Derivation:
2340
2341 * //RefBaseType// (restriction)
2342 ** //LocalIdentifiableRefBaseType// (restriction)
2343 *** //LocalItemRefBaseType// (restriction)
2344 **** LocalCategoryRefType
2345
2346 Attributes:
2347 id, local?, class?, package?
2348
2349 Content:
2350 {Empty}
2351
2352 Attribute Documentation:
2353
2354 |**Name**|**Type**|**Documentation**
2355 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
2356 |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.
2357 |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.
2358 |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.
2359
2360 **CodelistReferenceType: **CodelistReferenceType is a type for referencing a codelist object. It consists of a URN and/or a complete set of reference fields.
2361
2362 Derivation:
2363
2364 * //ReferenceType// (restriction)
2365 ** //MaintainableReferenceBaseType// (restriction)
2366 *** //ItemSchemeReferenceBaseType// (restriction)
2367 **** CodelistReferenceType
2368
2369 Content:
2370 ( (Ref, URN?) | URN)
2371
2372 Element Documentation:
2373
2374 |**Name**|**Type**|**Documentation**
2375 |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.
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 |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.
2378
2379 **CodelistRefType: **CodelistRefType provides a reference to a codelist via a complete set of reference fields.
2380
2381 Derivation:
2382
2383 * //RefBaseType// (restriction)
2384 ** //MaintainableRefBaseType// (restriction)
2385 *** //ItemSchemeRefBaseType// (restriction)
2386 **** CodelistRefType
2387
2388 Attributes:
2389 agencyID, id, version?, local?, class?, package?
2390
2391 Content:
2392 {Empty}
2393
2394 Attribute Documentation:
2395
2396 |**Name**|**Type**|**Documentation**
2397 |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.
2398 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
2399 |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.
2400 |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.
2401 |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.
2402 |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.
2403
2404 **CodeReferenceType: **CodeReferenceType is a type for referencing a code object. It consists of a URN and/or a complete set of reference fields.
2405
2406 Derivation:
2407
2408 * //ReferenceType// (restriction)
2409 ** //ChildObjectReferenceType// (restriction)
2410 *** //ItemReferenceType// (restriction)
2411 **** CodeReferenceType
2412
2413 Content:
2414 ( (Ref, URN?) | URN)
2415
2416 Element Documentation:
2417
2418 |**Name**|**Type**|**Documentation**
2419 |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.
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 |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.
2422
2423 **CodeRefType: **CodeRefType references a code from within a codelist. Reference fields are required for both the scheme and the item.
2424
2425 Derivation:
2426
2427 * //RefBaseType// (restriction)
2428 ** //ChildObjectRefBaseType// (restriction)
2429 *** //ItemRefBaseType// (restriction)
2430 **** CodeRefType
2431
2432 Attributes:
2433 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
2434
2435 Content:
2436 {Empty}
2437
2438 Attribute Documentation:
2439
2440 |**Name**|**Type**|**Documentation**
2441 |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.
2442 |maintainableParentID|IDType|The maintainableParentID references the codelist in which the code being referenced is defined.
2443 |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.
2444 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
2445 |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.
2446 |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.
2447 |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.
2448
2449 **LocalCodeReferenceType: **LocalCodeReferenceType provides a simple references to a code where the identification of the codelist which defines it is contained in another context.
2450
2451 Derivation:
2452
2453 * //ReferenceType// (restriction)
2454 ** //LocalItemReferenceType// (restriction)
2455 *** LocalCodeReferenceType
2456
2457 Content:
2458 Ref
2459
2460 Element Documentation:
2461
2462 |**Name**|**Type**|**Documentation**
2463 |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.
2464
2465 **LocalCodeRefType: **LocalCodeRefType references a code locally where the references to the codelist which defines it is provided elsewhere.
2466
2467 Derivation:
2468
2469 * //RefBaseType// (restriction)
2470 ** //LocalIdentifiableRefBaseType// (restriction)
2471 *** //LocalItemRefBaseType// (restriction)
2472 **** LocalCodeRefType
2473
2474 Attributes:
2475 id, local?, class?, package?
2476
2477 Content:
2478 {Empty}
2479
2480 Attribute Documentation:
2481
2482 |**Name**|**Type**|**Documentation**
2483 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
2484 |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.
2485 |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.
2486 |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.
2487
2488 **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.
2489
2490 Derivation:
2491
2492 * //ReferenceType// (restriction)
2493 ** //MaintainableReferenceBaseType// (restriction)
2494 *** AnyCodelistReferenceType
2495
2496 Content:
2497 ( (Ref, URN?) | URN)
2498
2499 Element Documentation:
2500
2501 |**Name**|**Type**|**Documentation**
2502 |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.
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 |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.
2505
2506 **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.
2507
2508 Derivation:
2509
2510 * //ReferenceType// (restriction)
2511 ** AnyLocalCodeReferenceType
2512
2513 Content:
2514 ( (Ref, URN?) | URN)
2515
2516 Element Documentation:
2517
2518 |**Name**|**Type**|**Documentation**
2519 |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.
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 |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.
2522
2523 **ConceptSchemeReferenceType: **ConceptSchemeReferenceType is a type for referencing a concept scheme object. It consists of a URN and/or a complete set of reference fields.
2524
2525 Derivation:
2526
2527 * //ReferenceType// (restriction)
2528 ** //MaintainableReferenceBaseType// (restriction)
2529 *** //ItemSchemeReferenceBaseType// (restriction)
2530 **** ConceptSchemeReferenceType
2531
2532 Content:
2533 ( (Ref, URN?) | URN)
2534
2535 Element Documentation:
2536
2537 |**Name**|**Type**|**Documentation**
2538 |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.
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 |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.
2541
2542 **ConceptSchemeRefType: **ConceptSchemeRefType provides a reference to a concept scheme via a complete set of reference fields.
2543
2544 Derivation:
2545
2546 * //RefBaseType// (restriction)
2547 ** //MaintainableRefBaseType// (restriction)
2548 *** //ItemSchemeRefBaseType// (restriction)
2549 **** ConceptSchemeRefType
2550
2551 Attributes:
2552 agencyID, id, version?, local?, class?, package?
2553
2554 Content:
2555 {Empty}
2556
2557 Attribute Documentation:
2558
2559 |**Name**|**Type**|**Documentation**
2560 |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.
2561 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
2562 |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.
2563 |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.
2564 |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.
2565 |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.
2566
2567 **ConceptReferenceType: **ConceptReferenceType is a type for referencing a concept object. It consists of a URN and/or a complete set of reference fields.
2568
2569 Derivation:
2570
2571 * //ReferenceType// (restriction)
2572 ** //ChildObjectReferenceType// (restriction)
2573 *** //ItemReferenceType// (restriction)
2574 **** ConceptReferenceType
2575
2576 Content:
2577 ( (Ref, URN?) | URN)
2578
2579 Element Documentation:
2580
2581 |**Name**|**Type**|**Documentation**
2582 |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.
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 |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.
2585
2586 **ConceptRefType: **ConceptRefType references a concept from within a concept scheme. Reference fields are required for both the scheme and the item.
2587
2588 Derivation:
2589
2590 * //RefBaseType// (restriction)
2591 ** //ChildObjectRefBaseType// (restriction)
2592 *** //ItemRefBaseType// (restriction)
2593 **** ConceptRefType
2594
2595 Attributes:
2596 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
2597
2598 Content:
2599 {Empty}
2600
2601 Attribute Documentation:
2602
2603 |**Name**|**Type**|**Documentation**
2604 |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.
2605 |maintainableParentID|IDType|The maintainableParentID references the concept scheme in which the concept being referenced is defined.
2606 |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.
2607 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
2608 |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.
2609 |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.
2610 |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.
2611
2612 **LocalConceptReferenceType: **LocalConceptReferenceType provides a simple references to a concept where the identification of the concept scheme which defines it is contained in another context.
2613
2614 Derivation:
2615
2616 * //ReferenceType// (restriction)
2617 ** //LocalItemReferenceType// (restriction)
2618 *** LocalConceptReferenceType
2619
2620 Content:
2621 Ref
2622
2623 Element Documentation:
2624
2625 |**Name**|**Type**|**Documentation**
2626 |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.
2627
2628 **LocalConceptRefType: **LocalConceptRefType references a concept locally where the references to the concept scheme which defines it is provided elsewhere.
2629
2630 Derivation:
2631
2632 * //RefBaseType// (restriction)
2633 ** //LocalIdentifiableRefBaseType// (restriction)
2634 *** //LocalItemRefBaseType// (restriction)
2635 **** LocalConceptRefType
2636
2637 Attributes:
2638 id, local?, class?, package?
2639
2640 Content:
2641 {Empty}
2642
2643 Attribute Documentation:
2644
2645 |**Name**|**Type**|**Documentation**
2646 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
2647 |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.
2648 |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.
2649 |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.
2650
2651 //**OrganisationSchemeReferenceBaseType**//**: **OrganisationSchemeReferenceBaseType is a type for referencing a organisation scheme object. It consists of a URN and/or a complete set of reference fields.
2652
2653 Derivation:
2654
2655 * //ReferenceType// (restriction)
2656 ** //MaintainableReferenceBaseType// (restriction)
2657 *** //ItemSchemeReferenceBaseType// (restriction)
2658 **** //OrganisationSchemeReferenceBaseType//
2659
2660 Content:
2661 ( (Ref, URN?) | URN)
2662
2663 Element Documentation:
2664
2665 |**Name**|**Type**|**Documentation**
2666 |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.
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 |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.
2669
2670 //**OrganisationSchemeRefBaseType**//**: **OrganisationSchemeRefBaseType contains a set of reference fields for an organisation scheme.
2671
2672 Derivation:
2673
2674 * //RefBaseType// (restriction)
2675 ** //MaintainableRefBaseType// (restriction)
2676 *** //ItemSchemeRefBaseType// (restriction)
2677 **** //OrganisationSchemeRefBaseType//
2678
2679 Attributes:
2680 agencyID, id, version?, local?, class?, package?
2681
2682 Content:
2683 {Empty}
2684
2685 Attribute Documentation:
2686
2687 |**Name**|**Type**|**Documentation**
2688 |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.
2689 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
2690 |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.
2691 |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.
2692 |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.
2693 |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.
2694
2695 **OrganisationSchemeReferenceType: **OrganisationSchemeReferenceType references an organisation scheme regardless of the specific type. It consists of a URN and/or a complete set of reference fields.
2696
2697 Derivation:
2698
2699 * //ReferenceType// (restriction)
2700 ** //MaintainableReferenceBaseType// (restriction)
2701 *** //ItemSchemeReferenceBaseType// (restriction)
2702 **** //OrganisationSchemeReferenceBaseType// (restriction)
2703 ***** OrganisationSchemeReferenceType
2704
2705 Content:
2706 ( (Ref, URN?) | URN)
2707
2708 Element Documentation:
2709
2710 |**Name**|**Type**|**Documentation**
2711 |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.
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 |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.
2714
2715 **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.
2716
2717 Derivation:
2718
2719 * //RefBaseType// (restriction)
2720 ** //MaintainableRefBaseType// (restriction)
2721 *** //ItemSchemeRefBaseType// (restriction)
2722 **** //OrganisationSchemeRefBaseType// (restriction)
2723 ***** OrganisationSchemeRefType
2724
2725 Attributes:
2726 agencyID, id, version?, local?, class, package?
2727
2728 Content:
2729 {Empty}
2730
2731 Attribute Documentation:
2732
2733 |**Name**|**Type**|**Documentation**
2734 |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.
2735 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
2736 |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.
2737 |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.
2738 |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.
2739 |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.
2740
2741 //**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.
2742
2743 Derivation:
2744
2745 * //ReferenceType// (restriction)
2746 ** //ChildObjectReferenceType// (restriction)
2747 *** //ItemReferenceType// (restriction)
2748 **** //OrganisationReferenceBaseType//
2749
2750 Content:
2751 ( (Ref, URN?) | URN)
2752
2753 Element Documentation:
2754
2755 |**Name**|**Type**|**Documentation**
2756 |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.
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 |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.
2759
2760 //**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.
2761
2762 Derivation:
2763
2764 * //RefBaseType// (restriction)
2765 ** //ChildObjectRefBaseType// (restriction)
2766 *** //ItemRefBaseType// (restriction)
2767 **** //OrganisationRefBaseType//
2768
2769 Attributes:
2770 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
2771
2772 Content:
2773 {Empty}
2774
2775 Attribute Documentation:
2776
2777 |**Name**|**Type**|**Documentation**
2778 |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.
2779 |maintainableParentID|IDType|The maintainableParentID references the organisation scheme in which the organisation being referenced is defined.
2780 |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.
2781 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
2782 |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.
2783 |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.
2784 |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.
2785
2786 **OrganisationReferenceType: **OrganisationReferenceType references an organisation regardless of the specific type. It consists of a URN and/or a complete set of reference fields.
2787
2788 Derivation:
2789
2790 * //ReferenceType// (restriction)
2791 ** //ChildObjectReferenceType// (restriction)
2792 *** //ItemReferenceType// (restriction)
2793 **** //OrganisationReferenceBaseType// (restriction)
2794 ***** OrganisationReferenceType
2795
2796 Content:
2797 ( (Ref, URN?) | URN)
2798
2799 Element Documentation:
2800
2801 |**Name**|**Type**|**Documentation**
2802 |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.
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 |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.
2805
2806 **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.
2807
2808 Derivation:
2809
2810 * //RefBaseType// (restriction)
2811 ** //ChildObjectRefBaseType// (restriction)
2812 *** //ItemRefBaseType// (restriction)
2813 **** //OrganisationRefBaseType// (restriction)
2814 ***** OrganisationRefType
2815
2816 Attributes:
2817 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class, package?
2818
2819 Content:
2820 {Empty}
2821
2822 Attribute Documentation:
2823
2824 |**Name**|**Type**|**Documentation**
2825 |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.
2826 |maintainableParentID|IDType|The maintainableParentID references the organisation scheme in which the organisation being referenced is defined.
2827 |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.
2828 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
2829 |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.
2830 |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.
2831 |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.
2832
2833 //**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.
2834
2835 Derivation:
2836
2837 * //ReferenceType// (restriction)
2838 ** //LocalItemReferenceType// (restriction)
2839 *** //LocalOrganisationReferenceBaseType//
2840
2841 Content:
2842 Ref
2843
2844 Element Documentation:
2845
2846 |**Name**|**Type**|**Documentation**
2847 |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.
2848
2849 //**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.
2850
2851 Derivation:
2852
2853 * //RefBaseType// (restriction)
2854 ** //LocalIdentifiableRefBaseType// (restriction)
2855 *** //LocalItemRefBaseType// (restriction)
2856 **** //LocalOrganisationRefBaseType//
2857
2858 Attributes:
2859 id, local?, class?, package?
2860
2861 Content:
2862 {Empty}
2863
2864 Attribute Documentation:
2865
2866 |**Name**|**Type**|**Documentation**
2867 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
2868 |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.
2869 |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.
2870 |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.
2871
2872 **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.
2873
2874 Derivation:
2875
2876 * //ReferenceType// (restriction)
2877 ** //LocalItemReferenceType// (restriction)
2878 *** //LocalOrganisationReferenceBaseType// (restriction)
2879 **** LocalOrganisationReferenceType
2880
2881 Content:
2882 Ref
2883
2884 Element Documentation:
2885
2886 |**Name**|**Type**|**Documentation**
2887 |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.
2888
2889 **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.
2890
2891 Derivation:
2892
2893 * //RefBaseType// (restriction)
2894 ** //LocalIdentifiableRefBaseType// (restriction)
2895 *** //LocalItemRefBaseType// (restriction)
2896 **** //LocalOrganisationRefBaseType// (restriction)
2897 ***** LocalOrganisationRefType
2898
2899 Attributes:
2900 id, local?, class?, package?
2901
2902 Content:
2903 {Empty}
2904
2905 Attribute Documentation:
2906
2907 |**Name**|**Type**|**Documentation**
2908 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
2909 |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.
2910 |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.
2911 |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.
2912
2913 **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.
2914
2915 Derivation:
2916
2917 * //ReferenceType// (restriction)
2918 ** //MaintainableReferenceBaseType// (restriction)
2919 *** //ItemSchemeReferenceBaseType// (restriction)
2920 **** //OrganisationSchemeReferenceBaseType// (restriction)
2921 ***** OrganisationUnitSchemeReferenceType
2922
2923 Content:
2924 ( (Ref, URN?) | URN)
2925
2926 Element Documentation:
2927
2928 |**Name**|**Type**|**Documentation**
2929 |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.
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 |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.
2932
2933 **OrganisationUnitSchemeRefType: **OrganisationUnitSchemeRefType contains a set of reference fields for an organisation unit scheme.
2934
2935 Derivation:
2936
2937 * //RefBaseType// (restriction)
2938 ** //MaintainableRefBaseType// (restriction)
2939 *** //ItemSchemeRefBaseType// (restriction)
2940 **** //OrganisationSchemeRefBaseType// (restriction)
2941 ***** OrganisationUnitSchemeRefType
2942
2943 Attributes:
2944 agencyID, id, version?, local?, class?, package?
2945
2946 Content:
2947 {Empty}
2948
2949 Attribute Documentation:
2950
2951 |**Name**|**Type**|**Documentation**
2952 |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.
2953 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
2954 |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.
2955 |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.
2956 |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.
2957 |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.
2958
2959 **OrganisationUnitReferenceType: **OrganisationUnitReferenceType is a type for referencing an organisation unit. It consists of a URN and/or a complete set of reference fields.
2960
2961 Derivation:
2962
2963 * //ReferenceType// (restriction)
2964 ** //ChildObjectReferenceType// (restriction)
2965 *** //ItemReferenceType// (restriction)
2966 **** //OrganisationReferenceBaseType// (restriction)
2967 ***** OrganisationUnitReferenceType
2968
2969 Content:
2970 ( (Ref, URN?) | URN)
2971
2972 Element Documentation:
2973
2974 |**Name**|**Type**|**Documentation**
2975 |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.
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 |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.
2978
2979 **OrganisationUnitRefType: **OrganisationUnitRefType contains a set of reference fields for referencing an organisation unit within an organisation unit scheme.
2980
2981 Derivation:
2982
2983 * //RefBaseType// (restriction)
2984 ** //ChildObjectRefBaseType// (restriction)
2985 *** //ItemRefBaseType// (restriction)
2986 **** //OrganisationRefBaseType// (restriction)
2987 ***** OrganisationUnitRefType
2988
2989 Attributes:
2990 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
2991
2992 Content:
2993 {Empty}
2994
2995 Attribute Documentation:
2996
2997 |**Name**|**Type**|**Documentation**
2998 |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.
2999 |maintainableParentID|IDType|The maintainableParentID references the organisation scheme in which the organisation being referenced is defined.
3000 |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.
3001 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
3002 |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.
3003 |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.
3004 |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.
3005
3006 **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.
3007
3008 Derivation:
3009
3010 * //ReferenceType// (restriction)
3011 ** //LocalItemReferenceType// (restriction)
3012 *** //LocalOrganisationReferenceBaseType// (restriction)
3013 **** LocalOrganisationUnitReferenceType
3014
3015 Content:
3016 Ref
3017
3018 Element Documentation:
3019
3020 |**Name**|**Type**|**Documentation**
3021 |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.
3022
3023 **LocalOrganisationUnitRefType: **LocalOrganisationUnitRefType references an organisation unit locally where the reference to the organisation unit scheme which defines it is provided elsewhere.
3024
3025 Derivation:
3026
3027 * //RefBaseType// (restriction)
3028 ** //LocalIdentifiableRefBaseType// (restriction)
3029 *** //LocalItemRefBaseType// (restriction)
3030 **** //LocalOrganisationRefBaseType// (restriction)
3031 ***** LocalOrganisationUnitRefType
3032
3033 Attributes:
3034 id, local?, class?, package?
3035
3036 Content:
3037 {Empty}
3038
3039 Attribute Documentation:
3040
3041 |**Name**|**Type**|**Documentation**
3042 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
3043 |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.
3044 |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.
3045 |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.
3046
3047 **AgencySchemeReferenceType: **AgencySchemeReferenceType is a type for referencing an agency scheme object. It consists of a URN and/or a complete set of reference fields.
3048
3049 Derivation:
3050
3051 * //ReferenceType// (restriction)
3052 ** //MaintainableReferenceBaseType// (restriction)
3053 *** //ItemSchemeReferenceBaseType// (restriction)
3054 **** //OrganisationSchemeReferenceBaseType// (restriction)
3055 ***** AgencySchemeReferenceType
3056
3057 Content:
3058 ( (Ref, URN?) | URN)
3059
3060 Element Documentation:
3061
3062 |**Name**|**Type**|**Documentation**
3063 |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.
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 |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.
3066
3067 **AgencySchemeRefType: **AgencySchemeRefType contains a set of reference fields for an agency scheme.
3068
3069 Derivation:
3070
3071 * //RefBaseType// (restriction)
3072 ** //MaintainableRefBaseType// (restriction)
3073 *** //ItemSchemeRefBaseType// (restriction)
3074 **** //OrganisationSchemeRefBaseType// (restriction)
3075 ***** AgencySchemeRefType
3076
3077 Attributes:
3078 agencyID, id, version?, local?, class?, package?
3079
3080 Content:
3081 {Empty}
3082
3083 Attribute Documentation:
3084
3085 |**Name**|**Type**|**Documentation**
3086 |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.
3087 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
3088 |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.
3089 |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.
3090 |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.
3091 |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.
3092
3093 **AgencyReferenceType: **AgencyReferenceType is a type for referencing an agency. It consists of a URN and/or a complete set of reference fields.
3094
3095 Derivation:
3096
3097 * //ReferenceType// (restriction)
3098 ** //ChildObjectReferenceType// (restriction)
3099 *** //ItemReferenceType// (restriction)
3100 **** //OrganisationReferenceBaseType// (restriction)
3101 ***** AgencyReferenceType
3102
3103 Content:
3104 ( (Ref, URN?) | URN)
3105
3106 Element Documentation:
3107
3108 |**Name**|**Type**|**Documentation**
3109 |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.
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 |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.
3112
3113 **AgencyRefType: **AgencyRefType contains a set of reference fields for referencing an agency within an agency scheme.
3114
3115 Derivation:
3116
3117 * //RefBaseType// (restriction)
3118 ** //ChildObjectRefBaseType// (restriction)
3119 *** //ItemRefBaseType// (restriction)
3120 **** //OrganisationRefBaseType// (restriction)
3121 ***** AgencyRefType
3122
3123 Attributes:
3124 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
3125
3126 Content:
3127 {Empty}
3128
3129 Attribute Documentation:
3130
3131 |**Name**|**Type**|**Documentation**
3132 |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.
3133 |maintainableParentID|IDType|The maintainableParentID references the organisation scheme in which the organisation being referenced is defined.
3134 |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.
3135 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
3136 |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.
3137 |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.
3138 |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.
3139
3140 **LocalAgencyReferenceType: **LocalAgencyReferenceType provides a simple reference to an agency, where the reference to the agency scheme which defines it is provided in another context.
3141
3142 Derivation:
3143
3144 * //ReferenceType// (restriction)
3145 ** //LocalItemReferenceType// (restriction)
3146 *** //LocalOrganisationReferenceBaseType// (restriction)
3147 **** LocalAgencyReferenceType
3148
3149 Content:
3150 Ref
3151
3152 Element Documentation:
3153
3154 |**Name**|**Type**|**Documentation**
3155 |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.
3156
3157 **LocalAgencyRefType: **LocalAgencyRefType references an agency locally where the reference to the agency scheme which defines it is provided elsewhere.
3158
3159 Derivation:
3160
3161 * //RefBaseType// (restriction)
3162 ** //LocalIdentifiableRefBaseType// (restriction)
3163 *** //LocalItemRefBaseType// (restriction)
3164 **** //LocalOrganisationRefBaseType// (restriction)
3165 ***** LocalAgencyRefType
3166
3167 Attributes:
3168 id, local?, class?, package?
3169
3170 Content:
3171 {Empty}
3172
3173 Attribute Documentation:
3174
3175 |**Name**|**Type**|**Documentation**
3176 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
3177 |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.
3178 |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.
3179 |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.
3180
3181 **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.
3182
3183 Derivation:
3184
3185 * //ReferenceType// (restriction)
3186 ** //MaintainableReferenceBaseType// (restriction)
3187 *** //ItemSchemeReferenceBaseType// (restriction)
3188 **** //OrganisationSchemeReferenceBaseType// (restriction)
3189 ***** DataConsumerSchemeReferenceType
3190
3191 Content:
3192 ( (Ref, URN?) | URN)
3193
3194 Element Documentation:
3195
3196 |**Name**|**Type**|**Documentation**
3197 |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.
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 |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.
3200
3201 **DataConsumerSchemeRefType: **DataConsumerSchemeRefType contains a set of reference fields for a data consumer scheme.
3202
3203 Derivation:
3204
3205 * //RefBaseType// (restriction)
3206 ** //MaintainableRefBaseType// (restriction)
3207 *** //ItemSchemeRefBaseType// (restriction)
3208 **** //OrganisationSchemeRefBaseType// (restriction)
3209 ***** DataConsumerSchemeRefType
3210
3211 Attributes:
3212 agencyID, id, version?, local?, class?, package?
3213
3214 Content:
3215 {Empty}
3216
3217 Attribute Documentation:
3218
3219 |**Name**|**Type**|**Documentation**
3220 |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.
3221 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
3222 |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.
3223 |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.
3224 |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.
3225 |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.
3226
3227 **DataConsumerReferenceType: **DataConsumerReferenceType is a type for referencing a data consumer. It consists of a URN and/or a complete set of reference fields.
3228
3229 Derivation:
3230
3231 * //ReferenceType// (restriction)
3232 ** //ChildObjectReferenceType// (restriction)
3233 *** //ItemReferenceType// (restriction)
3234 **** //OrganisationReferenceBaseType// (restriction)
3235 ***** DataConsumerReferenceType
3236
3237 Content:
3238 ( (Ref, URN?) | URN)
3239
3240 Element Documentation:
3241
3242 |**Name**|**Type**|**Documentation**
3243 |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.
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 |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.
3246
3247 **DataConsumerRefType: **DataConsumerRefType contains a set of reference fields for referencing a data consumer within a data consumer scheme.
3248
3249 Derivation:
3250
3251 * //RefBaseType// (restriction)
3252 ** //ChildObjectRefBaseType// (restriction)
3253 *** //ItemRefBaseType// (restriction)
3254 **** //OrganisationRefBaseType// (restriction)
3255 ***** DataConsumerRefType
3256
3257 Attributes:
3258 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
3259
3260 Content:
3261 {Empty}
3262
3263 Attribute Documentation:
3264
3265 |**Name**|**Type**|**Documentation**
3266 |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.
3267 |maintainableParentID|IDType|The maintainableParentID references the organisation scheme in which the organisation being referenced is defined.
3268 |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.
3269 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
3270 |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.
3271 |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.
3272 |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.
3273
3274 **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.
3275
3276 Derivation:
3277
3278 * //ReferenceType// (restriction)
3279 ** //LocalItemReferenceType// (restriction)
3280 *** //LocalOrganisationReferenceBaseType// (restriction)
3281 **** LocalDataConsumerReferenceType
3282
3283 Content:
3284 Ref
3285
3286 Element Documentation:
3287
3288 |**Name**|**Type**|**Documentation**
3289 |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.
3290
3291 **LocalDataConsumerRefType: **LocalDataConsumerRefType references a data consumer locally where the reference to the data consumer scheme which defines it is provided elsewhere.
3292
3293 Derivation:
3294
3295 * //RefBaseType// (restriction)
3296 ** //LocalIdentifiableRefBaseType// (restriction)
3297 *** //LocalItemRefBaseType// (restriction)
3298 **** //LocalOrganisationRefBaseType// (restriction)
3299 ***** LocalDataConsumerRefType
3300
3301 Attributes:
3302 id, local?, class?, package?
3303
3304 Content:
3305 {Empty}
3306
3307 Attribute Documentation:
3308
3309 |**Name**|**Type**|**Documentation**
3310 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
3311 |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.
3312 |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.
3313 |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.
3314
3315 **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.
3316
3317 Derivation:
3318
3319 * //ReferenceType// (restriction)
3320 ** //MaintainableReferenceBaseType// (restriction)
3321 *** //ItemSchemeReferenceBaseType// (restriction)
3322 **** //OrganisationSchemeReferenceBaseType// (restriction)
3323 ***** DataProviderSchemeReferenceType
3324
3325 Content:
3326 ( (Ref, URN?) | URN)
3327
3328 Element Documentation:
3329
3330 |**Name**|**Type**|**Documentation**
3331 |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.
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 |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.
3334
3335 **DataProviderSchemeRefType: **DataProviderSchemeRefType contains a set of reference fields for a data provider scheme.
3336
3337 Derivation:
3338
3339 * //RefBaseType// (restriction)
3340 ** //MaintainableRefBaseType// (restriction)
3341 *** //ItemSchemeRefBaseType// (restriction)
3342 **** //OrganisationSchemeRefBaseType// (restriction)
3343 ***** DataProviderSchemeRefType
3344
3345 Attributes:
3346 agencyID, id, version?, local?, class?, package?
3347
3348 Content:
3349 {Empty}
3350
3351 Attribute Documentation:
3352
3353 |**Name**|**Type**|**Documentation**
3354 |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.
3355 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
3356 |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.
3357 |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.
3358 |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.
3359 |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.
3360
3361 **DataProviderReferenceType: **DataProviderReferenceType is a type for referencing a data provider. It consists of a URN and/or a complete set of reference fields.
3362
3363 Derivation:
3364
3365 * //ReferenceType// (restriction)
3366 ** //ChildObjectReferenceType// (restriction)
3367 *** //ItemReferenceType// (restriction)
3368 **** //OrganisationReferenceBaseType// (restriction)
3369 ***** DataProviderReferenceType
3370
3371 Content:
3372 ( (Ref, URN?) | URN)
3373
3374 Element Documentation:
3375
3376 |**Name**|**Type**|**Documentation**
3377 |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.
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 |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.
3380
3381 **DataProviderRefType: **DataProviderRefType contains a set of reference fields for referencing a data provider within a data provider scheme.
3382
3383 Derivation:
3384
3385 * //RefBaseType// (restriction)
3386 ** //ChildObjectRefBaseType// (restriction)
3387 *** //ItemRefBaseType// (restriction)
3388 **** //OrganisationRefBaseType// (restriction)
3389 ***** DataProviderRefType
3390
3391 Attributes:
3392 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
3393
3394 Content:
3395 {Empty}
3396
3397 Attribute Documentation:
3398
3399 |**Name**|**Type**|**Documentation**
3400 |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.
3401 |maintainableParentID|IDType|The maintainableParentID references the organisation scheme in which the organisation being referenced is defined.
3402 |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.
3403 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
3404 |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.
3405 |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.
3406 |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.
3407
3408 **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.
3409
3410 Derivation:
3411
3412 * //ReferenceType// (restriction)
3413 ** //LocalItemReferenceType// (restriction)
3414 *** //LocalOrganisationReferenceBaseType// (restriction)
3415 **** LocalDataProviderReferenceType
3416
3417 Content:
3418 Ref
3419
3420 Element Documentation:
3421
3422 |**Name**|**Type**|**Documentation**
3423 |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.
3424
3425 **LocalDataProviderRefType: **LocalDataProviderRefType references a data provider locally where the reference to the data provider scheme which defines it is provided elsewhere.
3426
3427 Derivation:
3428
3429 * //RefBaseType// (restriction)
3430 ** //LocalIdentifiableRefBaseType// (restriction)
3431 *** //LocalItemRefBaseType// (restriction)
3432 **** //LocalOrganisationRefBaseType// (restriction)
3433 ***** LocalDataProviderRefType
3434
3435 Attributes:
3436 id, local?, class?, package?
3437
3438 Content:
3439 {Empty}
3440
3441 Attribute Documentation:
3442
3443 |**Name**|**Type**|**Documentation**
3444 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
3445 |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.
3446 |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.
3447 |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.
3448
3449 **ReportingTaxonomyReferenceType: **ReportingTaxonomyReferenceType is a type for referencing a reporting taxonomy object. It consists of a URN and/or a complete set of reference fields.
3450
3451 Derivation:
3452
3453 * //ReferenceType// (restriction)
3454 ** //MaintainableReferenceBaseType// (restriction)
3455 *** //ItemSchemeReferenceBaseType// (restriction)
3456 **** ReportingTaxonomyReferenceType
3457
3458 Content:
3459 ( (Ref, URN?) | URN)
3460
3461 Element Documentation:
3462
3463 |**Name**|**Type**|**Documentation**
3464 |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.
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 |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.
3467
3468 **ReportingTaxonomyRefType: **ReportingTaxonomyRefType provides a reference to a reporting taxonomy via a complete set of reference fields.
3469
3470 Derivation:
3471
3472 * //RefBaseType// (restriction)
3473 ** //MaintainableRefBaseType// (restriction)
3474 *** //ItemSchemeRefBaseType// (restriction)
3475 **** ReportingTaxonomyRefType
3476
3477 Attributes:
3478 agencyID, id, version?, local?, class?, package?
3479
3480 Content:
3481 {Empty}
3482
3483 Attribute Documentation:
3484
3485 |**Name**|**Type**|**Documentation**
3486 |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.
3487 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
3488 |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.
3489 |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.
3490 |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.
3491 |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.
3492
3493 **ReportingCategoryReferenceType: **ReportingCategoryReferenceType is a type for referencing a reporting category object. It consists of a URN and/or a complete set of reference fields.
3494
3495 Derivation:
3496
3497 * //ReferenceType// (restriction)
3498 ** //ChildObjectReferenceType// (restriction)
3499 *** //ItemReferenceType// (restriction)
3500 **** ReportingCategoryReferenceType
3501
3502 Content:
3503 ( (Ref, URN?) | URN)
3504
3505 Element Documentation:
3506
3507 |**Name**|**Type**|**Documentation**
3508 |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.
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 |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.
3511
3512 **ReportCategoryRefType: **ReportCategoryRefType contains a set of fields for referencing a reporting category within a reporting taxonomy.
3513
3514 Derivation:
3515
3516 * //RefBaseType// (restriction)
3517 ** //ChildObjectRefBaseType// (restriction)
3518 *** //ItemRefBaseType// (restriction)
3519 **** ReportCategoryRefType
3520
3521 Attributes:
3522 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
3523
3524 Content:
3525 {Empty}
3526
3527 Attribute Documentation:
3528
3529 |**Name**|**Type**|**Documentation**
3530 |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.
3531 |maintainableParentID|IDType|The maintainableParentID references the reporting taxonomy in which the reporting category being referenced is defined.
3532 |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.
3533 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
3534 |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.
3535 |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.
3536 |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.
3537
3538 **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.
3539
3540 Derivation:
3541
3542 * //ReferenceType// (restriction)
3543 ** //LocalItemReferenceType// (restriction)
3544 *** LocalReportingCategoryReferenceType
3545
3546 Content:
3547 Ref
3548
3549 Element Documentation:
3550
3551 |**Name**|**Type**|**Documentation**
3552 |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.
3553
3554 **LocalReportingCategoryRefType: **LocalReportingCategoryRefType references a reporting category locally where the references to the reporting taxonomy which defines it is provided elsewhere.
3555
3556 Derivation:
3557
3558 * //RefBaseType// (restriction)
3559 ** //LocalIdentifiableRefBaseType// (restriction)
3560 *** //LocalItemRefBaseType// (restriction)
3561 **** LocalReportingCategoryRefType
3562
3563 Attributes:
3564 id, local?, class?, package?
3565
3566 Content:
3567 {Empty}
3568
3569 Attribute Documentation:
3570
3571 |**Name**|**Type**|**Documentation**
3572 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
3573 |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.
3574 |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.
3575 |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.
3576
3577 **HierarchicalCodelistReferenceType: **HierarchicalCodelistReferenceType is a type for referencing a hierarchical codelist object. It consists of a URN and/or a complete set of reference fields.
3578
3579 Derivation:
3580
3581 * //ReferenceType// (restriction)
3582 ** //MaintainableReferenceBaseType// (restriction)
3583 *** HierarchicalCodelistReferenceType
3584
3585 Content:
3586 ( (Ref, URN?) | URN)
3587
3588 Element Documentation:
3589
3590 |**Name**|**Type**|**Documentation**
3591 |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.
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 |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.
3594
3595 **HierarchicalCodelistRefType: **HierarchicalCodelistRefType contains a set of reference fields for a hierarchical codelist.
3596
3597 Derivation:
3598
3599 * //RefBaseType// (restriction)
3600 ** //MaintainableRefBaseType// (restriction)
3601 *** HierarchicalCodelistRefType
3602
3603 Attributes:
3604 agencyID, id, version?, local?, class?, package?
3605
3606 Content:
3607 {Empty}
3608
3609 Attribute Documentation:
3610
3611 |**Name**|**Type**|**Documentation**
3612 |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.
3613 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
3614 |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.
3615 |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.
3616 |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.
3617 |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.
3618
3619 **HierarchyReferenceType: **HierarchyReferenceType is a type for referencing a hierarchy within a hierarchical codelist.
3620
3621 Derivation:
3622
3623 * //ReferenceType// (restriction)
3624 ** //ChildObjectReferenceType// (restriction)
3625 *** HierarchyReferenceType
3626
3627 Content:
3628 ( (Ref, URN?) | URN)
3629
3630 Element Documentation:
3631
3632 |**Name**|**Type**|**Documentation**
3633 |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.
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 |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.
3636
3637 **HierarchyRefType: **HierarchyRefType is type which references a hierarchy from within a hierarchical codelist. Reference fields are required for both the hierarchy and the codelist.
3638
3639 Derivation:
3640
3641 * //RefBaseType// (restriction)
3642 ** //ChildObjectRefBaseType// (restriction)
3643 *** HierarchyRefType
3644
3645 Attributes:
3646 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
3647
3648 Content:
3649 {Empty}
3650
3651 Attribute Documentation:
3652
3653 |**Name**|**Type**|**Documentation**
3654 |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.
3655 |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.
3656 |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.
3657 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
3658 |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.
3659 |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.
3660 |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.
3661
3662 **LevelReferenceType: **LevelReferenceType is a type for referencing a level object. It consists of a URN and/or a complete set of reference fields.
3663
3664 Derivation:
3665
3666 * //ReferenceType// (restriction)
3667 ** //ChildObjectReferenceType// (restriction)
3668 *** LevelReferenceType
3669
3670 Content:
3671 ( (Ref, URN?) | URN)
3672
3673 Element Documentation:
3674
3675 |**Name**|**Type**|**Documentation**
3676 |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.
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 |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.
3679
3680 **LevelRefType: **LevelRefType references a level from within a hierarchical codelist. Reference fields are required for both the level and the codelist.
3681
3682 Derivation:
3683
3684 * //RefBaseType// (restriction)
3685 ** //ChildObjectRefBaseType// (restriction)
3686 *** LevelRefType
3687
3688 Attributes:
3689 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
3690
3691 Content:
3692 {Empty}
3693
3694 Attribute Documentation:
3695
3696 |**Name**|**Type**|**Documentation**
3697 |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.
3698 |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.
3699 |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.
3700 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
3701 |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.
3702 |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.
3703 |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.
3704
3705 **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).
3706
3707 Derivation:
3708
3709 * //ReferenceType// (restriction)
3710 ** LocalLevelReferenceType
3711
3712 Content:
3713 Ref
3714
3715 Element Documentation:
3716
3717 |**Name**|**Type**|**Documentation**
3718 |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.
3719
3720 **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.
3721
3722 Derivation:
3723
3724 * //RefBaseType// (restriction)
3725 ** //LocalIdentifiableRefBaseType// (restriction)
3726 *** LocalLevelRefType
3727
3728 Attributes:
3729 containerID?, id, local?, class?, package?
3730
3731 Content:
3732 {Empty}
3733
3734 Attribute Documentation:
3735
3736 |**Name**|**Type**|**Documentation**
3737 |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.
3738 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
3739 |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.
3740 |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.
3741 |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.
3742
3743 **HierarchicalCodeReferenceType: **HierarchicalCodeReferenceType is a type for referencing a hierarchical code object. It consists of a URN and/or a complete set of reference fields.
3744
3745 Derivation:
3746
3747 * //ReferenceType// (restriction)
3748 ** //ContainerChildObjectReferenceType// (restriction)
3749 *** HierarchicalCodeReferenceType
3750
3751 Content:
3752 ( (Ref, URN?) | URN)
3753
3754 Element Documentation:
3755
3756 |**Name**|**Type**|**Documentation**
3757 |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.
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 |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.
3760
3761 **HierarchicalCodeRefType: **HierarchicalCodeRefType references a code from within a hierarchical codelist. Reference fields are required for both the code and the codelist.
3762
3763 Derivation:
3764
3765 * //RefBaseType// (restriction)
3766 ** //ContainerChildObjectRefBaseType// (restriction)
3767 *** HierarchicalCodeRefType
3768
3769 Attributes:
3770 agencyID, maintainableParentID, maintainableParentVersion?, containerID, id, version?, local?, class?, package?
3771
3772 Content:
3773 {Empty}
3774
3775 Attribute Documentation:
3776
3777 |**Name**|**Type**|**Documentation**
3778 |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.
3779 |maintainableParentID|IDType|The maintainableParentID references the hierarchical codelist in which the code being referenced is defined.
3780 |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.
3781 |containerID|IDType|The containerID references the hierarchy which contains the code being referenced is defined.
3782 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
3783 |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.
3784 |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.
3785 |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.
3786 |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.
3787
3788 **ConstraintReferenceType: **ConstraintReferenceType is a type for referencing a constraint object. It consists of a URN and/or a complete set of reference fields.
3789
3790 Derivation:
3791
3792 * //ReferenceType// (restriction)
3793 ** //MaintainableReferenceBaseType// (restriction)
3794 *** ConstraintReferenceType
3795
3796 Content:
3797 ( (Ref, URN?) | URN)
3798
3799 Element Documentation:
3800
3801 |**Name**|**Type**|**Documentation**
3802 |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.
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 |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.
3805
3806 //**ConstraintRefType**//**: **ConstraintRefType contains a set of reference fields for a constraint.
3807
3808 Derivation:
3809
3810 * //RefBaseType// (restriction)
3811 ** //MaintainableRefBaseType// (restriction)
3812 *** //ConstraintRefType//
3813
3814 Attributes:
3815 agencyID, id, version?, local?, class?, package?
3816
3817 Content:
3818 {Empty}
3819
3820 Attribute Documentation:
3821
3822 |**Name**|**Type**|**Documentation**
3823 |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.
3824 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
3825 |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.
3826 |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.
3827 |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.
3828 |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.
3829
3830 **AttachmentConstraintReferenceType: **AttachmentConstraintReferenceType is a type for referencing a attachment constraint object. It consists of a URN and/or a complete set of reference fields.
3831
3832 Derivation:
3833
3834 * //ReferenceType// (restriction)
3835 ** //MaintainableReferenceBaseType// (restriction)
3836 *** ConstraintReferenceType (restriction)
3837 **** AttachmentConstraintReferenceType
3838
3839 Content:
3840 ( (Ref, URN?) | URN)
3841
3842 Element Documentation:
3843
3844 |**Name**|**Type**|**Documentation**
3845 |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.
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 |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.
3848
3849 **AttachmentConstraintRefType: **AttachmentConstraintRefType contains a set of reference fields for an attachment constraint.
3850
3851 Derivation:
3852
3853 * //RefBaseType// (restriction)
3854 ** //MaintainableRefBaseType// (restriction)
3855 *** //ConstraintRefType// (restriction)
3856 **** AttachmentConstraintRefType
3857
3858 Attributes:
3859 agencyID, id, version?, local?, class?, package?
3860
3861 Content:
3862 {Empty}
3863
3864 Attribute Documentation:
3865
3866 |**Name**|**Type**|**Documentation**
3867 |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.
3868 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
3869 |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.
3870 |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.
3871 |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.
3872 |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.
3873
3874 **ContentConstraintReferenceType: **ContentConstraintReferenceType is a type for referencing a content constraint object. It consists of a URN and/or a complete set of reference fields.
3875
3876 Derivation:
3877
3878 * //ReferenceType// (restriction)
3879 ** //MaintainableReferenceBaseType// (restriction)
3880 *** ConstraintReferenceType (restriction)
3881 **** ContentConstraintReferenceType
3882
3883 Content:
3884 ( (Ref, URN?) | URN)
3885
3886 Element Documentation:
3887
3888 |**Name**|**Type**|**Documentation**
3889 |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.
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 |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.
3892
3893 **ContentConstraintRefType: **ContentConstraintRefType contains a set of reference fields for a content constraint.
3894
3895 Derivation:
3896
3897 * //RefBaseType// (restriction)
3898 ** //MaintainableRefBaseType// (restriction)
3899 *** //ConstraintRefType// (restriction)
3900 **** ContentConstraintRefType
3901
3902 Attributes:
3903 agencyID, id, version?, local?, class?, package?
3904
3905 Content:
3906 {Empty}
3907
3908 Attribute Documentation:
3909
3910 |**Name**|**Type**|**Documentation**
3911 |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.
3912 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
3913 |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.
3914 |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.
3915 |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.
3916 |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.
3917
3918 **DataflowReferenceType: **DataflowReferenceType is a type for referencing a dataflow object. It consists of a URN and/or a complete set of reference fields.
3919
3920 Derivation:
3921
3922 * //ReferenceType// (restriction)
3923 ** //MaintainableReferenceBaseType// (restriction)
3924 *** //StructureUsageReferenceBaseType// (restriction)
3925 **** DataflowReferenceType
3926
3927 Content:
3928 ( (Ref, URN?) | URN)
3929
3930 Element Documentation:
3931
3932 |**Name**|**Type**|**Documentation**
3933 |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.
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 |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.
3936
3937 **DataflowRefType: **DataflowRefType contains a set of reference fields for a data flow.
3938
3939 Derivation:
3940 //RefBaseType// (restriction)
3941 [[image:inherit.gif||height="9" width="9"]] //MaintainableRefBaseType// (restriction)
3942 [[image:inherit.gif||height="9" width="9"]] //StructureOrUsageRefBaseType// (restriction)
3943 [[image:inherit.gif||height="9" width="9"]] //StructureUsageRefBaseType// (restriction)
3944 [[image:inherit.gif||height="9" width="9"]] DataflowRefType
3945
3946 Attributes:
3947 agencyID, id, version?, local?, class?, package?
3948
3949 Content:
3950 {Empty}
3951
3952 Attribute Documentation:
3953
3954 |**Name**|**Type**|**Documentation**
3955 |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.
3956 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
3957 |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.
3958 |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.
3959 |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.
3960 |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.
3961
3962 **MetadataflowReferenceType: **MetadataflowReferenceType is a type for referencing a metadata flow object. It consists of a URN and/or a complete set of reference fields.
3963
3964 Derivation:
3965 //ReferenceType// (restriction)
3966 [[image:inherit.gif||height="9" width="9"]] //MaintainableReferenceBaseType// (restriction)
3967 [[image:inherit.gif||height="9" width="9"]] //StructureUsageReferenceBaseType// (restriction)
3968 [[image:inherit.gif||height="9" width="9"]] MetadataflowReferenceType
3969
3970 Content:
3971 ( (Ref, URN?) | URN)
3972
3973 Element Documentation:
3974
3975 |**Name**|**Type**|**Documentation**
3976 |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.
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 |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.
3979
3980 **MetadataflowRefType: **MetadataflowRefType contains a set of reference fields for a metadata flow.
3981
3982 Derivation:
3983 //RefBaseType// (restriction)
3984 [[image:inherit.gif||height="9" width="9"]] //MaintainableRefBaseType// (restriction)
3985 [[image:inherit.gif||height="9" width="9"]] //StructureOrUsageRefBaseType// (restriction)
3986 [[image:inherit.gif||height="9" width="9"]] //StructureUsageRefBaseType// (restriction)
3987 [[image:inherit.gif||height="9" width="9"]] MetadataflowRefType
3988
3989 Attributes:
3990 agencyID, id, version?, local?, class?, package?
3991
3992 Content:
3993 {Empty}
3994
3995 Attribute Documentation:
3996
3997 |**Name**|**Type**|**Documentation**
3998 |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.
3999 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
4000 |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.
4001 |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.
4002 |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.
4003 |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.
4004
4005 **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.
4006
4007 Derivation:
4008 //ReferenceType// (restriction)
4009 [[image:inherit.gif||height="9" width="9"]] //MaintainableReferenceBaseType// (restriction)
4010 [[image:inherit.gif||height="9" width="9"]] //StructureReferenceBaseType// (restriction)
4011 [[image:inherit.gif||height="9" width="9"]] DataStructureReferenceType
4012
4013 Content:
4014 ( (Ref, URN?) | URN)
4015
4016 Element Documentation:
4017
4018 |**Name**|**Type**|**Documentation**
4019 |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.
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 |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.
4022
4023 **DataStructureRefType: **DataStructureRefType contains a set of reference fields for a data structure definition.
4024
4025 Derivation:
4026 //RefBaseType// (restriction)
4027 [[image:inherit.gif||height="9" width="9"]] //MaintainableRefBaseType// (restriction)
4028 [[image:inherit.gif||height="9" width="9"]] //StructureOrUsageRefBaseType// (restriction)
4029 [[image:inherit.gif||height="9" width="9"]] //StructureRefBaseType// (restriction)
4030 [[image:inherit.gif||height="9" width="9"]] DataStructureRefType
4031
4032 Attributes:
4033 agencyID, id, version?, local?, class?, package?
4034
4035 Content:
4036 {Empty}
4037
4038 Attribute Documentation:
4039
4040 |**Name**|**Type**|**Documentation**
4041 |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.
4042 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
4043 |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.
4044 |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.
4045 |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.
4046 |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.
4047
4048 **KeyDescriptorReferenceType: **KeyDescriptorReferenceType is a type for referencing a key descriptor object. It consists of a URN and/or a complete set of reference fields.
4049
4050 Derivation:
4051 //ReferenceType// (restriction)
4052 [[image:inherit.gif||height="9" width="9"]] //ChildObjectReferenceType// (restriction)
4053 [[image:inherit.gif||height="9" width="9"]] //ComponentListReferenceType// (restriction)
4054 [[image:inherit.gif||height="9" width="9"]] KeyDescriptorReferenceType
4055
4056 Content:
4057 ( (Ref, URN?) | URN)
4058
4059 Element Documentation:
4060
4061 |**Name**|**Type**|**Documentation**
4062 |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.
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 |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.
4065
4066 **KeyDescriptorRefType: **KeyDescriptorRefType contains a reference to the key descriptor within a data structure definition.
4067
4068 Derivation:
4069 //RefBaseType// (restriction)
4070 [[image:inherit.gif||height="9" width="9"]] //ChildObjectRefBaseType// (restriction)
4071 [[image:inherit.gif||height="9" width="9"]] //ComponentListRefBaseType// (restriction)
4072 [[image:inherit.gif||height="9" width="9"]] KeyDescriptorRefType
4073
4074 Attributes:
4075 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
4076
4077 Content:
4078 {Empty}
4079
4080 Attribute Documentation:
4081
4082 |**Name**|**Type**|**Documentation**
4083 |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.
4084 |maintainableParentID|IDType|The maintainableParentID references the structure in which the component list being referenced is defined.
4085 |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.
4086 |id (fixed: DIMENSION_DESCRIPTOR)|IDType|The id attribute identifies the object being referenced, and is therefore always required.
4087 |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.
4088 |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.
4089 |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.
4090
4091 **AttributeDescriptorReferenceType: **AttributeDescriptorReferenceType is a type for referencing an attribute descriptor object. It consists of a URN and/or a complete set of reference fields.
4092
4093 Derivation:
4094 //ReferenceType// (restriction)
4095 [[image:inherit.gif||height="9" width="9"]] //ChildObjectReferenceType// (restriction)
4096 [[image:inherit.gif||height="9" width="9"]] //ComponentListReferenceType// (restriction)
4097 [[image:inherit.gif||height="9" width="9"]] AttributeDescriptorReferenceType
4098
4099 Content:
4100 ( (Ref, URN?) | URN)
4101
4102 Element Documentation:
4103
4104 |**Name**|**Type**|**Documentation**
4105 |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.
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 |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.
4108
4109 **AttributeDescriptorRefType: **AttributeDescriptorRefType contains a reference to the attribute descriptor within a data structure definition.
4110
4111 Derivation:
4112 //RefBaseType// (restriction)
4113 [[image:inherit.gif||height="9" width="9"]] //ChildObjectRefBaseType// (restriction)
4114 [[image:inherit.gif||height="9" width="9"]] //ComponentListRefBaseType// (restriction)
4115 [[image:inherit.gif||height="9" width="9"]] AttributeDescriptorRefType
4116
4117 Attributes:
4118 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
4119
4120 Content:
4121 {Empty}
4122
4123 Attribute Documentation:
4124
4125 |**Name**|**Type**|**Documentation**
4126 |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.
4127 |maintainableParentID|IDType|The maintainableParentID references the structure in which the component list being referenced is defined.
4128 |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.
4129 |id (fixed: ATTRIBUTE_DESCRIPTOR)|IDType|The id attribute identifies the object being referenced, and is therefore always required.
4130 |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.
4131 |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.
4132 |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.
4133
4134 **MeasureDescriptorReferenceType: **MeasureDescriptorReferenceType is a type for referencing a measure descriptor object. It consists of a URN and/or a complete set of reference fields.
4135
4136 Derivation:
4137 //ReferenceType// (restriction)
4138 [[image:inherit.gif||height="9" width="9"]] //ChildObjectReferenceType// (restriction)
4139 [[image:inherit.gif||height="9" width="9"]] //ComponentListReferenceType// (restriction)
4140 [[image:inherit.gif||height="9" width="9"]] MeasureDescriptorReferenceType
4141
4142 Content:
4143 ( (Ref, URN?) | URN)
4144
4145 Element Documentation:
4146
4147 |**Name**|**Type**|**Documentation**
4148 |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.
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 |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.
4151
4152 **MeasureDescriptorRefType: **MeasureDescriptorRefType contains a reference to the measure descriptor within a data structure definition.
4153
4154 Derivation:
4155 //RefBaseType// (restriction)
4156 [[image:inherit.gif||height="9" width="9"]] //ChildObjectRefBaseType// (restriction)
4157 [[image:inherit.gif||height="9" width="9"]] //ComponentListRefBaseType// (restriction)
4158 [[image:inherit.gif||height="9" width="9"]] MeasureDescriptorRefType
4159
4160 Attributes:
4161 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
4162
4163 Content:
4164 {Empty}
4165
4166 Attribute Documentation:
4167
4168 |**Name**|**Type**|**Documentation**
4169 |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.
4170 |maintainableParentID|IDType|The maintainableParentID references the structure in which the component list being referenced is defined.
4171 |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.
4172 |id (fixed: MEASURE_DESCRIPTOR)|IDType|The id attribute identifies the object being referenced, and is therefore always required.
4173 |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.
4174 |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.
4175 |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.
4176
4177 **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.
4178
4179 Derivation:
4180 //ReferenceType// (restriction)
4181 [[image:inherit.gif||height="9" width="9"]] //ChildObjectReferenceType// (restriction)
4182 [[image:inherit.gif||height="9" width="9"]] //ComponentListReferenceType// (restriction)
4183 [[image:inherit.gif||height="9" width="9"]] GroupKeyDescriptorReferenceType
4184
4185 Content:
4186 ( (Ref, URN?) | URN)
4187
4188 Element Documentation:
4189
4190 |**Name**|**Type**|**Documentation**
4191 |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.
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 |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.
4194
4195 **GroupKeyDescriptorRefType: **GroupKeyDescriptorRefType contains a reference to a group key descriptor within a data structure definition.
4196
4197 Derivation:
4198 //RefBaseType// (restriction)
4199 [[image:inherit.gif||height="9" width="9"]] //ChildObjectRefBaseType// (restriction)
4200 [[image:inherit.gif||height="9" width="9"]] //ComponentListRefBaseType// (restriction)
4201 [[image:inherit.gif||height="9" width="9"]] GroupKeyDescriptorRefType
4202
4203 Attributes:
4204 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
4205
4206 Content:
4207 {Empty}
4208
4209 Attribute Documentation:
4210
4211 |**Name**|**Type**|**Documentation**
4212 |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.
4213 |maintainableParentID|IDType|The maintainableParentID references the structure in which the component list being referenced is defined.
4214 |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.
4215 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
4216 |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.
4217 |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.
4218 |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.
4219
4220 **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).
4221
4222 Derivation:
4223 //ReferenceType// (restriction)
4224 [[image:inherit.gif||height="9" width="9"]] //LocalComponentListReferenceType// (restriction)
4225 [[image:inherit.gif||height="9" width="9"]] LocalGroupKeyDescriptorReferenceType
4226
4227 Content:
4228 Ref
4229
4230 Element Documentation:
4231
4232 |**Name**|**Type**|**Documentation**
4233 |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.
4234
4235 **LocalGroupKeyDescriptorRefType: **LocalGroupKeyDescriptorRefType contains a local reference to a group key descriptor.
4236
4237 Derivation:
4238 //RefBaseType// (restriction)
4239 [[image:inherit.gif||height="9" width="9"]] //LocalIdentifiableRefBaseType// (restriction)
4240 [[image:inherit.gif||height="9" width="9"]] //LocalComponentListRefBaseType// (restriction)
4241 [[image:inherit.gif||height="9" width="9"]] LocalGroupKeyDescriptorRefType
4242
4243 Attributes:
4244 id, local?, class?, package?
4245
4246 Content:
4247 {Empty}
4248
4249 Attribute Documentation:
4250
4251 |**Name**|**Type**|**Documentation**
4252 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
4253 |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.
4254 |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.
4255 |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.
4256
4257 **DimensionReferenceType: **DimensionReferenceType is a type for referencing a dimension object. It consists of a URN and/or a complete set of reference fields.
4258
4259 Derivation:
4260 //ReferenceType// (restriction)
4261 [[image:inherit.gif||height="9" width="9"]] //ContainerChildObjectReferenceType// (restriction)
4262 [[image:inherit.gif||height="9" width="9"]] //ComponentReferenceType// (restriction)
4263 [[image:inherit.gif||height="9" width="9"]] DimensionReferenceType
4264
4265 Content:
4266 ( (Ref, URN?) | URN)
4267
4268 Element Documentation:
4269
4270 |**Name**|**Type**|**Documentation**
4271 |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.
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 |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.
4274
4275 **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.
4276
4277 Derivation:
4278 //RefBaseType// (restriction)
4279 [[image:inherit.gif||height="9" width="9"]] //ContainerChildObjectRefBaseType// (restriction)
4280 [[image:inherit.gif||height="9" width="9"]] //ComponentRefBaseType// (restriction)
4281 [[image:inherit.gif||height="9" width="9"]] DimensionRefType
4282
4283 Attributes:
4284 agencyID, maintainableParentID, maintainableParentVersion?, id, version?, local?, class?, package?
4285
4286 Content:
4287 {Empty}
4288
4289 Attribute Documentation:
4290
4291 |**Name**|**Type**|**Documentation**
4292 |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.
4293 |maintainableParentID|IDType|The maintainableParentID references the structure in which the component being referenced is defined.
4294 |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.
4295 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
4296 |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.
4297 |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.
4298 |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.
4299 |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.
4300
4301 **MeasureDimensionReferenceType: **MeasureDimensionReferenceType is a type for referencing a measure dimension object. It consists of a URN and/or a complete set of reference fields.
4302
4303 Derivation:
4304 //ReferenceType// (restriction)
4305 [[image:inherit.gif||height="9" width="9"]] //ContainerChildObjectReferenceType// (restriction)
4306 [[image:inherit.gif||height="9" width="9"]] //ComponentReferenceType// (restriction)
4307 [[image:inherit.gif||height="9" width="9"]] MeasureDimensionReferenceType
4308
4309 Content:
4310 ( (Ref, URN?) | URN)
4311
4312 Element Documentation:
4313
4314 |**Name**|**Type**|**Documentation**
4315 |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.
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 |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.
4318
4319 **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.
4320
4321 Derivation:
4322 //RefBaseType// (restriction)
4323 [[image:inherit.gif||height="9" width="9"]] //ContainerChildObjectRefBaseType// (restriction)
4324 [[image:inherit.gif||height="9" width="9"]] //ComponentRefBaseType// (restriction)
4325 [[image:inherit.gif||height="9" width="9"]] MeasureDimensionRefType
4326
4327 Attributes:
4328 agencyID, maintainableParentID, maintainableParentVersion?, id, version?, local?, class?, package?
4329
4330 Content:
4331 {Empty}
4332
4333 Attribute Documentation:
4334
4335 |**Name**|**Type**|**Documentation**
4336 |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.
4337 |maintainableParentID|IDType|The maintainableParentID references the structure in which the component being referenced is defined.
4338 |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.
4339 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
4340 |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.
4341 |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.
4342 |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.
4343 |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.
4344
4345 **TimeDimensionReferenceType: **TimeDimensionReferenceType is a type for referencing a time dimension object. It consists of a URN and/or a complete set of reference fields.
4346
4347 Derivation:
4348 //ReferenceType// (restriction)
4349 [[image:inherit.gif||height="9" width="9"]] //ContainerChildObjectReferenceType// (restriction)
4350 [[image:inherit.gif||height="9" width="9"]] //ComponentReferenceType// (restriction)
4351 [[image:inherit.gif||height="9" width="9"]] TimeDimensionReferenceType
4352
4353 Content:
4354 ( (Ref, URN?) | URN)
4355
4356 Element Documentation:
4357
4358 |**Name**|**Type**|**Documentation**
4359 |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.
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 |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.
4362
4363 **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.
4364
4365 Derivation:
4366 //RefBaseType// (restriction)
4367 [[image:inherit.gif||height="9" width="9"]] //ContainerChildObjectRefBaseType// (restriction)
4368 [[image:inherit.gif||height="9" width="9"]] //ComponentRefBaseType// (restriction)
4369 [[image:inherit.gif||height="9" width="9"]] TimeDimensionRefType
4370
4371 Attributes:
4372 agencyID, maintainableParentID, maintainableParentVersion?, id, version?, local?, class?, package?
4373
4374 Content:
4375 {Empty}
4376
4377 Attribute Documentation:
4378
4379 |**Name**|**Type**|**Documentation**
4380 |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.
4381 |maintainableParentID|IDType|The maintainableParentID references the structure in which the component being referenced is defined.
4382 |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.
4383 |id (fixed: TIME_PERIOD)|IDType|The id attribute identifies the object being referenced, and is therefore always required.
4384 |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.
4385 |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.
4386 |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.
4387 |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.
4388
4389 **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).
4390
4391 Derivation:
4392 //ReferenceType// (restriction)
4393 [[image:inherit.gif||height="9" width="9"]] //LocalComponentListComponentReferenceBaseType// (restriction)
4394 [[image:inherit.gif||height="9" width="9"]] //LocalComponentReferenceBaseType// (restriction)
4395 [[image:inherit.gif||height="9" width="9"]] LocalDimensionReferenceType
4396
4397 Content:
4398 Ref
4399
4400 Element Documentation:
4401
4402 |**Name**|**Type**|**Documentation**
4403 |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.
4404
4405 **LocalDimensionRefType: **LocalDimensionRefType contains the reference fields for referencing a dimension locally.
4406
4407 Derivation:
4408 //RefBaseType// (restriction)
4409 [[image:inherit.gif||height="9" width="9"]] //LocalIdentifiableRefBaseType// (restriction)
4410 [[image:inherit.gif||height="9" width="9"]] //LocalComponentListComponentRefBaseType// (restriction)
4411 [[image:inherit.gif||height="9" width="9"]] //LocalComponentRefBaseType// (restriction)
4412 [[image:inherit.gif||height="9" width="9"]] LocalDimensionRefType
4413
4414 Attributes:
4415 id, local?, class?, package?
4416
4417 Content:
4418 {Empty}
4419
4420 Attribute Documentation:
4421
4422 |**Name**|**Type**|**Documentation**
4423 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
4424 |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.
4425 |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.
4426 |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.
4427
4428 **AttributeReferenceType: **AttributeReferenceType is a type for referencing an attribute object. It consists of a URN and/or a complete set of reference fields.
4429
4430 Derivation:
4431 //ReferenceType// (restriction)
4432 [[image:inherit.gif||height="9" width="9"]] //ContainerChildObjectReferenceType// (restriction)
4433 [[image:inherit.gif||height="9" width="9"]] //ComponentReferenceType// (restriction)
4434 [[image:inherit.gif||height="9" width="9"]] AttributeReferenceType
4435
4436 Content:
4437 ( (Ref, URN?) | URN)
4438
4439 Element Documentation:
4440
4441 |**Name**|**Type**|**Documentation**
4442 |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.
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 |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.
4445
4446 **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.
4447
4448 Derivation:
4449 //RefBaseType// (restriction)
4450 [[image:inherit.gif||height="9" width="9"]] //ContainerChildObjectRefBaseType// (restriction)
4451 [[image:inherit.gif||height="9" width="9"]] //ComponentRefBaseType// (restriction)
4452 [[image:inherit.gif||height="9" width="9"]] AttributeRefType
4453
4454 Attributes:
4455 agencyID, maintainableParentID, maintainableParentVersion?, id, version?, local?, class?, package?
4456
4457 Content:
4458 {Empty}
4459
4460 Attribute Documentation:
4461
4462 |**Name**|**Type**|**Documentation**
4463 |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.
4464 |maintainableParentID|IDType|The maintainableParentID references the structure in which the component being referenced is defined.
4465 |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.
4466 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
4467 |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.
4468 |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.
4469 |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.
4470 |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.
4471
4472 **PrimaryMeasureReferenceType: **PrimaryMeasureReferenceType is a type for referencing a primary measure object. It consists of a URN and/or a complete set of reference fields.
4473
4474 Derivation:
4475 //ReferenceType// (restriction)
4476 [[image:inherit.gif||height="9" width="9"]] //ContainerChildObjectReferenceType// (restriction)
4477 [[image:inherit.gif||height="9" width="9"]] //ComponentReferenceType// (restriction)
4478 [[image:inherit.gif||height="9" width="9"]] PrimaryMeasureReferenceType
4479
4480 Content:
4481 ( (Ref, URN?) | URN)
4482
4483 Element Documentation:
4484
4485 |**Name**|**Type**|**Documentation**
4486 |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.
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 |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.
4489
4490 **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.
4491
4492 Derivation:
4493
4494 //RefBaseType// (restriction)
4495 [[image:inherit.gif||height="9" width="9"]] //ContainerChildObjectRefBaseType// (restriction)
4496 [[image:inherit.gif||height="9" width="9"]] //ComponentRefBaseType// (restriction)
4497 [[image:inherit.gif||height="9" width="9"]] PrimaryMeasureRefType
4498
4499 Attributes:
4500 agencyID, maintainableParentID, maintainableParentVersion?, id, version?, local?, class?, package?
4501
4502 Content:
4503 {Empty}
4504
4505 Attribute Documentation:
4506
4507 |**Name**|**Type**|**Documentation**
4508 |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.
4509 |maintainableParentID|IDType|The maintainableParentID references the structure in which the component being referenced is defined.
4510 |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.
4511 |id (fixed: OBS_VALUE)|IDType|The id attribute identifies the object being referenced, and is therefore always required.
4512 |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.
4513 |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.
4514 |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.
4515 |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.
4516
4517 **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).
4518
4519 Derivation:
4520 //ReferenceType// (restriction)
4521 [[image:inherit.gif||height="9" width="9"]] //LocalComponentListComponentReferenceBaseType// (restriction)
4522 [[image:inherit.gif||height="9" width="9"]] //LocalComponentReferenceBaseType// (restriction)
4523 [[image:inherit.gif||height="9" width="9"]] LocalPrimaryMeasureReferenceType
4524
4525 Content:
4526 Ref
4527
4528 Element Documentation:
4529
4530 |**Name**|**Type**|**Documentation**
4531 |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.
4532
4533 **LocalPrimaryMeasureRefType: **LocalPrimaryMeasureRefType contains the reference fields for referencing a primary measure locally.
4534
4535 Derivation:
4536 //RefBaseType// (restriction)
4537 [[image:inherit.gif||height="9" width="9"]] //LocalIdentifiableRefBaseType// (restriction)
4538 [[image:inherit.gif||height="9" width="9"]] //LocalComponentListComponentRefBaseType// (restriction)
4539 [[image:inherit.gif||height="9" width="9"]] //LocalComponentRefBaseType// (restriction)
4540 [[image:inherit.gif||height="9" width="9"]] LocalPrimaryMeasureRefType
4541
4542 Attributes:
4543 id, local?, class?, package?
4544
4545 Content:
4546 {Empty}
4547
4548 Attribute Documentation:
4549
4550 |**Name**|**Type**|**Documentation**
4551 |id (fixed: OBS_VALUE)|IDType|The id attribute identifies the object being referenced, and is therefore always required.
4552 |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.
4553 |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.
4554 |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.
4555
4556 **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.
4557
4558 Derivation:
4559 //ReferenceType// (restriction)
4560 [[image:inherit.gif||height="9" width="9"]] //LocalComponentListComponentReferenceBaseType// (restriction)
4561 [[image:inherit.gif||height="9" width="9"]] LocalDataStructureComponentReferenceType
4562
4563 Content:
4564 Ref
4565
4566 Element Documentation:
4567
4568 |**Name**|**Type**|**Documentation**
4569 |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.
4570
4571 **LocalDataStructureComponentRefType: **LocalDataStructureComponentRefType contains the reference fields for referencing any data structure component locally. This reference must specify the class of the component being referenced.
4572
4573 Derivation:
4574 //RefBaseType// (restriction)
4575 [[image:inherit.gif||height="9" width="9"]] //LocalIdentifiableRefBaseType// (restriction)
4576 [[image:inherit.gif||height="9" width="9"]] //LocalComponentListComponentRefBaseType// (restriction)
4577 [[image:inherit.gif||height="9" width="9"]] LocalDataStructureComponentRefType
4578
4579 Attributes:
4580 id, local?, class, package?
4581
4582 Content:
4583 {Empty}
4584
4585 Attribute Documentation:
4586
4587 |**Name**|**Type**|**Documentation**
4588 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
4589 |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.
4590 |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.
4591 |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.
4592
4593 **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.
4594
4595 Derivation:
4596 //ReferenceType// (restriction)
4597 [[image:inherit.gif||height="9" width="9"]] //MaintainableReferenceBaseType// (restriction)
4598 [[image:inherit.gif||height="9" width="9"]] //ItemSchemeReferenceBaseType// (restriction)
4599 [[image:inherit.gif||height="9" width="9"]] ItemSchemeReferenceType (restriction)
4600 [[image:inherit.gif||height="9" width="9"]] DataStructureEnumerationSchemeReferenceType
4601
4602 Content:
4603 ( (Ref, URN?) | URN)
4604
4605 Element Documentation:
4606
4607 |**Name**|**Type**|**Documentation**
4608 |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.
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 |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.
4611
4612 **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.
4613
4614 Derivation:
4615 //RefBaseType// (restriction)
4616 [[image:inherit.gif||height="9" width="9"]] //MaintainableRefBaseType// (restriction)
4617 [[image:inherit.gif||height="9" width="9"]] //ItemSchemeRefBaseType// (restriction)
4618 [[image:inherit.gif||height="9" width="9"]] ItemSchemeRefType (restriction)
4619 [[image:inherit.gif||height="9" width="9"]] DataStructureEnumerationSchemeRefType
4620
4621 Attributes:
4622 agencyID, id, version?, local?, class, package
4623
4624 Content:
4625 {Empty}
4626
4627 Attribute Documentation:
4628
4629 |**Name**|**Type**|**Documentation**
4630 |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.
4631 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
4632 |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.
4633 |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.
4634 |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.
4635 |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.
4636
4637 **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.
4638
4639 Derivation:
4640 //ReferenceType// (restriction)
4641 [[image:inherit.gif||height="9" width="9"]] //MaintainableReferenceBaseType// (restriction)
4642 [[image:inherit.gif||height="9" width="9"]] //StructureReferenceBaseType// (restriction)
4643 [[image:inherit.gif||height="9" width="9"]] MetadataStructureReferenceType
4644
4645 Content:
4646 ( (Ref, URN?) | URN)
4647
4648 Element Documentation:
4649
4650 |**Name**|**Type**|**Documentation**
4651 |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.
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 |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.
4654
4655 **MetadataStructureRefType: **MetadataStructureRefType contains a set of reference fields for a metadata structure definition.
4656
4657 Derivation:
4658 //RefBaseType// (restriction)
4659 [[image:inherit.gif||height="9" width="9"]] //MaintainableRefBaseType// (restriction)
4660 [[image:inherit.gif||height="9" width="9"]] //StructureOrUsageRefBaseType// (restriction)
4661 [[image:inherit.gif||height="9" width="9"]] //StructureRefBaseType// (restriction)
4662 [[image:inherit.gif||height="9" width="9"]] MetadataStructureRefType
4663
4664 Attributes:
4665 agencyID, id, version?, local?, class?, package?
4666
4667 Content:
4668 {Empty}
4669
4670 Attribute Documentation:
4671
4672 |**Name**|**Type**|**Documentation**
4673 |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.
4674 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
4675 |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.
4676 |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.
4677 |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.
4678 |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.
4679
4680 **MetadataTargetReferenceType: **MetadataTargetReferenceType is a type for referencing a metadata target object. It consists of a URN and/or a complete set of reference fields.
4681
4682 Derivation:
4683 //ReferenceType// (restriction)
4684 [[image:inherit.gif||height="9" width="9"]] //ChildObjectReferenceType// (restriction)
4685 [[image:inherit.gif||height="9" width="9"]] //ComponentListReferenceType// (restriction)
4686 [[image:inherit.gif||height="9" width="9"]] MetadataTargetReferenceType
4687
4688 Content:
4689 ( (Ref, URN?) | URN)
4690
4691 Element Documentation:
4692
4693 |**Name**|**Type**|**Documentation**
4694 |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.
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 |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.
4697
4698 **MetadataTargetRefType: **MetadataTargetRefType contains a reference to a metadata target within a metadata structure definition.
4699
4700 Derivation:
4701 //RefBaseType// (restriction)
4702 [[image:inherit.gif||height="9" width="9"]] //ChildObjectRefBaseType// (restriction)
4703 [[image:inherit.gif||height="9" width="9"]] //ComponentListRefBaseType// (restriction)
4704 [[image:inherit.gif||height="9" width="9"]] MetadataTargetRefType
4705
4706 Attributes:
4707 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
4708
4709 Content:
4710 {Empty}
4711
4712 Attribute Documentation:
4713
4714 |**Name**|**Type**|**Documentation**
4715 |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.
4716 |maintainableParentID|IDType|The maintainableParentID references the structure in which the component list being referenced is defined.
4717 |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.
4718 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
4719 |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.
4720 |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.
4721 |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.
4722
4723 **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).
4724
4725 Derivation:
4726 //ReferenceType// (restriction)
4727 [[image:inherit.gif||height="9" width="9"]] //LocalComponentListReferenceType// (restriction)
4728 [[image:inherit.gif||height="9" width="9"]] LocalMetadataTargetReferenceType
4729
4730 Content:
4731 Ref
4732
4733 Element Documentation:
4734
4735 |**Name**|**Type**|**Documentation**
4736 |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.
4737
4738 **LocalMetadataTargetRefType: **LocalMetadataTargetRefType contains a local reference to a metadata target object.
4739
4740 Derivation:
4741 //RefBaseType// (restriction)
4742 [[image:inherit.gif||height="9" width="9"]] //LocalIdentifiableRefBaseType// (restriction)
4743 [[image:inherit.gif||height="9" width="9"]] //LocalComponentListRefBaseType// (restriction)
4744 [[image:inherit.gif||height="9" width="9"]] LocalMetadataTargetRefType
4745
4746 Attributes:
4747 id, local?, class?, package?
4748
4749 Content:
4750 {Empty}
4751
4752 Attribute Documentation:
4753
4754 |**Name**|**Type**|**Documentation**
4755 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
4756 |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.
4757 |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.
4758 |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.
4759
4760 **ConstraintTargetReferenceType: **ConstraintTargetReferenceType is a type for referencing a constraint target object. It consists of a URN and/or a complete set of reference fields.
4761
4762 Derivation:
4763 //ReferenceType// (restriction)
4764 [[image:inherit.gif||height="9" width="9"]] //ContainerChildObjectReferenceType// (restriction)
4765 [[image:inherit.gif||height="9" width="9"]] //ComponentReferenceType// (restriction)
4766 [[image:inherit.gif||height="9" width="9"]] ConstraintTargetReferenceType
4767
4768 Content:
4769 ( (Ref, URN?) | URN)
4770
4771 Element Documentation:
4772
4773 |**Name**|**Type**|**Documentation**
4774 |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.
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 |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.
4777
4778 **ConstraintTargetRefType: **ConstraintTargetRefType contains a reference to a constraint target within a metadata target of a data structure definition.
4779
4780 Derivation:
4781 //RefBaseType// (restriction)
4782 [[image:inherit.gif||height="9" width="9"]] //ContainerChildObjectRefBaseType// (restriction)
4783 [[image:inherit.gif||height="9" width="9"]] //ComponentRefBaseType// (restriction)
4784 [[image:inherit.gif||height="9" width="9"]] ConstraintTargetRefType
4785
4786 Attributes:
4787 agencyID, maintainableParentID, maintainableParentVersion?, containerID, id, version?, local?, class?, package?
4788
4789 Content:
4790 {Empty}
4791
4792 Attribute Documentation:
4793
4794 |**Name**|**Type**|**Documentation**
4795 |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.
4796 |maintainableParentID|IDType|The maintainableParentID references the structure in which the component being referenced is defined.
4797 |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.
4798 |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.
4799 |id (fixed: CONSTRAINT_TARGET)|IDType|The id attribute identifies the object being referenced, and is therefore always required.
4800 |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.
4801 |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.
4802 |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.
4803 |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.
4804
4805 **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.
4806
4807 Derivation:
4808 //ReferenceType// (restriction)
4809 [[image:inherit.gif||height="9" width="9"]] //ContainerChildObjectReferenceType// (restriction)
4810 [[image:inherit.gif||height="9" width="9"]] //ComponentReferenceType// (restriction)
4811 [[image:inherit.gif||height="9" width="9"]] DataSetTargetReferenceType
4812
4813 Content:
4814 ( (Ref, URN?) | URN)
4815
4816 Element Documentation:
4817
4818 |**Name**|**Type**|**Documentation**
4819 |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.
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 |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.
4822
4823 **DataSetTargetRefType: **DataSetTargetRefType contains a reference to a data set target within a metadata target of a data structure definition.
4824
4825 Derivation:
4826 //RefBaseType// (restriction)
4827 [[image:inherit.gif||height="9" width="9"]] //ContainerChildObjectRefBaseType// (restriction)
4828 [[image:inherit.gif||height="9" width="9"]] //ComponentRefBaseType// (restriction)
4829 [[image:inherit.gif||height="9" width="9"]] DataSetTargetRefType
4830
4831 Attributes:
4832 agencyID, maintainableParentID, maintainableParentVersion?, containerID, id, version?, local?, class?, package?
4833
4834 Content:
4835 {Empty}
4836
4837 Attribute Documentation:
4838
4839 |**Name**|**Type**|**Documentation**
4840 |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.
4841 |maintainableParentID|IDType|The maintainableParentID references the structure in which the component being referenced is defined.
4842 |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.
4843 |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.
4844 |id (fixed: DATA_SET_TARGET)|IDType|The id attribute identifies the object being referenced, and is therefore always required.
4845 |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.
4846 |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.
4847 |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.
4848 |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.
4849
4850 **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.
4851
4852 Derivation:
4853 //ReferenceType// (restriction)
4854 [[image:inherit.gif||height="9" width="9"]] //ContainerChildObjectReferenceType// (restriction)
4855 [[image:inherit.gif||height="9" width="9"]] //ComponentReferenceType// (restriction)
4856 [[image:inherit.gif||height="9" width="9"]] KeyDescriptorValuesTargetReferenceType
4857
4858 Content:
4859 ( (Ref, URN?) | URN)
4860
4861 Element Documentation:
4862
4863 |**Name**|**Type**|**Documentation**
4864 |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.
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 |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.
4867
4868 **KeyDescriptorValuesTargetRefType: **KeyDescriptorValuesTargetRefType contains a reference to a key descriptor values target within a metadata target of a data structure definition.
4869
4870 Derivation:
4871 //RefBaseType// (restriction)
4872 [[image:inherit.gif||height="9" width="9"]] //ContainerChildObjectRefBaseType// (restriction)
4873 [[image:inherit.gif||height="9" width="9"]] //ComponentRefBaseType// (restriction)
4874 [[image:inherit.gif||height="9" width="9"]] KeyDescriptorValuesTargetRefType
4875
4876 Attributes:
4877 agencyID, maintainableParentID, maintainableParentVersion?, containerID, id, version?, local?, class?, package?
4878
4879 Content:
4880 {Empty}
4881
4882 Attribute Documentation:
4883
4884 |**Name**|**Type**|**Documentation**
4885 |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.
4886 |maintainableParentID|IDType|The maintainableParentID references the structure in which the component being referenced is defined.
4887 |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.
4888 |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.
4889 |id (fixed: DIMENSION_DESCRIPTOR_VALUES_TARGET)|IDType|The id attribute identifies the object being referenced, and is therefore always required.
4890 |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.
4891 |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.
4892 |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.
4893 |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.
4894
4895 **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.
4896
4897 Derivation:
4898 //ReferenceType// (restriction)
4899 [[image:inherit.gif||height="9" width="9"]] //ContainerChildObjectReferenceType// (restriction)
4900 [[image:inherit.gif||height="9" width="9"]] //ComponentReferenceType// (restriction)
4901 [[image:inherit.gif||height="9" width="9"]] ReportPeriodTargetReferenceType
4902
4903 Content:
4904 ( (Ref, URN?) | URN)
4905
4906 Element Documentation:
4907
4908 |**Name**|**Type**|**Documentation**
4909 |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.
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 |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.
4912
4913 **ReportPeriodTargetRefType: **ReportPeriodTargetRefType contains a reference to a report period target within a metadata target of a data structure definition.
4914
4915 Derivation:
4916 //RefBaseType// (restriction)
4917 [[image:inherit.gif||height="9" width="9"]] //ContainerChildObjectRefBaseType// (restriction)
4918 [[image:inherit.gif||height="9" width="9"]] //ComponentRefBaseType// (restriction)
4919 [[image:inherit.gif||height="9" width="9"]] ReportPeriodTargetRefType
4920
4921 Attributes:
4922 agencyID, maintainableParentID, maintainableParentVersion?, containerID, id, version?, local?, class?, package?
4923
4924 Content:
4925 {Empty}
4926
4927 Attribute Documentation:
4928
4929 |**Name**|**Type**|**Documentation**
4930 |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.
4931 |maintainableParentID|IDType|The maintainableParentID references the structure in which the component being referenced is defined.
4932 |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.
4933 |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.
4934 |id (fixed: REPORT_PERIOD_TARGET)|IDType|The id attribute identifies the object being referenced, and is therefore always required.
4935 |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.
4936 |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.
4937 |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.
4938 |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.
4939
4940 **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.
4941
4942 Derivation:
4943 //ReferenceType// (restriction)
4944 [[image:inherit.gif||height="9" width="9"]] //ContainerChildObjectReferenceType// (restriction)
4945 [[image:inherit.gif||height="9" width="9"]] //ComponentReferenceType// (restriction)
4946 [[image:inherit.gif||height="9" width="9"]] IdentifiableObjectTargetReferenceType
4947
4948 Content:
4949 ( (Ref, URN?) | URN)
4950
4951 Element Documentation:
4952
4953 |**Name**|**Type**|**Documentation**
4954 |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.
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 |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.
4957
4958 **IdentifiableObjectTargetRefType: **IdentifiableObjectTargetRefType contains a reference to an identifiable object target within a metadata target of a data structure definition.
4959
4960 Derivation:
4961 //RefBaseType// (restriction)
4962 [[image:inherit.gif||height="9" width="9"]] //ContainerChildObjectRefBaseType// (restriction)
4963 [[image:inherit.gif||height="9" width="9"]] //ComponentRefBaseType// (restriction)
4964 [[image:inherit.gif||height="9" width="9"]] IdentifiableObjectTargetRefType
4965
4966 Attributes:
4967 agencyID, maintainableParentID, maintainableParentVersion?, containerID?, id, version?, local?, class?, package?
4968
4969 Content:
4970 {Empty}
4971
4972 Attribute Documentation:
4973
4974 |**Name**|**Type**|**Documentation**
4975 |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.
4976 |maintainableParentID|IDType|The maintainableParentID references the structure in which the component being referenced is defined.
4977 |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.
4978 |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.
4979 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
4980 |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.
4981 |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.
4982 |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.
4983 |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.
4984
4985 **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.
4986
4987 Derivation:
4988 //ReferenceType// (restriction)
4989 [[image:inherit.gif||height="9" width="9"]] //LocalComponentListComponentReferenceBaseType// (restriction)
4990 [[image:inherit.gif||height="9" width="9"]] //LocalComponentReferenceBaseType// (restriction)
4991 [[image:inherit.gif||height="9" width="9"]] LocalTargetObjectReferenceType
4992
4993 Content:
4994 Ref
4995
4996 Element Documentation:
4997
4998 |**Name**|**Type**|**Documentation**
4999 |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.
5000
5001 **LocalTargetObjectRefType: **LocalTargetObjectRefType contains the reference fields for referencing a target object locally.
5002
5003 Derivation:
5004 //RefBaseType// (restriction)
5005 [[image:inherit.gif||height="9" width="9"]] //LocalIdentifiableRefBaseType// (restriction)
5006 [[image:inherit.gif||height="9" width="9"]] //LocalComponentListComponentRefBaseType// (restriction)
5007 [[image:inherit.gif||height="9" width="9"]] //LocalComponentRefBaseType// (restriction)
5008 [[image:inherit.gif||height="9" width="9"]] LocalTargetObjectRefType
5009
5010 Attributes:
5011 id, local?, class, package?
5012
5013 Content:
5014 {Empty}
5015
5016 Attribute Documentation:
5017
5018 |**Name**|**Type**|**Documentation**
5019 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
5020 |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.
5021 |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.
5022 |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.
5023
5024 **ReportStructureReferenceType: **ReportStructureReferenceType is a type for referencing a report structure object. It consists of a URN and/or a complete set of reference fields.
5025
5026 Derivation:
5027 //ReferenceType// (restriction)
5028 [[image:inherit.gif||height="9" width="9"]] //ChildObjectReferenceType// (restriction)
5029 [[image:inherit.gif||height="9" width="9"]] //ComponentListReferenceType// (restriction)
5030 [[image:inherit.gif||height="9" width="9"]] ReportStructureReferenceType
5031
5032 Content:
5033 ( (Ref, URN?) | URN)
5034
5035 Element Documentation:
5036
5037 |**Name**|**Type**|**Documentation**
5038 |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.
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 |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.
5041
5042 **ReportStructureRefType: **ReportStructureRefType contains a reference to a report structure within a metadata structure definition.
5043
5044 Derivation:
5045 //RefBaseType// (restriction)
5046 [[image:inherit.gif||height="9" width="9"]] //ChildObjectRefBaseType// (restriction)
5047 [[image:inherit.gif||height="9" width="9"]] //ComponentListRefBaseType// (restriction)
5048 [[image:inherit.gif||height="9" width="9"]] ReportStructureRefType
5049
5050 Attributes:
5051 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
5052
5053 Content:
5054 {Empty}
5055
5056 Attribute Documentation:
5057
5058 |**Name**|**Type**|**Documentation**
5059 |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.
5060 |maintainableParentID|IDType|The maintainableParentID references the structure in which the component list being referenced is defined.
5061 |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.
5062 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
5063 |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.
5064 |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.
5065 |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.
5066
5067 **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).
5068
5069 Derivation:
5070 //ReferenceType// (restriction)
5071 [[image:inherit.gif||height="9" width="9"]] //LocalComponentListReferenceType// (restriction)
5072 [[image:inherit.gif||height="9" width="9"]] LocalReportStructureReferenceType
5073
5074 Content:
5075 Ref
5076
5077 Element Documentation:
5078
5079 |**Name**|**Type**|**Documentation**
5080 |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.
5081
5082 **LocalReportStructureRefType: **LocalReportStructureRefType contains a local reference to a report structure object.
5083
5084 Derivation:
5085 //RefBaseType// (restriction)
5086 [[image:inherit.gif||height="9" width="9"]] //LocalIdentifiableRefBaseType// (restriction)
5087 [[image:inherit.gif||height="9" width="9"]] //LocalComponentListRefBaseType// (restriction)
5088 [[image:inherit.gif||height="9" width="9"]] LocalReportStructureRefType
5089
5090 Attributes:
5091 id, local?, class?, package?
5092
5093 Content:
5094 {Empty}
5095
5096 Attribute Documentation:
5097
5098 |**Name**|**Type**|**Documentation**
5099 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
5100 |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.
5101 |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.
5102 |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.
5103
5104 **MetadataAttributeReferenceType: **MetadataAttributeReferenceType is a type for referencing a metadata attribute object. It consists of a URN and/or a complete set of reference fields.
5105
5106 Derivation:
5107 //ReferenceType// (restriction)
5108 [[image:inherit.gif||height="9" width="9"]] //ContainerChildObjectReferenceType// (restriction)
5109 [[image:inherit.gif||height="9" width="9"]] //ComponentReferenceType// (restriction)
5110 [[image:inherit.gif||height="9" width="9"]] MetadataAttributeReferenceType
5111
5112 Content:
5113 ( (Ref, URN?) | URN)
5114
5115 Element Documentation:
5116
5117 |**Name**|**Type**|**Documentation**
5118 |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.
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 |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.
5121
5122 **MetadataAttributeRefType: **MetadataAttributeRefType contains a reference to a metadata attribute within a report structure in a metadata structure definition.
5123
5124 Derivation:
5125 //RefBaseType// (restriction)
5126 [[image:inherit.gif||height="9" width="9"]] //ContainerChildObjectRefBaseType// (restriction)
5127 [[image:inherit.gif||height="9" width="9"]] //ComponentRefBaseType// (restriction)
5128 [[image:inherit.gif||height="9" width="9"]] MetadataAttributeRefType
5129
5130 Attributes:
5131 agencyID, maintainableParentID, maintainableParentVersion?, containerID, id, version?, local?, class?, package?
5132
5133 Content:
5134 {Empty}
5135
5136 Attribute Documentation:
5137
5138 |**Name**|**Type**|**Documentation**
5139 |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.
5140 |maintainableParentID|IDType|The maintainableParentID references the structure in which the component being referenced is defined.
5141 |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.
5142 |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.
5143 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
5144 |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.
5145 |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.
5146 |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.
5147 |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.
5148
5149 **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.
5150
5151 Derivation:
5152 //ReferenceType// (restriction)
5153 [[image:inherit.gif||height="9" width="9"]] //LocalComponentListComponentReferenceBaseType// (restriction)
5154 [[image:inherit.gif||height="9" width="9"]] LocalMetadataStructureComponentReferenceType
5155
5156 Content:
5157 Ref
5158
5159 Element Documentation:
5160
5161 |**Name**|**Type**|**Documentation**
5162 |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.
5163
5164 **LocalMetadataStructureComponentRefType: **LocalMetadataStructureComponentRefType contains the reference fields for referencing any metadata structure component locally. This reference must specify the class of the component being referenced.
5165
5166 Derivation:
5167 //RefBaseType// (restriction)
5168 [[image:inherit.gif||height="9" width="9"]] //LocalIdentifiableRefBaseType// (restriction)
5169 [[image:inherit.gif||height="9" width="9"]] //LocalComponentListComponentRefBaseType// (restriction)
5170 [[image:inherit.gif||height="9" width="9"]] LocalMetadataStructureComponentRefType
5171
5172 Attributes:
5173 containerID, id, local?, class, package?
5174
5175 Content:
5176 {Empty}
5177
5178 Attribute Documentation:
5179
5180 |**Name**|**Type**|**Documentation**
5181 |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.
5182 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
5183 |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.
5184 |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.
5185 |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.
5186
5187 **ProvisionAgreementReferenceType: **ProvisionAgreementReferenceType is a type for referencing a provision agreement. It consists of a URN and/or a complete set of reference fields.
5188
5189 Derivation:
5190 //ReferenceType// (restriction)
5191 [[image:inherit.gif||height="9" width="9"]] //MaintainableReferenceBaseType// (restriction)
5192 [[image:inherit.gif||height="9" width="9"]] ProvisionAgreementReferenceType
5193
5194 Content:
5195 ( (Ref, URN?) | URN)
5196
5197 Element Documentation:
5198
5199 |**Name**|**Type**|**Documentation**
5200 |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.
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 |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.
5203
5204 **ProvisionAgreementRefType: **ProvisionAgreementRefType contains a set of reference fields for a provision agreement.
5205
5206 Derivation:
5207 //RefBaseType// (restriction)
5208 [[image:inherit.gif||height="9" width="9"]] //MaintainableRefBaseType// (restriction)
5209 [[image:inherit.gif||height="9" width="9"]] ProvisionAgreementRefType
5210
5211 Attributes:
5212 agencyID, id, version?, local?, class?, package?
5213
5214 Content:
5215 {Empty}
5216
5217 Attribute Documentation:
5218
5219 |**Name**|**Type**|**Documentation**
5220 |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.
5221 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
5222 |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.
5223 |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.
5224 |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.
5225 |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.
5226
5227 **ProcessReferenceType: **ProcessReferenceType is a type for referencing a process object. It consists of a URN and/or a complete set of reference fields.
5228
5229 Derivation:
5230 //ReferenceType// (restriction)
5231 [[image:inherit.gif||height="9" width="9"]] //MaintainableReferenceBaseType// (restriction)
5232 [[image:inherit.gif||height="9" width="9"]] ProcessReferenceType
5233
5234 Content:
5235 ( (Ref, URN?) | URN)
5236
5237 Element Documentation:
5238
5239 |**Name**|**Type**|**Documentation**
5240 |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.
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 |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.
5243
5244 **ProcessRefType: **ProcessRefType contains a set of reference fields for a process.
5245
5246 Derivation:
5247 //RefBaseType// (restriction)
5248 [[image:inherit.gif||height="9" width="9"]] //MaintainableRefBaseType// (restriction)
5249 [[image:inherit.gif||height="9" width="9"]] ProcessRefType
5250
5251 Attributes:
5252 agencyID, id, version?, local?, class?, package?
5253
5254 Content:
5255 {Empty}
5256
5257 Attribute Documentation:
5258
5259 |**Name**|**Type**|**Documentation**
5260 |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.
5261 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
5262 |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.
5263 |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.
5264 |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.
5265 |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.
5266
5267 **ProcessStepReferenceType: **ProcessStepReferenceType is a type for referencing a process step object. It consists of a URN and/or a complete set of reference fields.
5268
5269 Derivation:
5270 //ReferenceType// (restriction)
5271 [[image:inherit.gif||height="9" width="9"]] //ChildObjectReferenceType// (restriction)
5272 [[image:inherit.gif||height="9" width="9"]] ProcessStepReferenceType
5273
5274 Content:
5275 ( (Ref, URN?) | URN)
5276
5277 Element Documentation:
5278
5279 |**Name**|**Type**|**Documentation**
5280 |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.
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 |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.
5283
5284 **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.
5285
5286 Derivation:
5287 //RefBaseType// (restriction)
5288 [[image:inherit.gif||height="9" width="9"]] //ChildObjectRefBaseType// (restriction)
5289 [[image:inherit.gif||height="9" width="9"]] ProcessStepRefType
5290
5291 Attributes:
5292 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
5293
5294 Content:
5295 {Empty}
5296
5297 Attribute Documentation:
5298
5299 |**Name**|**Type**|**Documentation**
5300 |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.
5301 |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.
5302 |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.
5303 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
5304 |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.
5305 |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.
5306 |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.
5307
5308 **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).
5309
5310 Derivation:
5311 //ReferenceType// (restriction)
5312 [[image:inherit.gif||height="9" width="9"]] //LocalIdentifiableReferenceType// (restriction)
5313 [[image:inherit.gif||height="9" width="9"]] LocalProcessStepReferenceType
5314
5315 Content:
5316 Ref
5317
5318 Element Documentation:
5319
5320 |**Name**|**Type**|**Documentation**
5321 |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.
5322
5323 **LocalProcessStepRefType: **LocalProcessStepRefType contains a local reference to a process step object.
5324
5325 Derivation:
5326 //RefBaseType// (restriction)
5327 [[image:inherit.gif||height="9" width="9"]] //LocalIdentifiableRefBaseType// (restriction)
5328 [[image:inherit.gif||height="9" width="9"]] LocalProcessStepRefType
5329
5330 Attributes:
5331
5332 containerID?, id, local?, class?, package?
5333
5334 Content:
5335 {Empty}
5336
5337 Attribute Documentation:
5338
5339 |**Name**|**Type**|**Documentation**
5340 |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.
5341 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
5342 |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.
5343 |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.
5344 |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.
5345
5346 **TransitionReferenceType: **TransiationReferenceType is a type for referencing a process step object. It consists of a URN and/or a complete set of reference fields.
5347
5348 Derivation:
5349 //ReferenceType// (restriction)
5350 [[image:inherit.gif||height="9" width="9"]] //ContainerChildObjectReferenceType// (restriction)
5351 [[image:inherit.gif||height="9" width="9"]] TransitionReferenceType
5352
5353 Content:
5354 ( (Ref, URN?) | URN)
5355
5356 Element Documentation:
5357
5358 |**Name**|**Type**|**Documentation**
5359 |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.
5360 |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.
5361 |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.
5362
5363 **TransitionRefType: **TransitionRefType provides for a reference to a transition definition in process step through its id.
5364
5365 Derivation:
5366 //RefBaseType// (restriction)
5367 [[image:inherit.gif||height="9" width="9"]] //ContainerChildObjectRefBaseType// (restriction)
5368 [[image:inherit.gif||height="9" width="9"]] TransitionRefType
5369
5370 Attributes:
5371 agencyID, maintainableParentID, maintainableParentVersion?, containerID, id, version?, local?, class?, package?
5372
5373 Content:
5374 {Empty}
5375
5376 Attribute Documentation:
5377
5378 |**Name**|**Type**|**Documentation**
5379 |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.
5380 |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.
5381 |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.
5382 |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.
5383 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
5384 |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.
5385 |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.
5386 |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.
5387 |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.
5388
5389 **StructureSetReferenceType: **StructureSetReferenceType is a type for referencing a structure set object. It consists of a URN and/or a complete set of reference fields.
5390
5391 Derivation:
5392 //ReferenceType// (restriction)
5393 [[image:inherit.gif||height="9" width="9"]] //MaintainableReferenceBaseType// (restriction)
5394
5395 *
5396 **
5397 *** StructureSetReferenceType
5398
5399 Content:
5400 ( (Ref, URN?) | URN)
5401
5402 Element Documentation:
5403
5404 |**Name**|**Type**|**Documentation**
5405 |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.
5406 |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.
5407 |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.
5408
5409 **StructureSetRefType: **StructureSetRefType contains a set of reference fields for a structure set.
5410
5411 Derivation:
5412 //RefBaseType// (restriction)
5413 [[image:inherit.gif||height="9" width="9"]] //MaintainableRefBaseType// (restriction)
5414 [[image:inherit.gif||height="9" width="9"]] StructureSetRefType
5415
5416 Attributes:
5417 agencyID, id, version?, local?, class?, package?
5418
5419 Content:
5420 {Empty}
5421
5422 Attribute Documentation:
5423
5424 |**Name**|**Type**|**Documentation**
5425 |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.
5426 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
5427 |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.
5428 |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.
5429 |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.
5430 |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.
5431
5432 **StructureMapReferenceType: **StructureMapReferenceType is a type for referencing a structure map object. It consists of a URN and/or a complete set of reference fields.
5433
5434 Derivation:
5435 //ReferenceType// (restriction)
5436 [[image:inherit.gif||height="9" width="9"]] //ChildObjectReferenceType// (restriction)
5437 [[image:inherit.gif||height="9" width="9"]] StructureMapReferenceType
5438
5439 Content:
5440 ( (Ref, URN?) | URN)
5441
5442 Element Documentation:
5443
5444 |**Name**|**Type**|**Documentation**
5445 |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.
5446 |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.
5447 |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.
5448
5449 **StructureMapRefType: **StructureMapRefType contains fields for referencing a structure map within a structure set.
5450
5451 Derivation:
5452 //RefBaseType// (restriction)
5453 [[image:inherit.gif||height="9" width="9"]] //ChildObjectRefBaseType// (restriction)
5454 [[image:inherit.gif||height="9" width="9"]] StructureMapRefType
5455
5456 Attributes:
5457 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
5458
5459 Content:
5460 {Empty}
5461
5462 Attribute Documentation:
5463
5464 |**Name**|**Type**|**Documentation**
5465 |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.
5466 |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.
5467 |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.
5468 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
5469 |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.
5470 |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.
5471 |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.
5472
5473 **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.
5474
5475 Derivation:
5476 //ReferenceType// (restriction)
5477 [[image:inherit.gif||height="9" width="9"]] //ChildObjectReferenceType// (restriction)
5478 [[image:inherit.gif||height="9" width="9"]] CategorySchemeMapReferenceType
5479
5480 Content:
5481 ( (Ref, URN?) | URN)
5482
5483 Element Documentation:
5484
5485 |**Name**|**Type**|**Documentation**
5486 |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.
5487 |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.
5488 |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.
5489
5490 **CategorySchemeMapRefType: **CategorySchemeMapRefType contains a set of reference fields for a category scheme map.
5491
5492 Derivation:
5493 //RefBaseType// (restriction)
5494 [[image:inherit.gif||height="9" width="9"]] //ChildObjectRefBaseType// (restriction)
5495 [[image:inherit.gif||height="9" width="9"]] CategorySchemeMapRefType
5496
5497 Attributes:
5498 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
5499
5500 Content:
5501 {Empty}
5502
5503 Attribute Documentation:
5504
5505 |**Name**|**Type**|**Documentation**
5506 |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.
5507 |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.
5508 |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.
5509 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
5510 |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.
5511 |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.
5512 |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.
5513
5514 **CodelistMapReferenceType: **CodelistMapReferenceType is a type for referencing a codelist map object. It consists of a URN and/or a complete set of reference fields.
5515
5516 Derivation:
5517 //ReferenceType// (restriction)
5518 [[image:inherit.gif||height="9" width="9"]] //ChildObjectReferenceType// (restriction)
5519 [[image:inherit.gif||height="9" width="9"]] CodelistMapReferenceType
5520
5521 Content:
5522 ( (Ref, URN?) | URN)
5523
5524 Element Documentation:
5525
5526 |**Name**|**Type**|**Documentation**
5527 |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.
5528 |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.
5529 |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.
5530
5531 **CodelistMapRefType: **CodelistMapRefType contains a set of reference fields for a codelist map.
5532
5533 Derivation:
5534 //RefBaseType// (restriction)
5535 [[image:inherit.gif||height="9" width="9"]] //ChildObjectRefBaseType// (restriction)
5536 [[image:inherit.gif||height="9" width="9"]] CodelistMapRefType
5537
5538 Attributes:
5539 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
5540
5541 Content:
5542 {Empty}
5543
5544 Attribute Documentation:
5545
5546 |**Name**|**Type**|**Documentation**
5547 |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.
5548 |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.
5549 |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.
5550 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
5551 |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.
5552 |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.
5553 |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.
5554
5555 **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).
5556
5557 Derivation:
5558 //ReferenceType// (restriction)
5559 [[image:inherit.gif||height="9" width="9"]] LocalCodelistMapReferenceType
5560
5561 Content:
5562 Ref
5563
5564 Element Documentation:
5565
5566 |**Name**|**Type**|**Documentation**
5567 |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.
5568
5569 **LocalCodelistMapRefType: **LocalCodelistMapRefType contains a set of reference fields for a codelist map locally.
5570
5571 Derivation:
5572 //RefBaseType// (restriction)
5573 [[image:inherit.gif||height="9" width="9"]] //LocalIdentifiableRefBaseType// (restriction)
5574 [[image:inherit.gif||height="9" width="9"]] LocalCodelistMapRefType
5575
5576 Attributes:
5577 id, local?, class?, package?
5578
5579 Content:
5580 {Empty}
5581
5582 Attribute Documentation:
5583
5584 |**Name**|**Type**|**Documentation**
5585 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
5586 |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.
5587 |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.
5588 |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.
5589
5590 **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.
5591
5592 Derivation:
5593 //ReferenceType// (restriction)
5594 [[image:inherit.gif||height="9" width="9"]] //ChildObjectReferenceType// (restriction)
5595 [[image:inherit.gif||height="9" width="9"]] ConceptSchemeMapReferenceType
5596
5597 Content:
5598 ( (Ref, URN?) | URN)
5599
5600 Element Documentation:
5601
5602 |**Name**|**Type**|**Documentation**
5603 |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.
5604 |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.
5605 |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.
5606
5607 **ConceptSchemeMapRefType: **ConceptSchemeMapRefType contains a set of reference fields for a concept scheme map.
5608
5609 Derivation:
5610 //RefBaseType// (restriction)
5611 [[image:inherit.gif||height="9" width="9"]] //ChildObjectRefBaseType// (restriction)
5612 [[image:inherit.gif||height="9" width="9"]] ConceptSchemeMapRefType
5613
5614 Attributes:
5615 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
5616
5617 Content:
5618 {Empty}
5619
5620 Attribute Documentation:
5621
5622 |**Name**|**Type**|**Documentation**
5623 |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.
5624 |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.
5625 |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.
5626 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
5627 |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.
5628 |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.
5629 |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.
5630
5631 **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.
5632
5633 Derivation:
5634 //ReferenceType// (restriction)
5635 [[image:inherit.gif||height="9" width="9"]] //ChildObjectReferenceType// (restriction)
5636 [[image:inherit.gif||height="9" width="9"]] OrganisationSchemeMapReferenceType
5637
5638 Content:
5639 ( (Ref, URN?) | URN)
5640
5641 Element Documentation:
5642
5643 |**Name**|**Type**|**Documentation**
5644 |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.
5645 |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.
5646 |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.
5647
5648 **OrganisationSchemeMapRefType: **OrganisationSchemeMapRefType contains a set of reference fields for an organisation scheme map.
5649
5650 Derivation:
5651 //RefBaseType// (restriction)
5652 [[image:inherit.gif||height="9" width="9"]] //ChildObjectRefBaseType// (restriction)
5653 [[image:inherit.gif||height="9" width="9"]] OrganisationSchemeMapRefType
5654
5655 Attributes:
5656 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
5657
5658 Content:
5659 {Empty}
5660
5661 Attribute Documentation:
5662
5663 |**Name**|**Type**|**Documentation**
5664 |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.
5665 |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.
5666 |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.
5667 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
5668 |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.
5669 |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.
5670 |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.
5671
5672 **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.
5673
5674 Derivation:
5675 //ReferenceType// (restriction)
5676 [[image:inherit.gif||height="9" width="9"]] //MaintainableReferenceBaseType// (restriction)
5677 [[image:inherit.gif||height="9" width="9"]] //ItemSchemeReferenceBaseType// (restriction)
5678 [[image:inherit.gif||height="9" width="9"]] VtlMappingSchemeReferenceType
5679
5680 Content:
5681 ( (Ref, URN?) | URN)
5682
5683 Element Documentation:
5684
5685 |**Name**|**Type**|**Documentation**
5686 |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.
5687 |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.
5688 |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.
5689
5690 **VtlMappingSchemeRefType: **VtlMappingSchemeRefType provides a reference to a VTL mapping scheme via a complete set of reference fields.
5691
5692 Derivation:
5693 //RefBaseType// (restriction)
5694 [[image:inherit.gif||height="9" width="9"]] //MaintainableRefBaseType// (restriction)
5695 [[image:inherit.gif||height="9" width="9"]] //ItemSchemeRefBaseType// (restriction)
5696 [[image:inherit.gif||height="9" width="9"]] VtlMappingSchemeRefType
5697
5698 Attributes:
5699 agencyID, id, version?, local?, class?, package?
5700
5701 Content:
5702 {Empty}
5703
5704 Attribute Documentation:
5705
5706 |**Name**|**Type**|**Documentation**
5707 |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.
5708 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
5709 |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.
5710 |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.
5711 |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.
5712 |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.
5713
5714 **VtlMappingReferenceType: **VtlMappingReferenceType is a type for referencing a VTL mapping object. It consists of a URN and/or a complete set of reference fields.
5715
5716 Derivation:
5717 //ReferenceType// (restriction)
5718 [[image:inherit.gif||height="9" width="9"]] //ChildObjectReferenceType// (restriction)
5719 [[image:inherit.gif||height="9" width="9"]] //ItemReferenceType// (restriction)
5720 [[image:inherit.gif||height="9" width="9"]] VtlMappingReferenceType
5721
5722 Content:
5723 ( (Ref, URN?) | URN)
5724
5725 Element Documentation:
5726
5727 |**Name**|**Type**|**Documentation**
5728 |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.
5729 |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.
5730 |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.
5731
5732 **VtlMappingRefType: **VtlMappingRefType references a VTL mapping from within a VTL mapping scheme. Reference fields are required for both the scheme and the item.
5733
5734 Derivation:
5735 //RefBaseType// (restriction)
5736 [[image:inherit.gif||height="9" width="9"]] //ChildObjectRefBaseType// (restriction)
5737 [[image:inherit.gif||height="9" width="9"]] //ItemRefBaseType// (restriction)
5738 [[image:inherit.gif||height="9" width="9"]] VtlMappingRefType
5739
5740 Attributes:
5741 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
5742
5743 Content:
5744 {Empty}
5745
5746 Attribute Documentation:
5747
5748 |**Name**|**Type**|**Documentation**
5749 |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.
5750 |maintainableParentID|IDType|The maintainableParentID references the VTL mapping scheme in which the VTL mapping being referenced is defined.
5751 |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.
5752 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
5753 |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.
5754 |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.
5755 |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.
5756
5757 **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.
5758
5759 Derivation:
5760 //ReferenceType// (restriction)
5761 [[image:inherit.gif||height="9" width="9"]] //LocalItemReferenceType// (restriction)
5762 [[image:inherit.gif||height="9" width="9"]] LocalVtlMappingReferenceType
5763
5764 Content:
5765 Ref
5766
5767 Element Documentation:
5768
5769 |**Name**|**Type**|**Documentation**
5770 |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.
5771
5772 **LocalVtlMappingRefType: **LocalVtlMappingRefType references a VTL mapping locally where the references to the VTL mapping scheme which defines it is provided elsewhere.
5773
5774 Derivation:
5775 //RefBaseType// (restriction)
5776 [[image:inherit.gif||height="9" width="9"]] //LocalIdentifiableRefBaseType// (restriction)
5777 [[image:inherit.gif||height="9" width="9"]] //LocalItemRefBaseType// (restriction)
5778 [[image:inherit.gif||height="9" width="9"]] LocalVtlMappingRefType
5779
5780 Attributes:
5781 id, local?, class?, package?
5782
5783 Content:
5784 {Empty}
5785
5786 Attribute Documentation:
5787
5788 |**Name**|**Type**|**Documentation**
5789 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
5790 |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.
5791 |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.
5792 |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.
5793
5794 **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.
5795
5796 Derivation:
5797 //ReferenceType// (restriction)
5798 [[image:inherit.gif||height="9" width="9"]] //MaintainableReferenceBaseType// (restriction)
5799 [[image:inherit.gif||height="9" width="9"]] //ItemSchemeReferenceBaseType// (restriction)
5800 [[image:inherit.gif||height="9" width="9"]] NamePersonalisationSchemeReferenceType
5801
5802 Content:
5803 ( (Ref, URN?) | URN)
5804
5805 Element Documentation:
5806
5807 |**Name**|**Type**|**Documentation**
5808 |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.
5809 |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.
5810 |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.
5811
5812 **NamePersonalisationSchemeRefType: **NamePersonalisationSchemeRefType provides a reference to a name personalisation scheme via a complete set of reference fields.
5813
5814 Derivation:
5815 //RefBaseType// (restriction)
5816 [[image:inherit.gif||height="9" width="9"]] //MaintainableRefBaseType// (restriction)
5817 [[image:inherit.gif||height="9" width="9"]] //ItemSchemeRefBaseType// (restriction)
5818 [[image:inherit.gif||height="9" width="9"]] NamePersonalisationSchemeRefType
5819
5820 Attributes:
5821 agencyID, id, version?, local?, class?, package?
5822
5823 Content:
5824 {Empty}
5825
5826 Attribute Documentation:
5827
5828 |**Name**|**Type**|**Documentation**
5829 |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.
5830 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
5831 |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.
5832 |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.
5833 |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.
5834 |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.
5835
5836 **NamePersonalisationReferenceType: **NamePersonalisationReferenceType is a type for referencing a name personalisation object. It consists of a URN and/or a complete set of reference fields.
5837
5838 Derivation:
5839 //ReferenceType// (restriction)
5840 [[image:inherit.gif||height="9" width="9"]] //ChildObjectReferenceType// (restriction)
5841 [[image:inherit.gif||height="9" width="9"]] //ItemReferenceType// (restriction)
5842 [[image:inherit.gif||height="9" width="9"]] NamePersonalisationReferenceType
5843
5844 Content:
5845 ( (Ref, URN?) | URN)
5846
5847 Element Documentation:
5848
5849 |**Name**|**Type**|**Documentation**
5850 |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.
5851 |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.
5852 |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.
5853
5854 **NamePersonalisationRefType: **NamePersonalisationRefType references a name personalisation from within a name personalisation scheme. Reference fields are required for both the scheme and the item.
5855
5856 Derivation:
5857 //RefBaseType// (restriction)
5858 [[image:inherit.gif||height="9" width="9"]] //ChildObjectRefBaseType// (restriction)
5859 [[image:inherit.gif||height="9" width="9"]] //ItemRefBaseType// (restriction)
5860 [[image:inherit.gif||height="9" width="9"]] NamePersonalisationRefType
5861
5862 Attributes:
5863 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
5864
5865 Content:
5866 {Empty}
5867
5868 Attribute Documentation:
5869
5870 |**Name**|**Type**|**Documentation**
5871 |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.
5872 |maintainableParentID|IDType|The maintainableParentID references the name personalisation scheme in which the name personalisation being referenced is defined.
5873 |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.
5874 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
5875 |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.
5876 |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.
5877 |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.
5878
5879 **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.
5880
5881 Derivation:
5882 //ReferenceType// (restriction)
5883 [[image:inherit.gif||height="9" width="9"]] //LocalItemReferenceType// (restriction)
5884 [[image:inherit.gif||height="9" width="9"]] LocalNamePersonalisationReferenceType
5885
5886 Content:
5887 Ref
5888
5889 Element Documentation:
5890
5891 |**Name**|**Type**|**Documentation**
5892 |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.
5893
5894 **LocalNamePersonalisationRefType: **LocalNamePersonalisationRefType references a name personalisation locally where the references to the name personalisation scheme which defines it is provided elsewhere.
5895
5896 Derivation:
5897 //RefBaseType// (restriction)
5898 [[image:inherit.gif||height="9" width="9"]] //LocalIdentifiableRefBaseType// (restriction)
5899 [[image:inherit.gif||height="9" width="9"]] //LocalItemRefBaseType// (restriction)
5900 [[image:inherit.gif||height="9" width="9"]] LocalNamePersonalisationRefType
5901
5902 Attributes:
5903 id, local?, class?, package?
5904
5905 Content:
5906 {Empty}
5907
5908 Attribute Documentation:
5909
5910 |**Name**|**Type**|**Documentation**
5911 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
5912 |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.
5913 |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.
5914 |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.
5915
5916 **RulesetSchemeReferenceType: **RulesetSchemeReferenceType is a type for referencing a ruleset scheme object. It consists of a URN and/or a complete set of reference fields.
5917
5918 Derivation:
5919 //ReferenceType// (restriction)
5920 [[image:inherit.gif||height="9" width="9"]] //MaintainableReferenceBaseType// (restriction)
5921 [[image:inherit.gif||height="9" width="9"]] //ItemSchemeReferenceBaseType// (restriction)
5922 [[image:inherit.gif||height="9" width="9"]] RulesetSchemeReferenceType
5923
5924 Content:
5925 ( (Ref, URN?) | URN)
5926
5927 Element Documentation:
5928
5929 |**Name**|**Type**|**Documentation**
5930 |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.
5931 |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.
5932 |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.
5933
5934 **RulesetSchemeRefType: **RulesetSchemeRefType provides a reference to a ruleset scheme via a complete set of reference fields.
5935
5936 Derivation:
5937 //RefBaseType// (restriction)
5938 [[image:inherit.gif||height="9" width="9"]] //MaintainableRefBaseType// (restriction)
5939 [[image:inherit.gif||height="9" width="9"]] //ItemSchemeRefBaseType// (restriction)
5940 [[image:inherit.gif||height="9" width="9"]] RulesetSchemeRefType
5941
5942 Attributes:
5943 agencyID, id, version?, local?, class?, package?
5944
5945 Content:
5946 {Empty}
5947
5948 Attribute Documentation:
5949
5950 |**Name**|**Type**|**Documentation**
5951 |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.
5952 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
5953 |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.
5954 |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.
5955 |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.
5956 |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.
5957
5958 **RulesetReferenceType: **RulesetReferenceType is a type for referencing a ruleset object. It consists of a URN and/or a complete set of reference fields.
5959
5960 Derivation:
5961 //ReferenceType// (restriction)
5962 [[image:inherit.gif||height="9" width="9"]] //ChildObjectReferenceType// (restriction)
5963 [[image:inherit.gif||height="9" width="9"]] //ItemReferenceType// (restriction)
5964 [[image:inherit.gif||height="9" width="9"]] RulesetReferenceType
5965
5966 Content:
5967 ( (Ref, URN?) | URN)
5968
5969 Element Documentation:
5970
5971 |**Name**|**Type**|**Documentation**
5972 |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.
5973 |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.
5974 |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.
5975
5976 **RulesetRefType: **RulesetRefType references a rule set from within an rule set scheme. Reference fields are required for both the scheme and the item.
5977
5978 Derivation:
5979 //RefBaseType// (restriction)
5980 [[image:inherit.gif||height="9" width="9"]] //ChildObjectRefBaseType// (restriction)
5981 [[image:inherit.gif||height="9" width="9"]] //ItemRefBaseType// (restriction)
5982 [[image:inherit.gif||height="9" width="9"]] RulesetRefType
5983
5984 Attributes:
5985 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
5986
5987 Content:
5988 {Empty}
5989
5990 Attribute Documentation:
5991
5992 |**Name**|**Type**|**Documentation**
5993 |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.
5994 |maintainableParentID|IDType|The maintainableParentID references the ruleset scheme in which the concept being referenced is defined.
5995 |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.
5996 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
5997 |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.
5998 |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.
5999 |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.
6000
6001 **LocalRulesetReferenceType: **LocalRulesetReferenceType provides a simple reference to a ruleset where the identification of the ruleset scheme which defines it is contained in another context.
6002
6003 Derivation:
6004 //ReferenceType// (restriction)
6005 [[image:inherit.gif||height="9" width="9"]] //LocalItemReferenceType// (restriction)
6006 [[image:inherit.gif||height="9" width="9"]] LocalRulesetReferenceType
6007
6008 Content:
6009 Ref
6010
6011 Element Documentation:
6012
6013 |**Name**|**Type**|**Documentation**
6014 |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.
6015
6016 **LocalRulesetRefType: **LocalRulesetRefType references a ruleset locally where the references to the ruleset scheme which defines it is provided elsewhere.
6017
6018 Derivation:
6019 //RefBaseType// (restriction)
6020 [[image:inherit.gif||height="9" width="9"]] //LocalIdentifiableRefBaseType// (restriction)
6021 [[image:inherit.gif||height="9" width="9"]] //LocalItemRefBaseType// (restriction)
6022 [[image:inherit.gif||height="9" width="9"]] LocalRulesetRefType
6023
6024 Attributes:
6025 id, local?, class?, package?
6026
6027 Content:
6028 {Empty}
6029
6030 Attribute Documentation:
6031
6032 |**Name**|**Type**|**Documentation**
6033 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
6034 |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.
6035 |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.
6036 |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.
6037
6038 **TransformationSchemeReferenceType: **TransformationSchemeReferenceType is a type for referencing a transformation scheme object. It consists of a URN and/or a complete set of reference fields.
6039
6040 Derivation:
6041 //ReferenceType// (restriction)
6042 [[image:inherit.gif||height="9" width="9"]] //MaintainableReferenceBaseType// (restriction)
6043 [[image:inherit.gif||height="9" width="9"]] //ItemSchemeReferenceBaseType// (restriction)
6044 [[image:inherit.gif||height="9" width="9"]] TransformationSchemeReferenceType
6045
6046 Content:
6047 ( (Ref, URN?) | URN)
6048
6049 Element Documentation:
6050
6051 |**Name**|**Type**|**Documentation**
6052 |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.
6053 |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.
6054 |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.
6055
6056 **TransformationSchemeRefType: **TransformationSchemeRefType provides a reference to a transformation scheme via a complete set of reference fields.
6057
6058 Derivation:
6059 //RefBaseType// (restriction)
6060 [[image:inherit.gif||height="9" width="9"]] //MaintainableRefBaseType// (restriction)
6061 [[image:inherit.gif||height="9" width="9"]] //ItemSchemeRefBaseType// (restriction)
6062 [[image:inherit.gif||height="9" width="9"]] TransformationSchemeRefType
6063
6064 Attributes:
6065 agencyID, id, version?, local?, class?, package?
6066
6067 Content:
6068 {Empty}
6069
6070 Attribute Documentation:
6071
6072 |**Name**|**Type**|**Documentation**
6073 |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.
6074 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
6075 |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.
6076 |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.
6077 |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.
6078 |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.
6079
6080 **TransformationReferenceType: **TransformationReferenceType is a type for referencing a transformation object. It consists of a URN and/or a complete set of reference fields.
6081
6082 Derivation:
6083 //ReferenceType// (restriction)
6084 [[image:inherit.gif||height="9" width="9"]] //ChildObjectReferenceType// (restriction)
6085 [[image:inherit.gif||height="9" width="9"]] //ItemReferenceType// (restriction)
6086 [[image:inherit.gif||height="9" width="9"]] TransformationReferenceType
6087
6088 Content:
6089 ( (Ref, URN?) | URN)
6090
6091 Element Documentation:
6092
6093 |**Name**|**Type**|**Documentation**
6094 |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.
6095 |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.
6096 |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.
6097
6098 **TransformationRefType: **TransformationRefType references a transformation from within a transformation scheme. Reference fields are required for both the scheme and the item.
6099
6100 Derivation:
6101 //RefBaseType// (restriction)
6102 [[image:inherit.gif||height="9" width="9"]] //ChildObjectRefBaseType// (restriction)
6103 [[image:inherit.gif||height="9" width="9"]] //ItemRefBaseType// (restriction)
6104 [[image:inherit.gif||height="9" width="9"]] TransformationRefType
6105
6106 Attributes:
6107 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
6108
6109 Content:
6110 {Empty}
6111
6112 Attribute Documentation:
6113
6114 |**Name**|**Type**|**Documentation**
6115 |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.
6116 |maintainableParentID|IDType|The maintainableParentID references the transformation scheme in which the transformation being referenced is defined.
6117 |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.
6118 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
6119 |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.
6120 |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.
6121 |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.
6122
6123 **LocalTransformationReferenceType: **LocalTransformationReferenceType provides a simple references to a transformation where the identification of the transformation scheme which defines it is contained in another context.
6124
6125 Derivation:
6126 //ReferenceType// (restriction)
6127 [[image:inherit.gif||height="9" width="9"]] //LocalItemReferenceType// (restriction)
6128 [[image:inherit.gif||height="9" width="9"]] LocalTransformationReferenceType
6129
6130 Content:
6131 Ref
6132
6133 Element Documentation:
6134
6135 |**Name**|**Type**|**Documentation**
6136 |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.
6137
6138 **LocalTransformationRefType: **LocalTransformationRefType references a transformation locally where the references to the transformation scheme which defines it is provided elsewhere.
6139
6140 Derivation:
6141 //RefBaseType// (restriction)
6142 [[image:inherit.gif||height="9" width="9"]] //LocalIdentifiableRefBaseType// (restriction)
6143 [[image:inherit.gif||height="9" width="9"]] //LocalItemRefBaseType// (restriction)
6144 [[image:inherit.gif||height="9" width="9"]] LocalTransformationRefType
6145
6146 Attributes:
6147 id, local?, class?, package?
6148
6149 Content:
6150 {Empty}
6151
6152 Attribute Documentation:
6153
6154 |**Name**|**Type**|**Documentation**
6155 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
6156 |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.
6157 |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.
6158 |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.
6159
6160 **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.
6161
6162 Derivation:
6163 //ReferenceType// (restriction)
6164 [[image:inherit.gif||height="9" width="9"]] //MaintainableReferenceBaseType// (restriction)
6165 [[image:inherit.gif||height="9" width="9"]] //ItemSchemeReferenceBaseType// (restriction)
6166 [[image:inherit.gif||height="9" width="9"]] UserDefinedOperatorSchemeReferenceType
6167
6168 Content:
6169 ( (Ref, URN?) | URN)
6170
6171 Element Documentation:
6172
6173 |**Name**|**Type**|**Documentation**
6174 |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.
6175 |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.
6176 |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.
6177
6178 **UserDefinedOperatorSchemeRefType: **UserDefinedOperatorSchemeRefType provides a reference to a user defined operator scheme via a complete set of reference fields.
6179
6180 Derivation:
6181 //RefBaseType// (restriction)
6182 [[image:inherit.gif||height="9" width="9"]] //MaintainableRefBaseType// (restriction)
6183 [[image:inherit.gif||height="9" width="9"]] //ItemSchemeRefBaseType// (restriction)
6184 [[image:inherit.gif||height="9" width="9"]] UserDefinedOperatorSchemeRefType
6185
6186 Attributes:
6187 agencyID, id, version?, local?, class?, package?
6188
6189 Content:
6190 {Empty}
6191
6192 Attribute Documentation:
6193
6194 |**Name**|**Type**|**Documentation**
6195 |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.
6196 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
6197 |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.
6198 |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.
6199 |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.
6200 |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.
6201
6202 **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.
6203
6204 Derivation:
6205 //ReferenceType// (restriction)
6206 [[image:inherit.gif||height="9" width="9"]] //ChildObjectReferenceType// (restriction)
6207 [[image:inherit.gif||height="9" width="9"]] //ItemReferenceType// (restriction)
6208 [[image:inherit.gif||height="9" width="9"]] UserDefinedOperatorReferenceType
6209
6210 Content:
6211 ( (Ref, URN?) | URN)
6212
6213 Element Documentation:
6214
6215 |**Name**|**Type**|**Documentation**
6216 |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.
6217 |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.
6218 |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.
6219
6220 **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.
6221
6222 Derivation:
6223 //RefBaseType// (restriction)
6224 [[image:inherit.gif||height="9" width="9"]] //ChildObjectRefBaseType// (restriction)
6225 [[image:inherit.gif||height="9" width="9"]] //ItemRefBaseType// (restriction)
6226 [[image:inherit.gif||height="9" width="9"]] UserDefinedOperatorRefType
6227
6228 Attributes:
6229 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
6230
6231 Content:
6232 {Empty}
6233
6234 Attribute Documentation:
6235
6236 |**Name**|**Type**|**Documentation**
6237 |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.
6238 |maintainableParentID|IDType|The maintainableParentID references the user defined operator scheme in which the user defined operator being referenced is defined.
6239 |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.
6240 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
6241 |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.
6242 |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.
6243 |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.
6244
6245 **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.
6246
6247 Derivation:
6248 //ReferenceType// (restriction)
6249 [[image:inherit.gif||height="9" width="9"]] //LocalItemReferenceType// (restriction)
6250 [[image:inherit.gif||height="9" width="9"]] LocalUserDefinedOperatorReferenceType
6251
6252 Content:
6253 Ref
6254
6255 Element Documentation:
6256
6257 |**Name**|**Type**|**Documentation**
6258 |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.
6259
6260 **LocalUserDefinedOperatorRefType: **LocalUserDefinedOperatorRefType references a user defined operator locally where the references to the user defined operator scheme which defines it is provided elsewhere.
6261
6262 Derivation:
6263 //RefBaseType// (restriction)
6264 [[image:inherit.gif||height="9" width="9"]] //LocalIdentifiableRefBaseType// (restriction)
6265 [[image:inherit.gif||height="9" width="9"]] //LocalItemRefBaseType// (restriction)
6266 [[image:inherit.gif||height="9" width="9"]] LocalUserDefinedOperatorRefType
6267
6268 Attributes:
6269 id, local?, class?, package?
6270
6271 Content:
6272 {Empty}
6273
6274 Attribute Documentation:
6275
6276 |**Name**|**Type**|**Documentation**
6277 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
6278 |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.
6279 |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.
6280 |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.
6281
6282 **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.
6283
6284 Derivation:
6285 //ReferenceType// (restriction)
6286 [[image:inherit.gif||height="9" width="9"]] //MaintainableReferenceBaseType// (restriction)
6287 [[image:inherit.gif||height="9" width="9"]] //ItemSchemeReferenceBaseType// (restriction)
6288 [[image:inherit.gif||height="9" width="9"]] CustomTypeSchemeReferenceType
6289
6290 Content:
6291 ( (Ref, URN?) | URN)
6292
6293 Element Documentation:
6294
6295 |**Name**|**Type**|**Documentation**
6296 |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.
6297 |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.
6298 |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.
6299
6300 **CustomTypeSchemeRefType: **CustomTypeSchemeRefType provides a reference to a custom type scheme via a complete set of reference fields.
6301
6302 Derivation:
6303 //RefBaseType// (restriction)
6304 [[image:inherit.gif||height="9" width="9"]] //MaintainableRefBaseType// (restriction)
6305 [[image:inherit.gif||height="9" width="9"]] //ItemSchemeRefBaseType// (restriction)
6306 [[image:inherit.gif||height="9" width="9"]] CustomTypeSchemeRefType
6307
6308 Attributes:
6309 agencyID, id, version?, local?, class?, package?
6310
6311 Content:
6312 {Empty}
6313
6314 Attribute Documentation:
6315
6316 |**Name**|**Type**|**Documentation**
6317 |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.
6318 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
6319 |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.
6320 |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.
6321 |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.
6322 |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.
6323
6324 **CustomTypeReferenceType: **CustomTypeReferenceType is a type for referencing a custom type object. It consists of a URN and/or a complete set of reference fields.
6325
6326 Derivation:
6327 //ReferenceType// (restriction)
6328 [[image:inherit.gif||height="9" width="9"]] //ChildObjectReferenceType// (restriction)
6329 [[image:inherit.gif||height="9" width="9"]] //ItemReferenceType// (restriction)
6330 [[image:inherit.gif||height="9" width="9"]] CustomTypeReferenceType
6331
6332 Content:
6333 ( (Ref, URN?) | URN)
6334
6335 Element Documentation:
6336
6337 |**Name**|**Type**|**Documentation**
6338 |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.
6339 |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.
6340 |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.
6341
6342 **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.
6343
6344 Derivation:
6345 //RefBaseType// (restriction)
6346 [[image:inherit.gif||height="9" width="9"]] //ChildObjectRefBaseType// (restriction)
6347 [[image:inherit.gif||height="9" width="9"]] //ItemRefBaseType// (restriction)
6348 [[image:inherit.gif||height="9" width="9"]] CustomTypeRefType
6349
6350 Attributes:
6351 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
6352
6353 Content:
6354 {Empty}
6355
6356 Attribute Documentation:
6357
6358 |**Name**|**Type**|**Documentation**
6359 |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.
6360 |maintainableParentID|IDType|The maintainableParentID references the custom mask scheme in which the custom type being referenced is defined.
6361 |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.
6362 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
6363 |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.
6364 |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.
6365 |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.
6366
6367 **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.
6368
6369 Derivation:
6370 //ReferenceType// (restriction)
6371 //LocalItemReferenceType// (restriction)
6372 LocalCustomTypeReferenceType
6373
6374 Content:
6375 Ref
6376
6377 Element Documentation:
6378
6379 |**Name**|**Type**|**Documentation**
6380 |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.
6381
6382 **LocalCustomTypeRefType: **LocalCustomTypeRefType references a custom type locally where the references to the custom type scheme which defines it is provided elsewhere.
6383
6384 Derivation:
6385 //RefBaseType// (restriction)
6386 //LocalIdentifiableRefBaseType// (restriction)
6387 //LocalItemRefBaseType// (restriction)
6388 LocalCustomTypeRefType
6389
6390 Attributes:
6391 id, local?, class?, package?
6392
6393 Content:
6394 {Empty}
6395
6396 Attribute Documentation:
6397
6398 |**Name**|**Type**|**Documentation**
6399 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
6400 |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.
6401 |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.
6402 |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.
6403
6404 **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.
6405
6406 Content:
6407 DataProvider, ID
6408
6409 Element Documentation:
6410
6411 |**Name**|**Type**|**Documentation**
6412 |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.
6413 |ID|IDType|ID contains the identifier of the data/metadata set being referenced.
6414
6415 **ObjectTypeListType: **ObjectTypeListType provides a means for enumerating object types.
6416
6417 Content:
6418 (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?)
6419
6420 Element Documentation:
6421
6422 |**Name**|**Type**|**Documentation**
6423 |Any|EmptyType|Any is an empty element that denotes an object of any type.
6424 |Agency|EmptyType|Agency is an empty element that denotes an agency object.
6425 |AgencyScheme|EmptyType|AgencyScheme is an empty element that denotes an agency scheme object.
6426 |AttachmentConstraint|EmptyType|AttachmentConstraint is an empty element that denotes an attachment constraint object.
6427 |Attribute|EmptyType|Attribute is an empty element that denotes an attribute object.
6428 |AttributeDescriptor|EmptyType|AttributeDescriptor is an empty element that denotes an attribute descriptor object.
6429 |Categorisation|EmptyType|Categorisation is an empty element that denotes a categorisation object.
6430 |Category|EmptyType|Category is an empty element that denotes a category object.
6431 |CategorySchemeMap|EmptyType|CategorySchemeMap is an empty element that denotes a category scheme map object.
6432 |CategoryScheme|EmptyType|CategoryScheme is an empty element that denotes a category scheme object.
6433 |Code|EmptyType|Code is an empty element that denotes a code object.
6434 |CodeMap|EmptyType|CodeMap is an empty element that denotes a code map object.
6435 |Codelist|EmptyType|Codelist is an empty element that denotes a code list object.
6436 |CodelistMap|EmptyType|CodelistMap is an empty element that denotes a code list map object.
6437 |ComponentMap|EmptyType|ComponentMap is an empty element that denotes a component map object.
6438 |Concept|EmptyType|Concept is an empty element that denotes a concept object.
6439 |ConceptMap|EmptyType|ConceptMap is an empty element that denotes a concept map object.
6440 |ConceptScheme|EmptyType|ConceptScheme is an empty element that denotes a concept scheme object.
6441 |ConceptSchemeMap|EmptyType|ConceptSchemeMap is an empty element that denotes a concept scheme map object.
6442 |ContentConstraint|EmptyType|ContentConstraint is an empty element that denotes a content constraint object.
6443 |CustomType|EmptyType|CustomType is an empty element that denotes a custom type object.
6444 |CustomTypeScheme|EmptyType|CustomTypeScheme is an empty element that denotes a custom type scheme object.
6445 |Dataflow|EmptyType|Dataflow is an empty element that denotes a data flow object.
6446 |DataConsumer|EmptyType|DataConsumer is an empty element that denotes a data consumer object.
6447 |DataConsumerScheme|EmptyType|DataConsumerScheme is an empty element that denotes a data consumer scheme object.
6448 |DataProvider|EmptyType|DataProvider is an empty element that denotes a data provider object.
6449 |DataProviderScheme|EmptyType|DataProviderScheme is an empty element that denotes a data provider scheme object.
6450 |DataSetTarget|EmptyType|DataSetTarget is an empty element that denotes a data set target object.
6451 |DataStructure|EmptyType|DataStructure is an empty element that denotes a data structure definition object.
6452 |Dimension|EmptyType|Dimension is an empty element that denotes a dimension object.
6453 |DimensionDescriptor|EmptyType|DimensionDescriptor is an empty element that denotes a dimension descriptor object.
6454 |DimensionDescriptorV aluesTarget|EmptyType|DimensionDescriptorValuesTarget is an empty element that denotes a dimension descriptor values target object.
6455 |GroupDimensionDescri ptor|EmptyType|GroupDimensionDescriptor is an empty element that denotes a group dimension descriptor object.
6456 |HierarchicalCode|EmptyType|HierarchicalCode is an empty element that denotes a hierarchical code object.
6457 |HierarchicalCodelist|EmptyType|HierarchicalCodelist is an empty element that denotes a hierarchical codelist object.
6458 |Hierarchy|EmptyType|Hierarchy is an empty element that denotes a hierarchy within a hiearcharchical codelist.
6459 |HybridCodelistMap|EmptyType|HybridCodelistMap is an empty element that denotes a hybrid codelist map object.
6460 |HybridCodeMap|EmptyType|HybridCodeMap is an empty element that denotes a hybrid code map object.
6461 |IdentifiableObjectTa rget|EmptyType|IdentifiableObjectTarget is an empty element that denotes an identifiable object target object.
6462 |Level|EmptyType|Level is an empty element that denotes a level object.
6463 |MeasureDescriptor|EmptyType|MeasureDescriptor is an empty element that denotes a measure descriptor object.
6464 |MeasureDimension|EmptyType|MeasureDimension is an empty element that denotes a measure dimension object.
6465 |Metadataflow|EmptyType|Metadataflow is an empty element that denotes a metadata flow object.
6466 |MetadataAttribute|EmptyType|MetadataAttribute is an empty element that denotes a metadata attribute object.
6467 |MetadataSet|EmptyType|MetadataSet is an empty element that denotes a metadata set object.
6468 |MetadataStructure|EmptyType|MetadataStructure is an empty element that denotes a metadata structure definition object.
6469 |MetadataTarget|EmptyType|MetadataTarget is an empty element that denotes a metadata target object.
6470 |NamePersonalisation|EmptyType|NamePersonalisation is an empty element that denotes a name personalisation object.
6471 |NamePersonalisationS cheme|EmptyType|NamePersonalisationScheme is an empty element that denotes a name personalisation scheme object.
6472 |OrganisationMap|EmptyType|OrganisationMap is an empty element that denotes an organisation map object.
6473 |OrganisationSchemeMa p|EmptyType|OrganisationSchemeMap is an empty element that denotes an organisation scheme map object.
6474 |OrganisationUnit|EmptyType|OrganisationUnit is an empty element that denotes an organisation unit object.
6475 |OrganisationUnitSche me|EmptyType|OrganisationUnitScheme is an empty element that denotes an organisation unit scheme object.
6476 |PrimaryMeasure|EmptyType|PrimaryMeasure is an empty element that denotes a primary measure object.
6477 |Process|EmptyType|Process is an empty element that denotes a process object.
6478 |ProcessStep|EmptyType|ProcessStep is an empty element that denotes a process step object.
6479 |ProvisionAgreement|EmptyType|ProvisionAgreement is an empty element that denotes a provision agreement object.
6480 |ReportingCategory|EmptyType|ReportingCategory is an empty element that denotes a reporting category object.
6481 |ReportingCategoryMap|EmptyType|ReportingCategoryMap is an empty element that denotes a reporting category map object.
6482 |ReportingTaxonomy|EmptyType|ReportingTaxonomy is an empty element that denotes a reporting taxonomy object.
6483 |ReportingTaxonomyMap|EmptyType|ReportingTaxonomyMap is an empty element that denotes a reporting taxonomy map object.
6484 |ReportPeriodTarget|EmptyType|ReportPeriodTarget is an empty element that denotes a report period target object.
6485 |ReportStructure|EmptyType|ReportStructure is an empty element that denotes a report structure object.
6486 |Ruleset|EmptyType|Ruleset is an empty element that denotes a ruleset object.
6487 |RulesetScheme|EmptyType|RulesetScheme is an empty element that denotes a ruleset scheme object.
6488 |StructureMap|EmptyType|StructureMap is an empty element that denotes a structure map object.
6489 |StructureSet|EmptyType|StructureSet is an empty element that denotes a structure set object.
6490 |TimeDimension|EmptyType|TimeDimension is an empty element that denotes a time dimension object.
6491 |Transformation|EmptyType|Transformation is an empty element that denotes a transformation object.
6492 |TransformationScheme|EmptyType|TransformationScheme is an empty element that denotes a transformation scheme object.
6493 |Transition|EmptyType|Transition is an empty element that denotes a transition object.
6494 |UserDefinedOperator|EmptyType|UserDefinedOperator is an empty element that denotes an user defined operator object.
6495 |UserDefinedOperatorS cheme|EmptyType|UserDefinedOperatorScheme is an empty element that denotes an user defined operator scheme object.
6496 |VtlMapping|EmptyType|VtlMapping is an empty element that denotes a VTL Mapping object.
6497 |VtlMappingScheme|EmptyType|VtlMappingScheme is an empty element that denotes a VTL mapping scheme object.
6498
6499 **MaintainableObjectTypeListType: **MaintainableObjectTypeListType provides a means for enumerating maintainable object types.
6500
6501 Derivation:
6502 ObjectTypeListType (restriction)
6503 [[image:inherit.gif||height="9" width="9"]] MaintainableObjectTypeListType
6504
6505 Content:
6506 (AgencyScheme?, AttachmentConstraint?, Categorisation?, CategoryScheme?, Codelist?, ConceptScheme?, ContentConstraint?, Dataflow?, DataConsumerScheme?, DataProviderScheme?, DataStructure?, HierarchicalCodelist?, Metadataflow?, MetadataStructure?, NamePersonalisationScheme?, OrganisationUnitScheme?, Process?, ProvisionAgreement?, ReportingTaxonomy?, RulesetScheme?, StructureSet?, TransformationScheme?, UserDefinedOperatorScheme?, VtlMappingScheme?)
6507
6508 Element Documentation:
6509
6510 |**Name**|**Type**|**Documentation**
6511 |AgencyScheme|EmptyType|AgencyScheme is an empty element that denotes an agency scheme object.
6512 |AttachmentConstraint|EmptyType|AttachmentConstraint is an empty element that denotes an attachment constraint object.
6513 |Categorisation|EmptyType|Categorisation is an empty element that denotes a categorisation object.
6514 |CategoryScheme|EmptyType|CategoryScheme is an empty element that denotes a category scheme object.
6515 |Codelist|EmptyType|Codelist is an empty element that denotes a code list object.
6516 |ConceptScheme|EmptyType|ConceptScheme is an empty element that denotes a concept scheme object.
6517 |ContentConstraint|EmptyType|ContentConstraint is an empty element that denotes a content constraint object.
6518 |Dataflow|EmptyType|Dataflow is an empty element that denotes a data flow object.
6519 |DataConsumerScheme|EmptyType|DataConsumerScheme is an empty element that denotes a data consumer scheme object.
6520 |DataProviderScheme|EmptyType|DataProviderScheme is an empty element that denotes a data provider scheme object.
6521 |DataStructure|EmptyType|DataStructure is an empty element that denotes a data structure definition object.
6522 |HierarchicalCodelist|EmptyType|HierarchicalCodelist is an empty element that denotes a hierarchical codelist object.
6523 |Metadataflow|EmptyType|Metadataflow is an empty element that denotes a metadata flow object.
6524 |MetadataStructure|EmptyType|MetadataStructure is an empty element that denotes a metadata structure definition object.
6525 |NamePersonalisationS cheme|EmptyType|NamePersonalisationScheme is an empty element that denotes a name personalisation scheme object.
6526 |OrganisationUnitSche me|EmptyType|OrganisationUnitScheme is an empty element that denotes an organisation unit scheme object.
6527 |Process|EmptyType|Process is an empty element that denotes a process object.
6528 |ProvisionAgreement|EmptyType|ProvisionAgreement is an empty element that denotes a provision agreement object.
6529 |ReportingTaxonomy|EmptyType|ReportingTaxonomy is an empty element that denotes a reporting taxonomy object.
6530 |RulesetScheme|EmptyType|RulesetScheme is an empty element that denotes a ruleset scheme object.
6531 |StructureSet|EmptyType|StructureSet is an empty element that denotes a structure set object.
6532 |TransformationScheme|EmptyType|TransformationScheme is an empty element that denotes a transformation scheme object.
6533 |UserDefinedOperatorS cheme|EmptyType|UserDefinedOperatorScheme is an empty element that denotes an user defined operator scheme object.
6534 |VtlMappingScheme|EmptyType|VtlMappingScheme is an empty element that denotes a VTL mapping scheme object.
6535
6536 === 2.1.4Simple Types ===
6537
6538 **AlphaNumericType: **AlphaNumericType is a reusable simple type that allows for only mixed-case alphabetical and numeric characters.
6539
6540 Derived by restriction of xs:string .
6541 Regular Expression Pattern: [A-Za-z0-9]+
6542
6543 **AlphaType: **AlphaType is a reusable simple type that allows for only mixed-case alphabetical characters. This is derived from the AlphaNumericType.
6544
6545 Derived by restriction of AlphaNumericType .
6546 Regular Expression Pattern: [A-Za-z]+
6547
6548 **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.
6549
6550 Derived by restriction of AlphaNumericType .
6551 Regular Expression Pattern: [0-9]+
6552
6553 **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.
6554
6555 Union of:
6556 xs:gYear, xs:gYearMonth, xs:date, xs:dateTime, ReportingYearType, ReportingSemesterType, ReportingTrimesterType, ReportingQuarterType, ReportingMonthType, ReportingWeekType, ReportingDayType, TimeRangeType.
6557
6558 **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).
6559
6560 Union of:
6561 xs:gYear, xs:gYearMonth, xs:date, xs:dateTime, ReportingYearType, ReportingSemesterType, ReportingTrimesterType, ReportingQuarterType, ReportingMonthType, ReportingWeekType, ReportingDayType.
6562
6563 **BasicTimePeriodType: **BasicTimePeriodType contains the basic dates and calendar periods. It is a combination of the Gregorian time periods and the date time type..
6564
6565 Union of:
6566 xs:gYear, xs:gYearMonth, xs:date, xs:dateTime.
6567
6568 **GregorianTimePeriodType: **GregorianTimePeriodType defines the set of standard calendar periods in SDMX.
6569
6570 Union of:
6571 xs:gYear, xs:gYearMonth, xs:date.
6572
6573 **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.
6574
6575 Union of:
6576 ReportingYearType, ReportingSemesterType, ReportingTrimesterType, ReportingQuarterType, ReportingMonthType, ReportingWeekType, ReportingDayType.
6577
6578 **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.
6579
6580 Derived by restriction of xs:string .
6581 Regular Expression Pattern: \d{4}\-([ASTQ]\d{1}|[MW]\d{2}|[D]\d{3})(Z|((\+|\-)\d{2}:\d{2}))?
6582
6583 **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.
6584
6585 Derived by restriction of BaseReportPeriodType .
6586 Regular Expression Pattern: .+Z.{5}.*(\+|\-)(14:00|((0[0-9]|1[0-3]):[0-5][0-9])).{5}[^\+\-Z]+
6587
6588 **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.
6589
6590 Derived by restriction of ReportPeriodValidTimeZoneType .
6591 Regular Expression Pattern: .{5}A1.*
6592
6593 **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.
6594
6595 Derived by restriction of ReportPeriodValidTimeZoneType .
6596 Regular Expression Pattern: .{5}S[1-2].*
6597
6598 **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.
6599
6600 Derived by restriction of ReportPeriodValidTimeZoneType .
6601 Regular Expression Pattern: .{5}T[1-3].*
6602
6603 **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.
6604
6605 Derived by restriction of ReportPeriodValidTimeZoneType .
6606 Regular Expression Pattern: .{5}Q[1-4].*
6607
6608 **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).
6609
6610 Derived by restriction of ReportPeriodValidTimeZoneType .
6611 Regular Expression Pattern: .{5}M(0[1-9]|1[0-2]).*
6612
6613 **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).
6614
6615 Derived by restriction of ReportPeriodValidTimeZoneType .
6616 Regular Expression Pattern: .{5}W(0[1-9]|[1-4][0-9]|5[0-3]).*
6617
6618 **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).
6619
6620 Derived by restriction of ReportPeriodValidTimeZoneType .
6621 Regular Expression Pattern: .{5}D(0[0-9][1-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-6]).*
6622
6623 **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.
6624
6625 Derived by restriction of xs:string .
6626 Regular Expression Pattern: \d{4}\-\d{2}\-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?)?(Z|((\+|\-)\d{2}:\d{2}))?/P.+
6627
6628 **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.
6629
6630 Derived by restriction of BaseTimeRangeType .
6631 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]).+
6632
6633 **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.
6634
6635 Derived by restriction of RangeValidMonthDayType .
6636 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]).+
6637
6638 **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.
6639
6640 Derived by restriction of RangeValidLeapYearType .
6641 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]+/.+
6642
6643 **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.
6644
6645 Derived by restriction of RangeValidTimeType .
6646 Regular Expression Pattern: .+Z/.+.{10}.*(\+|\-)(14:00|((0[0-9]|1[0-3]):[0-5][0-9]))/.+.{10}[^\+\-Z]+
6647
6648 **TimeRangeValidDateDurationType: **TimeRangeValidDateDurationType is an abstract derivation of the RangeValidTimeType which validates that duration provided is generally valid, up to the time component.
6649
6650 Derived by restriction of RangeValidTimeZoneType .
6651 Regular Expression Pattern: .+/P(\d+Y)?(\d+M)?(\d+D)?(T.+)?
6652
6653 **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.
6654
6655 Derived by restriction of TimeRangeValidDateDurationType .
6656 Regular Expression Pattern: .+/P.*T(\d+H)?(\d+M)?(\d+(.\d+)?S)?.+/P[^T]+
6657
6658 **TimezoneType: **TimezoneType defines the pattern for a time zone. An offset of -14:00 to +14:00 or Z can be specified.
6659
6660 Derived by restriction of xs:string .
6661 Regular Expression Pattern: Z(\+|\-)(14:00|((0[0-9]|1[0-3]):[0-5][0-9]))
6662
6663 **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.
6664
6665 Union of:
6666 MaxOccursNumberType, UnboundedCodeType.
6667
6668 **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.
6669
6670 Derived by restriction of xs:nonNegativeInteger .
6671 Minimum (inclusive): 1
6672 Fraction Digits: 0
6673
6674 **UnboundedCodeType: **UnboundedCodeType provides single textual value of "unbounded", for use in OccurentType.
6675
6676 Derived by restriction of xs:string .
6677
6678 Enumerations:
6679
6680 |**Value**|**Documentation**
6681 |unbounded|Object has no upper limit on occurrences.
6682
6683 **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.
6684
6685 Derived by restriction of xs:NMTOKEN .
6686
6687 Enumerations:
6688
6689 |**Value**|**Documentation**
6690 |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.
6691 |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.
6692 |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.
6693 |Information|Informational - data/metadata is being exchanged for informational purposes only, and not meant to update a system.
6694
6695 **WildCardValueType: **WildCardValueType is a single value code list, used to include the '%' character - indicating that an entire field is wild carded.
6696
6697 Derived by restriction of xs:string .
6698
6699 Enumerations:
6700
6701 |**Value**|**Documentation**
6702 |%|Indicates a wild card value.
6703
6704 **DimensionTypeType: **DimensionTypeType enumerates the sub-classes of a dimension.
6705
6706 Derived by restriction of xs:string .
6707
6708 Enumerations:
6709
6710 |**Value**|**Documentation**
6711 |Dimension|An ordinary dimension.
6712 |MeasureDimension|A measure dimension.
6713 |TimeDimension|The time dimension.
6714
6715 **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.
6716
6717 Derived by restriction of xs:string .
6718
6719 Enumerations:
6720
6721 |**Value**|**Documentation**
6722 |Allowed|The constraint contains the allowed values for attachable object.
6723 |Actual|The constraints contains the actual data present for the attachable object.
6724
6725 **SimpleOperatorType: **SimpleOperatorType provides an enumeration of simple operators to be applied to any value.
6726
6727 Derived by restriction of xs:string .
6728
6729 Enumerations:
6730
6731 |**Value**|**Documentation**
6732 |notEqual|(~!=) - value must not be equal to the value supplied.
6733 |equal|(=) - value must be exactly equal to the value supplied.
6734
6735 **RangeOperatorType: **RangeOperatorType provides an enumeration of range operators to be applied to an ordered value.
6736
6737 Derived by restriction of xs:string .
6738
6739 Enumerations:
6740
6741 |**Value**|**Documentation**
6742 |greaterThanOrEqual|(>=) - value must be greater than or equal to the value supplied.
6743 |lessThanOrEqual|(<=) - value must be less than or equal to the value supplied.
6744 |greaterThan|(>) - value must be greater than the value supplied.
6745 |lessThan|(<) - value must be less than the value supplied.
6746
6747 **TextSearchOperatorType: **TextSearchOperatorType provides an enumeration of text search operators.
6748
6749 Derived by restriction of xs:string .
6750
6751 Enumerations:
6752
6753 |**Value**|**Documentation**
6754 |contains|The text being searched must contain the supplied text.
6755 |startsWith|The text being searched must start with the supplied text.
6756 |endsWith|The text being searched must end with the supplied text.
6757 |doesNotContain|The text being searched cannot contain the supplied text.
6758 |doesNotStartWith|The text being searched cannot start with the supplied text.
6759 |doesNotEndWith|The text being searched cannot end with the supplied text.
6760
6761 **OrderedOperatorType: **OrderedOperatorType combines the SimpleOperatorType and the RangeOperatorType to provide a full range or operators for any ordered value.
6762
6763 Union of:
6764 SimpleOperatorType, RangeOperatorType.
6765
6766 **TextOperatorType:**
6767
6768 Union of:
6769 SimpleOperatorType, TextSearchOperatorType.
6770
6771 **TimeOperatorType: **TimeOperatorType derives from the OrderedOperatorType to remove the notEqual operator.
6772
6773 Derived by restriction of OrderedOperatorType .
6774
6775 Enumerations:
6776
6777 |**Value**|**Documentation**
6778 |equal|
6779 |greaterThanOrEqual|
6780 |lessThanOrEqual|
6781 |greaterThan|
6782 |lessThan|
6783
6784 **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".
6785
6786 Union of:
6787
6788 NCNameIDType, ObsDimensionsCodeType.
6789
6790 **ObsDimensionsCodeType: **ObsDimensionsCodeType is an enumeration containing the values "TimeDimension" and "AllDimensions"
6791
6792 Derived by restriction of xs:string .
6793
6794 Enumerations:
6795
6796 |**Value**|**Documentation**
6797 |AllDimensions|AllDimensions notes that the cross sectional format shall be flat; that is all dimensions should be contained at the observation level.
6798 |TIME_PERIOD|TIME_PERIOD refers to the fixed identifier for the time dimension.
6799
6800 **DataType: **DataTypeType provides an enumerated list of the types of data formats allowed as the for the representation of an object.
6801
6802 Derived by restriction of xs:NMTOKEN .
6803
6804 Enumerations:
6805
6806 |**Value**|**Documentation**
6807 |String|A string datatype corresponding to W3C XML Schema's xs:string datatype.
6808 |Alpha|A string datatype which only allows for the simple aplhabetic charcter set of A-Z, a-z.
6809 |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.
6810 |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.
6811 |BigInteger|An integer datatype corresponding to W3C XML Schema's xs:integer datatype.
6812 |Integer|An integer datatype corresponding to W3C XML Schema's xs:int datatype.
6813 |Long|A numeric datatype corresponding to W3C XML Schema's xs:long datatype.
6814 |Short|A numeric datatype corresponding to W3C XML Schema's xs:short datatype.
6815 |Decimal|A numeric datatype corresponding to W3C XML Schema's xs:decimal datatype.
6816 |Float|A numeric datatype corresponding to W3C XML Schema's xs:float datatype.
6817 |Double|A numeric datatype corresponding to W3C XML Schema's xs:double datatype.
6818 |Boolean|A datatype corresponding to W3C XML Schema's xs:boolean datatype.
6819 |URI|A datatype corresponding to W3C XML Schema's xs:anyURI datatype.
6820 |Count|A simple incrementing Integer type. The isSequence facet must be set to true, and the interval facet must be set to "1".
6821 |InclusiveValueRange|This value indicates that the startValue and endValue attributes provide the inclusive boundaries of a numeric range of type xs:decimal.
6822 |ExclusiveValueRange|This value indicates that the startValue and endValue attributes provide the exclusive boundaries of a numeric range, of type xs:decimal.
6823 |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.
6824 |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.
6825 |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.
6826 |BasicTimePeriod|BasicTimePeriod time periods is a superset of the Gregorian time periods and a date time.
6827 |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.
6828 |GregorianYear|A Gregorian time period corresponding to W3C XML Schema's xs:gYear datatype, which is based on ISO-8601.
6829 |GregorianYearMonth|A time datatype corresponding to W3C XML Schema's xs:gYearMonth datatype, which is based on ISO-8601.
6830 |GregorianDay|A time datatype corresponding to W3C XML Schema's xs:date datatype, which is based on ISO-8601.
6831 |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.
6832 |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.
6833 |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.
6834 |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.
6835 |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.
6836 |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.
6837 |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.
6838 |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.
6839 |DateTime|A time datatype corresponding to W3C XML Schema's xs:dateTime datatype.
6840 |TimeRange|TimeRange defines a time period by providing a distinct start (date or date time) and a duration.
6841 |Month|A time datatype corresponding to W3C XML Schema's xs:gMonth datatype.
6842 |MonthDay|A time datatype corresponding to W3C XML Schema's xs:gMonthDay datatype.
6843 |Day|A time datatype corresponding to W3C XML Schema's xs:gDay datatype.
6844 |Time|A time datatype corresponding to W3C XML Schema's xs:time datatype.
6845 |Duration|A time datatype corresponding to W3C XML Schema's xs:duration datatype.
6846 |XHTML|This value indicates that the content of the component can contain XHTML markup.
6847 |KeyValues|This value indicates that the content of the component will be data key (a set of dimension references and values for the dimensions).
6848 |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.
6849 |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.
6850 |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.
6851
6852 **BasicComponentDataType: **BasicComponentDataType provides an enumerated list of the types of characters allowed in the textType attribute for all non-target object components.
6853
6854 Derived by restriction of DataType .
6855
6856 Enumerations:
6857
6858 |**Value**|**Documentation**
6859 |String|A string datatype corresponding to W3C XML Schema's xs:string datatype.
6860 |Alpha|A string datatype which only allows for the simple aplhabetic charcter set of A-Z, a-z.
6861 |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.
6862 |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.
6863 |BigInteger|An integer datatype corresponding to W3C XML Schema's xs:integer datatype.
6864 |Integer|An integer datatype corresponding to W3C XML Schema's xs:int datatype.
6865 |Long|A numeric datatype corresponding to W3C XML Schema's xs:long datatype.
6866 |Short|A numeric datatype corresponding to W3C XML Schema's xs:short datatype.
6867 |Decimal|A numeric datatype corresponding to W3C XML Schema's xs:decimal datatype.
6868 |Float|A numeric datatype corresponding to W3C XML Schema's xs:float datatype.
6869 |Double|A numeric datatype corresponding to W3C XML Schema's xs:double datatype.
6870 |Boolean|A datatype corresponding to W3C XML Schema's xs:boolean datatype.
6871 |URI|A datatype corresponding to W3C XML Schema's xs:anyURI datatype.
6872 |Count|A simple incrementing Integer type. The isSequence facet must be set to true, and the interval facet must be set to "1".
6873 |InclusiveValueRange|This value indicates that the startValue and endValue attributes provide the inclusive boundaries of a numeric range of type xs:decimal.
6874 |ExclusiveValueRange|This value indicates that the startValue and endValue attributes provide the exclusive boundaries of a numeric range, of type xs:decimal.
6875 |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.
6876 |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.
6877 |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.
6878 |BasicTimePeriod|BasicTimePeriod time periods is a superset of the Gregorian time periods and a date time.
6879 |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.
6880 |GregorianYear|A Gregorian time period corresponding to W3C XML Schema's xs:gYear datatype, which is based on ISO-8601.
6881 |GregorianYearMonth|A time datatype corresponding to W3C XML Schema's xs:gYearMonth datatype, which is based on ISO-8601.
6882 |GregorianDay|A time datatype corresponding to W3C XML Schema's xs:date datatype, which is based on ISO-8601.
6883 |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.
6884 |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.
6885 |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.
6886 |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.
6887 |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.
6888 |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.
6889 |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.
6890 |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.
6891 |DateTime|A time datatype corresponding to W3C XML Schema's xs:dateTime datatype.
6892 |TimeRange|TimeRange defines a time period by providing a distinct start (date or date time) and a duration.
6893 |Month|A time datatype corresponding to W3C XML Schema's xs:gMonth datatype.
6894 |MonthDay|A time datatype corresponding to W3C XML Schema's xs:gMonthDay datatype.
6895 |Day|A time datatype corresponding to W3C XML Schema's xs:gDay datatype.
6896 |Time|A time datatype corresponding to W3C XML Schema's xs:time datatype.
6897 |Duration|A time datatype corresponding to W3C XML Schema's xs:duration datatype.
6898 |XHTML|This value indicates that the content of the component can contain XHTML markup.
6899
6900 **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.
6901
6902 Derived by restriction of BasicComponentDataType .
6903
6904 Enumerations:
6905
6906 |**Value**|**Documentation**
6907 |String|A string datatype corresponding to W3C XML Schema's xs:string datatype.
6908 |Alpha|A string datatype which only allows for the simple aplhabetic charcter set of A-Z, a-z.
6909 |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.
6910 |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.
6911 |BigInteger|An integer datatype corresponding to W3C XML Schema's xs:integer datatype.
6912 |Integer|An integer datatype corresponding to W3C XML Schema's xs:int datatype.
6913 |Long|A numeric datatype corresponding to W3C XML Schema's xs:long datatype.
6914 |Short|A numeric datatype corresponding to W3C XML Schema's xs:short datatype.
6915 |Decimal|A numeric datatype corresponding to W3C XML Schema's xs:decimal datatype.
6916 |Float|A numeric datatype corresponding to W3C XML Schema's xs:float datatype.
6917 |Double|A numeric datatype corresponding to W3C XML Schema's xs:double datatype.
6918 |Boolean|A datatype corresponding to W3C XML Schema's xs:boolean datatype.
6919 |URI|A datatype corresponding to W3C XML Schema's xs:anyURI datatype.
6920 |Count|A simple incrementing Integer type. The isSequence facet must be set to true, and the interval facet must be set to "1".
6921 |InclusiveValueRange|This value indicates that the startValue and endValue attributes provide the inclusive boundaries of a numeric range of type xs:decimal.
6922 |ExclusiveValueRange|This value indicates that the startValue and endValue attributes provide the exclusive boundaries of a numeric range, of type xs:decimal.
6923 |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.
6924 |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.
6925 |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.
6926 |BasicTimePeriod|BasicTimePeriod time periods is a superset of the Gregorian time periods and a date time.
6927 |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.
6928 |GregorianYear|A Gregorian time period corresponding to W3C XML Schema's xs:gYear datatype, which is based on ISO-8601.
6929 |GregorianYearMonth|A time datatype corresponding to W3C XML Schema's xs:gYearMonth datatype, which is based on ISO-8601.
6930 |GregorianDay|A time datatype corresponding to W3C XML Schema's xs:date datatype, which is based on ISO-8601.
6931 |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.
6932 |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.
6933 |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.
6934 |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.
6935 |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.
6936 |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.
6937 |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.
6938 |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.
6939 |DateTime|A time datatype corresponding to W3C XML Schema's xs:dateTime datatype.
6940 |TimeRange|TimeRange defines a time period by providing a distinct start (date or date time) and a duration.
6941 |Month|A time datatype corresponding to W3C XML Schema's xs:gMonth datatype.
6942 |MonthDay|A time datatype corresponding to W3C XML Schema's xs:gMonthDay datatype.
6943 |Day|A time datatype corresponding to W3C XML Schema's xs:gDay datatype.
6944 |Time|A time datatype corresponding to W3C XML Schema's xs:time datatype.
6945 |Duration|A time datatype corresponding to W3C XML Schema's xs:duration datatype.
6946
6947 **TimeDataType: **TimeDataType restricts SimpleDataType to specify the allowable data types for representing a time value.
6948
6949 Derived by restriction of SimpleDataType .
6950
6951 Enumerations:
6952
6953 (% style="width:968.835px" %)
6954 |**Value**|(% style="width:769px" %)**Documentation**
6955 |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.
6956 |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.
6957 |BasicTimePeriod|(% style="width:769px" %)BasicTimePeriod time periods is a superset of the Gregorian time periods and a date time.
6958 |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.
6959 |GregorianYear|(% style="width:769px" %)A Gregorian time period corresponding to W3C XML Schema's xs:gYear datatype, which is based on ISO-8601.
6960 |GregorianYearMonth|(% style="width:769px" %)A time datatype corresponding to W3C XML Schema's xs:gYearMonth datatype, which is based on ISO-8601.
6961 |GregorianDay|(% style="width:769px" %)A time datatype corresponding to W3C XML Schema's xs:date datatype, which is based on ISO-8601.
6962 |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.
6963 |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.
6964 |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.
6965 |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.
6966 |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.
6967 |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.
6968 |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.
6969 |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.
6970 |DateTime|(% style="width:769px" %)A time datatype corresponding to W3C XML Schema's xs:dateTime datatype.
6971 |TimeRange|(% style="width:769px" %)TimeRange defines a time period by providing a distinct start (date or date time) and a duration.
6972
6973 **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, _, -, $.
6974
6975 Derived by restriction of xs:string .
6976 Regular Expression Pattern: [A-Za-z0-9_@$\-]+(\.[A-Za-z0-9_@$\-]+)*
6977
6978 **TwoLevelIDType: **TwoLevelIDType defines an identifier with exactly two levels.
6979
6980 Derived by restriction of NestedIDType .
6981 Regular Expression Pattern: [A-Za-z0-9_@$\-]+\.[A-Za-z0-9_@$\-]+
6982
6983 **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, _, -, $.
6984
6985 Derived by restriction of NestedIDType .
6986 Regular Expression Pattern: [A-Za-z0-9_@$\-]+
6987
6988 **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.
6989
6990 Derived by restriction of IDType .
6991 Regular Expression Pattern: [A-Za-z][A-Za-z0-9_\-]*
6992
6993 **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.
6994
6995 Derived by restriction of NestedIDType .
6996 Regular Expression Pattern: [A-Za-z][A-Za-z0-9_\-]*(\.[A-Za-z][A-Za-z0-9_\-]*)*
6997
6998 **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).
6999
7000 Derived by restriction of NestedNCNameIDType .
7001 Regular Expression Pattern: [A-Za-z][A-Za-z0-9_\-]*
7002
7003 **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.
7004
7005 Derived by restriction of xs:string .
7006 Regular Expression Pattern: [0-9]+(\.[0-9]+)*
7007
7008 **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.
7009
7010 Union of:
7011 VersionType, LateBoundVersionType.
7012
7013 **LateBoundVersionType: **LateBoundVersionType is a single value code list, used to include the '*' character - indicating that the latest version of an object is required.
7014
7015 Derived by restriction of xs:string .
7016
7017 Enumerations:
7018
7019 |**Value**|**Documentation**
7020 |*|Indicates that the latest version of an object is requested.
7021
7022 **PackageTypeCodelistType: **PackageTypeCodelistType provides an enumeration of all SDMX package names.
7023
7024 Derived by restriction of xs:string .
7025
7026 Enumerations:
7027
7028 |**Value**|**Documentation**
7029 |base|
7030 |datastructure|
7031 |metadatastructure|
7032 |process|
7033 |registry|
7034 |mapping|
7035 |codelist|
7036 |categoryscheme|
7037 |conceptscheme|
7038 |transformation|
7039
7040 **ItemSchemePackageTypeCodelistType: **ItemSchemePackageTypeCodelistType provides an enumeration of all SDMX packages which contain item schemes.
7041
7042 Derived by restriction of PackageTypeCodelistType .
7043
7044 Enumerations:
7045
7046 |**Value**|**Documentation**
7047 |base|
7048 |codelist|
7049 |categoryscheme|
7050 |conceptscheme|
7051 |transformation|
7052
7053 **StructurePackageTypeCodelistType: **StructurePackageTypeCodelistType provides an enumeration of all SDMX packages which contain structure and structure usages.
7054
7055 Derived by restriction of PackageTypeCodelistType .
7056
7057 Enumerations:
7058
7059 |**Value**|**Documentation**
7060 |datastructure|
7061 |metadatastructure|
7062
7063 **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.
7064
7065 Derived by restriction of xs:string .
7066
7067 Enumerations:
7068
7069 |**Value**|**Documentation**
7070 |Any|
7071 |Agency|
7072 |AgencyScheme|
7073 |AttachmentConstraint|
7074 |Attribute|
7075 |AttributeDescriptor|
7076 |Categorisation|
7077 |Category|
7078 |CategorySchemeMap|
7079 |CategoryScheme|
7080 |Code|
7081 |CodeMap|
7082 |Codelist|
7083 |CodelistMap|
7084 |ComponentMap|
7085 |Concept|
7086 |ConceptMap|
7087 |ConceptScheme|
7088 |ConceptSchemeMap|
7089 |Constraint|
7090 |ConstraintTarget|
7091 |ContentConstraint|
7092 |CustomType|
7093 |CustomTypeScheme|
7094 |Dataflow|
7095 |DataConsumer|
7096 |DataConsumerScheme|
7097 |DataProvider|
7098 |DataProviderScheme|
7099 |DataSetTarget|
7100 |DataStructure|
7101 |DefinitionScheme|
7102 |Dimension|
7103 |DimensionDescriptor|
7104 |DimensionDescriptorValuesTarget|
7105 |GroupDimensionDescriptor|
7106 |HierarchicalCode|
7107 |HierarchicalCodelist|
7108 |Hierarchy|
7109 |HybridCodelistMap|
7110 |HybridCodeMap|
7111 |IdentifiableObjectTarget|
7112 |Level|
7113 |MeasureDescriptor|
7114 |MeasureDimension|
7115 |Metadataflow|
7116 |MetadataAttribute|
7117 |MetadataSet|
7118 |MetadataStructure|
7119 |MetadataTarget|
7120 |NamePersonalisation|
7121 |NamePersonalisationScheme|
7122 |Organisation|
7123 |OrganisationMap|
7124 |OrganisationScheme|
7125 |OrganisationSchemeMap|
7126 |OrganisationUnit|
7127 |OrganisationUnitScheme|
7128 |PrimaryMeasure|
7129 |Process|
7130 |ProcessStep|
7131 |ProvisionAgreement|
7132 |ReportingCategory|
7133 |ReportingCategoryMap|
7134 |ReportingTaxonomy|
7135 |ReportingTaxonomyMap|
7136 |ReportingYearStartDay|
7137 |ReportPeriodTarget|
7138 |ReportStructure|
7139 |Ruleset|
7140 |RulesetScheme|
7141 |StructureMap|
7142 |StructureSet|
7143 |TimeDimension|
7144 |Transformation|
7145 |TransformationScheme|
7146 |Transition|
7147 |UserDefinedOperator|
7148 |UserDefinedOperatorScheme|
7149 |VtlMapping|
7150 |VtlMappingScheme|
7151
7152 **MaintainableTypeCodelistType: **MaintainableTypeCodelistType provides an enumeration of all maintainable objects.
7153
7154 Derived by restriction of ObjectTypeCodelistType .
7155
7156 Enumerations:
7157
7158 |**Value**|**Documentation**
7159 |Any|
7160 |AgencyScheme|
7161 |AttachmentConstraint|
7162 |Categorisation|
7163 |CategoryScheme|
7164 |Codelist|
7165 |ConceptScheme|
7166 |Constraint|
7167 |ContentConstraint|
7168 |CustomTypeScheme|
7169 |Dataflow|
7170 |DataConsumerScheme|
7171 |DataProviderScheme|
7172 |DataStructure|
7173 |DefinitionScheme|
7174 |HierarchicalCodelist|
7175 |Metadataflow|
7176 |MetadataStructure|
7177 |NamePersonalisationScheme|
7178 |OrganisationScheme|
7179 |OrganisationUnitScheme|
7180 |Process|
7181 |ProvisionAgreement|
7182 |ReportingTaxonomy|
7183 |RulesetScheme|
7184 |StructureSet|
7185 |TransformationScheme|
7186 |UserDefinedOperatorScheme|
7187 |VtlMappingScheme|
7188
7189 **ConcreteMaintainableTypeCodelistType: **ConcreteMaintainableTypeCodelistType provides an enumeration of all concrete maintainable objects.
7190
7191 Derived by restriction of MaintainableTypeCodelistType .
7192
7193 Enumerations:
7194
7195 |**Value**|**Documentation**
7196 |AgencyScheme|
7197 |AttachmentConstraint|
7198 |Categorisation|
7199 |CategoryScheme|
7200 |Codelist|
7201 |ConceptScheme|
7202 |ContentConstraint|
7203 |CustomTypeScheme|
7204 |Dataflow|
7205 |DataConsumerScheme|
7206 |DataProviderScheme|
7207 |DataStructure|
7208 |HierarchicalCodelist|
7209 |Metadataflow|
7210 |MetadataStructure|
7211 |NamePersonalisationScheme|
7212 |OrganisationUnitScheme|
7213 |Process|
7214 |ProvisionAgreement|
7215 |ReportingTaxonomy|
7216 |RulesetScheme|
7217 |StructureSet|
7218 |TransformationScheme|
7219 |UserDefinedOperatorScheme|
7220 |VtlMappingScheme|
7221
7222 **CodelistTypeCodelistType: **CodelistTypeCodelistType provides an enumeration of all codelist objects.
7223
7224 Derived by restriction of MaintainableTypeCodelistType .
7225
7226 Enumerations:
7227
7228 |**Value**|**Documentation**
7229 |Codelist|
7230 |HierarchicalCodelist|
7231
7232 **CodeTypeCodelistType: **CodeTypeCodelistType provides an enumeration of all code objects.
7233
7234 Derived by restriction of ObjectTypeCodelistType .
7235
7236 Enumerations:
7237
7238 |**Value**|**Documentation**
7239 |Code|
7240 |HierarchicalCode|
7241
7242 **ConstraintTypeCodelistType: **ConstraintTypeCodelistType provides an enumeration of all constraint objects.
7243
7244 Derived by restriction of MaintainableTypeCodelistType .
7245
7246 Enumerations:
7247
7248 |**Value**|**Documentation**
7249 |AttachmentConstraint|
7250 |ContentConstraint|
7251
7252 **ItemSchemeTypeCodelistType: **ItemSchemeTypeCodelistType provides an enumeration of all item scheme objects.
7253
7254 Derived by restriction of MaintainableTypeCodelistType .
7255
7256 Enumerations:
7257
7258 |**Value**|**Documentation**
7259 |AgencyScheme|
7260 |CategoryScheme|
7261 |Codelist|
7262 |ConceptScheme|
7263 |CustomTypeScheme|
7264 |DataConsumerScheme|
7265 |DataProviderScheme|
7266 |NamePersonalisationScheme|
7267 |OrganisationUnitScheme|
7268 |ReportingTaxonomy|
7269 |RulesetScheme|
7270 |TransformationScheme|
7271 |UserDefinedOperatorScheme|
7272 |VtlMappingScheme|
7273
7274 **DefinitionSchemeTypeCodelistType: **DefinitionSchemeTypeCodelistType provides an enumeration of all definition scheme objects.
7275
7276 Derived by restriction of ItemSchemeTypeCodelistType .
7277
7278 Enumerations:
7279
7280 |**Value**|**Documentation**
7281 |CustomTypeScheme|
7282 |NamePersonalisationScheme|
7283 |RulesetScheme|
7284 |TransformationScheme|
7285 |UserDefinedOperatorScheme|
7286
7287 **OrganisationSchemeTypeCodelistType: **OrganisationSchemeTypeCodelistType provides an enumeration of all organisation scheme objects.
7288
7289 Derived by restriction of ItemSchemeTypeCodelistType .
7290
7291 Enumerations:
7292
7293 |**Value**|**Documentation**
7294 |AgencyScheme|
7295 |DataConsumerScheme|
7296 |DataProviderScheme|
7297 |OrganisationUnitScheme|
7298
7299 **OrganisationTypeCodelistType: **OrganisationTypeCodelistType provides an enumeration of all organisation objects.
7300
7301 Derived by restriction of ItemTypeCodelistType .
7302
7303 Enumerations:
7304
7305 |**Value**|**Documentation**
7306 |Agency|
7307 |DataConsumer|
7308 |DataProvider|
7309 |OrganisationUnit|
7310
7311 **StructureOrUsageTypeCodelistType: **StructureOrUsageTypeCodelistType provides an enumeration all structure and structure usage objects
7312
7313 Derived by restriction of MaintainableTypeCodelistType .
7314
7315 Enumerations:
7316
7317 |**Value**|**Documentation**
7318 |Dataflow|
7319 |DataStructure|
7320 |Metadataflow|
7321 |MetadataStructure|
7322
7323 **StructureTypeCodelistType: **StructureTypeCodelistType provides an enumeration all structure objects
7324
7325 Derived by restriction of StructureOrUsageTypeCodelistType .
7326
7327 Enumerations:
7328
7329 |**Value**|**Documentation**
7330 |DataStructure|
7331 |MetadataStructure|
7332
7333 **StructureUsageTypeCodelistType: **StructureUsageTypeCodelistType provides an enumeration all structure usage objects
7334
7335 Derived by restriction of StructureOrUsageTypeCodelistType .
7336
7337 Enumerations:
7338
7339 |**Value**|**Documentation**
7340 |Dataflow|
7341 |Metadataflow|
7342
7343 **ItemTypeCodelistType: **ItemTypeCodelistType provides an enumeration of all item objects.
7344
7345 Derived by restriction of ObjectTypeCodelistType .
7346
7347 Enumerations:
7348
7349 |**Value**|**Documentation**
7350 |Agency|
7351 |Category|
7352 |Code|
7353 |Concept|
7354 |CustomType|
7355 |DataConsumer|
7356 |DataProvider|
7357 |NamePersonalisation|
7358 |OrganisationUnit|
7359 |ReportingCategory|
7360 |Ruleset|
7361 |Transformation|
7362 |UserDefinedOperator|
7363 |VtlMapping|
7364
7365 **ComponentListTypeCodelistType: **ComponentListTypeCodelistType provides an enumeration of all component list objects.
7366
7367 Derived by restriction of ObjectTypeCodelistType .
7368
7369 Enumerations:
7370
7371 |**Value**|**Documentation**
7372 |AttributeDescriptor|
7373 |DimensionDescriptor|
7374 |GroupDimensionDescriptor|
7375 |MeasureDescriptor|
7376 |MetadataTarget|
7377 |ReportStructure|
7378
7379 **ComponentTypeCodelistType: **ComponentTypeCodelistType provides an enumeration of all component objects.
7380
7381 Derived by restriction of ObjectTypeCodelistType .
7382
7383 Enumerations:
7384
7385 |**Value**|**Documentation**
7386 |Attribute|
7387 |ConstraintTarget|
7388 |DataSetTarget|
7389 |Dimension|
7390 |IdentifiableObjectTarget|
7391 |DimensionDescriptorValuesTarget|
7392 |MeasureDimension|
7393 |MetadataAttribute|
7394 |PrimaryMeasure|
7395 |ReportingYearStartDay|
7396 |ReportPeriodTarget|
7397 |TimeDimension|
7398
7399 **DataStructureComponentTypeCodelistType: **DataStructureComponentTypeCodelistType provides an enumeration of all data structure component objects, except for the primary measure.
7400
7401 Derived by restriction of ComponentTypeCodelistType .
7402
7403 Enumerations:
7404
7405 |**Value**|**Documentation**
7406 |Attribute|
7407 |Dimension|
7408 |MeasureDimension|
7409 |PrimaryMeasure|
7410 |ReportingYearStartDay|
7411 |TimeDimension|
7412
7413 **DimensionEumerationSchemeTypeCodelistType: **DimensionEumerationSchemeTypeCodelistType provides an enumeration of all item schemes which are allowable as the representation of a data structure definition component.
7414
7415 Derived by restriction of ItemSchemeTypeCodelistType .
7416
7417 Enumerations:
7418
7419 |**Value**|**Documentation**
7420 |Codelist|
7421 |ConceptScheme|
7422
7423 **MetadataStructureComponentTypeCodelistType: **MetadataStructureComponentTypeCodelistType provides an enumeration of all metadata structure component objects.
7424
7425 Derived by restriction of ComponentTypeCodelistType .
7426
7427 Enumerations:
7428
7429 |**Value**|**Documentation**
7430 |ConstraintTarget|
7431 |DataSetTarget|
7432 |IdentifiableObjectTarget|
7433 |DimensionDescriptorValuesTarget|
7434 |MetadataAttribute|
7435 |ReportPeriodTarget|
7436
7437 **DimensionTypeCodelistType: **DimensionTypeCodelistType provides an enumeration of all dimension objects.
7438
7439 Derived by restriction of ComponentTypeCodelistType .
7440
7441 Enumerations:
7442
7443 |**Value**|**Documentation**
7444 |Dimension|
7445 |MeasureDimension|
7446 |TimeDimension|
7447
7448 **TargetObjectTypeCodelistType: **TargetObjectTypeCodelistType provides an enumeration of all target object objects.
7449
7450 Derived by restriction of ComponentTypeCodelistType .
7451
7452 Enumerations:
7453
7454 |**Value**|**Documentation**
7455 |ConstraintTarget|
7456 |DataSetTarget|
7457 |IdentifiableObjectTarget|
7458 |DimensionDescriptorValuesTarget|
7459 |ReportPeriodTarget|
© Semantic R&D Group, 2026