Skip to Content

Wiki source code of Part II.Common

Version 6.1 by Artur K. on 2025/06/27 11:05
Show last authors
1 = 1Introduction =
2
3 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.
4
5 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.
6
7 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.
8
9 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.
10
11 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.
12
13 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.
14
15 = 2Schema Documentation =
16
17 == 2.1Common Namespace ==
18
19 **http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/common**
20
21 === 2.1.1Summary ===
22
23 Referenced Namespaces:
24
25 |**Namespace**|**Prefix**
26 | |
27 |http:~/~/www.w3.org/1999/xhtml|
28 |http:~/~/www.w3.org/2001/XMLSchema|xs
29
30 Contents:
31
32 81 Global Elements
33 292 Complex Types
34 77 Simple Types
35
36 === 2.1.2Global Elements ===
37
38 **Name (TextType): **Name is a reusable element, used for providing a human-readable name for an object.
39
40 **Description (TextType): **Description is a reusable element, used for providing a longer human-readable description of an object.
41
42 **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).
43
44 **StructuredText (XHTMLType): **StructuredText is a reusable element, used for providing a language specific text value structured as XHTML.
45
46 **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.
47
48 **Any (EmptyType): **Any is an empty element that denotes an object of any type.
49
50 **Agency (EmptyType): **Agency is an empty element that denotes an agency object.
51
52 **AgencyScheme (EmptyType): **AgencyScheme is an empty element that denotes an agency scheme object.
53
54 **AttachmentConstraint (EmptyType): **AttachmentConstraint is an empty element that denotes an attachment constraint object.
55
56 **Attribute (EmptyType): **Attribute is an empty element that denotes an attribute object.
57
58 **AttributeDescriptor (EmptyType): **AttributeDescriptor is an empty element that denotes an attribute descriptor object.
59
60 **Categorisation (EmptyType): **Categorisation is an empty element that denotes a categorisation object.
61
62 **Category (EmptyType): **Category is an empty element that denotes a category object.
63
64 **CategorySchemeMap (EmptyType): **CategorySchemeMap is an empty element that denotes a category scheme map object.
65
66 **CategoryScheme (EmptyType): **CategoryScheme is an empty element that denotes a category scheme object.
67
68 **Code (EmptyType): **Code is an empty element that denotes a code object.
69
70 **CodeMap (EmptyType): **CodeMap is an empty element that denotes a code map object.
71
72 **Codelist (EmptyType): **Codelist is an empty element that denotes a code list object.
73
74 **CodelistMap (EmptyType): **CodelistMap is an empty element that denotes a code list map object.
75
76 **ComponentMap (EmptyType): **ComponentMap is an empty element that denotes a component map object.
77
78 **Concept (EmptyType): **Concept is an empty element that denotes a concept object.
79
80 **ConceptMap (EmptyType): **ConceptMap is an empty element that denotes a concept map object.
81
82 **ConceptScheme (EmptyType): **ConceptScheme is an empty element that denotes a concept scheme object.
83
84 **ConceptSchemeMap (EmptyType): **ConceptSchemeMap is an empty element that denotes a concept scheme map object.
85
86 **ConstraintTarget (EmptyType): **ConstraintTarget is an empty element that denotes a constraint target object.
87
88 **ContentConstraint (EmptyType): **ContentConstraint is an empty element that denotes a content constraint object.
89
90 **CustomType (EmptyType): **CustomType is an empty element that denotes a custom type object.
91
92 **CustomTypeScheme (EmptyType): **CustomTypeScheme is an empty element that denotes a custom type scheme object.
93
94 **Dataflow (EmptyType): **Dataflow is an empty element that denotes a data flow object.
95
96 **DataConsumer (EmptyType): **DataConsumer is an empty element that denotes a data consumer object.
97
98 **DataConsumerScheme (EmptyType): **DataConsumerScheme is an empty element that denotes a data consumer scheme object.
99
100 **DataProvider (EmptyType): **DataProvider is an empty element that denotes a data provider object.
101
102 **DataProviderScheme (EmptyType): **DataProviderScheme is an empty element that denotes a data provider scheme object.
103
104 **DataSetTarget (EmptyType): **DataSetTarget is an empty element that denotes a data set target object.
105
106 **DataStructure (EmptyType): **DataStructure is an empty element that denotes a data structure definition object.
107
108 **Dimension (EmptyType): **Dimension is an empty element that denotes a dimension object.
109
110 **DimensionDescriptor (EmptyType): **DimensionDescriptor is an empty element that denotes a dimension descriptor object.
111
112 **DimensionDescriptorValuesTarget (EmptyType): **DimensionDescriptorValuesTarget is an empty element that denotes a dimension descriptor values target object.
113
114 **GroupDimensionDescriptor (EmptyType): **GroupDimensionDescriptor is an empty element that denotes a group dimension descriptor object.
115
116 **HierarchicalCode (EmptyType): **HierarchicalCode is an empty element that denotes a hierarchical code object.
117
118 **HierarchicalCodelist (EmptyType): **HierarchicalCodelist is an empty element that denotes a hierarchical codelist object.
119
120 **Hierarchy (EmptyType): **Hierarchy is an empty element that denotes a hierarchy within a hiearcharchical codelist.
121
122 **HybridCodelistMap (EmptyType): **HybridCodelistMap is an empty element that denotes a hybrid codelist map object.
123
124 **HybridCodeMap (EmptyType): **HybridCodeMap is an empty element that denotes a hybrid code map object.
125
126 **IdentifiableObjectTarget (EmptyType): **IdentifiableObjectTarget is an empty element that denotes an identifiable object target object.
127
128 **Level (EmptyType): **Level is an empty element that denotes a level object.
129
130 **MeasureDescriptor (EmptyType): **MeasureDescriptor is an empty element that denotes a measure descriptor object.
131
132 **MeasureDimension (EmptyType): **MeasureDimension is an empty element that denotes a measure dimension object.
133
134 **Metadataflow (EmptyType): **Metadataflow is an empty element that denotes a metadata flow object.
135
136 **MetadataAttribute (EmptyType): **MetadataAttribute is an empty element that denotes a metadata attribute object.
137
138 **MetadataSet (EmptyType): **MetadataSet is an empty element that denotes a metadata set object.
139
140 **MetadataStructure (EmptyType): **MetadataStructure is an empty element that denotes a metadata structure definition object.
141
142 **MetadataTarget (EmptyType): **MetadataTarget is an empty element that denotes a metadata target object.
143
144 **NamePersonalisation (EmptyType): **NamePersonalisation is an empty element that denotes a name personalisation object.
145
146 **NamePersonalisationScheme (EmptyType): **NamePersonalisationScheme is an empty element that denotes a name personalisation scheme object.
147
148 **OrganisationMap (EmptyType): **OrganisationMap is an empty element that denotes an organisation map object.
149
150 **OrganisationSchemeMap (EmptyType): **OrganisationSchemeMap is an empty element that denotes an organisation scheme map object.
151
152 **OrganisationUnit (EmptyType): **OrganisationUnit is an empty element that denotes an organisation unit object.
153
154 **OrganisationUnitScheme (EmptyType): **OrganisationUnitScheme is an empty element that denotes an organisation unit scheme object.
155
156 **PrimaryMeasure (EmptyType): **PrimaryMeasure is an empty element that denotes a primary measure object.
157
158 **Process (EmptyType): **Process is an empty element that denotes a process object.
159
160 **ProcessStep (EmptyType): **ProcessStep is an empty element that denotes a process step object.
161
162 **ProvisionAgreement (EmptyType): **ProvisionAgreement is an empty element that denotes a provision agreement object.
163
164 **ReportingCategory (EmptyType): **ReportingCategory is an empty element that denotes a reporting category object.
165
166 **ReportingCategoryMap (EmptyType): **ReportingCategoryMap is an empty element that denotes a reporting category map object.
167
168 **ReportingTaxonomy (EmptyType): **ReportingTaxonomy is an empty element that denotes a reporting taxonomy object.
169
170 **ReportingTaxonomyMap (EmptyType): **ReportingTaxonomyMap is an empty element that denotes a reporting taxonomy map object.
171
172 **ReportPeriodTarget (EmptyType): **ReportPeriodTarget is an empty element that denotes a report period target object.
173
174 **ReportStructure (EmptyType): **ReportStructure is an empty element that denotes a report structure object.
175
176 **Ruleset (EmptyType): **Ruleset is an empty element that denotes a ruleset object.
177
178 **RulesetScheme (EmptyType): **RulesetScheme is an empty element that denotes a ruleset scheme object.
179
180 **StructureMap (EmptyType): **StructureMap is an empty element that denotes a structure map object.
181
182 **StructureSet (EmptyType): **StructureSet is an empty element that denotes a structure set object.
183
184 **TimeDimension (EmptyType): **TimeDimension is an empty element that denotes a time dimension object.
185
186 **Transformation (EmptyType): **Transformation is an empty element that denotes a transformation object.
187
188 **TransformationScheme (EmptyType): **TransformationScheme is an empty element that denotes a transformation scheme object.
189
190 **Transition (EmptyType): **Transition is an empty element that denotes a transition object.
191
192 **UserDefinedOperator (EmptyType): **UserDefinedOperator is an empty element that denotes an user defined operator object.
193
194 **UserDefinedOperatorScheme (EmptyType): **UserDefinedOperatorScheme is an empty element that denotes an user defined operator scheme object.
195
196 **VtlMapping (EmptyType): **VtlMapping is an empty element that denotes a VTL Mapping object.
197
198 **VtlMappingScheme (EmptyType): **VtlMappingScheme is an empty element that denotes a VTL mapping scheme object.
199
200 === 2.1.3Complex Types ===
201
202 **TextType: **TextType provides for a set of language-specific alternates to be provided for any human-readable constructs in the instance.
203
204 Derivation:
205
206 xs:anySimpleType (restriction)
207 [[image:inherit.gif||height="9" width="9"]] xs:string (extension)
208 [[image:inherit.gif||height="9" width="9"]] TextType
209
210 Attributes:
211
212 xml:lang?
213
214 Content:
215
216 Attribute Documentation:
217
218 |**Name**|**Type**|**Documentation**
219 |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.
220
221 **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.
222
223 Attributes:
224
225 code?
226
227 Content:
228
229 Text+
230
231 Attribute Documentation:
232
233 |**Name**|**Type**|**Documentation**
234 |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.
235
236 Element Documentation:
237
238 |**Name**|**Type**|**Documentation**
239 |Text|TextType|Text contains the text of the message, in parallel language values.
240
241 **CodedStatusMessageType: **CodedStatusMessageType describes the structure of an error or warning message which required a code.
242
243 Derivation:
244
245 StatusMessageType (restriction)
246 [[image:inherit.gif||height="9" width="9"]] CodedStatusMessageType
247
248 Attributes:
249
250 code
251
252 Content:
253
254 Text+
255
256 Attribute Documentation:
257
258 |**Name**|**Type**|**Documentation**
259 |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.
260
261 Element Documentation:
262
263 |**Name**|**Type**|**Documentation**
264 |Text|TextType|Text contains the text of the message, in parallel language values.
265
266 //**AnnotableType**//**: **AnnotableType is an abstract base type used for all annotable artefacts. Any type that provides for annotations should extend this type.
267
268 Content:
269
270 Annotations?
271
272 Element Documentation:
273
274 |**Name**|**Type**|**Documentation**
275 |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.
276
277 **AnnotationsType: **AnnotationsType provides for a list of annotations to be attached to data and structure messages.
278
279 Content:
280
281 Annotation+
282
283 Element Documentation:
284
285 |**Name**|**Type**|**Documentation**
286 |Annotation|AnnotationType|
287
288 **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.
289
290 Attributes:
291
292 id?
293
294 Content:
295
296 AnnotationTitle?, AnnotationType?, AnnotationURL?, AnnotationText*
297
298 Attribute Documentation:
299
300 |**Name**|**Type**|**Documentation**
301 |id|xs:string|The id attribute provides a non-standard identification of an annotation. It can be used to disambiguate annotations.
302
303 Element Documentation:
304
305 |**Name**|**Type**|**Documentation**
306 |AnnotationTitle|xs:string|AnnotationTitle provides a title for the annotation.
307 |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.
308 |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.
309 |AnnotationText|TextType|AnnotationText holds a language-specific string containing the text of the annotation.
310
311 **ReferencePeriodType: **Specifies the inclusive start and end times.
312
313 Attributes:
314
315 startTime, endTime
316
317 Content:
318
319 {Empty}
320
321 Attribute Documentation:
322
323 |**Name**|**Type**|**Documentation**
324 |startTime|xs:dateTime|The startTime attributes contains the inclusive start date for the reference period.
325 |endTime|xs:dateTime|The endTime attributes contains the inclusive end date for the reference period.
326
327 **QueryableDataSourceType: **QueryableDataSourceType describes a data source which is accepts an standard SDMX Query message and responds appropriately.
328
329 Attributes:
330
331 isRESTDatasource, isWebServiceDatasource
332
333 Content:
334
335 DataURL, WSDLURL?, WADLURL?
336
337 Attribute Documentation:
338
339 |**Name**|**Type**|**Documentation**
340 |isRESTDatasource|xs:boolean|The isRESTDatasource attribute indicates, if true, that the queryable data source is accessible via the REST protocol.
341 |isWebServiceDatasource|xs:boolean|The isWebServiceDatasource attribute indicates, if true, that the queryable data source is accessible via Web Services protocols.
342
343 Element Documentation:
344
345 |**Name**|**Type**|**Documentation**
346 |DataURL|xs:anyURI|DataURL contains the URL of the data source.
347 |WSDLURL|xs:anyURI|WSDLURL provides the location of a WSDL instance on the internet which describes the queryable data source.
348 |WADLURL|xs:anyURI|WADLURL provides the location of a WADL instance on the internet which describes the REST protocol of the queryable data source.
349
350 **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.
351
352 Attributes:
353
354 xml:lang?
355
356 Content:
357
358 {text} x {any element with namespace of http:~/~/www.w3.org/1999/xhtml}*
359
360 Attribute Documentation:
361
362 |**Name**|**Type**|**Documentation**
363 |xml:lang (default: en)|xs:language|
364
365 //**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.
366
367 Attributes:
368
369 include?
370
371 Content:
372
373 KeyValue*, Attribute*
374
375 Attribute Documentation:
376
377 |**Name**|**Type**|**Documentation**
378 |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.
379
380 Element Documentation:
381
382 |**Name**|**Type**|**Documentation**
383 |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.
384 |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.
385
386 //**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.
387
388 Attributes:
389
390 id, include?
391
392 Content:
393
394 (Value+ | DataSet+ | DataKey+ | Object+ | TimeRange)?
395
396 Attribute Documentation:
397
398 |**Name**|**Type**|**Documentation**
399 |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.
400 |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.
401
402 Element Documentation:
403
404 |**Name**|**Type**|**Documentation**
405 |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.
406 |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.
407 |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.
408 |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.
409 |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).
410
411 //**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.
412
413 Derivation:
414
415 //RegionType// (restriction)
416 [[image:inherit.gif||height="9" width="9"]] //DistinctKeyType//
417
418 Attributes:
419
420 include?
421
422 Content:
423
424 KeyValue+
425
426 Attribute Documentation:
427
428 |**Name**|**Type**|**Documentation**
429 |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.
430
431 Element Documentation:
432
433 |**Name**|**Type**|**Documentation**
434 |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.
435
436 //**DinstinctKeyValueType**//**: **DinstinctKeyValueType is an abstract base type which defines a singular, required value for a key component.
437
438 Derivation:
439
440 //ComponentValueSetType// (restriction)
441 [[image:inherit.gif||height="9" width="9"]] //DinstinctKeyValueType//
442
443 Attributes:
444
445 id, include?
446
447 Content:
448
449 (Value | DataSet | DataKey | Object)
450
451 Attribute Documentation:
452
453 |**Name**|**Type**|**Documentation**
454 |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.
455 |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.
456
457 Element Documentation:
458
459 |**Name**|**Type**|**Documentation**
460 |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.
461 |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.
462 |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.
463 |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.
464
465 **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.
466
467 Derivation:
468
469 //RegionType// (restriction)
470 [[image:inherit.gif||height="9" width="9"]] //DistinctKeyType// (restriction)
471 [[image:inherit.gif||height="9" width="9"]] DataKeyType
472
473 Attributes:
474
475 include?
476
477 Content:
478
479 KeyValue+
480
481 Attribute Documentation:
482
483 |**Name**|**Type**|**Documentation**
484 |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.
485
486 Element Documentation:
487
488 |**Name**|**Type**|**Documentation**
489 |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.
490
491 **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.
492
493 Derivation:
494
495 //ComponentValueSetType// (restriction)
496 [[image:inherit.gif||height="9" width="9"]] //DinstinctKeyValueType// (restriction)
497 [[image:inherit.gif||height="9" width="9"]] DataKeyValueType
498
499 Attributes:
500
501 id, include?
502
503 Content:
504
505 Value
506
507 Attribute Documentation:
508
509 |**Name**|**Type**|**Documentation**
510 |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.
511 |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.
512
513 Element Documentation:
514
515 |**Name**|**Type**|**Documentation**
516 |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.
517
518 **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.
519
520 Derivation:
521
522 //RegionType// (restriction)
523 [[image:inherit.gif||height="9" width="9"]] //DistinctKeyType// (restriction)
524 [[image:inherit.gif||height="9" width="9"]] MetadataKeyType
525
526 Attributes:
527
528 include?, report, metadataTarget
529
530 Content:
531
532 KeyValue+
533
534 Attribute Documentation:
535
536 |**Name**|**Type**|**Documentation**
537 |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.
538 |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.
539 |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.
540
541 Element Documentation:
542
543 |**Name**|**Type**|**Documentation**
544 |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.
545
546 **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.
547
548 Derivation:
549
550 //ComponentValueSetType// (restriction)
551 [[image:inherit.gif||height="9" width="9"]] //DinstinctKeyValueType// (restriction)
552 [[image:inherit.gif||height="9" width="9"]] MetadataKeyValueType
553
554 Attributes:
555
556 id, include?
557
558 Content:
559
560 (Value | DataSet | DataKey | Object)
561
562 Attribute Documentation:
563
564 |**Name**|**Type**|**Documentation**
565 |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.
566 |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.
567
568 Element Documentation:
569
570 |**Name**|**Type**|**Documentation**
571 |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.
572 |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.
573 |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.
574 |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.
575
576 **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.
577
578 Derivation:
579
580 //RegionType// (restriction)
581 [[image:inherit.gif||height="9" width="9"]] CubeRegionType
582
583 Attributes:
584
585 include?
586
587 Content:
588
589 KeyValue*, Attribute*
590
591 Attribute Documentation:
592
593 |**Name**|**Type**|**Documentation**
594 |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.
595
596 Element Documentation:
597
598 |**Name**|**Type**|**Documentation**
599 |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.
600 |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.
601
602 **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.
603
604 Derivation:
605
606 //RegionType// (restriction)
607 [[image:inherit.gif||height="9" width="9"]] MetadataTargetRegionType
608
609 Attributes:
610
611 include?, report, metadataTarget
612
613 Content:
614
615 KeyValue*, Attribute*
616
617 Attribute Documentation:
618
619 |**Name**|**Type**|**Documentation**
620 |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.
621 |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.
622 |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.
623
624 Element Documentation:
625
626 |**Name**|**Type**|**Documentation**
627 |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.
628 |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.
629
630 **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.
631
632 Derivation:
633
634 //ComponentValueSetType// (restriction)
635 [[image:inherit.gif||height="9" width="9"]] CubeRegionKeyType
636
637 Attributes:
638
639 id, include?
640
641 Content:
642
643 (Value+ | TimeRange)
644
645 Attribute Documentation:
646
647 |**Name**|**Type**|**Documentation**
648 |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.
649 |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.
650
651 Element Documentation:
652
653 |**Name**|**Type**|**Documentation**
654 |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.
655 |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).
656
657 **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.
658
659 Derivation:
660
661 //ComponentValueSetType// (restriction)
662 [[image:inherit.gif||height="9" width="9"]] MetadataTargetRegionKeyType
663
664 Attributes:
665
666 id, include?
667
668 Content:
669
670 (Value+ | DataSet+ | DataKey+ | Object+ | TimeRange)
671
672 Attribute Documentation:
673
674 |**Name**|**Type**|**Documentation**
675 |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.
676 |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.
677
678 Element Documentation:
679
680 |**Name**|**Type**|**Documentation**
681 |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.
682 |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.
683 |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.
684 |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.
685 |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).
686
687 **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.
688
689 Derivation:
690
691 //ComponentValueSetType// (restriction)
692 [[image:inherit.gif||height="9" width="9"]] AttributeValueSetType
693
694 Attributes:
695
696 id, include?
697
698 Content:
699
700 (Value+ | TimeRange)?
701
702 Attribute Documentation:
703
704 |**Name**|**Type**|**Documentation**
705 |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.
706 |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.
707
708 Element Documentation:
709
710 |**Name**|**Type**|**Documentation**
711 |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.
712 |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).
713
714 **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.
715
716 Derivation:
717
718 //ComponentValueSetType// (restriction)
719 [[image:inherit.gif||height="9" width="9"]] MetadataAttributeValueSetType
720
721 Attributes:
722
723 id, include?
724
725 Content:
726
727 (Value+ | TimeRange)?
728
729 Attribute Documentation:
730
731 |**Name**|**Type**|**Documentation**
732 |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.
733 |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.
734
735 Element Documentation:
736
737 |**Name**|**Type**|**Documentation**
738 |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.
739 |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).
740
741 **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.
742
743 Derivation:
744
745 xs:anySimpleType (restriction)
746 [[image:inherit.gif||height="9" width="9"]] xs:string (extension)
747 [[image:inherit.gif||height="9" width="9"]] SimpleValueType
748
749 Attributes:
750
751 cascadeValues?
752
753 Content:
754
755 Attribute Documentation:
756
757 |**Name**|**Type**|**Documentation**
758 |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.
759
760 **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.
761
762 Derivation:
763
764 xs:anySimpleType (restriction)
765 [[image:inherit.gif||height="9" width="9"]] xs:string (extension)
766 [[image:inherit.gif||height="9" width="9"]] SimpleValueType (restriction)
767 [[image:inherit.gif||height="9" width="9"]] SimpleKeyValueType
768
769 Content:
770
771 **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.
772
773 Content:
774
775 (BeforePeriod | AfterPeriod | (StartPeriod, EndPeriod))
776
777 Element Documentation:
778
779 |**Name**|**Type**|**Documentation**
780 |BeforePeriod|TimePeriodRangeType|BeforePeriod is the period before which the period is meant to cover. This date may be inclusive or exclusive in the range.
781 |AfterPeriod|TimePeriodRangeType|AfterPeriod is the period after which the period is meant to cover. This date may be inclusive or exclusive in the range.
782 |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.
783 |EndPeriod|TimePeriodRangeType|EndPeriod is the end period of the range. This date may be inclusive or exclusive in the range.
784
785 **TimePeriodRangeType: **TimePeriodRangeType defines a time period, and indicates whether it is inclusive in a range.
786
787 Derivation:
788
789 xs:anySimpleType (restriction)
790 [[image:inherit.gif||height="9" width="9"]] ObservationalTimePeriodType (extension)
791 [[image:inherit.gif||height="9" width="9"]] TimePeriodRangeType
792
793 Attributes:
794
795 isInclusive?
796
797 Content:
798
799 Attribute Documentation:
800
801 |**Name**|**Type**|**Documentation**
802 |isInclusive (default: true)|xs:boolean|The isInclusive attribute, when true, indicates that the time period specified is included in the range.
803
804 //**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).
805
806 Attributes:
807
808 structureID, schemaURL?, namespace?, dimensionAtObservation?, explicitMeasures?, serviceURL?, structureURL?
809
810 Content:
811
812 (ProvisionAgrement | StructureUsage | Structure)
813
814 Attribute Documentation:
815
816 |**Name**|**Type**|**Documentation**
817 |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.
818 |schemaURL|xs:anyURI|The schemaURL attribute provides a location from which the structure specific schema can be located.
819 |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.
820 |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.
821 |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.
822 |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.
823 |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.
824
825 Element Documentation:
826
827 |**Name**|**Type**|**Documentation**
828 |ProvisionAgrement|ProvisionAgreementRe ferenceType|ProvisionAgreement references a provision agreement which the data or metadata is reported against.
829 |StructureUsage|//StructureUsageRefere nceBaseType//|StructureUsage references a flow which the data or metadata is reported against.
830 |Structure|//StructureReferenceBa seType//|Structure references the structure which defines the structure of the data or metadata set.
831
832 //**DataStructureType**//**: **DataStructureType is an abstract base type the forms the basis for the structural information for a data set.
833
834 Derivation:
835
836 //PayloadStructureType// (restriction)
837 [[image:inherit.gif||height="9" width="9"]] //DataStructureType//
838
839 Attributes:
840
841 structureID, schemaURL?, namespace?, dimensionAtObservation?, explicitMeasures?, serviceURL?, structureURL?
842
843 Content:
844
845 (ProvisionAgrement | StructureUsage | Structure)
846
847 Attribute Documentation:
848
849 |**Name**|**Type**|**Documentation**
850 |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.
851 |schemaURL|xs:anyURI|The schemaURL attribute provides a location from which the structure specific schema can be located.
852 |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.
853 |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.
854 |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.
855 |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.
856 |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.
857
858 Element Documentation:
859
860 |**Name**|**Type**|**Documentation**
861 |ProvisionAgrement|ProvisionAgreementRe ferenceType|ProvisionAgreement references a provision agreement which the data is reported against.
862 |StructureUsage|DataflowReferenceTyp e|StructureUsage references a dataflow which the data is reported against.
863 |Structure|DataStructureReferen ceType|Structure references the data structure definition which defines the structure of the data.
864
865 **DataStructureRequestType: **DataStructureRequestType is a variation of a the DataStructureType for querying purposes. Only the observation dimension and the explicit measures flag are allowed.
866
867 Derivation:
868
869 //PayloadStructureType// (restriction)
870 [[image:inherit.gif||height="9" width="9"]] //DataStructureType// (restriction)
871 [[image:inherit.gif||height="9" width="9"]] DataStructureRequestType
872
873 Attributes:
874
875 structureID, dimensionAtObservation, explicitMeasures?, serviceURL?, structureURL?
876
877 Content:
878
879 (ProvisionAgrement | StructureUsage | Structure)
880
881 Attribute Documentation:
882
883 |**Name**|**Type**|**Documentation**
884 |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.
885 |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.
886 |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.
887 |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.
888 |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.
889
890 Element Documentation:
891
892 |**Name**|**Type**|**Documentation**
893 |ProvisionAgrement|ProvisionAgreementRe ferenceType|ProvisionAgreement references a provision agreement which the data is reported against.
894 |StructureUsage|DataflowReferenceTyp e|StructureUsage references a dataflow which the data is reported against.
895 |Structure|DataStructureReferen ceType|Structure references the data structure definition which defines the structure of the data.
896
897 **GenericDataStructureRequestType: **GenericDataStructureRequestType is a variation of a the DataStructureRequestType for querying purposes. The explicit measure flag in not allowed.
898
899 Derivation:
900
901 //PayloadStructureType// (restriction)
902 [[image:inherit.gif||height="9" width="9"]] //DataStructureType// (restriction)
903 [[image:inherit.gif||height="9" width="9"]] DataStructureRequestType (restriction)
904 [[image:inherit.gif||height="9" width="9"]] GenericDataStructureRequestType
905
906 Attributes:
907
908 structureID, dimensionAtObservation, serviceURL?, structureURL?
909
910 Content:
911
912 (ProvisionAgrement | StructureUsage | Structure)
913
914 Attribute Documentation:
915
916 |**Name**|**Type**|**Documentation**
917 |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.
918 |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.
919 |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.
920 |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.
921
922 Element Documentation:
923
924 |**Name**|**Type**|**Documentation**
925 |ProvisionAgrement|ProvisionAgreementRe ferenceType|ProvisionAgreement references a provision agreement which the data is reported against.
926 |StructureUsage|DataflowReferenceTyp e|StructureUsage references a dataflow which the data is reported against.
927 |Structure|DataStructureReferen ceType|Structure references the data structure definition which defines the structure of the data.
928
929 **TimeSeriesDataStructureRequestType: **TimeSeriesDataStructureRequestType is a variation of a the DataStructureRequestType for querying purposes. The observation dimension is fixed to TIME_PERIOD
930
931 Derivation:
932
933 //PayloadStructureType// (restriction)
934 [[image:inherit.gif||height="9" width="9"]] //DataStructureType// (restriction)
935 [[image:inherit.gif||height="9" width="9"]] DataStructureRequestType (restriction)
936 [[image:inherit.gif||height="9" width="9"]] TimeSeriesDataStructureRequestType
937
938 Attributes:
939
940 structureID, dimensionAtObservation, explicitMeasures?, serviceURL?, structureURL?
941
942 Content:
943
944 (ProvisionAgrement | StructureUsage | Structure)
945
946 Attribute Documentation:
947
948 |**Name**|**Type**|**Documentation**
949 |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.
950 |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.
951 |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.
952 |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.
953 |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.
954
955 Element Documentation:
956
957 |**Name**|**Type**|**Documentation**
958 |ProvisionAgrement|ProvisionAgreementRe ferenceType|ProvisionAgreement references a provision agreement which the data is reported against.
959 |StructureUsage|DataflowReferenceTyp e|StructureUsage references a dataflow which the data is reported against.
960 |Structure|DataStructureReferen ceType|Structure references the data structure definition which defines the structure of the data.
961
962 **TimeSeriesGenericDataStructureRequestType: **TimeSeriesGenericDataStructureRequestType is a variation of a the GenericDataStructureRequestType for querying purposes. The observation dimension is fixed to TIME_PERIOD.
963
964 Derivation:
965
966 //PayloadStructureType// (restriction)
967 [[image:inherit.gif||height="9" width="9"]] //DataStructureType// (restriction)
968 [[image:inherit.gif||height="9" width="9"]] DataStructureRequestType (restriction)
969 [[image:inherit.gif||height="9" width="9"]] GenericDataStructureRequestType (restriction)
970 [[image:inherit.gif||height="9" width="9"]] TimeSeriesGenericDataStructureRequestType
971
972 Attributes:
973
974 structureID, dimensionAtObservation, serviceURL?, structureURL?
975
976 Content:
977
978 (ProvisionAgrement | StructureUsage | Structure)
979
980 Attribute Documentation:
981
982 |**Name**|**Type**|**Documentation**
983 |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.
984 |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.
985 |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.
986 |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.
987
988 Element Documentation:
989
990 |**Name**|**Type**|**Documentation**
991 |ProvisionAgrement|ProvisionAgreementRe ferenceType|ProvisionAgreement references a provision agreement which the data is reported against.
992 |StructureUsage|DataflowReferenceTyp e|StructureUsage references a dataflow which the data is reported against.
993 |Structure|DataStructureReferen ceType|Structure references the data structure definition which defines the structure of the data.
994
995 **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.
996
997 Derivation:
998
999 //PayloadStructureType// (restriction)
1000 [[image:inherit.gif||height="9" width="9"]] //DataStructureType// (restriction)
1001 [[image:inherit.gif||height="9" width="9"]] GenericDataStructureType
1002
1003 Attributes:
1004
1005 structureID, dimensionAtObservation, serviceURL?, structureURL?
1006
1007 Content:
1008
1009 (ProvisionAgrement | StructureUsage | Structure)
1010
1011 Attribute Documentation:
1012
1013 |**Name**|**Type**|**Documentation**
1014 |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.
1015 |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.
1016 |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.
1017 |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.
1018
1019 Element Documentation:
1020
1021 |**Name**|**Type**|**Documentation**
1022 |ProvisionAgrement|ProvisionAgreementRe ferenceType|ProvisionAgreement references a provision agreement which the data is reported against.
1023 |StructureUsage|DataflowReferenceTyp e|StructureUsage references a dataflow which the data is reported against.
1024 |Structure|DataStructureReferen ceType|Structure references the data structure definition which defines the structure of the data.
1025
1026 **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.
1027
1028 Derivation:
1029
1030 //PayloadStructureType// (restriction)
1031 [[image:inherit.gif||height="9" width="9"]] //DataStructureType// (restriction)
1032 [[image:inherit.gif||height="9" width="9"]] GenericDataStructureType (restriction)
1033 [[image:inherit.gif||height="9" width="9"]] GenericTimeSeriesDataStructureType
1034
1035 Attributes:
1036
1037 structureID, dimensionAtObservation, serviceURL?, structureURL?
1038
1039 Content:
1040
1041 (ProvisionAgrement | StructureUsage | Structure)
1042
1043 Attribute Documentation:
1044
1045 |**Name**|**Type**|**Documentation**
1046 |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.
1047 |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.
1048 |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.
1049 |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.
1050
1051 Element Documentation:
1052
1053 |**Name**|**Type**|**Documentation**
1054 |ProvisionAgrement|ProvisionAgreementRe ferenceType|ProvisionAgreement references a provision agreement which the data is reported against.
1055 |StructureUsage|DataflowReferenceTyp e|StructureUsage references a dataflow which the data is reported against.
1056 |Structure|DataStructureReferen ceType|Structure references the data structure definition which defines the structure of the data.
1057
1058 **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.
1059
1060 Derivation:
1061
1062 //PayloadStructureType// (restriction)
1063 [[image:inherit.gif||height="9" width="9"]] //DataStructureType// (restriction)
1064 [[image:inherit.gif||height="9" width="9"]] StructureSpecificDataStructureType
1065
1066 Attributes:
1067
1068 structureID, schemaURL?, namespace, dimensionAtObservation, explicitMeasures?, serviceURL?, structureURL?
1069
1070 Content:
1071
1072 (ProvisionAgrement | StructureUsage | Structure)
1073
1074 Attribute Documentation:
1075
1076 |**Name**|**Type**|**Documentation**
1077 |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.
1078 |schemaURL|xs:anyURI|The schemaURL attribute provides a location from which the structure specific schema can be located.
1079 |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.
1080 |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.
1081 |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.
1082 |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.
1083 |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.
1084
1085 Element Documentation:
1086
1087 |**Name**|**Type**|**Documentation**
1088 |ProvisionAgrement|ProvisionAgreementRe ferenceType|ProvisionAgreement references a provision agreement which the data is reported against.
1089 |StructureUsage|DataflowReferenceTyp e|StructureUsage references a dataflow which the data is reported against.
1090 |Structure|DataStructureReferen ceType|Structure references the data structure definition which defines the structure of the data.
1091
1092 **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.
1093
1094 Derivation:
1095
1096 //PayloadStructureType// (restriction)
1097 [[image:inherit.gif||height="9" width="9"]] //DataStructureType// (restriction)
1098 [[image:inherit.gif||height="9" width="9"]] StructureSpecificDataStructureType (restriction)
1099 [[image:inherit.gif||height="9" width="9"]] StructureSpecificDataTimeSeriesStructureType
1100
1101 Attributes:
1102
1103 structureID, schemaURL?, namespace, dimensionAtObservation, serviceURL?, structureURL?
1104
1105 Content:
1106
1107 (ProvisionAgrement | StructureUsage | Structure)
1108
1109 Attribute Documentation:
1110
1111 |**Name**|**Type**|**Documentation**
1112 |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.
1113 |schemaURL|xs:anyURI|The schemaURL attribute provides a location from which the structure specific schema can be located.
1114 |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.
1115 |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.
1116 |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.
1117 |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.
1118
1119 Element Documentation:
1120
1121 |**Name**|**Type**|**Documentation**
1122 |ProvisionAgrement|ProvisionAgreementRe ferenceType|ProvisionAgreement references a provision agreement which the data is reported against.
1123 |StructureUsage|DataflowReferenceTyp e|StructureUsage references a dataflow which the data is reported against.
1124 |Structure|DataStructureReferen ceType|Structure references the data structure definition which defines the structure of the data.
1125
1126 //**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.
1127
1128 Derivation:
1129
1130 //PayloadStructureType// (restriction)
1131 [[image:inherit.gif||height="9" width="9"]] //MetadataStructureType//
1132
1133 Attributes:
1134
1135 structureID, schemaURL?, namespace?, serviceURL?, structureURL?
1136
1137 Content:
1138
1139 (ProvisionAgrement | StructureUsage | Structure)
1140
1141 Attribute Documentation:
1142
1143 |**Name**|**Type**|**Documentation**
1144 |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.
1145 |schemaURL|xs:anyURI|The schemaURL attribute provides a location from which the structure specific schema can be located.
1146 |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.
1147 |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.
1148 |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.
1149
1150 Element Documentation:
1151
1152 |**Name**|**Type**|**Documentation**
1153 |ProvisionAgrement|ProvisionAgreementRe ferenceType|ProvisionAgreement references a provision agreement which the metadata is reported against.
1154 |StructureUsage|MetadataflowReferenc eType|StructureUsage references a metadataflow which the metadata is reported against.
1155 |Structure|MetadataStructureRef erenceType|Structure references the metadata structure definition which defines the structure of the metadata.
1156
1157 **StructureSpecificMetadataStructureType: **StructureSpecificMetadataStructureType defines the structural information for a structured metadata message.
1158
1159 Derivation:
1160
1161 //PayloadStructureType// (restriction)
1162 [[image:inherit.gif||height="9" width="9"]] //MetadataStructureType// (restriction)
1163 [[image:inherit.gif||height="9" width="9"]] StructureSpecificMetadataStructureType
1164
1165 Attributes:
1166
1167 structureID, schemaURL?, namespace, serviceURL?, structureURL?
1168
1169 Content:
1170
1171 (ProvisionAgrement | StructureUsage | Structure)
1172
1173 Attribute Documentation:
1174
1175 |**Name**|**Type**|**Documentation**
1176 |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.
1177 |schemaURL|xs:anyURI|The schemaURL attribute provides a location from which the structure specific schema can be located.
1178 |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.
1179 |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.
1180 |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.
1181
1182 Element Documentation:
1183
1184 |**Name**|**Type**|**Documentation**
1185 |ProvisionAgrement|ProvisionAgreementRe ferenceType|ProvisionAgreement references a provision agreement which the metadata is reported against.
1186 |StructureUsage|MetadataflowReferenc eType|StructureUsage references a metadataflow which the metadata is reported against.
1187 |Structure|MetadataStructureRef erenceType|Structure references the metadata structure definition which defines the structure of the metadata.
1188
1189 **GenericMetadataStructureType: **GenericMetadataStructureType defines the structural information for a generic metadata message.
1190
1191 Derivation:
1192
1193 //PayloadStructureType// (restriction)
1194 [[image:inherit.gif||height="9" width="9"]] //MetadataStructureType// (restriction)
1195 [[image:inherit.gif||height="9" width="9"]] GenericMetadataStructureType
1196
1197 Attributes:
1198
1199 structureID, schemaURL?, serviceURL?, structureURL?
1200
1201 Content:
1202
1203 (ProvisionAgrement | StructureUsage | Structure)
1204
1205 Attribute Documentation:
1206
1207 |**Name**|**Type**|**Documentation**
1208 |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.
1209 |schemaURL|xs:anyURI|The schemaURL attribute provides a location from which the structure specific schema can be located.
1210 |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.
1211 |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.
1212
1213 Element Documentation:
1214
1215 |**Name**|**Type**|**Documentation**
1216 |ProvisionAgrement|ProvisionAgreementRe ferenceType|ProvisionAgreement references a provision agreement which the metadata is reported against.
1217 |StructureUsage|MetadataflowReferenc eType|StructureUsage references a metadataflow which the metadata is reported against.
1218 |Structure|MetadataStructureRef erenceType|Structure references the metadata structure definition which defines the structure of the metadata.
1219
1220 **EmptyType: **EmptyType is an empty complex type for elements where the presence of the tag indicates all that is necessary.
1221
1222 Content:
1223
1224 {Empty}
1225
1226 //**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])?.
1227
1228 Content:
1229
1230 ( (Ref, URN?) | URN)
1231
1232 Element Documentation:
1233
1234 |**Name**|**Type**|**Documentation**
1235 |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.
1236 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
1237 |URN|xs:anyURI|URN is used to hold the URN of the referenced object.
1238
1239 //**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.
1240
1241 Attributes:
1242
1243 agencyID?, maintainableParentID?, maintainableParentVersion?, containerID?, id, version?, local?, class?, package?
1244
1245 Content:
1246
1247 {Empty}
1248
1249 Attribute Documentation:
1250
1251 |**Name**|**Type**|**Documentation**
1252 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
1253 |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.
1254 |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.
1255 |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.
1256 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
1257 |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.
1258 |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.
1259 |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.
1260 |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.
1261
1262 **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.
1263
1264 Derivation:
1265
1266 //ReferenceType// (restriction)
1267 [[image:inherit.gif||height="9" width="9"]] ObjectReferenceType
1268
1269 Content:
1270
1271 ( (Ref, URN?) | URN)
1272
1273 Element Documentation:
1274
1275 |**Name**|**Type**|**Documentation**
1276 |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.
1277 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
1278 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
1279
1280 **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.
1281
1282 Derivation:
1283
1284 //RefBaseType// (restriction)
1285 [[image:inherit.gif||height="9" width="9"]] ObjectRefType
1286
1287 Attributes:
1288
1289 agencyID, maintainableParentID?, maintainableParentVersion?, containerID?, id, version?, local?, class, package
1290
1291 Content:
1292
1293 {Empty}
1294
1295 Attribute Documentation:
1296
1297 |**Name**|**Type**|**Documentation**
1298 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
1299 |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.
1300 |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.
1301 |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.
1302 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
1303 |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.
1304 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
1305 |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.
1306 |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.
1307
1308 //**MaintainableRefBaseType**//**: **MaintainableRefBaseType is an abstract base type for referencing a maintainable object.
1309
1310 Derivation:
1311
1312 //RefBaseType// (restriction)
1313 [[image:inherit.gif||height="9" width="9"]] //MaintainableRefBaseType//
1314
1315 Attributes:
1316
1317 agencyID, id, version?, local?, class?, package?
1318
1319 Content:
1320
1321 {Empty}
1322
1323 Attribute Documentation:
1324
1325 |**Name**|**Type**|**Documentation**
1326 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
1327 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
1328 |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.
1329 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
1330 |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.
1331 |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.
1332
1333 **MaintainableRefType: **MaintainableRefType contains a complete set of reference fields for referencing any maintainable object.
1334
1335 Derivation:
1336
1337 //RefBaseType// (restriction)
1338 [[image:inherit.gif||height="9" width="9"]] //MaintainableRefBaseType// (restriction)
1339 [[image:inherit.gif||height="9" width="9"]] MaintainableRefType
1340
1341 Attributes:
1342
1343 agencyID, id, version?, local?, class, package
1344
1345 Content:
1346
1347 {Empty}
1348
1349 Attribute Documentation:
1350
1351 |**Name**|**Type**|**Documentation**
1352 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
1353 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
1354 |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.
1355 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
1356 |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.
1357 |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.
1358
1359 //**ItemSchemeRefBaseType**//**: **ItemSchemeRefBaseType is an abstract base type for referencing an item scheme.
1360
1361 Derivation:
1362
1363 //RefBaseType// (restriction)
1364 [[image:inherit.gif||height="9" width="9"]] //MaintainableRefBaseType// (restriction)
1365 [[image:inherit.gif||height="9" width="9"]] //ItemSchemeRefBaseType//
1366
1367 Attributes:
1368
1369 agencyID, id, version?, local?, class?, package?
1370
1371 Content:
1372
1373 {Empty}
1374
1375 Attribute Documentation:
1376
1377 |**Name**|**Type**|**Documentation**
1378 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
1379 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
1380 |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.
1381 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
1382 |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.
1383 |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.
1384
1385 **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.
1386
1387 Derivation:
1388
1389 //RefBaseType// (restriction)
1390 [[image:inherit.gif||height="9" width="9"]] //MaintainableRefBaseType// (restriction)
1391 [[image:inherit.gif||height="9" width="9"]] //ItemSchemeRefBaseType// (restriction)
1392 [[image:inherit.gif||height="9" width="9"]] ItemSchemeRefType
1393
1394 Attributes:
1395
1396 agencyID, id, version?, local?, class, package
1397
1398 Content:
1399
1400 {Empty}
1401
1402 Attribute Documentation:
1403
1404 |**Name**|**Type**|**Documentation**
1405 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
1406 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
1407 |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.
1408 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
1409 |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.
1410 |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.
1411
1412 //**StructureOrUsageRefBaseType**//**: **StructureOrUsageRefBaseType is an abstract base type for referencing a structure or structure usage.
1413
1414 Derivation:
1415
1416 //RefBaseType// (restriction)
1417 [[image:inherit.gif||height="9" width="9"]] //MaintainableRefBaseType// (restriction)
1418 [[image:inherit.gif||height="9" width="9"]] //StructureOrUsageRefBaseType//
1419
1420 Attributes:
1421
1422 agencyID, id, version?, local?, class?, package?
1423
1424 Content:
1425
1426 {Empty}
1427
1428 Attribute Documentation:
1429
1430 |**Name**|**Type**|**Documentation**
1431 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
1432 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
1433 |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.
1434 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
1435 |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.
1436 |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.
1437
1438 //**StructureRefBaseType**//**: **StructureRefBaseType is an abstract base type for referencing a structure.
1439
1440 Derivation:
1441
1442 //RefBaseType// (restriction)
1443 [[image:inherit.gif||height="9" width="9"]] //MaintainableRefBaseType// (restriction)
1444 [[image:inherit.gif||height="9" width="9"]] //StructureOrUsageRefBaseType// (restriction)
1445 [[image:inherit.gif||height="9" width="9"]] //StructureRefBaseType//
1446
1447 Attributes:
1448
1449 agencyID, id, version?, local?, class?, package?
1450
1451 Content:
1452
1453 {Empty}
1454
1455 Attribute Documentation:
1456
1457 |**Name**|**Type**|**Documentation**
1458 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
1459 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
1460 |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.
1461 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
1462 |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.
1463 |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.
1464
1465 **StructureRefType: **StructureRefType contains a set of reference fields for referencing any structure.
1466
1467 Derivation:
1468
1469 //RefBaseType// (restriction)
1470 [[image:inherit.gif||height="9" width="9"]] //MaintainableRefBaseType// (restriction)
1471 [[image:inherit.gif||height="9" width="9"]] //StructureOrUsageRefBaseType// (restriction)
1472 [[image:inherit.gif||height="9" width="9"]] //StructureRefBaseType// (restriction)
1473 [[image:inherit.gif||height="9" width="9"]] StructureRefType
1474
1475 Attributes:
1476
1477 agencyID, id, version?, local?, class, package
1478
1479 Content:
1480
1481 {Empty}
1482
1483 Attribute Documentation:
1484
1485 |**Name**|**Type**|**Documentation**
1486 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
1487 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
1488 |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.
1489 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
1490 |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.
1491 |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.
1492
1493 //**StructureUsageRefBaseType**//**: **StructureUsageRefBaseType is an abstract base type for referencing a structure usage.
1494
1495 Derivation:
1496
1497 //RefBaseType// (restriction)
1498 [[image:inherit.gif||height="9" width="9"]] //MaintainableRefBaseType// (restriction)
1499 [[image:inherit.gif||height="9" width="9"]] //StructureOrUsageRefBaseType// (restriction)
1500 [[image:inherit.gif||height="9" width="9"]] //StructureUsageRefBaseType//
1501
1502 Attributes:
1503
1504 agencyID, id, version?, local?, class?, package?
1505
1506 Content:
1507
1508 {Empty}
1509
1510 Attribute Documentation:
1511
1512 |**Name**|**Type**|**Documentation**
1513 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
1514 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
1515 |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.
1516 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
1517 |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.
1518 |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.
1519
1520 **StructureUsageRefType: **StructureUsageRefType contains a set of reference fields for referencing any structure usage.
1521
1522 Derivation:
1523
1524 //RefBaseType// (restriction)
1525 [[image:inherit.gif||height="9" width="9"]] //MaintainableRefBaseType// (restriction)
1526 [[image:inherit.gif||height="9" width="9"]] //StructureOrUsageRefBaseType// (restriction)
1527 [[image:inherit.gif||height="9" width="9"]] //StructureUsageRefBaseType// (restriction)
1528 [[image:inherit.gif||height="9" width="9"]] StructureUsageRefType
1529
1530 Attributes:
1531
1532 agencyID, id, version?, local?, class, package
1533
1534 Content:
1535
1536 {Empty}
1537
1538 Attribute Documentation:
1539
1540 |**Name**|**Type**|**Documentation**
1541 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
1542 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
1543 |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.
1544 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
1545 |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.
1546 |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.
1547
1548 //**ChildObjectRefBaseType**//**: **ChildObjectRefBaseType is an abstract base type for referencing any child object defined directly within a maintainable object.
1549
1550 Derivation:
1551
1552 //RefBaseType// (restriction)
1553 [[image:inherit.gif||height="9" width="9"]] //ChildObjectRefBaseType//
1554
1555 Attributes:
1556
1557 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
1558
1559 Content:
1560
1561 {Empty}
1562
1563 Attribute Documentation:
1564
1565 |**Name**|**Type**|**Documentation**
1566 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
1567 |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.
1568 |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.
1569 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
1570 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
1571 |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.
1572 |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.
1573
1574 //**ContainerChildObjectRefBaseType**//**: **ContainerChildObjectRefBaseType is an abstract base type for referencing any child object within container defined in a maintainable object.
1575
1576 Derivation:
1577
1578 //RefBaseType// (restriction)
1579 [[image:inherit.gif||height="9" width="9"]] //ContainerChildObjectRefBaseType//
1580
1581 Attributes:
1582
1583 agencyID, maintainableParentID, maintainableParentVersion?, containerID?, id, version?, local?, class?, package?
1584
1585 Content:
1586
1587 {Empty}
1588
1589 Attribute Documentation:
1590
1591 |**Name**|**Type**|**Documentation**
1592 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
1593 |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.
1594 |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.
1595 |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.
1596 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
1597 |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.
1598 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
1599 |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.
1600 |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.
1601
1602 //**ItemRefBaseType**//**: **ItemRefBaseType is an abstract base type for referencing an item within an item scheme.
1603
1604 Derivation:
1605
1606 //RefBaseType// (restriction)
1607 [[image:inherit.gif||height="9" width="9"]] //ChildObjectRefBaseType// (restriction)
1608 [[image:inherit.gif||height="9" width="9"]] //ItemRefBaseType//
1609
1610 Attributes:
1611
1612 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
1613
1614 Content:
1615
1616 {Empty}
1617
1618 Attribute Documentation:
1619
1620 |**Name**|**Type**|**Documentation**
1621 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
1622 |maintainableParentID|IDType|The maintainableParentID references the item scheme in which the item being referenced is defined.
1623 |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.
1624 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
1625 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
1626 |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.
1627 |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.
1628
1629 //**ComponentListRefBaseType**//**: **ComponentListRefBaseType is an abstract base type for referencing a component list within a structure.
1630
1631 Derivation:
1632
1633 //RefBaseType// (restriction)
1634 [[image:inherit.gif||height="9" width="9"]] //ChildObjectRefBaseType// (restriction)
1635 [[image:inherit.gif||height="9" width="9"]] //ComponentListRefBaseType//
1636
1637 Attributes:
1638
1639 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
1640
1641 Content:
1642
1643 {Empty}
1644
1645 Attribute Documentation:
1646
1647 |**Name**|**Type**|**Documentation**
1648 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
1649 |maintainableParentID|IDType|The maintainableParentID references the structure in which the component list being referenced is defined.
1650 |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.
1651 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
1652 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
1653 |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.
1654 |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.
1655
1656 //**ComponentRefBaseType**//**: **ComponentRefBaseType is an abstract base type for referencing a component contained in a component list within a structure.
1657
1658 Derivation:
1659
1660 //RefBaseType// (restriction)
1661 [[image:inherit.gif||height="9" width="9"]] //ContainerChildObjectRefBaseType// (restriction)
1662 [[image:inherit.gif||height="9" width="9"]] //ComponentRefBaseType//
1663
1664 Attributes:
1665
1666 agencyID, maintainableParentID, maintainableParentVersion?, containerID?, id, version?, local?, class?, package?
1667
1668 Content:
1669
1670 {Empty}
1671
1672 Attribute Documentation:
1673
1674 |**Name**|**Type**|**Documentation**
1675 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
1676 |maintainableParentID|IDType|The maintainableParentID references the structure in which the component being referenced is defined.
1677 |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.
1678 |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.
1679 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
1680 |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.
1681 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
1682 |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.
1683 |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.
1684
1685 **AnyCodelistRefType: **AnyCodelistRefType is a type for referencing any codelist object (either a codelist or a hierarchical codelist).
1686
1687 Derivation:
1688
1689 //RefBaseType// (restriction)
1690 [[image:inherit.gif||height="9" width="9"]] //MaintainableRefBaseType// (restriction)
1691 [[image:inherit.gif||height="9" width="9"]] AnyCodelistRefType
1692
1693 Attributes:
1694
1695 agencyID, id, version?, local?, class, package?
1696
1697 Content:
1698
1699 {Empty}
1700
1701 Attribute Documentation:
1702
1703 |**Name**|**Type**|**Documentation**
1704 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
1705 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
1706 |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.
1707 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
1708 |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.
1709 |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.
1710
1711 **StructureOrUsageRefType: **StructureOrUsageRefType is a type for referencing a structure or structure usage.
1712
1713 Derivation:
1714
1715 //RefBaseType// (restriction)
1716 [[image:inherit.gif||height="9" width="9"]] //MaintainableRefBaseType// (restriction)
1717 [[image:inherit.gif||height="9" width="9"]] //StructureOrUsageRefBaseType// (restriction)
1718 [[image:inherit.gif||height="9" width="9"]] StructureOrUsageRefType
1719
1720 Attributes:
1721
1722 agencyID, id, version?, local?, class, package
1723
1724 Content:
1725
1726 {Empty}
1727
1728 Attribute Documentation:
1729
1730 |**Name**|**Type**|**Documentation**
1731 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
1732 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
1733 |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.
1734 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
1735 |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.
1736 |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.
1737
1738 //**LocalIdentifiableRefBaseType**//**: **LocalIdentifiableRefBaseType is an abstract base type which provides a local reference to any identifiable object.
1739
1740 Derivation:
1741
1742 //RefBaseType// (restriction)
1743 [[image:inherit.gif||height="9" width="9"]] //LocalIdentifiableRefBaseType//
1744
1745 Attributes:
1746
1747 containerID?, id, local?, class?, package?
1748
1749 Content:
1750
1751 {Empty}
1752
1753 Attribute Documentation:
1754
1755 |**Name**|**Type**|**Documentation**
1756 |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.
1757 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
1758 |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.
1759 |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.
1760 |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.
1761
1762 //**LocalItemRefBaseType**//**: **LocalItemRefBaseType is an abstract base type which provides a local reference to a item object.
1763
1764 Derivation:
1765
1766 //RefBaseType// (restriction)
1767 [[image:inherit.gif||height="9" width="9"]] //LocalIdentifiableRefBaseType// (restriction)
1768 [[image:inherit.gif||height="9" width="9"]] //LocalItemRefBaseType//
1769
1770 Attributes:
1771
1772 id, local?, class?, package?
1773
1774 Content:
1775
1776 {Empty}
1777
1778 Attribute Documentation:
1779
1780 |**Name**|**Type**|**Documentation**
1781 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
1782 |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.
1783 |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.
1784 |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.
1785
1786 //**LocalComponentListRefBaseType**//**: **LocalComponentListRefBaseType is an abstract base type which provides a local reference to a component list object.
1787
1788 Derivation:
1789
1790 //RefBaseType// (restriction)
1791 [[image:inherit.gif||height="9" width="9"]] //LocalIdentifiableRefBaseType// (restriction)
1792 [[image:inherit.gif||height="9" width="9"]] //LocalComponentListRefBaseType//
1793
1794 Attributes:
1795
1796 id, local?, class?, package?
1797
1798 Content:
1799
1800 {Empty}
1801
1802 Attribute Documentation:
1803
1804 |**Name**|**Type**|**Documentation**
1805 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
1806 |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.
1807 |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.
1808 |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.
1809
1810 //**LocalComponentListComponentRefBaseType**//**: **LocalComponentRefBaseType is an abstract base type which provides a local reference to a component object.
1811
1812 Derivation:
1813
1814 //RefBaseType// (restriction)
1815 [[image:inherit.gif||height="9" width="9"]] //LocalIdentifiableRefBaseType// (restriction)
1816 [[image:inherit.gif||height="9" width="9"]] //LocalComponentListComponentRefBaseType//
1817
1818 Attributes:
1819
1820 containerID?, id, local?, class?, package?
1821
1822 Content:
1823
1824 {Empty}
1825
1826 Attribute Documentation:
1827
1828 |**Name**|**Type**|**Documentation**
1829 |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.
1830 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
1831 |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.
1832 |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.
1833 |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.
1834
1835 **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.
1836
1837 Derivation:
1838
1839 //RefBaseType// (restriction)
1840 [[image:inherit.gif||height="9" width="9"]] //LocalIdentifiableRefBaseType// (restriction)
1841 [[image:inherit.gif||height="9" width="9"]] //LocalComponentListComponentRefBaseType// (restriction)
1842 [[image:inherit.gif||height="9" width="9"]] LocalComponentListComponentRefType
1843
1844 Attributes:
1845
1846 containerID, id, local?, class, package
1847
1848 Content:
1849
1850 {Empty}
1851
1852 Attribute Documentation:
1853
1854 |**Name**|**Type**|**Documentation**
1855 |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.
1856 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
1857 |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.
1858 |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.
1859 |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.
1860
1861 //**LocalComponentRefBaseType**//**: **LocalComponentRefBaseType is an abstract base type which provides a local reference to a component object.
1862
1863 Derivation:
1864
1865 //RefBaseType// (restriction)
1866 [[image:inherit.gif||height="9" width="9"]] //LocalIdentifiableRefBaseType// (restriction)
1867 [[image:inherit.gif||height="9" width="9"]] //LocalComponentListComponentRefBaseType// (restriction)
1868 [[image:inherit.gif||height="9" width="9"]] //LocalComponentRefBaseType//
1869
1870 Attributes:
1871
1872 id, local?, class?, package?
1873
1874 Content:
1875
1876 {Empty}
1877
1878 Attribute Documentation:
1879
1880 |**Name**|**Type**|**Documentation**
1881 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
1882 |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.
1883 |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.
1884 |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.
1885
1886 **LocalComponentRefType: **LocalComponentRefType provides a local reference to any type component object.
1887
1888 Derivation:
1889
1890 //RefBaseType// (restriction)
1891 [[image:inherit.gif||height="9" width="9"]] //LocalIdentifiableRefBaseType// (restriction)
1892 [[image:inherit.gif||height="9" width="9"]] //LocalComponentListComponentRefBaseType// (restriction)
1893 [[image:inherit.gif||height="9" width="9"]] //LocalComponentRefBaseType// (restriction)
1894 [[image:inherit.gif||height="9" width="9"]] LocalComponentRefType
1895
1896 Attributes:
1897
1898 id, local?, class, package
1899
1900 Content:
1901
1902 {Empty}
1903
1904 Attribute Documentation:
1905
1906 |**Name**|**Type**|**Documentation**
1907 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
1908 |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.
1909 |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.
1910 |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.
1911
1912 **AnyLocalCodeRefType: **AnyLocalCodeRefType provides a local reference to any code object.
1913
1914 Derivation:
1915
1916 //RefBaseType// (restriction)
1917 [[image:inherit.gif||height="9" width="9"]] AnyLocalCodeRefType
1918
1919 Attributes:
1920
1921 containerID?, id, version?, local?, class?, package?
1922
1923 Content:
1924
1925 {Empty}
1926
1927 Attribute Documentation:
1928
1929 |**Name**|**Type**|**Documentation**
1930 |containerID|IDType|The containerID attribute references the hierarchy which defines the hierarchical code in the case that this reference is for a hierarchical code.
1931 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
1932 |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.
1933 |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.
1934 |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.
1935 |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.
1936
1937 **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.
1938
1939 Derivation:
1940
1941 //ReferenceType// (restriction)
1942 [[image:inherit.gif||height="9" width="9"]] URNReferenceType
1943
1944 Content:
1945
1946 URN
1947
1948 Element Documentation:
1949
1950 |**Name**|**Type**|**Documentation**
1951 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
1952
1953 //**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.
1954
1955 Derivation:
1956
1957 //ReferenceType// (restriction)
1958 [[image:inherit.gif||height="9" width="9"]] //MaintainableReferenceBaseType//
1959
1960 Content:
1961
1962 ( (Ref, URN?) | URN)
1963
1964 Element Documentation:
1965
1966 |**Name**|**Type**|**Documentation**
1967 |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.
1968 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
1969 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
1970
1971 **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.
1972
1973 Derivation:
1974
1975 //ReferenceType// (restriction)
1976 [[image:inherit.gif||height="9" width="9"]] //MaintainableReferenceBaseType// (restriction)
1977 [[image:inherit.gif||height="9" width="9"]] MaintainableReferenceType
1978
1979 Content:
1980
1981 ( (Ref, URN?) | URN)
1982
1983 Element Documentation:
1984
1985 |**Name**|**Type**|**Documentation**
1986 |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.
1987 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
1988 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
1989
1990 //**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..
1991
1992 Derivation:
1993
1994 //ReferenceType// (restriction)
1995 [[image:inherit.gif||height="9" width="9"]] //LocalIdentifiableReferenceType//
1996
1997 Content:
1998
1999 Ref
2000
2001 Element Documentation:
2002
2003 |**Name**|**Type**|**Documentation**
2004 |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.
2005
2006 //**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.
2007
2008 Derivation:
2009
2010 //ReferenceType// (restriction)
2011 [[image:inherit.gif||height="9" width="9"]] //MaintainableReferenceBaseType// (restriction)
2012 [[image:inherit.gif||height="9" width="9"]] //StructureReferenceBaseType//
2013
2014 Content:
2015
2016 ( (Ref, URN?) | URN)
2017
2018 Element Documentation:
2019
2020 |**Name**|**Type**|**Documentation**
2021 |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.
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 **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.
2026
2027 Derivation:
2028
2029 //ReferenceType// (restriction)
2030 [[image:inherit.gif||height="9" width="9"]] //MaintainableReferenceBaseType// (restriction)
2031 [[image:inherit.gif||height="9" width="9"]] //StructureReferenceBaseType// (restriction)
2032 [[image:inherit.gif||height="9" width="9"]] StructureReferenceType
2033
2034 Content:
2035
2036 ( (Ref, URN?) | URN)
2037
2038 Element Documentation:
2039
2040 |**Name**|**Type**|**Documentation**
2041 |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.
2042 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2043 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2044
2045 //**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.
2046
2047 Derivation:
2048
2049 //ReferenceType// (restriction)
2050 [[image:inherit.gif||height="9" width="9"]] //MaintainableReferenceBaseType// (restriction)
2051 [[image:inherit.gif||height="9" width="9"]] //StructureUsageReferenceBaseType//
2052
2053 Content:
2054
2055 ( (Ref, URN?) | URN)
2056
2057 Element Documentation:
2058
2059 |**Name**|**Type**|**Documentation**
2060 |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.
2061 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2062 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2063
2064 **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.
2065
2066 Derivation:
2067
2068 //ReferenceType// (restriction)
2069 [[image:inherit.gif||height="9" width="9"]] //MaintainableReferenceBaseType// (restriction)
2070 [[image:inherit.gif||height="9" width="9"]] //StructureUsageReferenceBaseType// (restriction)
2071 [[image:inherit.gif||height="9" width="9"]] StructureUsageReferenceType
2072
2073 Content:
2074
2075 ( (Ref, URN?) | URN)
2076
2077 Element Documentation:
2078
2079 |**Name**|**Type**|**Documentation**
2080 |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.
2081 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2082 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2083
2084 //**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.
2085
2086 Derivation:
2087
2088 //ReferenceType// (restriction)
2089 [[image:inherit.gif||height="9" width="9"]] //MaintainableReferenceBaseType// (restriction)
2090 [[image:inherit.gif||height="9" width="9"]] //ItemSchemeReferenceBaseType//
2091
2092 Content:
2093
2094 ( (Ref, URN?) | URN)
2095
2096 Element Documentation:
2097
2098 |**Name**|**Type**|**Documentation**
2099 |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.
2100 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2101 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2102
2103 **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.
2104
2105 Derivation:
2106
2107 //ReferenceType// (restriction)
2108 [[image:inherit.gif||height="9" width="9"]] //MaintainableReferenceBaseType// (restriction)
2109 [[image:inherit.gif||height="9" width="9"]] //ItemSchemeReferenceBaseType// (restriction)
2110 [[image:inherit.gif||height="9" width="9"]] ItemSchemeReferenceType
2111
2112 Content:
2113
2114 ( (Ref, URN?) | URN)
2115
2116 Element Documentation:
2117
2118 |**Name**|**Type**|**Documentation**
2119 |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.
2120 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2121 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2122
2123 //**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).
2124
2125 Derivation:
2126
2127 //ReferenceType// (restriction)
2128 [[image:inherit.gif||height="9" width="9"]] //ChildObjectReferenceType//
2129
2130 Content:
2131
2132 ( (Ref, URN?) | URN)
2133
2134 Element Documentation:
2135
2136 |**Name**|**Type**|**Documentation**
2137 |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.
2138 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2139 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2140
2141 //**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).
2142
2143 Derivation:
2144
2145 //ReferenceType// (restriction)
2146 [[image:inherit.gif||height="9" width="9"]] //ContainerChildObjectReferenceType//
2147
2148 Content:
2149
2150 ( (Ref, URN?) | URN)
2151
2152 Element Documentation:
2153
2154 |**Name**|**Type**|**Documentation**
2155 |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.
2156 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2157 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2158
2159 //**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).
2160
2161 Derivation:
2162
2163 //ReferenceType// (restriction)
2164 [[image:inherit.gif||height="9" width="9"]] //ChildObjectReferenceType// (restriction)
2165 [[image:inherit.gif||height="9" width="9"]] //ItemReferenceType//
2166
2167 Content:
2168
2169 ( (Ref, URN?) | URN)
2170
2171 Element Documentation:
2172
2173 |**Name**|**Type**|**Documentation**
2174 |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.
2175 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2176 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2177
2178 //**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).
2179
2180 Derivation:
2181
2182 //ReferenceType// (restriction)
2183 [[image:inherit.gif||height="9" width="9"]] //ChildObjectReferenceType// (restriction)
2184 [[image:inherit.gif||height="9" width="9"]] //ComponentListReferenceType//
2185
2186 Content:
2187
2188 ( (Ref, URN?) | URN)
2189
2190 Element Documentation:
2191
2192 |**Name**|**Type**|**Documentation**
2193 |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.
2194 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2195 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2196
2197 //**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).
2198
2199 Derivation:
2200
2201 //ReferenceType// (restriction)
2202 [[image:inherit.gif||height="9" width="9"]] //ContainerChildObjectReferenceType// (restriction)
2203 [[image:inherit.gif||height="9" width="9"]] //ComponentReferenceType//
2204
2205 Content:
2206
2207 ( (Ref, URN?) | URN)
2208
2209 Element Documentation:
2210
2211 |**Name**|**Type**|**Documentation**
2212 |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.
2213 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2214 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2215
2216 //**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.
2217
2218 Derivation:
2219
2220 //ReferenceType// (restriction)
2221 [[image:inherit.gif||height="9" width="9"]] //LocalItemReferenceType//
2222
2223 Content:
2224
2225 Ref
2226
2227 Element Documentation:
2228
2229 |**Name**|**Type**|**Documentation**
2230 |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.
2231
2232 //**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.
2233
2234 Derivation:
2235
2236 //ReferenceType// (restriction)
2237 [[image:inherit.gif||height="9" width="9"]] //LocalComponentListReferenceType//
2238
2239 Content:
2240
2241 Ref
2242
2243 Element Documentation:
2244
2245 |**Name**|**Type**|**Documentation**
2246 |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.
2247
2248 //**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.
2249
2250 Derivation:
2251
2252 //ReferenceType// (restriction)
2253 [[image:inherit.gif||height="9" width="9"]] //LocalComponentListComponentReferenceBaseType//
2254
2255 Content:
2256
2257 Ref
2258
2259 Element Documentation:
2260
2261 |**Name**|**Type**|**Documentation**
2262 |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.
2263
2264 **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.
2265
2266 Derivation:
2267
2268 //ReferenceType// (restriction)
2269 [[image:inherit.gif||height="9" width="9"]] //LocalComponentListComponentReferenceBaseType// (restriction)
2270 [[image:inherit.gif||height="9" width="9"]] LocalComponentListComponentReferenceType
2271
2272 Content:
2273
2274 Ref
2275
2276 Element Documentation:
2277
2278 |**Name**|**Type**|**Documentation**
2279 |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.
2280
2281 //**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.
2282
2283 Derivation:
2284
2285 //ReferenceType// (restriction)
2286 [[image:inherit.gif||height="9" width="9"]] //LocalComponentListComponentReferenceBaseType// (restriction)
2287 [[image:inherit.gif||height="9" width="9"]] //LocalComponentReferenceBaseType//
2288
2289 Content:
2290
2291 Ref
2292
2293 Element Documentation:
2294
2295 |**Name**|**Type**|**Documentation**
2296 |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.
2297
2298 **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.
2299
2300 Derivation:
2301
2302 //ReferenceType// (restriction)
2303 [[image:inherit.gif||height="9" width="9"]] //LocalComponentListComponentReferenceBaseType// (restriction)
2304 [[image:inherit.gif||height="9" width="9"]] LocalComponentReferenceType
2305
2306 Content:
2307
2308 Ref
2309
2310 Element Documentation:
2311
2312 |**Name**|**Type**|**Documentation**
2313 |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.
2314
2315 **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.
2316
2317 Derivation:
2318
2319 //ReferenceType// (restriction)
2320 [[image:inherit.gif||height="9" width="9"]] //MaintainableReferenceBaseType// (restriction)
2321 [[image:inherit.gif||height="9" width="9"]] StructureOrUsageReferenceType
2322
2323 Content:
2324
2325 ( (Ref, URN?) | URN)
2326
2327 Element Documentation:
2328
2329 |**Name**|**Type**|**Documentation**
2330 |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.
2331 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2332 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2333
2334 **CategorisationReferenceType: **CategorisationReferenceType is a type for referencing a categorisation object. It consists of a URN and/or a complete set of reference fields.
2335
2336 Derivation:
2337
2338 //ReferenceType// (restriction)
2339 [[image:inherit.gif||height="9" width="9"]] //MaintainableReferenceBaseType// (restriction)
2340 [[image:inherit.gif||height="9" width="9"]] CategorisationReferenceType
2341
2342 Content:
2343
2344 ( (Ref, URN?) | URN)
2345
2346 Element Documentation:
2347
2348 |**Name**|**Type**|**Documentation**
2349 |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.
2350 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2351 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2352
2353 **CategorisationRefType: **CategorisationRefType provides a reference to a categorisation via a complete set of reference fields.
2354
2355 Derivation:
2356
2357 //RefBaseType// (restriction)
2358 [[image:inherit.gif||height="9" width="9"]] //MaintainableRefBaseType// (restriction)
2359 [[image:inherit.gif||height="9" width="9"]] CategorisationRefType
2360
2361 Attributes:
2362
2363 agencyID, id, version?, local?, class?, package?
2364
2365 Content:
2366
2367 {Empty}
2368
2369 Attribute Documentation:
2370
2371 |**Name**|**Type**|**Documentation**
2372 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
2373 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
2374 |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.
2375 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
2376 |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.
2377 |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.
2378
2379 **CategorySchemeReferenceType: **CategorySchemeReferenceType is a type for referencing a category scheme object. It consists of a URN and/or a complete set of reference fields.
2380
2381 Derivation:
2382
2383 //ReferenceType// (restriction)
2384 [[image:inherit.gif||height="9" width="9"]] //MaintainableReferenceBaseType// (restriction)
2385 [[image:inherit.gif||height="9" width="9"]] //ItemSchemeReferenceBaseType// (restriction)
2386 [[image:inherit.gif||height="9" width="9"]] CategorySchemeReferenceType
2387
2388 Content:
2389
2390 ( (Ref, URN?) | URN)
2391
2392 Element Documentation:
2393
2394 |**Name**|**Type**|**Documentation**
2395 |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.
2396 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2397 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2398
2399 **CategorySchemeRefType: **CategorySchemeRefType provides a reference to a category scheme via a complete set of reference fields.
2400
2401 Derivation:
2402
2403 //RefBaseType// (restriction)
2404 [[image:inherit.gif||height="9" width="9"]] //MaintainableRefBaseType// (restriction)
2405 [[image:inherit.gif||height="9" width="9"]] //ItemSchemeRefBaseType// (restriction)
2406 [[image:inherit.gif||height="9" width="9"]] CategorySchemeRefType
2407
2408 Attributes:
2409
2410 agencyID, id, version?, local?, class?, package?
2411
2412 Content:
2413
2414 {Empty}
2415
2416 Attribute Documentation:
2417
2418 |**Name**|**Type**|**Documentation**
2419 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
2420 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
2421 |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.
2422 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
2423 |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.
2424 |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.
2425
2426 **CategoryReferenceType: **CategoryReferenceType is a type for referencing a category object. It consists of a URN and/or a complete set of reference fields.
2427
2428 Derivation:
2429
2430 //ReferenceType// (restriction)
2431 [[image:inherit.gif||height="9" width="9"]] //ChildObjectReferenceType// (restriction)
2432 [[image:inherit.gif||height="9" width="9"]] //ItemReferenceType// (restriction)
2433 [[image:inherit.gif||height="9" width="9"]] CategoryReferenceType
2434
2435 Content:
2436
2437 ( (Ref, URN?) | URN)
2438
2439 Element Documentation:
2440
2441 |**Name**|**Type**|**Documentation**
2442 |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.
2443 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2444 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2445
2446 **CategoryRefType: **CategoryRefType references a category from within a category scheme. Reference fields are required for both the scheme and the item.
2447
2448 Derivation:
2449
2450 //RefBaseType// (restriction)
2451 [[image:inherit.gif||height="9" width="9"]] //ChildObjectRefBaseType// (restriction)
2452 [[image:inherit.gif||height="9" width="9"]] //ItemRefBaseType// (restriction)
2453 [[image:inherit.gif||height="9" width="9"]] CategoryRefType
2454
2455 Attributes:
2456
2457 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
2458
2459 Content:
2460
2461 {Empty}
2462
2463 Attribute Documentation:
2464
2465 |**Name**|**Type**|**Documentation**
2466 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
2467 |maintainableParentID|IDType|The maintainableParentID references the category scheme in which the category being referenced is defined.
2468 |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.
2469 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
2470 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
2471 |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.
2472 |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.
2473
2474 **LocalCategoryReferenceType: **LocalCategoryReferenceType provides a simple references to a category where the identification of the category scheme which defines it is contained in another context.
2475
2476 Derivation:
2477
2478 //ReferenceType// (restriction)
2479 [[image:inherit.gif||height="9" width="9"]] //LocalItemReferenceType// (restriction)
2480 [[image:inherit.gif||height="9" width="9"]] LocalCategoryReferenceType
2481
2482 Content:
2483
2484 Ref
2485
2486 Element Documentation:
2487
2488 |**Name**|**Type**|**Documentation**
2489 |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.
2490
2491 **LocalCategoryRefType: **LocalCategoryRefType references a category locally where the references to the category scheme which defines it is provided elsewhere.
2492
2493 Derivation:
2494
2495 //RefBaseType// (restriction)
2496 [[image:inherit.gif||height="9" width="9"]] //LocalIdentifiableRefBaseType// (restriction)
2497 [[image:inherit.gif||height="9" width="9"]] //LocalItemRefBaseType// (restriction)
2498 [[image:inherit.gif||height="9" width="9"]] LocalCategoryRefType
2499
2500 Attributes:
2501
2502 id, local?, class?, package?
2503
2504 Content:
2505
2506 {Empty}
2507
2508 Attribute Documentation:
2509
2510 |**Name**|**Type**|**Documentation**
2511 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
2512 |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.
2513 |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.
2514 |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.
2515
2516 **CodelistReferenceType: **CodelistReferenceType is a type for referencing a codelist object. It consists of a URN and/or a complete set of reference fields.
2517
2518 Derivation:
2519
2520 //ReferenceType// (restriction)
2521 [[image:inherit.gif||height="9" width="9"]] //MaintainableReferenceBaseType// (restriction)
2522 [[image:inherit.gif||height="9" width="9"]] //ItemSchemeReferenceBaseType// (restriction)
2523 [[image:inherit.gif||height="9" width="9"]] CodelistReferenceType
2524
2525 Content:
2526
2527 ( (Ref, URN?) | URN)
2528
2529 Element Documentation:
2530
2531 |**Name**|**Type**|**Documentation**
2532 |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.
2533 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2534 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2535
2536 **CodelistRefType: **CodelistRefType provides a reference to a codelist via a complete set of reference fields.
2537
2538 Derivation:
2539
2540 //RefBaseType// (restriction)
2541 [[image:inherit.gif||height="9" width="9"]] //MaintainableRefBaseType// (restriction)
2542 [[image:inherit.gif||height="9" width="9"]] //ItemSchemeRefBaseType// (restriction)
2543 [[image:inherit.gif||height="9" width="9"]] CodelistRefType
2544
2545 Attributes:
2546
2547 agencyID, id, version?, local?, class?, package?
2548
2549 Content:
2550
2551 {Empty}
2552
2553 Attribute Documentation:
2554
2555 |**Name**|**Type**|**Documentation**
2556 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
2557 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
2558 |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.
2559 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
2560 |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.
2561 |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.
2562
2563 **CodeReferenceType: **CodeReferenceType is a type for referencing a code object. It consists of a URN and/or a complete set of reference fields.
2564
2565 Derivation:
2566
2567 //ReferenceType// (restriction)
2568 [[image:inherit.gif||height="9" width="9"]] //ChildObjectReferenceType// (restriction)
2569 [[image:inherit.gif||height="9" width="9"]] //ItemReferenceType// (restriction)
2570 [[image:inherit.gif||height="9" width="9"]] CodeReferenceType
2571
2572 Content:
2573
2574 ( (Ref, URN?) | URN)
2575
2576 Element Documentation:
2577
2578 |**Name**|**Type**|**Documentation**
2579 |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.
2580 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2581 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2582
2583 **CodeRefType: **CodeRefType references a code from within a codelist. Reference fields are required for both the scheme and the item.
2584
2585 Derivation:
2586
2587 //RefBaseType// (restriction)
2588 [[image:inherit.gif||height="9" width="9"]] //ChildObjectRefBaseType// (restriction)
2589 [[image:inherit.gif||height="9" width="9"]] //ItemRefBaseType// (restriction)
2590 [[image:inherit.gif||height="9" width="9"]] CodeRefType
2591
2592 Attributes:
2593
2594 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
2595
2596 Content:
2597
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 codelist in which the code being referenced is defined.
2605 |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.
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: 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.
2609 |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.
2610
2611 **LocalCodeReferenceType: **LocalCodeReferenceType provides a simple references to a code where the identification of the codelist which defines it is contained in another context.
2612
2613 Derivation:
2614
2615 //ReferenceType// (restriction)
2616 [[image:inherit.gif||height="9" width="9"]] //LocalItemReferenceType// (restriction)
2617 [[image:inherit.gif||height="9" width="9"]] LocalCodeReferenceType
2618
2619 Content:
2620
2621 Ref
2622
2623 Element Documentation:
2624
2625 |**Name**|**Type**|**Documentation**
2626 |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.
2627
2628 **LocalCodeRefType: **LocalCodeRefType references a code locally where the references to the codelist which defines it is provided elsewhere.
2629
2630 Derivation:
2631
2632 //RefBaseType// (restriction)
2633 [[image:inherit.gif||height="9" width="9"]] //LocalIdentifiableRefBaseType// (restriction)
2634 [[image:inherit.gif||height="9" width="9"]] //LocalItemRefBaseType// (restriction)
2635 [[image:inherit.gif||height="9" width="9"]] LocalCodeRefType
2636
2637 Attributes:
2638
2639 id, local?, class?, package?
2640
2641 Content:
2642
2643 {Empty}
2644
2645 Attribute Documentation:
2646
2647 |**Name**|**Type**|**Documentation**
2648 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
2649 |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.
2650 |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.
2651 |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.
2652
2653 **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.
2654
2655 Derivation:
2656
2657 //ReferenceType// (restriction)
2658 [[image:inherit.gif||height="9" width="9"]] //MaintainableReferenceBaseType// (restriction)
2659 [[image:inherit.gif||height="9" width="9"]] AnyCodelistReferenceType
2660
2661 Content:
2662
2663 ( (Ref, URN?) | URN)
2664
2665 Element Documentation:
2666
2667 |**Name**|**Type**|**Documentation**
2668 |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.
2669 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2670 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2671
2672 **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.
2673
2674 Derivation:
2675
2676 //ReferenceType// (restriction)
2677 [[image:inherit.gif||height="9" width="9"]] AnyLocalCodeReferenceType
2678
2679 Content:
2680
2681 ( (Ref, URN?) | URN)
2682
2683 Element Documentation:
2684
2685 |**Name**|**Type**|**Documentation**
2686 |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.
2687 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2688 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2689
2690 **ConceptSchemeReferenceType: **ConceptSchemeReferenceType is a type for referencing a concept scheme object. It consists of a URN and/or a complete set of reference fields.
2691
2692 Derivation:
2693
2694 //ReferenceType// (restriction)
2695 [[image:inherit.gif||height="9" width="9"]] //MaintainableReferenceBaseType// (restriction)
2696 [[image:inherit.gif||height="9" width="9"]] //ItemSchemeReferenceBaseType// (restriction)
2697 [[image:inherit.gif||height="9" width="9"]] ConceptSchemeReferenceType
2698
2699 Content:
2700
2701 ( (Ref, URN?) | URN)
2702
2703 Element Documentation:
2704
2705 |**Name**|**Type**|**Documentation**
2706 |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.
2707 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2708 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2709
2710 **ConceptSchemeRefType: **ConceptSchemeRefType provides a reference to a concept scheme via a complete set of reference fields.
2711
2712 Derivation:
2713
2714 //RefBaseType// (restriction)
2715 [[image:inherit.gif||height="9" width="9"]] //MaintainableRefBaseType// (restriction)
2716 [[image:inherit.gif||height="9" width="9"]] //ItemSchemeRefBaseType// (restriction)
2717 [[image:inherit.gif||height="9" width="9"]] ConceptSchemeRefType
2718
2719 Attributes:
2720
2721 agencyID, id, version?, local?, class?, package?
2722
2723 Content:
2724
2725 {Empty}
2726
2727 Attribute Documentation:
2728
2729 |**Name**|**Type**|**Documentation**
2730 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
2731 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
2732 |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.
2733 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
2734 |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.
2735 |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.
2736
2737 **ConceptReferenceType: **ConceptReferenceType is a type for referencing a concept object. It consists of a URN and/or a complete set of reference fields.
2738
2739 Derivation:
2740
2741 //ReferenceType// (restriction)
2742 [[image:inherit.gif||height="9" width="9"]] //ChildObjectReferenceType// (restriction)
2743 [[image:inherit.gif||height="9" width="9"]] //ItemReferenceType// (restriction)
2744 [[image:inherit.gif||height="9" width="9"]] ConceptReferenceType
2745
2746 Content:
2747
2748 ( (Ref, URN?) | URN)
2749
2750 Element Documentation:
2751
2752 |**Name**|**Type**|**Documentation**
2753 |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.
2754 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2755 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2756
2757 **ConceptRefType: **ConceptRefType references a concept from within a concept scheme. Reference fields are required for both the scheme and the item.
2758
2759 Derivation:
2760
2761 //RefBaseType// (restriction)
2762 [[image:inherit.gif||height="9" width="9"]] //ChildObjectRefBaseType// (restriction)
2763 [[image:inherit.gif||height="9" width="9"]] //ItemRefBaseType// (restriction)
2764 [[image:inherit.gif||height="9" width="9"]] ConceptRefType
2765
2766 Attributes:
2767
2768 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
2769
2770 Content:
2771
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 concept scheme in which the concept being referenced is defined.
2779 |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.
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 (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.
2783 |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.
2784
2785 **LocalConceptReferenceType: **LocalConceptReferenceType provides a simple references to a concept where the identification of the concept scheme which defines it is contained in another context.
2786
2787 Derivation:
2788
2789 //ReferenceType// (restriction)
2790 [[image:inherit.gif||height="9" width="9"]] //LocalItemReferenceType// (restriction)
2791 [[image:inherit.gif||height="9" width="9"]] LocalConceptReferenceType
2792
2793 Content:
2794
2795 Ref
2796
2797 Element Documentation:
2798
2799 |**Name**|**Type**|**Documentation**
2800 |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.
2801
2802 **LocalConceptRefType: **LocalConceptRefType references a concept locally where the references to the concept scheme which defines it is provided elsewhere.
2803
2804 Derivation:
2805
2806 //RefBaseType// (restriction)
2807 [[image:inherit.gif||height="9" width="9"]] //LocalIdentifiableRefBaseType// (restriction)
2808 [[image:inherit.gif||height="9" width="9"]] //LocalItemRefBaseType// (restriction)
2809 [[image:inherit.gif||height="9" width="9"]] LocalConceptRefType
2810
2811 Attributes:
2812
2813 id, local?, class?, package?
2814
2815 Content:
2816
2817 {Empty}
2818
2819 Attribute Documentation:
2820
2821 |**Name**|**Type**|**Documentation**
2822 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
2823 |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.
2824 |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.
2825 |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.
2826
2827 //**OrganisationSchemeReferenceBaseType**//**: **OrganisationSchemeReferenceBaseType is a type for referencing a organisation scheme object. It consists of a URN and/or a complete set of reference fields.
2828
2829 Derivation:
2830
2831 //ReferenceType// (restriction)
2832 [[image:inherit.gif||height="9" width="9"]] //MaintainableReferenceBaseType// (restriction)
2833 [[image:inherit.gif||height="9" width="9"]] //ItemSchemeReferenceBaseType// (restriction)
2834 [[image:inherit.gif||height="9" width="9"]] //OrganisationSchemeReferenceBaseType//
2835
2836 Content:
2837
2838 ( (Ref, URN?) | URN)
2839
2840 Element Documentation:
2841
2842 |**Name**|**Type**|**Documentation**
2843 |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.
2844 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2845 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2846
2847 //**OrganisationSchemeRefBaseType**//**: **OrganisationSchemeRefBaseType contains a set of reference fields for an organisation scheme.
2848
2849 Derivation:
2850
2851 //RefBaseType// (restriction)
2852 [[image:inherit.gif||height="9" width="9"]] //MaintainableRefBaseType// (restriction)
2853 [[image:inherit.gif||height="9" width="9"]] //ItemSchemeRefBaseType// (restriction)
2854 [[image:inherit.gif||height="9" width="9"]] //OrganisationSchemeRefBaseType//
2855
2856 Attributes:
2857
2858 agencyID, id, version?, local?, class?, package?
2859
2860 Content:
2861
2862 {Empty}
2863
2864 Attribute Documentation:
2865
2866 |**Name**|**Type**|**Documentation**
2867 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
2868 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
2869 |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.
2870 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
2871 |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.
2872 |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.
2873
2874 **OrganisationSchemeReferenceType: **OrganisationSchemeReferenceType references an organisation scheme regardless of the specific type. It consists of a URN and/or a complete set of reference fields.
2875
2876 Derivation:
2877
2878 //ReferenceType// (restriction)
2879 [[image:inherit.gif||height="9" width="9"]] //MaintainableReferenceBaseType// (restriction)
2880 [[image:inherit.gif||height="9" width="9"]] //ItemSchemeReferenceBaseType// (restriction)
2881 [[image:inherit.gif||height="9" width="9"]] //OrganisationSchemeReferenceBaseType// (restriction)
2882 [[image:inherit.gif||height="9" width="9"]] OrganisationSchemeReferenceType
2883
2884 Content:
2885
2886 ( (Ref, URN?) | URN)
2887
2888 Element Documentation:
2889
2890 |**Name**|**Type**|**Documentation**
2891 |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.
2892 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2893 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2894
2895 **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.
2896
2897 Derivation:
2898
2899 //RefBaseType// (restriction)
2900 [[image:inherit.gif||height="9" width="9"]] //MaintainableRefBaseType// (restriction)
2901 [[image:inherit.gif||height="9" width="9"]] //ItemSchemeRefBaseType// (restriction)
2902 [[image:inherit.gif||height="9" width="9"]] //OrganisationSchemeRefBaseType// (restriction)
2903 [[image:inherit.gif||height="9" width="9"]] OrganisationSchemeRefType
2904
2905 Attributes:
2906
2907 agencyID, id, version?, local?, class, package?
2908
2909 Content:
2910
2911 {Empty}
2912
2913 Attribute Documentation:
2914
2915 |**Name**|**Type**|**Documentation**
2916 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
2917 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
2918 |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.
2919 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
2920 |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.
2921 |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.
2922
2923 //**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.
2924
2925 Derivation:
2926
2927 //ReferenceType// (restriction)
2928 [[image:inherit.gif||height="9" width="9"]] //ChildObjectReferenceType// (restriction)
2929 [[image:inherit.gif||height="9" width="9"]] //ItemReferenceType// (restriction)
2930 [[image:inherit.gif||height="9" width="9"]] //OrganisationReferenceBaseType//
2931
2932 Content:
2933
2934 ( (Ref, URN?) | URN)
2935
2936 Element Documentation:
2937
2938 |**Name**|**Type**|**Documentation**
2939 |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.
2940 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2941 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2942
2943 //**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.
2944
2945 Derivation:
2946
2947 //RefBaseType// (restriction)
2948 [[image:inherit.gif||height="9" width="9"]] //ChildObjectRefBaseType// (restriction)
2949 [[image:inherit.gif||height="9" width="9"]] //ItemRefBaseType// (restriction)
2950 [[image:inherit.gif||height="9" width="9"]] //OrganisationRefBaseType//
2951
2952 Attributes:
2953
2954 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
2955
2956 Content:
2957
2958 {Empty}
2959
2960 Attribute Documentation:
2961
2962 |**Name**|**Type**|**Documentation**
2963 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
2964 |maintainableParentID|IDType|The maintainableParentID references the organisation scheme in which the organisation being referenced is defined.
2965 |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.
2966 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
2967 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
2968 |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.
2969 |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.
2970
2971 **OrganisationReferenceType: **OrganisationReferenceType references an organisation regardless of the specific type. It consists of a URN and/or a complete set of reference fields.
2972
2973 Derivation:
2974
2975 //ReferenceType// (restriction)
2976 [[image:inherit.gif||height="9" width="9"]] //ChildObjectReferenceType// (restriction)
2977 [[image:inherit.gif||height="9" width="9"]] //ItemReferenceType// (restriction)
2978 [[image:inherit.gif||height="9" width="9"]] //OrganisationReferenceBaseType// (restriction)
2979 [[image:inherit.gif||height="9" width="9"]] OrganisationReferenceType
2980
2981 Content:
2982
2983 ( (Ref, URN?) | URN)
2984
2985 Element Documentation:
2986
2987 |**Name**|**Type**|**Documentation**
2988 |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.
2989 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2990 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2991
2992 **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.
2993
2994 Derivation:
2995
2996 //RefBaseType// (restriction)
2997 [[image:inherit.gif||height="9" width="9"]] //ChildObjectRefBaseType// (restriction)
2998 [[image:inherit.gif||height="9" width="9"]] //ItemRefBaseType// (restriction)
2999 [[image:inherit.gif||height="9" width="9"]] //OrganisationRefBaseType// (restriction)
3000 [[image:inherit.gif||height="9" width="9"]] OrganisationRefType
3001
3002 Attributes:
3003
3004 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class, package?
3005
3006 Content:
3007
3008 {Empty}
3009
3010 Attribute Documentation:
3011
3012 |**Name**|**Type**|**Documentation**
3013 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
3014 |maintainableParentID|IDType|The maintainableParentID references the organisation scheme in which the organisation being referenced is defined.
3015 |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.
3016 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
3017 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
3018 |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.
3019 |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.
3020
3021 //**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.
3022
3023 Derivation:
3024
3025 //ReferenceType// (restriction)
3026 [[image:inherit.gif||height="9" width="9"]] //LocalItemReferenceType// (restriction)
3027 [[image:inherit.gif||height="9" width="9"]] //LocalOrganisationReferenceBaseType//
3028
3029 Content:
3030
3031 Ref
3032
3033 Element Documentation:
3034
3035 |**Name**|**Type**|**Documentation**
3036 |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.
3037
3038 //**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.
3039
3040 Derivation:
3041
3042 //RefBaseType// (restriction)
3043 [[image:inherit.gif||height="9" width="9"]] //LocalIdentifiableRefBaseType// (restriction)
3044 [[image:inherit.gif||height="9" width="9"]] //LocalItemRefBaseType// (restriction)
3045 [[image:inherit.gif||height="9" width="9"]] //LocalOrganisationRefBaseType//
3046
3047 Attributes:
3048
3049 id, local?, class?, package?
3050
3051 Content:
3052
3053 {Empty}
3054
3055 Attribute Documentation:
3056
3057 |**Name**|**Type**|**Documentation**
3058 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
3059 |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.
3060 |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.
3061 |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.
3062
3063 **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.
3064
3065 Derivation:
3066
3067 //ReferenceType// (restriction)
3068 [[image:inherit.gif||height="9" width="9"]] //LocalItemReferenceType// (restriction)
3069 [[image:inherit.gif||height="9" width="9"]] //LocalOrganisationReferenceBaseType// (restriction)
3070 [[image:inherit.gif||height="9" width="9"]] LocalOrganisationReferenceType
3071
3072 Content:
3073
3074 Ref
3075
3076 Element Documentation:
3077
3078 |**Name**|**Type**|**Documentation**
3079 |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.
3080
3081 **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.
3082
3083 Derivation:
3084
3085 //RefBaseType// (restriction)
3086 [[image:inherit.gif||height="9" width="9"]] //LocalIdentifiableRefBaseType// (restriction)
3087 [[image:inherit.gif||height="9" width="9"]] //LocalItemRefBaseType// (restriction)
3088 [[image:inherit.gif||height="9" width="9"]] //LocalOrganisationRefBaseType// (restriction)
3089 [[image:inherit.gif||height="9" width="9"]] LocalOrganisationRefType
3090
3091 Attributes:
3092
3093 id, local?, class?, package?
3094
3095 Content:
3096
3097 {Empty}
3098
3099 Attribute Documentation:
3100
3101 |**Name**|**Type**|**Documentation**
3102 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
3103 |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.
3104 |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.
3105 |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.
3106
3107 **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.
3108
3109 Derivation:
3110
3111 //ReferenceType// (restriction)
3112 [[image:inherit.gif||height="9" width="9"]] //MaintainableReferenceBaseType// (restriction)
3113 [[image:inherit.gif||height="9" width="9"]] //ItemSchemeReferenceBaseType// (restriction)
3114 [[image:inherit.gif||height="9" width="9"]] //OrganisationSchemeReferenceBaseType// (restriction)
3115 [[image:inherit.gif||height="9" width="9"]] OrganisationUnitSchemeReferenceType
3116
3117 Content:
3118
3119 ( (Ref, URN?) | URN)
3120
3121 Element Documentation:
3122
3123 |**Name**|**Type**|**Documentation**
3124 |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.
3125 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3126 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3127
3128 **OrganisationUnitSchemeRefType: **OrganisationUnitSchemeRefType contains a set of reference fields for an organisation unit scheme.
3129
3130 Derivation:
3131
3132 //RefBaseType// (restriction)
3133 [[image:inherit.gif||height="9" width="9"]] //MaintainableRefBaseType// (restriction)
3134 [[image:inherit.gif||height="9" width="9"]] //ItemSchemeRefBaseType// (restriction)
3135 [[image:inherit.gif||height="9" width="9"]] //OrganisationSchemeRefBaseType// (restriction)
3136 [[image:inherit.gif||height="9" width="9"]] OrganisationUnitSchemeRefType
3137
3138 Attributes:
3139
3140 agencyID, id, version?, local?, class?, package?
3141
3142 Content:
3143
3144 {Empty}
3145
3146 Attribute Documentation:
3147
3148 |**Name**|**Type**|**Documentation**
3149 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
3150 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
3151 |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.
3152 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
3153 |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.
3154 |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.
3155
3156 **OrganisationUnitReferenceType: **OrganisationUnitReferenceType is a type for referencing an organisation unit. It consists of a URN and/or a complete set of reference fields.
3157
3158 Derivation:
3159
3160 //ReferenceType// (restriction)
3161 [[image:inherit.gif||height="9" width="9"]] //ChildObjectReferenceType// (restriction)
3162 [[image:inherit.gif||height="9" width="9"]] //ItemReferenceType// (restriction)
3163 [[image:inherit.gif||height="9" width="9"]] //OrganisationReferenceBaseType// (restriction)
3164 [[image:inherit.gif||height="9" width="9"]] OrganisationUnitReferenceType
3165
3166 Content:
3167
3168 ( (Ref, URN?) | URN)
3169
3170 Element Documentation:
3171
3172 |**Name**|**Type**|**Documentation**
3173 |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.
3174 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3175 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3176
3177 **OrganisationUnitRefType: **OrganisationUnitRefType contains a set of reference fields for referencing an organisation unit within an organisation unit scheme.
3178
3179 Derivation:
3180
3181 //RefBaseType// (restriction)
3182 [[image:inherit.gif||height="9" width="9"]] //ChildObjectRefBaseType// (restriction)
3183 [[image:inherit.gif||height="9" width="9"]] //ItemRefBaseType// (restriction)
3184 [[image:inherit.gif||height="9" width="9"]] //OrganisationRefBaseType// (restriction)
3185 [[image:inherit.gif||height="9" width="9"]] OrganisationUnitRefType
3186
3187 Attributes:
3188
3189 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
3190
3191 Content:
3192
3193 {Empty}
3194
3195 Attribute Documentation:
3196
3197 |**Name**|**Type**|**Documentation**
3198 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
3199 |maintainableParentID|IDType|The maintainableParentID references the organisation scheme in which the organisation being referenced is defined.
3200 |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.
3201 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
3202 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
3203 |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.
3204 |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.
3205
3206 **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.
3207
3208 Derivation:
3209
3210 //ReferenceType// (restriction)
3211 [[image:inherit.gif||height="9" width="9"]] //LocalItemReferenceType// (restriction)
3212 [[image:inherit.gif||height="9" width="9"]] //LocalOrganisationReferenceBaseType// (restriction)
3213 [[image:inherit.gif||height="9" width="9"]] LocalOrganisationUnitReferenceType
3214
3215 Content:
3216
3217 Ref
3218
3219 Element Documentation:
3220
3221 |**Name**|**Type**|**Documentation**
3222 |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.
3223
3224 **LocalOrganisationUnitRefType: **LocalOrganisationUnitRefType references an organisation unit locally where the reference to the organisation unit scheme which defines it is provided elsewhere.
3225
3226 Derivation:
3227
3228 //RefBaseType// (restriction)
3229 [[image:inherit.gif||height="9" width="9"]] //LocalIdentifiableRefBaseType// (restriction)
3230 [[image:inherit.gif||height="9" width="9"]] //LocalItemRefBaseType// (restriction)
3231 [[image:inherit.gif||height="9" width="9"]] //LocalOrganisationRefBaseType// (restriction)
3232 [[image:inherit.gif||height="9" width="9"]] LocalOrganisationUnitRefType
3233
3234 Attributes:
3235
3236 id, local?, class?, package?
3237
3238 Content:
3239
3240 {Empty}
3241
3242 Attribute Documentation:
3243
3244 |**Name**|**Type**|**Documentation**
3245 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
3246 |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.
3247 |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.
3248 |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.
3249
3250 **AgencySchemeReferenceType: **AgencySchemeReferenceType is a type for referencing an agency scheme object. It consists of a URN and/or a complete set of reference fields.
3251
3252 Derivation:
3253
3254 //ReferenceType// (restriction)
3255 [[image:inherit.gif||height="9" width="9"]] //MaintainableReferenceBaseType// (restriction)
3256 [[image:inherit.gif||height="9" width="9"]] //ItemSchemeReferenceBaseType// (restriction)
3257 [[image:inherit.gif||height="9" width="9"]] //OrganisationSchemeReferenceBaseType// (restriction)
3258 [[image:inherit.gif||height="9" width="9"]] AgencySchemeReferenceType
3259
3260 Content:
3261
3262 ( (Ref, URN?) | URN)
3263
3264 Element Documentation:
3265
3266 |**Name**|**Type**|**Documentation**
3267 |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.
3268 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3269 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3270
3271 **AgencySchemeRefType: **AgencySchemeRefType contains a set of reference fields for an agency scheme.
3272
3273 Derivation:
3274
3275 //RefBaseType// (restriction)
3276 [[image:inherit.gif||height="9" width="9"]] //MaintainableRefBaseType// (restriction)
3277 [[image:inherit.gif||height="9" width="9"]] //ItemSchemeRefBaseType// (restriction)
3278 [[image:inherit.gif||height="9" width="9"]] //OrganisationSchemeRefBaseType// (restriction)
3279 [[image:inherit.gif||height="9" width="9"]] AgencySchemeRefType
3280
3281 Attributes:
3282
3283 agencyID, id, version?, local?, class?, package?
3284
3285 Content:
3286
3287 {Empty}
3288
3289 Attribute Documentation:
3290
3291 |**Name**|**Type**|**Documentation**
3292 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
3293 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
3294 |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.
3295 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
3296 |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.
3297 |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.
3298
3299 **AgencyReferenceType: **AgencyReferenceType is a type for referencing an agency. It consists of a URN and/or a complete set of reference fields.
3300
3301 Derivation:
3302
3303 //ReferenceType// (restriction)
3304 [[image:inherit.gif||height="9" width="9"]] //ChildObjectReferenceType// (restriction)
3305 [[image:inherit.gif||height="9" width="9"]] //ItemReferenceType// (restriction)
3306 [[image:inherit.gif||height="9" width="9"]] //OrganisationReferenceBaseType// (restriction)
3307 [[image:inherit.gif||height="9" width="9"]] AgencyReferenceType
3308
3309 Content:
3310
3311 ( (Ref, URN?) | URN)
3312
3313 Element Documentation:
3314
3315 |**Name**|**Type**|**Documentation**
3316 |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.
3317 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3318 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3319
3320 **AgencyRefType: **AgencyRefType contains a set of reference fields for referencing an agency within an agency scheme.
3321
3322 Derivation:
3323
3324 //RefBaseType// (restriction)
3325 [[image:inherit.gif||height="9" width="9"]] //ChildObjectRefBaseType// (restriction)
3326 [[image:inherit.gif||height="9" width="9"]] //ItemRefBaseType// (restriction)
3327 [[image:inherit.gif||height="9" width="9"]] //OrganisationRefBaseType// (restriction)
3328 [[image:inherit.gif||height="9" width="9"]] AgencyRefType
3329
3330 Attributes:
3331
3332 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
3333
3334 Content:
3335
3336 {Empty}
3337
3338 Attribute Documentation:
3339
3340 |**Name**|**Type**|**Documentation**
3341 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
3342 |maintainableParentID|IDType|The maintainableParentID references the organisation scheme in which the organisation being referenced is defined.
3343 |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.
3344 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
3345 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
3346 |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.
3347 |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.
3348
3349 **LocalAgencyReferenceType: **LocalAgencyReferenceType provides a simple reference to an agency, where the reference to the agency scheme which defines it is provided in another context.
3350
3351 Derivation:
3352
3353 //ReferenceType// (restriction)
3354 [[image:inherit.gif||height="9" width="9"]] //LocalItemReferenceType// (restriction)
3355 [[image:inherit.gif||height="9" width="9"]] //LocalOrganisationReferenceBaseType// (restriction)
3356 [[image:inherit.gif||height="9" width="9"]] LocalAgencyReferenceType
3357
3358 Content:
3359
3360 Ref
3361
3362 Element Documentation:
3363
3364 |**Name**|**Type**|**Documentation**
3365 |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.
3366
3367 **LocalAgencyRefType: **LocalAgencyRefType references an agency locally where the reference to the agency scheme which defines it is provided elsewhere.
3368
3369 Derivation:
3370
3371 //RefBaseType// (restriction)
3372 [[image:inherit.gif||height="9" width="9"]] //LocalIdentifiableRefBaseType// (restriction)
3373 [[image:inherit.gif||height="9" width="9"]] //LocalItemRefBaseType// (restriction)
3374 [[image:inherit.gif||height="9" width="9"]] //LocalOrganisationRefBaseType// (restriction)
3375 [[image:inherit.gif||height="9" width="9"]] LocalAgencyRefType
3376
3377 Attributes:
3378
3379 id, local?, class?, package?
3380
3381 Content:
3382
3383 {Empty}
3384
3385 Attribute Documentation:
3386
3387 |**Name**|**Type**|**Documentation**
3388 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
3389 |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.
3390 |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.
3391 |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.
3392
3393 **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.
3394
3395 Derivation:
3396
3397 //ReferenceType// (restriction)
3398 [[image:inherit.gif||height="9" width="9"]] //MaintainableReferenceBaseType// (restriction)
3399 [[image:inherit.gif||height="9" width="9"]] //ItemSchemeReferenceBaseType// (restriction)
3400 [[image:inherit.gif||height="9" width="9"]] //OrganisationSchemeReferenceBaseType// (restriction)
3401 [[image:inherit.gif||height="9" width="9"]] DataConsumerSchemeReferenceType
3402
3403 Content:
3404
3405 ( (Ref, URN?) | URN)
3406
3407 Element Documentation:
3408
3409 |**Name**|**Type**|**Documentation**
3410 |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.
3411 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3412 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3413
3414 **DataConsumerSchemeRefType: **DataConsumerSchemeRefType contains a set of reference fields for a data consumer scheme.
3415
3416 Derivation:
3417
3418 //RefBaseType// (restriction)
3419 [[image:inherit.gif||height="9" width="9"]] //MaintainableRefBaseType// (restriction)
3420 [[image:inherit.gif||height="9" width="9"]] //ItemSchemeRefBaseType// (restriction)
3421 [[image:inherit.gif||height="9" width="9"]] //OrganisationSchemeRefBaseType// (restriction)
3422 [[image:inherit.gif||height="9" width="9"]] DataConsumerSchemeRefType
3423
3424 Attributes:
3425
3426 agencyID, id, version?, local?, class?, package?
3427
3428 Content:
3429
3430 {Empty}
3431
3432 Attribute Documentation:
3433
3434 |**Name**|**Type**|**Documentation**
3435 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
3436 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
3437 |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.
3438 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
3439 |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.
3440 |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.
3441
3442 **DataConsumerReferenceType: **DataConsumerReferenceType is a type for referencing a data consumer. It consists of a URN and/or a complete set of reference fields.
3443
3444 Derivation:
3445
3446 //ReferenceType// (restriction)
3447 [[image:inherit.gif||height="9" width="9"]] //ChildObjectReferenceType// (restriction)
3448 [[image:inherit.gif||height="9" width="9"]] //ItemReferenceType// (restriction)
3449 [[image:inherit.gif||height="9" width="9"]] //OrganisationReferenceBaseType// (restriction)
3450 [[image:inherit.gif||height="9" width="9"]] DataConsumerReferenceType
3451
3452 Content:
3453
3454 ( (Ref, URN?) | URN)
3455
3456 Element Documentation:
3457
3458 |**Name**|**Type**|**Documentation**
3459 |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.
3460 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3461 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3462
3463 **DataConsumerRefType: **DataConsumerRefType contains a set of reference fields for referencing a data consumer within a data consumer scheme.
3464
3465 Derivation:
3466
3467 //RefBaseType// (restriction)
3468 [[image:inherit.gif||height="9" width="9"]] //ChildObjectRefBaseType// (restriction)
3469 [[image:inherit.gif||height="9" width="9"]] //ItemRefBaseType// (restriction)
3470 [[image:inherit.gif||height="9" width="9"]] //OrganisationRefBaseType// (restriction)
3471 [[image:inherit.gif||height="9" width="9"]] DataConsumerRefType
3472
3473 Attributes:
3474
3475 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
3476
3477 Content:
3478
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 |maintainableParentID|IDType|The maintainableParentID references the organisation scheme in which the organisation being referenced is defined.
3486 |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.
3487 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
3488 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
3489 |class (fixed: 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.
3490 |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.
3491
3492 **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.
3493
3494 Derivation:
3495
3496 //ReferenceType// (restriction)
3497 [[image:inherit.gif||height="9" width="9"]] //LocalItemReferenceType// (restriction)
3498 [[image:inherit.gif||height="9" width="9"]] //LocalOrganisationReferenceBaseType// (restriction)
3499 [[image:inherit.gif||height="9" width="9"]] LocalDataConsumerReferenceType
3500
3501 Content:
3502
3503 Ref
3504
3505 Element Documentation:
3506
3507 |**Name**|**Type**|**Documentation**
3508 |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.
3509
3510 **LocalDataConsumerRefType: **LocalDataConsumerRefType references a data consumer locally where the reference to the data consumer scheme which defines it is provided elsewhere.
3511
3512 Derivation:
3513
3514 //RefBaseType// (restriction)
3515 [[image:inherit.gif||height="9" width="9"]] //LocalIdentifiableRefBaseType// (restriction)
3516 [[image:inherit.gif||height="9" width="9"]] //LocalItemRefBaseType// (restriction)
3517 [[image:inherit.gif||height="9" width="9"]] //LocalOrganisationRefBaseType// (restriction)
3518 [[image:inherit.gif||height="9" width="9"]] LocalDataConsumerRefType
3519
3520 Attributes:
3521
3522 id, local?, class?, package?
3523
3524 Content:
3525
3526 {Empty}
3527
3528 Attribute Documentation:
3529
3530 |**Name**|**Type**|**Documentation**
3531 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
3532 |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.
3533 |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.
3534 |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.
3535
3536 **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.
3537
3538 Derivation:
3539
3540 //ReferenceType// (restriction)
3541 [[image:inherit.gif||height="9" width="9"]] //MaintainableReferenceBaseType// (restriction)
3542 [[image:inherit.gif||height="9" width="9"]] //ItemSchemeReferenceBaseType// (restriction)
3543 [[image:inherit.gif||height="9" width="9"]] //OrganisationSchemeReferenceBaseType// (restriction)
3544 [[image:inherit.gif||height="9" width="9"]] DataProviderSchemeReferenceType
3545
3546 Content:
3547
3548 ( (Ref, URN?) | URN)
3549
3550 Element Documentation:
3551
3552 |**Name**|**Type**|**Documentation**
3553 |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.
3554 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3555 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3556
3557 **DataProviderSchemeRefType: **DataProviderSchemeRefType contains a set of reference fields for a data provider scheme.
3558
3559 Derivation:
3560
3561 //RefBaseType// (restriction)
3562 [[image:inherit.gif||height="9" width="9"]] //MaintainableRefBaseType// (restriction)
3563 [[image:inherit.gif||height="9" width="9"]] //ItemSchemeRefBaseType// (restriction)
3564 [[image:inherit.gif||height="9" width="9"]] //OrganisationSchemeRefBaseType// (restriction)
3565 [[image:inherit.gif||height="9" width="9"]] DataProviderSchemeRefType
3566
3567 Attributes:
3568
3569 agencyID, id, version?, local?, class?, package?
3570
3571 Content:
3572
3573 {Empty}
3574
3575 Attribute Documentation:
3576
3577 |**Name**|**Type**|**Documentation**
3578 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
3579 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
3580 |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.
3581 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
3582 |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.
3583 |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.
3584
3585 **DataProviderReferenceType: **DataProviderReferenceType is a type for referencing a data provider. It consists of a URN and/or a complete set of reference fields.
3586
3587 Derivation:
3588
3589 //ReferenceType// (restriction)
3590 [[image:inherit.gif||height="9" width="9"]] //ChildObjectReferenceType// (restriction)
3591 [[image:inherit.gif||height="9" width="9"]] //ItemReferenceType// (restriction)
3592 [[image:inherit.gif||height="9" width="9"]] //OrganisationReferenceBaseType// (restriction)
3593 [[image:inherit.gif||height="9" width="9"]] DataProviderReferenceType
3594
3595 Content:
3596
3597 ( (Ref, URN?) | URN)
3598
3599 Element Documentation:
3600
3601 |**Name**|**Type**|**Documentation**
3602 |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.
3603 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3604 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3605
3606 **DataProviderRefType: **DataProviderRefType contains a set of reference fields for referencing a data provider within a data provider scheme.
3607
3608 Derivation:
3609
3610 //RefBaseType// (restriction)
3611 [[image:inherit.gif||height="9" width="9"]] //ChildObjectRefBaseType// (restriction)
3612 [[image:inherit.gif||height="9" width="9"]] //ItemRefBaseType// (restriction)
3613 [[image:inherit.gif||height="9" width="9"]] //OrganisationRefBaseType// (restriction)
3614 [[image:inherit.gif||height="9" width="9"]] DataProviderRefType
3615
3616 Attributes:
3617
3618 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
3619
3620 Content:
3621
3622 {Empty}
3623
3624 Attribute Documentation:
3625
3626 |**Name**|**Type**|**Documentation**
3627 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
3628 |maintainableParentID|IDType|The maintainableParentID references the organisation scheme in which the organisation being referenced is defined.
3629 |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.
3630 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
3631 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
3632 |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.
3633 |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.
3634
3635 **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.
3636
3637 Derivation:
3638
3639 //ReferenceType// (restriction)
3640 [[image:inherit.gif||height="9" width="9"]] //LocalItemReferenceType// (restriction)
3641 [[image:inherit.gif||height="9" width="9"]] //LocalOrganisationReferenceBaseType// (restriction)
3642 [[image:inherit.gif||height="9" width="9"]] LocalDataProviderReferenceType
3643
3644 Content:
3645
3646 Ref
3647
3648 Element Documentation:
3649
3650 |**Name**|**Type**|**Documentation**
3651 |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.
3652
3653 **LocalDataProviderRefType: **LocalDataProviderRefType references a data provider locally where the reference to the data provider scheme which defines it is provided elsewhere.
3654
3655 Derivation:
3656
3657 //RefBaseType// (restriction)
3658 [[image:inherit.gif||height="9" width="9"]] //LocalIdentifiableRefBaseType// (restriction)
3659 [[image:inherit.gif||height="9" width="9"]] //LocalItemRefBaseType// (restriction)
3660 [[image:inherit.gif||height="9" width="9"]] //LocalOrganisationRefBaseType// (restriction)
3661 [[image:inherit.gif||height="9" width="9"]] LocalDataProviderRefType
3662
3663 Attributes:
3664
3665 id, local?, class?, package?
3666
3667 Content:
3668
3669 {Empty}
3670
3671 Attribute Documentation:
3672
3673 |**Name**|**Type**|**Documentation**
3674 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
3675 |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.
3676 |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.
3677 |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.
3678
3679 **ReportingTaxonomyReferenceType: **ReportingTaxonomyReferenceType is a type for referencing a reporting taxonomy object. It consists of a URN and/or a complete set of reference fields.
3680
3681 Derivation:
3682
3683 //ReferenceType// (restriction)
3684 [[image:inherit.gif||height="9" width="9"]] //MaintainableReferenceBaseType// (restriction)
3685 [[image:inherit.gif||height="9" width="9"]] //ItemSchemeReferenceBaseType// (restriction)
3686 [[image:inherit.gif||height="9" width="9"]] ReportingTaxonomyReferenceType
3687
3688 Content:
3689
3690 ( (Ref, URN?) | URN)
3691
3692 Element Documentation:
3693
3694 |**Name**|**Type**|**Documentation**
3695 |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.
3696 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3697 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3698
3699 **ReportingTaxonomyRefType: **ReportingTaxonomyRefType provides a reference to a reporting taxonomy via a complete set of reference fields.
3700
3701 Derivation:
3702
3703 //RefBaseType// (restriction)
3704 [[image:inherit.gif||height="9" width="9"]] //MaintainableRefBaseType// (restriction)
3705 [[image:inherit.gif||height="9" width="9"]] //ItemSchemeRefBaseType// (restriction)
3706 [[image:inherit.gif||height="9" width="9"]] ReportingTaxonomyRefType
3707
3708 Attributes:
3709
3710 agencyID, id, version?, local?, class?, package?
3711
3712 Content:
3713
3714 {Empty}
3715
3716 Attribute Documentation:
3717
3718 |**Name**|**Type**|**Documentation**
3719 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
3720 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
3721 |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.
3722 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
3723 |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.
3724 |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.
3725
3726 **ReportingCategoryReferenceType: **ReportingCategoryReferenceType is a type for referencing a reporting category object. It consists of a URN and/or a complete set of reference fields.
3727
3728 Derivation:
3729
3730 //ReferenceType// (restriction)
3731 [[image:inherit.gif||height="9" width="9"]] //ChildObjectReferenceType// (restriction)
3732 [[image:inherit.gif||height="9" width="9"]] //ItemReferenceType// (restriction)
3733 [[image:inherit.gif||height="9" width="9"]] ReportingCategoryReferenceType
3734
3735 Content:
3736
3737 ( (Ref, URN?) | URN)
3738
3739 Element Documentation:
3740
3741 |**Name**|**Type**|**Documentation**
3742 |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.
3743 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3744 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3745
3746 **ReportCategoryRefType: **ReportCategoryRefType contains a set of fields for referencing a reporting category within a reporting taxonomy.
3747
3748 Derivation:
3749
3750 //RefBaseType// (restriction)
3751 [[image:inherit.gif||height="9" width="9"]] //ChildObjectRefBaseType// (restriction)
3752 [[image:inherit.gif||height="9" width="9"]] //ItemRefBaseType// (restriction)
3753 [[image:inherit.gif||height="9" width="9"]] ReportCategoryRefType
3754
3755 Attributes:
3756
3757 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
3758
3759 Content:
3760
3761 {Empty}
3762
3763 Attribute Documentation:
3764
3765 |**Name**|**Type**|**Documentation**
3766 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
3767 |maintainableParentID|IDType|The maintainableParentID references the reporting taxonomy in which the reporting category being referenced is defined.
3768 |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.
3769 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
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: 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.
3772 |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.
3773
3774 **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.
3775
3776 Derivation:
3777
3778 //ReferenceType// (restriction)
3779 [[image:inherit.gif||height="9" width="9"]] //LocalItemReferenceType// (restriction)
3780 [[image:inherit.gif||height="9" width="9"]] LocalReportingCategoryReferenceType
3781
3782 Content:
3783
3784 Ref
3785
3786 Element Documentation:
3787
3788 |**Name**|**Type**|**Documentation**
3789 |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.
3790
3791 **LocalReportingCategoryRefType: **LocalReportingCategoryRefType references a reporting category locally where the references to the reporting taxonomy which defines it is provided elsewhere.
3792
3793 Derivation:
3794
3795 //RefBaseType// (restriction)
3796 [[image:inherit.gif||height="9" width="9"]] //LocalIdentifiableRefBaseType// (restriction)
3797 [[image:inherit.gif||height="9" width="9"]] //LocalItemRefBaseType// (restriction)
3798 [[image:inherit.gif||height="9" width="9"]] LocalReportingCategoryRefType
3799
3800 Attributes:
3801
3802 id, local?, class?, package?
3803
3804 Content:
3805
3806 {Empty}
3807
3808 Attribute Documentation:
3809
3810 |**Name**|**Type**|**Documentation**
3811 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
3812 |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.
3813 |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.
3814 |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.
3815
3816 **HierarchicalCodelistReferenceType: **HierarchicalCodelistReferenceType is a type for referencing a hierarchical codelist object. It consists of a URN and/or a complete set of reference fields.
3817
3818 Derivation:
3819
3820 //ReferenceType// (restriction)
3821 [[image:inherit.gif||height="9" width="9"]] //MaintainableReferenceBaseType// (restriction)
3822 [[image:inherit.gif||height="9" width="9"]] HierarchicalCodelistReferenceType
3823
3824 Content:
3825
3826 ( (Ref, URN?) | URN)
3827
3828 Element Documentation:
3829
3830 |**Name**|**Type**|**Documentation**
3831 |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.
3832 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3833 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3834
3835 **HierarchicalCodelistRefType: **HierarchicalCodelistRefType contains a set of reference fields for a hierarchical codelist.
3836
3837 Derivation:
3838
3839 //RefBaseType// (restriction)
3840 [[image:inherit.gif||height="9" width="9"]] //MaintainableRefBaseType// (restriction)
3841 [[image:inherit.gif||height="9" width="9"]] HierarchicalCodelistRefType
3842
3843 Attributes:
3844
3845 agencyID, id, version?, local?, class?, package?
3846
3847 Content:
3848
3849 {Empty}
3850
3851 Attribute Documentation:
3852
3853 |**Name**|**Type**|**Documentation**
3854 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
3855 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
3856 |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.
3857 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
3858 |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.
3859 |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.
3860
3861 **HierarchyReferenceType: **HierarchyReferenceType is a type for referencing a hierarchy within a hierarchical codelist.
3862
3863 Derivation:
3864
3865 //ReferenceType// (restriction)
3866 [[image:inherit.gif||height="9" width="9"]] //ChildObjectReferenceType// (restriction)
3867 [[image:inherit.gif||height="9" width="9"]] HierarchyReferenceType
3868
3869 Content:
3870
3871 ( (Ref, URN?) | URN)
3872
3873 Element Documentation:
3874
3875 |**Name**|**Type**|**Documentation**
3876 |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.
3877 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3878 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3879
3880 **HierarchyRefType: **HierarchyRefType is type which references a hierarchy from within a hierarchical codelist. Reference fields are required for both the hierarchy and the codelist.
3881
3882 Derivation:
3883
3884 //RefBaseType// (restriction)
3885 [[image:inherit.gif||height="9" width="9"]] //ChildObjectRefBaseType// (restriction)
3886 [[image:inherit.gif||height="9" width="9"]] HierarchyRefType
3887
3888 Attributes:
3889
3890 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
3891
3892 Content:
3893
3894 {Empty}
3895
3896 Attribute Documentation:
3897
3898 |**Name**|**Type**|**Documentation**
3899 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
3900 |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.
3901 |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.
3902 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
3903 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
3904 |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.
3905 |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.
3906
3907 **LevelReferenceType: **LevelReferenceType is a type for referencing a level object. It consists of a URN and/or a complete set of reference fields.
3908
3909 Derivation:
3910
3911 //ReferenceType// (restriction)
3912 [[image:inherit.gif||height="9" width="9"]] //ChildObjectReferenceType// (restriction)
3913 [[image:inherit.gif||height="9" width="9"]] LevelReferenceType
3914
3915 Content:
3916
3917 ( (Ref, URN?) | URN)
3918
3919 Element Documentation:
3920
3921 |**Name**|**Type**|**Documentation**
3922 |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.
3923 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3924 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3925
3926 **LevelRefType: **LevelRefType references a level from within a hierarchical codelist. Reference fields are required for both the level and the codelist.
3927
3928 Derivation:
3929
3930 //RefBaseType// (restriction)
3931 [[image:inherit.gif||height="9" width="9"]] //ChildObjectRefBaseType// (restriction)
3932 [[image:inherit.gif||height="9" width="9"]] LevelRefType
3933
3934 Attributes:
3935
3936 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
3937
3938 Content:
3939
3940 {Empty}
3941
3942 Attribute Documentation:
3943
3944 |**Name**|**Type**|**Documentation**
3945 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
3946 |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.
3947 |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.
3948 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
3949 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
3950 |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.
3951 |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.
3952
3953 **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).
3954
3955 Derivation:
3956
3957 //ReferenceType// (restriction)
3958 [[image:inherit.gif||height="9" width="9"]] LocalLevelReferenceType
3959
3960 Content:
3961
3962 Ref
3963
3964 Element Documentation:
3965
3966 |**Name**|**Type**|**Documentation**
3967 |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.
3968
3969 **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.
3970
3971 Derivation:
3972
3973 //RefBaseType// (restriction)
3974 [[image:inherit.gif||height="9" width="9"]] //LocalIdentifiableRefBaseType// (restriction)
3975 [[image:inherit.gif||height="9" width="9"]] LocalLevelRefType
3976
3977 Attributes:
3978
3979 containerID?, id, local?, class?, package?
3980
3981 Content:
3982
3983 {Empty}
3984
3985 Attribute Documentation:
3986
3987 |**Name**|**Type**|**Documentation**
3988 |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.
3989 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
3990 |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.
3991 |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.
3992 |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.
3993
3994 **HierarchicalCodeReferenceType: **HierarchicalCodeReferenceType is a type for referencing a hierarchical code object. It consists of a URN and/or a complete set of reference fields.
3995
3996 Derivation:
3997
3998 //ReferenceType// (restriction)
3999 [[image:inherit.gif||height="9" width="9"]] //ContainerChildObjectReferenceType// (restriction)
4000 [[image:inherit.gif||height="9" width="9"]] HierarchicalCodeReferenceType
4001
4002 Content:
4003
4004 ( (Ref, URN?) | URN)
4005
4006 Element Documentation:
4007
4008 |**Name**|**Type**|**Documentation**
4009 |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.
4010 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4011 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4012
4013 **HierarchicalCodeRefType: **HierarchicalCodeRefType references a code from within a hierarchical codelist. Reference fields are required for both the code and the codelist.
4014
4015 Derivation:
4016
4017 //RefBaseType// (restriction)
4018 [[image:inherit.gif||height="9" width="9"]] //ContainerChildObjectRefBaseType// (restriction)
4019 [[image:inherit.gif||height="9" width="9"]] HierarchicalCodeRefType
4020
4021 Attributes:
4022
4023 agencyID, maintainableParentID, maintainableParentVersion?, containerID, id, version?, local?, class?, package?
4024
4025 Content:
4026
4027 {Empty}
4028
4029 Attribute Documentation:
4030
4031 |**Name**|**Type**|**Documentation**
4032 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
4033 |maintainableParentID|IDType|The maintainableParentID references the hierarchical codelist in which the code being referenced is defined.
4034 |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.
4035 |containerID|IDType|The containerID references the hierarchy which contains the code being referenced is defined.
4036 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
4037 |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.
4038 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
4039 |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.
4040 |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.
4041
4042 **ConstraintReferenceType: **ConstraintReferenceType is a type for referencing a constraint object. It consists of a URN and/or a complete set of reference fields.
4043
4044 Derivation:
4045
4046 //ReferenceType// (restriction)
4047 [[image:inherit.gif||height="9" width="9"]] //MaintainableReferenceBaseType// (restriction)
4048 [[image:inherit.gif||height="9" width="9"]] ConstraintReferenceType
4049
4050 Content:
4051
4052 ( (Ref, URN?) | URN)
4053
4054 Element Documentation:
4055
4056 |**Name**|**Type**|**Documentation**
4057 |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.
4058 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4059 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4060
4061 //**ConstraintRefType**//**: **ConstraintRefType contains a set of reference fields for a constraint.
4062
4063 Derivation:
4064
4065 //RefBaseType// (restriction)
4066 [[image:inherit.gif||height="9" width="9"]] //MaintainableRefBaseType// (restriction)
4067 [[image:inherit.gif||height="9" width="9"]] //ConstraintRefType//
4068
4069 Attributes:
4070
4071 agencyID, id, version?, local?, class?, package?
4072
4073 Content:
4074
4075 {Empty}
4076
4077 Attribute Documentation:
4078
4079 |**Name**|**Type**|**Documentation**
4080 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
4081 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
4082 |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.
4083 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
4084 |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.
4085 |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.
4086
4087 **AttachmentConstraintReferenceType: **AttachmentConstraintReferenceType is a type for referencing a attachment constraint object. It consists of a URN and/or a complete set of reference fields.
4088
4089 Derivation:
4090
4091 //ReferenceType// (restriction)
4092 [[image:inherit.gif||height="9" width="9"]] //MaintainableReferenceBaseType// (restriction)
4093 [[image:inherit.gif||height="9" width="9"]] ConstraintReferenceType (restriction)
4094 [[image:inherit.gif||height="9" width="9"]] AttachmentConstraintReferenceType
4095
4096 Content:
4097
4098 ( (Ref, URN?) | URN)
4099
4100 Element Documentation:
4101
4102 |**Name**|**Type**|**Documentation**
4103 |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.
4104 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4105 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4106
4107 **AttachmentConstraintRefType: **AttachmentConstraintRefType contains a set of reference fields for an attachment constraint.
4108
4109 Derivation:
4110
4111 //RefBaseType// (restriction)
4112 [[image:inherit.gif||height="9" width="9"]] //MaintainableRefBaseType// (restriction)
4113 [[image:inherit.gif||height="9" width="9"]] //ConstraintRefType// (restriction)
4114 [[image:inherit.gif||height="9" width="9"]] AttachmentConstraintRefType
4115
4116 Attributes:
4117
4118 agencyID, id, version?, local?, class?, package?
4119
4120 Content:
4121
4122 {Empty}
4123
4124 Attribute Documentation:
4125
4126 |**Name**|**Type**|**Documentation**
4127 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
4128 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
4129 |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.
4130 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
4131 |class (fixed: 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.
4132 |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.
4133
4134 **ContentConstraintReferenceType: **ContentConstraintReferenceType is a type for referencing a content constraint object. It consists of a URN and/or a complete set of reference fields.
4135
4136 Derivation:
4137
4138 //ReferenceType// (restriction)
4139 [[image:inherit.gif||height="9" width="9"]] //MaintainableReferenceBaseType// (restriction)
4140 [[image:inherit.gif||height="9" width="9"]] ConstraintReferenceType (restriction)
4141 [[image:inherit.gif||height="9" width="9"]] ContentConstraintReferenceType
4142
4143 Content:
4144
4145 ( (Ref, URN?) | URN)
4146
4147 Element Documentation:
4148
4149 |**Name**|**Type**|**Documentation**
4150 |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.
4151 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4152 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4153
4154 **ContentConstraintRefType: **ContentConstraintRefType contains a set of reference fields for a content constraint.
4155
4156 Derivation:
4157
4158 //RefBaseType// (restriction)
4159 [[image:inherit.gif||height="9" width="9"]] //MaintainableRefBaseType// (restriction)
4160 [[image:inherit.gif||height="9" width="9"]] //ConstraintRefType// (restriction)
4161 [[image:inherit.gif||height="9" width="9"]] ContentConstraintRefType
4162
4163 Attributes:
4164
4165 agencyID, id, version?, local?, class?, package?
4166
4167 Content:
4168
4169 {Empty}
4170
4171 Attribute Documentation:
4172
4173 |**Name**|**Type**|**Documentation**
4174 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
4175 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
4176 |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.
4177 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
4178 |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.
4179 |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.
4180
4181 **DataflowReferenceType: **DataflowReferenceType is a type for referencing a dataflow object. It consists of a URN and/or a complete set of reference fields.
4182
4183 Derivation:
4184
4185 //ReferenceType// (restriction)
4186 [[image:inherit.gif||height="9" width="9"]] //MaintainableReferenceBaseType// (restriction)
4187 [[image:inherit.gif||height="9" width="9"]] //StructureUsageReferenceBaseType// (restriction)
4188 [[image:inherit.gif||height="9" width="9"]] DataflowReferenceType
4189
4190 Content:
4191
4192 ( (Ref, URN?) | URN)
4193
4194 Element Documentation:
4195
4196 |**Name**|**Type**|**Documentation**
4197 |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.
4198 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4199 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4200
4201 **DataflowRefType: **DataflowRefType contains a set of reference fields for a data flow.
4202
4203 Derivation:
4204
4205 //RefBaseType// (restriction)
4206 [[image:inherit.gif||height="9" width="9"]] //MaintainableRefBaseType// (restriction)
4207 [[image:inherit.gif||height="9" width="9"]] //StructureOrUsageRefBaseType// (restriction)
4208 [[image:inherit.gif||height="9" width="9"]] //StructureUsageRefBaseType// (restriction)
4209 [[image:inherit.gif||height="9" width="9"]] DataflowRefType
4210
4211 Attributes:
4212
4213 agencyID, id, version?, local?, class?, package?
4214
4215 Content:
4216
4217 {Empty}
4218
4219 Attribute Documentation:
4220
4221 |**Name**|**Type**|**Documentation**
4222 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
4223 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
4224 |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.
4225 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
4226 |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.
4227 |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.
4228
4229 **MetadataflowReferenceType: **MetadataflowReferenceType is a type for referencing a metadata flow object. It consists of a URN and/or a complete set of reference fields.
4230
4231 Derivation:
4232
4233 //ReferenceType// (restriction)
4234 [[image:inherit.gif||height="9" width="9"]] //MaintainableReferenceBaseType// (restriction)
4235 [[image:inherit.gif||height="9" width="9"]] //StructureUsageReferenceBaseType// (restriction)
4236 [[image:inherit.gif||height="9" width="9"]] MetadataflowReferenceType
4237
4238 Content:
4239
4240 ( (Ref, URN?) | URN)
4241
4242 Element Documentation:
4243
4244 |**Name**|**Type**|**Documentation**
4245 |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.
4246 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4247 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4248
4249 **MetadataflowRefType: **MetadataflowRefType contains a set of reference fields for a metadata flow.
4250
4251 Derivation:
4252
4253 //RefBaseType// (restriction)
4254 [[image:inherit.gif||height="9" width="9"]] //MaintainableRefBaseType// (restriction)
4255 [[image:inherit.gif||height="9" width="9"]] //StructureOrUsageRefBaseType// (restriction)
4256 [[image:inherit.gif||height="9" width="9"]] //StructureUsageRefBaseType// (restriction)
4257 [[image:inherit.gif||height="9" width="9"]] MetadataflowRefType
4258
4259 Attributes:
4260
4261 agencyID, id, version?, local?, class?, package?
4262
4263 Content:
4264
4265 {Empty}
4266
4267 Attribute Documentation:
4268
4269 |**Name**|**Type**|**Documentation**
4270 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
4271 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
4272 |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.
4273 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
4274 |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.
4275 |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.
4276
4277 **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.
4278
4279 Derivation:
4280
4281 //ReferenceType// (restriction)
4282 [[image:inherit.gif||height="9" width="9"]] //MaintainableReferenceBaseType// (restriction)
4283 [[image:inherit.gif||height="9" width="9"]] //StructureReferenceBaseType// (restriction)
4284 [[image:inherit.gif||height="9" width="9"]] DataStructureReferenceType
4285
4286 Content:
4287
4288 ( (Ref, URN?) | URN)
4289
4290 Element Documentation:
4291
4292 |**Name**|**Type**|**Documentation**
4293 |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.
4294 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
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
4297 **DataStructureRefType: **DataStructureRefType contains a set of reference fields for a data structure definition.
4298
4299 Derivation:
4300
4301 //RefBaseType// (restriction)
4302 [[image:inherit.gif||height="9" width="9"]] //MaintainableRefBaseType// (restriction)
4303 [[image:inherit.gif||height="9" width="9"]] //StructureOrUsageRefBaseType// (restriction)
4304 [[image:inherit.gif||height="9" width="9"]] //StructureRefBaseType// (restriction)
4305 [[image:inherit.gif||height="9" width="9"]] DataStructureRefType
4306
4307 Attributes:
4308
4309 agencyID, id, version?, local?, class?, package?
4310
4311 Content:
4312
4313 {Empty}
4314
4315 Attribute Documentation:
4316
4317 |**Name**|**Type**|**Documentation**
4318 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
4319 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
4320 |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.
4321 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
4322 |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.
4323 |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.
4324
4325 **KeyDescriptorReferenceType: **KeyDescriptorReferenceType is a type for referencing a key descriptor object. It consists of a URN and/or a complete set of reference fields.
4326
4327 Derivation:
4328
4329 //ReferenceType// (restriction)
4330 [[image:inherit.gif||height="9" width="9"]] //ChildObjectReferenceType// (restriction)
4331 [[image:inherit.gif||height="9" width="9"]] //ComponentListReferenceType// (restriction)
4332 [[image:inherit.gif||height="9" width="9"]] KeyDescriptorReferenceType
4333
4334 Content:
4335
4336 ( (Ref, URN?) | URN)
4337
4338 Element Documentation:
4339
4340 |**Name**|**Type**|**Documentation**
4341 |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.
4342 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4343 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4344
4345 **KeyDescriptorRefType: **KeyDescriptorRefType contains a reference to the key descriptor within a data structure definition.
4346
4347 Derivation:
4348
4349 //RefBaseType// (restriction)
4350 [[image:inherit.gif||height="9" width="9"]] //ChildObjectRefBaseType// (restriction)
4351 [[image:inherit.gif||height="9" width="9"]] //ComponentListRefBaseType// (restriction)
4352 [[image:inherit.gif||height="9" width="9"]] KeyDescriptorRefType
4353
4354 Attributes:
4355
4356 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
4357
4358 Content:
4359
4360 {Empty}
4361
4362 Attribute Documentation:
4363
4364 |**Name**|**Type**|**Documentation**
4365 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
4366 |maintainableParentID|IDType|The maintainableParentID references the structure in which the component list being referenced is defined.
4367 |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.
4368 |id (fixed: DIMENSION_DESCRIPTOR)|IDType|The id attribute identifies the object being referenced, and is therefore always required.
4369 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
4370 |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.
4371 |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.
4372
4373 **AttributeDescriptorReferenceType: **AttributeDescriptorReferenceType is a type for referencing an attribute descriptor object. It consists of a URN and/or a complete set of reference fields.
4374
4375 Derivation:
4376
4377 //ReferenceType// (restriction)
4378 [[image:inherit.gif||height="9" width="9"]] //ChildObjectReferenceType// (restriction)
4379 [[image:inherit.gif||height="9" width="9"]] //ComponentListReferenceType// (restriction)
4380 [[image:inherit.gif||height="9" width="9"]] AttributeDescriptorReferenceType
4381
4382 Content:
4383
4384 ( (Ref, URN?) | URN)
4385
4386 Element Documentation:
4387
4388 |**Name**|**Type**|**Documentation**
4389 |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.
4390 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4391 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4392
4393 **AttributeDescriptorRefType: **AttributeDescriptorRefType contains a reference to the attribute descriptor within a data structure definition.
4394
4395 Derivation:
4396
4397 //RefBaseType// (restriction)
4398 [[image:inherit.gif||height="9" width="9"]] //ChildObjectRefBaseType// (restriction)
4399 [[image:inherit.gif||height="9" width="9"]] //ComponentListRefBaseType// (restriction)
4400 [[image:inherit.gif||height="9" width="9"]] AttributeDescriptorRefType
4401
4402 Attributes:
4403
4404 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
4405
4406 Content:
4407
4408 {Empty}
4409
4410 Attribute Documentation:
4411
4412 |**Name**|**Type**|**Documentation**
4413 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
4414 |maintainableParentID|IDType|The maintainableParentID references the structure in which the component list being referenced is defined.
4415 |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.
4416 |id (fixed: ATTRIBUTE_DESCRIPTOR)|IDType|The id attribute identifies the object being referenced, and is therefore always required.
4417 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
4418 |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.
4419 |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.
4420
4421 **MeasureDescriptorReferenceType: **MeasureDescriptorReferenceType is a type for referencing a measure descriptor object. It consists of a URN and/or a complete set of reference fields.
4422
4423 Derivation:
4424
4425 //ReferenceType// (restriction)
4426 [[image:inherit.gif||height="9" width="9"]] //ChildObjectReferenceType// (restriction)
4427 [[image:inherit.gif||height="9" width="9"]] //ComponentListReferenceType// (restriction)
4428 [[image:inherit.gif||height="9" width="9"]] MeasureDescriptorReferenceType
4429
4430 Content:
4431
4432 ( (Ref, URN?) | URN)
4433
4434 Element Documentation:
4435
4436 |**Name**|**Type**|**Documentation**
4437 |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.
4438 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4439 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4440
4441 **MeasureDescriptorRefType: **MeasureDescriptorRefType contains a reference to the measure descriptor within a data structure definition.
4442
4443 Derivation:
4444
4445 //RefBaseType// (restriction)
4446 [[image:inherit.gif||height="9" width="9"]] //ChildObjectRefBaseType// (restriction)
4447 [[image:inherit.gif||height="9" width="9"]] //ComponentListRefBaseType// (restriction)
4448 [[image:inherit.gif||height="9" width="9"]] MeasureDescriptorRefType
4449
4450 Attributes:
4451
4452 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
4453
4454 Content:
4455
4456 {Empty}
4457
4458 Attribute Documentation:
4459
4460 |**Name**|**Type**|**Documentation**
4461 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
4462 |maintainableParentID|IDType|The maintainableParentID references the structure in which the component list being referenced is defined.
4463 |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.
4464 |id (fixed: MEASURE_DESCRIPTOR)|IDType|The id attribute identifies the object being referenced, and is therefore always required.
4465 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
4466 |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.
4467 |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.
4468
4469 **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.
4470
4471 Derivation:
4472
4473 //ReferenceType// (restriction)
4474 [[image:inherit.gif||height="9" width="9"]] //ChildObjectReferenceType// (restriction)
4475 [[image:inherit.gif||height="9" width="9"]] //ComponentListReferenceType// (restriction)
4476 [[image:inherit.gif||height="9" width="9"]] GroupKeyDescriptorReferenceType
4477
4478 Content:
4479
4480 ( (Ref, URN?) | URN)
4481
4482 Element Documentation:
4483
4484 |**Name**|**Type**|**Documentation**
4485 |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.
4486 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4487 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4488
4489 **GroupKeyDescriptorRefType: **GroupKeyDescriptorRefType contains a reference to a group key descriptor within a data structure definition.
4490
4491 Derivation:
4492
4493 //RefBaseType// (restriction)
4494 [[image:inherit.gif||height="9" width="9"]] //ChildObjectRefBaseType// (restriction)
4495 [[image:inherit.gif||height="9" width="9"]] //ComponentListRefBaseType// (restriction)
4496 [[image:inherit.gif||height="9" width="9"]] GroupKeyDescriptorRefType
4497
4498 Attributes:
4499
4500 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
4501
4502 Content:
4503
4504 {Empty}
4505
4506 Attribute Documentation:
4507
4508 |**Name**|**Type**|**Documentation**
4509 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
4510 |maintainableParentID|IDType|The maintainableParentID references the structure in which the component list being referenced is defined.
4511 |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.
4512 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
4513 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
4514 |class (fixed: 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.
4515 |package (fixed: datastructure)|StructurePackageType CodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
4516
4517 **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).
4518
4519 Derivation:
4520
4521 //ReferenceType// (restriction)
4522 [[image:inherit.gif||height="9" width="9"]] //LocalComponentListReferenceType// (restriction)
4523 [[image:inherit.gif||height="9" width="9"]] LocalGroupKeyDescriptorReferenceType
4524
4525 Content:
4526
4527 Ref
4528
4529 Element Documentation:
4530
4531 |**Name**|**Type**|**Documentation**
4532 |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.
4533
4534 **LocalGroupKeyDescriptorRefType: **LocalGroupKeyDescriptorRefType contains a local reference to a group key descriptor.
4535
4536 Derivation:
4537
4538 //RefBaseType// (restriction)
4539 [[image:inherit.gif||height="9" width="9"]] //LocalIdentifiableRefBaseType// (restriction)
4540 [[image:inherit.gif||height="9" width="9"]] //LocalComponentListRefBaseType// (restriction)
4541 [[image:inherit.gif||height="9" width="9"]] LocalGroupKeyDescriptorRefType
4542
4543 Attributes:
4544
4545 id, local?, class?, package?
4546
4547 Content:
4548
4549 {Empty}
4550
4551 Attribute Documentation:
4552
4553 |**Name**|**Type**|**Documentation**
4554 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
4555 |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.
4556 |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.
4557 |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.
4558
4559 **DimensionReferenceType: **DimensionReferenceType is a type for referencing a dimension object. It consists of a URN and/or a complete set of reference fields.
4560
4561 Derivation:
4562
4563 //ReferenceType// (restriction)
4564 [[image:inherit.gif||height="9" width="9"]] //ContainerChildObjectReferenceType// (restriction)
4565 [[image:inherit.gif||height="9" width="9"]] //ComponentReferenceType// (restriction)
4566 [[image:inherit.gif||height="9" width="9"]] DimensionReferenceType
4567
4568 Content:
4569
4570 ( (Ref, URN?) | URN)
4571
4572 Element Documentation:
4573
4574 |**Name**|**Type**|**Documentation**
4575 |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.
4576 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4577 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4578
4579 **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.
4580
4581 Derivation:
4582
4583 //RefBaseType// (restriction)
4584 [[image:inherit.gif||height="9" width="9"]] //ContainerChildObjectRefBaseType// (restriction)
4585 [[image:inherit.gif||height="9" width="9"]] //ComponentRefBaseType// (restriction)
4586 [[image:inherit.gif||height="9" width="9"]] DimensionRefType
4587
4588 Attributes:
4589
4590 agencyID, maintainableParentID, maintainableParentVersion?, id, version?, local?, class?, package?
4591
4592 Content:
4593
4594 {Empty}
4595
4596 Attribute Documentation:
4597
4598 |**Name**|**Type**|**Documentation**
4599 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
4600 |maintainableParentID|IDType|The maintainableParentID references the structure in which the component being referenced is defined.
4601 |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.
4602 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
4603 |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.
4604 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
4605 |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.
4606 |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.
4607
4608 **MeasureDimensionReferenceType: **MeasureDimensionReferenceType is a type for referencing a measure dimension object. It consists of a URN and/or a complete set of reference fields.
4609
4610 Derivation:
4611
4612 //ReferenceType// (restriction)
4613 [[image:inherit.gif||height="9" width="9"]] //ContainerChildObjectReferenceType// (restriction)
4614 [[image:inherit.gif||height="9" width="9"]] //ComponentReferenceType// (restriction)
4615 [[image:inherit.gif||height="9" width="9"]] MeasureDimensionReferenceType
4616
4617 Content:
4618
4619 ( (Ref, URN?) | URN)
4620
4621 Element Documentation:
4622
4623 |**Name**|**Type**|**Documentation**
4624 |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.
4625 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4626 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4627
4628 **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.
4629
4630 Derivation:
4631
4632 //RefBaseType// (restriction)
4633 [[image:inherit.gif||height="9" width="9"]] //ContainerChildObjectRefBaseType// (restriction)
4634 [[image:inherit.gif||height="9" width="9"]] //ComponentRefBaseType// (restriction)
4635 [[image:inherit.gif||height="9" width="9"]] MeasureDimensionRefType
4636
4637 Attributes:
4638
4639 agencyID, maintainableParentID, maintainableParentVersion?, id, version?, local?, class?, package?
4640
4641 Content:
4642
4643 {Empty}
4644
4645 Attribute Documentation:
4646
4647 |**Name**|**Type**|**Documentation**
4648 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
4649 |maintainableParentID|IDType|The maintainableParentID references the structure in which the component being referenced is defined.
4650 |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.
4651 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
4652 |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.
4653 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
4654 |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.
4655 |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.
4656
4657 **TimeDimensionReferenceType: **TimeDimensionReferenceType is a type for referencing a time dimension object. It consists of a URN and/or a complete set of reference fields.
4658
4659 Derivation:
4660
4661 //ReferenceType// (restriction)
4662 [[image:inherit.gif||height="9" width="9"]] //ContainerChildObjectReferenceType// (restriction)
4663 [[image:inherit.gif||height="9" width="9"]] //ComponentReferenceType// (restriction)
4664 [[image:inherit.gif||height="9" width="9"]] TimeDimensionReferenceType
4665
4666 Content:
4667
4668 ( (Ref, URN?) | URN)
4669
4670 Element Documentation:
4671
4672 |**Name**|**Type**|**Documentation**
4673 |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.
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 **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.
4678
4679 Derivation:
4680
4681 //RefBaseType// (restriction)
4682 [[image:inherit.gif||height="9" width="9"]] //ContainerChildObjectRefBaseType// (restriction)
4683 [[image:inherit.gif||height="9" width="9"]] //ComponentRefBaseType// (restriction)
4684 [[image:inherit.gif||height="9" width="9"]] TimeDimensionRefType
4685
4686 Attributes:
4687
4688 agencyID, maintainableParentID, maintainableParentVersion?, id, version?, local?, class?, package?
4689
4690 Content:
4691
4692 {Empty}
4693
4694 Attribute Documentation:
4695
4696 |**Name**|**Type**|**Documentation**
4697 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
4698 |maintainableParentID|IDType|The maintainableParentID references the structure in which the component being referenced is defined.
4699 |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.
4700 |id (fixed: TIME_PERIOD)|IDType|The id attribute identifies the object being referenced, and is therefore always required.
4701 |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.
4702 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
4703 |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.
4704 |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.
4705
4706 **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).
4707
4708 Derivation:
4709
4710 //ReferenceType// (restriction)
4711 [[image:inherit.gif||height="9" width="9"]] //LocalComponentListComponentReferenceBaseType// (restriction)
4712 [[image:inherit.gif||height="9" width="9"]] //LocalComponentReferenceBaseType// (restriction)
4713 [[image:inherit.gif||height="9" width="9"]] LocalDimensionReferenceType
4714
4715 Content:
4716
4717 Ref
4718
4719 Element Documentation:
4720
4721 |**Name**|**Type**|**Documentation**
4722 |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.
4723
4724 **LocalDimensionRefType: **LocalDimensionRefType contains the reference fields for referencing a dimension locally.
4725
4726 Derivation:
4727
4728 //RefBaseType// (restriction)
4729 [[image:inherit.gif||height="9" width="9"]] //LocalIdentifiableRefBaseType// (restriction)
4730 [[image:inherit.gif||height="9" width="9"]] //LocalComponentListComponentRefBaseType// (restriction)
4731 [[image:inherit.gif||height="9" width="9"]] //LocalComponentRefBaseType// (restriction)
4732 [[image:inherit.gif||height="9" width="9"]] LocalDimensionRefType
4733
4734 Attributes:
4735
4736 id, local?, class?, package?
4737
4738 Content:
4739
4740 {Empty}
4741
4742 Attribute Documentation:
4743
4744 |**Name**|**Type**|**Documentation**
4745 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
4746 |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.
4747 |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.
4748 |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.
4749
4750 **AttributeReferenceType: **AttributeReferenceType is a type for referencing an attribute object. It consists of a URN and/or a complete set of reference fields.
4751
4752 Derivation:
4753
4754 //ReferenceType// (restriction)
4755 [[image:inherit.gif||height="9" width="9"]] //ContainerChildObjectReferenceType// (restriction)
4756 [[image:inherit.gif||height="9" width="9"]] //ComponentReferenceType// (restriction)
4757 [[image:inherit.gif||height="9" width="9"]] AttributeReferenceType
4758
4759 Content:
4760
4761 ( (Ref, URN?) | URN)
4762
4763 Element Documentation:
4764
4765 |**Name**|**Type**|**Documentation**
4766 |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.
4767 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4768 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4769
4770 **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.
4771
4772 Derivation:
4773
4774 //RefBaseType// (restriction)
4775 [[image:inherit.gif||height="9" width="9"]] //ContainerChildObjectRefBaseType// (restriction)
4776 [[image:inherit.gif||height="9" width="9"]] //ComponentRefBaseType// (restriction)
4777 [[image:inherit.gif||height="9" width="9"]] AttributeRefType
4778
4779 Attributes:
4780
4781 agencyID, maintainableParentID, maintainableParentVersion?, id, version?, local?, class?, package?
4782
4783 Content:
4784
4785 {Empty}
4786
4787 Attribute Documentation:
4788
4789 |**Name**|**Type**|**Documentation**
4790 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
4791 |maintainableParentID|IDType|The maintainableParentID references the structure in which the component being referenced is defined.
4792 |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.
4793 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
4794 |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.
4795 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
4796 |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.
4797 |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.
4798
4799 **PrimaryMeasureReferenceType: **PrimaryMeasureReferenceType is a type for referencing a primary measure object. It consists of a URN and/or a complete set of reference fields.
4800
4801 Derivation:
4802
4803 //ReferenceType// (restriction)
4804 [[image:inherit.gif||height="9" width="9"]] //ContainerChildObjectReferenceType// (restriction)
4805 [[image:inherit.gif||height="9" width="9"]] //ComponentReferenceType// (restriction)
4806 [[image:inherit.gif||height="9" width="9"]] PrimaryMeasureReferenceType
4807
4808 Content:
4809
4810 ( (Ref, URN?) | URN)
4811
4812 Element Documentation:
4813
4814 |**Name**|**Type**|**Documentation**
4815 |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.
4816 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4817 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4818
4819 **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.
4820
4821 Derivation:
4822
4823 //RefBaseType// (restriction)
4824 [[image:inherit.gif||height="9" width="9"]] //ContainerChildObjectRefBaseType// (restriction)
4825 [[image:inherit.gif||height="9" width="9"]] //ComponentRefBaseType// (restriction)
4826 [[image:inherit.gif||height="9" width="9"]] PrimaryMeasureRefType
4827
4828 Attributes:
4829
4830 agencyID, maintainableParentID, maintainableParentVersion?, id, version?, local?, class?, package?
4831
4832 Content:
4833
4834 {Empty}
4835
4836 Attribute Documentation:
4837
4838 |**Name**|**Type**|**Documentation**
4839 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
4840 |maintainableParentID|IDType|The maintainableParentID references the structure in which the component being referenced is defined.
4841 |maintainableParentVersion (default: 1.0)|VersionType|The maintainableParentVersion attribute references the version of the structure in which the component being referenced is defined. If not supplied, a default value of 1.0 is assumed.
4842 |id (fixed: OBS_VALUE)|IDType|The id attribute identifies the object being referenced, and is therefore always required.
4843 |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.
4844 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
4845 |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.
4846 |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.
4847
4848 **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).
4849
4850 Derivation:
4851
4852 //ReferenceType// (restriction)
4853 [[image:inherit.gif||height="9" width="9"]] //LocalComponentListComponentReferenceBaseType// (restriction)
4854 [[image:inherit.gif||height="9" width="9"]] //LocalComponentReferenceBaseType// (restriction)
4855 [[image:inherit.gif||height="9" width="9"]] LocalPrimaryMeasureReferenceType
4856
4857 Content:
4858
4859 Ref
4860
4861 Element Documentation:
4862
4863 |**Name**|**Type**|**Documentation**
4864 |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.
4865
4866 **LocalPrimaryMeasureRefType: **LocalPrimaryMeasureRefType contains the reference fields for referencing a primary measure locally.
4867
4868 Derivation:
4869
4870 //RefBaseType// (restriction)
4871 [[image:inherit.gif||height="9" width="9"]] //LocalIdentifiableRefBaseType// (restriction)
4872 [[image:inherit.gif||height="9" width="9"]] //LocalComponentListComponentRefBaseType// (restriction)
4873 [[image:inherit.gif||height="9" width="9"]] //LocalComponentRefBaseType// (restriction)
4874 [[image:inherit.gif||height="9" width="9"]] LocalPrimaryMeasureRefType
4875
4876 Attributes:
4877
4878 id, local?, class?, package?
4879
4880 Content:
4881
4882 {Empty}
4883
4884 Attribute Documentation:
4885
4886 |**Name**|**Type**|**Documentation**
4887 |id (fixed: OBS_VALUE)|IDType|The id attribute identifies the object being referenced, and is therefore always required.
4888 |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.
4889 |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.
4890 |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.
4891
4892 **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.
4893
4894 Derivation:
4895
4896 //ReferenceType// (restriction)
4897 [[image:inherit.gif||height="9" width="9"]] //LocalComponentListComponentReferenceBaseType// (restriction)
4898 [[image:inherit.gif||height="9" width="9"]] LocalDataStructureComponentReferenceType
4899
4900 Content:
4901
4902 Ref
4903
4904 Element Documentation:
4905
4906 |**Name**|**Type**|**Documentation**
4907 |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.
4908
4909 **LocalDataStructureComponentRefType: **LocalDataStructureComponentRefType contains the reference fields for referencing any data structure component locally. This reference must specify the class of the component being referenced.
4910
4911 Derivation:
4912
4913 //RefBaseType// (restriction)
4914 [[image:inherit.gif||height="9" width="9"]] //LocalIdentifiableRefBaseType// (restriction)
4915 [[image:inherit.gif||height="9" width="9"]] //LocalComponentListComponentRefBaseType// (restriction)
4916 [[image:inherit.gif||height="9" width="9"]] LocalDataStructureComponentRefType
4917
4918 Attributes:
4919
4920 id, local?, class, package?
4921
4922 Content:
4923
4924 {Empty}
4925
4926 Attribute Documentation:
4927
4928 |**Name**|**Type**|**Documentation**
4929 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
4930 |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.
4931 |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.
4932 |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.
4933
4934 **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.
4935
4936 Derivation:
4937
4938 //ReferenceType// (restriction)
4939 [[image:inherit.gif||height="9" width="9"]] //MaintainableReferenceBaseType// (restriction)
4940 [[image:inherit.gif||height="9" width="9"]] //ItemSchemeReferenceBaseType// (restriction)
4941 [[image:inherit.gif||height="9" width="9"]] ItemSchemeReferenceType (restriction)
4942 [[image:inherit.gif||height="9" width="9"]] DataStructureEnumerationSchemeReferenceType
4943
4944 Content:
4945
4946 ( (Ref, URN?) | URN)
4947
4948 Element Documentation:
4949
4950 |**Name**|**Type**|**Documentation**
4951 |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.
4952 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4953 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4954
4955 **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.
4956
4957 Derivation:
4958
4959 //RefBaseType// (restriction)
4960 [[image:inherit.gif||height="9" width="9"]] //MaintainableRefBaseType// (restriction)
4961 [[image:inherit.gif||height="9" width="9"]] //ItemSchemeRefBaseType// (restriction)
4962 [[image:inherit.gif||height="9" width="9"]] ItemSchemeRefType (restriction)
4963 [[image:inherit.gif||height="9" width="9"]] DataStructureEnumerationSchemeRefType
4964
4965 Attributes:
4966
4967 agencyID, id, version?, local?, class, package
4968
4969 Content:
4970
4971 {Empty}
4972
4973 Attribute Documentation:
4974
4975 |**Name**|**Type**|**Documentation**
4976 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
4977 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
4978 |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.
4979 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
4980 |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.
4981 |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.
4982
4983 **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.
4984
4985 Derivation:
4986
4987 //ReferenceType// (restriction)
4988 [[image:inherit.gif||height="9" width="9"]] //MaintainableReferenceBaseType// (restriction)
4989 [[image:inherit.gif||height="9" width="9"]] //StructureReferenceBaseType// (restriction)
4990 [[image:inherit.gif||height="9" width="9"]] MetadataStructureReferenceType
4991
4992 Content:
4993
4994 ( (Ref, URN?) | URN)
4995
4996 Element Documentation:
4997
4998 |**Name**|**Type**|**Documentation**
4999 |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.
5000 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5001 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5002
5003 **MetadataStructureRefType: **MetadataStructureRefType contains a set of reference fields for a metadata structure definition.
5004
5005 Derivation:
5006
5007 //RefBaseType// (restriction)
5008 [[image:inherit.gif||height="9" width="9"]] //MaintainableRefBaseType// (restriction)
5009 [[image:inherit.gif||height="9" width="9"]] //StructureOrUsageRefBaseType// (restriction)
5010 [[image:inherit.gif||height="9" width="9"]] //StructureRefBaseType// (restriction)
5011 [[image:inherit.gif||height="9" width="9"]] MetadataStructureRefType
5012
5013 Attributes:
5014
5015 agencyID, id, version?, local?, class?, package?
5016
5017 Content:
5018
5019 {Empty}
5020
5021 Attribute Documentation:
5022
5023 |**Name**|**Type**|**Documentation**
5024 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
5025 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
5026 |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.
5027 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
5028 |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.
5029 |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.
5030
5031 **MetadataTargetReferenceType: **MetadataTargetReferenceType is a type for referencing a metadata target object. It consists of a URN and/or a complete set of reference fields.
5032
5033 Derivation:
5034
5035 //ReferenceType// (restriction)
5036 [[image:inherit.gif||height="9" width="9"]] //ChildObjectReferenceType// (restriction)
5037 [[image:inherit.gif||height="9" width="9"]] //ComponentListReferenceType// (restriction)
5038 [[image:inherit.gif||height="9" width="9"]] MetadataTargetReferenceType
5039
5040 Content:
5041
5042 ( (Ref, URN?) | URN)
5043
5044 Element Documentation:
5045
5046 |**Name**|**Type**|**Documentation**
5047 |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.
5048 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5049 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5050
5051 **MetadataTargetRefType: **MetadataTargetRefType contains a reference to a metadata target within a metadata structure definition.
5052
5053 Derivation:
5054
5055 //RefBaseType// (restriction)
5056 [[image:inherit.gif||height="9" width="9"]] //ChildObjectRefBaseType// (restriction)
5057 [[image:inherit.gif||height="9" width="9"]] //ComponentListRefBaseType// (restriction)
5058 [[image:inherit.gif||height="9" width="9"]] MetadataTargetRefType
5059
5060 Attributes:
5061
5062 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
5063
5064 Content:
5065
5066 {Empty}
5067
5068 Attribute Documentation:
5069
5070 |**Name**|**Type**|**Documentation**
5071 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
5072 |maintainableParentID|IDType|The maintainableParentID references the structure in which the component list being referenced is defined.
5073 |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.
5074 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
5075 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
5076 |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.
5077 |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.
5078
5079 **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).
5080
5081 Derivation:
5082
5083 //ReferenceType// (restriction)
5084 [[image:inherit.gif||height="9" width="9"]] //LocalComponentListReferenceType// (restriction)
5085 [[image:inherit.gif||height="9" width="9"]] LocalMetadataTargetReferenceType
5086
5087 Content:
5088
5089 Ref
5090
5091 Element Documentation:
5092
5093 |**Name**|**Type**|**Documentation**
5094 |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.
5095
5096 **LocalMetadataTargetRefType: **LocalMetadataTargetRefType contains a local reference to a metadata target object.
5097
5098 Derivation:
5099
5100 //RefBaseType// (restriction)
5101 [[image:inherit.gif||height="9" width="9"]] //LocalIdentifiableRefBaseType// (restriction)
5102 [[image:inherit.gif||height="9" width="9"]] //LocalComponentListRefBaseType// (restriction)
5103 [[image:inherit.gif||height="9" width="9"]] LocalMetadataTargetRefType
5104
5105 Attributes:
5106
5107 id, local?, class?, package?
5108
5109 Content:
5110
5111 {Empty}
5112
5113 Attribute Documentation:
5114
5115 |**Name**|**Type**|**Documentation**
5116 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
5117 |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.
5118 |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.
5119 |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.
5120
5121 **ConstraintTargetReferenceType: **ConstraintTargetReferenceType is a type for referencing a constraint target object. It consists of a URN and/or a complete set of reference fields.
5122
5123 Derivation:
5124
5125 //ReferenceType// (restriction)
5126 [[image:inherit.gif||height="9" width="9"]] //ContainerChildObjectReferenceType// (restriction)
5127 [[image:inherit.gif||height="9" width="9"]] //ComponentReferenceType// (restriction)
5128 [[image:inherit.gif||height="9" width="9"]] ConstraintTargetReferenceType
5129
5130 Content:
5131
5132 ( (Ref, URN?) | URN)
5133
5134 Element Documentation:
5135
5136 |**Name**|**Type**|**Documentation**
5137 |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.
5138 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5139 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5140
5141 **ConstraintTargetRefType: **ConstraintTargetRefType contains a reference to a constraint target within a metadata target of a data structure definition.
5142
5143 Derivation:
5144
5145 //RefBaseType// (restriction)
5146 [[image:inherit.gif||height="9" width="9"]] //ContainerChildObjectRefBaseType// (restriction)
5147 [[image:inherit.gif||height="9" width="9"]] //ComponentRefBaseType// (restriction)
5148 [[image:inherit.gif||height="9" width="9"]] ConstraintTargetRefType
5149
5150 Attributes:
5151
5152 agencyID, maintainableParentID, maintainableParentVersion?, containerID, id, version?, local?, class?, package?
5153
5154 Content:
5155
5156 {Empty}
5157
5158 Attribute Documentation:
5159
5160 |**Name**|**Type**|**Documentation**
5161 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
5162 |maintainableParentID|IDType|The maintainableParentID references the structure in which the component being referenced is defined.
5163 |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.
5164 |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.
5165 |id (fixed: CONSTRAINT_TARGET)|IDType|The id attribute identifies the object being referenced, and is therefore always required.
5166 |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.
5167 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
5168 |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.
5169 |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.
5170
5171 **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.
5172
5173 Derivation:
5174
5175 //ReferenceType// (restriction)
5176 [[image:inherit.gif||height="9" width="9"]] //ContainerChildObjectReferenceType// (restriction)
5177 [[image:inherit.gif||height="9" width="9"]] //ComponentReferenceType// (restriction)
5178 [[image:inherit.gif||height="9" width="9"]] DataSetTargetReferenceType
5179
5180 Content:
5181
5182 ( (Ref, URN?) | URN)
5183
5184 Element Documentation:
5185
5186 |**Name**|**Type**|**Documentation**
5187 |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.
5188 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5189 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5190
5191 **DataSetTargetRefType: **DataSetTargetRefType contains a reference to a data set target within a metadata target of a data structure definition.
5192
5193 Derivation:
5194
5195 //RefBaseType// (restriction)
5196 [[image:inherit.gif||height="9" width="9"]] //ContainerChildObjectRefBaseType// (restriction)
5197 [[image:inherit.gif||height="9" width="9"]] //ComponentRefBaseType// (restriction)
5198 [[image:inherit.gif||height="9" width="9"]] DataSetTargetRefType
5199
5200 Attributes:
5201
5202 agencyID, maintainableParentID, maintainableParentVersion?, containerID, id, version?, local?, class?, package?
5203
5204 Content:
5205
5206 {Empty}
5207
5208 Attribute Documentation:
5209
5210 |**Name**|**Type**|**Documentation**
5211 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
5212 |maintainableParentID|IDType|The maintainableParentID references the structure in which the component being referenced is defined.
5213 |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.
5214 |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.
5215 |id (fixed: DATA_SET_TARGET)|IDType|The id attribute identifies the object being referenced, and is therefore always required.
5216 |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.
5217 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
5218 |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.
5219 |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.
5220
5221 **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.
5222
5223 Derivation:
5224
5225 //ReferenceType// (restriction)
5226 [[image:inherit.gif||height="9" width="9"]] //ContainerChildObjectReferenceType// (restriction)
5227 [[image:inherit.gif||height="9" width="9"]] //ComponentReferenceType// (restriction)
5228 [[image:inherit.gif||height="9" width="9"]] KeyDescriptorValuesTargetReferenceType
5229
5230 Content:
5231
5232 ( (Ref, URN?) | URN)
5233
5234 Element Documentation:
5235
5236 |**Name**|**Type**|**Documentation**
5237 |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.
5238 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5239 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5240
5241 **KeyDescriptorValuesTargetRefType: **KeyDescriptorValuesTargetRefType contains a reference to a key descriptor values target within a metadata target of a data structure definition.
5242
5243 Derivation:
5244
5245 //RefBaseType// (restriction)
5246 [[image:inherit.gif||height="9" width="9"]] //ContainerChildObjectRefBaseType// (restriction)
5247 [[image:inherit.gif||height="9" width="9"]] //ComponentRefBaseType// (restriction)
5248 [[image:inherit.gif||height="9" width="9"]] KeyDescriptorValuesTargetRefType
5249
5250 Attributes:
5251
5252 agencyID, maintainableParentID, maintainableParentVersion?, containerID, id, version?, local?, class?, package?
5253
5254 Content:
5255
5256 {Empty}
5257
5258 Attribute Documentation:
5259
5260 |**Name**|**Type**|**Documentation**
5261 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
5262 |maintainableParentID|IDType|The maintainableParentID references the structure in which the component being referenced is defined.
5263 |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.
5264 |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.
5265 |id (fixed: DIMENSION_DESCRIPTOR_VALUES_TARGET)|IDType|The id attribute identifies the object being referenced, and is therefore always required.
5266 |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.
5267 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
5268 |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.
5269 |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.
5270
5271 **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.
5272
5273 Derivation:
5274
5275 //ReferenceType// (restriction)
5276 [[image:inherit.gif||height="9" width="9"]] //ContainerChildObjectReferenceType// (restriction)
5277 [[image:inherit.gif||height="9" width="9"]] //ComponentReferenceType// (restriction)
5278 [[image:inherit.gif||height="9" width="9"]] ReportPeriodTargetReferenceType
5279
5280 Content:
5281
5282 ( (Ref, URN?) | URN)
5283
5284 Element Documentation:
5285
5286 |**Name**|**Type**|**Documentation**
5287 |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.
5288 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5289 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5290
5291 **ReportPeriodTargetRefType: **ReportPeriodTargetRefType contains a reference to a report period target within a metadata target of a data structure definition.
5292
5293 Derivation:
5294
5295 //RefBaseType// (restriction)
5296 [[image:inherit.gif||height="9" width="9"]] //ContainerChildObjectRefBaseType// (restriction)
5297 [[image:inherit.gif||height="9" width="9"]] //ComponentRefBaseType// (restriction)
5298 [[image:inherit.gif||height="9" width="9"]] ReportPeriodTargetRefType
5299
5300 Attributes:
5301
5302 agencyID, maintainableParentID, maintainableParentVersion?, containerID, id, version?, local?, class?, package?
5303
5304 Content:
5305
5306 {Empty}
5307
5308 Attribute Documentation:
5309
5310 |**Name**|**Type**|**Documentation**
5311 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
5312 |maintainableParentID|IDType|The maintainableParentID references the structure in which the component being referenced is defined.
5313 |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.
5314 |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.
5315 |id (fixed: REPORT_PERIOD_TARGET)|IDType|The id attribute identifies the object being referenced, and is therefore always required.
5316 |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.
5317 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
5318 |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.
5319 |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.
5320
5321 **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.
5322
5323 Derivation:
5324
5325 //ReferenceType// (restriction)
5326 [[image:inherit.gif||height="9" width="9"]] //ContainerChildObjectReferenceType// (restriction)
5327 [[image:inherit.gif||height="9" width="9"]] //ComponentReferenceType// (restriction)
5328 [[image:inherit.gif||height="9" width="9"]] IdentifiableObjectTargetReferenceType
5329
5330 Content:
5331
5332 ( (Ref, URN?) | URN)
5333
5334 Element Documentation:
5335
5336 |**Name**|**Type**|**Documentation**
5337 |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.
5338 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
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
5341 **IdentifiableObjectTargetRefType: **IdentifiableObjectTargetRefType contains a reference to an identifiable object target within a metadata target of a data structure definition.
5342
5343 Derivation:
5344
5345 //RefBaseType// (restriction)
5346 [[image:inherit.gif||height="9" width="9"]] //ContainerChildObjectRefBaseType// (restriction)
5347 [[image:inherit.gif||height="9" width="9"]] //ComponentRefBaseType// (restriction)
5348 [[image:inherit.gif||height="9" width="9"]] IdentifiableObjectTargetRefType
5349
5350 Attributes:
5351
5352 agencyID, maintainableParentID, maintainableParentVersion?, containerID?, id, version?, local?, class?, package?
5353
5354 Content:
5355
5356 {Empty}
5357
5358 Attribute Documentation:
5359
5360 |**Name**|**Type**|**Documentation**
5361 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
5362 |maintainableParentID|IDType|The maintainableParentID references the structure in which the component being referenced is defined.
5363 |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.
5364 |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.
5365 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
5366 |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.
5367 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
5368 |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.
5369 |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.
5370
5371 **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.
5372
5373 Derivation:
5374
5375 //ReferenceType// (restriction)
5376 [[image:inherit.gif||height="9" width="9"]] //LocalComponentListComponentReferenceBaseType// (restriction)
5377 [[image:inherit.gif||height="9" width="9"]] //LocalComponentReferenceBaseType// (restriction)
5378 [[image:inherit.gif||height="9" width="9"]] LocalTargetObjectReferenceType
5379
5380 Content:
5381
5382 Ref
5383
5384 Element Documentation:
5385
5386 |**Name**|**Type**|**Documentation**
5387 |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.
5388
5389 **LocalTargetObjectRefType: **LocalTargetObjectRefType contains the reference fields for referencing a target object locally.
5390
5391 Derivation:
5392
5393 //RefBaseType// (restriction)
5394 [[image:inherit.gif||height="9" width="9"]] //LocalIdentifiableRefBaseType// (restriction)
5395 [[image:inherit.gif||height="9" width="9"]] //LocalComponentListComponentRefBaseType// (restriction)
5396 [[image:inherit.gif||height="9" width="9"]] //LocalComponentRefBaseType// (restriction)
5397 [[image:inherit.gif||height="9" width="9"]] LocalTargetObjectRefType
5398
5399 Attributes:
5400
5401 id, local?, class, package?
5402
5403 Content:
5404
5405 {Empty}
5406
5407 Attribute Documentation:
5408
5409 |**Name**|**Type**|**Documentation**
5410 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
5411 |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.
5412 |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.
5413 |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.
5414
5415 **ReportStructureReferenceType: **ReportStructureReferenceType is a type for referencing a report structure object. It consists of a URN and/or a complete set of reference fields.
5416
5417 Derivation:
5418
5419 //ReferenceType// (restriction)
5420 [[image:inherit.gif||height="9" width="9"]] //ChildObjectReferenceType// (restriction)
5421 [[image:inherit.gif||height="9" width="9"]] //ComponentListReferenceType// (restriction)
5422 [[image:inherit.gif||height="9" width="9"]] ReportStructureReferenceType
5423
5424 Content:
5425
5426 ( (Ref, URN?) | URN)
5427
5428 Element Documentation:
5429
5430 |**Name**|**Type**|**Documentation**
5431 |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.
5432 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5433 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5434
5435 **ReportStructureRefType: **ReportStructureRefType contains a reference to a report structure within a metadata structure definition.
5436
5437 Derivation:
5438
5439 //RefBaseType// (restriction)
5440 [[image:inherit.gif||height="9" width="9"]] //ChildObjectRefBaseType// (restriction)
5441 [[image:inherit.gif||height="9" width="9"]] //ComponentListRefBaseType// (restriction)
5442 [[image:inherit.gif||height="9" width="9"]] ReportStructureRefType
5443
5444 Attributes:
5445
5446 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
5447
5448 Content:
5449
5450 {Empty}
5451
5452 Attribute Documentation:
5453
5454 |**Name**|**Type**|**Documentation**
5455 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
5456 |maintainableParentID|IDType|The maintainableParentID references the structure in which the component list being referenced is defined.
5457 |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.
5458 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
5459 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
5460 |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.
5461 |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.
5462
5463 **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).
5464
5465 Derivation:
5466
5467 //ReferenceType// (restriction)
5468 [[image:inherit.gif||height="9" width="9"]] //LocalComponentListReferenceType// (restriction)
5469 [[image:inherit.gif||height="9" width="9"]] LocalReportStructureReferenceType
5470
5471 Content:
5472
5473 Ref
5474
5475 Element Documentation:
5476
5477 |**Name**|**Type**|**Documentation**
5478 |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.
5479
5480 **LocalReportStructureRefType: **LocalReportStructureRefType contains a local reference to a report structure object.
5481
5482 Derivation:
5483
5484 //RefBaseType// (restriction)
5485 [[image:inherit.gif||height="9" width="9"]] //LocalIdentifiableRefBaseType// (restriction)
5486 [[image:inherit.gif||height="9" width="9"]] //LocalComponentListRefBaseType// (restriction)
5487 [[image:inherit.gif||height="9" width="9"]] LocalReportStructureRefType
5488
5489 Attributes:
5490
5491 id, local?, class?, package?
5492
5493 Content:
5494
5495 {Empty}
5496
5497 Attribute Documentation:
5498
5499 |**Name**|**Type**|**Documentation**
5500 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
5501 |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.
5502 |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.
5503 |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.
5504
5505 **MetadataAttributeReferenceType: **MetadataAttributeReferenceType is a type for referencing a metadata attribute object. It consists of a URN and/or a complete set of reference fields.
5506
5507 Derivation:
5508
5509 //ReferenceType// (restriction)
5510 [[image:inherit.gif||height="9" width="9"]] //ContainerChildObjectReferenceType// (restriction)
5511 [[image:inherit.gif||height="9" width="9"]] //ComponentReferenceType// (restriction)
5512 [[image:inherit.gif||height="9" width="9"]] MetadataAttributeReferenceType
5513
5514 Content:
5515
5516 ( (Ref, URN?) | URN)
5517
5518 Element Documentation:
5519
5520 |**Name**|**Type**|**Documentation**
5521 |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.
5522 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5523 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5524
5525 **MetadataAttributeRefType: **MetadataAttributeRefType contains a reference to a metadata attribute within a report structure in a metadata structure definition.
5526
5527 Derivation:
5528
5529 //RefBaseType// (restriction)
5530 [[image:inherit.gif||height="9" width="9"]] //ContainerChildObjectRefBaseType// (restriction)
5531 [[image:inherit.gif||height="9" width="9"]] //ComponentRefBaseType// (restriction)
5532 [[image:inherit.gif||height="9" width="9"]] MetadataAttributeRefType
5533
5534 Attributes:
5535
5536 agencyID, maintainableParentID, maintainableParentVersion?, containerID, id, version?, local?, class?, package?
5537
5538 Content:
5539
5540 {Empty}
5541
5542 Attribute Documentation:
5543
5544 |**Name**|**Type**|**Documentation**
5545 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
5546 |maintainableParentID|IDType|The maintainableParentID references the structure in which the component being referenced is defined.
5547 |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.
5548 |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.
5549 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
5550 |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.
5551 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
5552 |class (fixed: 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.
5553 |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.
5554
5555 **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.
5556
5557 Derivation:
5558
5559 //ReferenceType// (restriction)
5560 [[image:inherit.gif||height="9" width="9"]] //LocalComponentListComponentReferenceBaseType// (restriction)
5561 [[image:inherit.gif||height="9" width="9"]] LocalMetadataStructureComponentReferenceType
5562
5563 Content:
5564
5565 Ref
5566
5567 Element Documentation:
5568
5569 |**Name**|**Type**|**Documentation**
5570 |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.
5571
5572 **LocalMetadataStructureComponentRefType: **LocalMetadataStructureComponentRefType contains the reference fields for referencing any metadata structure component locally. This reference must specify the class of the component being referenced.
5573
5574 Derivation:
5575
5576 //RefBaseType// (restriction)
5577 [[image:inherit.gif||height="9" width="9"]] //LocalIdentifiableRefBaseType// (restriction)
5578 [[image:inherit.gif||height="9" width="9"]] //LocalComponentListComponentRefBaseType// (restriction)
5579 [[image:inherit.gif||height="9" width="9"]] LocalMetadataStructureComponentRefType
5580
5581 Attributes:
5582
5583 containerID, id, local?, class, package?
5584
5585 Content:
5586
5587 {Empty}
5588
5589 Attribute Documentation:
5590
5591 |**Name**|**Type**|**Documentation**
5592 |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.
5593 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
5594 |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.
5595 |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.
5596 |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.
5597
5598 **ProvisionAgreementReferenceType: **ProvisionAgreementReferenceType is a type for referencing a provision agreement. It consists of a URN and/or a complete set of reference fields.
5599
5600 Derivation:
5601
5602 //ReferenceType// (restriction)
5603 [[image:inherit.gif||height="9" width="9"]] //MaintainableReferenceBaseType// (restriction)
5604 [[image:inherit.gif||height="9" width="9"]] ProvisionAgreementReferenceType
5605
5606 Content:
5607
5608 ( (Ref, URN?) | URN)
5609
5610 Element Documentation:
5611
5612 |**Name**|**Type**|**Documentation**
5613 |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.
5614 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5615 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5616
5617 **ProvisionAgreementRefType: **ProvisionAgreementRefType contains a set of reference fields for a provision agreement.
5618
5619 Derivation:
5620
5621 //RefBaseType// (restriction)
5622 [[image:inherit.gif||height="9" width="9"]] //MaintainableRefBaseType// (restriction)
5623 [[image:inherit.gif||height="9" width="9"]] ProvisionAgreementRefType
5624
5625 Attributes:
5626
5627 agencyID, id, version?, local?, class?, package?
5628
5629 Content:
5630
5631 {Empty}
5632
5633 Attribute Documentation:
5634
5635 |**Name**|**Type**|**Documentation**
5636 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
5637 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
5638 |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.
5639 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
5640 |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.
5641 |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.
5642
5643 **ProcessReferenceType: **ProcessReferenceType is a type for referencing a process object. It consists of a URN and/or a complete set of reference fields.
5644
5645 Derivation:
5646
5647 //ReferenceType// (restriction)
5648 [[image:inherit.gif||height="9" width="9"]] //MaintainableReferenceBaseType// (restriction)
5649 [[image:inherit.gif||height="9" width="9"]] ProcessReferenceType
5650
5651 Content:
5652
5653 ( (Ref, URN?) | URN)
5654
5655 Element Documentation:
5656
5657 |**Name**|**Type**|**Documentation**
5658 |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.
5659 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5660 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5661
5662 **ProcessRefType: **ProcessRefType contains a set of reference fields for a process.
5663
5664 Derivation:
5665
5666 //RefBaseType// (restriction)
5667 [[image:inherit.gif||height="9" width="9"]] //MaintainableRefBaseType// (restriction)
5668 [[image:inherit.gif||height="9" width="9"]] ProcessRefType
5669
5670 Attributes:
5671
5672 agencyID, id, version?, local?, class?, package?
5673
5674 Content:
5675
5676 {Empty}
5677
5678 Attribute Documentation:
5679
5680 |**Name**|**Type**|**Documentation**
5681 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
5682 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
5683 |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.
5684 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
5685 |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.
5686 |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.
5687
5688 **ProcessStepReferenceType: **ProcessStepReferenceType is a type for referencing a process step object. It consists of a URN and/or a complete set of reference fields.
5689
5690 Derivation:
5691
5692 //ReferenceType// (restriction)
5693 [[image:inherit.gif||height="9" width="9"]] //ChildObjectReferenceType// (restriction)
5694 [[image:inherit.gif||height="9" width="9"]] ProcessStepReferenceType
5695
5696 Content:
5697
5698 ( (Ref, URN?) | URN)
5699
5700 Element Documentation:
5701
5702 |**Name**|**Type**|**Documentation**
5703 |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.
5704 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5705 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5706
5707 **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.
5708
5709 Derivation:
5710
5711 //RefBaseType// (restriction)
5712 [[image:inherit.gif||height="9" width="9"]] //ChildObjectRefBaseType// (restriction)
5713 [[image:inherit.gif||height="9" width="9"]] ProcessStepRefType
5714
5715 Attributes:
5716
5717 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
5718
5719 Content:
5720
5721 {Empty}
5722
5723 Attribute Documentation:
5724
5725 |**Name**|**Type**|**Documentation**
5726 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
5727 |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.
5728 |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.
5729 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
5730 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
5731 |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.
5732 |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.
5733
5734 **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).
5735
5736 Derivation:
5737
5738 //ReferenceType// (restriction)
5739 [[image:inherit.gif||height="9" width="9"]] //LocalIdentifiableReferenceType// (restriction)
5740 [[image:inherit.gif||height="9" width="9"]] LocalProcessStepReferenceType
5741
5742 Content:
5743
5744 Ref
5745
5746 Element Documentation:
5747
5748 |**Name**|**Type**|**Documentation**
5749 |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.
5750
5751 **LocalProcessStepRefType: **LocalProcessStepRefType contains a local reference to a process step object.
5752
5753 Derivation:
5754
5755 //RefBaseType// (restriction)
5756 [[image:inherit.gif||height="9" width="9"]] //LocalIdentifiableRefBaseType// (restriction)
5757 [[image:inherit.gif||height="9" width="9"]] LocalProcessStepRefType
5758
5759 Attributes:
5760
5761 containerID?, id, local?, class?, package?
5762
5763 Content:
5764
5765 {Empty}
5766
5767 Attribute Documentation:
5768
5769 |**Name**|**Type**|**Documentation**
5770 |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.
5771 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
5772 |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.
5773 |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.
5774 |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.
5775
5776 **TransitionReferenceType: **TransiationReferenceType is a type for referencing a process step object. It consists of a URN and/or a complete set of reference fields.
5777
5778 Derivation:
5779
5780 //ReferenceType// (restriction)
5781 [[image:inherit.gif||height="9" width="9"]] //ContainerChildObjectReferenceType// (restriction)
5782 [[image:inherit.gif||height="9" width="9"]] TransitionReferenceType
5783
5784 Content:
5785
5786 ( (Ref, URN?) | URN)
5787
5788 Element Documentation:
5789
5790 |**Name**|**Type**|**Documentation**
5791 |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.
5792 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5793 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5794
5795 **TransitionRefType: **TransitionRefType provides for a reference to a transition definition in process step through its id.
5796
5797 Derivation:
5798
5799 //RefBaseType// (restriction)
5800 [[image:inherit.gif||height="9" width="9"]] //ContainerChildObjectRefBaseType// (restriction)
5801 [[image:inherit.gif||height="9" width="9"]] TransitionRefType
5802
5803 Attributes:
5804
5805 agencyID, maintainableParentID, maintainableParentVersion?, containerID, id, version?, local?, class?, package?
5806
5807 Content:
5808
5809 {Empty}
5810
5811 Attribute Documentation:
5812
5813 |**Name**|**Type**|**Documentation**
5814 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
5815 |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.
5816 |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.
5817 |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.
5818 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
5819 |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.
5820 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
5821 |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.
5822 |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.
5823
5824 **StructureSetReferenceType: **StructureSetReferenceType is a type for referencing a structure set object. It consists of a URN and/or a complete set of reference fields.
5825
5826 Derivation:
5827
5828 //ReferenceType// (restriction)
5829 [[image:inherit.gif||height="9" width="9"]] //MaintainableReferenceBaseType// (restriction)
5830 [[image:inherit.gif||height="9" width="9"]] StructureSetReferenceType
5831
5832 Content:
5833
5834 ( (Ref, URN?) | URN)
5835
5836 Element Documentation:
5837
5838 |**Name**|**Type**|**Documentation**
5839 |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.
5840 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5841 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5842
5843 **StructureSetRefType: **StructureSetRefType contains a set of reference fields for a structure set.
5844
5845 Derivation:
5846
5847 //RefBaseType// (restriction)
5848 [[image:inherit.gif||height="9" width="9"]] //MaintainableRefBaseType// (restriction)
5849 [[image:inherit.gif||height="9" width="9"]] StructureSetRefType
5850
5851 Attributes:
5852
5853 agencyID, id, version?, local?, class?, package?
5854
5855 Content:
5856
5857 {Empty}
5858
5859 Attribute Documentation:
5860
5861 |**Name**|**Type**|**Documentation**
5862 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
5863 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
5864 |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.
5865 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
5866 |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.
5867 |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.
5868
5869 **StructureMapReferenceType: **StructureMapReferenceType is a type for referencing a structure map object. It consists of a URN and/or a complete set of reference fields.
5870
5871 Derivation:
5872
5873 //ReferenceType// (restriction)
5874 [[image:inherit.gif||height="9" width="9"]] //ChildObjectReferenceType// (restriction)
5875 [[image:inherit.gif||height="9" width="9"]] StructureMapReferenceType
5876
5877 Content:
5878
5879 ( (Ref, URN?) | URN)
5880
5881 Element Documentation:
5882
5883 |**Name**|**Type**|**Documentation**
5884 |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.
5885 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5886 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5887
5888 **StructureMapRefType: **StructureMapRefType contains fields for referencing a structure map within a structure set.
5889
5890 Derivation:
5891
5892 //RefBaseType// (restriction)
5893 [[image:inherit.gif||height="9" width="9"]] //ChildObjectRefBaseType// (restriction)
5894 [[image:inherit.gif||height="9" width="9"]] StructureMapRefType
5895
5896 Attributes:
5897
5898 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
5899
5900 Content:
5901
5902 {Empty}
5903
5904 Attribute Documentation:
5905
5906 |**Name**|**Type**|**Documentation**
5907 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
5908 |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.
5909 |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.
5910 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
5911 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
5912 |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.
5913 |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.
5914
5915 **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.
5916
5917 Derivation:
5918
5919 //ReferenceType// (restriction)
5920 [[image:inherit.gif||height="9" width="9"]] //ChildObjectReferenceType// (restriction)
5921 [[image:inherit.gif||height="9" width="9"]] CategorySchemeMapReferenceType
5922
5923 Content:
5924
5925 ( (Ref, URN?) | URN)
5926
5927 Element Documentation:
5928
5929 |**Name**|**Type**|**Documentation**
5930 |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.
5931 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5932 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5933
5934 **CategorySchemeMapRefType: **CategorySchemeMapRefType contains a set of reference fields for a category scheme map.
5935
5936 Derivation:
5937
5938 //RefBaseType// (restriction)
5939 [[image:inherit.gif||height="9" width="9"]] //ChildObjectRefBaseType// (restriction)
5940 [[image:inherit.gif||height="9" width="9"]] CategorySchemeMapRefType
5941
5942 Attributes:
5943
5944 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
5945
5946 Content:
5947
5948 {Empty}
5949
5950 Attribute Documentation:
5951
5952 |**Name**|**Type**|**Documentation**
5953 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
5954 |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.
5955 |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.
5956 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
5957 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
5958 |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.
5959 |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.
5960
5961 **CodelistMapReferenceType: **CodelistMapReferenceType is a type for referencing a codelist map object. It consists of a URN and/or a complete set of reference fields.
5962
5963 Derivation:
5964
5965 //ReferenceType// (restriction)
5966 [[image:inherit.gif||height="9" width="9"]] //ChildObjectReferenceType// (restriction)
5967 [[image:inherit.gif||height="9" width="9"]] CodelistMapReferenceType
5968
5969 Content:
5970
5971 ( (Ref, URN?) | URN)
5972
5973 Element Documentation:
5974
5975 |**Name**|**Type**|**Documentation**
5976 |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.
5977 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5978 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5979
5980 **CodelistMapRefType: **CodelistMapRefType contains a set of reference fields for a codelist map.
5981
5982 Derivation:
5983
5984 //RefBaseType// (restriction)
5985 [[image:inherit.gif||height="9" width="9"]] //ChildObjectRefBaseType// (restriction)
5986 [[image:inherit.gif||height="9" width="9"]] CodelistMapRefType
5987
5988 Attributes:
5989
5990 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
5991
5992 Content:
5993
5994 {Empty}
5995
5996 Attribute Documentation:
5997
5998 |**Name**|**Type**|**Documentation**
5999 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
6000 |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.
6001 |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.
6002 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
6003 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
6004 |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.
6005 |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.
6006
6007 **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).
6008
6009 Derivation:
6010
6011 //ReferenceType// (restriction)
6012 [[image:inherit.gif||height="9" width="9"]] LocalCodelistMapReferenceType
6013
6014 Content:
6015
6016 Ref
6017
6018 Element Documentation:
6019
6020 |**Name**|**Type**|**Documentation**
6021 |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.
6022
6023 **LocalCodelistMapRefType: **LocalCodelistMapRefType contains a set of reference fields for a codelist map locally.
6024
6025 Derivation:
6026
6027 //RefBaseType// (restriction)
6028 [[image:inherit.gif||height="9" width="9"]] //LocalIdentifiableRefBaseType// (restriction)
6029 [[image:inherit.gif||height="9" width="9"]] LocalCodelistMapRefType
6030
6031 Attributes:
6032
6033 id, local?, class?, package?
6034
6035 Content:
6036
6037 {Empty}
6038
6039 Attribute Documentation:
6040
6041 |**Name**|**Type**|**Documentation**
6042 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
6043 |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.
6044 |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.
6045 |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.
6046
6047 **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.
6048
6049 Derivation:
6050
6051 //ReferenceType// (restriction)
6052 [[image:inherit.gif||height="9" width="9"]] //ChildObjectReferenceType// (restriction)
6053 [[image:inherit.gif||height="9" width="9"]] ConceptSchemeMapReferenceType
6054
6055 Content:
6056
6057 ( (Ref, URN?) | URN)
6058
6059 Element Documentation:
6060
6061 |**Name**|**Type**|**Documentation**
6062 |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.
6063 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
6064 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
6065
6066 **ConceptSchemeMapRefType: **ConceptSchemeMapRefType contains a set of reference fields for a concept scheme map.
6067
6068 Derivation:
6069
6070 //RefBaseType// (restriction)
6071 [[image:inherit.gif||height="9" width="9"]] //ChildObjectRefBaseType// (restriction)
6072 [[image:inherit.gif||height="9" width="9"]] ConceptSchemeMapRefType
6073
6074 Attributes:
6075
6076 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
6077
6078 Content:
6079
6080 {Empty}
6081
6082 Attribute Documentation:
6083
6084 |**Name**|**Type**|**Documentation**
6085 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
6086 |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.
6087 |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.
6088 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
6089 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
6090 |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.
6091 |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.
6092
6093 **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.
6094
6095 Derivation:
6096
6097 //ReferenceType// (restriction)
6098 [[image:inherit.gif||height="9" width="9"]] //ChildObjectReferenceType// (restriction)
6099 [[image:inherit.gif||height="9" width="9"]] OrganisationSchemeMapReferenceType
6100
6101 Content:
6102
6103 ( (Ref, URN?) | URN)
6104
6105 Element Documentation:
6106
6107 |**Name**|**Type**|**Documentation**
6108 |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.
6109 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
6110 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
6111
6112 **OrganisationSchemeMapRefType: **OrganisationSchemeMapRefType contains a set of reference fields for an organisation scheme map.
6113
6114 Derivation:
6115
6116 //RefBaseType// (restriction)
6117 [[image:inherit.gif||height="9" width="9"]] //ChildObjectRefBaseType// (restriction)
6118 [[image:inherit.gif||height="9" width="9"]] OrganisationSchemeMapRefType
6119
6120 Attributes:
6121
6122 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
6123
6124 Content:
6125
6126 {Empty}
6127
6128 Attribute Documentation:
6129
6130 |**Name**|**Type**|**Documentation**
6131 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
6132 |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.
6133 |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.
6134 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
6135 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value 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: 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.
6137 |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.
6138
6139 **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.
6140
6141 Derivation:
6142
6143 //ReferenceType// (restriction)
6144 [[image:inherit.gif||height="9" width="9"]] //MaintainableReferenceBaseType// (restriction)
6145 [[image:inherit.gif||height="9" width="9"]] //ItemSchemeReferenceBaseType// (restriction)
6146 [[image:inherit.gif||height="9" width="9"]] VtlMappingSchemeReferenceType
6147
6148 Content:
6149
6150 ( (Ref, URN?) | URN)
6151
6152 Element Documentation:
6153
6154 |**Name**|**Type**|**Documentation**
6155 |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.
6156 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
6157 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
6158
6159 **VtlMappingSchemeRefType: **VtlMappingSchemeRefType provides a reference to a VTL mapping scheme via a complete set of reference fields.
6160
6161 Derivation:
6162
6163 //RefBaseType// (restriction)
6164 [[image:inherit.gif||height="9" width="9"]] //MaintainableRefBaseType// (restriction)
6165 [[image:inherit.gif||height="9" width="9"]] //ItemSchemeRefBaseType// (restriction)
6166 [[image:inherit.gif||height="9" width="9"]] VtlMappingSchemeRefType
6167
6168 Attributes:
6169
6170 agencyID, id, version?, local?, class?, package?
6171
6172 Content:
6173
6174 {Empty}
6175
6176 Attribute Documentation:
6177
6178 |**Name**|**Type**|**Documentation**
6179 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
6180 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
6181 |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.
6182 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
6183 |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.
6184 |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.
6185
6186 **VtlMappingReferenceType: **VtlMappingReferenceType is a type for referencing a VTL mapping object. It consists of a URN and/or a complete set of reference fields.
6187
6188 Derivation:
6189
6190 //ReferenceType// (restriction)
6191 [[image:inherit.gif||height="9" width="9"]] //ChildObjectReferenceType// (restriction)
6192 [[image:inherit.gif||height="9" width="9"]] //ItemReferenceType// (restriction)
6193 [[image:inherit.gif||height="9" width="9"]] VtlMappingReferenceType
6194
6195 Content:
6196
6197 ( (Ref, URN?) | URN)
6198
6199 Element Documentation:
6200
6201 |**Name**|**Type**|**Documentation**
6202 |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.
6203 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
6204 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
6205
6206 **VtlMappingRefType: **VtlMappingRefType references a VTL mapping from within a VTL mapping scheme. Reference fields are required for both the scheme and the item.
6207
6208 Derivation:
6209
6210 //RefBaseType// (restriction)
6211 [[image:inherit.gif||height="9" width="9"]] //ChildObjectRefBaseType// (restriction)
6212 [[image:inherit.gif||height="9" width="9"]] //ItemRefBaseType// (restriction)
6213 [[image:inherit.gif||height="9" width="9"]] VtlMappingRefType
6214
6215 Attributes:
6216
6217 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
6218
6219 Content:
6220
6221 {Empty}
6222
6223 Attribute Documentation:
6224
6225 |**Name**|**Type**|**Documentation**
6226 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
6227 |maintainableParentID|IDType|The maintainableParentID references the VTL mapping scheme in which the VTL mapping being referenced is defined.
6228 |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.
6229 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
6230 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
6231 |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.
6232 |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.
6233
6234 **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.
6235
6236 Derivation:
6237
6238 //ReferenceType// (restriction)
6239 [[image:inherit.gif||height="9" width="9"]] //LocalItemReferenceType// (restriction)
6240 [[image:inherit.gif||height="9" width="9"]] LocalVtlMappingReferenceType
6241
6242 Content:
6243
6244 Ref
6245
6246 Element Documentation:
6247
6248 |**Name**|**Type**|**Documentation**
6249 |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.
6250
6251 **LocalVtlMappingRefType: **LocalVtlMappingRefType references a VTL mapping locally where the references to the VTL mapping scheme which defines it is provided elsewhere.
6252
6253 Derivation:
6254
6255 //RefBaseType// (restriction)
6256 [[image:inherit.gif||height="9" width="9"]] //LocalIdentifiableRefBaseType// (restriction)
6257 [[image:inherit.gif||height="9" width="9"]] //LocalItemRefBaseType// (restriction)
6258 [[image:inherit.gif||height="9" width="9"]] LocalVtlMappingRefType
6259
6260 Attributes:
6261
6262 id, local?, class?, package?
6263
6264 Content:
6265
6266 {Empty}
6267
6268 Attribute Documentation:
6269
6270 |**Name**|**Type**|**Documentation**
6271 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
6272 |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.
6273 |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.
6274 |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.
6275
6276 **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.
6277
6278 Derivation:
6279
6280 //ReferenceType// (restriction)
6281 [[image:inherit.gif||height="9" width="9"]] //MaintainableReferenceBaseType// (restriction)
6282 [[image:inherit.gif||height="9" width="9"]] //ItemSchemeReferenceBaseType// (restriction)
6283 [[image:inherit.gif||height="9" width="9"]] NamePersonalisationSchemeReferenceType
6284
6285 Content:
6286
6287 ( (Ref, URN?) | URN)
6288
6289 Element Documentation:
6290
6291 |**Name**|**Type**|**Documentation**
6292 |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.
6293 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
6294 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
6295
6296 **NamePersonalisationSchemeRefType: **NamePersonalisationSchemeRefType provides a reference to a name personalisation scheme via a complete set of reference fields.
6297
6298 Derivation:
6299
6300 //RefBaseType// (restriction)
6301 [[image:inherit.gif||height="9" width="9"]] //MaintainableRefBaseType// (restriction)
6302 [[image:inherit.gif||height="9" width="9"]] //ItemSchemeRefBaseType// (restriction)
6303 [[image:inherit.gif||height="9" width="9"]] NamePersonalisationSchemeRefType
6304
6305 Attributes:
6306
6307 agencyID, id, version?, local?, class?, package?
6308
6309 Content:
6310
6311 {Empty}
6312
6313 Attribute Documentation:
6314
6315 |**Name**|**Type**|**Documentation**
6316 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
6317 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
6318 |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.
6319 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
6320 |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.
6321 |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.
6322
6323 **NamePersonalisationReferenceType: **NamePersonalisationReferenceType is a type for referencing a name personalisation object. It consists of a URN and/or a complete set of reference fields.
6324
6325 Derivation:
6326
6327 //ReferenceType// (restriction)
6328 [[image:inherit.gif||height="9" width="9"]] //ChildObjectReferenceType// (restriction)
6329 [[image:inherit.gif||height="9" width="9"]] //ItemReferenceType// (restriction)
6330 [[image:inherit.gif||height="9" width="9"]] NamePersonalisationReferenceType
6331
6332 Content:
6333
6334 ( (Ref, URN?) | URN)
6335
6336 Element Documentation:
6337
6338 |**Name**|**Type**|**Documentation**
6339 |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.
6340 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
6341 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
6342
6343 **NamePersonalisationRefType: **NamePersonalisationRefType references a name personalisation from within a name personalisation scheme. Reference fields are required for both the scheme and the item.
6344
6345 Derivation:
6346
6347 //RefBaseType// (restriction)
6348 [[image:inherit.gif||height="9" width="9"]] //ChildObjectRefBaseType// (restriction)
6349 [[image:inherit.gif||height="9" width="9"]] //ItemRefBaseType// (restriction)
6350 [[image:inherit.gif||height="9" width="9"]] NamePersonalisationRefType
6351
6352 Attributes:
6353
6354 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
6355
6356 Content:
6357
6358 {Empty}
6359
6360 Attribute Documentation:
6361
6362 |**Name**|**Type**|**Documentation**
6363 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
6364 |maintainableParentID|IDType|The maintainableParentID references the name personalisation scheme in which the name personalisation being referenced is defined.
6365 |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.
6366 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
6367 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
6368 |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.
6369 |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.
6370
6371 **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.
6372
6373 Derivation:
6374
6375 //ReferenceType// (restriction)
6376 [[image:inherit.gif||height="9" width="9"]] //LocalItemReferenceType// (restriction)
6377 [[image:inherit.gif||height="9" width="9"]] LocalNamePersonalisationReferenceType
6378
6379 Content:
6380
6381 Ref
6382
6383 Element Documentation:
6384
6385 |**Name**|**Type**|**Documentation**
6386 |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.
6387
6388 **LocalNamePersonalisationRefType: **LocalNamePersonalisationRefType references a name personalisation locally where the references to the name personalisation scheme which defines it is provided elsewhere.
6389
6390 Derivation:
6391
6392 //RefBaseType// (restriction)
6393 [[image:inherit.gif||height="9" width="9"]] //LocalIdentifiableRefBaseType// (restriction)
6394 [[image:inherit.gif||height="9" width="9"]] //LocalItemRefBaseType// (restriction)
6395 [[image:inherit.gif||height="9" width="9"]] LocalNamePersonalisationRefType
6396
6397 Attributes:
6398
6399 id, local?, class?, package?
6400
6401 Content:
6402
6403 {Empty}
6404
6405 Attribute Documentation:
6406
6407 |**Name**|**Type**|**Documentation**
6408 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
6409 |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.
6410 |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.
6411 |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.
6412
6413 **RulesetSchemeReferenceType: **RulesetSchemeReferenceType is a type for referencing a ruleset scheme object. It consists of a URN and/or a complete set of reference fields.
6414
6415 Derivation:
6416
6417 //ReferenceType// (restriction)
6418 [[image:inherit.gif||height="9" width="9"]] //MaintainableReferenceBaseType// (restriction)
6419 [[image:inherit.gif||height="9" width="9"]] //ItemSchemeReferenceBaseType// (restriction)
6420 [[image:inherit.gif||height="9" width="9"]] RulesetSchemeReferenceType
6421
6422 Content:
6423
6424 ( (Ref, URN?) | URN)
6425
6426 Element Documentation:
6427
6428 |**Name**|**Type**|**Documentation**
6429 |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.
6430 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
6431 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
6432
6433 **RulesetSchemeRefType: **RulesetSchemeRefType provides a reference to a ruleset scheme via a complete set of reference fields.
6434
6435 Derivation:
6436
6437 //RefBaseType// (restriction)
6438 [[image:inherit.gif||height="9" width="9"]] //MaintainableRefBaseType// (restriction)
6439 [[image:inherit.gif||height="9" width="9"]] //ItemSchemeRefBaseType// (restriction)
6440 [[image:inherit.gif||height="9" width="9"]] RulesetSchemeRefType
6441
6442 Attributes:
6443
6444 agencyID, id, version?, local?, class?, package?
6445
6446 Content:
6447
6448 {Empty}
6449
6450 Attribute Documentation:
6451
6452 |**Name**|**Type**|**Documentation**
6453 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
6454 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
6455 |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.
6456 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
6457 |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.
6458 |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.
6459
6460 **RulesetReferenceType: **RulesetReferenceType is a type for referencing a ruleset object. It consists of a URN and/or a complete set of reference fields.
6461
6462 Derivation:
6463
6464 //ReferenceType// (restriction)
6465 [[image:inherit.gif||height="9" width="9"]] //ChildObjectReferenceType// (restriction)
6466 [[image:inherit.gif||height="9" width="9"]] //ItemReferenceType// (restriction)
6467 [[image:inherit.gif||height="9" width="9"]] RulesetReferenceType
6468
6469 Content:
6470
6471 ( (Ref, URN?) | URN)
6472
6473 Element Documentation:
6474
6475 |**Name**|**Type**|**Documentation**
6476 |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.
6477 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
6478 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
6479
6480 **RulesetRefType: **RulesetRefType references a rule set from within an rule set scheme. Reference fields are required for both the scheme and the item.
6481
6482 Derivation:
6483
6484 //RefBaseType// (restriction)
6485 [[image:inherit.gif||height="9" width="9"]] //ChildObjectRefBaseType// (restriction)
6486 [[image:inherit.gif||height="9" width="9"]] //ItemRefBaseType// (restriction)
6487 [[image:inherit.gif||height="9" width="9"]] RulesetRefType
6488
6489 Attributes:
6490
6491 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
6492
6493 Content:
6494
6495 {Empty}
6496
6497 Attribute Documentation:
6498
6499 |**Name**|**Type**|**Documentation**
6500 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
6501 |maintainableParentID|IDType|The maintainableParentID references the ruleset scheme in which the concept being referenced is defined.
6502 |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.
6503 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
6504 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
6505 |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.
6506 |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.
6507
6508 **LocalRulesetReferenceType: **LocalRulesetReferenceType provides a simple reference to a ruleset where the identification of the ruleset scheme which defines it is contained in another context.
6509
6510 Derivation:
6511
6512 //ReferenceType// (restriction)
6513 [[image:inherit.gif||height="9" width="9"]] //LocalItemReferenceType// (restriction)
6514 [[image:inherit.gif||height="9" width="9"]] LocalRulesetReferenceType
6515
6516 Content:
6517
6518 Ref
6519
6520 Element Documentation:
6521
6522 |**Name**|**Type**|**Documentation**
6523 |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.
6524
6525 **LocalRulesetRefType: **LocalRulesetRefType references a ruleset locally where the references to the ruleset scheme which defines it is provided elsewhere.
6526
6527 Derivation:
6528
6529 //RefBaseType// (restriction)
6530 [[image:inherit.gif||height="9" width="9"]] //LocalIdentifiableRefBaseType// (restriction)
6531 [[image:inherit.gif||height="9" width="9"]] //LocalItemRefBaseType// (restriction)
6532 [[image:inherit.gif||height="9" width="9"]] LocalRulesetRefType
6533
6534 Attributes:
6535
6536 id, local?, class?, package?
6537
6538 Content:
6539
6540 {Empty}
6541
6542 Attribute Documentation:
6543
6544 |**Name**|**Type**|**Documentation**
6545 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
6546 |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.
6547 |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.
6548 |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.
6549
6550 **TransformationSchemeReferenceType: **TransformationSchemeReferenceType is a type for referencing a transformation scheme object. It consists of a URN and/or a complete set of reference fields.
6551
6552 Derivation:
6553
6554 //ReferenceType// (restriction)
6555 [[image:inherit.gif||height="9" width="9"]] //MaintainableReferenceBaseType// (restriction)
6556 [[image:inherit.gif||height="9" width="9"]] //ItemSchemeReferenceBaseType// (restriction)
6557 [[image:inherit.gif||height="9" width="9"]] TransformationSchemeReferenceType
6558
6559 Content:
6560
6561 ( (Ref, URN?) | URN)
6562
6563 Element Documentation:
6564
6565 |**Name**|**Type**|**Documentation**
6566 |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.
6567 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
6568 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
6569
6570 **TransformationSchemeRefType: **TransformationSchemeRefType provides a reference to a transformation scheme via a complete set of reference fields.
6571
6572 Derivation:
6573
6574 //RefBaseType// (restriction)
6575 [[image:inherit.gif||height="9" width="9"]] //MaintainableRefBaseType// (restriction)
6576 [[image:inherit.gif||height="9" width="9"]] //ItemSchemeRefBaseType// (restriction)
6577 [[image:inherit.gif||height="9" width="9"]] TransformationSchemeRefType
6578
6579 Attributes:
6580
6581 agencyID, id, version?, local?, class?, package?
6582
6583 Content:
6584
6585 {Empty}
6586
6587 Attribute Documentation:
6588
6589 |**Name**|**Type**|**Documentation**
6590 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
6591 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
6592 |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.
6593 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
6594 |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.
6595 |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.
6596
6597 **TransformationReferenceType: **TransformationReferenceType is a type for referencing a transformation object. It consists of a URN and/or a complete set of reference fields.
6598
6599 Derivation:
6600
6601 //ReferenceType// (restriction)
6602 [[image:inherit.gif||height="9" width="9"]] //ChildObjectReferenceType// (restriction)
6603 [[image:inherit.gif||height="9" width="9"]] //ItemReferenceType// (restriction)
6604 [[image:inherit.gif||height="9" width="9"]] TransformationReferenceType
6605
6606 Content:
6607
6608 ( (Ref, URN?) | URN)
6609
6610 Element Documentation:
6611
6612 |**Name**|**Type**|**Documentation**
6613 |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.
6614 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
6615 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
6616
6617 **TransformationRefType: **TransformationRefType references a transformation from within a transformation scheme. Reference fields are required for both the scheme and the item.
6618
6619 Derivation:
6620
6621 //RefBaseType// (restriction)
6622 [[image:inherit.gif||height="9" width="9"]] //ChildObjectRefBaseType// (restriction)
6623 [[image:inherit.gif||height="9" width="9"]] //ItemRefBaseType// (restriction)
6624 [[image:inherit.gif||height="9" width="9"]] TransformationRefType
6625
6626 Attributes:
6627
6628 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
6629
6630 Content:
6631
6632 {Empty}
6633
6634 Attribute Documentation:
6635
6636 |**Name**|**Type**|**Documentation**
6637 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
6638 |maintainableParentID|IDType|The maintainableParentID references the transformation scheme in which the transformation being referenced is defined.
6639 |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.
6640 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
6641 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
6642 |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.
6643 |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.
6644
6645 **LocalTransformationReferenceType: **LocalTransformationReferenceType provides a simple references to a transformation where the identification of the transformation scheme which defines it is contained in another context.
6646
6647 Derivation:
6648
6649 //ReferenceType// (restriction)
6650 [[image:inherit.gif||height="9" width="9"]] //LocalItemReferenceType// (restriction)
6651 [[image:inherit.gif||height="9" width="9"]] LocalTransformationReferenceType
6652
6653 Content:
6654
6655 Ref
6656
6657 Element Documentation:
6658
6659 |**Name**|**Type**|**Documentation**
6660 |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.
6661
6662 **LocalTransformationRefType: **LocalTransformationRefType references a transformation locally where the references to the transformation scheme which defines it is provided elsewhere.
6663
6664 Derivation:
6665
6666 //RefBaseType// (restriction)
6667 [[image:inherit.gif||height="9" width="9"]] //LocalIdentifiableRefBaseType// (restriction)
6668 [[image:inherit.gif||height="9" width="9"]] //LocalItemRefBaseType// (restriction)
6669 [[image:inherit.gif||height="9" width="9"]] LocalTransformationRefType
6670
6671 Attributes:
6672
6673 id, local?, class?, package?
6674
6675 Content:
6676
6677 {Empty}
6678
6679 Attribute Documentation:
6680
6681 |**Name**|**Type**|**Documentation**
6682 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
6683 |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.
6684 |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.
6685 |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.
6686
6687 **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.
6688
6689 Derivation:
6690
6691 //ReferenceType// (restriction)
6692 [[image:inherit.gif||height="9" width="9"]] //MaintainableReferenceBaseType// (restriction)
6693 [[image:inherit.gif||height="9" width="9"]] //ItemSchemeReferenceBaseType// (restriction)
6694 [[image:inherit.gif||height="9" width="9"]] UserDefinedOperatorSchemeReferenceType
6695
6696 Content:
6697
6698 ( (Ref, URN?) | URN)
6699
6700 Element Documentation:
6701
6702 |**Name**|**Type**|**Documentation**
6703 |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.
6704 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
6705 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
6706
6707 **UserDefinedOperatorSchemeRefType: **UserDefinedOperatorSchemeRefType provides a reference to a user defined operator scheme via a complete set of reference fields.
6708
6709 Derivation:
6710
6711 //RefBaseType// (restriction)
6712 [[image:inherit.gif||height="9" width="9"]] //MaintainableRefBaseType// (restriction)
6713 [[image:inherit.gif||height="9" width="9"]] //ItemSchemeRefBaseType// (restriction)
6714 [[image:inherit.gif||height="9" width="9"]] UserDefinedOperatorSchemeRefType
6715
6716 Attributes:
6717
6718 agencyID, id, version?, local?, class?, package?
6719
6720 Content:
6721
6722 {Empty}
6723
6724 Attribute Documentation:
6725
6726 |**Name**|**Type**|**Documentation**
6727 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
6728 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
6729 |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.
6730 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
6731 |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.
6732 |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.
6733
6734 **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.
6735
6736 Derivation:
6737
6738 //ReferenceType// (restriction)
6739 [[image:inherit.gif||height="9" width="9"]] //ChildObjectReferenceType// (restriction)
6740 [[image:inherit.gif||height="9" width="9"]] //ItemReferenceType// (restriction)
6741 [[image:inherit.gif||height="9" width="9"]] UserDefinedOperatorReferenceType
6742
6743 Content:
6744
6745 ( (Ref, URN?) | URN)
6746
6747 Element Documentation:
6748
6749 |**Name**|**Type**|**Documentation**
6750 |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.
6751 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
6752 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
6753
6754 **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.
6755
6756 Derivation:
6757
6758 //RefBaseType// (restriction)
6759 [[image:inherit.gif||height="9" width="9"]] //ChildObjectRefBaseType// (restriction)
6760 [[image:inherit.gif||height="9" width="9"]] //ItemRefBaseType// (restriction)
6761 [[image:inherit.gif||height="9" width="9"]] UserDefinedOperatorRefType
6762
6763 Attributes:
6764
6765 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
6766
6767 Content:
6768
6769 {Empty}
6770
6771 Attribute Documentation:
6772
6773 |**Name**|**Type**|**Documentation**
6774 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
6775 |maintainableParentID|IDType|The maintainableParentID references the user defined operator scheme in which the user defined operator being referenced is defined.
6776 |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.
6777 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
6778 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
6779 |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.
6780 |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.
6781
6782 **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.
6783
6784 Derivation:
6785
6786 //ReferenceType// (restriction)
6787 [[image:inherit.gif||height="9" width="9"]] //LocalItemReferenceType// (restriction)
6788 [[image:inherit.gif||height="9" width="9"]] LocalUserDefinedOperatorReferenceType
6789
6790 Content:
6791
6792 Ref
6793
6794 Element Documentation:
6795
6796 |**Name**|**Type**|**Documentation**
6797 |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.
6798
6799 **LocalUserDefinedOperatorRefType: **LocalUserDefinedOperatorRefType references a user defined operator locally where the references to the user defined operator scheme which defines it is provided elsewhere.
6800
6801 Derivation:
6802
6803 //RefBaseType// (restriction)
6804 [[image:inherit.gif||height="9" width="9"]] //LocalIdentifiableRefBaseType// (restriction)
6805 [[image:inherit.gif||height="9" width="9"]] //LocalItemRefBaseType// (restriction)
6806 [[image:inherit.gif||height="9" width="9"]] LocalUserDefinedOperatorRefType
6807
6808 Attributes:
6809
6810 id, local?, class?, package?
6811
6812 Content:
6813
6814 {Empty}
6815
6816 Attribute Documentation:
6817
6818 |**Name**|**Type**|**Documentation**
6819 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
6820 |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.
6821 |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.
6822 |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.
6823
6824 **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.
6825
6826 Derivation:
6827
6828 //ReferenceType// (restriction)
6829 [[image:inherit.gif||height="9" width="9"]] //MaintainableReferenceBaseType// (restriction)
6830 [[image:inherit.gif||height="9" width="9"]] //ItemSchemeReferenceBaseType// (restriction)
6831 [[image:inherit.gif||height="9" width="9"]] CustomTypeSchemeReferenceType
6832
6833 Content:
6834
6835 ( (Ref, URN?) | URN)
6836
6837 Element Documentation:
6838
6839 |**Name**|**Type**|**Documentation**
6840 |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.
6841 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
6842 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
6843
6844 **CustomTypeSchemeRefType: **CustomTypeSchemeRefType provides a reference to a custom type scheme via a complete set of reference fields.
6845
6846 Derivation:
6847
6848 //RefBaseType// (restriction)
6849 [[image:inherit.gif||height="9" width="9"]] //MaintainableRefBaseType// (restriction)
6850 [[image:inherit.gif||height="9" width="9"]] //ItemSchemeRefBaseType// (restriction)
6851 [[image:inherit.gif||height="9" width="9"]] CustomTypeSchemeRefType
6852
6853 Attributes:
6854
6855 agencyID, id, version?, local?, class?, package?
6856
6857 Content:
6858
6859 {Empty}
6860
6861 Attribute Documentation:
6862
6863 |**Name**|**Type**|**Documentation**
6864 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
6865 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
6866 |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.
6867 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
6868 |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.
6869 |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.
6870
6871 **CustomTypeReferenceType: **CustomTypeReferenceType is a type for referencing a custom type object. It consists of a URN and/or a complete set of reference fields.
6872
6873 Derivation:
6874
6875 //ReferenceType// (restriction)
6876 [[image:inherit.gif||height="9" width="9"]] //ChildObjectReferenceType// (restriction)
6877 [[image:inherit.gif||height="9" width="9"]] //ItemReferenceType// (restriction)
6878 [[image:inherit.gif||height="9" width="9"]] CustomTypeReferenceType
6879
6880 Content:
6881
6882 ( (Ref, URN?) | URN)
6883
6884 Element Documentation:
6885
6886 |**Name**|**Type**|**Documentation**
6887 |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.
6888 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
6889 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
6890
6891 **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.
6892
6893 Derivation:
6894
6895 //RefBaseType// (restriction)
6896 [[image:inherit.gif||height="9" width="9"]] //ChildObjectRefBaseType// (restriction)
6897 [[image:inherit.gif||height="9" width="9"]] //ItemRefBaseType// (restriction)
6898 [[image:inherit.gif||height="9" width="9"]] CustomTypeRefType
6899
6900 Attributes:
6901
6902 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
6903
6904 Content:
6905
6906 {Empty}
6907
6908 Attribute Documentation:
6909
6910 |**Name**|**Type**|**Documentation**
6911 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
6912 |maintainableParentID|IDType|The maintainableParentID references the custom mask scheme in which the custom type being referenced is defined.
6913 |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.
6914 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
6915 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
6916 |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.
6917 |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.
6918
6919 **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.
6920
6921 Derivation:
6922
6923 //ReferenceType// (restriction)
6924 [[image:inherit.gif||height="9" width="9"]] //LocalItemReferenceType// (restriction)
6925 [[image:inherit.gif||height="9" width="9"]] LocalCustomTypeReferenceType
6926
6927 Content:
6928
6929 Ref
6930
6931 Element Documentation:
6932
6933 |**Name**|**Type**|**Documentation**
6934 |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.
6935
6936 **LocalCustomTypeRefType: **LocalCustomTypeRefType references a custom type locally where the references to the custom type scheme which defines it is provided elsewhere.
6937
6938 Derivation:
6939
6940 //RefBaseType// (restriction)
6941 [[image:inherit.gif||height="9" width="9"]] //LocalIdentifiableRefBaseType// (restriction)
6942 [[image:inherit.gif||height="9" width="9"]] //LocalItemRefBaseType// (restriction)
6943 [[image:inherit.gif||height="9" width="9"]] LocalCustomTypeRefType
6944
6945 Attributes:
6946
6947 id, local?, class?, package?
6948
6949 Content:
6950
6951 {Empty}
6952
6953 Attribute Documentation:
6954
6955 |**Name**|**Type**|**Documentation**
6956 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
6957 |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.
6958 |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.
6959 |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.
6960
6961 **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.
6962
6963 Content:
6964
6965 DataProvider, ID
6966
6967 Element Documentation:
6968
6969 |**Name**|**Type**|**Documentation**
6970 |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.
6971 |ID|IDType|ID contains the identifier of the data/metadata set being referenced.
6972
6973 **ObjectTypeListType: **ObjectTypeListType provides a means for enumerating object types.
6974
6975 Content:
6976
6977 (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?)
6978
6979 Element Documentation:
6980
6981 |**Name**|**Type**|**Documentation**
6982 |Any|EmptyType|Any is an empty element that denotes an object of any type.
6983 |Agency|EmptyType|Agency is an empty element that denotes an agency object.
6984 |AgencyScheme|EmptyType|AgencyScheme is an empty element that denotes an agency scheme object.
6985 |AttachmentConstraint|EmptyType|AttachmentConstraint is an empty element that denotes an attachment constraint object.
6986 |Attribute|EmptyType|Attribute is an empty element that denotes an attribute object.
6987 |AttributeDescriptor|EmptyType|AttributeDescriptor is an empty element that denotes an attribute descriptor object.
6988 |Categorisation|EmptyType|Categorisation is an empty element that denotes a categorisation object.
6989 |Category|EmptyType|Category is an empty element that denotes a category object.
6990 |CategorySchemeMap|EmptyType|CategorySchemeMap is an empty element that denotes a category scheme map object.
6991 |CategoryScheme|EmptyType|CategoryScheme is an empty element that denotes a category scheme object.
6992 |Code|EmptyType|Code is an empty element that denotes a code object.
6993 |CodeMap|EmptyType|CodeMap is an empty element that denotes a code map object.
6994 |Codelist|EmptyType|Codelist is an empty element that denotes a code list object.
6995 |CodelistMap|EmptyType|CodelistMap is an empty element that denotes a code list map object.
6996 |ComponentMap|EmptyType|ComponentMap is an empty element that denotes a component map object.
6997 |Concept|EmptyType|Concept is an empty element that denotes a concept object.
6998 |ConceptMap|EmptyType|ConceptMap is an empty element that denotes a concept map object.
6999 |ConceptScheme|EmptyType|ConceptScheme is an empty element that denotes a concept scheme object.
7000 |ConceptSchemeMap|EmptyType|ConceptSchemeMap is an empty element that denotes a concept scheme map object.
7001 |ContentConstraint|EmptyType|ContentConstraint is an empty element that denotes a content constraint object.
7002 |CustomType|EmptyType|CustomType is an empty element that denotes a custom type object.
7003 |CustomTypeScheme|EmptyType|CustomTypeScheme is an empty element that denotes a custom type scheme object.
7004 |Dataflow|EmptyType|Dataflow is an empty element that denotes a data flow object.
7005 |DataConsumer|EmptyType|DataConsumer is an empty element that denotes a data consumer object.
7006 |DataConsumerScheme|EmptyType|DataConsumerScheme is an empty element that denotes a data consumer scheme object.
7007 |DataProvider|EmptyType|DataProvider is an empty element that denotes a data provider object.
7008 |DataProviderScheme|EmptyType|DataProviderScheme is an empty element that denotes a data provider scheme object.
7009 |DataSetTarget|EmptyType|DataSetTarget is an empty element that denotes a data set target object.
7010 |DataStructure|EmptyType|DataStructure is an empty element that denotes a data structure definition object.
7011 |Dimension|EmptyType|Dimension is an empty element that denotes a dimension object.
7012 |DimensionDescriptor|EmptyType|DimensionDescriptor is an empty element that denotes a dimension descriptor object.
7013 |DimensionDescriptorV aluesTarget|EmptyType|DimensionDescriptorValuesTarget is an empty element that denotes a dimension descriptor values target object.
7014 |GroupDimensionDescri ptor|EmptyType|GroupDimensionDescriptor is an empty element that denotes a group dimension descriptor object.
7015 |HierarchicalCode|EmptyType|HierarchicalCode is an empty element that denotes a hierarchical code object.
7016 |HierarchicalCodelist|EmptyType|HierarchicalCodelist is an empty element that denotes a hierarchical codelist object.
7017 |Hierarchy|EmptyType|Hierarchy is an empty element that denotes a hierarchy within a hiearcharchical codelist.
7018 |HybridCodelistMap|EmptyType|HybridCodelistMap is an empty element that denotes a hybrid codelist map object.
7019 |HybridCodeMap|EmptyType|HybridCodeMap is an empty element that denotes a hybrid code map object.
7020 |IdentifiableObjectTa rget|EmptyType|IdentifiableObjectTarget is an empty element that denotes an identifiable object target object.
7021 |Level|EmptyType|Level is an empty element that denotes a level object.
7022 |MeasureDescriptor|EmptyType|MeasureDescriptor is an empty element that denotes a measure descriptor object.
7023 |MeasureDimension|EmptyType|MeasureDimension is an empty element that denotes a measure dimension object.
7024 |Metadataflow|EmptyType|Metadataflow is an empty element that denotes a metadata flow object.
7025 |MetadataAttribute|EmptyType|MetadataAttribute is an empty element that denotes a metadata attribute object.
7026 |MetadataSet|EmptyType|MetadataSet is an empty element that denotes a metadata set object.
7027 |MetadataStructure|EmptyType|MetadataStructure is an empty element that denotes a metadata structure definition object.
7028 |MetadataTarget|EmptyType|MetadataTarget is an empty element that denotes a metadata target object.
7029 |NamePersonalisation|EmptyType|NamePersonalisation is an empty element that denotes a name personalisation object.
7030 |NamePersonalisationS cheme|EmptyType|NamePersonalisationScheme is an empty element that denotes a name personalisation scheme object.
7031 |OrganisationMap|EmptyType|OrganisationMap is an empty element that denotes an organisation map object.
7032 |OrganisationSchemeMa p|EmptyType|OrganisationSchemeMap is an empty element that denotes an organisation scheme map object.
7033 |OrganisationUnit|EmptyType|OrganisationUnit is an empty element that denotes an organisation unit object.
7034 |OrganisationUnitSche me|EmptyType|OrganisationUnitScheme is an empty element that denotes an organisation unit scheme object.
7035 |PrimaryMeasure|EmptyType|PrimaryMeasure is an empty element that denotes a primary measure object.
7036 |Process|EmptyType|Process is an empty element that denotes a process object.
7037 |ProcessStep|EmptyType|ProcessStep is an empty element that denotes a process step object.
7038 |ProvisionAgreement|EmptyType|ProvisionAgreement is an empty element that denotes a provision agreement object.
7039 |ReportingCategory|EmptyType|ReportingCategory is an empty element that denotes a reporting category object.
7040 |ReportingCategoryMap|EmptyType|ReportingCategoryMap is an empty element that denotes a reporting category map object.
7041 |ReportingTaxonomy|EmptyType|ReportingTaxonomy is an empty element that denotes a reporting taxonomy object.
7042 |ReportingTaxonomyMap|EmptyType|ReportingTaxonomyMap is an empty element that denotes a reporting taxonomy map object.
7043 |ReportPeriodTarget|EmptyType|ReportPeriodTarget is an empty element that denotes a report period target object.
7044 |ReportStructure|EmptyType|ReportStructure is an empty element that denotes a report structure object.
7045 |Ruleset|EmptyType|Ruleset is an empty element that denotes a ruleset object.
7046 |RulesetScheme|EmptyType|RulesetScheme is an empty element that denotes a ruleset scheme object.
7047 |StructureMap|EmptyType|StructureMap is an empty element that denotes a structure map object.
7048 |StructureSet|EmptyType|StructureSet is an empty element that denotes a structure set object.
7049 |TimeDimension|EmptyType|TimeDimension is an empty element that denotes a time dimension object.
7050 |Transformation|EmptyType|Transformation is an empty element that denotes a transformation object.
7051 |TransformationScheme|EmptyType|TransformationScheme is an empty element that denotes a transformation scheme object.
7052 |Transition|EmptyType|Transition is an empty element that denotes a transition object.
7053 |UserDefinedOperator|EmptyType|UserDefinedOperator is an empty element that denotes an user defined operator object.
7054 |UserDefinedOperatorS cheme|EmptyType|UserDefinedOperatorScheme is an empty element that denotes an user defined operator scheme object.
7055 |VtlMapping|EmptyType|VtlMapping is an empty element that denotes a VTL Mapping object.
7056 |VtlMappingScheme|EmptyType|VtlMappingScheme is an empty element that denotes a VTL mapping scheme object.
7057
7058 **MaintainableObjectTypeListType: **MaintainableObjectTypeListType provides a means for enumerating maintainable object types.
7059
7060 Derivation:
7061
7062 ObjectTypeListType (restriction)
7063 [[image:inherit.gif||height="9" width="9"]] MaintainableObjectTypeListType
7064
7065 Content:
7066
7067 (AgencyScheme?, AttachmentConstraint?, Categorisation?, CategoryScheme?, Codelist?, ConceptScheme?, ContentConstraint?, Dataflow?, DataConsumerScheme?, DataProviderScheme?, DataStructure?, HierarchicalCodelist?, Metadataflow?, MetadataStructure?, NamePersonalisationScheme?, OrganisationUnitScheme?, Process?, ProvisionAgreement?, ReportingTaxonomy?, RulesetScheme?, StructureSet?, TransformationScheme?, UserDefinedOperatorScheme?, VtlMappingScheme?)
7068
7069 Element Documentation:
7070
7071 |**Name**|**Type**|**Documentation**
7072 |AgencyScheme|EmptyType|AgencyScheme is an empty element that denotes an agency scheme object.
7073 |AttachmentConstraint|EmptyType|AttachmentConstraint is an empty element that denotes an attachment constraint object.
7074 |Categorisation|EmptyType|Categorisation is an empty element that denotes a categorisation object.
7075 |CategoryScheme|EmptyType|CategoryScheme is an empty element that denotes a category scheme object.
7076 |Codelist|EmptyType|Codelist is an empty element that denotes a code list object.
7077 |ConceptScheme|EmptyType|ConceptScheme is an empty element that denotes a concept scheme object.
7078 |ContentConstraint|EmptyType|ContentConstraint is an empty element that denotes a content constraint object.
7079 |Dataflow|EmptyType|Dataflow is an empty element that denotes a data flow object.
7080 |DataConsumerScheme|EmptyType|DataConsumerScheme is an empty element that denotes a data consumer scheme object.
7081 |DataProviderScheme|EmptyType|DataProviderScheme is an empty element that denotes a data provider scheme object.
7082 |DataStructure|EmptyType|DataStructure is an empty element that denotes a data structure definition object.
7083 |HierarchicalCodelist|EmptyType|HierarchicalCodelist is an empty element that denotes a hierarchical codelist object.
7084 |Metadataflow|EmptyType|Metadataflow is an empty element that denotes a metadata flow object.
7085 |MetadataStructure|EmptyType|MetadataStructure is an empty element that denotes a metadata structure definition object.
7086 |NamePersonalisationS cheme|EmptyType|NamePersonalisationScheme is an empty element that denotes a name personalisation scheme object.
7087 |OrganisationUnitSche me|EmptyType|OrganisationUnitScheme is an empty element that denotes an organisation unit scheme object.
7088 |Process|EmptyType|Process is an empty element that denotes a process object.
7089 |ProvisionAgreement|EmptyType|ProvisionAgreement is an empty element that denotes a provision agreement object.
7090 |ReportingTaxonomy|EmptyType|ReportingTaxonomy is an empty element that denotes a reporting taxonomy object.
7091 |RulesetScheme|EmptyType|RulesetScheme is an empty element that denotes a ruleset scheme object.
7092 |StructureSet|EmptyType|StructureSet is an empty element that denotes a structure set object.
7093 |TransformationScheme|EmptyType|TransformationScheme is an empty element that denotes a transformation scheme object.
7094 |UserDefinedOperatorS cheme|EmptyType|UserDefinedOperatorScheme is an empty element that denotes an user defined operator scheme object.
7095 |VtlMappingScheme|EmptyType|VtlMappingScheme is an empty element that denotes a VTL mapping scheme object.
7096
7097 === 2.1.4Simple Types ===
7098
7099 **AlphaNumericType: **AlphaNumericType is a reusable simple type that allows for only mixed-case alphabetical and numeric characters.
7100
7101 Derived by restriction of xs:string .
7102 Regular Expression Pattern: [A-Za-z0-9]+
7103
7104 **AlphaType: **AlphaType is a reusable simple type that allows for only mixed-case alphabetical characters. This is derived from the AlphaNumericType.
7105
7106 Derived by restriction of AlphaNumericType .
7107 Regular Expression Pattern: [A-Za-z]+
7108
7109 **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.
7110
7111 Derived by restriction of AlphaNumericType .
7112 Regular Expression Pattern: [0-9]+
7113
7114 **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.
7115
7116 Union of:
7117
7118 xs:gYear, xs:gYearMonth, xs:date, xs:dateTime, ReportingYearType, ReportingSemesterType, ReportingTrimesterType, ReportingQuarterType, ReportingMonthType, ReportingWeekType, ReportingDayType, TimeRangeType.
7119
7120 **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).
7121
7122 Union of:
7123
7124 xs:gYear, xs:gYearMonth, xs:date, xs:dateTime, ReportingYearType, ReportingSemesterType, ReportingTrimesterType, ReportingQuarterType, ReportingMonthType, ReportingWeekType, ReportingDayType.
7125
7126 **BasicTimePeriodType: **BasicTimePeriodType contains the basic dates and calendar periods. It is a combination of the Gregorian time periods and the date time type..
7127
7128 Union of:
7129
7130 xs:gYear, xs:gYearMonth, xs:date, xs:dateTime.
7131
7132 **GregorianTimePeriodType: **GregorianTimePeriodType defines the set of standard calendar periods in SDMX.
7133
7134 Union of:
7135
7136 xs:gYear, xs:gYearMonth, xs:date.
7137
7138 **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.
7139
7140 Union of:
7141
7142 ReportingYearType, ReportingSemesterType, ReportingTrimesterType, ReportingQuarterType, ReportingMonthType, ReportingWeekType, ReportingDayType.
7143
7144 **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.
7145
7146 Derived by restriction of xs:string .
7147 Regular Expression Pattern: \d{4}\-([ASTQ]\d{1}|[MW]\d{2}|[D]\d{3})(Z|((\+|\-)\d{2}:\d{2}))?
7148
7149 **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.
7150
7151 Derived by restriction of BaseReportPeriodType .
7152 Regular Expression Pattern: .+Z.{5}.*(\+|\-)(14:00|((0[0-9]|1[0-3]):[0-5][0-9])).{5}[^\+\-Z]+
7153
7154 **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.
7155
7156 Derived by restriction of ReportPeriodValidTimeZoneType .
7157 Regular Expression Pattern: .{5}A1.*
7158
7159 **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.
7160
7161 Derived by restriction of ReportPeriodValidTimeZoneType .
7162 Regular Expression Pattern: .{5}S[1-2].*
7163
7164 **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.
7165
7166 Derived by restriction of ReportPeriodValidTimeZoneType .
7167 Regular Expression Pattern: .{5}T[1-3].*
7168
7169 **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.
7170
7171 Derived by restriction of ReportPeriodValidTimeZoneType .
7172 Regular Expression Pattern: .{5}Q[1-4].*
7173
7174 **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).
7175
7176 Derived by restriction of ReportPeriodValidTimeZoneType .
7177 Regular Expression Pattern: .{5}M(0[1-9]|1[0-2]).*
7178
7179 **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).
7180
7181 Derived by restriction of ReportPeriodValidTimeZoneType .
7182 Regular Expression Pattern: .{5}W(0[1-9]|[1-4][0-9]|5[0-3]).*
7183
7184 **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).
7185
7186 Derived by restriction of ReportPeriodValidTimeZoneType .
7187 Regular Expression Pattern: .{5}D(0[0-9][1-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-6]).*
7188
7189 **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.
7190
7191 Derived by restriction of xs:string .
7192 Regular Expression Pattern: \d{4}\-\d{2}\-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?)?(Z|((\+|\-)\d{2}:\d{2}))?/P.+
7193
7194 **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.
7195
7196 Derived by restriction of BaseTimeRangeType .
7197 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]).+
7198
7199 **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.
7200
7201 Derived by restriction of RangeValidMonthDayType .
7202 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]).+
7203
7204 **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.
7205
7206 Derived by restriction of RangeValidLeapYearType .
7207 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]+/.+
7208
7209 **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.
7210
7211 Derived by restriction of RangeValidTimeType .
7212 Regular Expression Pattern: .+Z/.+.{10}.*(\+|\-)(14:00|((0[0-9]|1[0-3]):[0-5][0-9]))/.+.{10}[^\+\-Z]+
7213
7214 **TimeRangeValidDateDurationType: **TimeRangeValidDateDurationType is an abstract derivation of the RangeValidTimeType which validates that duration provided is generally valid, up to the time component.
7215
7216 Derived by restriction of RangeValidTimeZoneType .
7217 Regular Expression Pattern: .+/P(\d+Y)?(\d+M)?(\d+D)?(T.+)?
7218
7219 **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.
7220
7221 Derived by restriction of TimeRangeValidDateDurationType .
7222 Regular Expression Pattern: .+/P.*T(\d+H)?(\d+M)?(\d+(.\d+)?S)?.+/P[^T]+
7223
7224 **TimezoneType: **TimezoneType defines the pattern for a time zone. An offset of -14:00 to +14:00 or Z can be specified.
7225
7226 Derived by restriction of xs:string .
7227 Regular Expression Pattern: Z(\+|\-)(14:00|((0[0-9]|1[0-3]):[0-5][0-9]))
7228
7229 **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.
7230
7231 Union of:
7232
7233 MaxOccursNumberType, UnboundedCodeType.
7234
7235 **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.
7236
7237 Derived by restriction of xs:nonNegativeInteger .
7238 Minimum (inclusive): 1
7239 Fraction Digits: 0
7240
7241 **UnboundedCodeType: **UnboundedCodeType provides single textual value of "unbounded", for use in OccurentType.
7242
7243 Derived by restriction of xs:string .
7244
7245 Enumerations:
7246
7247 |**Value**|**Documentation**
7248 |unbounded|Object has no upper limit on occurrences.
7249
7250 **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.
7251
7252 Derived by restriction of xs:NMTOKEN .
7253
7254 Enumerations:
7255
7256 |**Value**|**Documentation**
7257 |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.
7258 |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.
7259 |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.
7260 |Information|Informational - data/metadata is being exchanged for informational purposes only, and not meant to update a system.
7261
7262 **WildCardValueType: **WildCardValueType is a single value code list, used to include the '%' character - indicating that an entire field is wild carded.
7263
7264 Derived by restriction of xs:string .
7265
7266 Enumerations:
7267
7268 |**Value**|**Documentation**
7269 |%|Indicates a wild card value.
7270
7271 **DimensionTypeType: **DimensionTypeType enumerates the sub-classes of a dimension.
7272
7273 Derived by restriction of xs:string .
7274
7275 Enumerations:
7276
7277 |**Value**|**Documentation**
7278 |Dimension|An ordinary dimension.
7279 |MeasureDimension|A measure dimension.
7280 |TimeDimension|The time dimension.
7281
7282 **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.
7283
7284 Derived by restriction of xs:string .
7285
7286 Enumerations:
7287
7288 |**Value**|**Documentation**
7289 |Allowed|The constraint contains the allowed values for attachable object.
7290 |Actual|The constraints contains the actual data present for the attachable object.
7291
7292 **SimpleOperatorType: **SimpleOperatorType provides an enumeration of simple operators to be applied to any value.
7293
7294 Derived by restriction of xs:string .
7295
7296 Enumerations:
7297
7298 |**Value**|**Documentation**
7299 |notEqual|(~!=) - value must not be equal to the value supplied.
7300 |equal|(=) - value must be exactly equal to the value supplied.
7301
7302 **RangeOperatorType: **RangeOperatorType provides an enumeration of range operators to be applied to an ordered value.
7303
7304 Derived by restriction of xs:string .
7305
7306 Enumerations:
7307
7308 |**Value**|**Documentation**
7309 |greaterThanOrEqual|(>=) - value must be greater than or equal to the value supplied.
7310 |lessThanOrEqual|(<=) - value must be less than or equal to the value supplied.
7311 |greaterThan|(>) - value must be greater than the value supplied.
7312 |lessThan|(<) - value must be less than the value supplied.
7313
7314 **TextSearchOperatorType: **TextSearchOperatorType provides an enumeration of text search operators.
7315
7316 Derived by restriction of xs:string .
7317
7318 Enumerations:
7319
7320 |**Value**|**Documentation**
7321 |contains|The text being searched must contain the supplied text.
7322 |startsWith|The text being searched must start with the supplied text.
7323 |endsWith|The text being searched must end with the supplied text.
7324 |doesNotContain|The text being searched cannot contain the supplied text.
7325 |doesNotStartWith|The text being searched cannot start with the supplied text.
7326 |doesNotEndWith|The text being searched cannot end with the supplied text.
7327
7328 **OrderedOperatorType: **OrderedOperatorType combines the SimpleOperatorType and the RangeOperatorType to provide a full range or operators for any ordered value.
7329
7330 Union of:
7331
7332 SimpleOperatorType, RangeOperatorType.
7333
7334 **TextOperatorType:**
7335
7336 Union of:
7337
7338 SimpleOperatorType, TextSearchOperatorType.
7339
7340 **TimeOperatorType: **TimeOperatorType derives from the OrderedOperatorType to remove the notEqual operator.
7341
7342 Derived by restriction of OrderedOperatorType .
7343
7344 Enumerations:
7345
7346 |**Value**|**Documentation**
7347 |equal|
7348 |greaterThanOrEqual|
7349 |lessThanOrEqual|
7350 |greaterThan|
7351 |lessThan|
7352
7353 **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".
7354
7355 Union of:
7356
7357 NCNameIDType, ObsDimensionsCodeType.
7358
7359 **ObsDimensionsCodeType: **ObsDimensionsCodeType is an enumeration containing the values "TimeDimension" and "AllDimensions"
7360
7361 Derived by restriction of xs:string .
7362
7363 Enumerations:
7364
7365 |**Value**|**Documentation**
7366 |AllDimensions|AllDimensions notes that the cross sectional format shall be flat; that is all dimensions should be contained at the observation level.
7367 |TIME_PERIOD|TIME_PERIOD refers to the fixed identifier for the time dimension.
7368
7369 **DataType: **DataTypeType provides an enumerated list of the types of data formats allowed as the for the representation of an object.
7370
7371 Derived by restriction of xs:NMTOKEN .
7372
7373 Enumerations:
7374
7375 |**Value**|**Documentation**
7376 |String|A string datatype corresponding to W3C XML Schema's xs:string datatype.
7377 |Alpha|A string datatype which only allows for the simple aplhabetic charcter set of A-Z, a-z.
7378 |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.
7379 |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.
7380 |BigInteger|An integer datatype corresponding to W3C XML Schema's xs:integer datatype.
7381 |Integer|An integer datatype corresponding to W3C XML Schema's xs:int datatype.
7382 |Long|A numeric datatype corresponding to W3C XML Schema's xs:long datatype.
7383 |Short|A numeric datatype corresponding to W3C XML Schema's xs:short datatype.
7384 |Decimal|A numeric datatype corresponding to W3C XML Schema's xs:decimal datatype.
7385 |Float|A numeric datatype corresponding to W3C XML Schema's xs:float datatype.
7386 |Double|A numeric datatype corresponding to W3C XML Schema's xs:double datatype.
7387 |Boolean|A datatype corresponding to W3C XML Schema's xs:boolean datatype.
7388 |URI|A datatype corresponding to W3C XML Schema's xs:anyURI datatype.
7389 |Count|A simple incrementing Integer type. The isSequence facet must be set to true, and the interval facet must be set to "1".
7390 |InclusiveValueRange|This value indicates that the startValue and endValue attributes provide the inclusive boundaries of a numeric range of type xs:decimal.
7391 |ExclusiveValueRange|This value indicates that the startValue and endValue attributes provide the exclusive boundaries of a numeric range, of type xs:decimal.
7392 |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.
7393 |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.
7394 |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.
7395 |BasicTimePeriod|BasicTimePeriod time periods is a superset of the Gregorian time periods and a date time.
7396 |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.
7397 |GregorianYear|A Gregorian time period corresponding to W3C XML Schema's xs:gYear datatype, which is based on ISO-8601.
7398 |GregorianYearMonth|A time datatype corresponding to W3C XML Schema's xs:gYearMonth datatype, which is based on ISO-8601.
7399 |GregorianDay|A time datatype corresponding to W3C XML Schema's xs:date datatype, which is based on ISO-8601.
7400 |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.
7401 |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.
7402 |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.
7403 |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.
7404 |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.
7405 |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.
7406 |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.
7407 |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.
7408 |DateTime|A time datatype corresponding to W3C XML Schema's xs:dateTime datatype.
7409 |TimeRange|TimeRange defines a time period by providing a distinct start (date or date time) and a duration.
7410 |Month|A time datatype corresponding to W3C XML Schema's xs:gMonth datatype.
7411 |MonthDay|A time datatype corresponding to W3C XML Schema's xs:gMonthDay datatype.
7412 |Day|A time datatype corresponding to W3C XML Schema's xs:gDay datatype.
7413 |Time|A time datatype corresponding to W3C XML Schema's xs:time datatype.
7414 |Duration|A time datatype corresponding to W3C XML Schema's xs:duration datatype.
7415 |XHTML|This value indicates that the content of the component can contain XHTML markup.
7416 |KeyValues|This value indicates that the content of the component will be data key (a set of dimension references and values for the dimensions).
7417 |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.
7418 |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.
7419 |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.
7420
7421 **BasicComponentDataType: **BasicComponentDataType provides an enumerated list of the types of characters allowed in the textType attribute for all non-target object components.
7422
7423 Derived by restriction of DataType .
7424
7425 Enumerations:
7426
7427 |**Value**|**Documentation**
7428 |String|A string datatype corresponding to W3C XML Schema's xs:string datatype.
7429 |Alpha|A string datatype which only allows for the simple aplhabetic charcter set of A-Z, a-z.
7430 |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.
7431 |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.
7432 |BigInteger|An integer datatype corresponding to W3C XML Schema's xs:integer datatype.
7433 |Integer|An integer datatype corresponding to W3C XML Schema's xs:int datatype.
7434 |Long|A numeric datatype corresponding to W3C XML Schema's xs:long datatype.
7435 |Short|A numeric datatype corresponding to W3C XML Schema's xs:short datatype.
7436 |Decimal|A numeric datatype corresponding to W3C XML Schema's xs:decimal datatype.
7437 |Float|A numeric datatype corresponding to W3C XML Schema's xs:float datatype.
7438 |Double|A numeric datatype corresponding to W3C XML Schema's xs:double datatype.
7439 |Boolean|A datatype corresponding to W3C XML Schema's xs:boolean datatype.
7440 |URI|A datatype corresponding to W3C XML Schema's xs:anyURI datatype.
7441 |Count|A simple incrementing Integer type. The isSequence facet must be set to true, and the interval facet must be set to "1".
7442 |InclusiveValueRange|This value indicates that the startValue and endValue attributes provide the inclusive boundaries of a numeric range of type xs:decimal.
7443 |ExclusiveValueRange|This value indicates that the startValue and endValue attributes provide the exclusive boundaries of a numeric range, of type xs:decimal.
7444 |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.
7445 |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.
7446 |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.
7447 |BasicTimePeriod|BasicTimePeriod time periods is a superset of the Gregorian time periods and a date time.
7448 |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.
7449 |GregorianYear|A Gregorian time period corresponding to W3C XML Schema's xs:gYear datatype, which is based on ISO-8601.
7450 |GregorianYearMonth|A time datatype corresponding to W3C XML Schema's xs:gYearMonth datatype, which is based on ISO-8601.
7451 |GregorianDay|A time datatype corresponding to W3C XML Schema's xs:date datatype, which is based on ISO-8601.
7452 |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.
7453 |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.
7454 |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.
7455 |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.
7456 |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.
7457 |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.
7458 |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.
7459 |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.
7460 |DateTime|A time datatype corresponding to W3C XML Schema's xs:dateTime datatype.
7461 |TimeRange|TimeRange defines a time period by providing a distinct start (date or date time) and a duration.
7462 |Month|A time datatype corresponding to W3C XML Schema's xs:gMonth datatype.
7463 |MonthDay|A time datatype corresponding to W3C XML Schema's xs:gMonthDay datatype.
7464 |Day|A time datatype corresponding to W3C XML Schema's xs:gDay datatype.
7465 |Time|A time datatype corresponding to W3C XML Schema's xs:time datatype.
7466 |Duration|A time datatype corresponding to W3C XML Schema's xs:duration datatype.
7467 |XHTML|This value indicates that the content of the component can contain XHTML markup.
7468
7469 **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.
7470
7471 Derived by restriction of BasicComponentDataType .
7472
7473 Enumerations:
7474
7475 |**Value**|**Documentation**
7476 |String|A string datatype corresponding to W3C XML Schema's xs:string datatype.
7477 |Alpha|A string datatype which only allows for the simple aplhabetic charcter set of A-Z, a-z.
7478 |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.
7479 |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.
7480 |BigInteger|An integer datatype corresponding to W3C XML Schema's xs:integer datatype.
7481 |Integer|An integer datatype corresponding to W3C XML Schema's xs:int datatype.
7482 |Long|A numeric datatype corresponding to W3C XML Schema's xs:long datatype.
7483 |Short|A numeric datatype corresponding to W3C XML Schema's xs:short datatype.
7484 |Decimal|A numeric datatype corresponding to W3C XML Schema's xs:decimal datatype.
7485 |Float|A numeric datatype corresponding to W3C XML Schema's xs:float datatype.
7486 |Double|A numeric datatype corresponding to W3C XML Schema's xs:double datatype.
7487 |Boolean|A datatype corresponding to W3C XML Schema's xs:boolean datatype.
7488 |URI|A datatype corresponding to W3C XML Schema's xs:anyURI datatype.
7489 |Count|A simple incrementing Integer type. The isSequence facet must be set to true, and the interval facet must be set to "1".
7490 |InclusiveValueRange|This value indicates that the startValue and endValue attributes provide the inclusive boundaries of a numeric range of type xs:decimal.
7491 |ExclusiveValueRange|This value indicates that the startValue and endValue attributes provide the exclusive boundaries of a numeric range, of type xs:decimal.
7492 |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.
7493 |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.
7494 |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.
7495 |BasicTimePeriod|BasicTimePeriod time periods is a superset of the Gregorian time periods and a date time.
7496 |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.
7497 |GregorianYear|A Gregorian time period corresponding to W3C XML Schema's xs:gYear datatype, which is based on ISO-8601.
7498 |GregorianYearMonth|A time datatype corresponding to W3C XML Schema's xs:gYearMonth datatype, which is based on ISO-8601.
7499 |GregorianDay|A time datatype corresponding to W3C XML Schema's xs:date datatype, which is based on ISO-8601.
7500 |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.
7501 |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.
7502 |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.
7503 |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.
7504 |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.
7505 |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.
7506 |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.
7507 |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.
7508 |DateTime|A time datatype corresponding to W3C XML Schema's xs:dateTime datatype.
7509 |TimeRange|TimeRange defines a time period by providing a distinct start (date or date time) and a duration.
7510 |Month|A time datatype corresponding to W3C XML Schema's xs:gMonth datatype.
7511 |MonthDay|A time datatype corresponding to W3C XML Schema's xs:gMonthDay datatype.
7512 |Day|A time datatype corresponding to W3C XML Schema's xs:gDay datatype.
7513 |Time|A time datatype corresponding to W3C XML Schema's xs:time datatype.
7514 |Duration|A time datatype corresponding to W3C XML Schema's xs:duration datatype.
7515
7516 **TimeDataType: **TimeDataType restricts SimpleDataType to specify the allowable data types for representing a time value.
7517
7518 Derived by restriction of SimpleDataType .
7519
7520 Enumerations:
7521
7522 |**Value**|**Documentation**
7523 |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.
7524 |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.
7525 |BasicTimePeriod|BasicTimePeriod time periods is a superset of the Gregorian time periods and a date time.
7526 |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.
7527 |GregorianYear|A Gregorian time period corresponding to W3C XML Schema's xs:gYear datatype, which is based on ISO-8601.
7528 |GregorianYearMonth|A time datatype corresponding to W3C XML Schema's xs:gYearMonth datatype, which is based on ISO-8601.
7529 |GregorianDay|A time datatype corresponding to W3C XML Schema's xs:date datatype, which is based on ISO-8601.
7530 |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.
7531 |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.
7532 |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.
7533 |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.
7534 |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.
7535 |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.
7536 |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.
7537 |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.
7538 |DateTime|A time datatype corresponding to W3C XML Schema's xs:dateTime datatype.
7539 |TimeRange|TimeRange defines a time period by providing a distinct start (date or date time) and a duration.
7540
7541 **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, _, -, $.
7542
7543 Derived by restriction of xs:string .
7544 Regular Expression Pattern: [A-Za-z0-9_@$\-]+(\.[A-Za-z0-9_@$\-]+)*
7545
7546 **TwoLevelIDType: **TwoLevelIDType defines an identifier with exactly two levels.
7547
7548 Derived by restriction of NestedIDType .
7549 Regular Expression Pattern: [A-Za-z0-9_@$\-]+\.[A-Za-z0-9_@$\-]+
7550
7551 **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, _, -, $.
7552
7553 Derived by restriction of NestedIDType .
7554 Regular Expression Pattern: [A-Za-z0-9_@$\-]+
7555
7556 **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.
7557
7558 Derived by restriction of IDType .
7559 Regular Expression Pattern: [A-Za-z][A-Za-z0-9_\-]*
7560
7561 **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.
7562
7563 Derived by restriction of NestedIDType .
7564 Regular Expression Pattern: [A-Za-z][A-Za-z0-9_\-]*(\.[A-Za-z][A-Za-z0-9_\-]*)*
7565
7566 **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).
7567
7568 Derived by restriction of NestedNCNameIDType .
7569 Regular Expression Pattern: [A-Za-z][A-Za-z0-9_\-]*
7570
7571 **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.
7572
7573 Derived by restriction of xs:string .
7574 Regular Expression Pattern: [0-9]+(\.[0-9]+)*
7575
7576 **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.
7577
7578 Union of:
7579
7580 VersionType, LateBoundVersionType.
7581
7582 **LateBoundVersionType: **LateBoundVersionType is a single value code list, used to include the '*' character - indicating that the latest version of an object is required.
7583
7584 Derived by restriction of xs:string .
7585
7586 Enumerations:
7587
7588 |**Value**|**Documentation**
7589 |*|Indicates that the latest version of an object is requested.
7590
7591 **PackageTypeCodelistType: **PackageTypeCodelistType provides an enumeration of all SDMX package names.
7592
7593 Derived by restriction of xs:string .
7594
7595 Enumerations:
7596
7597 |**Value**|**Documentation**
7598 |base|
7599 |datastructure|
7600 |metadatastructure|
7601 |process|
7602 |registry|
7603 |mapping|
7604 |codelist|
7605 |categoryscheme|
7606 |conceptscheme|
7607 |transformation|
7608
7609 **ItemSchemePackageTypeCodelistType: **ItemSchemePackageTypeCodelistType provides an enumeration of all SDMX packages which contain item schemes.
7610
7611 Derived by restriction of PackageTypeCodelistType .
7612
7613 Enumerations:
7614
7615 |**Value**|**Documentation**
7616 |base|
7617 |codelist|
7618 |categoryscheme|
7619 |conceptscheme|
7620 |transformation|
7621
7622 **StructurePackageTypeCodelistType: **StructurePackageTypeCodelistType provides an enumeration of all SDMX packages which contain structure and structure usages.
7623
7624 Derived by restriction of PackageTypeCodelistType .
7625
7626 Enumerations:
7627
7628 |**Value**|**Documentation**
7629 |datastructure|
7630 |metadatastructure|
7631
7632 **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.
7633
7634 Derived by restriction of xs:string .
7635
7636 Enumerations:
7637
7638 |**Value**|**Documentation**
7639 |Any|
7640 |Agency|
7641 |AgencyScheme|
7642 |AttachmentConstraint|
7643 |Attribute|
7644 |AttributeDescriptor|
7645 |Categorisation|
7646 |Category|
7647 |CategorySchemeMap|
7648 |CategoryScheme|
7649 |Code|
7650 |CodeMap|
7651 |Codelist|
7652 |CodelistMap|
7653 |ComponentMap|
7654 |Concept|
7655 |ConceptMap|
7656 |ConceptScheme|
7657 |ConceptSchemeMap|
7658 |Constraint|
7659 |ConstraintTarget|
7660 |ContentConstraint|
7661 |CustomType|
7662 |CustomTypeScheme|
7663 |Dataflow|
7664 |DataConsumer|
7665 |DataConsumerScheme|
7666 |DataProvider|
7667 |DataProviderScheme|
7668 |DataSetTarget|
7669 |DataStructure|
7670 |DefinitionScheme|
7671 |Dimension|
7672 |DimensionDescriptor|
7673 |DimensionDescriptorValuesTarget|
7674 |GroupDimensionDescriptor|
7675 |HierarchicalCode|
7676 |HierarchicalCodelist|
7677 |Hierarchy|
7678 |HybridCodelistMap|
7679 |HybridCodeMap|
7680 |IdentifiableObjectTarget|
7681 |Level|
7682 |MeasureDescriptor|
7683 |MeasureDimension|
7684 |Metadataflow|
7685 |MetadataAttribute|
7686 |MetadataSet|
7687 |MetadataStructure|
7688 |MetadataTarget|
7689 |NamePersonalisation|
7690 |NamePersonalisationScheme|
7691 |Organisation|
7692 |OrganisationMap|
7693 |OrganisationScheme|
7694 |OrganisationSchemeMap|
7695 |OrganisationUnit|
7696 |OrganisationUnitScheme|
7697 |PrimaryMeasure|
7698 |Process|
7699 |ProcessStep|
7700 |ProvisionAgreement|
7701 |ReportingCategory|
7702 |ReportingCategoryMap|
7703 |ReportingTaxonomy|
7704 |ReportingTaxonomyMap|
7705 |ReportingYearStartDay|
7706 |ReportPeriodTarget|
7707 |ReportStructure|
7708 |Ruleset|
7709 |RulesetScheme|
7710 |StructureMap|
7711 |StructureSet|
7712 |TimeDimension|
7713 |Transformation|
7714 |TransformationScheme|
7715 |Transition|
7716 |UserDefinedOperator|
7717 |UserDefinedOperatorScheme|
7718 |VtlMapping|
7719 |VtlMappingScheme|
7720
7721 **MaintainableTypeCodelistType: **MaintainableTypeCodelistType provides an enumeration of all maintainable objects.
7722
7723 Derived by restriction of ObjectTypeCodelistType .
7724
7725 Enumerations:
7726
7727 |**Value**|**Documentation**
7728 |Any|
7729 |AgencyScheme|
7730 |AttachmentConstraint|
7731 |Categorisation|
7732 |CategoryScheme|
7733 |Codelist|
7734 |ConceptScheme|
7735 |Constraint|
7736 |ContentConstraint|
7737 |CustomTypeScheme|
7738 |Dataflow|
7739 |DataConsumerScheme|
7740 |DataProviderScheme|
7741 |DataStructure|
7742 |DefinitionScheme|
7743 |HierarchicalCodelist|
7744 |Metadataflow|
7745 |MetadataStructure|
7746 |NamePersonalisationScheme|
7747 |OrganisationScheme|
7748 |OrganisationUnitScheme|
7749 |Process|
7750 |ProvisionAgreement|
7751 |ReportingTaxonomy|
7752 |RulesetScheme|
7753 |StructureSet|
7754 |TransformationScheme|
7755 |UserDefinedOperatorScheme|
7756 |VtlMappingScheme|
7757
7758 **ConcreteMaintainableTypeCodelistType: **ConcreteMaintainableTypeCodelistType provides an enumeration of all concrete maintainable objects.
7759
7760 Derived by restriction of MaintainableTypeCodelistType .
7761
7762 Enumerations:
7763
7764 |**Value**|**Documentation**
7765 |AgencyScheme|
7766 |AttachmentConstraint|
7767 |Categorisation|
7768 |CategoryScheme|
7769 |Codelist|
7770 |ConceptScheme|
7771 |ContentConstraint|
7772 |CustomTypeScheme|
7773 |Dataflow|
7774 |DataConsumerScheme|
7775 |DataProviderScheme|
7776 |DataStructure|
7777 |HierarchicalCodelist|
7778 |Metadataflow|
7779 |MetadataStructure|
7780 |NamePersonalisationScheme|
7781 |OrganisationUnitScheme|
7782 |Process|
7783 |ProvisionAgreement|
7784 |ReportingTaxonomy|
7785 |RulesetScheme|
7786 |StructureSet|
7787 |TransformationScheme|
7788 |UserDefinedOperatorScheme|
7789 |VtlMappingScheme|
7790
7791 **CodelistTypeCodelistType: **CodelistTypeCodelistType provides an enumeration of all codelist objects.
7792
7793 Derived by restriction of MaintainableTypeCodelistType .
7794
7795 Enumerations:
7796
7797 |**Value**|**Documentation**
7798 |Codelist|
7799 |HierarchicalCodelist|
7800
7801 **CodeTypeCodelistType: **CodeTypeCodelistType provides an enumeration of all code objects.
7802
7803 Derived by restriction of ObjectTypeCodelistType .
7804
7805 Enumerations:
7806
7807 |**Value**|**Documentation**
7808 |Code|
7809 |HierarchicalCode|
7810
7811 **ConstraintTypeCodelistType: **ConstraintTypeCodelistType provides an enumeration of all constraint objects.
7812
7813 Derived by restriction of MaintainableTypeCodelistType .
7814
7815 Enumerations:
7816
7817 |**Value**|**Documentation**
7818 |AttachmentConstraint|
7819 |ContentConstraint|
7820
7821 **ItemSchemeTypeCodelistType: **ItemSchemeTypeCodelistType provides an enumeration of all item scheme objects.
7822
7823 Derived by restriction of MaintainableTypeCodelistType .
7824
7825 Enumerations:
7826
7827 |**Value**|**Documentation**
7828 |AgencyScheme|
7829 |CategoryScheme|
7830 |Codelist|
7831 |ConceptScheme|
7832 |CustomTypeScheme|
7833 |DataConsumerScheme|
7834 |DataProviderScheme|
7835 |NamePersonalisationScheme|
7836 |OrganisationUnitScheme|
7837 |ReportingTaxonomy|
7838 |RulesetScheme|
7839 |TransformationScheme|
7840 |UserDefinedOperatorScheme|
7841 |VtlMappingScheme|
7842
7843 **DefinitionSchemeTypeCodelistType: **DefinitionSchemeTypeCodelistType provides an enumeration of all definition scheme objects.
7844
7845 Derived by restriction of ItemSchemeTypeCodelistType .
7846
7847 Enumerations:
7848
7849 |**Value**|**Documentation**
7850 |CustomTypeScheme|
7851 |NamePersonalisationScheme|
7852 |RulesetScheme|
7853 |TransformationScheme|
7854 |UserDefinedOperatorScheme|
7855
7856 **OrganisationSchemeTypeCodelistType: **OrganisationSchemeTypeCodelistType provides an enumeration of all organisation scheme objects.
7857
7858 Derived by restriction of ItemSchemeTypeCodelistType .
7859
7860 Enumerations:
7861
7862 |**Value**|**Documentation**
7863 |AgencyScheme|
7864 |DataConsumerScheme|
7865 |DataProviderScheme|
7866 |OrganisationUnitScheme|
7867
7868 **OrganisationTypeCodelistType: **OrganisationTypeCodelistType provides an enumeration of all organisation objects.
7869
7870 Derived by restriction of ItemTypeCodelistType .
7871
7872 Enumerations:
7873
7874 |**Value**|**Documentation**
7875 |Agency|
7876 |DataConsumer|
7877 |DataProvider|
7878 |OrganisationUnit|
7879
7880 **StructureOrUsageTypeCodelistType: **StructureOrUsageTypeCodelistType provides an enumeration all structure and structure usage objects
7881
7882 Derived by restriction of MaintainableTypeCodelistType .
7883
7884 Enumerations:
7885
7886 |**Value**|**Documentation**
7887 |Dataflow|
7888 |DataStructure|
7889 |Metadataflow|
7890 |MetadataStructure|
7891
7892 **StructureTypeCodelistType: **StructureTypeCodelistType provides an enumeration all structure objects
7893
7894 Derived by restriction of StructureOrUsageTypeCodelistType .
7895
7896 Enumerations:
7897
7898 |**Value**|**Documentation**
7899 |DataStructure|
7900 |MetadataStructure|
7901
7902 **StructureUsageTypeCodelistType: **StructureUsageTypeCodelistType provides an enumeration all structure usage objects
7903
7904 Derived by restriction of StructureOrUsageTypeCodelistType .
7905
7906 Enumerations:
7907
7908 |**Value**|**Documentation**
7909 |Dataflow|
7910 |Metadataflow|
7911
7912 **ItemTypeCodelistType: **ItemTypeCodelistType provides an enumeration of all item objects.
7913
7914 Derived by restriction of ObjectTypeCodelistType .
7915
7916 Enumerations:
7917
7918 |**Value**|**Documentation**
7919 |Agency|
7920 |Category|
7921 |Code|
7922 |Concept|
7923 |CustomType|
7924 |DataConsumer|
7925 |DataProvider|
7926 |NamePersonalisation|
7927 |OrganisationUnit|
7928 |ReportingCategory|
7929 |Ruleset|
7930 |Transformation|
7931 |UserDefinedOperator|
7932 |VtlMapping|
7933
7934 **ComponentListTypeCodelistType: **ComponentListTypeCodelistType provides an enumeration of all component list objects.
7935
7936 Derived by restriction of ObjectTypeCodelistType .
7937
7938 Enumerations:
7939
7940 |**Value**|**Documentation**
7941 |AttributeDescriptor|
7942 |DimensionDescriptor|
7943 |GroupDimensionDescriptor|
7944 |MeasureDescriptor|
7945 |MetadataTarget|
7946 |ReportStructure|
7947
7948 **ComponentTypeCodelistType: **ComponentTypeCodelistType provides an enumeration of all component objects.
7949
7950 Derived by restriction of ObjectTypeCodelistType .
7951
7952 Enumerations:
7953
7954 |**Value**|**Documentation**
7955 |Attribute|
7956 |ConstraintTarget|
7957 |DataSetTarget|
7958 |Dimension|
7959 |IdentifiableObjectTarget|
7960 |DimensionDescriptorValuesTarget|
7961 |MeasureDimension|
7962 |MetadataAttribute|
7963 |PrimaryMeasure|
7964 |ReportingYearStartDay|
7965 |ReportPeriodTarget|
7966 |TimeDimension|
7967
7968 **DataStructureComponentTypeCodelistType: **DataStructureComponentTypeCodelistType provides an enumeration of all data structure component objects, except for the primary measure.
7969
7970 Derived by restriction of ComponentTypeCodelistType .
7971
7972 Enumerations:
7973
7974 |**Value**|**Documentation**
7975 |Attribute|
7976 |Dimension|
7977 |MeasureDimension|
7978 |PrimaryMeasure|
7979 |ReportingYearStartDay|
7980 |TimeDimension|
7981
7982 **DimensionEumerationSchemeTypeCodelistType: **DimensionEumerationSchemeTypeCodelistType provides an enumeration of all item schemes which are allowable as the representation of a data structure definition component.
7983
7984 Derived by restriction of ItemSchemeTypeCodelistType .
7985
7986 Enumerations:
7987
7988 |**Value**|**Documentation**
7989 |Codelist|
7990 |ConceptScheme|
7991
7992 **MetadataStructureComponentTypeCodelistType: **MetadataStructureComponentTypeCodelistType provides an enumeration of all metadata structure component objects.
7993
7994 Derived by restriction of ComponentTypeCodelistType .
7995
7996 Enumerations:
7997
7998 |**Value**|**Documentation**
7999 |ConstraintTarget|
8000 |DataSetTarget|
8001 |IdentifiableObjectTarget|
8002 |DimensionDescriptorValuesTarget|
8003 |MetadataAttribute|
8004 |ReportPeriodTarget|
8005
8006 **DimensionTypeCodelistType: **DimensionTypeCodelistType provides an enumeration of all dimension objects.
8007
8008 Derived by restriction of ComponentTypeCodelistType .
8009
8010 Enumerations:
8011
8012 |**Value**|**Documentation**
8013 |Dimension|
8014 |MeasureDimension|
8015 |TimeDimension|
8016
8017 **TargetObjectTypeCodelistType: **TargetObjectTypeCodelistType provides an enumeration of all target object objects.
8018
8019 Derived by restriction of ComponentTypeCodelistType .
8020
8021 Enumerations:
8022
8023 |**Value**|**Documentation**
8024 |ConstraintTarget|
8025 |DataSetTarget|
8026 |IdentifiableObjectTarget|
8027 |DimensionDescriptorValuesTarget|
8028 |ReportPeriodTarget|
© Semantic R&D Group, 2026