Skip to Content

Wiki source code of Part II.Common

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