Skip to Content

Wiki source code of Part II.Common

Version 13.1 by Helena K. on 2025/06/29 22:11
Show last authors
1 {{box title="**Contents**"}}
2 {{toc/}}
3 {{/box}}
4
5 = 1. Introduction =
6
7 The common namespace defines a collection of constructs that are reused across the various [[components>>doc:sdmx:Glossary.Component.WebHome]] of [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]]. Most important of these are the referencing mechanism. The goal of the reference construct was to define a generic structure that could be processed uniformly regardless of the context where the reference was used. But it was also important that references be required to be complete whenever possible.
8
9 Any object can be referenced either explicitly with a URN or by a set of complete reference fields. To meet the previously stated requirements, and very general mechanism was created based on the URN structure of [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] objects for these reference fields.
10
11 There was also a requirement that the references be able to be refined to meet particular needs outside of the common namespace. An example of this is in the metadata structure specific schemas. It is a requirement that if an target object is specified as having to come from a particular scheme, that a type based on the reference structure be created that enforced the requirement.
12
13 Typically, this would not have been an issues as all of the [[components>>doc:sdmx:Glossary.Component.WebHome]] which make up the references are of atomic types, and therefore can be expressed as XML [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] which are easily refined and restricted since the XML Schema design principles in [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] always treats [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] as unqualified.
14
15 However, the requirement to allow both a URN and/or a complete set of reference field necessitate that these properties be contained in elements. The fact that they are elements typically would mean that the only way a refinement outside of the namespace could happen was if the element were global and allowed for substitutions. This however would mean that every distinct type of referenced object would have a unique set of elements. This moved away from the requirement that the structure be easy to process regardless of context.
16
17 The solution to this problem was to deviate from the normal [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] XML Schema design principle of always using qualified elements and allowing for these to be unqualified. Doing so allows other namespace to derive from these types and place further restrictions on what can be referenced. The deviation from this principle was justified in that it met the all of the requirements and was not deemed to major of a shift since these properties normally would have been expressed as unqualified [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] if it weren't for the complete reference requirement.
18
19 = 2. Schema Documentation =
20
21 == 2.1 Common Namespace ==
22
23 **http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/common**
24
25 === 2.1.1 Summary ===
26
27 Referenced Namespaces:
28
29 |**Namespace**|**Prefix**
30 | |
31 |http:~/~/www.w3.org/1999/xhtml|
32 |http:~/~/www.w3.org/2001/XMLSchema|xs
33
34 Contents:
35
36 81 Global Elements
37 292 Complex Types
38 77 Simple Types
39
40 === 2.1.2 Global Elements ===
41
42 **Name (TextType): **Name is a reusable element, used for providing a human-readable name for an object.
43
44 **Description (TextType): **Description is a reusable element, used for providing a longer human-readable description of an object.
45
46 **Text (TextType): **Text is a reusable element, used for providing a language specific text value for general purposes (i.e. not for a name or description).
47
48 **StructuredText (XHTMLType): **StructuredText is a reusable element, used for providing a language specific text value structured as XHTML.
49
50 **Annotations (AnnotationsType): **Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
51
52 **Any (EmptyType): **Any is an empty element that denotes an object of any type.
53
54 **Agency (EmptyType): **Agency is an empty element that denotes an agency object.
55
56 **AgencyScheme (EmptyType): **AgencyScheme is an empty element that denotes an agency scheme object.
57
58 **AttachmentConstraint (EmptyType): **AttachmentConstraint is an empty element that denotes an attachment constraint object.
59
60 **Attribute (EmptyType): **Attribute is an empty element that denotes an attribute object.
61
62 **AttributeDescriptor (EmptyType): **AttributeDescriptor is an empty element that denotes an attribute descriptor object.
63
64 **Categorisation (EmptyType): **Categorisation is an empty element that denotes a categorisation object.
65
66 **Category (EmptyType): **Category is an empty element that denotes a category object.
67
68 **CategorySchemeMap (EmptyType): **CategorySchemeMap is an empty element that denotes a category scheme map object.
69
70 **CategoryScheme (EmptyType): **CategoryScheme is an empty element that denotes a category scheme object.
71
72 **Code (EmptyType): **Code is an empty element that denotes a code object.
73
74 **CodeMap (EmptyType): **CodeMap is an empty element that denotes a code map object.
75
76 **Codelist (EmptyType): **Codelist is an empty element that denotes a code list object.
77
78 **CodelistMap (EmptyType): **CodelistMap is an empty element that denotes a code list map object.
79
80 **ComponentMap (EmptyType): **ComponentMap is an empty element that denotes a component map object.
81
82 **Concept (EmptyType): **Concept is an empty element that denotes a concept object.
83
84 **ConceptMap (EmptyType): **ConceptMap is an empty element that denotes a concept map object.
85
86 **ConceptScheme (EmptyType): **ConceptScheme is an empty element that denotes a concept scheme object.
87
88 **ConceptSchemeMap (EmptyType): **ConceptSchemeMap is an empty element that denotes a concept scheme map object.
89
90 **ConstraintTarget (EmptyType): **ConstraintTarget is an empty element that denotes a constraint target object.
91
92 **ContentConstraint (EmptyType): **ContentConstraint is an empty element that denotes a content constraint object.
93
94 **CustomType (EmptyType): **CustomType is an empty element that denotes a custom type object.
95
96 **CustomTypeScheme (EmptyType): **CustomTypeScheme is an empty element that denotes a custom type scheme object.
97
98 **Dataflow (EmptyType): **Dataflow is an empty element that denotes a data flow object.
99
100 **DataConsumer (EmptyType): **DataConsumer is an empty element that denotes a data consumer object.
101
102 **DataConsumerScheme (EmptyType): **DataConsumerScheme is an empty element that denotes a data consumer scheme object.
103
104 **DataProvider (EmptyType): **DataProvider is an empty element that denotes a data provider object.
105
106 **DataProviderScheme (EmptyType): **DataProviderScheme is an empty element that denotes a data provider scheme object.
107
108 **DataSetTarget (EmptyType): **DataSetTarget is an empty element that denotes a data set target object.
109
110 **DataStructure (EmptyType): **DataStructure is an empty element that denotes a data structure definition object.
111
112 **Dimension (EmptyType): **Dimension is an empty element that denotes a dimension object.
113
114 **DimensionDescriptor (EmptyType): **DimensionDescriptor is an empty element that denotes a dimension descriptor object.
115
116 **DimensionDescriptorValuesTarget (EmptyType): **DimensionDescriptorValuesTarget is an empty element that denotes a dimension descriptor values target object.
117
118 **GroupDimensionDescriptor (EmptyType): **GroupDimensionDescriptor is an empty element that denotes a group dimension descriptor object.
119
120 **HierarchicalCode (EmptyType): **HierarchicalCode is an empty element that denotes a hierarchical code object.
121
122 **HierarchicalCodelist (EmptyType): **HierarchicalCodelist is an empty element that denotes a hierarchical codelist object.
123
124 **Hierarchy (EmptyType): **Hierarchy is an empty element that denotes a hierarchy within a hiearcharchical codelist.
125
126 **HybridCodelistMap (EmptyType): **HybridCodelistMap is an empty element that denotes a hybrid codelist map object.
127
128 **HybridCodeMap (EmptyType): **HybridCodeMap is an empty element that denotes a hybrid code map object.
129
130 **IdentifiableObjectTarget (EmptyType): **IdentifiableObjectTarget is an empty element that denotes an identifiable object target object.
131
132 **Level (EmptyType): **Level is an empty element that denotes a level object.
133
134 **MeasureDescriptor (EmptyType): **MeasureDescriptor is an empty element that denotes a measure descriptor object.
135
136 **MeasureDimension (EmptyType): **MeasureDimension is an empty element that denotes a measure dimension object.
137
138 **Metadataflow (EmptyType): **Metadataflow is an empty element that denotes a metadata flow object.
139
140 **MetadataAttribute (EmptyType): **MetadataAttribute is an empty element that denotes a metadata attribute object.
141
142 **MetadataSet (EmptyType): **MetadataSet is an empty element that denotes a metadata set object.
143
144 **MetadataStructure (EmptyType): **MetadataStructure is an empty element that denotes a metadata structure definition object.
145
146 **MetadataTarget (EmptyType): **MetadataTarget is an empty element that denotes a metadata target object.
147
148 **NamePersonalisation (EmptyType): **NamePersonalisation is an empty element that denotes a name personalisation object.
149
150 **NamePersonalisationScheme (EmptyType): **NamePersonalisationScheme is an empty element that denotes a name personalisation scheme object.
151
152 **OrganisationMap (EmptyType): **OrganisationMap is an empty element that denotes an organisation map object.
153
154 **OrganisationSchemeMap (EmptyType): **OrganisationSchemeMap is an empty element that denotes an organisation scheme map object.
155
156 **OrganisationUnit (EmptyType): **OrganisationUnit is an empty element that denotes an organisation unit object.
157
158 **OrganisationUnitScheme (EmptyType): **OrganisationUnitScheme is an empty element that denotes an organisation unit scheme object.
159
160 **PrimaryMeasure (EmptyType): **PrimaryMeasure is an empty element that denotes a primary measure object.
161
162 **Process (EmptyType): **Process is an empty element that denotes a process object.
163
164 **ProcessStep (EmptyType): **ProcessStep is an empty element that denotes a process step object.
165
166 **ProvisionAgreement (EmptyType): **ProvisionAgreement is an empty element that denotes a provision agreement object.
167
168 **ReportingCategory (EmptyType): **ReportingCategory is an empty element that denotes a reporting category object.
169
170 **ReportingCategoryMap (EmptyType): **ReportingCategoryMap is an empty element that denotes a reporting category map object.
171
172 **ReportingTaxonomy (EmptyType): **ReportingTaxonomy is an empty element that denotes a reporting taxonomy object.
173
174 **ReportingTaxonomyMap (EmptyType): **ReportingTaxonomyMap is an empty element that denotes a reporting taxonomy map object.
175
176 **ReportPeriodTarget (EmptyType): **ReportPeriodTarget is an empty element that denotes a report period target object.
177
178 **ReportStructure (EmptyType): **ReportStructure is an empty element that denotes a report structure object.
179
180 **Ruleset (EmptyType): **Ruleset is an empty element that denotes a ruleset object.
181
182 **RulesetScheme (EmptyType): **RulesetScheme is an empty element that denotes a ruleset scheme object.
183
184 **StructureMap (EmptyType): **StructureMap is an empty element that denotes a structure map object.
185
186 **StructureSet (EmptyType): **StructureSet is an empty element that denotes a structure set object.
187
188 **TimeDimension (EmptyType): **TimeDimension is an empty element that denotes a time dimension object.
189
190 **Transformation (EmptyType): **Transformation is an empty element that denotes a transformation object.
191
192 **TransformationScheme (EmptyType): **TransformationScheme is an empty element that denotes a transformation scheme object.
193
194 **Transition (EmptyType): **Transition is an empty element that denotes a transition object.
195
196 **UserDefinedOperator (EmptyType): **UserDefinedOperator is an empty element that denotes an user defined operator object.
197
198 **UserDefinedOperatorScheme (EmptyType): **UserDefinedOperatorScheme is an empty element that denotes an user defined operator scheme object.
199
200 **VtlMapping (EmptyType): **VtlMapping is an empty element that denotes a VTL Mapping object.
201
202 **VtlMappingScheme (EmptyType): **VtlMappingScheme is an empty element that denotes a VTL mapping scheme object.
203
204 === 2.1.3 Complex Types ===
205
206 **TextType: **TextType provides for a set of language-specific alternates to be provided for any human-readable constructs in the instance.
207
208 Derivation:
209
210 * xs:anySimpleType (restriction)
211 ** xs:string (extension)
212 *** TextType
213
214 Attributes:
215 xml:lang?
216
217 Content:
218
219 Attribute Documentation:
220
221 |**Name**|**Type**|**Documentation**
222 |xml:lang (default: en)|xs:language|The xml:lang attribute specifies a language code for the text. If not supplied, the default language is assumed to be English.
223
224 **StatusMessageType: **StatusMessageType describes the structure of an error or warning message. A message contains the text of the message, as well as an optional language indicator and an optional code.
225
226 Attributes:
227 code?
228
229 Content:
230 Text+
231
232 Attribute Documentation:
233
234 |**Name**|**Type**|**Documentation**
235 |code|xs:string|The code attribute holds an optional code identifying the underlying error that generated the message. This should be used if parallel language descriptions of the error are supplied, to distinguish which of the multiple error messages are for the same underlying error.
236
237 Element Documentation:
238
239 |**Name**|**Type**|**Documentation**
240 |Text|TextType|Text contains the text of the message, in parallel language values.
241
242 **CodedStatusMessageType: **CodedStatusMessageType describes the structure of an error or warning message which required a code.
243
244 Derivation:
245
246 * StatusMessageType (restriction)
247 ** CodedStatusMessageType
248
249 Attributes:
250 code
251
252 Content:
253 Text+
254
255 Attribute Documentation:
256
257 |**Name**|**Type**|**Documentation**
258 |code|xs:string|The code attribute holds an optional code identifying the underlying error that generated the message. This should be used if parallel language descriptions of the error are supplied, to distinguish which of the multiple error messages are for the same underlying error.
259
260 Element Documentation:
261
262 |**Name**|**Type**|**Documentation**
263 |Text|TextType|Text contains the text of the message, in parallel language values.
264
265 //**AnnotableType**//**: **AnnotableType is an abstract base type used for all annotable artefacts. Any type that provides for annotations should extend this type.
266
267 Content:
268 Annotations?
269
270 Element Documentation:
271
272 |**Name**|**Type**|**Documentation**
273 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
274
275 **AnnotationsType: **AnnotationsType provides for a list of annotations to be attached to data and structure messages.
276
277 Content:
278 Annotation+
279
280 Element Documentation:
281
282 |**Name**|**Type**|**Documentation**
283 |Annotation|AnnotationType|
284
285 **AnnotationType: **AnnotationType provides for non-documentation notes and annotations to be embedded in data and structure messages. It provides optional fields for providing a title, a type description, a URI, and the text of the annotation.
286
287 Attributes:
288 id?
289
290 Content:
291 AnnotationTitle?, AnnotationType?, AnnotationURL?, AnnotationText*
292
293 Attribute Documentation:
294
295 |**Name**|**Type**|**Documentation**
296 |id|xs:string|The id attribute provides a non-standard identification of an annotation. It can be used to disambiguate annotations.
297
298 Element Documentation:
299
300 |**Name**|**Type**|**Documentation**
301 |AnnotationTitle|xs:string|AnnotationTitle provides a title for the annotation.
302 |AnnotationType|xs:string|AnnotationType is used to distinguish between annotations designed to support various uses. The types are not enumerated, as these can be specified by the user or creator of the annotations. The definitions and use of annotation types should be documented by their creator.
303 |AnnotationURL|xs:anyURI|AnnotationURL is a URI - typically a URL - which points to an external resource which may contain or supplement the annotation. If a specific behavior is desired, an annotation type should be defined which specifies the use of this field more exactly.
304 |AnnotationText|TextType|AnnotationText holds a language-specific string containing the text of the annotation.
305
306 **ReferencePeriodType: **Specifies the inclusive start and end times.
307
308 Attributes:
309 startTime, endTime
310
311 Content:
312 {Empty}
313
314 Attribute Documentation:
315
316 |**Name**|**Type**|**Documentation**
317 |startTime|xs:dateTime|The startTime attributes contains the inclusive start date for the reference period.
318 |endTime|xs:dateTime|The endTime attributes contains the inclusive end date for the reference period.
319
320 **QueryableDataSourceType: **QueryableDataSourceType describes a data source which is accepts an standard SDMX Query message and responds appropriately.
321
322 Attributes:
323 isRESTDatasource, isWebServiceDatasource
324
325 Content:
326 DataURL, WSDLURL?, WADLURL?
327
328 Attribute Documentation:
329
330 |**Name**|**Type**|**Documentation**
331 |isRESTDatasource|xs:boolean|The isRESTDatasource attribute indicates, if true, that the queryable data source is accessible via the REST protocol.
332 |isWebServiceDatasource|xs:boolean|The isWebServiceDatasource attribute indicates, if true, that the queryable data source is accessible via Web Services protocols.
333
334 Element Documentation:
335
336 |**Name**|**Type**|**Documentation**
337 |DataURL|xs:anyURI|DataURL contains the URL of the data source.
338 |WSDLURL|xs:anyURI|WSDLURL provides the location of a WSDL instance on the internet which describes the queryable data source.
339 |WADLURL|xs:anyURI|WADLURL provides the location of a WADL instance on the internet which describes the REST protocol of the queryable data source.
340
341 **XHTMLType: **XHTMLType allows for mixed content of text and XHTML tags. When using this type, one will have to provide a reference to the XHTML schema, since the processing of the tags within this type is strict, meaning that they are validated against the XHTML schema provided.
342
343 Attributes:
344 xml:lang?
345
346 Content:
347 {text} x {any element with namespace of http:~/~/www.w3.org/1999/xhtml}*
348
349 Attribute Documentation:
350
351 |**Name**|**Type**|**Documentation**
352 |xml:lang (default: en)|xs:language|
353
354 //**RegionType**//**: **RegionType is an abstract type which defines a generic constraint region. This type can be refined to define regions for data or metadata sets. A region is defined by a collection of key values - each of which a collection of values for a component which disambiguates data or metadata (i.e. dimensions or the target objects of a metadata target). For each region, as collection of attribute values can be provided. Taken together, the key values and attributes serve to identify or describe a subset of a data or metadata set. Finally, the region can flagged as being included or excluded, although this flag only makes sense when the region is used in a particular context.
355
356 Attributes:
357 include?
358
359 Content:
360 KeyValue*, Attribute*
361
362 Attribute Documentation:
363
364 |**Name**|**Type**|**Documentation**
365 |include (default: true)|xs:boolean|The include attribute indicates that the region is to be included or excluded within the context in which it is defined. For example, if the regions is defined as part of a content constraint, the exclude flag would mean the data identified by the region is not present.
366
367 Element Documentation:
368
369 |**Name**|**Type**|**Documentation**
370 |KeyValue|//ComponentValueSetTyp e//|KeyValue contains a reference to a component which disambiguates the data or metadata (i.e. a dimension or target object) and provides a collection of values for the component. The collection of values can be flagged as being inclusive or exclusive to the region being defined. Any key component that is not included is assumed to be wild carded, which is to say that the cube includes all possible values for the un-referenced key components. Further, this assumption applies to the values of the components as well. The values for any given component can only be sub-setted in the region by explicit inclusion or exclusion. For example, a dimension X which has the possible values of 1, 2, 3 is assumed to have all of these values if a key value is not defined. If a key value is defined with an inclusion attribute of true and the values of 1 and 2, the only the values of 1 and 2 for dimension X are included in the definition of the region. If the key value is defined with an inclusion attribute of false and the value of 1, then the values of 2 and 3 for dimension X are included in the definition of the region. Note that any given key component must only be referenced once in the region.
371 |Attribute|//ComponentValueSetTyp e//|Attributes contains a reference to an attribute component (data or metadata) and provides a collection of values for the referenced attribute. This serves to state that for the key which defines the region, the attributes that are specified here have or do not have (depending to the include attribute of the value set) the values provided. It is possible to provide and attribute reference without specifying values, for the purpose of stating the attribute is absent (include = false) or present with an unbounded set of values. As opposed to key components, which are assumed to be wild carded if absent, no assumptions are made about the absence of an attribute. Only attributes which are explicitly stated to be present or absent from the region will be know. All unstated attributes for the set cannot be assumed to absent or present.
372
373 //**ComponentValueSetType**//**: **ComponentValueSetType is an abstract base type which is used to provide a set of value for a referenced component. Implementations of this type will be based on a particular component type and refine the allowed values to reflect the types of values that are possible for that type of component.
374
375 Attributes:
376 id, include?
377
378 Content:
379 (Value+ | DataSet+ | DataKey+ | Object+ | TimeRange)?
380
381 Attribute Documentation:
382
383 |**Name**|**Type**|**Documentation**
384 |id|NestedNCNameIDType|The id attribute provides the identifier for the component for which values are being provided. This base type allows for a nested identifier to be provided, for the purpose of referencing a nested component (i.e. a metadata attribute). However, specific implementations will restrict this representation to only allow single level identifiers where appropriate.
385 |include (default: true)|xs:boolean|The include attribute indicates whether the values provided for the referenced component are to be included are excluded from the region in which they are defined.
386
387 Element Documentation:
388
389 |**Name**|**Type**|**Documentation**
390 |Value|SimpleValueType|Value provides a simple value for the component, such as a coded, numeric, or simple text value. This type of component value is applicable for dimensions and attributes.
391 |DataSet|SetReferenceType|DataSet provides a reference to a data set and is used to state a value for the data set target component in a metadata target.
392 |DataKey|DataKeyType|DataKey provides a set of dimension references and value, which form a full or partial data key. This is used to state a value for the key descriptor values target component in a metadata target.
393 |Object|ObjectReferenceType|Object provides a reference to an Identifiable object in the SDMX Information Model. This is used to state a value for an identifiable target component in a metadata target.
394 |TimeRange|TimeRangeValueType|TimeValue provides a value for a component which has a time representation. This is repeatable to allow for a range to be specified, although a single value can also be provided. An operator is available on this to indicate whether the specified value indicates an exact value or the beginning/end of a range (inclusive or exclusive).
395
396 //**DistinctKeyType**//**: **DistinctKeyType is an abstract base type which is a special type of region that only defines a distinct region of data or metadata. For each component defined in the region, only a single values is provided. However, the same rules that apply to the general region about unstated components being wild carded apply here as well. Thus, this type can define a distinct full or partial key for data or metadata.
397
398 Derivation:
399
400 * //RegionType// (restriction)
401 ** //DistinctKeyType//
402
403 Attributes:
404 include?
405
406 Content:
407 KeyValue+
408
409 Attribute Documentation:
410
411 |**Name**|**Type**|**Documentation**
412 |include (fixed: true)|xs:boolean|The include attribute has a fixed value of true for a distinct key, since such a key is always assumed to identify existing data or metadata.
413
414 Element Documentation:
415
416 |**Name**|**Type**|**Documentation**
417 |KeyValue|//DinstinctKeyValueTyp e//|KeyValue contains a reference to a component which disambiguates the data or metadata (i.e. a dimension or target object) and provides a collection of values for the component. The collection of values can be flagged as being inclusive or exclusive to the region being defined. Any key component that is not included is assumed to be wild carded, which is to say that the cube includes all possible values for the un-referenced key components. Further, this assumption applies to the values of the components as well. The values for any given component can only be sub-setted in the region by explicit inclusion or exclusion. For example, a dimension X which has the possible values of 1, 2, 3 is assumed to have all of these values if a key value is not defined. If a key value is defined with an inclusion attribute of true and the values of 1 and 2, the only the values of 1 and 2 for dimension X are included in the definition of the region. If the key value is defined with an inclusion attribute of false and the value of 1, then the values of 2 and 3 for dimension X are included in the definition of the region. Note that any given key component must only be referenced once in the region.
418
419 //**DinstinctKeyValueType**//**: **DinstinctKeyValueType is an abstract base type which defines a singular, required value for a key component.
420
421 Derivation:
422
423 * //ComponentValueSetType// (restriction)
424 ** //DinstinctKeyValueType//
425
426 Attributes:
427 id, include?
428
429 Content:
430 (Value | DataSet | DataKey | Object)
431
432 Attribute Documentation:
433
434 |**Name**|**Type**|**Documentation**
435 |id|SingleNCNameIDType|The id attribute provides the identifier for the component for which values are being provided. This base type allows for a nested identifier to be provided, for the purpose of referencing a nested component (i.e. a metadata attribute). However, specific implementations will restrict this representation to only allow single level identifiers where appropriate.
436 |include (fixed: true)|xs:boolean|The include attribute indicates whether the values provided for the referenced component are to be included are excluded from the region in which they are defined.
437
438 Element Documentation:
439
440 |**Name**|**Type**|**Documentation**
441 |Value|SimpleKeyValueType|Value provides a simple value for the component, such as a coded, numeric, or simple text value. This type of component value is applicable for dimensions and attributes.
442 |DataSet|SetReferenceType|DataSet provides a reference to a data set and is used to state a value for the data set target component in a metadata target.
443 |DataKey|DataKeyType|DataKey provides a set of dimension references and value, which form a full or partial data key. This is used to state a value for the key descriptor values target component in a metadata target.
444 |Object|ObjectReferenceType|Object provides a reference to an Identifiable object in the SDMX Information Model. This is used to state a value for an identifiable target component in a metadata target.
445
446 **DataKeyType: **DataKeyType is a region which defines a distinct full or partial data key. The key consists of a set of values, each referencing a dimension and providing a single value for that dimension. The purpose of the key is to define a subset of a data set (i.e. the observed value and data attribute) which have the dimension values provided in this definition. Any dimension not stated explicitly in this key is assumed to be wild carded, thus allowing for the definition of partial data keys.
447
448 Derivation:
449
450 * //RegionType// (restriction)
451 ** //DistinctKeyType// (restriction)
452 *** DataKeyType
453
454 Attributes:
455 include?
456
457 Content:
458 KeyValue+
459
460 Attribute Documentation:
461
462 |**Name**|**Type**|**Documentation**
463 |include (fixed: true)|xs:boolean|The include attribute has a fixed value of true for a distinct key, since such a key is always assumed to identify existing data or metadata.
464
465 Element Documentation:
466
467 |**Name**|**Type**|**Documentation**
468 |KeyValue|DataKeyValueType|KeyValue contains a reference to a component which disambiguates the data or metadata (i.e. a dimension or target object) and provides a collection of values for the component. The collection of values can be flagged as being inclusive or exclusive to the region being defined. Any key component that is not included is assumed to be wild carded, which is to say that the cube includes all possible values for the un-referenced key components. Further, this assumption applies to the values of the components as well. The values for any given component can only be sub-setted in the region by explicit inclusion or exclusion. For example, a dimension X which has the possible values of 1, 2, 3 is assumed to have all of these values if a key value is not defined. If a key value is defined with an inclusion attribute of true and the values of 1 and 2, the only the values of 1 and 2 for dimension X are included in the definition of the region. If the key value is defined with an inclusion attribute of false and the value of 1, then the values of 2 and 3 for dimension X are included in the definition of the region. Note that any given key component must only be referenced once in the region.
469
470 **DataKeyValueType: **DataKeyValueType is a type for providing a dimension value for the purpose of defining a distinct data key. Only a single value can be provided for the dimension.
471
472 Derivation:
473
474 * //ComponentValueSetType// (restriction)
475 ** //DinstinctKeyValueType// (restriction)
476 *** DataKeyValueType
477
478 Attributes:
479 id, include?
480
481 Content:
482 Value
483
484 Attribute Documentation:
485
486 |**Name**|**Type**|**Documentation**
487 |id|SingleNCNameIDType|The id attribute provides the identifier for the component for which values are being provided. This base type allows for a nested identifier to be provided, for the purpose of referencing a nested component (i.e. a metadata attribute). However, specific implementations will restrict this representation to only allow single level identifiers where appropriate.
488 |include (fixed: true)|xs:boolean|The include attribute indicates whether the values provided for the referenced component are to be included are excluded from the region in which they are defined.
489
490 Element Documentation:
491
492 |**Name**|**Type**|**Documentation**
493 |Value|SimpleKeyValueType|Value provides a simple value for the component, such as a coded, numeric, or simple text value. This type of component value is applicable for dimensions and attributes.
494
495 **MetadataKeyType: **MetadataKeyType is a region which defines a distinct full or partial metadata key. The key consists of a set of values, each referencing a target object for the metadata target referenced in the metadataTarget attribute, which must be defined in the report structure referenced in the report attribute. Each target object can be assigned a single value. If an target object from the reference metadata target is not included in this key, the value of that is assumed to be all known objects for a reference target object, all possible keys for a key descriptor values target object, or all dates for report period target object. The purpose of this key reference a metadata conforming to a particular report structure for given object or set of objects.
496
497 Derivation:
498
499 * //RegionType// (restriction)
500 ** //DistinctKeyType// (restriction)
501 *** MetadataKeyType
502
503 Attributes:
504 include?, report, metadataTarget
505
506 Content:
507 KeyValue+
508
509 Attribute Documentation:
510
511 |**Name**|**Type**|**Documentation**
512 |include (fixed: true)|xs:boolean|The include attribute has a fixed value of true for a distinct key, since such a key is always assumed to identify existing data or metadata.
513 |report|IDType|The report attribute is required and holds the identifier of the report structure which the reference metadata being defined by this key is based on.
514 |metadataTarget|IDType|The metadataTarget attribute is required and identifies the metadata target for the report structure which this key is based upon. Note that a report structure can have multiple metadata targets, so to properly determine the object or objects for which the key applies, the proper metadata target must be identified.
515
516 Element Documentation:
517
518 |**Name**|**Type**|**Documentation**
519 |KeyValue|MetadataKeyValueType|KeyValue contains a reference to a component which disambiguates the data or metadata (i.e. a dimension or target object) and provides a collection of values for the component. The collection of values can be flagged as being inclusive or exclusive to the region being defined. Any key component that is not included is assumed to be wild carded, which is to say that the cube includes all possible values for the un-referenced key components. Further, this assumption applies to the values of the components as well. The values for any given component can only be sub-setted in the region by explicit inclusion or exclusion. For example, a dimension X which has the possible values of 1, 2, 3 is assumed to have all of these values if a key value is not defined. If a key value is defined with an inclusion attribute of true and the values of 1 and 2, the only the values of 1 and 2 for dimension X are included in the definition of the region. If the key value is defined with an inclusion attribute of false and the value of 1, then the values of 2 and 3 for dimension X are included in the definition of the region. Note that any given key component must only be referenced once in the region.
520
521 **MetadataKeyValueType: **MetadataKeyValueType is a type for providing a target object value for the purpose of defining a distinct metadata key. Only a single value can be provided for the target object.
522
523 Derivation:
524
525 * //ComponentValueSetType// (restriction)
526 ** //DinstinctKeyValueType// (restriction)
527 *** MetadataKeyValueType
528
529 Attributes:
530 id, include?
531
532 Content:
533 (Value | DataSet | DataKey | Object)
534
535 Attribute Documentation:
536
537 |**Name**|**Type**|**Documentation**
538 |id|SingleNCNameIDType|The id attribute provides the identifier for the component for which values are being provided. This base type allows for a nested identifier to be provided, for the purpose of referencing a nested component (i.e. a metadata attribute). However, specific implementations will restrict this representation to only allow single level identifiers where appropriate.
539 |include (fixed: true)|xs:boolean|The include attribute indicates whether the values provided for the referenced component are to be included are excluded from the region in which they are defined.
540
541 Element Documentation:
542
543 |**Name**|**Type**|**Documentation**
544 |Value|SimpleKeyValueType|Value provides a simple value for the component, such as a coded, numeric, or simple text value. This type of component value is applicable for dimensions and attributes.
545 |DataSet|SetReferenceType|DataSet provides a reference to a data set and is used to state a value for the data set target component in a metadata target.
546 |DataKey|DataKeyType|DataKey provides a set of dimension references and value, which form a full or partial data key. This is used to state a value for the key descriptor values target component in a metadata target.
547 |Object|ObjectReferenceType|Object provides a reference to an Identifiable object in the SDMX Information Model. This is used to state a value for an identifiable target component in a metadata target.
548
549 **CubeRegionType: **CubeRegionType defines the structure of a data cube region. This is based on the abstract RegionType and simply refines the key and attribute values to conform with what is applicable for dimensions and attributes, respectively. See the documentation of the base type for more details on how a region is defined.
550
551 Derivation:
552
553 * //RegionType// (restriction)
554 ** CubeRegionType
555
556 Attributes:
557 include?
558
559 Content:
560 KeyValue*, Attribute*
561
562 Attribute Documentation:
563
564 |**Name**|**Type**|**Documentation**
565 |include (default: true)|xs:boolean|The include attribute indicates that the region is to be included or excluded within the context in which it is defined. For example, if the regions is defined as part of a content constraint, the exclude flag would mean the data identified by the region is not present.
566
567 Element Documentation:
568
569 |**Name**|**Type**|**Documentation**
570 |KeyValue|CubeRegionKeyType|KeyValue contains a reference to a component which disambiguates the data or metadata (i.e. a dimension or target object) and provides a collection of values for the component. The collection of values can be flagged as being inclusive or exclusive to the region being defined. Any key component that is not included is assumed to be wild carded, which is to say that the cube includes all possible values for the un-referenced key components. Further, this assumption applies to the values of the components as well. The values for any given component can only be sub-setted in the region by explicit inclusion or exclusion. For example, a dimension X which has the possible values of 1, 2, 3 is assumed to have all of these values if a key value is not defined. If a key value is defined with an inclusion attribute of true and the values of 1 and 2, the only the values of 1 and 2 for dimension X are included in the definition of the region. If the key value is defined with an inclusion attribute of false and the value of 1, then the values of 2 and 3 for dimension X are included in the definition of the region. Note that any given key component must only be referenced once in the region.
571 |Attribute|AttributeValueSetTyp e|Attributes contains a reference to an attribute component (data or metadata) and provides a collection of values for the referenced attribute. This serves to state that for the key which defines the region, the attributes that are specified here have or do not have (depending to the include attribute of the value set) the values provided. It is possible to provide and attribute reference without specifying values, for the purpose of stating the attribute is absent (include = false) or present with an unbounded set of values. As opposed to key components, which are assumed to be wild carded if absent, no assumptions are made about the absence of an attribute. Only attributes which are explicitly stated to be present or absent from the region will be know. All unstated attributes for the set cannot be assumed to absent or present.
572
573 **MetadataTargetRegionType: **MetadataTargetRegionType defines the structure of a metadata target region. A metadata target region must define the report structure and the metadata target from that structure on which the region is based. This type is based on the abstract RegionType and simply refines the key and attribute values to conform with what is applicable for target objects and metadata attributes, respectively. See the documentation of the base type for more details on how a region is defined.
574
575 Derivation:
576
577 * //RegionType// (restriction)
578 ** MetadataTargetRegionType
579
580 Attributes:
581 include?, report, metadataTarget
582
583 Content:
584 KeyValue*, Attribute*
585
586 Attribute Documentation:
587
588 |**Name**|**Type**|**Documentation**
589 |include (default: true)|xs:boolean|The include attribute indicates that the region is to be included or excluded within the context in which it is defined. For example, if the regions is defined as part of a content constraint, the exclude flag would mean the data identified by the region is not present.
590 |report|IDType|The report attribute is required and holds the identifier of the report structure which the reference metadata being defined by this region is based on.
591 |metadataTarget|IDType|The metadataTarget attribute is required and identifies the metadata target for the report structure which this region is based upon. Note that a report structure can have multiple metadata targets, so to properly determine the object or objects for which the region applies, the proper metadata target must be identified.
592
593 Element Documentation:
594
595 |**Name**|**Type**|**Documentation**
596 |KeyValue|MetadataTargetRegion KeyType|KeyValue contains a reference to a component which disambiguates the data or metadata (i.e. a dimension or target object) and provides a collection of values for the component. The collection of values can be flagged as being inclusive or exclusive to the region being defined. Any key component that is not included is assumed to be wild carded, which is to say that the cube includes all possible values for the un-referenced key components. Further, this assumption applies to the values of the components as well. The values for any given component can only be sub-setted in the region by explicit inclusion or exclusion. For example, a dimension X which has the possible values of 1, 2, 3 is assumed to have all of these values if a key value is not defined. If a key value is defined with an inclusion attribute of true and the values of 1 and 2, the only the values of 1 and 2 for dimension X are included in the definition of the region. If the key value is defined with an inclusion attribute of false and the value of 1, then the values of 2 and 3 for dimension X are included in the definition of the region. Note that any given key component must only be referenced once in the region.
597 |Attribute|MetadataAttributeVal ueSetType|Attributes contains a reference to an attribute component (data or metadata) and provides a collection of values for the referenced attribute. This serves to state that for the key which defines the region, the attributes that are specified here have or do not have (depending to the include attribute of the value set) the values provided. It is possible to provide and attribute reference without specifying values, for the purpose of stating the attribute is absent (include = false) or present with an unbounded set of values. As opposed to key components, which are assumed to be wild carded if absent, no assumptions are made about the absence of an attribute. Only attributes which are explicitly stated to be present or absent from the region will be know. All unstated attributes for the set cannot be assumed to absent or present.
598
599 **CubeRegionKeyType: **CubeRegionKeyType is a type for providing a set of values for a dimension for the purpose of defining a data cube region. A set of distinct value can be provided, or if this dimension is represented as time, and time range can be specified.
600
601 Derivation:
602
603 * //ComponentValueSetType// (restriction)
604 ** CubeRegionKeyType
605
606 Attributes:
607 id, include?
608
609 Content:
610 (Value+ | TimeRange)
611
612 Attribute Documentation:
613
614 |**Name**|**Type**|**Documentation**
615 |id|SingleNCNameIDType|The id attribute provides the identifier for the component for which values are being provided. This base type allows for a nested identifier to be provided, for the purpose of referencing a nested component (i.e. a metadata attribute). However, specific implementations will restrict this representation to only allow single level identifiers where appropriate.
616 |include (default: true)|xs:boolean|The include attribute indicates whether the values provided for the referenced component are to be included are excluded from the region in which they are defined.
617
618 Element Documentation:
619
620 |**Name**|**Type**|**Documentation**
621 |Value|SimpleValueType|Value provides a simple value for the component, such as a coded, numeric, or simple text value. This type of component value is applicable for dimensions and attributes.
622 |TimeRange|TimeRangeValueType|TimeValue provides a value for a component which has a time representation. This is repeatable to allow for a range to be specified, although a single value can also be provided. An operator is available on this to indicate whether the specified value indicates an exact value or the beginning/end of a range (inclusive or exclusive).
623
624 **MetadataTargetRegionKeyType: **MetadataTargetRegionKeyType is a type for providing a set of values for a target object in a metadata target of a re fence metadata report. A set of values or a time range can be provided for a report period target object. A collection of the respective types of references can be provided for data set reference and identifiable object reference target objects. For a key descriptor values target object, a collection of data keys can be provided.
625
626 Derivation:
627
628 * //ComponentValueSetType// (restriction)
629 ** MetadataTargetRegionKeyType
630
631 Attributes:
632 id, include?
633
634 Content:
635 (Value+ | DataSet+ | DataKey+ | Object+ | TimeRange)
636
637 Attribute Documentation:
638
639 |**Name**|**Type**|**Documentation**
640 |id|SingleNCNameIDType|The id attribute provides the identifier for the component for which values are being provided. This base type allows for a nested identifier to be provided, for the purpose of referencing a nested component (i.e. a metadata attribute). However, specific implementations will restrict this representation to only allow single level identifiers where appropriate.
641 |include (default: true)|xs:boolean|The include attribute indicates whether the values provided for the referenced component are to be included are excluded from the region in which they are defined.
642
643 Element Documentation:
644
645 |**Name**|**Type**|**Documentation**
646 |Value|SimpleKeyValueType|Value provides a simple value for the component, such as a coded, numeric, or simple text value. This type of component value is applicable for dimensions and attributes.
647 |DataSet|SetReferenceType|DataSet provides a reference to a data set and is used to state a value for the data set target component in a metadata target.
648 |DataKey|DataKeyType|DataKey provides a set of dimension references and value, which form a full or partial data key. This is used to state a value for the key descriptor values target component in a metadata target.
649 |Object|ObjectReferenceType|Object provides a reference to an Identifiable object in the SDMX Information Model. This is used to state a value for an identifiable target component in a metadata target.
650 |TimeRange|TimeRangeValueType|TimeValue provides a value for a component which has a time representation. This is repeatable to allow for a range to be specified, although a single value can also be provided. An operator is available on this to indicate whether the specified value indicates an exact value or the beginning/end of a range (inclusive or exclusive).
651
652 **AttributeValueSetType: **AttributeValueSetType defines the structure for providing values for a data attribute. If no values are provided, the attribute is implied to include/excluded from the region in which it is defined, with no regard to the value of the data attribute. Note that for metadata attributes which occur within other metadata attributes, a nested identifier can be provided. For example, a value of CONTACT.ADDRESS.STREET refers to the metadata attribute with the identifier STREET which exists in the ADDRESS metadata attribute in the CONTACT metadata attribute, which is defined at the root of the report structure.
653
654 Derivation:
655
656 * //ComponentValueSetType// (restriction)
657 ** AttributeValueSetType
658
659 Attributes:
660 id, include?
661
662 Content:
663 (Value+ | TimeRange)?
664
665 Attribute Documentation:
666
667 |**Name**|**Type**|**Documentation**
668 |id|SingleNCNameIDType|The id attribute provides the identifier for the component for which values are being provided. This base type allows for a nested identifier to be provided, for the purpose of referencing a nested component (i.e. a metadata attribute). However, specific implementations will restrict this representation to only allow single level identifiers where appropriate.
669 |include (default: true)|xs:boolean|The include attribute indicates whether the values provided for the referenced component are to be included are excluded from the region in which they are defined.
670
671 Element Documentation:
672
673 |**Name**|**Type**|**Documentation**
674 |Value|SimpleValueType|Value provides a simple value for the component, such as a coded, numeric, or simple text value. This type of component value is applicable for dimensions and attributes.
675 |TimeRange|TimeRangeValueType|TimeValue provides a value for a component which has a time representation. This is repeatable to allow for a range to be specified, although a single value can also be provided. An operator is available on this to indicate whether the specified value indicates an exact value or the beginning/end of a range (inclusive or exclusive).
676
677 **MetadataAttributeValueSetType: **MetadataAttributeValueSetType defines the structure for providing values for a metadata attribute. If no values are provided, the attribute is implied to include/excluded from the region in which it is defined, with no regard to the value of the metadata attribute.
678
679 Derivation:
680
681 * //ComponentValueSetType// (restriction)
682 ** MetadataAttributeValueSetType
683
684 Attributes:
685 id, include?
686
687 Content:
688 (Value+ | TimeRange)?
689
690 Attribute Documentation:
691
692 |**Name**|**Type**|**Documentation**
693 |id|NestedNCNameIDType|The id attribute provides the identifier for the component for which values are being provided. This base type allows for a nested identifier to be provided, for the purpose of referencing a nested component (i.e. a metadata attribute). However, specific implementations will restrict this representation to only allow single level identifiers where appropriate.
694 |include (default: true)|xs:boolean|The include attribute indicates whether the values provided for the referenced component are to be included are excluded from the region in which they are defined.
695
696 Element Documentation:
697
698 |**Name**|**Type**|**Documentation**
699 |Value|SimpleValueType|Value provides a simple value for the component, such as a coded, numeric, or simple text value. This type of component value is applicable for dimensions and attributes.
700 |TimeRange|TimeRangeValueType|TimeValue provides a value for a component which has a time representation. This is repeatable to allow for a range to be specified, although a single value can also be provided. An operator is available on this to indicate whether the specified value indicates an exact value or the beginning/end of a range (inclusive or exclusive).
701
702 **SimpleValueType: **SimpleValueType contains a simple value for a component, and if that value is from a code list, the ability to indicate that child codes in a simple hierarchy are part of the value set of the component for the region.
703
704 Derivation:
705
706 * xs:anySimpleType (restriction)
707 ** xs:string (extension)
708 *** SimpleValueType
709
710 Attributes:
711 cascadeValues?
712
713 Content:
714
715 Attribute Documentation:
716
717 |**Name**|**Type**|**Documentation**
718 |cascadeValues (default: false)|xs:boolean|The cascadeValues attribute, if true, indicates that if the value is taken from a code all child codes in a simple hierarchy are understood be included in the region.
719
720 **SimpleKeyValueType: **SimpleKeyValueType derives from the SimpleValueType, but does not allow for the cascading of value in the hierarchy, as keys are meant to describe a distinct full or partial key.
721
722 Derivation:
723
724 * xs:anySimpleType (restriction)
725 **
726 *** xs:string (extension)
727 **** SimpleValueType (restriction)
728 ***** SimpleKeyValueType
729
730 Content:
731 **TimeRangeValueType: **TimeRangeValueType allows a time period value to be expressed as a range. It can be expressed as the period before a period, after a period, or between two periods. Each of these properties can specify their inclusion in regards to the range.
732
733 Content:
734 (BeforePeriod | AfterPeriod | (StartPeriod, EndPeriod))
735
736 Element Documentation:
737
738 |**Name**|**Type**|**Documentation**
739 |BeforePeriod|TimePeriodRangeType|BeforePeriod is the period before which the period is meant to cover. This date may be inclusive or exclusive in the range.
740 |AfterPeriod|TimePeriodRangeType|AfterPeriod is the period after which the period is meant to cover. This date may be inclusive or exclusive in the range.
741 |StartPeriod|TimePeriodRangeType|StartPeriod is the start date or the range that the queried date must occur within. This date may be inclusive or exclusive in the range.
742 |EndPeriod|TimePeriodRangeType|EndPeriod is the end period of the range. This date may be inclusive or exclusive in the range.
743
744 **TimePeriodRangeType: **TimePeriodRangeType defines a time period, and indicates whether it is inclusive in a range.
745
746 Derivation:
747
748 * xs:anySimpleType (restriction)
749 ** ObservationalTimePeriodType (extension)
750 *** TimePeriodRangeType
751
752 Attributes:
753 isInclusive?
754
755 Content:
756 Attribute Documentation:
757
758 |**Name**|**Type**|**Documentation**
759 |isInclusive (default: true)|xs:boolean|The isInclusive attribute, when true, indicates that the time period specified is included in the range.
760
761 //**PayloadStructureType**//**: **PayloadStructureType is an abstract base type used to define the structural information for data or metadata sets. A reference to the structure is provided (either explicitly or through a reference to a structure usage).
762
763 Attributes:
764 structureID, schemaURL?, namespace?, dimensionAtObservation?, explicitMeasures?, serviceURL?, structureURL?
765
766 Content:
767 (ProvisionAgrement | StructureUsage | Structure)
768
769 Attribute Documentation:
770
771 |**Name**|**Type**|**Documentation**
772 |structureID|xs:ID|The structureID attribute uniquely identifies the structure for the purpose of referencing it from the payload. This is only used in structure specific formats. Although it is required, it is only useful when more than one data set is present in the message.
773 |schemaURL|xs:anyURI|The schemaURL attribute provides a location from which the structure specific schema can be located.
774 |namespace|xs:anyURI|The namespace attribute is used to provide the namespace for structure-specific formats. By communicating this information in the header, it is possible to generate the structure specific schema while processing the message.
775 |dimensionAtObservation|ObservationDimension Type|The dimensionAtObservation is used to reference the dimension at the observation level for data messages. This can also be given the explicit value of "AllDimensions" which denotes that the cross sectional data is in the flat format.
776 |explicitMeasures|xs:boolean|The explicitMeasures indicates whether explicit measures are used in the cross sectional format. This is only applicable for the measure dimension as the dimension at the observation level or the flat structure.
777 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
778 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
779
780 Element Documentation:
781
782 |**Name**|**Type**|**Documentation**
783 |ProvisionAgrement|ProvisionAgreementRe ferenceType|ProvisionAgreement references a provision agreement which the data or metadata is reported against.
784 |StructureUsage|//StructureUsageRefere nceBaseType//|StructureUsage references a flow which the data or metadata is reported against.
785 |Structure|//StructureReferenceBa seType//|Structure references the structure which defines the structure of the data or metadata set.
786
787 //**DataStructureType**//**: **DataStructureType is an abstract base type the forms the basis for the structural information for a data set.
788
789 Derivation:
790
791 * //PayloadStructureType// (restriction)
792 ** //DataStructureType//
793
794 Attributes:
795 structureID, schemaURL?, namespace?, dimensionAtObservation?, explicitMeasures?, serviceURL?, structureURL?
796
797 Content:
798 (ProvisionAgrement | StructureUsage | Structure)
799
800 Attribute Documentation:
801
802 |**Name**|**Type**|**Documentation**
803 |structureID|xs:ID|The structureID attribute uniquely identifies the structure for the purpose of referencing it from the payload. This is only used in structure specific formats. Although it is required, it is only useful when more than one data set is present in the message.
804 |schemaURL|xs:anyURI|The schemaURL attribute provides a location from which the structure specific schema can be located.
805 |namespace|xs:anyURI|The namespace attribute is used to provide the namespace for structure-specific formats. By communicating this information in the header, it is possible to generate the structure specific schema while processing the message.
806 |dimensionAtObservation|ObservationDimension Type|The dimensionAtObservation is used to reference the dimension at the observation level for data messages. This can also be given the explicit value of "AllDimensions" which denotes that the cross sectional data is in the flat format.
807 |explicitMeasures|xs:boolean|The explicitMeasures indicates whether explicit measures are used in the cross sectional format. This is only applicable for the measure dimension as the dimension at the observation level or the flat structure.
808 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
809 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
810
811 Element Documentation:
812
813 |**Name**|**Type**|**Documentation**
814 |ProvisionAgrement|ProvisionAgreementRe ferenceType|ProvisionAgreement references a provision agreement which the data is reported against.
815 |StructureUsage|DataflowReferenceTyp e|StructureUsage references a dataflow which the data is reported against.
816 |Structure|DataStructureReferen ceType|Structure references the data structure definition which defines the structure of the data.
817
818 **DataStructureRequestType: **DataStructureRequestType is a variation of a the DataStructureType for querying purposes. Only the observation dimension and the explicit measures flag are allowed.
819
820 Derivation:
821
822 * //PayloadStructureType// (restriction)
823 ** //DataStructureType// (restriction)
824 *** DataStructureRequestType
825
826 Attributes:
827 structureID, dimensionAtObservation, explicitMeasures?, serviceURL?, structureURL?
828
829 Content:
830 (ProvisionAgrement | StructureUsage | Structure)
831
832 Attribute Documentation:
833
834 |**Name**|**Type**|**Documentation**
835 |structureID|xs:ID|The structureID attribute uniquely identifies the structure for the purpose of referencing it from the payload. This is only used in structure specific formats. Although it is required, it is only useful when more than one data set is present in the message.
836 |dimensionAtObservation|ObservationDimension Type|The dimensionAtObservation is used to reference the dimension at the observation level for data messages. This can also be given the explicit value of "AllDimensions" which denotes that the cross sectional data is in the flat format.
837 |explicitMeasures (default: false)|xs:boolean|The explicitMeasures indicates whether explicit measures are used in the cross sectional format. This is only applicable for the measure dimension as the dimension at the observation level or the flat structure.
838 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
839 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
840
841 Element Documentation:
842
843 |**Name**|**Type**|**Documentation**
844 |ProvisionAgrement|ProvisionAgreementRe ferenceType|ProvisionAgreement references a provision agreement which the data is reported against.
845 |StructureUsage|DataflowReferenceTyp e|StructureUsage references a dataflow which the data is reported against.
846 |Structure|DataStructureReferen ceType|Structure references the data structure definition which defines the structure of the data.
847
848 **GenericDataStructureRequestType: **GenericDataStructureRequestType is a variation of a the DataStructureRequestType for querying purposes. The explicit measure flag in not allowed.
849
850 Derivation:
851
852 * //PayloadStructureType// (restriction)
853 ** //DataStructureType// (restriction)
854 *** DataStructureRequestType (restriction)
855 **** GenericDataStructureRequestType
856
857 Attributes:
858 structureID, dimensionAtObservation, serviceURL?, structureURL?
859
860 Content:
861 (ProvisionAgrement | StructureUsage | Structure)
862
863 Attribute Documentation:
864
865 |**Name**|**Type**|**Documentation**
866 |structureID|xs:ID|The structureID attribute uniquely identifies the structure for the purpose of referencing it from the payload. This is only used in structure specific formats. Although it is required, it is only useful when more than one data set is present in the message.
867 |dimensionAtObservation|ObservationDimension Type|The dimensionAtObservation is used to reference the dimension at the observation level for data messages. This can also be given the explicit value of "AllDimensions" which denotes that the cross sectional data is in the flat format.
868 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
869 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
870
871 Element Documentation:
872
873 |**Name**|**Type**|**Documentation**
874 |ProvisionAgrement|ProvisionAgreementRe ferenceType|ProvisionAgreement references a provision agreement which the data is reported against.
875 |StructureUsage|DataflowReferenceTyp e|StructureUsage references a dataflow which the data is reported against.
876 |Structure|DataStructureReferen ceType|Structure references the data structure definition which defines the structure of the data.
877
878 **TimeSeriesDataStructureRequestType: **TimeSeriesDataStructureRequestType is a variation of a the DataStructureRequestType for querying purposes. The observation dimension is fixed to TIME_PERIOD
879
880 Derivation:
881
882 * //PayloadStructureType// (restriction)
883 ** //DataStructureType// (restriction)
884 ***
885 **** DataStructureRequestType (restriction)
886 ***** TimeSeriesDataStructureRequestType
887
888 Attributes:
889 structureID, dimensionAtObservation, explicitMeasures?, serviceURL?, structureURL?
890
891 Content:
892 (ProvisionAgrement | StructureUsage | Structure)
893
894 Attribute Documentation:
895
896 |**Name**|**Type**|**Documentation**
897 |structureID|xs:ID|The structureID attribute uniquely identifies the structure for the purpose of referencing it from the payload. This is only used in structure specific formats. Although it is required, it is only useful when more than one data set is present in the message.
898 |dimensionAtObservation (fixed: TIME_PERIOD)|ObservationDimension Type|The dimensionAtObservation is used to reference the dimension at the observation level for data messages. This can also be given the explicit value of "AllDimensions" which denotes that the cross sectional data is in the flat format.
899 |explicitMeasures (default: false)|xs:boolean|The explicitMeasures indicates whether explicit measures are used in the cross sectional format. This is only applicable for the measure dimension as the dimension at the observation level or the flat structure.
900 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
901 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
902
903 Element Documentation:
904
905 |**Name**|**Type**|**Documentation**
906 |ProvisionAgrement|ProvisionAgreementRe ferenceType|ProvisionAgreement references a provision agreement which the data is reported against.
907 |StructureUsage|DataflowReferenceTyp e|StructureUsage references a dataflow which the data is reported against.
908 |Structure|DataStructureReferen ceType|Structure references the data structure definition which defines the structure of the data.
909
910 **TimeSeriesGenericDataStructureRequestType: **TimeSeriesGenericDataStructureRequestType is a variation of a the GenericDataStructureRequestType for querying purposes. The observation dimension is fixed to TIME_PERIOD.
911
912 Derivation:
913
914 * //PayloadStructureType// (restriction)
915 ** //DataStructureType// (restriction)
916 *** DataStructureRequestType (restriction)
917 **** GenericDataStructureRequestType (restriction)
918 ***** TimeSeriesGenericDataStructureRequestType
919
920 Attributes:
921 structureID, dimensionAtObservation, serviceURL?, structureURL?
922
923 Content:
924 (ProvisionAgrement | StructureUsage | Structure)
925
926 Attribute Documentation:
927
928 |**Name**|**Type**|**Documentation**
929 |structureID|xs:ID|The structureID attribute uniquely identifies the structure for the purpose of referencing it from the payload. This is only used in structure specific formats. Although it is required, it is only useful when more than one data set is present in the message.
930 |dimensionAtObservation (fixed: TIME_PERIOD)|ObservationDimension Type|The dimensionAtObservation is used to reference the dimension at the observation level for data messages. This can also be given the explicit value of "AllDimensions" which denotes that the cross sectional data is in the flat format.
931 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
932 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
933
934 Element Documentation:
935
936 |**Name**|**Type**|**Documentation**
937 |ProvisionAgrement|ProvisionAgreementRe ferenceType|ProvisionAgreement references a provision agreement which the data is reported against.
938 |StructureUsage|DataflowReferenceTyp e|StructureUsage references a dataflow which the data is reported against.
939 |Structure|DataStructureReferen ceType|Structure references the data structure definition which defines the structure of the data.
940
941 **GenericDataStructureType: **GenericDataStructureType defines the structural information for a generic data set. A reference to the structure, either explicitly or through a dataflow or provision agreement is required as well as the dimension which occurs at the observation level.
942
943 Derivation:
944
945 * //PayloadStructureType// (restriction)
946 ** //DataStructureType// (restriction)
947 *** GenericDataStructureType
948
949 Attributes:
950 structureID, dimensionAtObservation, serviceURL?, structureURL?
951
952 Content:
953 (ProvisionAgrement | StructureUsage | Structure)
954
955 Attribute Documentation:
956
957 |**Name**|**Type**|**Documentation**
958 |structureID|xs:ID|The structureID attribute uniquely identifies the structure for the purpose of referencing it from the payload. This is only used in structure specific formats. Although it is required, it is only useful when more than one data set is present in the message.
959 |dimensionAtObservation|ObservationDimension Type|The dimensionAtObservation is used to reference the dimension at the observation level for data messages. This can also be given the explicit value of "AllDimensions" which denotes that the cross sectional data is in the flat format.
960 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
961 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
962
963 Element Documentation:
964
965 |**Name**|**Type**|**Documentation**
966 |ProvisionAgrement|ProvisionAgreementRe ferenceType|ProvisionAgreement references a provision agreement which the data is reported against.
967 |StructureUsage|DataflowReferenceTyp e|StructureUsage references a dataflow which the data is reported against.
968 |Structure|DataStructureReferen ceType|Structure references the data structure definition which defines the structure of the data.
969
970 **GenericTimeSeriesDataStructureType: **GenericTimeSeriesDataStructureType defines the structural information for a generic time series based data set. The dimension at the observation level is fixed to be TIME_PERIOD.
971
972 Derivation:
973
974 * //PayloadStructureType// (restriction)
975 ** //DataStructureType// (restriction)
976 *** GenericDataStructureType (restriction)
977 **** GenericTimeSeriesDataStructureType
978
979 Attributes:
980 structureID, dimensionAtObservation, serviceURL?, structureURL?
981
982 Content:
983 (ProvisionAgrement | StructureUsage | Structure)
984
985 Attribute Documentation:
986
987 |**Name**|**Type**|**Documentation**
988 |structureID|xs:ID|The structureID attribute uniquely identifies the structure for the purpose of referencing it from the payload. This is only used in structure specific formats. Although it is required, it is only useful when more than one data set is present in the message.
989 |dimensionAtObservation (fixed: TIME_PERIOD)|ObservationDimension Type|The dimensionAtObservation is used to reference the dimension at the observation level for data messages. This can also be given the explicit value of "AllDimensions" which denotes that the cross sectional data is in the flat format.
990 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
991 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
992
993 Element Documentation:
994
995 |**Name**|**Type**|**Documentation**
996 |ProvisionAgrement|ProvisionAgreementRe ferenceType|ProvisionAgreement references a provision agreement which the data is reported against.
997 |StructureUsage|DataflowReferenceTyp e|StructureUsage references a dataflow which the data is reported against.
998 |Structure|DataStructureReferen ceType|Structure references the data structure definition which defines the structure of the data.
999
1000 **StructureSpecificDataStructureType: **StructureSpecificDataStructureType defines the structural information for a structured data set. In addition to referencing the data structure or dataflow which defines the structure of the data, the namespace for the data structure specific schema as well as which dimension is used at the observation level must be provided. It is also necessary to state whether the format uses explicit measures, although this is technically only applicable is the dimension at the observation level is the measure dimension or the flat data format is used.
1001
1002 Derivation:
1003
1004 * //PayloadStructureType// (restriction)
1005 ** //DataStructureType// (restriction)
1006 *** StructureSpecificDataStructureType
1007
1008 Attributes:
1009 structureID, schemaURL?, namespace, dimensionAtObservation, explicitMeasures?, serviceURL?, structureURL?
1010
1011 Content:
1012 (ProvisionAgrement | StructureUsage | Structure)
1013
1014 Attribute Documentation:
1015
1016 |**Name**|**Type**|**Documentation**
1017 |structureID|xs:ID|The structureID attribute uniquely identifies the structure for the purpose of referencing it from the payload. This is only used in structure specific formats. Although it is required, it is only useful when more than one data set is present in the message.
1018 |schemaURL|xs:anyURI|The schemaURL attribute provides a location from which the structure specific schema can be located.
1019 |namespace|xs:anyURI|The namespace attribute is used to provide the namespace for structure-specific formats. By communicating this information in the header, it is possible to generate the structure specific schema while processing the message.
1020 |dimensionAtObservation|ObservationDimension Type|The dimensionAtObservation is used to reference the dimension at the observation level for data messages. This can also be given the explicit value of "AllDimensions" which denotes that the cross sectional data is in the flat format.
1021 |explicitMeasures (default: false)|xs:boolean|The explicitMeasures indicates whether explicit measures are used in the cross sectional format. This is only applicable for the measure dimension as the dimension at the observation level or the flat structure.
1022 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
1023 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
1024
1025 Element Documentation:
1026
1027 |**Name**|**Type**|**Documentation**
1028 |ProvisionAgrement|ProvisionAgreementRe ferenceType|ProvisionAgreement references a provision agreement which the data is reported against.
1029 |StructureUsage|DataflowReferenceTyp e|StructureUsage references a dataflow which the data is reported against.
1030 |Structure|DataStructureReferen ceType|Structure references the data structure definition which defines the structure of the data.
1031
1032 **StructureSpecificDataTimeSeriesStructureType: **StructureSpecificDataTimeSeriesStructureType defines the structural information for a structure definition specific time series data set. The dimension at the observation level is fixed to be TIME_PERIOD.
1033
1034 Derivation:
1035
1036 * //PayloadStructureType// (restriction)
1037 ** //DataStructureType// (restriction)
1038 *** StructureSpecificDataStructureType (restriction)
1039 **** StructureSpecificDataTimeSeriesStructureType
1040
1041 Attributes:
1042 structureID, schemaURL?, namespace, dimensionAtObservation, serviceURL?, structureURL?
1043
1044 Content:
1045 (ProvisionAgrement | StructureUsage | Structure)
1046
1047 Attribute Documentation:
1048
1049 |**Name**|**Type**|**Documentation**
1050 |structureID|xs:ID|The structureID attribute uniquely identifies the structure for the purpose of referencing it from the payload. This is only used in structure specific formats. Although it is required, it is only useful when more than one data set is present in the message.
1051 |schemaURL|xs:anyURI|The schemaURL attribute provides a location from which the structure specific schema can be located.
1052 |namespace|xs:anyURI|The namespace attribute is used to provide the namespace for structure-specific formats. By communicating this information in the header, it is possible to generate the structure specific schema while processing the message.
1053 |dimensionAtObservation (fixed: TIME_PERIOD)|ObservationDimension Type|The dimensionAtObservation is used to reference the dimension at the observation level for data messages. This can also be given the explicit value of "AllDimensions" which denotes that the cross sectional data is in the flat format.
1054 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
1055 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
1056
1057 Element Documentation:
1058
1059 |**Name**|**Type**|**Documentation**
1060 |ProvisionAgrement|ProvisionAgreementRe ferenceType|ProvisionAgreement references a provision agreement which the data is reported against.
1061 |StructureUsage|DataflowReferenceTyp e|StructureUsage references a dataflow which the data is reported against.
1062 |Structure|DataStructureReferen ceType|Structure references the data structure definition which defines the structure of the data.
1063
1064 //**MetadataStructureType**//**: **MetadataStructureType is an abstract base type the forms the basis of the structural information for any metadata message. A reference to the metadata structure definition or a metadataflow must be provided. This can be used to determine the structure of the message.
1065
1066 Derivation:
1067
1068 * //PayloadStructureType// (restriction)
1069 ** //MetadataStructureType//
1070
1071 Attributes:
1072 structureID, schemaURL?, namespace?, serviceURL?, structureURL?
1073
1074 Content:
1075 (ProvisionAgrement | StructureUsage | Structure)
1076
1077 Attribute Documentation:
1078
1079 |**Name**|**Type**|**Documentation**
1080 |structureID|xs:ID|The structureID attribute uniquely identifies the structure for the purpose of referencing it from the payload. This is only used in structure specific formats. Although it is required, it is only useful when more than one data set is present in the message.
1081 |schemaURL|xs:anyURI|The schemaURL attribute provides a location from which the structure specific schema can be located.
1082 |namespace|xs:anyURI|The namespace attribute is used to provide the namespace for structure-specific formats. By communicating this information in the header, it is possible to generate the structure specific schema while processing the message.
1083 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
1084 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
1085
1086 Element Documentation:
1087
1088 |**Name**|**Type**|**Documentation**
1089 |ProvisionAgrement|ProvisionAgreementRe ferenceType|ProvisionAgreement references a provision agreement which the metadata is reported against.
1090 |StructureUsage|MetadataflowReferenc eType|StructureUsage references a metadataflow which the metadata is reported against.
1091 |Structure|MetadataStructureRef erenceType|Structure references the metadata structure definition which defines the structure of the metadata.
1092
1093 **StructureSpecificMetadataStructureType: **StructureSpecificMetadataStructureType defines the structural information for a structured metadata message.
1094
1095 Derivation:
1096
1097 * //PayloadStructureType// (restriction)
1098 ** //MetadataStructureType// (restriction)
1099 *** StructureSpecificMetadataStructureType
1100
1101 Attributes:
1102 structureID, schemaURL?, namespace, serviceURL?, structureURL?
1103
1104 Content:
1105 (ProvisionAgrement | StructureUsage | Structure)
1106
1107 Attribute Documentation:
1108
1109 |**Name**|**Type**|**Documentation**
1110 |structureID|xs:ID|The structureID attribute uniquely identifies the structure for the purpose of referencing it from the payload. This is only used in structure specific formats. Although it is required, it is only useful when more than one data set is present in the message.
1111 |schemaURL|xs:anyURI|The schemaURL attribute provides a location from which the structure specific schema can be located.
1112 |namespace|xs:anyURI|The namespace attribute is used to provide the namespace for structure-specific formats. By communicating this information in the header, it is possible to generate the structure specific schema while processing the message.
1113 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
1114 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
1115
1116 Element Documentation:
1117
1118 |**Name**|**Type**|**Documentation**
1119 |ProvisionAgrement|ProvisionAgreementRe ferenceType|ProvisionAgreement references a provision agreement which the metadata is reported against.
1120 |StructureUsage|MetadataflowReferenc eType|StructureUsage references a metadataflow which the metadata is reported against.
1121 |Structure|MetadataStructureRef erenceType|Structure references the metadata structure definition which defines the structure of the metadata.
1122
1123 **GenericMetadataStructureType: **GenericMetadataStructureType defines the structural information for a generic metadata message.
1124
1125 Derivation:
1126
1127 * //PayloadStructureType// (restriction)
1128 ** //MetadataStructureType// (restriction)
1129 *** GenericMetadataStructureType
1130
1131 Attributes:
1132 structureID, schemaURL?, serviceURL?, structureURL?
1133
1134 Content:
1135 (ProvisionAgrement | StructureUsage | Structure)
1136
1137 Attribute Documentation:
1138
1139 |**Name**|**Type**|**Documentation**
1140 |structureID|xs:ID|The structureID attribute uniquely identifies the structure for the purpose of referencing it from the payload. This is only used in structure specific formats. Although it is required, it is only useful when more than one data set is present in the message.
1141 |schemaURL|xs:anyURI|The schemaURL attribute provides a location from which the structure specific schema can be located.
1142 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
1143 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
1144
1145 Element Documentation:
1146
1147 |**Name**|**Type**|**Documentation**
1148 |ProvisionAgrement|ProvisionAgreementRe ferenceType|ProvisionAgreement references a provision agreement which the metadata is reported against.
1149 |StructureUsage|MetadataflowReferenc eType|StructureUsage references a metadataflow which the metadata is reported against.
1150 |Structure|MetadataStructureRef erenceType|Structure references the metadata structure definition which defines the structure of the metadata.
1151
1152 **EmptyType: **EmptyType is an empty complex type for elements where the presence of the tag indicates all that is necessary.
1153
1154 Content:
1155 {Empty}
1156
1157 //**ReferenceType**//**: **ReferenceType is an abstract base type. It is used as the basis for all references, to all for a top level generic object reference that can be substituted with an explicit reference to any object. Any reference can consist of a Ref (which contains all required reference fields separately) and/or a URN. These must result in the identification of the same object. Note that the Ref and URN elements are local and unqualified in order to allow for refinement of this structure outside of the namespace. This allows any reference to further refined by a different namespace. For example, a metadata structure definition specific metadata set might wish to restrict the URN to only allow for a value from an enumerated list. The general URN structure, for the purpose of mapping the reference fields is as follows: urn:sdmx:org.package-name.class-name=agency-id:(maintainable-parent-object-id[maintainable-parent-object-version].)?(container-object-id.)?object-id([object-version])?.
1158
1159 Content:
1160 ( (Ref, URN?) | URN)
1161
1162 Element Documentation:
1163
1164 |**Name**|**Type**|**Documentation**
1165 |Ref|//RefBaseType//|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
1166 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
1167 |URN|xs:anyURI|URN is used to hold the URN of the referenced object.
1168
1169 //**RefBaseType**//**: **RefBaseType is an abstract base type the defines the basis for any set of complete reference fields. This should be refined by derived types so that only the necessary fields are available and required as necessary. This can be used for both full and local references (when some of the values are implied from another context). A local reference is indicated with the local attribute. The values in this type correspond directly to the components of the URN structure, and thus can be used to compose a URN when the local attribute value is false. As this is the case, any reference components which are not part of the URN structure should not be present in the derived types.
1170
1171 Attributes:
1172 agencyID?, maintainableParentID?, maintainableParentVersion?, containerID?, id, version?, local?, class?, package?
1173
1174 Content:
1175 {Empty}
1176
1177 Attribute Documentation:
1178
1179 |**Name**|**Type**|**Documentation**
1180 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
1181 |maintainableParentID|IDType|The maintainableParentID attribute identifies the maintainable object in which the referenced object is defined, if applicable (maintainable-parent-object-id in the URN structure). This is only used in references where the referenced object is not itself maintainable.
1182 |maintainableParentVersion|VersionType|The maintainableParentVersion attribute identifies the version of the maintainable object in which the referenced object is defined (maintainable-parent-object-version in the URN structure). This is only used in references where the referenced object is not itself maintainable. This should only be used when the maintainableParentID is present. If this is available, a default of 1.0 will always apply.
1183 |containerID|NestedIDType|The containerID attribute identifies the object within a maintainable object in which the referenced object is defined (container-object-id in the URN structure). This is only used in references where the referenced object is not contained directly within a maintainable object (e.g. a Component within a ComponentList, within a maintainable Structure). If the container has a fixed identifier, this attribute will not be present.
1184 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
1185 |version|VersionType|The version attribute identifies the version of the object being reference, if applicable. If this is available, a default value of 1.0 will always apply.
1186 |local|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
1187 |class|ObjectTypeCodelistTy pe|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1188 |package|PackageTypeCodelistT ype|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1189
1190 **ObjectReferenceType: **ObjectReferenceType is a generic reference which allows for any object to be referenced. The type of object actually referenced can be determined from the URN or from the class attribute of the full set of reference fields.
1191
1192 Derivation:
1193
1194 * //ReferenceType// (restriction)
1195 ** ObjectReferenceType
1196
1197 Content:
1198 ( (Ref, URN?) | URN)
1199
1200 Element Documentation:
1201
1202 |**Name**|**Type**|**Documentation**
1203 |Ref|ObjectRefType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
1204 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
1205 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
1206
1207 **ObjectRefType: **ObjectRefType contains a set of reference fields for the purpose of referencing any object. This cannot be a local reference, therefore the agency identifier is required. It is also required that the class and package be supplied for the referenced object such that a complete URN reference can be built from the values provided. Note that this is not capable of fully validating that all necessary fields are supplied for a given object type.
1208
1209 Derivation:
1210
1211 * //RefBaseType// (restriction)
1212 ** ObjectRefType
1213
1214 Attributes:
1215 agencyID, maintainableParentID?, maintainableParentVersion?, containerID?, id, version?, local?, class, package
1216
1217 Content:
1218 {Empty}
1219
1220 Attribute Documentation:
1221
1222 |**Name**|**Type**|**Documentation**
1223 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
1224 |maintainableParentID|IDType|The maintainableParentID attribute identifies the maintainable object in which the referenced object is defined, if applicable (maintainable-parent-object-id in the URN structure). This is only used in references where the referenced object is not itself maintainable.
1225 |maintainableParentVersion|VersionType|The maintainableParentVersion attribute identifies the version of the maintainable object in which the referenced object is defined (maintainable-parent-object-version in the URN structure). This is only used in references where the referenced object is not itself maintainable. This should only be used when the maintainableParentID is present. If this is available, a default of 1.0 will always apply.
1226 |containerID|NestedIDType|The containerID attribute identifies the object within a maintainable object in which the referenced object is defined (container-object-id in the URN structure). This is only used in references where the referenced object is not contained directly within a maintainable object (e.g. a Component within a ComponentList, within a maintainable Structure). If the container has a fixed identifier, this attribute will not be present.
1227 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
1228 |version|VersionType|The version attribute identifies the version of the object being reference, if applicable. If this is available, a default value of 1.0 will always apply.
1229 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
1230 |class|ObjectTypeCodelistTy pe|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1231 |package|PackageTypeCodelistT ype|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1232
1233 //**MaintainableRefBaseType**//**: **MaintainableRefBaseType is an abstract base type for referencing a maintainable object.
1234
1235 Derivation:
1236
1237 * //RefBaseType// (restriction)
1238 ** //MaintainableRefBaseType//
1239
1240 Attributes:
1241 agencyID, id, version?, local?, class?, package?
1242
1243 Content:
1244 {Empty}
1245
1246 Attribute Documentation:
1247
1248 |**Name**|**Type**|**Documentation**
1249 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
1250 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
1251 |version (default: 1.0)|VersionType|The version attribute identifies the version of the object being reference, if applicable. If this is available, a default value of 1.0 will always apply.
1252 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
1253 |class|MaintainableTypeCode listType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1254 |package|PackageTypeCodelistT ype|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1255
1256 **MaintainableRefType: **MaintainableRefType contains a complete set of reference fields for referencing any maintainable object.
1257
1258 Derivation:
1259
1260 * //RefBaseType// (restriction)
1261 ** //MaintainableRefBaseType// (restriction)
1262 *** MaintainableRefType
1263
1264 Attributes:
1265 agencyID, id, version?, local?, class, package
1266
1267 Content:
1268 {Empty}
1269
1270 Attribute Documentation:
1271
1272 |**Name**|**Type**|**Documentation**
1273 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
1274 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
1275 |version (default: 1.0)|VersionType|The version attribute identifies the version of the object being reference, if applicable. If this is available, a default value of 1.0 will always apply.
1276 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
1277 |class|ConcreteMaintainable TypeCodelistType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1278 |package|PackageTypeCodelistT ype|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1279
1280 //**ItemSchemeRefBaseType**//**: **ItemSchemeRefBaseType is an abstract base type for referencing an item scheme.
1281
1282 Derivation:
1283
1284 * //RefBaseType// (restriction)
1285 ** //MaintainableRefBaseType// (restriction)
1286 *** //ItemSchemeRefBaseType//
1287
1288 Attributes:
1289 agencyID, id, version?, local?, class?, package?
1290
1291 Content:
1292 {Empty}
1293
1294 Attribute Documentation:
1295
1296 |**Name**|**Type**|**Documentation**
1297 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
1298 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
1299 |version (default: 1.0)|VersionType|The version attribute identifies the version of the object being reference, if applicable. If this is available, a default value of 1.0 will always apply.
1300 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
1301 |class|ItemSchemeTypeCodeli stType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1302 |package|ItemSchemePackageTyp eCodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1303
1304 **ItemSchemeRefType: **ItemSchemeRefType contains a complete set of reference fields for referencing any item scheme. The class and package a required so that the reference is explicit as to the exact object being referenced.
1305
1306 Derivation:
1307
1308 * //RefBaseType// (restriction)
1309 ** //MaintainableRefBaseType// (restriction)
1310 *** //ItemSchemeRefBaseType// (restriction)
1311 **** ItemSchemeRefType
1312
1313 Attributes:
1314 agencyID, id, version?, local?, class, package
1315
1316 Content:
1317 {Empty}
1318
1319 Attribute Documentation:
1320
1321 |**Name**|**Type**|**Documentation**
1322 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
1323 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
1324 |version (default: 1.0)|VersionType|The version attribute identifies the version of the object being reference, if applicable. If this is available, a default value of 1.0 will always apply.
1325 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
1326 |class|ItemSchemeTypeCodeli stType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1327 |package|ItemSchemePackageTyp eCodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1328
1329 //**StructureOrUsageRefBaseType**//**: **StructureOrUsageRefBaseType is an abstract base type for referencing a structure or structure usage.
1330
1331 Derivation:
1332
1333 * //RefBaseType// (restriction)
1334 ** //MaintainableRefBaseType// (restriction)
1335 *** //StructureOrUsageRefBaseType//
1336
1337 Attributes:
1338 agencyID, id, version?, local?, class?, package?
1339
1340 Content:
1341 {Empty}
1342
1343 Attribute Documentation:
1344
1345 |**Name**|**Type**|**Documentation**
1346 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
1347 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
1348 |version (default: 1.0)|VersionType|The version attribute identifies the version of the object being reference, if applicable. If this is available, a default value of 1.0 will always apply.
1349 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
1350 |class|StructureOrUsageType CodelistType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1351 |package|StructurePackageType CodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1352
1353 //**StructureRefBaseType**//**: **StructureRefBaseType is an abstract base type for referencing a structure.
1354
1355 Derivation:
1356
1357 * //RefBaseType// (restriction)
1358 ** //MaintainableRefBaseType// (restriction)
1359 *** //StructureOrUsageRefBaseType// (restriction)
1360 **** //StructureRefBaseType//
1361
1362 Attributes:
1363 agencyID, id, version?, local?, class?, package?
1364
1365 Content:
1366 {Empty}
1367
1368 Attribute Documentation:
1369
1370 |**Name**|**Type**|**Documentation**
1371 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
1372 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
1373 |version (default: 1.0)|VersionType|The version attribute identifies the version of the object being reference, if applicable. If this is available, a default value of 1.0 will always apply.
1374 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
1375 |class|StructureTypeCodelis tType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1376 |package|StructurePackageType CodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1377
1378 **StructureRefType: **StructureRefType contains a set of reference fields for referencing any structure.
1379
1380 Derivation:
1381
1382 * //RefBaseType// (restriction)
1383 ** //MaintainableRefBaseType// (restriction)
1384 *** //StructureOrUsageRefBaseType// (restriction)
1385 **** //StructureRefBaseType// (restriction)
1386 ***** StructureRefType
1387
1388 Attributes:
1389 agencyID, id, version?, local?, class, package
1390
1391 Content:
1392 {Empty}
1393
1394 Attribute Documentation:
1395
1396 |**Name**|**Type**|**Documentation**
1397 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
1398 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
1399 |version (default: 1.0)|VersionType|The version attribute identifies the version of the object being reference, if applicable. If this is available, a default value of 1.0 will always apply.
1400 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
1401 |class|StructureTypeCodelis tType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1402 |package|StructurePackageType CodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1403
1404 //**StructureUsageRefBaseType**//**: **StructureUsageRefBaseType is an abstract base type for referencing a structure usage.
1405
1406 Derivation:
1407
1408 * //RefBaseType// (restriction)
1409 ** //MaintainableRefBaseType// (restriction)
1410 *** //StructureOrUsageRefBaseType// (restriction)
1411 **** //StructureUsageRefBaseType//
1412
1413 Attributes:
1414 agencyID, id, version?, local?, class?, package?
1415
1416 Content:
1417 {Empty}
1418
1419 Attribute Documentation:
1420
1421 |**Name**|**Type**|**Documentation**
1422 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
1423 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
1424 |version (default: 1.0)|VersionType|The version attribute identifies the version of the object being reference, if applicable. If this is available, a default value of 1.0 will always apply.
1425 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
1426 |class|StructureUsageTypeCo delistType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1427 |package|StructurePackageType CodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1428
1429 **StructureUsageRefType: **StructureUsageRefType contains a set of reference fields for referencing any structure usage.
1430
1431 Derivation:
1432
1433 * //RefBaseType// (restriction)
1434 ** //MaintainableRefBaseType// (restriction)
1435 *** //StructureOrUsageRefBaseType// (restriction)
1436 **** //StructureUsageRefBaseType// (restriction)
1437 ***** StructureUsageRefType
1438
1439 Attributes:
1440 agencyID, id, version?, local?, class, package
1441
1442 Content:
1443 {Empty}
1444
1445 Attribute Documentation:
1446
1447 |**Name**|**Type**|**Documentation**
1448 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
1449 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
1450 |version (default: 1.0)|VersionType|The version attribute identifies the version of the object being reference, if applicable. If this is available, a default value of 1.0 will always apply.
1451 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
1452 |class|StructureUsageTypeCo delistType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1453 |package|StructurePackageType CodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1454
1455 //**ChildObjectRefBaseType**//**: **ChildObjectRefBaseType is an abstract base type for referencing any child object defined directly within a maintainable object.
1456
1457 Derivation:
1458
1459 * //RefBaseType// (restriction)
1460 ** //ChildObjectRefBaseType//
1461
1462 Attributes:
1463 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
1464
1465 Content:
1466 {Empty}
1467
1468 Attribute Documentation:
1469
1470 |**Name**|**Type**|**Documentation**
1471 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
1472 |maintainableParentID|IDType|The maintainableParentID attribute identifies the maintainable object in which the referenced object is defined, if applicable (maintainable-parent-object-id in the URN structure). This is only used in references where the referenced object is not itself maintainable.
1473 |maintainableParentVersion (default: 1.0)|VersionType|The maintainableParentVersion attribute identifies the version of the maintainable object in which the referenced object is defined (maintainable-parent-object-version in the URN structure). This is only used in references where the referenced object is not itself maintainable. This should only be used when the maintainableParentID is present. If this is available, a default of 1.0 will always apply.
1474 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
1475 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
1476 |class|ObjectTypeCodelistTy pe|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1477 |package|PackageTypeCodelistT ype|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1478
1479 //**ContainerChildObjectRefBaseType**//**: **ContainerChildObjectRefBaseType is an abstract base type for referencing any child object within container defined in a maintainable object.
1480
1481 Derivation:
1482
1483 * //RefBaseType// (restriction)
1484 ** //ContainerChildObjectRefBaseType//
1485
1486 Attributes:
1487 agencyID, maintainableParentID, maintainableParentVersion?, containerID?, id, version?, local?, class?, package?
1488
1489 Content:
1490 {Empty}
1491
1492 Attribute Documentation:
1493
1494 |**Name**|**Type**|**Documentation**
1495 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
1496 |maintainableParentID|IDType|The maintainableParentID attribute identifies the maintainable object in which the referenced object is defined, if applicable (maintainable-parent-object-id in the URN structure). This is only used in references where the referenced object is not itself maintainable.
1497 |maintainableParentVersion (default: 1.0)|VersionType|The maintainableParentVersion attribute identifies the version of the maintainable object in which the referenced object is defined (maintainable-parent-object-version in the URN structure). This is only used in references where the referenced object is not itself maintainable. This should only be used when the maintainableParentID is present. If this is available, a default of 1.0 will always apply.
1498 |containerID|NestedIDType|The containerID attribute identifies the object within a maintainable object in which the referenced object is defined (container-object-id in the URN structure). This is only used in references where the referenced object is not contained directly within a maintainable object (e.g. a Component within a ComponentList, within a maintainable Structure). If the container has a fixed identifier, this attribute will not be present.
1499 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
1500 |version|VersionType|The version attribute identifies the version of the object being reference, if applicable. If this is available, a default value of 1.0 will always apply.
1501 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
1502 |class|ObjectTypeCodelistTy pe|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1503 |package|PackageTypeCodelistT ype|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1504
1505 //**ItemRefBaseType**//**: **ItemRefBaseType is an abstract base type for referencing an item within an item scheme.
1506
1507 Derivation:
1508
1509 * //RefBaseType// (restriction)
1510 ** //ChildObjectRefBaseType// (restriction)
1511 *** //ItemRefBaseType//
1512
1513 Attributes:
1514 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
1515
1516 Content:
1517 {Empty}
1518
1519 Attribute Documentation:
1520
1521 |**Name**|**Type**|**Documentation**
1522 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
1523 |maintainableParentID|IDType|The maintainableParentID references the item scheme in which the item being referenced is defined.
1524 |maintainableParentVersion (default: 1.0)|VersionType|The maintainableParentVersion attribute references the version of the item scheme in which the item being referenced is defined. If not supplied, a default value of 1.0 is assumed.
1525 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
1526 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
1527 |class|ItemTypeCodelistType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1528 |package|ItemSchemePackageTyp eCodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1529
1530 //**ComponentListRefBaseType**//**: **ComponentListRefBaseType is an abstract base type for referencing a component list within a structure.
1531
1532 Derivation:
1533
1534 * //RefBaseType// (restriction)
1535 ** //ChildObjectRefBaseType// (restriction)
1536 *** //ComponentListRefBaseType//
1537
1538 Attributes:
1539 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
1540
1541 Content:
1542 {Empty}
1543
1544 Attribute Documentation:
1545
1546 |**Name**|**Type**|**Documentation**
1547 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
1548 |maintainableParentID|IDType|The maintainableParentID references the structure in which the component list being referenced is defined.
1549 |maintainableParentVersion (default: 1.0)|VersionType|The maintainableParentVersion attribute references the version of the structure in which the component list being referenced is defined. If not supplied, a default value of 1.0 is assumed.
1550 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
1551 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
1552 |class|ComponentListTypeCod elistType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1553 |package|StructurePackageType CodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1554
1555 //**ComponentRefBaseType**//**: **ComponentRefBaseType is an abstract base type for referencing a component contained in a component list within a structure.
1556
1557 Derivation:
1558
1559 * //RefBaseType// (restriction)
1560 ** //ContainerChildObjectRefBaseType// (restriction)
1561 *** //ComponentRefBaseType//
1562
1563 Attributes:
1564 agencyID, maintainableParentID, maintainableParentVersion?, containerID?, id, version?, local?, class?, package?
1565
1566 Content:
1567 {Empty}
1568
1569 Attribute Documentation:
1570
1571 |**Name**|**Type**|**Documentation**
1572 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
1573 |maintainableParentID|IDType|The maintainableParentID references the structure in which the component being referenced is defined.
1574 |maintainableParentVersion (default: 1.0)|VersionType|The maintainableParentVersion attribute references the version of the structure in which the component being referenced is defined. If not supplied, a default value of 1.0 is assumed.
1575 |containerID|NestedIDType|The containerID attribute references the component list of that contains the component being referenced. It is optional for the cases where the component list has a fixed identifier. Specific implementations of this will prohibit or require this accordingly.
1576 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
1577 |version|VersionType|The version attribute identifies the version of the object being reference, if applicable. If this is available, a default value of 1.0 will always apply.
1578 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
1579 |class|ComponentTypeCodelis tType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1580 |package|StructurePackageType CodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1581
1582 **AnyCodelistRefType: **AnyCodelistRefType is a type for referencing any codelist object (either a codelist or a hierarchical codelist).
1583
1584 Derivation:
1585
1586 * //RefBaseType// (restriction)
1587 ** //MaintainableRefBaseType// (restriction)
1588 *** AnyCodelistRefType
1589
1590 Attributes:
1591 agencyID, id, version?, local?, class, package?
1592
1593 Content:
1594 {Empty}
1595
1596 Attribute Documentation:
1597
1598 |**Name**|**Type**|**Documentation**
1599 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
1600 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
1601 |version (default: 1.0)|VersionType|The version attribute identifies the version of the object being reference, if applicable. If this is available, a default value of 1.0 will always apply.
1602 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
1603 |class|CodelistTypeCodelist Type|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1604 |package (fixed: codelist)|PackageTypeCodelistT ype|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1605
1606 **StructureOrUsageRefType: **StructureOrUsageRefType is a type for referencing a structure or structure usage.
1607
1608 Derivation:
1609
1610 * //RefBaseType// (restriction)
1611 ** //MaintainableRefBaseType// (restriction)
1612 *** //StructureOrUsageRefBaseType// (restriction)
1613 **** StructureOrUsageRefType
1614
1615 Attributes:
1616 agencyID, id, version?, local?, class, package
1617
1618 Content:
1619 {Empty}
1620
1621 Attribute Documentation:
1622
1623 |**Name**|**Type**|**Documentation**
1624 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
1625 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
1626 |version (default: 1.0)|VersionType|The version attribute identifies the version of the object being reference, if applicable. If this is available, a default value of 1.0 will always apply.
1627 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
1628 |class|StructureOrUsageType CodelistType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1629 |package|StructurePackageType CodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1630
1631 //**LocalIdentifiableRefBaseType**//**: **LocalIdentifiableRefBaseType is an abstract base type which provides a local reference to any identifiable object.
1632
1633 Derivation:
1634
1635 * //RefBaseType// (restriction)
1636 ** //LocalIdentifiableRefBaseType//
1637
1638 Attributes:
1639 containerID?, id, local?, class?, package?
1640
1641 Content:
1642 {Empty}
1643
1644 Attribute Documentation:
1645
1646 |**Name**|**Type**|**Documentation**
1647 |containerID|NestedIDType|The containerID attribute identifies the object within a maintainable object in which the referenced object is defined (container-object-id in the URN structure). This is only used in references where the referenced object is not contained directly within a maintainable object (e.g. a Component within a ComponentList, within a maintainable Structure). If the container has a fixed identifier, this attribute will not be present.
1648 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
1649 |local (fixed: true)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
1650 |class|ObjectTypeCodelistTy pe|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1651 |package|PackageTypeCodelistT ype|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1652
1653 //**LocalItemRefBaseType**//**: **LocalItemRefBaseType is an abstract base type which provides a local reference to a item object.
1654
1655 Derivation:
1656
1657 * //RefBaseType// (restriction)
1658 ** //LocalIdentifiableRefBaseType// (restriction)
1659 *** //LocalItemRefBaseType//
1660
1661 Attributes:
1662 id, local?, class?, package?
1663
1664 Content:
1665 {Empty}
1666
1667 Attribute Documentation:
1668
1669 |**Name**|**Type**|**Documentation**
1670 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
1671 |local (fixed: true)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
1672 |class|ItemTypeCodelistType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1673 |package|ItemSchemePackageTyp eCodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1674
1675 //**LocalComponentListRefBaseType**//**: **LocalComponentListRefBaseType is an abstract base type which provides a local reference to a component list object.
1676
1677 Derivation:
1678
1679 * //RefBaseType// (restriction)
1680 ** //LocalIdentifiableRefBaseType// (restriction)
1681 *** //LocalComponentListRefBaseType//
1682
1683 Attributes:
1684 id, local?, class?, package?
1685
1686 Content:
1687 {Empty}
1688
1689 Attribute Documentation:
1690
1691 |**Name**|**Type**|**Documentation**
1692 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
1693 |local (fixed: true)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
1694 |class|ComponentListTypeCod elistType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1695 |package|StructurePackageType CodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1696
1697 //**LocalComponentListComponentRefBaseType**//**: **LocalComponentRefBaseType is an abstract base type which provides a local reference to a component object.
1698
1699 Derivation:
1700
1701 * //RefBaseType// (restriction)
1702 ** //LocalIdentifiableRefBaseType// (restriction)
1703 *** //LocalComponentListComponentRefBaseType//
1704
1705 Attributes:
1706 containerID?, id, local?, class?, package?
1707
1708 Content:
1709 {Empty}
1710
1711 Attribute Documentation:
1712
1713 |**Name**|**Type**|**Documentation**
1714 |containerID|IDType|The containerID attribute identifies the object within a maintainable object in which the referenced object is defined (container-object-id in the URN structure). This is only used in references where the referenced object is not contained directly within a maintainable object (e.g. a Component within a ComponentList, within a maintainable Structure). If the container has a fixed identifier, this attribute will not be present.
1715 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
1716 |local (fixed: true)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
1717 |class|ObjectTypeCodelistTy pe|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1718 |package|PackageTypeCodelistT ype|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1719
1720 **LocalComponentListComponentRefType: **LocalComponentListComponentRefType provides a local reference to any component object within a specific component list. References for both of these are required as well as an indication of which type of type of component is being referenced via the class attribute.
1721
1722 Derivation:
1723
1724 * //RefBaseType// (restriction)
1725 ** //LocalIdentifiableRefBaseType// (restriction)
1726 *** //LocalComponentListComponentRefBaseType// (restriction)
1727 **** LocalComponentListComponentRefType
1728
1729 Attributes:
1730 containerID, id, local?, class, package
1731
1732 Content:
1733 {Empty}
1734
1735 Attribute Documentation:
1736
1737 |**Name**|**Type**|**Documentation**
1738 |containerID|IDType|The containerID attribute identifies the object within a maintainable object in which the referenced object is defined (container-object-id in the URN structure). This is only used in references where the referenced object is not contained directly within a maintainable object (e.g. a Component within a ComponentList, within a maintainable Structure). If the container has a fixed identifier, this attribute will not be present.
1739 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
1740 |local (fixed: true)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
1741 |class|ComponentTypeCodelis tType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1742 |package|StructurePackageType CodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1743
1744 //**LocalComponentRefBaseType**//**: **LocalComponentRefBaseType is an abstract base type which provides a local reference to a component object.
1745
1746 Derivation:
1747
1748 * //RefBaseType// (restriction)
1749 ** //LocalIdentifiableRefBaseType// (restriction)
1750 *** //LocalComponentListComponentRefBaseType// (restriction)
1751 **** //LocalComponentRefBaseType//
1752
1753 Attributes:
1754 id, local?, class?, package?
1755
1756 Content:
1757 {Empty}
1758
1759 Attribute Documentation:
1760
1761 |**Name**|**Type**|**Documentation**
1762 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
1763 |local (fixed: true)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
1764 |class|ObjectTypeCodelistTy pe|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1765 |package|PackageTypeCodelistT ype|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1766
1767 **LocalComponentRefType: **LocalComponentRefType provides a local reference to any type component object.
1768
1769 Derivation:
1770
1771 * //RefBaseType// (restriction)
1772 ** //LocalIdentifiableRefBaseType// (restriction)
1773 *** //LocalComponentListComponentRefBaseType// (restriction)
1774 **** //LocalComponentRefBaseType// (restriction)
1775 ***** LocalComponentRefType
1776
1777 Attributes:
1778 id, local?, class, package
1779
1780 Content:
1781 {Empty}
1782
1783 Attribute Documentation:
1784
1785 |**Name**|**Type**|**Documentation**
1786 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
1787 |local (fixed: true)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
1788 |class|ComponentTypeCodelis tType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1789 |package|StructurePackageType CodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1790
1791 **AnyLocalCodeRefType: **AnyLocalCodeRefType provides a local reference to any code object.
1792
1793 Derivation:
1794
1795 * //RefBaseType// (restriction)
1796 ** AnyLocalCodeRefType
1797
1798 Attributes:
1799 containerID?, id, version?, local?, class?, package?
1800
1801 Content:
1802 {Empty}
1803
1804 Attribute Documentation:
1805
1806 |**Name**|**Type**|**Documentation**
1807 |containerID|IDType|The containerID attribute references the hierarchy which defines the hierarchical code in the case that this reference is for a hierarchical code.
1808 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
1809 |version|VersionType|The version attribute identifies the version of the object being reference, if applicable. If this is available, a default value of 1.0 will always apply.
1810 |local (fixed: true)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
1811 |class|CodeTypeCodelistType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1812 |package (fixed: codelist)|PackageTypeCodelistT ype|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
1813
1814 **URNReferenceType: **URNReferenceType is a type referencing any object via its URN. The exact type of object is not specified, although it can be determined from the URN value.
1815
1816 Derivation:
1817
1818 * //ReferenceType// (restriction)
1819 ** URNReferenceType
1820
1821 Content:
1822 URN
1823
1824 Element Documentation:
1825
1826 |**Name**|**Type**|**Documentation**
1827 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
1828
1829 //**MaintainableReferenceBaseType**//**: **MaintainableReferenceBaseType is an abstract base type for referencing a maintainable object. It consists of a URN and/or a complete set of reference fields; agency, id, and version.
1830
1831 Derivation:
1832
1833 * //ReferenceType// (restriction)
1834 ** //MaintainableReferenceBaseType//
1835
1836 Content:
1837 ( (Ref, URN?) | URN)
1838
1839 Element Documentation:
1840
1841 |**Name**|**Type**|**Documentation**
1842 |Ref|//MaintainableRefBaseT ype//|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
1843 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
1844 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
1845
1846 **MaintainableReferenceType: **MaintainableReferenceType is a type for referencing any maintainable object. It consists of a URN and/or a complete set of reference fields; agency, id, and version.
1847
1848 Derivation:
1849
1850 * //ReferenceType// (restriction)
1851 ** //MaintainableReferenceBaseType// (restriction)
1852 *** MaintainableReferenceType
1853
1854 Content:
1855 ( (Ref, URN?) | URN)
1856
1857 Element Documentation:
1858
1859 |**Name**|**Type**|**Documentation**
1860 |Ref|MaintainableRefType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
1861 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
1862 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
1863
1864 //**LocalIdentifiableReferenceType**//**: **LocalIdentifiableReferenceType is an abstract base type for referencing an identifiable object locally, where the maintainable object in which it is defined is referenced in another context..
1865
1866 Derivation:
1867
1868 * //ReferenceType// (restriction)
1869 ** //LocalIdentifiableReferenceType//
1870
1871 Content:
1872 Ref
1873
1874 Element Documentation:
1875
1876 |**Name**|**Type**|**Documentation**
1877 |Ref|//LocalIdentifiableRef BaseType//|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
1878
1879 //**StructureReferenceBaseType**//**: **StructureReferneceBaseType is a specific type of MaintainableReference that is used for referencing structure definitions. It consists of a URN and/or a complete set of reference fields; agency, id, and version.
1880
1881 Derivation:
1882
1883 * //ReferenceType// (restriction)
1884 ** //MaintainableReferenceBaseType// (restriction)
1885 *** //StructureReferenceBaseType//
1886
1887 Content:
1888 ( (Ref, URN?) | URN)
1889
1890 Element Documentation:
1891
1892 |**Name**|**Type**|**Documentation**
1893 |Ref|//StructureRefBaseType//|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
1894 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
1895 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
1896
1897 **StructureReferenceType: **StructureReferenceType is a specific type of MaintainableReference that is used for referencing any structure. It consists of a URN and/or a complete set of reference fields; agency, id, and version.
1898
1899 Derivation:
1900
1901 * //ReferenceType// (restriction)
1902 ** //MaintainableReferenceBaseType// (restriction)
1903 *** //StructureReferenceBaseType// (restriction)
1904 **** StructureReferenceType
1905
1906 Content:
1907 ( (Ref, URN?) | URN)
1908
1909 Element Documentation:
1910
1911 |**Name**|**Type**|**Documentation**
1912 |Ref|StructureRefType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
1913 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
1914 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
1915
1916 //**StructureUsageReferenceBaseType**//**: **StructureUsageReferenceBaseType is a specific type of MaintainableReference that is used for referencing structure usages. It consists of a URN and/or a complete set of reference fields; agency, id, and version.
1917
1918 Derivation:
1919
1920 * //ReferenceType// (restriction)
1921 ** //MaintainableReferenceBaseType// (restriction)
1922 *** //StructureUsageReferenceBaseType//
1923
1924 Content:
1925 ( (Ref, URN?) | URN)
1926
1927 Element Documentation:
1928
1929 |**Name**|**Type**|**Documentation**
1930 |Ref|//StructureUsageRefBas eType//|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
1931 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
1932 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
1933
1934 **StructureUsageReferenceType: **StructureUsageReferenceType is a specific type of MaintainableReference that is used for referencing any structure usages. It consists of a URN and/or a complete set of reference fields; agency, id, and version.
1935
1936 Derivation:
1937
1938 * //ReferenceType// (restriction)
1939 ** //MaintainableReferenceBaseType// (restriction)
1940 *** //StructureUsageReferenceBaseType// (restriction)
1941 **** StructureUsageReferenceType
1942
1943 Content:
1944 ( (Ref, URN?) | URN)
1945
1946 Element Documentation:
1947
1948 |**Name**|**Type**|**Documentation**
1949 |Ref|StructureUsageRefTyp e|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
1950 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
1951 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
1952
1953 //**ItemSchemeReferenceBaseType**//**: **ItemSchemeReferenceBaseType is a specific type of MaintainableReference that is used for referencing item schemes. It consists of a URN and/or a complete set of reference fields; agency, id, and version.
1954
1955 Derivation:
1956
1957 * //ReferenceType// (restriction)
1958 ** //MaintainableReferenceBaseType// (restriction)
1959 *** //ItemSchemeReferenceBaseType//
1960
1961 Content:
1962 ( (Ref, URN?) | URN)
1963
1964 Element Documentation:
1965
1966 |**Name**|**Type**|**Documentation**
1967 |Ref|//ItemSchemeRefBaseTyp e//|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
1968 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
1969 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
1970
1971 **ItemSchemeReferenceType: **ItemSchemeReferenceType is a reference that is used for referencing any type of item scheme. It consists of a URN and/or a complete set of reference fields; agency, id, and version.
1972
1973 Derivation:
1974
1975 * //ReferenceType// (restriction)
1976 ** //MaintainableReferenceBaseType// (restriction)
1977 *** //ItemSchemeReferenceBaseType// (restriction)
1978 **** ItemSchemeReferenceType
1979
1980 Content:
1981 ( (Ref, URN?) | URN)
1982
1983 Element Documentation:
1984
1985 |**Name**|**Type**|**Documentation**
1986 |Ref|ItemSchemeRefType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
1987 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
1988 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
1989
1990 //**ChildObjectReferenceType**//**: **ChildObjectReferenceType is an abstract base type used for referencing a particular object defined directly within a maintainable object. It consists of a URN and/or a complete set of reference fields; agency, maintainable id (maintainableParentID), maintainable version (maintainableParentVersion), the object id (which can be nested), and optionally the object version (if applicable).
1991
1992 Derivation:
1993
1994 * //ReferenceType// (restriction)
1995 ** //ChildObjectReferenceType//
1996
1997 Content:
1998 ( (Ref, URN?) | URN)
1999
2000 Element Documentation:
2001
2002 |**Name**|**Type**|**Documentation**
2003 |Ref|//ChildObjectRefBaseTy pe//|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
2004 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2005 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2006
2007 //**ContainerChildObjectReferenceType**//**: **ContainerChildObjectReferenceType is an abstract base type used for referencing a particular object defined in a container object within a maintainable object. It consists of a URN and/or a complete set of reference fields; agency, maintainable id (maintainableParentID), maintainable version (maintainableParentVersion), container id (which is optional in order to allow for containers with fixed values to be omitted), container version (if applicable), the object id (which can be nested), and optionally the object version (if applicable).
2008
2009 Derivation:
2010
2011 * //ReferenceType// (restriction)
2012 ** //ContainerChildObjectReferenceType//
2013
2014 Content:
2015 ( (Ref, URN?) | URN)
2016
2017 Element Documentation:
2018
2019 |**Name**|**Type**|**Documentation**
2020 |Ref|//ContainerChildObject RefBaseType//|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
2021 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2022 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2023
2024 //**ItemReferenceType**//**: **ItemReferenceType is an abstract base type used for referencing a particular item within an item scheme. Note that this reference also has the ability to reference items contained within other items inside of the item scheme. It consists of a URN and/or a complete set of reference fields; agency, scheme id (maintainableParentID), scheme version (maintainableParentVersion), and item id (which can be nested).
2025
2026 Derivation:
2027
2028 * //ReferenceType// (restriction)
2029 ** //ChildObjectReferenceType// (restriction)
2030 *** //ItemReferenceType//
2031
2032 Content:
2033 ( (Ref, URN?) | URN)
2034
2035 Element Documentation:
2036
2037 |**Name**|**Type**|**Documentation**
2038 |Ref|//ItemRefBaseType//|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
2039 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2040 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2041
2042 //**ComponentListReferenceType**//**: **ComponentListReferenceType is an abstract base type used for referencing component lists within a structure. It consists of a URN and/or a complete set of reference fields (structure agency, structure id, structure version, and component list id).
2043
2044 Derivation:
2045
2046 * //ReferenceType// (restriction)
2047 ** //ChildObjectReferenceType// (restriction)
2048 *** //ComponentListReferenceType//
2049
2050 Content:
2051 ( (Ref, URN?) | URN)
2052
2053 Element Documentation:
2054
2055 |**Name**|**Type**|**Documentation**
2056 |Ref|//ComponentListRefBase Type//|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
2057 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2058 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2059
2060 //**ComponentReferenceType**//**: **ComponentReferenceType is an abstract base type used for referencing components within a structure definition. It consists of a URN and/or a complete set of reference fields (structure agency, structure id, structure version, component list id, and component id).
2061
2062 Derivation:
2063
2064 * //ReferenceType// (restriction)
2065 ** //ContainerChildObjectReferenceType// (restriction)
2066 *** //ComponentReferenceType//
2067
2068 Content:
2069 ( (Ref, URN?) | URN)
2070
2071 Element Documentation:
2072
2073 |**Name**|**Type**|**Documentation**
2074 |Ref|//ComponentRefBaseType//|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
2075 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2076 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2077
2078 //**LocalItemReferenceType**//**: **LocalItemReferenceType is an abstract base type which provides a simple reference to an item where the reference to the item scheme which defines it are provided in another context.
2079
2080 Derivation:
2081
2082 * //ReferenceType// (restriction)
2083 ** //LocalItemReferenceType//
2084
2085 Content:
2086 Ref
2087
2088 Element Documentation:
2089
2090 |**Name**|**Type**|**Documentation**
2091 |Ref|//LocalItemRefBaseType//|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
2092
2093 //**LocalComponentListReferenceType**//**: **LocalComponentListReferenceType is an abstract base type which provides a simple reference to a component list where the reference to the structure which defines it is provided in another context.
2094
2095 Derivation:
2096
2097 * //ReferenceType// (restriction)
2098 ** //LocalComponentListReferenceType//
2099
2100 Content:
2101 Ref
2102
2103 Element Documentation:
2104
2105 |**Name**|**Type**|**Documentation**
2106 |Ref|//LocalComponentListRe fBaseType//|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
2107
2108 //**LocalComponentListComponentReferenceBaseType**//**: **LocalComponentListComponentReferenceBaseType is an abstract base type which provides a simple reference to any type of component in a specific component list where the reference to the structure which defines it are provided in another context, and the component list may or may not be defined in another context.
2109
2110 Derivation:
2111
2112 * //ReferenceType// (restriction)
2113 ** //LocalComponentListComponentReferenceBaseType//
2114
2115 Content:
2116 Ref
2117
2118 Element Documentation:
2119
2120 |**Name**|**Type**|**Documentation**
2121 |Ref|//LocalComponentListCo mponentRefBaseType//|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
2122
2123 **LocalComponentListComponentReferenceType: **LocalComponentListComponentReferenceType provides a simple reference to any type of component in a specific component list where the reference to the structure which defines it are provided in another context.
2124
2125 Derivation:
2126
2127 * //ReferenceType// (restriction)
2128 ** //LocalComponentListComponentReferenceBaseType// (restriction)
2129 *** LocalComponentListComponentReferenceType
2130
2131 Content:
2132 Ref
2133
2134 Element Documentation:
2135
2136 |**Name**|**Type**|**Documentation**
2137 |Ref|LocalComponentListCo mponentRefType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
2138
2139 //**LocalComponentReferenceBaseType**//**: **LocalComponentReferenceBaseType is an abstract base type which provides a simple reference to a component where the references to the component list which contains it and the structure which defines it are provided in another context.
2140
2141 Derivation:
2142
2143 * //ReferenceType// (restriction)
2144 ** //LocalComponentListComponentReferenceBaseType// (restriction)
2145 *** //LocalComponentReferenceBaseType//
2146
2147 Content:
2148 Ref
2149
2150 Element Documentation:
2151
2152 |**Name**|**Type**|**Documentation**
2153 |Ref|//LocalComponentRefBas eType//|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
2154
2155 **LocalComponentReferenceType: **LocalComponentReferenceType provides a simple reference to any type of component in a component list where the references to the component list and the structure which defines them are provided in another context.
2156
2157 Derivation:
2158
2159 * //ReferenceType// (restriction)
2160 ** //LocalComponentListComponentReferenceBaseType// (restriction)
2161 *** LocalComponentReferenceType
2162
2163 Content:
2164 Ref
2165
2166 Element Documentation:
2167
2168 |**Name**|**Type**|**Documentation**
2169 |Ref|LocalComponentRefTyp e|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
2170
2171 **StructureOrUsageReferenceType: **StructureOrUsageReferenceType is a specific type of a reference for referencing either a structure or a structure usage. It consists of a URN and/or a complete set of reference fields; agency, id and version. If the complete set of reference fields is used, it is required that a class and package be provided so that the type of object referenced is clear.
2172
2173 Derivation:
2174
2175 * //ReferenceType// (restriction)
2176 ** //MaintainableReferenceBaseType// (restriction)
2177 *** StructureOrUsageReferenceType
2178
2179 Content:
2180 ( (Ref, URN?) | URN)
2181
2182 Element Documentation:
2183
2184 |**Name**|**Type**|**Documentation**
2185 |Ref|StructureOrUsageRefT ype|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
2186 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2187 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2188
2189 **CategorisationReferenceType: **CategorisationReferenceType is a type for referencing a categorisation object. It consists of a URN and/or a complete set of reference fields.
2190
2191 Derivation:
2192
2193 * //ReferenceType// (restriction)
2194 ** //MaintainableReferenceBaseType// (restriction)
2195 *** CategorisationReferenceType
2196
2197 Content:
2198 ( (Ref, URN?) | URN)
2199
2200 Element Documentation:
2201
2202 |**Name**|**Type**|**Documentation**
2203 |Ref|CategorisationRefTyp e|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
2204 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2205 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2206
2207 **CategorisationRefType: **CategorisationRefType provides a reference to a categorisation via a complete set of reference fields.
2208
2209 Derivation:
2210
2211 * //RefBaseType// (restriction)
2212 ** //MaintainableRefBaseType// (restriction)
2213 *** CategorisationRefType
2214
2215 Attributes:
2216 agencyID, id, version?, local?, class?, package?
2217
2218 Content:
2219 {Empty}
2220
2221 Attribute Documentation:
2222
2223 |**Name**|**Type**|**Documentation**
2224 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
2225 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
2226 |version (default: 1.0)|VersionType|The version attribute identifies the version of the object being reference, if applicable. If this is available, a default value of 1.0 will always apply.
2227 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
2228 |class (fixed: Categorisation)|MaintainableTypeCode listType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
2229 |package (fixed: categoryscheme)|PackageTypeCodelistT ype|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
2230
2231 **CategorySchemeReferenceType: **CategorySchemeReferenceType is a type for referencing a category scheme object. It consists of a URN and/or a complete set of reference fields.
2232
2233 Derivation:
2234
2235 * //ReferenceType// (restriction)
2236 ** //MaintainableReferenceBaseType// (restriction)
2237 *** //ItemSchemeReferenceBaseType// (restriction)
2238 **** CategorySchemeReferenceType
2239
2240 Content:
2241 ( (Ref, URN?) | URN)
2242
2243 Element Documentation:
2244
2245 |**Name**|**Type**|**Documentation**
2246 |Ref|CategorySchemeRefTyp e|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
2247 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2248 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2249
2250 **CategorySchemeRefType: **CategorySchemeRefType provides a reference to a category scheme via a complete set of reference fields.
2251
2252 Derivation:
2253
2254 * //RefBaseType// (restriction)
2255 ** //MaintainableRefBaseType// (restriction)
2256 *** //ItemSchemeRefBaseType// (restriction)
2257 **** CategorySchemeRefType
2258
2259 Attributes:
2260 agencyID, id, version?, local?, class?, package?
2261
2262 Content:
2263 {Empty}
2264
2265 Attribute Documentation:
2266
2267 |**Name**|**Type**|**Documentation**
2268 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
2269 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
2270 |version (default: 1.0)|VersionType|The version attribute identifies the version of the object being reference, if applicable. If this is available, a default value of 1.0 will always apply.
2271 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
2272 |class (fixed: CategoryScheme)|ItemSchemeTypeCodeli stType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
2273 |package (fixed: categoryscheme)|ItemSchemePackageTyp eCodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
2274
2275 **CategoryReferenceType: **CategoryReferenceType is a type for referencing a category object. It consists of a URN and/or a complete set of reference fields.
2276
2277 Derivation:
2278
2279 * //ReferenceType// (restriction)
2280 ** //ChildObjectReferenceType// (restriction)
2281 *** //ItemReferenceType// (restriction)
2282 **** CategoryReferenceType
2283
2284 Content:
2285 ( (Ref, URN?) | URN)
2286
2287 Element Documentation:
2288
2289 |**Name**|**Type**|**Documentation**
2290 |Ref|CategoryRefType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
2291 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2292 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2293
2294 **CategoryRefType: **CategoryRefType references a category from within a category scheme. Reference fields are required for both the scheme and the item.
2295
2296 Derivation:
2297
2298 * //RefBaseType// (restriction)
2299 ** //ChildObjectRefBaseType// (restriction)
2300 *** //ItemRefBaseType// (restriction)
2301 **** CategoryRefType
2302
2303 Attributes:
2304 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
2305
2306 Content:
2307 {Empty}
2308
2309 Attribute Documentation:
2310
2311 |**Name**|**Type**|**Documentation**
2312 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
2313 |maintainableParentID|IDType|The maintainableParentID references the category scheme in which the category being referenced is defined.
2314 |maintainableParentVersion (default: 1.0)|VersionType|The maintainableParentVersion attribute references the version of the category scheme in which the category being referenced is defined. If not supplied, a default value of 1.0 is assumed.
2315 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
2316 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
2317 |class (fixed: Category)|ItemTypeCodelistType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
2318 |package (fixed: categoryscheme)|ItemSchemePackageTyp eCodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
2319
2320 **LocalCategoryReferenceType: **LocalCategoryReferenceType provides a simple references to a category where the identification of the category scheme which defines it is contained in another context.
2321
2322 Derivation:
2323
2324 * //ReferenceType// (restriction)
2325 ** //LocalItemReferenceType// (restriction)
2326 *** LocalCategoryReferenceType
2327
2328 Content:
2329 Ref
2330
2331 Element Documentation:
2332
2333 |**Name**|**Type**|**Documentation**
2334 |Ref|LocalCategoryRefType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
2335
2336 **LocalCategoryRefType: **LocalCategoryRefType references a category locally where the references to the category scheme which defines it is provided elsewhere.
2337
2338 Derivation:
2339
2340 * //RefBaseType// (restriction)
2341 ** //LocalIdentifiableRefBaseType// (restriction)
2342 *** //LocalItemRefBaseType// (restriction)
2343 **** LocalCategoryRefType
2344
2345 Attributes:
2346 id, local?, class?, package?
2347
2348 Content:
2349 {Empty}
2350
2351 Attribute Documentation:
2352
2353 |**Name**|**Type**|**Documentation**
2354 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
2355 |local (fixed: true)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
2356 |class (fixed: Category)|ItemTypeCodelistType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
2357 |package (fixed: categoryscheme)|ItemSchemePackageTyp eCodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
2358
2359 **CodelistReferenceType: **CodelistReferenceType is a type for referencing a codelist object. It consists of a URN and/or a complete set of reference fields.
2360
2361 Derivation:
2362
2363 * //ReferenceType// (restriction)
2364 ** //MaintainableReferenceBaseType// (restriction)
2365 *** //ItemSchemeReferenceBaseType// (restriction)
2366 **** CodelistReferenceType
2367
2368 Content:
2369 ( (Ref, URN?) | URN)
2370
2371 Element Documentation:
2372
2373 |**Name**|**Type**|**Documentation**
2374 |Ref|CodelistRefType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
2375 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2376 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2377
2378 **CodelistRefType: **CodelistRefType provides a reference to a codelist via a complete set of reference fields.
2379
2380 Derivation:
2381
2382 * //RefBaseType// (restriction)
2383 ** //MaintainableRefBaseType// (restriction)
2384 *** //ItemSchemeRefBaseType// (restriction)
2385 **** CodelistRefType
2386
2387 Attributes:
2388 agencyID, id, version?, local?, class?, package?
2389
2390 Content:
2391 {Empty}
2392
2393 Attribute Documentation:
2394
2395 |**Name**|**Type**|**Documentation**
2396 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
2397 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
2398 |version (default: 1.0)|VersionType|The version attribute identifies the version of the object being reference, if applicable. If this is available, a default value of 1.0 will always apply.
2399 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
2400 |class (fixed: Codelist)|ItemSchemeTypeCodeli stType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
2401 |package (fixed: codelist)|ItemSchemePackageTyp eCodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
2402
2403 **CodeReferenceType: **CodeReferenceType is a type for referencing a code object. It consists of a URN and/or a complete set of reference fields.
2404
2405 Derivation:
2406
2407 * //ReferenceType// (restriction)
2408 ** //ChildObjectReferenceType// (restriction)
2409 *** //ItemReferenceType// (restriction)
2410 **** CodeReferenceType
2411
2412 Content:
2413 ( (Ref, URN?) | URN)
2414
2415 Element Documentation:
2416
2417 |**Name**|**Type**|**Documentation**
2418 |Ref|CodeRefType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
2419 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2420 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2421
2422 **CodeRefType: **CodeRefType references a code from within a codelist. Reference fields are required for both the scheme and the item.
2423
2424 Derivation:
2425
2426 * //RefBaseType// (restriction)
2427 ** //ChildObjectRefBaseType// (restriction)
2428 *** //ItemRefBaseType// (restriction)
2429 **** CodeRefType
2430
2431 Attributes:
2432 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
2433
2434 Content:
2435 {Empty}
2436
2437 Attribute Documentation:
2438
2439 |**Name**|**Type**|**Documentation**
2440 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
2441 |maintainableParentID|IDType|The maintainableParentID references the codelist in which the code being referenced is defined.
2442 |maintainableParentVersion (default: 1.0)|VersionType|The maintainableParentVersion attribute references the version of the codelist in which the code being referenced is defined. If not supplied, a default value of 1.0 is assumed.
2443 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
2444 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
2445 |class (fixed: Code)|ItemTypeCodelistType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
2446 |package (fixed: codelist)|ItemSchemePackageTyp eCodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
2447
2448 **LocalCodeReferenceType: **LocalCodeReferenceType provides a simple references to a code where the identification of the codelist which defines it is contained in another context.
2449
2450 Derivation:
2451
2452 * //ReferenceType// (restriction)
2453 ** //LocalItemReferenceType// (restriction)
2454 *** LocalCodeReferenceType
2455
2456 Content:
2457 Ref
2458
2459 Element Documentation:
2460
2461 |**Name**|**Type**|**Documentation**
2462 |Ref|LocalCodeRefType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
2463
2464 **LocalCodeRefType: **LocalCodeRefType references a code locally where the references to the codelist which defines it is provided elsewhere.
2465
2466 Derivation:
2467
2468 * //RefBaseType// (restriction)
2469 ** //LocalIdentifiableRefBaseType// (restriction)
2470 *** //LocalItemRefBaseType// (restriction)
2471 **** LocalCodeRefType
2472
2473 Attributes:
2474 id, local?, class?, package?
2475
2476 Content:
2477 {Empty}
2478
2479 Attribute Documentation:
2480
2481 |**Name**|**Type**|**Documentation**
2482 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
2483 |local (fixed: true)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
2484 |class (fixed: Code)|ItemTypeCodelistType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
2485 |package (fixed: codelist)|ItemSchemePackageTyp eCodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
2486
2487 **AnyCodelistReferenceType: **AnyCodelistReferenceType is a specific type of a reference for referencing either a codelist or a hierarchical codelist usage. It consists of a URN and/or a complete set of reference fields; agency, id and version. If the complete set of reference fields is used, it is required that a class be provided so that the type of object referenced is clear.
2488
2489 Derivation:
2490
2491 * //ReferenceType// (restriction)
2492 ** //MaintainableReferenceBaseType// (restriction)
2493 *** AnyCodelistReferenceType
2494
2495 Content:
2496 ( (Ref, URN?) | URN)
2497
2498 Element Documentation:
2499
2500 |**Name**|**Type**|**Documentation**
2501 |Ref|AnyCodelistRefType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
2502 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2503 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2504
2505 **AnyLocalCodeReferenceType: **AnyLocalCodeReferenceType provides a simple references to any code or hierarchical code where the identification of the codelist or hierarchical codelist which defines it is contained in another context.
2506
2507 Derivation:
2508
2509 * //ReferenceType// (restriction)
2510 ** AnyLocalCodeReferenceType
2511
2512 Content:
2513 ( (Ref, URN?) | URN)
2514
2515 Element Documentation:
2516
2517 |**Name**|**Type**|**Documentation**
2518 |Ref|AnyLocalCodeRefType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
2519 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2520 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2521
2522 **ConceptSchemeReferenceType: **ConceptSchemeReferenceType is a type for referencing a concept scheme object. It consists of a URN and/or a complete set of reference fields.
2523
2524 Derivation:
2525
2526 * //ReferenceType// (restriction)
2527 ** //MaintainableReferenceBaseType// (restriction)
2528 *** //ItemSchemeReferenceBaseType// (restriction)
2529 **** ConceptSchemeReferenceType
2530
2531 Content:
2532 ( (Ref, URN?) | URN)
2533
2534 Element Documentation:
2535
2536 |**Name**|**Type**|**Documentation**
2537 |Ref|ConceptSchemeRefType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
2538 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2539 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2540
2541 **ConceptSchemeRefType: **ConceptSchemeRefType provides a reference to a concept scheme via a complete set of reference fields.
2542
2543 Derivation:
2544
2545 * //RefBaseType// (restriction)
2546 ** //MaintainableRefBaseType// (restriction)
2547 *** //ItemSchemeRefBaseType// (restriction)
2548 **** ConceptSchemeRefType
2549
2550 Attributes:
2551 agencyID, id, version?, local?, class?, package?
2552
2553 Content:
2554 {Empty}
2555
2556 Attribute Documentation:
2557
2558 |**Name**|**Type**|**Documentation**
2559 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
2560 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
2561 |version (default: 1.0)|VersionType|The version attribute identifies the version of the object being reference, if applicable. If this is available, a default value of 1.0 will always apply.
2562 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
2563 |class (fixed: ConceptScheme)|ItemSchemeTypeCodeli stType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
2564 |package (fixed: conceptscheme)|ItemSchemePackageTyp eCodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
2565
2566 **ConceptReferenceType: **ConceptReferenceType is a type for referencing a concept object. It consists of a URN and/or a complete set of reference fields.
2567
2568 Derivation:
2569
2570 * //ReferenceType// (restriction)
2571 ** //ChildObjectReferenceType// (restriction)
2572 *** //ItemReferenceType// (restriction)
2573 **** ConceptReferenceType
2574
2575 Content:
2576 ( (Ref, URN?) | URN)
2577
2578 Element Documentation:
2579
2580 |**Name**|**Type**|**Documentation**
2581 |Ref|ConceptRefType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
2582 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2583 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2584
2585 **ConceptRefType: **ConceptRefType references a concept from within a concept scheme. Reference fields are required for both the scheme and the item.
2586
2587 Derivation:
2588
2589 * //RefBaseType// (restriction)
2590 ** //ChildObjectRefBaseType// (restriction)
2591 *** //ItemRefBaseType// (restriction)
2592 **** ConceptRefType
2593
2594 Attributes:
2595 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
2596
2597 Content:
2598 {Empty}
2599
2600 Attribute Documentation:
2601
2602 |**Name**|**Type**|**Documentation**
2603 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
2604 |maintainableParentID|IDType|The maintainableParentID references the concept scheme in which the concept being referenced is defined.
2605 |maintainableParentVersion (default: 1.0)|VersionType|The maintainableParentVersion attribute references the version of the concept scheme in which the concept being referenced is defined. If not supplied, a default value of 1.0 is assumed.
2606 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
2607 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
2608 |class (fixed: Concept)|ItemTypeCodelistType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
2609 |package (fixed: conceptscheme)|ItemSchemePackageTyp eCodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
2610
2611 **LocalConceptReferenceType: **LocalConceptReferenceType provides a simple references to a concept where the identification of the concept scheme which defines it is contained in another context.
2612
2613 Derivation:
2614
2615 * //ReferenceType// (restriction)
2616 ** //LocalItemReferenceType// (restriction)
2617 *** LocalConceptReferenceType
2618
2619 Content:
2620 Ref
2621
2622 Element Documentation:
2623
2624 |**Name**|**Type**|**Documentation**
2625 |Ref|LocalConceptRefType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
2626
2627 **LocalConceptRefType: **LocalConceptRefType references a concept locally where the references to the concept scheme which defines it is provided elsewhere.
2628
2629 Derivation:
2630
2631 * //RefBaseType// (restriction)
2632 ** //LocalIdentifiableRefBaseType// (restriction)
2633 *** //LocalItemRefBaseType// (restriction)
2634 **** LocalConceptRefType
2635
2636 Attributes:
2637 id, local?, class?, package?
2638
2639 Content:
2640 {Empty}
2641
2642 Attribute Documentation:
2643
2644 |**Name**|**Type**|**Documentation**
2645 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
2646 |local (fixed: true)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
2647 |class (fixed: Concept)|ItemTypeCodelistType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
2648 |package (fixed: conceptscheme)|ItemSchemePackageTyp eCodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
2649
2650 //**OrganisationSchemeReferenceBaseType**//**: **OrganisationSchemeReferenceBaseType is a type for referencing a organisation scheme object. It consists of a URN and/or a complete set of reference fields.
2651
2652 Derivation:
2653
2654 * //ReferenceType// (restriction)
2655 ** //MaintainableReferenceBaseType// (restriction)
2656 *** //ItemSchemeReferenceBaseType// (restriction)
2657 **** //OrganisationSchemeReferenceBaseType//
2658
2659 Content:
2660 ( (Ref, URN?) | URN)
2661
2662 Element Documentation:
2663
2664 |**Name**|**Type**|**Documentation**
2665 |Ref|//OrganisationSchemeRe fBaseType//|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
2666 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2667 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2668
2669 //**OrganisationSchemeRefBaseType**//**: **OrganisationSchemeRefBaseType contains a set of reference fields for an organisation scheme.
2670
2671 Derivation:
2672
2673 * //RefBaseType// (restriction)
2674 ** //MaintainableRefBaseType// (restriction)
2675 *** //ItemSchemeRefBaseType// (restriction)
2676 **** //OrganisationSchemeRefBaseType//
2677
2678 Attributes:
2679 agencyID, id, version?, local?, class?, package?
2680
2681 Content:
2682 {Empty}
2683
2684 Attribute Documentation:
2685
2686 |**Name**|**Type**|**Documentation**
2687 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
2688 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
2689 |version (default: 1.0)|VersionType|The version attribute identifies the version of the object being reference, if applicable. If this is available, a default value of 1.0 will always apply.
2690 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
2691 |class|OrganisationSchemeTy peCodelistType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
2692 |package (fixed: base)|ItemSchemePackageTyp eCodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
2693
2694 **OrganisationSchemeReferenceType: **OrganisationSchemeReferenceType references an organisation scheme regardless of the specific type. It consists of a URN and/or a complete set of reference fields.
2695
2696 Derivation:
2697
2698 * //ReferenceType// (restriction)
2699 ** //MaintainableReferenceBaseType// (restriction)
2700 *** //ItemSchemeReferenceBaseType// (restriction)
2701 **** //OrganisationSchemeReferenceBaseType// (restriction)
2702 ***** OrganisationSchemeReferenceType
2703
2704 Content:
2705 ( (Ref, URN?) | URN)
2706
2707 Element Documentation:
2708
2709 |**Name**|**Type**|**Documentation**
2710 |Ref|OrganisationSchemeRe fType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
2711 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2712 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2713
2714 **OrganisationSchemeRefType: **OrganisationSchemeRefType provides a reference to an organisation scheme via a complete set of reference fields. It is required that the class (i.e. the type) of organisation scheme being referenced be specified.
2715
2716 Derivation:
2717
2718 * //RefBaseType// (restriction)
2719 ** //MaintainableRefBaseType// (restriction)
2720 *** //ItemSchemeRefBaseType// (restriction)
2721 **** //OrganisationSchemeRefBaseType// (restriction)
2722 ***** OrganisationSchemeRefType
2723
2724 Attributes:
2725 agencyID, id, version?, local?, class, package?
2726
2727 Content:
2728 {Empty}
2729
2730 Attribute Documentation:
2731
2732 |**Name**|**Type**|**Documentation**
2733 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
2734 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
2735 |version (default: 1.0)|VersionType|The version attribute identifies the version of the object being reference, if applicable. If this is available, a default value of 1.0 will always apply.
2736 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
2737 |class|OrganisationSchemeTy peCodelistType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
2738 |package (fixed: base)|ItemSchemePackageTyp eCodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
2739
2740 //**OrganisationReferenceBaseType**//**: **OrganisationReferenceBaseType is a type for referencing any organisation object, regardless of its type. It consists of a URN and/or a complete set of reference fields.
2741
2742 Derivation:
2743
2744 * //ReferenceType// (restriction)
2745 ** //ChildObjectReferenceType// (restriction)
2746 *** //ItemReferenceType// (restriction)
2747 **** //OrganisationReferenceBaseType//
2748
2749 Content:
2750 ( (Ref, URN?) | URN)
2751
2752 Element Documentation:
2753
2754 |**Name**|**Type**|**Documentation**
2755 |Ref|//OrganisationRefBaseT ype//|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
2756 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2757 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2758
2759 //**OrganisationRefBaseType**//**: **OrganisationRefBaseType is an abstract base type which references an organisation from within a organisation scheme. Reference fields are required for both the scheme and the organisation.
2760
2761 Derivation:
2762
2763 * //RefBaseType// (restriction)
2764 ** //ChildObjectRefBaseType// (restriction)
2765 *** //ItemRefBaseType// (restriction)
2766 **** //OrganisationRefBaseType//
2767
2768 Attributes:
2769 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
2770
2771 Content:
2772 {Empty}
2773
2774 Attribute Documentation:
2775
2776 |**Name**|**Type**|**Documentation**
2777 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
2778 |maintainableParentID|IDType|The maintainableParentID references the organisation scheme in which the organisation being referenced is defined.
2779 |maintainableParentVersion (default: 1.0)|VersionType|The maintainableParentVersion attribute references the version of the organisation scheme in which the organisation being referenced is defined. If not supplied, a default value of 1.0 is assumed.
2780 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
2781 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
2782 |class|OrganisationTypeCode listType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
2783 |package (fixed: base)|ItemSchemePackageTyp eCodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
2784
2785 **OrganisationReferenceType: **OrganisationReferenceType references an organisation regardless of the specific type. It consists of a URN and/or a complete set of reference fields.
2786
2787 Derivation:
2788
2789 * //ReferenceType// (restriction)
2790 ** //ChildObjectReferenceType// (restriction)
2791 *** //ItemReferenceType// (restriction)
2792 **** //OrganisationReferenceBaseType// (restriction)
2793 ***** OrganisationReferenceType
2794
2795 Content:
2796 ( (Ref, URN?) | URN)
2797
2798 Element Documentation:
2799
2800 |**Name**|**Type**|**Documentation**
2801 |Ref|//OrganisationRefBaseT ype//|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
2802 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2803 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2804
2805 **OrganisationRefType: **OrganisationRefType provides a reference to any organisation via a complete set of reference fields. It is required that the class (i.e. the type) of organisation being referenced be specified.
2806
2807 Derivation:
2808
2809 * //RefBaseType// (restriction)
2810 ** //ChildObjectRefBaseType// (restriction)
2811 *** //ItemRefBaseType// (restriction)
2812 **** //OrganisationRefBaseType// (restriction)
2813 ***** OrganisationRefType
2814
2815 Attributes:
2816 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class, package?
2817
2818 Content:
2819 {Empty}
2820
2821 Attribute Documentation:
2822
2823 |**Name**|**Type**|**Documentation**
2824 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
2825 |maintainableParentID|IDType|The maintainableParentID references the organisation scheme in which the organisation being referenced is defined.
2826 |maintainableParentVersion (default: 1.0)|VersionType|The maintainableParentVersion attribute references the version of the organisation scheme in which the organisation being referenced is defined. If not supplied, a default value of 1.0 is assumed.
2827 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
2828 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
2829 |class|OrganisationTypeCode listType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
2830 |package (fixed: base)|ItemSchemePackageTyp eCodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
2831
2832 //**LocalOrganisationReferenceBaseType**//**: **LocalOrganisationReferenceBaseType is an abstract base type which provides a simple references to an organisation, regardless of type, where the identification of the organisation scheme which defines it is contained in another context.
2833
2834 Derivation:
2835
2836 * //ReferenceType// (restriction)
2837 ** //LocalItemReferenceType// (restriction)
2838 *** //LocalOrganisationReferenceBaseType//
2839
2840 Content:
2841 Ref
2842
2843 Element Documentation:
2844
2845 |**Name**|**Type**|**Documentation**
2846 |Ref|//LocalOrganisationRef BaseType//|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
2847
2848 //**LocalOrganisationRefBaseType**//**: **LocalOrganisationRefBaseType is an abstract base type that references an organisation locally where the reference to the organisation scheme which defines it is provided elsewhere.
2849
2850 Derivation:
2851
2852 * //RefBaseType// (restriction)
2853 ** //LocalIdentifiableRefBaseType// (restriction)
2854 *** //LocalItemRefBaseType// (restriction)
2855 **** //LocalOrganisationRefBaseType//
2856
2857 Attributes:
2858 id, local?, class?, package?
2859
2860 Content:
2861 {Empty}
2862
2863 Attribute Documentation:
2864
2865 |**Name**|**Type**|**Documentation**
2866 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
2867 |local (fixed: true)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
2868 |class|OrganisationTypeCode listType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
2869 |package (fixed: base)|ItemSchemePackageTyp eCodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
2870
2871 **LocalOrganisationReferenceType: **LocalOrganisationReferenceType provides a simple reference to an organisation, regardless of type, where the identification of the organisation scheme which defines it is contained in another context.
2872
2873 Derivation:
2874
2875 * //ReferenceType// (restriction)
2876 ** //LocalItemReferenceType// (restriction)
2877 *** //LocalOrganisationReferenceBaseType// (restriction)
2878 **** LocalOrganisationReferenceType
2879
2880 Content:
2881 Ref
2882
2883 Element Documentation:
2884
2885 |**Name**|**Type**|**Documentation**
2886 |Ref|LocalOrganisationRef Type|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
2887
2888 **LocalOrganisationRefType: **LocalOrganisationRefType references an organisation locally where the reference to the organisation scheme which defines it is provided elsewhere. The reference requires that the class (i.e. the type) or the organisation being reference be provided.
2889
2890 Derivation:
2891
2892 * //RefBaseType// (restriction)
2893 ** //LocalIdentifiableRefBaseType// (restriction)
2894 *** //LocalItemRefBaseType// (restriction)
2895 **** //LocalOrganisationRefBaseType// (restriction)
2896 ***** LocalOrganisationRefType
2897
2898 Attributes:
2899 id, local?, class?, package?
2900
2901 Content:
2902 {Empty}
2903
2904 Attribute Documentation:
2905
2906 |**Name**|**Type**|**Documentation**
2907 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
2908 |local (fixed: true)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
2909 |class|OrganisationTypeCode listType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
2910 |package (fixed: base)|ItemSchemePackageTyp eCodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
2911
2912 **OrganisationUnitSchemeReferenceType: **OrganisationUnitSchemeReferenceType is a type for referencing an organisation unit scheme object. It consists of a URN and/or a complete set of reference fields.
2913
2914 Derivation:
2915
2916 * //ReferenceType// (restriction)
2917 ** //MaintainableReferenceBaseType// (restriction)
2918 *** //ItemSchemeReferenceBaseType// (restriction)
2919 **** //OrganisationSchemeReferenceBaseType// (restriction)
2920 ***** OrganisationUnitSchemeReferenceType
2921
2922 Content:
2923 ( (Ref, URN?) | URN)
2924
2925 Element Documentation:
2926
2927 |**Name**|**Type**|**Documentation**
2928 |Ref|OrganisationUnitSche meRefType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
2929 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2930 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2931
2932 **OrganisationUnitSchemeRefType: **OrganisationUnitSchemeRefType contains a set of reference fields for an organisation unit scheme.
2933
2934 Derivation:
2935
2936 * //RefBaseType// (restriction)
2937 ** //MaintainableRefBaseType// (restriction)
2938 *** //ItemSchemeRefBaseType// (restriction)
2939 **** //OrganisationSchemeRefBaseType// (restriction)
2940 ***** OrganisationUnitSchemeRefType
2941
2942 Attributes:
2943 agencyID, id, version?, local?, class?, package?
2944
2945 Content:
2946 {Empty}
2947
2948 Attribute Documentation:
2949
2950 |**Name**|**Type**|**Documentation**
2951 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
2952 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
2953 |version (default: 1.0)|VersionType|The version attribute identifies the version of the object being reference, if applicable. If this is available, a default value of 1.0 will always apply.
2954 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
2955 |class (fixed: OrganisationUnitScheme)|OrganisationSchemeTy peCodelistType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
2956 |package (fixed: base)|ItemSchemePackageTyp eCodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
2957
2958 **OrganisationUnitReferenceType: **OrganisationUnitReferenceType is a type for referencing an organisation unit. It consists of a URN and/or a complete set of reference fields.
2959
2960 Derivation:
2961
2962 * //ReferenceType// (restriction)
2963 ** //ChildObjectReferenceType// (restriction)
2964 *** //ItemReferenceType// (restriction)
2965 **** //OrganisationReferenceBaseType// (restriction)
2966 ***** OrganisationUnitReferenceType
2967
2968 Content:
2969 ( (Ref, URN?) | URN)
2970
2971 Element Documentation:
2972
2973 |**Name**|**Type**|**Documentation**
2974 |Ref|OrganisationUnitRefT ype|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
2975 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2976 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
2977
2978 **OrganisationUnitRefType: **OrganisationUnitRefType contains a set of reference fields for referencing an organisation unit within an organisation unit scheme.
2979
2980 Derivation:
2981
2982 * //RefBaseType// (restriction)
2983 ** //ChildObjectRefBaseType// (restriction)
2984 *** //ItemRefBaseType// (restriction)
2985 **** //OrganisationRefBaseType// (restriction)
2986 ***** OrganisationUnitRefType
2987
2988 Attributes:
2989 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
2990
2991 Content:
2992 {Empty}
2993
2994 Attribute Documentation:
2995
2996 |**Name**|**Type**|**Documentation**
2997 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
2998 |maintainableParentID|IDType|The maintainableParentID references the organisation scheme in which the organisation being referenced is defined.
2999 |maintainableParentVersion (default: 1.0)|VersionType|The maintainableParentVersion attribute references the version of the organisation scheme in which the organisation being referenced is defined. If not supplied, a default value of 1.0 is assumed.
3000 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
3001 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
3002 |class (fixed: OrganisationUnit)|OrganisationTypeCode listType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
3003 |package (fixed: base)|ItemSchemePackageTyp eCodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
3004
3005 **LocalOrganisationUnitReferenceType: **LocalOrganisationUnitReferenceType provides a simple reference to an organisation unit, where the reference to the organisation unit scheme which defines it is provided in another context.
3006
3007 Derivation:
3008
3009 * //ReferenceType// (restriction)
3010 ** //LocalItemReferenceType// (restriction)
3011 *** //LocalOrganisationReferenceBaseType// (restriction)
3012 **** LocalOrganisationUnitReferenceType
3013
3014 Content:
3015 Ref
3016
3017 Element Documentation:
3018
3019 |**Name**|**Type**|**Documentation**
3020 |Ref|LocalOrganisationUni tRefType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
3021
3022 **LocalOrganisationUnitRefType: **LocalOrganisationUnitRefType references an organisation unit locally where the reference to the organisation unit scheme which defines it is provided elsewhere.
3023
3024 Derivation:
3025
3026 * //RefBaseType// (restriction)
3027 ** //LocalIdentifiableRefBaseType// (restriction)
3028 *** //LocalItemRefBaseType// (restriction)
3029 **** //LocalOrganisationRefBaseType// (restriction)
3030 ***** LocalOrganisationUnitRefType
3031
3032 Attributes:
3033 id, local?, class?, package?
3034
3035 Content:
3036 {Empty}
3037
3038 Attribute Documentation:
3039
3040 |**Name**|**Type**|**Documentation**
3041 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
3042 |local (fixed: true)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
3043 |class (fixed: OrganisationUnit)|OrganisationTypeCode listType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
3044 |package (fixed: base)|ItemSchemePackageTyp eCodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
3045
3046 **AgencySchemeReferenceType: **AgencySchemeReferenceType is a type for referencing an agency scheme object. It consists of a URN and/or a complete set of reference fields.
3047
3048 Derivation:
3049
3050 * //ReferenceType// (restriction)
3051 ** //MaintainableReferenceBaseType// (restriction)
3052 *** //ItemSchemeReferenceBaseType// (restriction)
3053 **** //OrganisationSchemeReferenceBaseType// (restriction)
3054 ***** AgencySchemeReferenceType
3055
3056 Content:
3057 ( (Ref, URN?) | URN)
3058
3059 Element Documentation:
3060
3061 |**Name**|**Type**|**Documentation**
3062 |Ref|AgencySchemeRefType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
3063 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3064 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3065
3066 **AgencySchemeRefType: **AgencySchemeRefType contains a set of reference fields for an agency scheme.
3067
3068 Derivation:
3069
3070 * //RefBaseType// (restriction)
3071 ** //MaintainableRefBaseType// (restriction)
3072 *** //ItemSchemeRefBaseType// (restriction)
3073 **** //OrganisationSchemeRefBaseType// (restriction)
3074 ***** AgencySchemeRefType
3075
3076 Attributes:
3077 agencyID, id, version?, local?, class?, package?
3078
3079 Content:
3080 {Empty}
3081
3082 Attribute Documentation:
3083
3084 |**Name**|**Type**|**Documentation**
3085 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
3086 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
3087 |version (default: 1.0)|VersionType|The version attribute identifies the version of the object being reference, if applicable. If this is available, a default value of 1.0 will always apply.
3088 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
3089 |class (fixed: AgencyScheme)|OrganisationSchemeTy peCodelistType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
3090 |package (fixed: base)|ItemSchemePackageTyp eCodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
3091
3092 **AgencyReferenceType: **AgencyReferenceType is a type for referencing an agency. It consists of a URN and/or a complete set of reference fields.
3093
3094 Derivation:
3095
3096 * //ReferenceType// (restriction)
3097 ** //ChildObjectReferenceType// (restriction)
3098 *** //ItemReferenceType// (restriction)
3099 **** //OrganisationReferenceBaseType// (restriction)
3100 ***** AgencyReferenceType
3101
3102 Content:
3103 ( (Ref, URN?) | URN)
3104
3105 Element Documentation:
3106
3107 |**Name**|**Type**|**Documentation**
3108 |Ref|AgencyRefType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
3109 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3110 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3111
3112 **AgencyRefType: **AgencyRefType contains a set of reference fields for referencing an agency within an agency scheme.
3113
3114 Derivation:
3115
3116 * //RefBaseType// (restriction)
3117 ** //ChildObjectRefBaseType// (restriction)
3118 *** //ItemRefBaseType// (restriction)
3119 **** //OrganisationRefBaseType// (restriction)
3120 ***** AgencyRefType
3121
3122 Attributes:
3123 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
3124
3125 Content:
3126 {Empty}
3127
3128 Attribute Documentation:
3129
3130 |**Name**|**Type**|**Documentation**
3131 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
3132 |maintainableParentID|IDType|The maintainableParentID references the organisation scheme in which the organisation being referenced is defined.
3133 |maintainableParentVersion (default: 1.0)|VersionType|The maintainableParentVersion attribute references the version of the organisation scheme in which the organisation being referenced is defined. If not supplied, a default value of 1.0 is assumed.
3134 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
3135 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
3136 |class (fixed: Agency)|OrganisationTypeCode listType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
3137 |package (fixed: base)|ItemSchemePackageTyp eCodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
3138
3139 **LocalAgencyReferenceType: **LocalAgencyReferenceType provides a simple reference to an agency, where the reference to the agency scheme which defines it is provided in another context.
3140
3141 Derivation:
3142
3143 * //ReferenceType// (restriction)
3144 ** //LocalItemReferenceType// (restriction)
3145 *** //LocalOrganisationReferenceBaseType// (restriction)
3146 **** LocalAgencyReferenceType
3147
3148 Content:
3149 Ref
3150
3151 Element Documentation:
3152
3153 |**Name**|**Type**|**Documentation**
3154 |Ref|LocalAgencyRefType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
3155
3156 **LocalAgencyRefType: **LocalAgencyRefType references an agency locally where the reference to the agency scheme which defines it is provided elsewhere.
3157
3158 Derivation:
3159
3160 * //RefBaseType// (restriction)
3161 ** //LocalIdentifiableRefBaseType// (restriction)
3162 *** //LocalItemRefBaseType// (restriction)
3163 **** //LocalOrganisationRefBaseType// (restriction)
3164 ***** LocalAgencyRefType
3165
3166 Attributes:
3167 id, local?, class?, package?
3168
3169 Content:
3170 {Empty}
3171
3172 Attribute Documentation:
3173
3174 |**Name**|**Type**|**Documentation**
3175 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
3176 |local (fixed: true)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
3177 |class (fixed: Agency)|OrganisationTypeCode listType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
3178 |package (fixed: base)|ItemSchemePackageTyp eCodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
3179
3180 **DataConsumerSchemeReferenceType: **DataConsumerSchemeReferenceType is a type for referencing a data consumer scheme object. It consists of a URN and/or a complete set of reference fields.
3181
3182 Derivation:
3183
3184 * //ReferenceType// (restriction)
3185 ** //MaintainableReferenceBaseType// (restriction)
3186 *** //ItemSchemeReferenceBaseType// (restriction)
3187 **** //OrganisationSchemeReferenceBaseType// (restriction)
3188 ***** DataConsumerSchemeReferenceType
3189
3190 Content:
3191 ( (Ref, URN?) | URN)
3192
3193 Element Documentation:
3194
3195 |**Name**|**Type**|**Documentation**
3196 |Ref|DataConsumerSchemeRe fType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
3197 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3198 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3199
3200 **DataConsumerSchemeRefType: **DataConsumerSchemeRefType contains a set of reference fields for a data consumer scheme.
3201
3202 Derivation:
3203
3204 * //RefBaseType// (restriction)
3205 ** //MaintainableRefBaseType// (restriction)
3206 *** //ItemSchemeRefBaseType// (restriction)
3207 **** //OrganisationSchemeRefBaseType// (restriction)
3208 ***** DataConsumerSchemeRefType
3209
3210 Attributes:
3211 agencyID, id, version?, local?, class?, package?
3212
3213 Content:
3214 {Empty}
3215
3216 Attribute Documentation:
3217
3218 |**Name**|**Type**|**Documentation**
3219 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
3220 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
3221 |version (default: 1.0)|VersionType|The version attribute identifies the version of the object being reference, if applicable. If this is available, a default value of 1.0 will always apply.
3222 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
3223 |class (fixed: DataConsumerScheme)|OrganisationSchemeTy peCodelistType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
3224 |package (fixed: base)|ItemSchemePackageTyp eCodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
3225
3226 **DataConsumerReferenceType: **DataConsumerReferenceType is a type for referencing a data consumer. It consists of a URN and/or a complete set of reference fields.
3227
3228 Derivation:
3229
3230 * //ReferenceType// (restriction)
3231 ** //ChildObjectReferenceType// (restriction)
3232 *** //ItemReferenceType// (restriction)
3233 **** //OrganisationReferenceBaseType// (restriction)
3234 ***** DataConsumerReferenceType
3235
3236 Content:
3237 ( (Ref, URN?) | URN)
3238
3239 Element Documentation:
3240
3241 |**Name**|**Type**|**Documentation**
3242 |Ref|DataConsumerRefType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
3243 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3244 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3245
3246 **DataConsumerRefType: **DataConsumerRefType contains a set of reference fields for referencing a data consumer within a data consumer scheme.
3247
3248 Derivation:
3249
3250 * //RefBaseType// (restriction)
3251 ** //ChildObjectRefBaseType// (restriction)
3252 *** //ItemRefBaseType// (restriction)
3253 **** //OrganisationRefBaseType// (restriction)
3254 ***** DataConsumerRefType
3255
3256 Attributes:
3257 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
3258
3259 Content:
3260 {Empty}
3261
3262 Attribute Documentation:
3263
3264 |**Name**|**Type**|**Documentation**
3265 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
3266 |maintainableParentID|IDType|The maintainableParentID references the organisation scheme in which the organisation being referenced is defined.
3267 |maintainableParentVersion (default: 1.0)|VersionType|The maintainableParentVersion attribute references the version of the organisation scheme in which the organisation being referenced is defined. If not supplied, a default value of 1.0 is assumed.
3268 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
3269 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
3270 |class (fixed: DataConsumer)|OrganisationTypeCode listType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
3271 |package (fixed: base)|ItemSchemePackageTyp eCodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
3272
3273 **LocalDataConsumerReferenceType: **LocalDataConsumerReferenceType provides a simple reference to a data consumer, where the reference to the data consumer scheme which defines it is provided in another context.
3274
3275 Derivation:
3276
3277 * //ReferenceType// (restriction)
3278 ** //LocalItemReferenceType// (restriction)
3279 *** //LocalOrganisationReferenceBaseType// (restriction)
3280 **** LocalDataConsumerReferenceType
3281
3282 Content:
3283 Ref
3284
3285 Element Documentation:
3286
3287 |**Name**|**Type**|**Documentation**
3288 |Ref|LocalDataConsumerRef Type|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
3289
3290 **LocalDataConsumerRefType: **LocalDataConsumerRefType references a data consumer locally where the reference to the data consumer scheme which defines it is provided elsewhere.
3291
3292 Derivation:
3293
3294 * //RefBaseType// (restriction)
3295 ** //LocalIdentifiableRefBaseType// (restriction)
3296 *** //LocalItemRefBaseType// (restriction)
3297 **** //LocalOrganisationRefBaseType// (restriction)
3298 ***** LocalDataConsumerRefType
3299
3300 Attributes:
3301 id, local?, class?, package?
3302
3303 Content:
3304 {Empty}
3305
3306 Attribute Documentation:
3307
3308 |**Name**|**Type**|**Documentation**
3309 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
3310 |local (fixed: true)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
3311 |class (fixed: DataConsumer)|OrganisationTypeCode listType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
3312 |package (fixed: base)|ItemSchemePackageTyp eCodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
3313
3314 **DataProviderSchemeReferenceType: **DataProviderSchemeReferenceType is a type for referencing a data provider scheme object. It consists of a URN and/or a complete set of reference fields.
3315
3316 Derivation:
3317
3318 * //ReferenceType// (restriction)
3319 ** //MaintainableReferenceBaseType// (restriction)
3320 *** //ItemSchemeReferenceBaseType// (restriction)
3321 **** //OrganisationSchemeReferenceBaseType// (restriction)
3322 ***** DataProviderSchemeReferenceType
3323
3324 Content:
3325 ( (Ref, URN?) | URN)
3326
3327 Element Documentation:
3328
3329 |**Name**|**Type**|**Documentation**
3330 |Ref|DataProviderSchemeRe fType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
3331 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3332 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3333
3334 **DataProviderSchemeRefType: **DataProviderSchemeRefType contains a set of reference fields for a data provider scheme.
3335
3336 Derivation:
3337
3338 * //RefBaseType// (restriction)
3339 ** //MaintainableRefBaseType// (restriction)
3340 *** //ItemSchemeRefBaseType// (restriction)
3341 **** //OrganisationSchemeRefBaseType// (restriction)
3342 ***** DataProviderSchemeRefType
3343
3344 Attributes:
3345 agencyID, id, version?, local?, class?, package?
3346
3347 Content:
3348 {Empty}
3349
3350 Attribute Documentation:
3351
3352 |**Name**|**Type**|**Documentation**
3353 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
3354 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
3355 |version (default: 1.0)|VersionType|The version attribute identifies the version of the object being reference, if applicable. If this is available, a default value of 1.0 will always apply.
3356 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
3357 |class (fixed: DataProviderScheme)|OrganisationSchemeTy peCodelistType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
3358 |package (fixed: base)|ItemSchemePackageTyp eCodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
3359
3360 **DataProviderReferenceType: **DataProviderReferenceType is a type for referencing a data provider. It consists of a URN and/or a complete set of reference fields.
3361
3362 Derivation:
3363
3364 * //ReferenceType// (restriction)
3365 ** //ChildObjectReferenceType// (restriction)
3366 *** //ItemReferenceType// (restriction)
3367 **** //OrganisationReferenceBaseType// (restriction)
3368 ***** DataProviderReferenceType
3369
3370 Content:
3371 ( (Ref, URN?) | URN)
3372
3373 Element Documentation:
3374
3375 |**Name**|**Type**|**Documentation**
3376 |Ref|DataProviderRefType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
3377 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3378 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3379
3380 **DataProviderRefType: **DataProviderRefType contains a set of reference fields for referencing a data provider within a data provider scheme.
3381
3382 Derivation:
3383
3384 * //RefBaseType// (restriction)
3385 ** //ChildObjectRefBaseType// (restriction)
3386 *** //ItemRefBaseType// (restriction)
3387 **** //OrganisationRefBaseType// (restriction)
3388 ***** DataProviderRefType
3389
3390 Attributes:
3391 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
3392
3393 Content:
3394 {Empty}
3395
3396 Attribute Documentation:
3397
3398 |**Name**|**Type**|**Documentation**
3399 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
3400 |maintainableParentID|IDType|The maintainableParentID references the organisation scheme in which the organisation being referenced is defined.
3401 |maintainableParentVersion (default: 1.0)|VersionType|The maintainableParentVersion attribute references the version of the organisation scheme in which the organisation being referenced is defined. If not supplied, a default value of 1.0 is assumed.
3402 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
3403 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
3404 |class (fixed: DataProvider)|OrganisationTypeCode listType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
3405 |package (fixed: base)|ItemSchemePackageTyp eCodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
3406
3407 **LocalDataProviderReferenceType: **LocalDataProviderReferenceType provides a simple reference to a data provider, where the reference to the data provider scheme which defines it is provided in another context.
3408
3409 Derivation:
3410
3411 * //ReferenceType// (restriction)
3412 ** //LocalItemReferenceType// (restriction)
3413 *** //LocalOrganisationReferenceBaseType// (restriction)
3414 **** LocalDataProviderReferenceType
3415
3416 Content:
3417 Ref
3418
3419 Element Documentation:
3420
3421 |**Name**|**Type**|**Documentation**
3422 |Ref|LocalDataProviderRef Type|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
3423
3424 **LocalDataProviderRefType: **LocalDataProviderRefType references a data provider locally where the reference to the data provider scheme which defines it is provided elsewhere.
3425
3426 Derivation:
3427
3428 * //RefBaseType// (restriction)
3429 ** //LocalIdentifiableRefBaseType// (restriction)
3430 *** //LocalItemRefBaseType// (restriction)
3431 **** //LocalOrganisationRefBaseType// (restriction)
3432 ***** LocalDataProviderRefType
3433
3434 Attributes:
3435 id, local?, class?, package?
3436
3437 Content:
3438 {Empty}
3439
3440 Attribute Documentation:
3441
3442 |**Name**|**Type**|**Documentation**
3443 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
3444 |local (fixed: true)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
3445 |class (fixed: DataProvider)|OrganisationTypeCode listType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
3446 |package (fixed: base)|ItemSchemePackageTyp eCodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
3447
3448 **ReportingTaxonomyReferenceType: **ReportingTaxonomyReferenceType is a type for referencing a reporting taxonomy object. It consists of a URN and/or a complete set of reference fields.
3449
3450 Derivation:
3451
3452 * //ReferenceType// (restriction)
3453 ** //MaintainableReferenceBaseType// (restriction)
3454 *** //ItemSchemeReferenceBaseType// (restriction)
3455 **** ReportingTaxonomyReferenceType
3456
3457 Content:
3458 ( (Ref, URN?) | URN)
3459
3460 Element Documentation:
3461
3462 |**Name**|**Type**|**Documentation**
3463 |Ref|ReportingTaxonomyRef Type|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
3464 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3465 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3466
3467 **ReportingTaxonomyRefType: **ReportingTaxonomyRefType provides a reference to a reporting taxonomy via a complete set of reference fields.
3468
3469 Derivation:
3470
3471 * //RefBaseType// (restriction)
3472 ** //MaintainableRefBaseType// (restriction)
3473 *** //ItemSchemeRefBaseType// (restriction)
3474 **** ReportingTaxonomyRefType
3475
3476 Attributes:
3477 agencyID, id, version?, local?, class?, package?
3478
3479 Content:
3480 {Empty}
3481
3482 Attribute Documentation:
3483
3484 |**Name**|**Type**|**Documentation**
3485 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
3486 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
3487 |version (default: 1.0)|VersionType|The version attribute identifies the version of the object being reference, if applicable. If this is available, a default value of 1.0 will always apply.
3488 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
3489 |class (fixed: ReportingTaxonomy)|ItemSchemeTypeCodeli stType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
3490 |package (fixed: categoryscheme)|ItemSchemePackageTyp eCodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
3491
3492 **ReportingCategoryReferenceType: **ReportingCategoryReferenceType is a type for referencing a reporting category object. It consists of a URN and/or a complete set of reference fields.
3493
3494 Derivation:
3495
3496 * //ReferenceType// (restriction)
3497 ** //ChildObjectReferenceType// (restriction)
3498 *** //ItemReferenceType// (restriction)
3499 **** ReportingCategoryReferenceType
3500
3501 Content:
3502 ( (Ref, URN?) | URN)
3503
3504 Element Documentation:
3505
3506 |**Name**|**Type**|**Documentation**
3507 |Ref|ReportCategoryRefTyp e|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
3508 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3509 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3510
3511 **ReportCategoryRefType: **ReportCategoryRefType contains a set of fields for referencing a reporting category within a reporting taxonomy.
3512
3513 Derivation:
3514
3515 * //RefBaseType// (restriction)
3516 ** //ChildObjectRefBaseType// (restriction)
3517 *** //ItemRefBaseType// (restriction)
3518 **** ReportCategoryRefType
3519
3520 Attributes:
3521 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
3522
3523 Content:
3524 {Empty}
3525
3526 Attribute Documentation:
3527
3528 |**Name**|**Type**|**Documentation**
3529 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
3530 |maintainableParentID|IDType|The maintainableParentID references the reporting taxonomy in which the reporting category being referenced is defined.
3531 |maintainableParentVersion (default: 1.0)|VersionType|The maintainableParentVersion attribute references the version of the reporting taxonomy in which the reporting category being referenced is defined. If not supplied, a default value of 1.0 is assumed.
3532 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
3533 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
3534 |class (fixed: ReportingCategory)|ItemTypeCodelistType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
3535 |package (fixed: categoryscheme)|ItemSchemePackageTyp eCodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
3536
3537 **LocalReportingCategoryReferenceType: **LocalReportingCategoryReferenceType provides a simple references to a reporting category where the identification of the reporting taxonomy which defines it is contained in another context.
3538
3539 Derivation:
3540
3541 * //ReferenceType// (restriction)
3542 ** //LocalItemReferenceType// (restriction)
3543 *** LocalReportingCategoryReferenceType
3544
3545 Content:
3546 Ref
3547
3548 Element Documentation:
3549
3550 |**Name**|**Type**|**Documentation**
3551 |Ref|LocalReportingCatego ryRefType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
3552
3553 **LocalReportingCategoryRefType: **LocalReportingCategoryRefType references a reporting category locally where the references to the reporting taxonomy which defines it is provided elsewhere.
3554
3555 Derivation:
3556
3557 * //RefBaseType// (restriction)
3558 ** //LocalIdentifiableRefBaseType// (restriction)
3559 *** //LocalItemRefBaseType// (restriction)
3560 **** LocalReportingCategoryRefType
3561
3562 Attributes:
3563 id, local?, class?, package?
3564
3565 Content:
3566 {Empty}
3567
3568 Attribute Documentation:
3569
3570 |**Name**|**Type**|**Documentation**
3571 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
3572 |local (fixed: true)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
3573 |class (fixed: ReportingCategory)|ItemTypeCodelistType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
3574 |package (fixed: categoryscheme)|ItemSchemePackageTyp eCodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
3575
3576 **HierarchicalCodelistReferenceType: **HierarchicalCodelistReferenceType is a type for referencing a hierarchical codelist object. It consists of a URN and/or a complete set of reference fields.
3577
3578 Derivation:
3579
3580 * //ReferenceType// (restriction)
3581 ** //MaintainableReferenceBaseType// (restriction)
3582 *** HierarchicalCodelistReferenceType
3583
3584 Content:
3585 ( (Ref, URN?) | URN)
3586
3587 Element Documentation:
3588
3589 |**Name**|**Type**|**Documentation**
3590 |Ref|HierarchicalCodelist RefType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
3591 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3592 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3593
3594 **HierarchicalCodelistRefType: **HierarchicalCodelistRefType contains a set of reference fields for a hierarchical codelist.
3595
3596 Derivation:
3597
3598 * //RefBaseType// (restriction)
3599 ** //MaintainableRefBaseType// (restriction)
3600 *** HierarchicalCodelistRefType
3601
3602 Attributes:
3603 agencyID, id, version?, local?, class?, package?
3604
3605 Content:
3606 {Empty}
3607
3608 Attribute Documentation:
3609
3610 |**Name**|**Type**|**Documentation**
3611 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
3612 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
3613 |version (default: 1.0)|VersionType|The version attribute identifies the version of the object being reference, if applicable. If this is available, a default value of 1.0 will always apply.
3614 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
3615 |class (fixed: HierarchicalCodelist)|MaintainableTypeCode listType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
3616 |package (fixed: codelist)|ItemSchemePackageTyp eCodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
3617
3618 **HierarchyReferenceType: **HierarchyReferenceType is a type for referencing a hierarchy within a hierarchical codelist.
3619
3620 Derivation:
3621
3622 * //ReferenceType// (restriction)
3623 ** //ChildObjectReferenceType// (restriction)
3624 *** HierarchyReferenceType
3625
3626 Content:
3627 ( (Ref, URN?) | URN)
3628
3629 Element Documentation:
3630
3631 |**Name**|**Type**|**Documentation**
3632 |Ref|HierarchyRefType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
3633 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3634 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3635
3636 **HierarchyRefType: **HierarchyRefType is type which references a hierarchy from within a hierarchical codelist. Reference fields are required for both the hierarchy and the codelist.
3637
3638 Derivation:
3639
3640 * //RefBaseType// (restriction)
3641 ** //ChildObjectRefBaseType// (restriction)
3642 *** HierarchyRefType
3643
3644 Attributes:
3645 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
3646
3647 Content:
3648 {Empty}
3649
3650 Attribute Documentation:
3651
3652 |**Name**|**Type**|**Documentation**
3653 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
3654 |maintainableParentID|IDType|The maintainableParentID attribute identifies the maintainable object in which the referenced object is defined, if applicable (maintainable-parent-object-id in the URN structure). This is only used in references where the referenced object is not itself maintainable.
3655 |maintainableParentVersion (default: 1.0)|VersionType|The maintainableParentVersion attribute identifies the version of the maintainable object in which the referenced object is defined (maintainable-parent-object-version in the URN structure). This is only used in references where the referenced object is not itself maintainable. This should only be used when the maintainableParentID is present. If this is available, a default of 1.0 will always apply.
3656 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
3657 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
3658 |class (fixed: Hierarchy)|ObjectTypeCodelistTy pe|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
3659 |package (fixed: codelist)|PackageTypeCodelistT ype|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
3660
3661 **LevelReferenceType: **LevelReferenceType is a type for referencing a level object. It consists of a URN and/or a complete set of reference fields.
3662
3663 Derivation:
3664
3665 * //ReferenceType// (restriction)
3666 ** //ChildObjectReferenceType// (restriction)
3667 *** LevelReferenceType
3668
3669 Content:
3670 ( (Ref, URN?) | URN)
3671
3672 Element Documentation:
3673
3674 |**Name**|**Type**|**Documentation**
3675 |Ref|LevelRefType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
3676 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3677 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3678
3679 **LevelRefType: **LevelRefType references a level from within a hierarchical codelist. Reference fields are required for both the level and the codelist.
3680
3681 Derivation:
3682
3683 * //RefBaseType// (restriction)
3684 ** //ChildObjectRefBaseType// (restriction)
3685 *** LevelRefType
3686
3687 Attributes:
3688 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
3689
3690 Content:
3691 {Empty}
3692
3693 Attribute Documentation:
3694
3695 |**Name**|**Type**|**Documentation**
3696 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
3697 |maintainableParentID|IDType|The maintainableParentID attribute identifies the maintainable object in which the referenced object is defined, if applicable (maintainable-parent-object-id in the URN structure). This is only used in references where the referenced object is not itself maintainable.
3698 |maintainableParentVersion (default: 1.0)|VersionType|The maintainableParentVersion attribute identifies the version of the maintainable object in which the referenced object is defined (maintainable-parent-object-version in the URN structure). This is only used in references where the referenced object is not itself maintainable. This should only be used when the maintainableParentID is present. If this is available, a default of 1.0 will always apply.
3699 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
3700 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
3701 |class (fixed: Level)|ObjectTypeCodelistTy pe|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
3702 |package (fixed: codelist)|PackageTypeCodelistT ype|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
3703
3704 **LocalLevelReferenceType: **LocalLevelReferenceType is a type for referencing a level object where the reference to the hierarchical codelist and the hierarchy in which it is defined is provided in another context (e.g. is inferred from the hierarchy in which the reference is defined).
3705
3706 Derivation:
3707
3708 * //ReferenceType// (restriction)
3709 ** LocalLevelReferenceType
3710
3711 Content:
3712 Ref
3713
3714 Element Documentation:
3715
3716 |**Name**|**Type**|**Documentation**
3717 |Ref|LocalLevelRefType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
3718
3719 **LocalLevelRefType: **LocalLevelRefType references a level object where the reference to the hierarchy in which it is contained and the hierarchical codelist which define it are provided in another context.
3720
3721 Derivation:
3722
3723 * //RefBaseType// (restriction)
3724 ** //LocalIdentifiableRefBaseType// (restriction)
3725 *** LocalLevelRefType
3726
3727 Attributes:
3728 containerID?, id, local?, class?, package?
3729
3730 Content:
3731 {Empty}
3732
3733 Attribute Documentation:
3734
3735 |**Name**|**Type**|**Documentation**
3736 |containerID|NestedIDType|The containerID attribute identifies the object within a maintainable object in which the referenced object is defined (container-object-id in the URN structure). This is only used in references where the referenced object is not contained directly within a maintainable object (e.g. a Component within a ComponentList, within a maintainable Structure). If the container has a fixed identifier, this attribute will not be present.
3737 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
3738 |local (fixed: true)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
3739 |class (fixed: Level)|ObjectTypeCodelistTy pe|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
3740 |package|PackageTypeCodelistT ype|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
3741
3742 **HierarchicalCodeReferenceType: **HierarchicalCodeReferenceType is a type for referencing a hierarchical code object. It consists of a URN and/or a complete set of reference fields.
3743
3744 Derivation:
3745
3746 * //ReferenceType// (restriction)
3747 ** //ContainerChildObjectReferenceType// (restriction)
3748 *** HierarchicalCodeReferenceType
3749
3750 Content:
3751 ( (Ref, URN?) | URN)
3752
3753 Element Documentation:
3754
3755 |**Name**|**Type**|**Documentation**
3756 |Ref|HierarchicalCodeRefT ype|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
3757 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3758 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3759
3760 **HierarchicalCodeRefType: **HierarchicalCodeRefType references a code from within a hierarchical codelist. Reference fields are required for both the code and the codelist.
3761
3762 Derivation:
3763
3764 * //RefBaseType// (restriction)
3765 ** //ContainerChildObjectRefBaseType// (restriction)
3766 *** HierarchicalCodeRefType
3767
3768 Attributes:
3769 agencyID, maintainableParentID, maintainableParentVersion?, containerID, id, version?, local?, class?, package?
3770
3771 Content:
3772 {Empty}
3773
3774 Attribute Documentation:
3775
3776 |**Name**|**Type**|**Documentation**
3777 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
3778 |maintainableParentID|IDType|The maintainableParentID references the hierarchical codelist in which the code being referenced is defined.
3779 |maintainableParentVersion (default: 1.0)|VersionType|The maintainableParentVersion attribute references the version of the hierarchical codelist in which the code being referenced is defined. If not supplied, a default value of 1.0 is assumed.
3780 |containerID|IDType|The containerID references the hierarchy which contains the code being referenced is defined.
3781 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
3782 |version|VersionType|The version attribute identifies the version of the object being reference, if applicable. If this is available, a default value of 1.0 will always apply.
3783 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
3784 |class (fixed: HierarchicalCode)|ObjectTypeCodelistTy pe|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
3785 |package (fixed: codelist)|PackageTypeCodelistT ype|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
3786
3787 **ConstraintReferenceType: **ConstraintReferenceType is a type for referencing a constraint object. It consists of a URN and/or a complete set of reference fields.
3788
3789 Derivation:
3790
3791 * //ReferenceType// (restriction)
3792 ** //MaintainableReferenceBaseType// (restriction)
3793 *** ConstraintReferenceType
3794
3795 Content:
3796 ( (Ref, URN?) | URN)
3797
3798 Element Documentation:
3799
3800 |**Name**|**Type**|**Documentation**
3801 |Ref|//ConstraintRefType//|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
3802 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3803 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3804
3805 //**ConstraintRefType**//**: **ConstraintRefType contains a set of reference fields for a constraint.
3806
3807 Derivation:
3808
3809 * //RefBaseType// (restriction)
3810 ** //MaintainableRefBaseType// (restriction)
3811 *** //ConstraintRefType//
3812
3813 Attributes:
3814 agencyID, id, version?, local?, class?, package?
3815
3816 Content:
3817 {Empty}
3818
3819 Attribute Documentation:
3820
3821 |**Name**|**Type**|**Documentation**
3822 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
3823 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
3824 |version (default: 1.0)|VersionType|The version attribute identifies the version of the object being reference, if applicable. If this is available, a default value of 1.0 will always apply.
3825 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
3826 |class|ConstraintTypeCodeli stType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
3827 |package (fixed: registry)|PackageTypeCodelistT ype|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
3828
3829 **AttachmentConstraintReferenceType: **AttachmentConstraintReferenceType is a type for referencing a attachment constraint object. It consists of a URN and/or a complete set of reference fields.
3830
3831 Derivation:
3832
3833 * //ReferenceType// (restriction)
3834 ** //MaintainableReferenceBaseType// (restriction)
3835 *** ConstraintReferenceType (restriction)
3836 **** AttachmentConstraintReferenceType
3837
3838 Content:
3839 ( (Ref, URN?) | URN)
3840
3841 Element Documentation:
3842
3843 |**Name**|**Type**|**Documentation**
3844 |Ref|AttachmentConstraint RefType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
3845 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3846 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3847
3848 **AttachmentConstraintRefType: **AttachmentConstraintRefType contains a set of reference fields for an attachment constraint.
3849
3850 Derivation:
3851
3852 * //RefBaseType// (restriction)
3853 ** //MaintainableRefBaseType// (restriction)
3854 *** //ConstraintRefType// (restriction)
3855 **** AttachmentConstraintRefType
3856
3857 Attributes:
3858 agencyID, id, version?, local?, class?, package?
3859
3860 Content:
3861 {Empty}
3862
3863 Attribute Documentation:
3864
3865 |**Name**|**Type**|**Documentation**
3866 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
3867 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
3868 |version (default: 1.0)|VersionType|The version attribute identifies the version of the object being reference, if applicable. If this is available, a default value of 1.0 will always apply.
3869 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
3870 |class (fixed: AttachmentConstraint)|ConstraintTypeCodeli stType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
3871 |package (fixed: registry)|PackageTypeCodelistT ype|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
3872
3873 **ContentConstraintReferenceType: **ContentConstraintReferenceType is a type for referencing a content constraint object. It consists of a URN and/or a complete set of reference fields.
3874
3875 Derivation:
3876
3877 * //ReferenceType// (restriction)
3878 ** //MaintainableReferenceBaseType// (restriction)
3879 *** ConstraintReferenceType (restriction)
3880 **** ContentConstraintReferenceType
3881
3882 Content:
3883 ( (Ref, URN?) | URN)
3884
3885 Element Documentation:
3886
3887 |**Name**|**Type**|**Documentation**
3888 |Ref|ContentConstraintRef Type|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
3889 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3890 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3891
3892 **ContentConstraintRefType: **ContentConstraintRefType contains a set of reference fields for a content constraint.
3893
3894 Derivation:
3895
3896 * //RefBaseType// (restriction)
3897 ** //MaintainableRefBaseType// (restriction)
3898 *** //ConstraintRefType// (restriction)
3899 **** ContentConstraintRefType
3900
3901 Attributes:
3902 agencyID, id, version?, local?, class?, package?
3903
3904 Content:
3905 {Empty}
3906
3907 Attribute Documentation:
3908
3909 |**Name**|**Type**|**Documentation**
3910 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
3911 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
3912 |version (default: 1.0)|VersionType|The version attribute identifies the version of the object being reference, if applicable. If this is available, a default value of 1.0 will always apply.
3913 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
3914 |class (fixed: ContentConstraint)|ConstraintTypeCodeli stType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
3915 |package (fixed: registry)|PackageTypeCodelistT ype|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
3916
3917 **DataflowReferenceType: **DataflowReferenceType is a type for referencing a dataflow object. It consists of a URN and/or a complete set of reference fields.
3918
3919 Derivation:
3920
3921 * //ReferenceType// (restriction)
3922 ** //MaintainableReferenceBaseType// (restriction)
3923 *** //StructureUsageReferenceBaseType// (restriction)
3924 **** DataflowReferenceType
3925
3926 Content:
3927 ( (Ref, URN?) | URN)
3928
3929 Element Documentation:
3930
3931 |**Name**|**Type**|**Documentation**
3932 |Ref|DataflowRefType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
3933 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3934 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3935
3936 **DataflowRefType: **DataflowRefType contains a set of reference fields for a data flow.
3937
3938 Derivation:
3939
3940 * //RefBaseType// (restriction)
3941 ** //MaintainableRefBaseType// (restriction)
3942 *** //StructureOrUsageRefBaseType// (restriction)
3943 **** //StructureUsageRefBaseType// (restriction)
3944 ***** DataflowRefType
3945
3946 Attributes:
3947 agencyID, id, version?, local?, class?, package?
3948
3949 Content:
3950 {Empty}
3951
3952 Attribute Documentation:
3953
3954 |**Name**|**Type**|**Documentation**
3955 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
3956 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
3957 |version (default: 1.0)|VersionType|The version attribute identifies the version of the object being reference, if applicable. If this is available, a default value of 1.0 will always apply.
3958 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
3959 |class (fixed: Dataflow)|StructureUsageTypeCo delistType|The class attribute indicates the class name of the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
3960 |package (fixed: datastructure)|StructurePackageType CodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
3961
3962 **MetadataflowReferenceType: **MetadataflowReferenceType is a type for referencing a metadata flow object. It consists of a URN and/or a complete set of reference fields.
3963
3964 Derivation:
3965
3966 * //ReferenceType// (restriction)
3967 ** //MaintainableReferenceBaseType// (restriction)
3968 *** //StructureUsageReferenceBaseType// (restriction)
3969 **** MetadataflowReferenceType
3970
3971 Content:
3972 ( (Ref, URN?) | URN)
3973
3974 Element Documentation:
3975
3976 |**Name**|**Type**|**Documentation**
3977 |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.
3978 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3979 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3980
3981 **MetadataflowRefType: **MetadataflowRefType contains a set of reference fields for a metadata flow.
3982
3983 Derivation:
3984
3985 * //RefBaseType// (restriction)
3986 ** //MaintainableRefBaseType// (restriction)
3987 *** //StructureOrUsageRefBaseType// (restriction)
3988 **** //StructureUsageRefBaseType// (restriction)
3989 ***** MetadataflowRefType
3990
3991 Attributes:
3992 agencyID, id, version?, local?, class?, package?
3993
3994 Content:
3995 {Empty}
3996
3997 Attribute Documentation:
3998
3999 |**Name**|**Type**|**Documentation**
4000 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
4001 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
4002 |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.
4003 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
4004 |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.
4005 |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.
4006
4007 **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.
4008
4009 Derivation:
4010
4011 * //ReferenceType// (restriction)
4012 ** //MaintainableReferenceBaseType// (restriction)
4013 *** //StructureReferenceBaseType// (restriction)
4014 **** DataStructureReferenceType
4015
4016 Content:
4017 ( (Ref, URN?) | URN)
4018
4019 Element Documentation:
4020
4021 |**Name**|**Type**|**Documentation**
4022 |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.
4023 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4024 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4025
4026 **DataStructureRefType: **DataStructureRefType contains a set of reference fields for a data structure definition.
4027
4028 Derivation:
4029
4030 * //RefBaseType// (restriction)
4031 ** //MaintainableRefBaseType// (restriction)
4032 *** //StructureOrUsageRefBaseType// (restriction)
4033 **** //StructureRefBaseType// (restriction)
4034 ***** DataStructureRefType
4035
4036 Attributes:
4037 agencyID, id, version?, local?, class?, package?
4038
4039 Content:
4040 {Empty}
4041
4042 Attribute Documentation:
4043
4044 |**Name**|**Type**|**Documentation**
4045 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
4046 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
4047 |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.
4048 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
4049 |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.
4050 |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.
4051
4052 **KeyDescriptorReferenceType: **KeyDescriptorReferenceType is a type for referencing a key descriptor object. It consists of a URN and/or a complete set of reference fields.
4053
4054 Derivation:
4055
4056 * //ReferenceType// (restriction)
4057 ** //ChildObjectReferenceType// (restriction)
4058 *** //ComponentListReferenceType// (restriction)
4059 **** KeyDescriptorReferenceType
4060
4061 Content:
4062 ( (Ref, URN?) | URN)
4063
4064 Element Documentation:
4065
4066 |**Name**|**Type**|**Documentation**
4067 |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.
4068 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4069 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4070
4071 **KeyDescriptorRefType: **KeyDescriptorRefType contains a reference to the key descriptor within a data structure definition.
4072
4073 Derivation:
4074
4075 * //RefBaseType// (restriction)
4076 ** //ChildObjectRefBaseType// (restriction)
4077 *** //ComponentListRefBaseType// (restriction)
4078 **** KeyDescriptorRefType
4079
4080 Attributes:
4081 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
4082
4083 Content:
4084 {Empty}
4085
4086 Attribute Documentation:
4087
4088 |**Name**|**Type**|**Documentation**
4089 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
4090 |maintainableParentID|IDType|The maintainableParentID references the structure in which the component list being referenced is defined.
4091 |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.
4092 |id (fixed: DIMENSION_DESCRIPTOR)|IDType|The id attribute identifies the object being referenced, and is therefore always required.
4093 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
4094 |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.
4095 |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.
4096
4097 **AttributeDescriptorReferenceType: **AttributeDescriptorReferenceType is a type for referencing an attribute descriptor object. It consists of a URN and/or a complete set of reference fields.
4098
4099 Derivation:
4100
4101 * //ReferenceType// (restriction)
4102 ** //ChildObjectReferenceType// (restriction)
4103 *** //ComponentListReferenceType// (restriction)
4104 **** AttributeDescriptorReferenceType
4105
4106 Content:
4107 ( (Ref, URN?) | URN)
4108
4109 Element Documentation:
4110
4111 |**Name**|**Type**|**Documentation**
4112 |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.
4113 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4114 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4115
4116 **AttributeDescriptorRefType: **AttributeDescriptorRefType contains a reference to the attribute descriptor within a data structure definition.
4117
4118 Derivation:
4119
4120 * //RefBaseType// (restriction)
4121 ** //ChildObjectRefBaseType// (restriction)
4122 *** //ComponentListRefBaseType// (restriction)
4123 **** AttributeDescriptorRefType
4124
4125 Attributes:
4126 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
4127
4128 Content:
4129 {Empty}
4130
4131 Attribute Documentation:
4132
4133 |**Name**|**Type**|**Documentation**
4134 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
4135 |maintainableParentID|IDType|The maintainableParentID references the structure in which the component list being referenced is defined.
4136 |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.
4137 |id (fixed: ATTRIBUTE_DESCRIPTOR)|IDType|The id attribute identifies the object being referenced, and is therefore always required.
4138 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
4139 |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.
4140 |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.
4141
4142 **MeasureDescriptorReferenceType: **MeasureDescriptorReferenceType is a type for referencing a measure descriptor object. It consists of a URN and/or a complete set of reference fields.
4143
4144 Derivation:
4145
4146 * //ReferenceType// (restriction)
4147 ** //ChildObjectReferenceType// (restriction)
4148 *** //ComponentListReferenceType// (restriction)
4149 **** MeasureDescriptorReferenceType
4150
4151 Content:
4152 ( (Ref, URN?) | URN)
4153
4154 Element Documentation:
4155
4156 |**Name**|**Type**|**Documentation**
4157 |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.
4158 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4159 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4160
4161 **MeasureDescriptorRefType: **MeasureDescriptorRefType contains a reference to the measure descriptor within a data structure definition.
4162
4163 Derivation:
4164
4165 * //RefBaseType// (restriction)
4166 ** //ChildObjectRefBaseType// (restriction)
4167 *** //ComponentListRefBaseType// (restriction)
4168 **** MeasureDescriptorRefType
4169
4170 Attributes:
4171 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
4172
4173 Content:
4174 {Empty}
4175
4176 Attribute Documentation:
4177
4178 |**Name**|**Type**|**Documentation**
4179 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
4180 |maintainableParentID|IDType|The maintainableParentID references the structure in which the component list being referenced is defined.
4181 |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.
4182 |id (fixed: MEASURE_DESCRIPTOR)|IDType|The id attribute identifies the object being referenced, and is therefore always required.
4183 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
4184 |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.
4185 |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.
4186
4187 **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.
4188
4189 Derivation:
4190
4191 * //ReferenceType// (restriction)
4192 ** //ChildObjectReferenceType// (restriction)
4193 *** //ComponentListReferenceType// (restriction)
4194 **** GroupKeyDescriptorReferenceType
4195
4196 Content:
4197 ( (Ref, URN?) | URN)
4198
4199 Element Documentation:
4200
4201 |**Name**|**Type**|**Documentation**
4202 |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.
4203 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4204 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4205
4206 **GroupKeyDescriptorRefType: **GroupKeyDescriptorRefType contains a reference to a group key descriptor within a data structure definition.
4207
4208 Derivation:
4209
4210 * //RefBaseType// (restriction)
4211 ** //ChildObjectRefBaseType// (restriction)
4212 *** //ComponentListRefBaseType// (restriction)
4213 **** GroupKeyDescriptorRefType
4214
4215 Attributes:
4216 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
4217
4218 Content:
4219 {Empty}
4220
4221 Attribute Documentation:
4222
4223 |**Name**|**Type**|**Documentation**
4224 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
4225 |maintainableParentID|IDType|The maintainableParentID references the structure in which the component list being referenced is defined.
4226 |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.
4227 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
4228 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
4229 |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.
4230 |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.
4231
4232 **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).
4233
4234 Derivation:
4235
4236 * //ReferenceType// (restriction)
4237 ** //LocalComponentListReferenceType// (restriction)
4238 *** LocalGroupKeyDescriptorReferenceType
4239
4240 Content:
4241 Ref
4242
4243 Element Documentation:
4244
4245 |**Name**|**Type**|**Documentation**
4246 |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.
4247
4248 **LocalGroupKeyDescriptorRefType: **LocalGroupKeyDescriptorRefType contains a local reference to a group key descriptor.
4249
4250 Derivation:
4251
4252 * //RefBaseType// (restriction)
4253 ** //LocalIdentifiableRefBaseType// (restriction)
4254 *** //LocalComponentListRefBaseType// (restriction)
4255 **** LocalGroupKeyDescriptorRefType
4256
4257 Attributes:
4258 id, local?, class?, package?
4259
4260 Content:
4261 {Empty}
4262
4263 Attribute Documentation:
4264
4265 |**Name**|**Type**|**Documentation**
4266 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
4267 |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.
4268 |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.
4269 |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.
4270
4271 **DimensionReferenceType: **DimensionReferenceType is a type for referencing a dimension object. It consists of a URN and/or a complete set of reference fields.
4272
4273 Derivation:
4274
4275 * //ReferenceType// (restriction)
4276 ** //ContainerChildObjectReferenceType// (restriction)
4277 *** //ComponentReferenceType// (restriction)
4278 **** DimensionReferenceType
4279
4280 Content:
4281 ( (Ref, URN?) | URN)
4282
4283 Element Documentation:
4284
4285 |**Name**|**Type**|**Documentation**
4286 |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.
4287 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4288 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4289
4290 **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.
4291
4292 Derivation:
4293
4294 * //RefBaseType// (restriction)
4295 ** //ContainerChildObjectRefBaseType// (restriction)
4296 *** //ComponentRefBaseType// (restriction)
4297 **** DimensionRefType
4298
4299 Attributes:
4300 agencyID, maintainableParentID, maintainableParentVersion?, id, version?, local?, class?, package?
4301
4302 Content:
4303 {Empty}
4304
4305 Attribute Documentation:
4306
4307 |**Name**|**Type**|**Documentation**
4308 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
4309 |maintainableParentID|IDType|The maintainableParentID references the structure in which the component being referenced is defined.
4310 |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.
4311 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
4312 |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.
4313 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
4314 |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.
4315 |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.
4316
4317 **MeasureDimensionReferenceType: **MeasureDimensionReferenceType is a type for referencing a measure dimension object. It consists of a URN and/or a complete set of reference fields.
4318
4319 Derivation:
4320
4321 * //ReferenceType// (restriction)
4322 ** //ContainerChildObjectReferenceType// (restriction)
4323 *** //ComponentReferenceType// (restriction)
4324 **** MeasureDimensionReferenceType
4325
4326 Content:
4327 ( (Ref, URN?) | URN)
4328
4329 Element Documentation:
4330
4331 |**Name**|**Type**|**Documentation**
4332 |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.
4333 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4334 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4335
4336 **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.
4337
4338 Derivation:
4339
4340 * //RefBaseType// (restriction)
4341 ** //ContainerChildObjectRefBaseType// (restriction)
4342 *** //ComponentRefBaseType// (restriction)
4343 **** MeasureDimensionRefType
4344
4345 Attributes:
4346 agencyID, maintainableParentID, maintainableParentVersion?, id, version?, local?, class?, package?
4347
4348 Content:
4349 {Empty}
4350
4351 Attribute Documentation:
4352
4353 |**Name**|**Type**|**Documentation**
4354 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
4355 |maintainableParentID|IDType|The maintainableParentID references the structure in which the component being referenced is defined.
4356 |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.
4357 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
4358 |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.
4359 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
4360 |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.
4361 |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.
4362
4363 **TimeDimensionReferenceType: **TimeDimensionReferenceType is a type for referencing a time dimension object. It consists of a URN and/or a complete set of reference fields.
4364
4365 Derivation:
4366
4367 * //ReferenceType// (restriction)
4368 ** //ContainerChildObjectReferenceType// (restriction)
4369 *** //ComponentReferenceType// (restriction)
4370 **** TimeDimensionReferenceType
4371
4372 Content:
4373 ( (Ref, URN?) | URN)
4374
4375 Element Documentation:
4376
4377 |**Name**|**Type**|**Documentation**
4378 |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.
4379 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4380 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4381
4382 **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.
4383
4384 Derivation:
4385
4386 * //RefBaseType// (restriction)
4387 ** //ContainerChildObjectRefBaseType// (restriction)
4388 *** //ComponentRefBaseType// (restriction)
4389 **** TimeDimensionRefType
4390
4391 Attributes:
4392 agencyID, maintainableParentID, maintainableParentVersion?, id, version?, local?, class?, package?
4393
4394 Content:
4395 {Empty}
4396
4397 Attribute Documentation:
4398
4399 |**Name**|**Type**|**Documentation**
4400 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
4401 |maintainableParentID|IDType|The maintainableParentID references the structure in which the component being referenced is defined.
4402 |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.
4403 |id (fixed: TIME_PERIOD)|IDType|The id attribute identifies the object being referenced, and is therefore always required.
4404 |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.
4405 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
4406 |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.
4407 |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.
4408
4409 **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).
4410
4411 Derivation:
4412
4413 * //ReferenceType// (restriction)
4414 ** //LocalComponentListComponentReferenceBaseType// (restriction)
4415 *** //LocalComponentReferenceBaseType// (restriction)
4416 **** LocalDimensionReferenceType
4417
4418 Content:
4419 Ref
4420
4421 Element Documentation:
4422
4423 |**Name**|**Type**|**Documentation**
4424 |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.
4425
4426 **LocalDimensionRefType: **LocalDimensionRefType contains the reference fields for referencing a dimension locally.
4427
4428 Derivation:
4429
4430 * //RefBaseType// (restriction)
4431 ** //LocalIdentifiableRefBaseType// (restriction)
4432 *** //LocalComponentListComponentRefBaseType// (restriction)
4433 **** //LocalComponentRefBaseType// (restriction)
4434 ***** LocalDimensionRefType
4435
4436 Attributes:
4437 id, local?, class?, package?
4438
4439 Content:
4440 {Empty}
4441
4442 Attribute Documentation:
4443
4444 |**Name**|**Type**|**Documentation**
4445 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
4446 |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.
4447 |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.
4448 |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.
4449
4450 **AttributeReferenceType: **AttributeReferenceType is a type for referencing an attribute object. It consists of a URN and/or a complete set of reference fields.
4451
4452 Derivation:
4453
4454 * //ReferenceType// (restriction)
4455 ** //ContainerChildObjectReferenceType// (restriction)
4456 *** //ComponentReferenceType// (restriction)
4457 **** AttributeReferenceType
4458
4459 Content:
4460 ( (Ref, URN?) | URN)
4461
4462 Element Documentation:
4463
4464 |**Name**|**Type**|**Documentation**
4465 |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.
4466 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4467 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4468
4469 **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.
4470
4471 Derivation:
4472
4473 * //RefBaseType// (restriction)
4474 ** //ContainerChildObjectRefBaseType// (restriction)
4475 *** //ComponentRefBaseType// (restriction)
4476 **** AttributeRefType
4477
4478 Attributes:
4479 agencyID, maintainableParentID, maintainableParentVersion?, id, version?, local?, class?, package?
4480
4481 Content:
4482 {Empty}
4483
4484 Attribute Documentation:
4485
4486 |**Name**|**Type**|**Documentation**
4487 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
4488 |maintainableParentID|IDType|The maintainableParentID references the structure in which the component being referenced is defined.
4489 |maintainableParentVersion (default: 1.0)|VersionType|The maintainableParentVersion attribute references the version of the structure in which the component being referenced is defined. If not supplied, a default value of 1.0 is assumed.
4490 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
4491 |version|VersionType|The version attribute identifies the version of the object being reference, if applicable. If this is available, a default value of 1.0 will always apply.
4492 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
4493 |class (fixed: 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.
4494 |package (fixed: datastructure)|StructurePackageType CodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
4495
4496 **PrimaryMeasureReferenceType: **PrimaryMeasureReferenceType is a type for referencing a primary measure object. It consists of a URN and/or a complete set of reference fields.
4497
4498 Derivation:
4499
4500 * //ReferenceType// (restriction)
4501 ** //ContainerChildObjectReferenceType// (restriction)
4502 *** //ComponentReferenceType// (restriction)
4503 **** PrimaryMeasureReferenceType
4504
4505 Content:
4506 ( (Ref, URN?) | URN)
4507
4508 Element Documentation:
4509
4510 |**Name**|**Type**|**Documentation**
4511 |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.
4512 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4513 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4514
4515 **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.
4516
4517 Derivation:
4518
4519 * //RefBaseType// (restriction)
4520 ** //ContainerChildObjectRefBaseType// (restriction)
4521 *** //ComponentRefBaseType// (restriction)
4522 **** PrimaryMeasureRefType
4523
4524 Attributes:
4525 agencyID, maintainableParentID, maintainableParentVersion?, id, version?, local?, class?, package?
4526
4527 Content:
4528 {Empty}
4529
4530 Attribute Documentation:
4531
4532 |**Name**|**Type**|**Documentation**
4533 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
4534 |maintainableParentID|IDType|The maintainableParentID references the structure in which the component being referenced is defined.
4535 |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.
4536 |id (fixed: OBS_VALUE)|IDType|The id attribute identifies the object being referenced, and is therefore always required.
4537 |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.
4538 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
4539 |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.
4540 |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.
4541
4542 **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).
4543
4544 Derivation:
4545
4546 * //ReferenceType// (restriction)
4547 ** //LocalComponentListComponentReferenceBaseType// (restriction)
4548 *** //LocalComponentReferenceBaseType// (restriction)
4549 **** LocalPrimaryMeasureReferenceType
4550
4551 Content:
4552 Ref
4553
4554 Element Documentation:
4555
4556 |**Name**|**Type**|**Documentation**
4557 |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.
4558
4559 **LocalPrimaryMeasureRefType: **LocalPrimaryMeasureRefType contains the reference fields for referencing a primary measure locally.
4560
4561 Derivation:
4562
4563 * //RefBaseType// (restriction)
4564 ** //LocalIdentifiableRefBaseType// (restriction)
4565 *** //LocalComponentListComponentRefBaseType// (restriction)
4566 **** //LocalComponentRefBaseType// (restriction)
4567 ***** LocalPrimaryMeasureRefType
4568
4569 Attributes:
4570 id, local?, class?, package?
4571
4572 Content:
4573 {Empty}
4574
4575 Attribute Documentation:
4576
4577 |**Name**|**Type**|**Documentation**
4578 |id (fixed: OBS_VALUE)|IDType|The id attribute identifies the object being referenced, and is therefore always required.
4579 |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.
4580 |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.
4581 |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.
4582
4583 **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.
4584
4585 Derivation:
4586
4587 * //ReferenceType// (restriction)
4588 ** //LocalComponentListComponentReferenceBaseType// (restriction)
4589 *** LocalDataStructureComponentReferenceType
4590
4591 Content:
4592 Ref
4593
4594 Element Documentation:
4595
4596 |**Name**|**Type**|**Documentation**
4597 |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.
4598
4599 **LocalDataStructureComponentRefType: **LocalDataStructureComponentRefType contains the reference fields for referencing any data structure component locally. This reference must specify the class of the component being referenced.
4600
4601 Derivation:
4602
4603 * //RefBaseType// (restriction)
4604 ** //LocalIdentifiableRefBaseType// (restriction)
4605 *** //LocalComponentListComponentRefBaseType// (restriction)
4606 **** LocalDataStructureComponentRefType
4607
4608 Attributes:
4609 id, local?, class, package?
4610
4611 Content:
4612 {Empty}
4613
4614 Attribute Documentation:
4615
4616 |**Name**|**Type**|**Documentation**
4617 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
4618 |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.
4619 |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.
4620 |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.
4621
4622 **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.
4623
4624 Derivation:
4625
4626 * //ReferenceType// (restriction)
4627 ** //MaintainableReferenceBaseType// (restriction)
4628 *** //ItemSchemeReferenceBaseType// (restriction)
4629 **** ItemSchemeReferenceType (restriction)
4630 ***** DataStructureEnumerationSchemeReferenceType
4631
4632 Content:
4633 ( (Ref, URN?) | URN)
4634
4635 Element Documentation:
4636
4637 |**Name**|**Type**|**Documentation**
4638 |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.
4639 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4640 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4641
4642 **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.
4643
4644 Derivation:
4645
4646 * //RefBaseType// (restriction)
4647 ** //MaintainableRefBaseType// (restriction)
4648 *** //ItemSchemeRefBaseType// (restriction)
4649 **** ItemSchemeRefType (restriction)
4650 ***** DataStructureEnumerationSchemeRefType
4651
4652 Attributes:
4653 agencyID, id, version?, local?, class, package
4654
4655 Content:
4656 {Empty}
4657
4658 Attribute Documentation:
4659
4660 |**Name**|**Type**|**Documentation**
4661 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
4662 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
4663 |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.
4664 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
4665 |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.
4666 |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.
4667
4668 **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.
4669
4670 Derivation:
4671
4672 * //ReferenceType// (restriction)
4673 ** //MaintainableReferenceBaseType// (restriction)
4674 *** //StructureReferenceBaseType// (restriction)
4675 **** MetadataStructureReferenceType
4676
4677 Content:
4678 ( (Ref, URN?) | URN)
4679
4680 Element Documentation:
4681
4682 |**Name**|**Type**|**Documentation**
4683 |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.
4684 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4685 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4686
4687 **MetadataStructureRefType: **MetadataStructureRefType contains a set of reference fields for a metadata structure definition.
4688
4689 Derivation:
4690
4691 * //RefBaseType// (restriction)
4692 ** //MaintainableRefBaseType// (restriction)
4693 *** //StructureOrUsageRefBaseType// (restriction)
4694 **** //StructureRefBaseType// (restriction)
4695 ***** MetadataStructureRefType
4696
4697 Attributes:
4698 agencyID, id, version?, local?, class?, package?
4699
4700 Content:
4701 {Empty}
4702
4703 Attribute Documentation:
4704
4705 |**Name**|**Type**|**Documentation**
4706 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
4707 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
4708 |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.
4709 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
4710 |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.
4711 |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.
4712
4713 **MetadataTargetReferenceType: **MetadataTargetReferenceType is a type for referencing a metadata target object. It consists of a URN and/or a complete set of reference fields.
4714
4715 Derivation:
4716
4717 * //ReferenceType// (restriction)
4718 ** //ChildObjectReferenceType// (restriction)
4719 *** //ComponentListReferenceType// (restriction)
4720 **** MetadataTargetReferenceType
4721
4722 Content:
4723 ( (Ref, URN?) | URN)
4724
4725 Element Documentation:
4726
4727 |**Name**|**Type**|**Documentation**
4728 |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.
4729 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4730 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4731
4732 **MetadataTargetRefType: **MetadataTargetRefType contains a reference to a metadata target within a metadata structure definition.
4733
4734 Derivation:
4735
4736 * //RefBaseType// (restriction)
4737 ** //ChildObjectRefBaseType// (restriction)
4738 *** //ComponentListRefBaseType// (restriction)
4739 **** MetadataTargetRefType
4740
4741 Attributes:
4742 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
4743
4744 Content:
4745 {Empty}
4746
4747 Attribute Documentation:
4748
4749 |**Name**|**Type**|**Documentation**
4750 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
4751 |maintainableParentID|IDType|The maintainableParentID references the structure in which the component list being referenced is defined.
4752 |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.
4753 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
4754 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
4755 |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.
4756 |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.
4757
4758 **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).
4759
4760 Derivation:
4761
4762 * //ReferenceType// (restriction)
4763 ** //LocalComponentListReferenceType// (restriction)
4764 *** LocalMetadataTargetReferenceType
4765
4766 Content:
4767 Ref
4768
4769 Element Documentation:
4770
4771 |**Name**|**Type**|**Documentation**
4772 |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.
4773
4774 **LocalMetadataTargetRefType: **LocalMetadataTargetRefType contains a local reference to a metadata target object.
4775
4776 Derivation:
4777
4778 * //RefBaseType// (restriction)
4779 ** //LocalIdentifiableRefBaseType// (restriction)
4780 *** //LocalComponentListRefBaseType// (restriction)
4781 **** LocalMetadataTargetRefType
4782
4783 Attributes:
4784 id, local?, class?, package?
4785
4786 Content:
4787 {Empty}
4788
4789 Attribute Documentation:
4790
4791 |**Name**|**Type**|**Documentation**
4792 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
4793 |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.
4794 |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.
4795 |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.
4796
4797 **ConstraintTargetReferenceType: **ConstraintTargetReferenceType is a type for referencing a constraint target object. It consists of a URN and/or a complete set of reference fields.
4798
4799 Derivation:
4800
4801 * //ReferenceType// (restriction)
4802 ** //ContainerChildObjectReferenceType// (restriction)
4803 *** //ComponentReferenceType// (restriction)
4804 **** ConstraintTargetReferenceType
4805
4806 Content:
4807 ( (Ref, URN?) | URN)
4808
4809 Element Documentation:
4810
4811 |**Name**|**Type**|**Documentation**
4812 |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.
4813 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4814 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4815
4816 **ConstraintTargetRefType: **ConstraintTargetRefType contains a reference to a constraint target within a metadata target of a data structure definition.
4817
4818 Derivation:
4819
4820 * //RefBaseType// (restriction)
4821 ** //ContainerChildObjectRefBaseType// (restriction)
4822 *** //ComponentRefBaseType// (restriction)
4823 **** ConstraintTargetRefType
4824
4825 Attributes:
4826 agencyID, maintainableParentID, maintainableParentVersion?, containerID, id, version?, local?, class?, package?
4827
4828 Content:
4829 {Empty}
4830
4831 Attribute Documentation:
4832
4833 |**Name**|**Type**|**Documentation**
4834 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
4835 |maintainableParentID|IDType|The maintainableParentID references the structure in which the component being referenced is defined.
4836 |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.
4837 |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.
4838 |id (fixed: CONSTRAINT_TARGET)|IDType|The id attribute identifies the object being referenced, and is therefore always required.
4839 |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.
4840 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
4841 |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.
4842 |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.
4843
4844 **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.
4845
4846 Derivation:
4847
4848 * //ReferenceType// (restriction)
4849 ** //ContainerChildObjectReferenceType// (restriction)
4850 *** //ComponentReferenceType// (restriction)
4851 **** DataSetTargetReferenceType
4852
4853 Content:
4854 ( (Ref, URN?) | URN)
4855
4856 Element Documentation:
4857
4858 |**Name**|**Type**|**Documentation**
4859 |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.
4860 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4861 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4862
4863 **DataSetTargetRefType: **DataSetTargetRefType contains a reference to a data set target within a metadata target of a data structure definition.
4864
4865 Derivation:
4866
4867 * //RefBaseType// (restriction)
4868 ** //ContainerChildObjectRefBaseType// (restriction)
4869 *** //ComponentRefBaseType// (restriction)
4870 **** DataSetTargetRefType
4871
4872 Attributes:
4873 agencyID, maintainableParentID, maintainableParentVersion?, containerID, id, version?, local?, class?, package?
4874
4875 Content:
4876 {Empty}
4877
4878 Attribute Documentation:
4879
4880 |**Name**|**Type**|**Documentation**
4881 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
4882 |maintainableParentID|IDType|The maintainableParentID references the structure in which the component being referenced is defined.
4883 |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.
4884 |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.
4885 |id (fixed: DATA_SET_TARGET)|IDType|The id attribute identifies the object being referenced, and is therefore always required.
4886 |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.
4887 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
4888 |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.
4889 |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.
4890
4891 **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.
4892
4893 Derivation:
4894
4895 * //ReferenceType// (restriction)
4896 ** //ContainerChildObjectReferenceType// (restriction)
4897 *** //ComponentReferenceType// (restriction)
4898 **** KeyDescriptorValuesTargetReferenceType
4899
4900 Content:
4901 ( (Ref, URN?) | URN)
4902
4903 Element Documentation:
4904
4905 |**Name**|**Type**|**Documentation**
4906 |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.
4907 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4908 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4909
4910 **KeyDescriptorValuesTargetRefType: **KeyDescriptorValuesTargetRefType contains a reference to a key descriptor values target within a metadata target of a data structure definition.
4911
4912 Derivation:
4913
4914 * //RefBaseType// (restriction)
4915 ** //ContainerChildObjectRefBaseType// (restriction)
4916 *** //ComponentRefBaseType// (restriction)
4917 **** KeyDescriptorValuesTargetRefType
4918
4919 Attributes:
4920 agencyID, maintainableParentID, maintainableParentVersion?, containerID, id, version?, local?, class?, package?
4921
4922 Content:
4923 {Empty}
4924
4925 Attribute Documentation:
4926
4927 |**Name**|**Type**|**Documentation**
4928 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
4929 |maintainableParentID|IDType|The maintainableParentID references the structure in which the component being referenced is defined.
4930 |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.
4931 |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.
4932 |id (fixed: DIMENSION_DESCRIPTOR_VALUES_TARGET)|IDType|The id attribute identifies the object being referenced, and is therefore always required.
4933 |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.
4934 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
4935 |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.
4936 |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.
4937
4938 **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.
4939
4940 Derivation:
4941
4942 * //ReferenceType// (restriction)
4943 ** //ContainerChildObjectReferenceType// (restriction)
4944 *** //ComponentReferenceType// (restriction)
4945 **** ReportPeriodTargetReferenceType
4946
4947 Content:
4948 ( (Ref, URN?) | URN)
4949
4950 Element Documentation:
4951
4952 |**Name**|**Type**|**Documentation**
4953 |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.
4954 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4955 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
4956
4957 **ReportPeriodTargetRefType: **ReportPeriodTargetRefType contains a reference to a report period target within a metadata target of a data structure definition.
4958
4959 Derivation:
4960
4961 * //RefBaseType// (restriction)
4962 ** //ContainerChildObjectRefBaseType// (restriction)
4963 *** //ComponentRefBaseType// (restriction)
4964 **** ReportPeriodTargetRefType
4965
4966 Attributes:
4967 agencyID, maintainableParentID, maintainableParentVersion?, containerID, id, version?, local?, class?, package?
4968
4969 Content:
4970 {Empty}
4971
4972 Attribute Documentation:
4973
4974 |**Name**|**Type**|**Documentation**
4975 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
4976 |maintainableParentID|IDType|The maintainableParentID references the structure in which the component being referenced is defined.
4977 |maintainableParentVersion (default: 1.0)|VersionType|The maintainableParentVersion attribute references the version of the structure in which the component being referenced is defined. If not supplied, a default value of 1.0 is assumed.
4978 |containerID|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.
4979 |id (fixed: REPORT_PERIOD_TARGET)|IDType|The id attribute identifies the object being referenced, and is therefore always required.
4980 |version|VersionType|The version attribute identifies the version of the object being reference, if applicable. If this is available, a default value of 1.0 will always apply.
4981 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
4982 |class (fixed: 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.
4983 |package (fixed: metadatastructure)|StructurePackageType CodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
4984
4985 **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.
4986
4987 Derivation:
4988
4989 * //ReferenceType// (restriction)
4990 ** //ContainerChildObjectReferenceType// (restriction)
4991 *** //ComponentReferenceType// (restriction)
4992 **** IdentifiableObjectTargetReferenceType
4993
4994 Content:
4995 ( (Ref, URN?) | URN)
4996
4997 Element Documentation:
4998
4999 |**Name**|**Type**|**Documentation**
5000 |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.
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 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5003
5004 **IdentifiableObjectTargetRefType: **IdentifiableObjectTargetRefType contains a reference to an identifiable object target within a metadata target of a data structure definition.
5005
5006 Derivation:
5007
5008 * //RefBaseType// (restriction)
5009 ** //ContainerChildObjectRefBaseType// (restriction)
5010 *** //ComponentRefBaseType// (restriction)
5011 **** IdentifiableObjectTargetRefType
5012
5013 Attributes:
5014 agencyID, maintainableParentID, maintainableParentVersion?, containerID?, id, version?, local?, class?, package?
5015
5016 Content:
5017 {Empty}
5018
5019 Attribute Documentation:
5020
5021 |**Name**|**Type**|**Documentation**
5022 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
5023 |maintainableParentID|IDType|The maintainableParentID references the structure in which the component being referenced is defined.
5024 |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.
5025 |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.
5026 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
5027 |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.
5028 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
5029 |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.
5030 |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.
5031
5032 **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.
5033
5034 Derivation:
5035
5036 * //ReferenceType// (restriction)
5037 ** //LocalComponentListComponentReferenceBaseType// (restriction)
5038 *** //LocalComponentReferenceBaseType// (restriction)
5039 **** LocalTargetObjectReferenceType
5040
5041 Content:
5042 Ref
5043
5044 Element Documentation:
5045
5046 |**Name**|**Type**|**Documentation**
5047 |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.
5048
5049 **LocalTargetObjectRefType: **LocalTargetObjectRefType contains the reference fields for referencing a target object locally.
5050
5051 Derivation:
5052
5053 * //RefBaseType// (restriction)
5054 ** //LocalIdentifiableRefBaseType// (restriction)
5055 *** //LocalComponentListComponentRefBaseType// (restriction)
5056 **** //LocalComponentRefBaseType// (restriction)
5057 ***** LocalTargetObjectRefType
5058
5059 Attributes:
5060 id, local?, class, package?
5061
5062 Content:
5063 {Empty}
5064
5065 Attribute Documentation:
5066
5067 |**Name**|**Type**|**Documentation**
5068 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
5069 |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.
5070 |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.
5071 |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.
5072
5073 **ReportStructureReferenceType: **ReportStructureReferenceType is a type for referencing a report structure object. It consists of a URN and/or a complete set of reference fields.
5074
5075 Derivation:
5076
5077 * //ReferenceType// (restriction)
5078 ** //ChildObjectReferenceType// (restriction)
5079 *** //ComponentListReferenceType// (restriction)
5080 **** ReportStructureReferenceType
5081
5082 Content:
5083 ( (Ref, URN?) | URN)
5084
5085 Element Documentation:
5086
5087 |**Name**|**Type**|**Documentation**
5088 |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.
5089 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5090 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5091
5092 **ReportStructureRefType: **ReportStructureRefType contains a reference to a report structure within a metadata structure definition.
5093
5094 Derivation:
5095
5096 * //RefBaseType// (restriction)
5097 ** //ChildObjectRefBaseType// (restriction)
5098 *** //ComponentListRefBaseType// (restriction)
5099 **** ReportStructureRefType
5100
5101 Attributes:
5102 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
5103
5104 Content:
5105 {Empty}
5106
5107 Attribute Documentation:
5108
5109 |**Name**|**Type**|**Documentation**
5110 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
5111 |maintainableParentID|IDType|The maintainableParentID references the structure in which the component list being referenced is defined.
5112 |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.
5113 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
5114 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
5115 |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.
5116 |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.
5117
5118 **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).
5119
5120 Derivation:
5121
5122 * //ReferenceType// (restriction)
5123 ** //LocalComponentListReferenceType// (restriction)
5124 *** LocalReportStructureReferenceType
5125
5126 Content:
5127 Ref
5128
5129 Element Documentation:
5130
5131 |**Name**|**Type**|**Documentation**
5132 |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.
5133
5134 **LocalReportStructureRefType: **LocalReportStructureRefType contains a local reference to a report structure object.
5135
5136 Derivation:
5137
5138 * //RefBaseType// (restriction)
5139 ** //LocalIdentifiableRefBaseType// (restriction)
5140 *** //LocalComponentListRefBaseType// (restriction)
5141 **** LocalReportStructureRefType
5142
5143 Attributes:
5144 id, local?, class?, package?
5145
5146 Content:
5147 {Empty}
5148
5149 Attribute Documentation:
5150
5151 |**Name**|**Type**|**Documentation**
5152 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
5153 |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.
5154 |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.
5155 |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.
5156
5157 **MetadataAttributeReferenceType: **MetadataAttributeReferenceType is a type for referencing a metadata attribute object. It consists of a URN and/or a complete set of reference fields.
5158
5159 Derivation:
5160
5161 * //ReferenceType// (restriction)
5162 ** //ContainerChildObjectReferenceType// (restriction)
5163 *** //ComponentReferenceType// (restriction)
5164 **** MetadataAttributeReferenceType
5165
5166 Content:
5167 ( (Ref, URN?) | URN)
5168
5169 Element Documentation:
5170
5171 |**Name**|**Type**|**Documentation**
5172 |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.
5173 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5174 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5175
5176 **MetadataAttributeRefType: **MetadataAttributeRefType contains a reference to a metadata attribute within a report structure in a metadata structure definition.
5177
5178 Derivation:
5179
5180 * //RefBaseType// (restriction)
5181 ** //ContainerChildObjectRefBaseType// (restriction)
5182 *** //ComponentRefBaseType// (restriction)
5183 **** MetadataAttributeRefType
5184
5185 Attributes:
5186 agencyID, maintainableParentID, maintainableParentVersion?, containerID, id, version?, local?, class?, package?
5187
5188 Content:
5189 {Empty}
5190
5191 Attribute Documentation:
5192
5193 |**Name**|**Type**|**Documentation**
5194 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
5195 |maintainableParentID|IDType|The maintainableParentID references the structure in which the component being referenced is defined.
5196 |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.
5197 |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.
5198 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
5199 |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.
5200 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
5201 |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.
5202 |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.
5203
5204 **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.
5205
5206 Derivation:
5207
5208 * //ReferenceType// (restriction)
5209 ** //LocalComponentListComponentReferenceBaseType// (restriction)
5210 *** LocalMetadataStructureComponentReferenceType
5211
5212 Content:
5213 Ref
5214
5215 Element Documentation:
5216
5217 |**Name**|**Type**|**Documentation**
5218 |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.
5219
5220 **LocalMetadataStructureComponentRefType: **LocalMetadataStructureComponentRefType contains the reference fields for referencing any metadata structure component locally. This reference must specify the class of the component being referenced.
5221
5222 Derivation:
5223
5224 * //RefBaseType// (restriction)
5225 ** //LocalIdentifiableRefBaseType// (restriction)
5226 *** //LocalComponentListComponentRefBaseType// (restriction)
5227 **** LocalMetadataStructureComponentRefType
5228
5229 Attributes:
5230 containerID, id, local?, class, package?
5231
5232 Content:
5233 {Empty}
5234
5235 Attribute Documentation:
5236
5237 |**Name**|**Type**|**Documentation**
5238 |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.
5239 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
5240 |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.
5241 |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.
5242 |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.
5243
5244 **ProvisionAgreementReferenceType: **ProvisionAgreementReferenceType is a type for referencing a provision agreement. It consists of a URN and/or a complete set of reference fields.
5245
5246 Derivation:
5247
5248 * //ReferenceType// (restriction)
5249 ** //MaintainableReferenceBaseType// (restriction)
5250 *** ProvisionAgreementReferenceType
5251
5252 Content:
5253 ( (Ref, URN?) | URN)
5254
5255 Element Documentation:
5256
5257 |**Name**|**Type**|**Documentation**
5258 |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.
5259 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5260 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5261
5262 **ProvisionAgreementRefType: **ProvisionAgreementRefType contains a set of reference fields for a provision agreement.
5263
5264 Derivation:
5265
5266 * //RefBaseType// (restriction)
5267 ** //MaintainableRefBaseType// (restriction)
5268 *** ProvisionAgreementRefType
5269
5270 Attributes:
5271 agencyID, id, version?, local?, class?, package?
5272
5273 Content:
5274 {Empty}
5275
5276 Attribute Documentation:
5277
5278 |**Name**|**Type**|**Documentation**
5279 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
5280 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
5281 |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.
5282 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
5283 |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.
5284 |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.
5285
5286 **ProcessReferenceType: **ProcessReferenceType is a type for referencing a process object. It consists of a URN and/or a complete set of reference fields.
5287
5288 Derivation:
5289
5290 * //ReferenceType// (restriction)
5291 ** //MaintainableReferenceBaseType// (restriction)
5292 *** ProcessReferenceType
5293
5294 Content:
5295 ( (Ref, URN?) | URN)
5296
5297 Element Documentation:
5298
5299 |**Name**|**Type**|**Documentation**
5300 |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.
5301 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5302 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5303
5304 **ProcessRefType: **ProcessRefType contains a set of reference fields for a process.
5305
5306 Derivation:
5307
5308 * //RefBaseType// (restriction)
5309 ** //MaintainableRefBaseType// (restriction)
5310 *** ProcessRefType
5311
5312 Attributes:
5313 agencyID, id, version?, local?, class?, package?
5314
5315 Content:
5316 {Empty}
5317
5318 Attribute Documentation:
5319
5320 |**Name**|**Type**|**Documentation**
5321 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
5322 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
5323 |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.
5324 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
5325 |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.
5326 |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.
5327
5328 **ProcessStepReferenceType: **ProcessStepReferenceType is a type for referencing a process step object. It consists of a URN and/or a complete set of reference fields.
5329
5330 Derivation:
5331
5332 * //ReferenceType// (restriction)
5333 ** //ChildObjectReferenceType// (restriction)
5334 *** ProcessStepReferenceType
5335
5336 Content:
5337 ( (Ref, URN?) | URN)
5338
5339 Element Documentation:
5340
5341 |**Name**|**Type**|**Documentation**
5342 |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.
5343 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5344 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5345
5346 **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.
5347
5348 Derivation:
5349
5350 * //RefBaseType// (restriction)
5351 ** //ChildObjectRefBaseType// (restriction)
5352 *** ProcessStepRefType
5353
5354 Attributes:
5355 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
5356
5357 Content:
5358 {Empty}
5359
5360 Attribute Documentation:
5361
5362 |**Name**|**Type**|**Documentation**
5363 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
5364 |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.
5365 |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.
5366 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
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: 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.
5369 |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.
5370
5371 **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).
5372
5373 Derivation:
5374
5375 * //ReferenceType// (restriction)
5376 ** //LocalIdentifiableReferenceType// (restriction)
5377 *** LocalProcessStepReferenceType
5378
5379 Content:
5380 Ref
5381
5382 Element Documentation:
5383
5384 |**Name**|**Type**|**Documentation**
5385 |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.
5386
5387 **LocalProcessStepRefType: **LocalProcessStepRefType contains a local reference to a process step object.
5388
5389 Derivation:
5390
5391 * //RefBaseType// (restriction)
5392 ** //LocalIdentifiableRefBaseType// (restriction)
5393 *** LocalProcessStepRefType
5394
5395 Attributes:
5396 containerID?, id, local?, class?, package?
5397
5398 Content:
5399 {Empty}
5400
5401 Attribute Documentation:
5402
5403 |**Name**|**Type**|**Documentation**
5404 |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.
5405 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
5406 |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.
5407 |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.
5408 |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.
5409
5410 **TransitionReferenceType: **TransiationReferenceType is a type for referencing a process step object. It consists of a URN and/or a complete set of reference fields.
5411
5412 Derivation:
5413
5414 * //ReferenceType// (restriction)
5415 ** //ContainerChildObjectReferenceType// (restriction)
5416 *** TransitionReferenceType
5417
5418 Content:
5419 ( (Ref, URN?) | URN)
5420
5421 Element Documentation:
5422
5423 |**Name**|**Type**|**Documentation**
5424 |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.
5425 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5426 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5427
5428 **TransitionRefType: **TransitionRefType provides for a reference to a transition definition in process step through its id.
5429
5430 Derivation:
5431
5432 * //RefBaseType// (restriction)
5433 ** //ContainerChildObjectRefBaseType// (restriction)
5434 *** TransitionRefType
5435
5436 Attributes:
5437 agencyID, maintainableParentID, maintainableParentVersion?, containerID, id, version?, local?, class?, package?
5438
5439 Content:
5440 {Empty}
5441
5442 Attribute Documentation:
5443
5444 |**Name**|**Type**|**Documentation**
5445 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
5446 |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.
5447 |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.
5448 |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.
5449 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
5450 |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.
5451 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
5452 |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.
5453 |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.
5454
5455 **StructureSetReferenceType: **StructureSetReferenceType is a type for referencing a structure set object. It consists of a URN and/or a complete set of reference fields.
5456
5457 Derivation:
5458
5459 * //ReferenceType// (restriction)
5460 ** //MaintainableReferenceBaseType// (restriction)
5461 *** StructureSetReferenceType
5462
5463 Content:
5464 ( (Ref, URN?) | URN)
5465
5466 Element Documentation:
5467
5468 |**Name**|**Type**|**Documentation**
5469 |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.
5470 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5471 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5472
5473 **StructureSetRefType: **StructureSetRefType contains a set of reference fields for a structure set.
5474
5475 Derivation:
5476
5477 * //RefBaseType// (restriction)
5478 ** //MaintainableRefBaseType// (restriction)
5479 *** StructureSetRefType
5480
5481 Attributes:
5482 agencyID, id, version?, local?, class?, package?
5483
5484 Content:
5485 {Empty}
5486
5487 Attribute Documentation:
5488
5489 |**Name**|**Type**|**Documentation**
5490 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
5491 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
5492 |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.
5493 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
5494 |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.
5495 |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.
5496
5497 **StructureMapReferenceType: **StructureMapReferenceType is a type for referencing a structure map object. It consists of a URN and/or a complete set of reference fields.
5498
5499 Derivation:
5500
5501 * //ReferenceType// (restriction)
5502 ** //ChildObjectReferenceType// (restriction)
5503 *** StructureMapReferenceType
5504
5505 Content:
5506 ( (Ref, URN?) | URN)
5507
5508 Element Documentation:
5509
5510 |**Name**|**Type**|**Documentation**
5511 |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.
5512 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5513 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5514
5515 **StructureMapRefType: **StructureMapRefType contains fields for referencing a structure map within a structure set.
5516
5517 Derivation:
5518
5519 * //RefBaseType// (restriction)
5520 ** //ChildObjectRefBaseType// (restriction)
5521 *** StructureMapRefType
5522
5523 Attributes:
5524 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
5525
5526 Content:
5527 {Empty}
5528
5529 Attribute Documentation:
5530
5531 |**Name**|**Type**|**Documentation**
5532 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
5533 |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.
5534 |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.
5535 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
5536 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
5537 |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.
5538 |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.
5539
5540 **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.
5541
5542 Derivation:
5543
5544 * //ReferenceType// (restriction)
5545 ** //ChildObjectReferenceType// (restriction)
5546 *** CategorySchemeMapReferenceType
5547
5548 Content:
5549 ( (Ref, URN?) | URN)
5550
5551 Element Documentation:
5552
5553 |**Name**|**Type**|**Documentation**
5554 |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.
5555 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5556 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5557
5558 **CategorySchemeMapRefType: **CategorySchemeMapRefType contains a set of reference fields for a category scheme map.
5559
5560 Derivation:
5561
5562 * //RefBaseType// (restriction)
5563 ** //ChildObjectRefBaseType// (restriction)
5564 *** CategorySchemeMapRefType
5565
5566 Attributes:
5567 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
5568
5569 Content:
5570 {Empty}
5571
5572 Attribute Documentation:
5573
5574 |**Name**|**Type**|**Documentation**
5575 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
5576 |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.
5577 |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.
5578 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
5579 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
5580 |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.
5581 |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.
5582
5583 **CodelistMapReferenceType: **CodelistMapReferenceType is a type for referencing a codelist map object. It consists of a URN and/or a complete set of reference fields.
5584
5585 Derivation:
5586
5587 * //ReferenceType// (restriction)
5588 ** //ChildObjectReferenceType// (restriction)
5589 *** CodelistMapReferenceType
5590
5591 Content:
5592 ( (Ref, URN?) | URN)
5593
5594 Element Documentation:
5595
5596 |**Name**|**Type**|**Documentation**
5597 |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.
5598 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5599 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5600
5601 **CodelistMapRefType: **CodelistMapRefType contains a set of reference fields for a codelist map.
5602
5603 Derivation:
5604
5605 * //RefBaseType// (restriction)
5606 ** //ChildObjectRefBaseType// (restriction)
5607 *** CodelistMapRefType
5608
5609 Attributes:
5610 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
5611
5612 Content:
5613 {Empty}
5614
5615 Attribute Documentation:
5616
5617 |**Name**|**Type**|**Documentation**
5618 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
5619 |maintainableParentID|IDType|The maintainableParentID attribute identifies the maintainable object in which the referenced object is defined, if applicable (maintainable-parent-object-id in the URN structure). This is only used in references where the referenced object is not itself maintainable.
5620 |maintainableParentVersion (default: 1.0)|VersionType|The maintainableParentVersion attribute identifies the version of the maintainable object in which the referenced object is defined (maintainable-parent-object-version in the URN structure). This is only used in references where the referenced object is not itself maintainable. This should only be used when the maintainableParentID is present. If this is available, a default of 1.0 will always apply.
5621 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
5622 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
5623 |class (fixed: 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.
5624 |package (fixed: mapping)|PackageTypeCodelistT ype|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
5625
5626 **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).
5627
5628 Derivation:
5629
5630 * //ReferenceType// (restriction)
5631 ** LocalCodelistMapReferenceType
5632
5633 Content:
5634 Ref
5635
5636 Element Documentation:
5637
5638 |**Name**|**Type**|**Documentation**
5639 |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.
5640
5641 **LocalCodelistMapRefType: **LocalCodelistMapRefType contains a set of reference fields for a codelist map locally.
5642
5643 Derivation:
5644
5645 * //RefBaseType// (restriction)
5646 ** //LocalIdentifiableRefBaseType// (restriction)
5647 *** LocalCodelistMapRefType
5648
5649 Attributes:
5650 id, local?, class?, package?
5651
5652 Content:
5653 {Empty}
5654
5655 Attribute Documentation:
5656
5657 |**Name**|**Type**|**Documentation**
5658 |id|NestedIDType|The id attribute identifies the object being referenced, and is therefore always required.
5659 |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.
5660 |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.
5661 |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.
5662
5663 **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.
5664
5665 Derivation:
5666
5667 * //ReferenceType// (restriction)
5668 ** //ChildObjectReferenceType// (restriction)
5669 *** ConceptSchemeMapReferenceType
5670
5671 Content:
5672 ( (Ref, URN?) | URN)
5673
5674 Element Documentation:
5675
5676 |**Name**|**Type**|**Documentation**
5677 |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.
5678 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5679 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5680
5681 **ConceptSchemeMapRefType: **ConceptSchemeMapRefType contains a set of reference fields for a concept scheme map.
5682
5683 Derivation:
5684
5685 * //RefBaseType// (restriction)
5686 ** //ChildObjectRefBaseType// (restriction)
5687 *** ConceptSchemeMapRefType
5688
5689 Attributes:
5690 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
5691
5692 Content:
5693 {Empty}
5694
5695 Attribute Documentation:
5696
5697 |**Name**|**Type**|**Documentation**
5698 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
5699 |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.
5700 |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.
5701 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
5702 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
5703 |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.
5704 |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.
5705
5706 **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.
5707
5708 Derivation:
5709
5710 * //ReferenceType// (restriction)
5711 ** //ChildObjectReferenceType// (restriction)
5712 *** OrganisationSchemeMapReferenceType
5713
5714 Content:
5715 ( (Ref, URN?) | URN)
5716
5717 Element Documentation:
5718
5719 |**Name**|**Type**|**Documentation**
5720 |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.
5721 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5722 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5723
5724 **OrganisationSchemeMapRefType: **OrganisationSchemeMapRefType contains a set of reference fields for an organisation scheme map.
5725
5726 Derivation:
5727
5728 * //RefBaseType// (restriction)
5729 ** //ChildObjectRefBaseType// (restriction)
5730 *** OrganisationSchemeMapRefType
5731
5732 Attributes:
5733 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
5734
5735 Content:
5736 {Empty}
5737
5738 Attribute Documentation:
5739
5740 |**Name**|**Type**|**Documentation**
5741 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
5742 |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.
5743 |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.
5744 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
5745 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
5746 |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.
5747 |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.
5748
5749 **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.
5750
5751 Derivation:
5752
5753 * //ReferenceType// (restriction)
5754 ** //MaintainableReferenceBaseType// (restriction)
5755 *** //ItemSchemeReferenceBaseType// (restriction)
5756 **** VtlMappingSchemeReferenceType
5757
5758 Content:
5759 ( (Ref, URN?) | URN)
5760
5761 Element Documentation:
5762
5763 |**Name**|**Type**|**Documentation**
5764 |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.
5765 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5766 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5767
5768 **VtlMappingSchemeRefType: **VtlMappingSchemeRefType provides a reference to a VTL mapping scheme via a complete set of reference fields.
5769
5770 Derivation:
5771
5772 * //RefBaseType// (restriction)
5773 ** //MaintainableRefBaseType// (restriction)
5774 *** //ItemSchemeRefBaseType// (restriction)
5775 **** VtlMappingSchemeRefType
5776
5777 Attributes:
5778 agencyID, id, version?, local?, class?, package?
5779
5780 Content:
5781 {Empty}
5782
5783 Attribute Documentation:
5784
5785 |**Name**|**Type**|**Documentation**
5786 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
5787 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
5788 |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.
5789 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
5790 |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.
5791 |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.
5792
5793 **VtlMappingReferenceType: **VtlMappingReferenceType is a type for referencing a VTL mapping object. It consists of a URN and/or a complete set of reference fields.
5794
5795 Derivation:
5796
5797 * //ReferenceType// (restriction)
5798 ** //ChildObjectReferenceType// (restriction)
5799 *** //ItemReferenceType// (restriction)
5800 **** VtlMappingReferenceType
5801
5802 Content:
5803 ( (Ref, URN?) | URN)
5804
5805 Element Documentation:
5806
5807 |**Name**|**Type**|**Documentation**
5808 |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.
5809 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5810 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5811
5812 **VtlMappingRefType: **VtlMappingRefType references a VTL mapping from within a VTL mapping scheme. Reference fields are required for both the scheme and the item.
5813
5814 Derivation:
5815
5816 * //RefBaseType// (restriction)
5817 ** //ChildObjectRefBaseType// (restriction)
5818 *** //ItemRefBaseType// (restriction)
5819 **** VtlMappingRefType
5820
5821 Attributes:
5822 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
5823
5824 Content:
5825 {Empty}
5826
5827 Attribute Documentation:
5828
5829 |**Name**|**Type**|**Documentation**
5830 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
5831 |maintainableParentID|IDType|The maintainableParentID references the VTL mapping scheme in which the VTL mapping being referenced is defined.
5832 |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.
5833 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
5834 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
5835 |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.
5836 |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.
5837
5838 **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.
5839
5840 Derivation:
5841
5842 * //ReferenceType// (restriction)
5843 ** //LocalItemReferenceType// (restriction)
5844 *** LocalVtlMappingReferenceType
5845
5846 Content:
5847 Ref
5848
5849 Element Documentation:
5850
5851 |**Name**|**Type**|**Documentation**
5852 |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.
5853
5854 **LocalVtlMappingRefType: **LocalVtlMappingRefType references a VTL mapping locally where the references to the VTL mapping scheme which defines it is provided elsewhere.
5855
5856 Derivation:
5857
5858 * //RefBaseType// (restriction)
5859 ** //LocalIdentifiableRefBaseType// (restriction)
5860 *** //LocalItemRefBaseType// (restriction)
5861 **** LocalVtlMappingRefType
5862
5863 Attributes:
5864 id, local?, class?, package?
5865
5866 Content:
5867 {Empty}
5868
5869 Attribute Documentation:
5870
5871 |**Name**|**Type**|**Documentation**
5872 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
5873 |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.
5874 |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.
5875 |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.
5876
5877 **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.
5878
5879 Derivation:
5880
5881 * //ReferenceType// (restriction)
5882 ** //MaintainableReferenceBaseType// (restriction)
5883 *** //ItemSchemeReferenceBaseType// (restriction)
5884 **** NamePersonalisationSchemeReferenceType
5885
5886 Content:
5887 ( (Ref, URN?) | URN)
5888
5889 Element Documentation:
5890
5891 |**Name**|**Type**|**Documentation**
5892 |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.
5893 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5894 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5895
5896 **NamePersonalisationSchemeRefType: **NamePersonalisationSchemeRefType provides a reference to a name personalisation scheme via a complete set of reference fields.
5897
5898 Derivation:
5899
5900 * //RefBaseType// (restriction)
5901 ** //MaintainableRefBaseType// (restriction)
5902 *** //ItemSchemeRefBaseType// (restriction)
5903 **** NamePersonalisationSchemeRefType
5904
5905 Attributes:
5906 agencyID, id, version?, local?, class?, package?
5907
5908 Content:
5909 {Empty}
5910
5911 Attribute Documentation:
5912
5913 |**Name**|**Type**|**Documentation**
5914 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
5915 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
5916 |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.
5917 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
5918 |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.
5919 |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.
5920
5921 **NamePersonalisationReferenceType: **NamePersonalisationReferenceType is a type for referencing a name personalisation object. It consists of a URN and/or a complete set of reference fields.
5922
5923 Derivation:
5924
5925 * //ReferenceType// (restriction)
5926 ** //ChildObjectReferenceType// (restriction)
5927 *** //ItemReferenceType// (restriction)
5928 **** NamePersonalisationReferenceType
5929
5930 Content:
5931 ( (Ref, URN?) | URN)
5932
5933 Element Documentation:
5934
5935 |**Name**|**Type**|**Documentation**
5936 |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.
5937 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5938 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
5939
5940 **NamePersonalisationRefType: **NamePersonalisationRefType references a name personalisation from within a name personalisation scheme. Reference fields are required for both the scheme and the item.
5941
5942 Derivation:
5943
5944 * //RefBaseType// (restriction)
5945 ** //ChildObjectRefBaseType// (restriction)
5946 *** //ItemRefBaseType// (restriction)
5947 **** NamePersonalisationRefType
5948
5949 Attributes:
5950 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
5951
5952 Content:
5953 {Empty}
5954
5955 Attribute Documentation:
5956
5957 |**Name**|**Type**|**Documentation**
5958 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
5959 |maintainableParentID|IDType|The maintainableParentID references the name personalisation scheme in which the name personalisation being referenced is defined.
5960 |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.
5961 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
5962 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
5963 |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.
5964 |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.
5965
5966 **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.
5967
5968 Derivation:
5969
5970 * //ReferenceType// (restriction)
5971 ** //LocalItemReferenceType// (restriction)
5972 *** LocalNamePersonalisationReferenceType
5973
5974 Content:
5975 Ref
5976
5977 Element Documentation:
5978
5979 |**Name**|**Type**|**Documentation**
5980 |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.
5981
5982 **LocalNamePersonalisationRefType: **LocalNamePersonalisationRefType references a name personalisation locally where the references to the name personalisation scheme which defines it is provided elsewhere.
5983
5984 Derivation:
5985
5986 * //RefBaseType// (restriction)
5987 ** //LocalIdentifiableRefBaseType// (restriction)
5988 *** //LocalItemRefBaseType// (restriction)
5989 **** LocalNamePersonalisationRefType
5990
5991 Attributes:
5992 id, local?, class?, package?
5993
5994 Content:
5995 {Empty}
5996
5997 Attribute Documentation:
5998
5999 |**Name**|**Type**|**Documentation**
6000 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
6001 |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.
6002 |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.
6003 |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.
6004
6005 **RulesetSchemeReferenceType: **RulesetSchemeReferenceType is a type for referencing a ruleset scheme object. It consists of a URN and/or a complete set of reference fields.
6006
6007 Derivation:
6008
6009 * //ReferenceType// (restriction)
6010 ** //MaintainableReferenceBaseType// (restriction)
6011 *** //ItemSchemeReferenceBaseType// (restriction)
6012 **** RulesetSchemeReferenceType
6013
6014 Content:
6015 ( (Ref, URN?) | URN)
6016
6017 Element Documentation:
6018
6019 |**Name**|**Type**|**Documentation**
6020 |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.
6021 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
6022 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
6023
6024 **RulesetSchemeRefType: **RulesetSchemeRefType provides a reference to a ruleset scheme via a complete set of reference fields.
6025
6026 Derivation:
6027
6028 * //RefBaseType// (restriction)
6029 ** //MaintainableRefBaseType// (restriction)
6030 *** //ItemSchemeRefBaseType// (restriction)
6031 **** RulesetSchemeRefType
6032
6033 Attributes:
6034 agencyID, id, version?, local?, class?, package?
6035
6036 Content:
6037 {Empty}
6038
6039 Attribute Documentation:
6040
6041 |**Name**|**Type**|**Documentation**
6042 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
6043 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
6044 |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.
6045 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
6046 |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.
6047 |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.
6048
6049 **RulesetReferenceType: **RulesetReferenceType is a type for referencing a ruleset object. It consists of a URN and/or a complete set of reference fields.
6050
6051 Derivation:
6052
6053 * //ReferenceType// (restriction)
6054 ** //ChildObjectReferenceType// (restriction)
6055 *** //ItemReferenceType// (restriction)
6056 **** RulesetReferenceType
6057
6058 Content:
6059 ( (Ref, URN?) | URN)
6060
6061 Element Documentation:
6062
6063 |**Name**|**Type**|**Documentation**
6064 |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.
6065 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
6066 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
6067
6068 **RulesetRefType: **RulesetRefType references a rule set from within an rule set scheme. Reference fields are required for both the scheme and the item.
6069
6070 Derivation:
6071
6072 * //RefBaseType// (restriction)
6073 ** //ChildObjectRefBaseType// (restriction)
6074 *** //ItemRefBaseType// (restriction)
6075 **** RulesetRefType
6076
6077 Attributes:
6078 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
6079
6080 Content:
6081 {Empty}
6082
6083 Attribute Documentation:
6084
6085 |**Name**|**Type**|**Documentation**
6086 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
6087 |maintainableParentID|IDType|The maintainableParentID references the ruleset scheme in which the concept being referenced is defined.
6088 |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.
6089 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
6090 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
6091 |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.
6092 |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.
6093
6094 **LocalRulesetReferenceType: **LocalRulesetReferenceType provides a simple reference to a ruleset where the identification of the ruleset scheme which defines it is contained in another context.
6095
6096 Derivation:
6097
6098 * //ReferenceType// (restriction)
6099 ** //LocalItemReferenceType// (restriction)
6100 *** LocalRulesetReferenceType
6101
6102 Content:
6103 Ref
6104
6105 Element Documentation:
6106
6107 |**Name**|**Type**|**Documentation**
6108 |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.
6109
6110 **LocalRulesetRefType: **LocalRulesetRefType references a ruleset locally where the references to the ruleset scheme which defines it is provided elsewhere.
6111
6112 Derivation:
6113
6114 * //RefBaseType// (restriction)
6115 ** //LocalIdentifiableRefBaseType// (restriction)
6116 *** //LocalItemRefBaseType// (restriction)
6117 **** LocalRulesetRefType
6118
6119 Attributes:
6120 id, local?, class?, package?
6121
6122 Content:
6123 {Empty}
6124
6125 Attribute Documentation:
6126
6127 |**Name**|**Type**|**Documentation**
6128 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
6129 |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.
6130 |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.
6131 |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.
6132
6133 **TransformationSchemeReferenceType: **TransformationSchemeReferenceType is a type for referencing a transformation scheme object. It consists of a URN and/or a complete set of reference fields.
6134
6135 Derivation:
6136
6137 * //ReferenceType// (restriction)
6138 ** //MaintainableReferenceBaseType// (restriction)
6139 *** //ItemSchemeReferenceBaseType// (restriction)
6140 **** TransformationSchemeReferenceType
6141
6142 Content:
6143 ( (Ref, URN?) | URN)
6144
6145 Element Documentation:
6146
6147 |**Name**|**Type**|**Documentation**
6148 |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.
6149 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
6150 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
6151
6152 **TransformationSchemeRefType: **TransformationSchemeRefType provides a reference to a transformation scheme via a complete set of reference fields.
6153
6154 Derivation:
6155
6156 * //RefBaseType// (restriction)
6157 ** //MaintainableRefBaseType// (restriction)
6158 *** //ItemSchemeRefBaseType// (restriction)
6159 **** TransformationSchemeRefType
6160
6161 Attributes:
6162 agencyID, id, version?, local?, class?, package?
6163
6164 Content:
6165 {Empty}
6166
6167 Attribute Documentation:
6168
6169 |**Name**|**Type**|**Documentation**
6170 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
6171 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
6172 |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.
6173 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
6174 |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.
6175 |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.
6176
6177 **TransformationReferenceType: **TransformationReferenceType is a type for referencing a transformation object. It consists of a URN and/or a complete set of reference fields.
6178
6179 Derivation:
6180
6181 * //ReferenceType// (restriction)
6182 ** //ChildObjectReferenceType// (restriction)
6183 *** //ItemReferenceType// (restriction)
6184 **** TransformationReferenceType
6185
6186 Content:
6187 ( (Ref, URN?) | URN)
6188
6189 Element Documentation:
6190
6191 |**Name**|**Type**|**Documentation**
6192 |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.
6193 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
6194 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
6195
6196 **TransformationRefType: **TransformationRefType references a transformation from within a transformation scheme. Reference fields are required for both the scheme and the item.
6197
6198 Derivation:
6199
6200 * //RefBaseType// (restriction)
6201 ** //ChildObjectRefBaseType// (restriction)
6202 *** //ItemRefBaseType// (restriction)
6203 **** TransformationRefType
6204
6205 Attributes:
6206 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
6207
6208 Content:
6209 {Empty}
6210
6211 Attribute Documentation:
6212
6213 |**Name**|**Type**|**Documentation**
6214 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
6215 |maintainableParentID|IDType|The maintainableParentID references the transformation scheme in which the transformation being referenced is defined.
6216 |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.
6217 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
6218 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
6219 |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.
6220 |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.
6221
6222 **LocalTransformationReferenceType: **LocalTransformationReferenceType provides a simple references to a transformation where the identification of the transformation scheme which defines it is contained in another context.
6223
6224 Derivation:
6225
6226 * //ReferenceType// (restriction)
6227 ** //LocalItemReferenceType// (restriction)
6228 *** LocalTransformationReferenceType
6229
6230 Content:
6231 Ref
6232
6233 Element Documentation:
6234
6235 |**Name**|**Type**|**Documentation**
6236 |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.
6237
6238 **LocalTransformationRefType: **LocalTransformationRefType references a transformation locally where the references to the transformation scheme which defines it is provided elsewhere.
6239
6240 Derivation:
6241
6242 * //RefBaseType// (restriction)
6243 ** //LocalIdentifiableRefBaseType// (restriction)
6244 *** //LocalItemRefBaseType// (restriction)
6245 **** LocalTransformationRefType
6246
6247 Attributes:
6248 id, local?, class?, package?
6249
6250 Content:
6251 {Empty}
6252
6253 Attribute Documentation:
6254
6255 |**Name**|**Type**|**Documentation**
6256 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
6257 |local (fixed: true)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
6258 |class (fixed: 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.
6259 |package (fixed: transformation)|ItemSchemePackageTyp eCodelistType|The package attribute indicates the package name for the object being referenced. This attribute allows any reference to be processed generically from this definition. References derived from this should fix the value of this attribute to indicate the type of object that is being referenced, or in the case that a reference which allows specific types of fields, the representation should be sub-setted to the appropriate values.
6260
6261 **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.
6262
6263 Derivation:
6264
6265 * //ReferenceType// (restriction)
6266 ** //MaintainableReferenceBaseType// (restriction)
6267 *** //ItemSchemeReferenceBaseType// (restriction)
6268 **** UserDefinedOperatorSchemeReferenceType
6269
6270 Content:
6271 ( (Ref, URN?) | URN)
6272
6273 Element Documentation:
6274
6275 |**Name**|**Type**|**Documentation**
6276 |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.
6277 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
6278 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
6279
6280 **UserDefinedOperatorSchemeRefType: **UserDefinedOperatorSchemeRefType provides a reference to a user defined operator scheme via a complete set of reference fields.
6281
6282 Derivation:
6283
6284 * //RefBaseType// (restriction)
6285 ** //MaintainableRefBaseType// (restriction)
6286 *** //ItemSchemeRefBaseType// (restriction)
6287 **** UserDefinedOperatorSchemeRefType
6288
6289 Attributes:
6290 agencyID, id, version?, local?, class?, package?
6291
6292 Content:
6293 {Empty}
6294
6295 Attribute Documentation:
6296
6297 |**Name**|**Type**|**Documentation**
6298 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
6299 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
6300 |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.
6301 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
6302 |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.
6303 |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.
6304
6305 **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.
6306
6307 Derivation:
6308
6309 * //ReferenceType// (restriction)
6310 ** //ChildObjectReferenceType// (restriction)
6311 *** //ItemReferenceType// (restriction)
6312 **** UserDefinedOperatorReferenceType
6313
6314 Content:
6315 ( (Ref, URN?) | URN)
6316
6317 Element Documentation:
6318
6319 |**Name**|**Type**|**Documentation**
6320 |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.
6321 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
6322 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
6323
6324 **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.
6325
6326 Derivation:
6327
6328 * //RefBaseType// (restriction)
6329 ** //ChildObjectRefBaseType// (restriction)
6330 *** //ItemRefBaseType// (restriction)
6331 **** UserDefinedOperatorRefType
6332
6333 Attributes:
6334 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
6335
6336 Content:
6337 {Empty}
6338
6339 Attribute Documentation:
6340
6341 |**Name**|**Type**|**Documentation**
6342 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
6343 |maintainableParentID|IDType|The maintainableParentID references the user defined operator scheme in which the user defined operator being referenced is defined.
6344 |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.
6345 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
6346 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
6347 |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.
6348 |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.
6349
6350 **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.
6351
6352 Derivation:
6353
6354 * //ReferenceType// (restriction)
6355 ** //LocalItemReferenceType// (restriction)
6356 *** LocalUserDefinedOperatorReferenceType
6357
6358 Content:
6359 Ref
6360
6361 Element Documentation:
6362
6363 |**Name**|**Type**|**Documentation**
6364 |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.
6365
6366 **LocalUserDefinedOperatorRefType: **LocalUserDefinedOperatorRefType references a user defined operator locally where the references to the user defined operator scheme which defines it is provided elsewhere.
6367
6368 Derivation:
6369
6370 * //RefBaseType// (restriction)
6371 ** //LocalIdentifiableRefBaseType// (restriction)
6372 *** //LocalItemRefBaseType// (restriction)
6373 **** LocalUserDefinedOperatorRefType
6374
6375 Attributes:
6376 id, local?, class?, package?
6377
6378 Content:
6379 {Empty}
6380
6381 Attribute Documentation:
6382
6383 |**Name**|**Type**|**Documentation**
6384 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
6385 |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.
6386 |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.
6387 |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.
6388
6389 **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.
6390
6391 Derivation:
6392
6393 * //ReferenceType// (restriction)
6394 ** //MaintainableReferenceBaseType// (restriction)
6395 *** //ItemSchemeReferenceBaseType// (restriction)
6396 **** CustomTypeSchemeReferenceType
6397
6398 Content:
6399 ( (Ref, URN?) | URN)
6400
6401 Element Documentation:
6402
6403 |**Name**|**Type**|**Documentation**
6404 |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.
6405 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
6406 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
6407
6408 **CustomTypeSchemeRefType: **CustomTypeSchemeRefType provides a reference to a custom type scheme via a complete set of reference fields.
6409
6410 Derivation:
6411
6412 * //RefBaseType// (restriction)
6413 ** //MaintainableRefBaseType// (restriction)
6414 *** //ItemSchemeRefBaseType// (restriction)
6415 **** CustomTypeSchemeRefType
6416
6417 Attributes:
6418 agencyID, id, version?, local?, class?, package?
6419
6420 Content:
6421 {Empty}
6422
6423 Attribute Documentation:
6424
6425 |**Name**|**Type**|**Documentation**
6426 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
6427 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
6428 |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.
6429 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
6430 |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.
6431 |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.
6432
6433 **CustomTypeReferenceType: **CustomTypeReferenceType is a type for referencing a custom type object. It consists of a URN and/or a complete set of reference fields.
6434
6435 Derivation:
6436
6437 * //ReferenceType// (restriction)
6438 ** //ChildObjectReferenceType// (restriction)
6439 *** //ItemReferenceType// (restriction)
6440 **** CustomTypeReferenceType
6441
6442 Content:
6443 ( (Ref, URN?) | URN)
6444
6445 Element Documentation:
6446
6447 |**Name**|**Type**|**Documentation**
6448 |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.
6449 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
6450 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
6451
6452 **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.
6453
6454 Derivation:
6455
6456 * //RefBaseType// (restriction)
6457 ** //ChildObjectRefBaseType// (restriction)
6458 *** //ItemRefBaseType// (restriction)
6459 **** CustomTypeRefType
6460
6461 Attributes:
6462 agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?
6463
6464 Content:
6465 {Empty}
6466
6467 Attribute Documentation:
6468
6469 |**Name**|**Type**|**Documentation**
6470 |agencyID|NestedNCNameIDType|The agencyID attribute identifies the maintenance agency for the object being referenced (agency-id in the URN structure). This is optional to allow for local references (where the other reference fields are inferred from another context), but all complete references will require this.
6471 |maintainableParentID|IDType|The maintainableParentID references the custom mask scheme in which the custom type being referenced is defined.
6472 |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.
6473 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
6474 |local (fixed: false)|xs:boolean|The local attribute indicates whether this set of reference fields is meant for local referencing, in which case some of the reference fields will be implied from another context. Concrete instances of this class will always fix this value to either true or false, depending on their intended usage. If the value is fixed to true, then the complete set of reference fields will be required and a URN can be fully composed from the values.
6475 |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.
6476 |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.
6477
6478 **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.
6479
6480 Derivation:
6481
6482 * //ReferenceType// (restriction)
6483 ** //LocalItemReferenceType// (restriction)
6484 *** LocalCustomTypeReferenceType
6485
6486 Content:
6487 Ref
6488
6489 Element Documentation:
6490
6491 |**Name**|**Type**|**Documentation**
6492 |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.
6493
6494 **LocalCustomTypeRefType: **LocalCustomTypeRefType references a custom type locally where the references to the custom type scheme which defines it is provided elsewhere.
6495
6496 Derivation:
6497
6498 * //RefBaseType// (restriction)
6499 ** //LocalIdentifiableRefBaseType// (restriction)
6500 *** //LocalItemRefBaseType// (restriction)
6501 **** LocalCustomTypeRefType
6502
6503 Attributes:
6504 id, local?, class?, package?
6505
6506 Content:
6507 {Empty}
6508
6509 Attribute Documentation:
6510
6511 |**Name**|**Type**|**Documentation**
6512 |id|IDType|The id attribute identifies the object being referenced, and is therefore always required.
6513 |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.
6514 |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.
6515 |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.
6516
6517 **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.
6518
6519 Content:
6520 DataProvider, ID
6521
6522 Element Documentation:
6523
6524 |**Name**|**Type**|**Documentation**
6525 |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.
6526 |ID|IDType|ID contains the identifier of the data/metadata set being referenced.
6527
6528 **ObjectTypeListType: **ObjectTypeListType provides a means for enumerating object types.
6529
6530 Content:
6531 (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?)
6532
6533 Element Documentation:
6534
6535 |**Name**|**Type**|**Documentation**
6536 |Any|EmptyType|Any is an empty element that denotes an object of any type.
6537 |Agency|EmptyType|Agency is an empty element that denotes an agency object.
6538 |AgencyScheme|EmptyType|AgencyScheme is an empty element that denotes an agency scheme object.
6539 |AttachmentConstraint|EmptyType|AttachmentConstraint is an empty element that denotes an attachment constraint object.
6540 |Attribute|EmptyType|Attribute is an empty element that denotes an attribute object.
6541 |AttributeDescriptor|EmptyType|AttributeDescriptor is an empty element that denotes an attribute descriptor object.
6542 |Categorisation|EmptyType|Categorisation is an empty element that denotes a categorisation object.
6543 |Category|EmptyType|Category is an empty element that denotes a category object.
6544 |CategorySchemeMap|EmptyType|CategorySchemeMap is an empty element that denotes a category scheme map object.
6545 |CategoryScheme|EmptyType|CategoryScheme is an empty element that denotes a category scheme object.
6546 |Code|EmptyType|Code is an empty element that denotes a code object.
6547 |CodeMap|EmptyType|CodeMap is an empty element that denotes a code map object.
6548 |Codelist|EmptyType|Codelist is an empty element that denotes a code list object.
6549 |CodelistMap|EmptyType|CodelistMap is an empty element that denotes a code list map object.
6550 |ComponentMap|EmptyType|ComponentMap is an empty element that denotes a component map object.
6551 |Concept|EmptyType|Concept is an empty element that denotes a concept object.
6552 |ConceptMap|EmptyType|ConceptMap is an empty element that denotes a concept map object.
6553 |ConceptScheme|EmptyType|ConceptScheme is an empty element that denotes a concept scheme object.
6554 |ConceptSchemeMap|EmptyType|ConceptSchemeMap is an empty element that denotes a concept scheme map object.
6555 |ContentConstraint|EmptyType|ContentConstraint is an empty element that denotes a content constraint object.
6556 |CustomType|EmptyType|CustomType is an empty element that denotes a custom type object.
6557 |CustomTypeScheme|EmptyType|CustomTypeScheme is an empty element that denotes a custom type scheme object.
6558 |Dataflow|EmptyType|Dataflow is an empty element that denotes a data flow object.
6559 |DataConsumer|EmptyType|DataConsumer is an empty element that denotes a data consumer object.
6560 |DataConsumerScheme|EmptyType|DataConsumerScheme is an empty element that denotes a data consumer scheme object.
6561 |DataProvider|EmptyType|DataProvider is an empty element that denotes a data provider object.
6562 |DataProviderScheme|EmptyType|DataProviderScheme is an empty element that denotes a data provider scheme object.
6563 |DataSetTarget|EmptyType|DataSetTarget is an empty element that denotes a data set target object.
6564 |DataStructure|EmptyType|DataStructure is an empty element that denotes a data structure definition object.
6565 |Dimension|EmptyType|Dimension is an empty element that denotes a dimension object.
6566 |DimensionDescriptor|EmptyType|DimensionDescriptor is an empty element that denotes a dimension descriptor object.
6567 |DimensionDescriptorV aluesTarget|EmptyType|DimensionDescriptorValuesTarget is an empty element that denotes a dimension descriptor values target object.
6568 |GroupDimensionDescri ptor|EmptyType|GroupDimensionDescriptor is an empty element that denotes a group dimension descriptor object.
6569 |HierarchicalCode|EmptyType|HierarchicalCode is an empty element that denotes a hierarchical code object.
6570 |HierarchicalCodelist|EmptyType|HierarchicalCodelist is an empty element that denotes a hierarchical codelist object.
6571 |Hierarchy|EmptyType|Hierarchy is an empty element that denotes a hierarchy within a hiearcharchical codelist.
6572 |HybridCodelistMap|EmptyType|HybridCodelistMap is an empty element that denotes a hybrid codelist map object.
6573 |HybridCodeMap|EmptyType|HybridCodeMap is an empty element that denotes a hybrid code map object.
6574 |IdentifiableObjectTa rget|EmptyType|IdentifiableObjectTarget is an empty element that denotes an identifiable object target object.
6575 |Level|EmptyType|Level is an empty element that denotes a level object.
6576 |MeasureDescriptor|EmptyType|MeasureDescriptor is an empty element that denotes a measure descriptor object.
6577 |MeasureDimension|EmptyType|MeasureDimension is an empty element that denotes a measure dimension object.
6578 |Metadataflow|EmptyType|Metadataflow is an empty element that denotes a metadata flow object.
6579 |MetadataAttribute|EmptyType|MetadataAttribute is an empty element that denotes a metadata attribute object.
6580 |MetadataSet|EmptyType|MetadataSet is an empty element that denotes a metadata set object.
6581 |MetadataStructure|EmptyType|MetadataStructure is an empty element that denotes a metadata structure definition object.
6582 |MetadataTarget|EmptyType|MetadataTarget is an empty element that denotes a metadata target object.
6583 |NamePersonalisation|EmptyType|NamePersonalisation is an empty element that denotes a name personalisation object.
6584 |NamePersonalisationS cheme|EmptyType|NamePersonalisationScheme is an empty element that denotes a name personalisation scheme object.
6585 |OrganisationMap|EmptyType|OrganisationMap is an empty element that denotes an organisation map object.
6586 |OrganisationSchemeMa p|EmptyType|OrganisationSchemeMap is an empty element that denotes an organisation scheme map object.
6587 |OrganisationUnit|EmptyType|OrganisationUnit is an empty element that denotes an organisation unit object.
6588 |OrganisationUnitSche me|EmptyType|OrganisationUnitScheme is an empty element that denotes an organisation unit scheme object.
6589 |PrimaryMeasure|EmptyType|PrimaryMeasure is an empty element that denotes a primary measure object.
6590 |Process|EmptyType|Process is an empty element that denotes a process object.
6591 |ProcessStep|EmptyType|ProcessStep is an empty element that denotes a process step object.
6592 |ProvisionAgreement|EmptyType|ProvisionAgreement is an empty element that denotes a provision agreement object.
6593 |ReportingCategory|EmptyType|ReportingCategory is an empty element that denotes a reporting category object.
6594 |ReportingCategoryMap|EmptyType|ReportingCategoryMap is an empty element that denotes a reporting category map object.
6595 |ReportingTaxonomy|EmptyType|ReportingTaxonomy is an empty element that denotes a reporting taxonomy object.
6596 |ReportingTaxonomyMap|EmptyType|ReportingTaxonomyMap is an empty element that denotes a reporting taxonomy map object.
6597 |ReportPeriodTarget|EmptyType|ReportPeriodTarget is an empty element that denotes a report period target object.
6598 |ReportStructure|EmptyType|ReportStructure is an empty element that denotes a report structure object.
6599 |Ruleset|EmptyType|Ruleset is an empty element that denotes a ruleset object.
6600 |RulesetScheme|EmptyType|RulesetScheme is an empty element that denotes a ruleset scheme object.
6601 |StructureMap|EmptyType|StructureMap is an empty element that denotes a structure map object.
6602 |StructureSet|EmptyType|StructureSet is an empty element that denotes a structure set object.
6603 |TimeDimension|EmptyType|TimeDimension is an empty element that denotes a time dimension object.
6604 |Transformation|EmptyType|Transformation is an empty element that denotes a transformation object.
6605 |TransformationScheme|EmptyType|TransformationScheme is an empty element that denotes a transformation scheme object.
6606 |Transition|EmptyType|Transition is an empty element that denotes a transition object.
6607 |UserDefinedOperator|EmptyType|UserDefinedOperator is an empty element that denotes an user defined operator object.
6608 |UserDefinedOperatorS cheme|EmptyType|UserDefinedOperatorScheme is an empty element that denotes an user defined operator scheme object.
6609 |VtlMapping|EmptyType|VtlMapping is an empty element that denotes a VTL Mapping object.
6610 |VtlMappingScheme|EmptyType|VtlMappingScheme is an empty element that denotes a VTL mapping scheme object.
6611
6612 **MaintainableObjectTypeListType: **MaintainableObjectTypeListType provides a means for enumerating maintainable object types.
6613
6614 Derivation:
6615
6616 * ObjectTypeListType (restriction)
6617 ** MaintainableObjectTypeListType
6618
6619 Content:
6620 (AgencyScheme?, AttachmentConstraint?, Categorisation?, CategoryScheme?, Codelist?, ConceptScheme?, ContentConstraint?, Dataflow?, DataConsumerScheme?, DataProviderScheme?, DataStructure?, HierarchicalCodelist?, Metadataflow?, MetadataStructure?, NamePersonalisationScheme?, OrganisationUnitScheme?, Process?, ProvisionAgreement?, ReportingTaxonomy?, RulesetScheme?, StructureSet?, TransformationScheme?, UserDefinedOperatorScheme?, VtlMappingScheme?)
6621
6622 Element Documentation:
6623
6624 |**Name**|**Type**|**Documentation**
6625 |AgencyScheme|EmptyType|AgencyScheme is an empty element that denotes an agency scheme object.
6626 |AttachmentConstraint|EmptyType|AttachmentConstraint is an empty element that denotes an attachment constraint object.
6627 |Categorisation|EmptyType|Categorisation is an empty element that denotes a categorisation object.
6628 |CategoryScheme|EmptyType|CategoryScheme is an empty element that denotes a category scheme object.
6629 |Codelist|EmptyType|Codelist is an empty element that denotes a code list object.
6630 |ConceptScheme|EmptyType|ConceptScheme is an empty element that denotes a concept scheme object.
6631 |ContentConstraint|EmptyType|ContentConstraint is an empty element that denotes a content constraint object.
6632 |Dataflow|EmptyType|Dataflow is an empty element that denotes a data flow object.
6633 |DataConsumerScheme|EmptyType|DataConsumerScheme is an empty element that denotes a data consumer scheme object.
6634 |DataProviderScheme|EmptyType|DataProviderScheme is an empty element that denotes a data provider scheme object.
6635 |DataStructure|EmptyType|DataStructure is an empty element that denotes a data structure definition object.
6636 |HierarchicalCodelist|EmptyType|HierarchicalCodelist is an empty element that denotes a hierarchical codelist object.
6637 |Metadataflow|EmptyType|Metadataflow is an empty element that denotes a metadata flow object.
6638 |MetadataStructure|EmptyType|MetadataStructure is an empty element that denotes a metadata structure definition object.
6639 |NamePersonalisationS cheme|EmptyType|NamePersonalisationScheme is an empty element that denotes a name personalisation scheme object.
6640 |OrganisationUnitSche me|EmptyType|OrganisationUnitScheme is an empty element that denotes an organisation unit scheme object.
6641 |Process|EmptyType|Process is an empty element that denotes a process object.
6642 |ProvisionAgreement|EmptyType|ProvisionAgreement is an empty element that denotes a provision agreement object.
6643 |ReportingTaxonomy|EmptyType|ReportingTaxonomy is an empty element that denotes a reporting taxonomy object.
6644 |RulesetScheme|EmptyType|RulesetScheme is an empty element that denotes a ruleset scheme object.
6645 |StructureSet|EmptyType|StructureSet is an empty element that denotes a structure set object.
6646 |TransformationScheme|EmptyType|TransformationScheme is an empty element that denotes a transformation scheme object.
6647 |UserDefinedOperatorS cheme|EmptyType|UserDefinedOperatorScheme is an empty element that denotes an user defined operator scheme object.
6648 |VtlMappingScheme|EmptyType|VtlMappingScheme is an empty element that denotes a VTL mapping scheme object.
6649
6650 === 2.1.4 Simple Types ===
6651
6652 **AlphaNumericType: **AlphaNumericType is a reusable simple type that allows for only mixed-case alphabetical and numeric characters.
6653
6654 Derived by restriction of xs:string .
6655 Regular Expression Pattern: [A-Za-z0-9]+
6656
6657 **AlphaType: **AlphaType is a reusable simple type that allows for only mixed-case alphabetical characters. This is derived from the AlphaNumericType.
6658
6659 Derived by restriction of AlphaNumericType .
6660 Regular Expression Pattern: [A-Za-z]+
6661
6662 **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.
6663
6664 Derived by restriction of AlphaNumericType .
6665 Regular Expression Pattern: [0-9]+
6666
6667 **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.
6668
6669 Union of:
6670 xs:gYear, xs:gYearMonth, xs:date, xs:dateTime, ReportingYearType, ReportingSemesterType, ReportingTrimesterType, ReportingQuarterType, ReportingMonthType, ReportingWeekType, ReportingDayType, TimeRangeType.
6671
6672 **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).
6673
6674 Union of:
6675 xs:gYear, xs:gYearMonth, xs:date, xs:dateTime, ReportingYearType, ReportingSemesterType, ReportingTrimesterType, ReportingQuarterType, ReportingMonthType, ReportingWeekType, ReportingDayType.
6676
6677 **BasicTimePeriodType: **BasicTimePeriodType contains the basic dates and calendar periods. It is a combination of the Gregorian time periods and the date time type..
6678
6679 Union of:
6680 xs:gYear, xs:gYearMonth, xs:date, xs:dateTime.
6681
6682 **GregorianTimePeriodType: **GregorianTimePeriodType defines the set of standard calendar periods in SDMX.
6683
6684 Union of:
6685 xs:gYear, xs:gYearMonth, xs:date.
6686
6687 **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.
6688
6689 Union of:
6690 ReportingYearType, ReportingSemesterType, ReportingTrimesterType, ReportingQuarterType, ReportingMonthType, ReportingWeekType, ReportingDayType.
6691
6692 **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.
6693
6694 Derived by restriction of xs:string .
6695 Regular Expression Pattern: \d{4}\-([ASTQ]\d{1}|[MW]\d{2}|[D]\d{3})(Z|((\+|\-)\d{2}:\d{2}))?
6696
6697 **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.
6698
6699 Derived by restriction of BaseReportPeriodType .
6700 Regular Expression Pattern: .+Z.{5}.*(\+|\-)(14:00|((0[0-9]|1[0-3]):[0-5][0-9])).{5}[^\+\-Z]+
6701
6702 **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.
6703
6704 Derived by restriction of ReportPeriodValidTimeZoneType .
6705 Regular Expression Pattern: .{5}A1.*
6706
6707 **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.
6708
6709 Derived by restriction of ReportPeriodValidTimeZoneType .
6710 Regular Expression Pattern: .{5}S[1-2].*
6711
6712 **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.
6713
6714 Derived by restriction of ReportPeriodValidTimeZoneType .
6715 Regular Expression Pattern: .{5}T[1-3].*
6716
6717 **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.
6718
6719 Derived by restriction of ReportPeriodValidTimeZoneType .
6720 Regular Expression Pattern: .{5}Q[1-4].*
6721
6722 **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).
6723
6724 Derived by restriction of ReportPeriodValidTimeZoneType .
6725 Regular Expression Pattern: .{5}M(0[1-9]|1[0-2]).*
6726
6727 **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).
6728
6729 Derived by restriction of ReportPeriodValidTimeZoneType .
6730 Regular Expression Pattern: .{5}W(0[1-9]|[1-4][0-9]|5[0-3]).*
6731
6732 **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).
6733
6734 Derived by restriction of ReportPeriodValidTimeZoneType .
6735 Regular Expression Pattern: .{5}D(0[0-9][1-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-6]).*
6736
6737 **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.
6738
6739 Derived by restriction of xs:string .
6740 Regular Expression Pattern: \d{4}\-\d{2}\-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?)?(Z|((\+|\-)\d{2}:\d{2}))?/P.+
6741
6742 **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.
6743
6744 Derived by restriction of BaseTimeRangeType .
6745 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]).+
6746
6747 **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.
6748
6749 Derived by restriction of RangeValidMonthDayType .
6750 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]).+
6751
6752 **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.
6753
6754 Derived by restriction of RangeValidLeapYearType .
6755 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]+/.+
6756
6757 **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.
6758
6759 Derived by restriction of RangeValidTimeType .
6760 Regular Expression Pattern: .+Z/.+.{10}.*(\+|\-)(14:00|((0[0-9]|1[0-3]):[0-5][0-9]))/.+.{10}[^\+\-Z]+
6761
6762 **TimeRangeValidDateDurationType: **TimeRangeValidDateDurationType is an abstract derivation of the RangeValidTimeType which validates that duration provided is generally valid, up to the time component.
6763
6764 Derived by restriction of RangeValidTimeZoneType .
6765 Regular Expression Pattern: .+/P(\d+Y)?(\d+M)?(\d+D)?(T.+)?
6766
6767 **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.
6768
6769 Derived by restriction of TimeRangeValidDateDurationType.
6770 Regular Expression Pattern: .+/P.*T(\d+H)?(\d+M)?(\d+(.\d+)?S)?.+/P[^T]+
6771
6772 **TimezoneType: **TimezoneType defines the pattern for a time zone. An offset of -14:00 to +14:00 or Z can be specified.
6773
6774 Derived by restriction of xs:string.
6775 Regular Expression Pattern: Z(\+|\-)(14:00|((0[0-9]|1[0-3]):[0-5][0-9]))
6776
6777 **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.
6778
6779 Union of:
6780 MaxOccursNumberType, UnboundedCodeType.
6781
6782 **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.
6783
6784 Derived by restriction of xs:nonNegativeInteger.
6785 Minimum (inclusive): 1
6786 Fraction Digits: 0
6787
6788 **UnboundedCodeType: **UnboundedCodeType provides single textual value of "unbounded", for use in OccurentType.
6789
6790 Derived by restriction of xs:string .
6791
6792 Enumerations:
6793
6794 |**Value**|**Documentation**
6795 |unbounded|Object has no upper limit on occurrences.
6796
6797 **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.
6798
6799 Derived by restriction of xs:NMTOKEN .
6800
6801 Enumerations:
6802
6803 |**Value**|**Documentation**
6804 |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.
6805 |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.
6806 |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.
6807 |Information|Informational - data/metadata is being exchanged for informational purposes only, and not meant to update a system.
6808
6809 **WildCardValueType: **WildCardValueType is a single value code list, used to include the '%' character - indicating that an entire field is wild carded.
6810
6811 Derived by restriction of xs:string .
6812
6813 Enumerations:
6814
6815 (% style="width:913.294px" %)
6816 |(% style="width:183px" %)**Value**|(% style="width:727px" %)**Documentation**
6817 |(% style="width:183px" %)%|(% style="width:727px" %)Indicates a wild card value.
6818
6819 **DimensionTypeType: **DimensionTypeType enumerates the sub-classes of a dimension.
6820
6821 Derived by restriction of xs:string .
6822
6823 Enumerations:
6824
6825 |**Value**|**Documentation**
6826 |Dimension|An ordinary dimension.
6827 |MeasureDimension|A measure dimension.
6828 |TimeDimension|The time dimension.
6829
6830 **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.
6831
6832 Derived by restriction of xs:string .
6833
6834 Enumerations:
6835
6836 |**Value**|**Documentation**
6837 |Allowed|The constraint contains the allowed values for attachable object.
6838 |Actual|The constraints contains the actual data present for the attachable object.
6839
6840 **SimpleOperatorType: **SimpleOperatorType provides an enumeration of simple operators to be applied to any value.
6841
6842 Derived by restriction of xs:string .
6843
6844 Enumerations:
6845
6846 |**Value**|**Documentation**
6847 |notEqual|(~!=) - value must not be equal to the value supplied.
6848 |equal|(=) - value must be exactly equal to the value supplied.
6849
6850 **RangeOperatorType: **RangeOperatorType provides an enumeration of range operators to be applied to an ordered value.
6851
6852 Derived by restriction of xs:string .
6853
6854 Enumerations:
6855
6856 |**Value**|**Documentation**
6857 |greaterThanOrEqual|(>=) - value must be greater than or equal to the value supplied.
6858 |lessThanOrEqual|(<=) - value must be less than or equal to the value supplied.
6859 |greaterThan|(>) - value must be greater than the value supplied.
6860 |lessThan|(<) - value must be less than the value supplied.
6861
6862 **TextSearchOperatorType: **TextSearchOperatorType provides an enumeration of text search operators.
6863
6864 Derived by restriction of xs:string .
6865
6866 Enumerations:
6867
6868 |**Value**|**Documentation**
6869 |contains|The text being searched must contain the supplied text.
6870 |startsWith|The text being searched must start with the supplied text.
6871 |endsWith|The text being searched must end with the supplied text.
6872 |doesNotContain|The text being searched cannot contain the supplied text.
6873 |doesNotStartWith|The text being searched cannot start with the supplied text.
6874 |doesNotEndWith|The text being searched cannot end with the supplied text.
6875
6876 **OrderedOperatorType: **OrderedOperatorType combines the SimpleOperatorType and the RangeOperatorType to provide a full range or operators for any ordered value.
6877
6878 Union of:
6879 SimpleOperatorType, RangeOperatorType.
6880
6881 **TextOperatorType:**
6882
6883 Union of:
6884 SimpleOperatorType, TextSearchOperatorType.
6885
6886 **TimeOperatorType: **TimeOperatorType derives from the OrderedOperatorType to remove the notEqual operator.
6887
6888 Derived by restriction of OrderedOperatorType .
6889
6890 Enumerations:
6891
6892 |**Value**|**Documentation**
6893 |equal|
6894 |greaterThanOrEqual|
6895 |lessThanOrEqual|
6896 |greaterThan|
6897 |lessThan|
6898
6899 **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".
6900
6901 Union of:
6902 NCNameIDType, ObsDimensionsCodeType.
6903
6904 **ObsDimensionsCodeType: **ObsDimensionsCodeType is an enumeration containing the values "TimeDimension" and "AllDimensions"
6905
6906 Derived by restriction of xs:string .
6907
6908 Enumerations:
6909
6910 |**Value**|**Documentation**
6911 |AllDimensions|AllDimensions notes that the cross sectional format shall be flat; that is all dimensions should be contained at the observation level.
6912 |TIME_PERIOD|TIME_PERIOD refers to the fixed identifier for the time dimension.
6913
6914 **DataType: **DataTypeType provides an enumerated list of the types of data formats allowed as the for the representation of an object.
6915
6916 Derived by restriction of xs:NMTOKEN .
6917
6918 Enumerations:
6919
6920 |**Value**|**Documentation**
6921 |String|A string datatype corresponding to W3C XML Schema's xs:string datatype.
6922 |Alpha|A string datatype which only allows for the simple aplhabetic charcter set of A-Z, a-z.
6923 |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.
6924 |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.
6925 |BigInteger|An integer datatype corresponding to W3C XML Schema's xs:integer datatype.
6926 |Integer|An integer datatype corresponding to W3C XML Schema's xs:int datatype.
6927 |Long|A numeric datatype corresponding to W3C XML Schema's xs:long datatype.
6928 |Short|A numeric datatype corresponding to W3C XML Schema's xs:short datatype.
6929 |Decimal|A numeric datatype corresponding to W3C XML Schema's xs:decimal datatype.
6930 |Float|A numeric datatype corresponding to W3C XML Schema's xs:float datatype.
6931 |Double|A numeric datatype corresponding to W3C XML Schema's xs:double datatype.
6932 |Boolean|A datatype corresponding to W3C XML Schema's xs:boolean datatype.
6933 |URI|A datatype corresponding to W3C XML Schema's xs:anyURI datatype.
6934 |Count|A simple incrementing Integer type. The isSequence facet must be set to true, and the interval facet must be set to "1".
6935 |InclusiveValueRange|This value indicates that the startValue and endValue attributes provide the inclusive boundaries of a numeric range of type xs:decimal.
6936 |ExclusiveValueRange|This value indicates that the startValue and endValue attributes provide the exclusive boundaries of a numeric range, of type xs:decimal.
6937 |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.
6938 |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.
6939 |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.
6940 |BasicTimePeriod|BasicTimePeriod time periods is a superset of the Gregorian time periods and a date time.
6941 |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.
6942 |GregorianYear|A Gregorian time period corresponding to W3C XML Schema's xs:gYear datatype, which is based on ISO-8601.
6943 |GregorianYearMonth|A time datatype corresponding to W3C XML Schema's xs:gYearMonth datatype, which is based on ISO-8601.
6944 |GregorianDay|A time datatype corresponding to W3C XML Schema's xs:date datatype, which is based on ISO-8601.
6945 |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.
6946 |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.
6947 |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.
6948 |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.
6949 |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.
6950 |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.
6951 |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.
6952 |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.
6953 |DateTime|A time datatype corresponding to W3C XML Schema's xs:dateTime datatype.
6954 |TimeRange|TimeRange defines a time period by providing a distinct start (date or date time) and a duration.
6955 |Month|A time datatype corresponding to W3C XML Schema's xs:gMonth datatype.
6956 |MonthDay|A time datatype corresponding to W3C XML Schema's xs:gMonthDay datatype.
6957 |Day|A time datatype corresponding to W3C XML Schema's xs:gDay datatype.
6958 |Time|A time datatype corresponding to W3C XML Schema's xs:time datatype.
6959 |Duration|A time datatype corresponding to W3C XML Schema's xs:duration datatype.
6960 |XHTML|This value indicates that the content of the component can contain XHTML markup.
6961 |KeyValues|This value indicates that the content of the component will be data key (a set of dimension references and values for the dimensions).
6962 |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.
6963 |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.
6964 |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.
6965
6966 **BasicComponentDataType: **BasicComponentDataType provides an enumerated list of the types of characters allowed in the textType attribute for all non-target object components.
6967
6968 Derived by restriction of DataType .
6969
6970 Enumerations:
6971
6972 |**Value**|**Documentation**
6973 |String|A string datatype corresponding to W3C XML Schema's xs:string datatype.
6974 |Alpha|A string datatype which only allows for the simple aplhabetic charcter set of A-Z, a-z.
6975 |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.
6976 |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.
6977 |BigInteger|An integer datatype corresponding to W3C XML Schema's xs:integer datatype.
6978 |Integer|An integer datatype corresponding to W3C XML Schema's xs:int datatype.
6979 |Long|A numeric datatype corresponding to W3C XML Schema's xs:long datatype.
6980 |Short|A numeric datatype corresponding to W3C XML Schema's xs:short datatype.
6981 |Decimal|A numeric datatype corresponding to W3C XML Schema's xs:decimal datatype.
6982 |Float|A numeric datatype corresponding to W3C XML Schema's xs:float datatype.
6983 |Double|A numeric datatype corresponding to W3C XML Schema's xs:double datatype.
6984 |Boolean|A datatype corresponding to W3C XML Schema's xs:boolean datatype.
6985 |URI|A datatype corresponding to W3C XML Schema's xs:anyURI datatype.
6986 |Count|A simple incrementing Integer type. The isSequence facet must be set to true, and the interval facet must be set to "1".
6987 |InclusiveValueRange|This value indicates that the startValue and endValue attributes provide the inclusive boundaries of a numeric range of type xs:decimal.
6988 |ExclusiveValueRange|This value indicates that the startValue and endValue attributes provide the exclusive boundaries of a numeric range, of type xs:decimal.
6989 |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.
6990 |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.
6991 |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.
6992 |BasicTimePeriod|BasicTimePeriod time periods is a superset of the Gregorian time periods and a date time.
6993 |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.
6994 |GregorianYear|A Gregorian time period corresponding to W3C XML Schema's xs:gYear datatype, which is based on ISO-8601.
6995 |GregorianYearMonth|A time datatype corresponding to W3C XML Schema's xs:gYearMonth datatype, which is based on ISO-8601.
6996 |GregorianDay|A time datatype corresponding to W3C XML Schema's xs:date datatype, which is based on ISO-8601.
6997 |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.
6998 |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.
6999 |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.
7000 |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.
7001 |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.
7002 |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.
7003 |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.
7004 |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.
7005 |DateTime|A time datatype corresponding to W3C XML Schema's xs:dateTime datatype.
7006 |TimeRange|TimeRange defines a time period by providing a distinct start (date or date time) and a duration.
7007 |Month|A time datatype corresponding to W3C XML Schema's xs:gMonth datatype.
7008 |MonthDay|A time datatype corresponding to W3C XML Schema's xs:gMonthDay datatype.
7009 |Day|A time datatype corresponding to W3C XML Schema's xs:gDay datatype.
7010 |Time|A time datatype corresponding to W3C XML Schema's xs:time datatype.
7011 |Duration|A time datatype corresponding to W3C XML Schema's xs:duration datatype.
7012 |XHTML|This value indicates that the content of the component can contain XHTML markup.
7013
7014 **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.
7015
7016 Derived by restriction of BasicComponentDataType .
7017
7018 Enumerations:
7019
7020 |**Value**|**Documentation**
7021 |String|A string datatype corresponding to W3C XML Schema's xs:string datatype.
7022 |Alpha|A string datatype which only allows for the simple aplhabetic charcter set of A-Z, a-z.
7023 |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.
7024 |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.
7025 |BigInteger|An integer datatype corresponding to W3C XML Schema's xs:integer datatype.
7026 |Integer|An integer datatype corresponding to W3C XML Schema's xs:int datatype.
7027 |Long|A numeric datatype corresponding to W3C XML Schema's xs:long datatype.
7028 |Short|A numeric datatype corresponding to W3C XML Schema's xs:short datatype.
7029 |Decimal|A numeric datatype corresponding to W3C XML Schema's xs:decimal datatype.
7030 |Float|A numeric datatype corresponding to W3C XML Schema's xs:float datatype.
7031 |Double|A numeric datatype corresponding to W3C XML Schema's xs:double datatype.
7032 |Boolean|A datatype corresponding to W3C XML Schema's xs:boolean datatype.
7033 |URI|A datatype corresponding to W3C XML Schema's xs:anyURI datatype.
7034 |Count|A simple incrementing Integer type. The isSequence facet must be set to true, and the interval facet must be set to "1".
7035 |InclusiveValueRange|This value indicates that the startValue and endValue attributes provide the inclusive boundaries of a numeric range of type xs:decimal.
7036 |ExclusiveValueRange|This value indicates that the startValue and endValue attributes provide the exclusive boundaries of a numeric range, of type xs:decimal.
7037 |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.
7038 |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.
7039 |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.
7040 |BasicTimePeriod|BasicTimePeriod time periods is a superset of the Gregorian time periods and a date time.
7041 |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.
7042 |GregorianYear|A Gregorian time period corresponding to W3C XML Schema's xs:gYear datatype, which is based on ISO-8601.
7043 |GregorianYearMonth|A time datatype corresponding to W3C XML Schema's xs:gYearMonth datatype, which is based on ISO-8601.
7044 |GregorianDay|A time datatype corresponding to W3C XML Schema's xs:date datatype, which is based on ISO-8601.
7045 |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.
7046 |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.
7047 |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.
7048 |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.
7049 |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.
7050 |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.
7051 |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.
7052 |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.
7053 |DateTime|A time datatype corresponding to W3C XML Schema's xs:dateTime datatype.
7054 |TimeRange|TimeRange defines a time period by providing a distinct start (date or date time) and a duration.
7055 |Month|A time datatype corresponding to W3C XML Schema's xs:gMonth datatype.
7056 |MonthDay|A time datatype corresponding to W3C XML Schema's xs:gMonthDay datatype.
7057 |Day|A time datatype corresponding to W3C XML Schema's xs:gDay datatype.
7058 |Time|A time datatype corresponding to W3C XML Schema's xs:time datatype.
7059 |Duration|A time datatype corresponding to W3C XML Schema's xs:duration datatype.
7060
7061 **TimeDataType: **TimeDataType restricts SimpleDataType to specify the allowable data types for representing a time value.
7062
7063 Derived by restriction of SimpleDataType .
7064
7065 Enumerations:
7066
7067 (% style="width:968.835px" %)
7068 |**Value**|(% style="width:769px" %)**Documentation**
7069 |ObservationalTimePeriod|(% style="width:769px" %)Observational time periods are the superset of all time periods in SDMX. It is the union of the standard time periods (i.e. Gregorian time periods, the reporting time periods, and date time) and a time range.
7070 |StandardTimePeriod|(% style="width:769px" %)Standard time periods is a superset of distinct time period in SDMX. It is the union of the basic time periods (i.e. the Gregorian time periods and date time) and the reporting time periods.
7071 |BasicTimePeriod|(% style="width:769px" %)BasicTimePeriod time periods is a superset of the Gregorian time periods and a date time.
7072 |GregorianTimePeriod|(% style="width:769px" %)Gregorian time periods correspond to calendar periods and are represented in ISO-8601 formats. This is the union of the year, year month, and date formats.
7073 |GregorianYear|(% style="width:769px" %)A Gregorian time period corresponding to W3C XML Schema's xs:gYear datatype, which is based on ISO-8601.
7074 |GregorianYearMonth|(% style="width:769px" %)A time datatype corresponding to W3C XML Schema's xs:gYearMonth datatype, which is based on ISO-8601.
7075 |GregorianDay|(% style="width:769px" %)A time datatype corresponding to W3C XML Schema's xs:date datatype, which is based on ISO-8601.
7076 |ReportingTimePeriod|(% style="width:769px" %)Reporting time periods represent periods of a standard length within a reporting year, where to start of the year (defined as a month and day) must be defined elsewhere or it is assumed to be January 1. This is the union of the reporting year, semester, trimester, quarter, month, week, and day.
7077 |ReportingYear|(% style="width:769px" %)A reporting year represents a period of 1 year (P1Y) from the start date of the reporting year. This is expressed as using the SDMX specific ReportingYearType.
7078 |ReportingSemester|(% style="width:769px" %)A reporting semester represents a period of 6 months (P6M) from the start date of the reporting year. This is expressed as using the SDMX specific ReportingSemesterType.
7079 |ReportingTrimester|(% style="width:769px" %)A reporting trimester represents a period of 4 months (P4M) from the start date of the reporting year. This is expressed as using the SDMX specific ReportingTrimesterType.
7080 |ReportingQuarter|(% style="width:769px" %)A reporting quarter represents a period of 3 months (P3M) from the start date of the reporting year. This is expressed as using the SDMX specific ReportingQuarterType.
7081 |ReportingMonth|(% style="width:769px" %)A reporting month represents a period of 1 month (P1M) from the start date of the reporting year. This is expressed as using the SDMX specific ReportingMonthType.
7082 |ReportingWeek|(% style="width:769px" %)A reporting week represents a period of 7 days (P7D) from the start date of the reporting year. This is expressed as using the SDMX specific ReportingWeekType.
7083 |ReportingDay|(% style="width:769px" %)A reporting day represents a period of 1 day (P1D) from the start date of the reporting year. This is expressed as using the SDMX specific ReportingDayType.
7084 |DateTime|(% style="width:769px" %)A time datatype corresponding to W3C XML Schema's xs:dateTime datatype.
7085 |TimeRange|(% style="width:769px" %)TimeRange defines a time period by providing a distinct start (date or date time) and a duration.
7086
7087 **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, _, -, $.
7088
7089 Derived by restriction of xs:string .
7090 Regular Expression Pattern: [A-Za-z0-9_@$\-]+(\.[A-Za-z0-9_@$\-]+)*
7091
7092 **TwoLevelIDType: **TwoLevelIDType defines an identifier with exactly two levels.
7093
7094 Derived by restriction of NestedIDType .
7095 Regular Expression Pattern: [A-Za-z0-9_@$\-]+\.[A-Za-z0-9_@$\-]+
7096
7097 **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, _, -, $.
7098
7099 Derived by restriction of NestedIDType .
7100 Regular Expression Pattern: [A-Za-z0-9_@$\-]+
7101
7102 **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.
7103
7104 Derived by restriction of IDType .
7105 Regular Expression Pattern: [A-Za-z][A-Za-z0-9_\-]*
7106
7107 **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.
7108
7109 Derived by restriction of NestedIDType .
7110 Regular Expression Pattern: [A-Za-z][A-Za-z0-9_\-]*(\.[A-Za-z][A-Za-z0-9_\-]*)*
7111
7112 **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).
7113
7114 Derived by restriction of NestedNCNameIDType .
7115 Regular Expression Pattern: [A-Za-z][A-Za-z0-9_\-]*
7116
7117 **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.
7118
7119 Derived by restriction of xs:string .
7120 Regular Expression Pattern: [0-9]+(\.[0-9]+)*
7121
7122 **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.
7123
7124 Union of:
7125 VersionType, LateBoundVersionType.
7126
7127 **LateBoundVersionType: **LateBoundVersionType is a single value code list, used to include the '*' character - indicating that the latest version of an object is required.
7128
7129 Derived by restriction of xs:string .
7130
7131 Enumerations:
7132
7133 |**Value**|**Documentation**
7134 |*|Indicates that the latest version of an object is requested.
7135
7136 **PackageTypeCodelistType: **PackageTypeCodelistType provides an enumeration of all SDMX package names.
7137
7138 Derived by restriction of xs:string .
7139
7140 Enumerations:
7141
7142 |**Value**|**Documentation**
7143 |base|
7144 |datastructure|
7145 |metadatastructure|
7146 |process|
7147 |registry|
7148 |mapping|
7149 |codelist|
7150 |categoryscheme|
7151 |conceptscheme|
7152 |transformation|
7153
7154 **ItemSchemePackageTypeCodelistType: **ItemSchemePackageTypeCodelistType provides an enumeration of all SDMX packages which contain item schemes.
7155
7156 Derived by restriction of PackageTypeCodelistType .
7157
7158 Enumerations:
7159
7160 |**Value**|**Documentation**
7161 |base|
7162 |codelist|
7163 |categoryscheme|
7164 |conceptscheme|
7165 |transformation|
7166
7167 **StructurePackageTypeCodelistType: **StructurePackageTypeCodelistType provides an enumeration of all SDMX packages which contain structure and structure usages.
7168
7169 Derived by restriction of PackageTypeCodelistType .
7170
7171 Enumerations:
7172
7173 |**Value**|**Documentation**
7174 |datastructure|
7175 |metadatastructure|
7176
7177 **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.
7178
7179 Derived by restriction of xs:string .
7180
7181 Enumerations:
7182
7183 |**Value**|**Documentation**
7184 |Any|
7185 |Agency|
7186 |AgencyScheme|
7187 |AttachmentConstraint|
7188 |Attribute|
7189 |AttributeDescriptor|
7190 |Categorisation|
7191 |Category|
7192 |CategorySchemeMap|
7193 |CategoryScheme|
7194 |Code|
7195 |CodeMap|
7196 |Codelist|
7197 |CodelistMap|
7198 |ComponentMap|
7199 |Concept|
7200 |ConceptMap|
7201 |ConceptScheme|
7202 |ConceptSchemeMap|
7203 |Constraint|
7204 |ConstraintTarget|
7205 |ContentConstraint|
7206 |CustomType|
7207 |CustomTypeScheme|
7208 |Dataflow|
7209 |DataConsumer|
7210 |DataConsumerScheme|
7211 |DataProvider|
7212 |DataProviderScheme|
7213 |DataSetTarget|
7214 |DataStructure|
7215 |DefinitionScheme|
7216 |Dimension|
7217 |DimensionDescriptor|
7218 |DimensionDescriptorValuesTarget|
7219 |GroupDimensionDescriptor|
7220 |HierarchicalCode|
7221 |HierarchicalCodelist|
7222 |Hierarchy|
7223 |HybridCodelistMap|
7224 |HybridCodeMap|
7225 |IdentifiableObjectTarget|
7226 |Level|
7227 |MeasureDescriptor|
7228 |MeasureDimension|
7229 |Metadataflow|
7230 |MetadataAttribute|
7231 |MetadataSet|
7232 |MetadataStructure|
7233 |MetadataTarget|
7234 |NamePersonalisation|
7235 |NamePersonalisationScheme|
7236 |Organisation|
7237 |OrganisationMap|
7238 |OrganisationScheme|
7239 |OrganisationSchemeMap|
7240 |OrganisationUnit|
7241 |OrganisationUnitScheme|
7242 |PrimaryMeasure|
7243 |Process|
7244 |ProcessStep|
7245 |ProvisionAgreement|
7246 |ReportingCategory|
7247 |ReportingCategoryMap|
7248 |ReportingTaxonomy|
7249 |ReportingTaxonomyMap|
7250 |ReportingYearStartDay|
7251 |ReportPeriodTarget|
7252 |ReportStructure|
7253 |Ruleset|
7254 |RulesetScheme|
7255 |StructureMap|
7256 |StructureSet|
7257 |TimeDimension|
7258 |Transformation|
7259 |TransformationScheme|
7260 |Transition|
7261 |UserDefinedOperator|
7262 |UserDefinedOperatorScheme|
7263 |VtlMapping|
7264 |VtlMappingScheme|
7265
7266 **MaintainableTypeCodelistType: **MaintainableTypeCodelistType provides an enumeration of all maintainable objects.
7267
7268 Derived by restriction of ObjectTypeCodelistType .
7269
7270 Enumerations:
7271
7272 |**Value**|**Documentation**
7273 |Any|
7274 |AgencyScheme|
7275 |AttachmentConstraint|
7276 |Categorisation|
7277 |CategoryScheme|
7278 |Codelist|
7279 |ConceptScheme|
7280 |Constraint|
7281 |ContentConstraint|
7282 |CustomTypeScheme|
7283 |Dataflow|
7284 |DataConsumerScheme|
7285 |DataProviderScheme|
7286 |DataStructure|
7287 |DefinitionScheme|
7288 |HierarchicalCodelist|
7289 |Metadataflow|
7290 |MetadataStructure|
7291 |NamePersonalisationScheme|
7292 |OrganisationScheme|
7293 |OrganisationUnitScheme|
7294 |Process|
7295 |ProvisionAgreement|
7296 |ReportingTaxonomy|
7297 |RulesetScheme|
7298 |StructureSet|
7299 |TransformationScheme|
7300 |UserDefinedOperatorScheme|
7301 |VtlMappingScheme|
7302
7303 **ConcreteMaintainableTypeCodelistType: **ConcreteMaintainableTypeCodelistType provides an enumeration of all concrete maintainable objects.
7304
7305 Derived by restriction of MaintainableTypeCodelistType .
7306
7307 Enumerations:
7308
7309 |**Value**|**Documentation**
7310 |AgencyScheme|
7311 |AttachmentConstraint|
7312 |Categorisation|
7313 |CategoryScheme|
7314 |Codelist|
7315 |ConceptScheme|
7316 |ContentConstraint|
7317 |CustomTypeScheme|
7318 |Dataflow|
7319 |DataConsumerScheme|
7320 |DataProviderScheme|
7321 |DataStructure|
7322 |HierarchicalCodelist|
7323 |Metadataflow|
7324 |MetadataStructure|
7325 |NamePersonalisationScheme|
7326 |OrganisationUnitScheme|
7327 |Process|
7328 |ProvisionAgreement|
7329 |ReportingTaxonomy|
7330 |RulesetScheme|
7331 |StructureSet|
7332 |TransformationScheme|
7333 |UserDefinedOperatorScheme|
7334 |VtlMappingScheme|
7335
7336 **CodelistTypeCodelistType: **CodelistTypeCodelistType provides an enumeration of all codelist objects.
7337
7338 Derived by restriction of MaintainableTypeCodelistType .
7339
7340 Enumerations:
7341
7342 |**Value**|**Documentation**
7343 |Codelist|
7344 |HierarchicalCodelist|
7345
7346 **CodeTypeCodelistType: **CodeTypeCodelistType provides an enumeration of all code objects.
7347
7348 Derived by restriction of ObjectTypeCodelistType .
7349
7350 Enumerations:
7351
7352 |**Value**|**Documentation**
7353 |Code|
7354 |HierarchicalCode|
7355
7356 **ConstraintTypeCodelistType: **ConstraintTypeCodelistType provides an enumeration of all constraint objects.
7357
7358 Derived by restriction of MaintainableTypeCodelistType .
7359
7360 Enumerations:
7361
7362 |**Value**|**Documentation**
7363 |AttachmentConstraint|
7364 |ContentConstraint|
7365
7366 **ItemSchemeTypeCodelistType: **ItemSchemeTypeCodelistType provides an enumeration of all item scheme objects.
7367
7368 Derived by restriction of MaintainableTypeCodelistType .
7369
7370 Enumerations:
7371
7372 |**Value**|**Documentation**
7373 |AgencyScheme|
7374 |CategoryScheme|
7375 |Codelist|
7376 |ConceptScheme|
7377 |CustomTypeScheme|
7378 |DataConsumerScheme|
7379 |DataProviderScheme|
7380 |NamePersonalisationScheme|
7381 |OrganisationUnitScheme|
7382 |ReportingTaxonomy|
7383 |RulesetScheme|
7384 |TransformationScheme|
7385 |UserDefinedOperatorScheme|
7386 |VtlMappingScheme|
7387
7388 **DefinitionSchemeTypeCodelistType: **DefinitionSchemeTypeCodelistType provides an enumeration of all definition scheme objects.
7389
7390 Derived by restriction of ItemSchemeTypeCodelistType .
7391
7392 Enumerations:
7393
7394 |**Value**|**Documentation**
7395 |CustomTypeScheme|
7396 |NamePersonalisationScheme|
7397 |RulesetScheme|
7398 |TransformationScheme|
7399 |UserDefinedOperatorScheme|
7400
7401 **OrganisationSchemeTypeCodelistType: **OrganisationSchemeTypeCodelistType provides an enumeration of all organisation scheme objects.
7402
7403 Derived by restriction of ItemSchemeTypeCodelistType .
7404
7405 Enumerations:
7406
7407 |**Value**|**Documentation**
7408 |AgencyScheme|
7409 |DataConsumerScheme|
7410 |DataProviderScheme|
7411 |OrganisationUnitScheme|
7412
7413 **OrganisationTypeCodelistType: **OrganisationTypeCodelistType provides an enumeration of all organisation objects.
7414
7415 Derived by restriction of ItemTypeCodelistType .
7416
7417 Enumerations:
7418
7419 |**Value**|**Documentation**
7420 |Agency|
7421 |DataConsumer|
7422 |DataProvider|
7423 |OrganisationUnit|
7424
7425 **StructureOrUsageTypeCodelistType: **StructureOrUsageTypeCodelistType provides an enumeration all structure and structure usage objects
7426
7427 Derived by restriction of MaintainableTypeCodelistType .
7428
7429 Enumerations:
7430
7431 |**Value**|**Documentation**
7432 |Dataflow|
7433 |DataStructure|
7434 |Metadataflow|
7435 |MetadataStructure|
7436
7437 **StructureTypeCodelistType: **StructureTypeCodelistType provides an enumeration all structure objects
7438
7439 Derived by restriction of StructureOrUsageTypeCodelistType .
7440
7441 Enumerations:
7442
7443 |**Value**|**Documentation**
7444 |DataStructure|
7445 |MetadataStructure|
7446
7447 **StructureUsageTypeCodelistType: **StructureUsageTypeCodelistType provides an enumeration all structure usage objects
7448
7449 Derived by restriction of StructureOrUsageTypeCodelistType .
7450
7451 Enumerations:
7452
7453 |**Value**|**Documentation**
7454 |Dataflow|
7455 |Metadataflow|
7456
7457 **ItemTypeCodelistType: **ItemTypeCodelistType provides an enumeration of all item objects.
7458
7459 Derived by restriction of ObjectTypeCodelistType .
7460
7461 Enumerations:
7462
7463 |**Value**|**Documentation**
7464 |Agency|
7465 |Category|
7466 |Code|
7467 |Concept|
7468 |CustomType|
7469 |DataConsumer|
7470 |DataProvider|
7471 |NamePersonalisation|
7472 |OrganisationUnit|
7473 |ReportingCategory|
7474 |Ruleset|
7475 |Transformation|
7476 |UserDefinedOperator|
7477 |VtlMapping|
7478
7479 **ComponentListTypeCodelistType: **ComponentListTypeCodelistType provides an enumeration of all component list objects.
7480
7481 Derived by restriction of ObjectTypeCodelistType .
7482
7483 Enumerations:
7484
7485 |**Value**|**Documentation**
7486 |AttributeDescriptor|
7487 |DimensionDescriptor|
7488 |GroupDimensionDescriptor|
7489 |MeasureDescriptor|
7490 |MetadataTarget|
7491 |ReportStructure|
7492
7493 **ComponentTypeCodelistType: **ComponentTypeCodelistType provides an enumeration of all component objects.
7494
7495 Derived by restriction of ObjectTypeCodelistType .
7496
7497 Enumerations:
7498
7499 |**Value**|**Documentation**
7500 |Attribute|
7501 |ConstraintTarget|
7502 |DataSetTarget|
7503 |Dimension|
7504 |IdentifiableObjectTarget|
7505 |DimensionDescriptorValuesTarget|
7506 |MeasureDimension|
7507 |MetadataAttribute|
7508 |PrimaryMeasure|
7509 |ReportingYearStartDay|
7510 |ReportPeriodTarget|
7511 |TimeDimension|
7512
7513 **DataStructureComponentTypeCodelistType: **DataStructureComponentTypeCodelistType provides an enumeration of all data structure component objects, except for the primary measure.
7514
7515 Derived by restriction of ComponentTypeCodelistType .
7516
7517 Enumerations:
7518
7519 (% style="width:960.294px" %)
7520 |(% style="width:333px" %)**Value**|(% style="width:624px" %)**Documentation**
7521 |(% style="width:333px" %)Attribute|(% style="width:624px" %)
7522 |(% style="width:333px" %)Dimension|(% style="width:624px" %)
7523 |(% style="width:333px" %)MeasureDimension|(% style="width:624px" %)
7524 |(% style="width:333px" %)PrimaryMeasure|(% style="width:624px" %)
7525 |(% style="width:333px" %)ReportingYearStartDay|(% style="width:624px" %)
7526 |(% style="width:333px" %)TimeDimension|(% style="width:624px" %)
7527
7528 **DimensionEumerationSchemeTypeCodelistType: **DimensionEumerationSchemeTypeCodelistType provides an enumeration of all item schemes which are allowable as the representation of a data structure definition component.
7529
7530 Derived by restriction of ItemSchemeTypeCodelistType .
7531
7532 Enumerations:
7533
7534 |**Value**|**Documentation**
7535 |Codelist|
7536 |ConceptScheme|
7537
7538 **MetadataStructureComponentTypeCodelistType: **MetadataStructureComponentTypeCodelistType provides an enumeration of all metadata structure component objects.
7539
7540 Derived by restriction of ComponentTypeCodelistType .
7541
7542 Enumerations:
7543
7544 |**Value**|**Documentation**
7545 |ConstraintTarget|
7546 |DataSetTarget|
7547 |IdentifiableObjectTarget|
7548 |DimensionDescriptorValuesTarget|
7549 |MetadataAttribute|
7550 |ReportPeriodTarget|
7551
7552 **DimensionTypeCodelistType: **DimensionTypeCodelistType provides an enumeration of all dimension objects.
7553
7554 Derived by restriction of ComponentTypeCodelistType .
7555
7556 Enumerations:
7557
7558 |**Value**|**Documentation**
7559 |Dimension|
7560 |MeasureDimension|
7561 |TimeDimension|
7562
7563 **TargetObjectTypeCodelistType: **TargetObjectTypeCodelistType provides an enumeration of all target object objects.
7564
7565 Derived by restriction of ComponentTypeCodelistType .
7566
7567 Enumerations:
7568
7569 |**Value**|**Documentation**
7570 |ConstraintTarget|
7571 |DataSetTarget|
7572 |IdentifiableObjectTarget|
7573 |DimensionDescriptorValuesTarget|
7574 |ReportPeriodTarget|
© Semantic R&D Group, 2026