Skip to Content

Wiki source code of Part II.Common

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