Skip to Content

Wiki source code of Part II.Common

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