Last modified by Elena on 2025/09/10 11:19

From version 5.3
edited by Helena
on 2025/06/08 11:23
Change comment: There is no comment for this version
To version 5.4
edited by Helena
on 2025/06/08 11:25
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -302,87 +302,88 @@
302 302  
303 303  ==== 5.4.3.2 Definitions ====
304 304  
305 -|**Class**|**Feature**|**Description**
306 -|//DataSet//|(((
305 +(% style="width:964.835px" %)
306 +|(% style="width:200px" %)**Class**|(% style="width:285px" %)**Feature**|(% style="width:454px" %)**Description**
307 +|(% style="width:200px" %)//DataSet//|(% style="width:285px" %)(((
307 307  Abstract Class
308 308  Sub classes
309 309  StructureSpecificData
310 310  Set
311 -)))|An organised collection of data.
312 -| |reportingBegin|A specific time period in a known system of time periods that identifies the start period of a report.
313 -| |reportingEnd|A specific time period in a known system of time periods that identifies the end period of a report.
314 -| |dataExtractionDate|A specific time period that identifies the date and time that the data are extracted from a data source.
315 -| |validFrom|Indicates the inclusive start time indicating the validity of the information in the data set.
316 -| |validTo|Indicates the inclusive end time indicating the validity of the information in the data set.
317 -| |publicationYear|Specifies the year of publication of the data or metadata in terms of whatever provisioning agreements might be in force.
318 -| |publicationPeriod|Specifies the period of publication of the data or metadata in terms of whatever provisioning agreements might be in force.
319 -| |setId|Provides an identification of the data set.
320 -| |action|Defines the action to be taken by the recipient system (information, append, replace, delete)
321 -| |describedBy|(((
312 +)))|(% style="width:454px" %)An organised collection of data.
313 +|(% style="width:200px" %) |(% style="width:285px" %)reportingBegin|(% style="width:454px" %)A specific time period in a known system of time periods that identifies the start period of a report.
314 +|(% style="width:200px" %) |(% style="width:285px" %)reportingEnd|(% style="width:454px" %)A specific time period in a known system of time periods that identifies the end period of a report.
315 +|(% style="width:200px" %) |(% style="width:285px" %)dataExtractionDate|(% style="width:454px" %)A specific time period that identifies the date and time that the data are extracted from a data source.
316 +|(% style="width:200px" %) |(% style="width:285px" %)validFrom|(% style="width:454px" %)Indicates the inclusive start time indicating the validity of the information in the data set.
317 +|(% style="width:200px" %) |(% style="width:285px" %)validTo|(% style="width:454px" %)Indicates the inclusive end time indicating the validity of the information in the data set.
318 +|(% style="width:200px" %) |(% style="width:285px" %)publicationYear|(% style="width:454px" %)Specifies the year of publication of the data or metadata in terms of whatever provisioning agreements might be in force.
319 +|(% style="width:200px" %) |(% style="width:285px" %)publicationPeriod|(% style="width:454px" %)Specifies the period of publication of the data or metadata in terms of whatever provisioning agreements might be in force.
320 +|(% style="width:200px" %) |(% style="width:285px" %)setId|(% style="width:454px" %)Provides an identification of the data set.
321 +|(% style="width:200px" %) |(% style="width:285px" %)action|(% style="width:454px" %)Defines the action to be taken by the recipient system (information, append, replace, delete)
322 +|(% style="width:200px" %) |(% style="width:285px" %)describedBy|(% style="width:454px" %)(((
322 322  Associates a Dataflow and thereby a Data Structure
323 323  
324 324  Definition to the data set.
325 325  )))
326 -| |+structuredBy|(((
327 +|(% style="width:200px" %) |(% style="width:285px" %)+structuredBy|(% style="width:454px" %)(((
327 327  Associates the Data Structure Definition that defines the structure of the Data Set. Note that the Data Structure Definition is the same as that associated
328 328  
329 329  (non-mandatory) to the Dataflow.
330 330  )))
331 -| |+publishedBy|Associates the Data Provider that reports/publishes the data.
332 -|StructureSpecific DataSet| |An XML specific data format structure that contains data corresponding to one specific Data Structure Definition.
333 -|//Key//|(((
332 +|(% style="width:200px" %) |(% style="width:285px" %)+publishedBy|(% style="width:454px" %)Associates the Data Provider that reports/publishes the data.
333 +|(% style="width:200px" %)StructureSpecificDataSet|(% style="width:285px" %) |(% style="width:454px" %)An XML specific data format structure that contains data corresponding to one specific Data Structure Definition.
334 +|(% style="width:200px" %)//Key//|(% style="width:285px" %)(((
334 334  Abstract class
335 335  Sub classes
336 336  SeriesKey
337 337  GroupKey
338 -)))|Comprises the cross product of values of dimensions that identify uniquely an Observation.
339 -| |keyValues|Association to the individual Key Values that comprise the Key.
340 -| |+attachedAttribute|Association to the Attribute Values relating to the Series Key or Group Key.
341 -|//KeyValue//|(((
339 +)))|(% style="width:454px" %)Comprises the cross product of values of dimensions that identify uniquely an Observation.
340 +|(% style="width:200px" %) |(% style="width:285px" %)keyValues|(% style="width:454px" %)Association to the individual Key Values that comprise the Key.
341 +|(% style="width:200px" %) |(% style="width:285px" %)+attachedAttribute|(% style="width:454px" %)Association to the Attribute Values relating to the Series Key or Group Key.
342 +|(% style="width:200px" %)//KeyValue//|(% style="width:285px" %)(((
342 342  Abstract class
343 343  Sub classes
344 344  TimeKeyValue
345 345  CodedKeyValue
346 346  UncodedKeyValue
347 -)))|The value of a component of a key such as the value of the instance a Dimension in a Dimension Descriptor of a Data Structure Definition.
348 -| |+valueFor|(((
348 +)))|(% style="width:454px" %)The value of a component of a key such as the value of the instance a Dimension in a Dimension Descriptor of a Data Structure Definition.
349 +|(% style="width:200px" %) |(% style="width:285px" %)+valueFor|(% style="width:454px" %)(((
349 349  Association to the key component in the Data Structure Definition for which this Key Value is a valid representation.
350 350  Note that this is conceptual association as the key component is identified explicitly in the data set.
351 351  )))
352 -|TimeKeyValue|(((
353 +|(% style="width:200px" %)TimeKeyValue|(% style="width:285px" %)(((
353 353  Inherits from
354 354  //KeyValue//
355 -)))|The value of the Time Dimension component of the key.
356 -|CodedKeyValue|(((
356 +)))|(% style="width:454px" %)The value of the Time Dimension component of the key.
357 +|(% style="width:200px" %)CodedKeyValue|(% style="width:285px" %)(((
357 357  Inherits from
358 358  //KeyValue//
359 -)))|The value of a coded component of the key. The value is the Code to which this class is associated.
360 -| |+valueOf|Association to the Code. Note that this is a conceptual association showing that the Code must exist in the Code list associated with the Dimension in the Data Structure Definition. In the actual Data Set the value of the Code is placed in the Key Value.
361 -|UnCodedKeyValue|(((
360 +)))|(% style="width:454px" %)The value of a coded component of the key. The value is the Code to which this class is associated.
361 +|(% style="width:200px" %) |(% style="width:285px" %)+valueOf|(% style="width:454px" %)Association to the Code. Note that this is a conceptual association showing that the Code must exist in the Code list associated with the Dimension in the Data Structure Definition. In the actual Data Set the value of the Code is placed in the Key Value.
362 +|(% style="width:200px" %)UnCodedKeyValue|(% style="width:285px" %)(((
362 362  Inherits from
363 363  //KeyValue//
364 -)))|The value of an uncoded component of the key.
365 -| |value|The value of the key component.
366 -| |startTime|This attribute is only used if the textFormat of the attribute is of the Timespan type in the Data Structure Definition (in which case the value field takes a duration).
367 -|GroupKey|(((
365 +)))|(% style="width:454px" %)The value of an uncoded component of the key.
366 +|(% style="width:200px" %) |(% style="width:285px" %)value|(% style="width:454px" %)The value of the key component.
367 +|(% style="width:200px" %) |(% style="width:285px" %)startTime|(% style="width:454px" %)This attribute is only used if the textFormat of the attribute is of the Timespan type in the Data Structure Definition (in which case the value field takes a duration).
368 +|(% style="width:200px" %)GroupKey|(% style="width:285px" %)(((
368 368  Inherits from
369 369  //Key//
370 -)))|A set of Key Values that comprise a partial key, of the same dimensionality as the Time Series Key for the purpose of attaching Data Attributes.
371 -| |+describedBy|Associates the Group Dimension Descriptor defined in the Data Structure Definition.
372 -|SeriesKey|(((
371 +)))|(% style="width:454px" %)A set of Key Values that comprise a partial key, of the same dimensionality as the Time Series Key for the purpose of attaching Data Attributes.
372 +|(% style="width:200px" %) |(% style="width:285px" %)+describedBy|(% style="width:454px" %)Associates the Group Dimension Descriptor defined in the Data Structure Definition.
373 +|(% style="width:200px" %)SeriesKey|(% style="width:285px" %)(((
373 373  Inherits from
374 374  //Key//
375 -)))|Comprises the cross product of values of all the Key Values that, together with the Key Value of the +observation Dimension identify uniquely an Observation.
376 -| |+describedBy|Associates the Dimension Descriptor defined in the Data Structure Definition.
377 -|Observation| |The value(s) of the observed phenomenon in the context of the Key Values comprising the key.
378 -| |+valueFor|(((
376 +)))|(% style="width:454px" %)Comprises the cross product of values of all the Key Values that, together with the Key Value of the +observation Dimension identify uniquely an Observation.
377 +|(% style="width:200px" %) |(% style="width:285px" %)+describedBy|(% style="width:454px" %)Associates the Dimension Descriptor defined in the Data Structure Definition.
378 +|(% style="width:200px" %)Observation|(% style="width:285px" %) |(% style="width:454px" %)The value(s) of the observed phenomenon in the context of the Key Values comprising the key.
379 +|(% style="width:200px" %) |(% style="width:285px" %)+valueFor|(% style="width:454px" %)(((
379 379  Associates the Measure(s) defined in the Data Structure Definition.
380 380  
381 381  The source multiplicity (1..*) indicates that more than one values may be provided for a Measure, if the latter allows it.
382 382  )))
383 -| |+attachedAttribute|Association to the Attribute Values relating to the Observation.
384 -| |+observationDimension|Association to the Key Value that holds the value of the “Dimension at the Observation Level”.
385 -|//ObservationValue//|(((
384 +|(% style="width:200px" %) |(% style="width:285px" %)+attachedAttribute|(% style="width:454px" %)Association to the Attribute Values relating to the Observation.
385 +|(% style="width:200px" %) |(% style="width:285px" %)+observationDimension|(% style="width:454px" %)Association to the Key Value that holds the value of the “Dimension at the Observation Level”.
386 +|(% style="width:200px" %)//ObservationValue//|(% style="width:285px" %)(((
386 386  Abstract class
387 387  
388 388  Sub classes
... ... @@ -390,8 +390,8 @@
390 390  //UncodedObservationValue//
391 391  
392 392  CodedObservation
393 -)))|
394 -|//UncodedObservatio nValue//|(((
394 +)))|(% style="width:454px" %)
395 +|(% style="width:200px" %)//UncodedObservationValue//|(% style="width:285px" %)(((
395 395  Abstract class
396 396  Inherits from
397 397  //ObservationValue//
... ... @@ -398,29 +398,29 @@
398 398  Sub classes
399 399  OtherUncodedMeasureValue
400 400  TextMeasureValue
401 -)))|
402 -|OtherUncodedMeasu reValue|(((
402 +)))|(% style="width:454px" %)
403 +|(% style="width:200px" %)OtherUncodedMeasureValue|(% style="width:285px" %)(((
403 403  Inherits from
404 404  //UncodedObservationValue//
405 -)))|An observation that has a text value.
406 -| |value|The value of the Uncoded Observation.
407 -| |startTime|This attribute is only used if the textFormat of the Measure is of the Timespan type in the Data Structure Definition (in which case the value field takes a duration).
408 -|TextMeasureValue|(((
406 +)))|(% style="width:454px" %)An observation that has a text value.
407 +|(% style="width:200px" %) |(% style="width:285px" %)value|(% style="width:454px" %)The value of the Uncoded Observation.
408 +|(% style="width:200px" %) |(% style="width:285px" %)startTime|(% style="width:454px" %)This attribute is only used if the textFormat of the Measure is of the Timespan type in the Data Structure Definition (in which case the value field takes a duration).
409 +|(% style="width:200px" %)TextMeasureValue|(% style="width:285px" %)(((
409 409  Inherits from
410 410  //UncodedObservationValue//
411 -)))|An observation that has a localised text value
412 -| |text|The localised text values.
413 -|CodedObservation|(((
412 +)))|(% style="width:454px" %)An observation that has a localised text value
413 +|(% style="width:200px" %) |(% style="width:285px" %)text|(% style="width:454px" %)The localised text values.
414 +|(% style="width:200px" %)CodedObservation|(% style="width:285px" %)(((
414 414  Inherits from
415 415  //ObservationValue//
416 -)))|An Observation that takes its value from a code in a Code list.
417 -| |+valueOf|Association to the Code that is the value of the Observation. Note that this is a conceptual association showing that the Code must exist in the Codelist(s) associated with the Measure(s) in the Data Structure Definition. In the actual Data Set the value of the Code is placed in the Observation.
418 -|//AttributeValue//|(((
417 +)))|(% style="width:454px" %)An Observation that takes its value from a code in a Code list.
418 +|(% style="width:200px" %) |(% style="width:285px" %)+valueOf|(% style="width:454px" %)Association to the Code that is the value of the Observation. Note that this is a conceptual association showing that the Code must exist in the Codelist(s) associated with the Measure(s) in the Data Structure Definition. In the actual Data Set the value of the Code is placed in the Observation.
419 +|(% style="width:200px" %)//AttributeValue//|(% style="width:285px" %)(((
419 419  Abstract class
420 420  Sub classes
421 -//DataAttributeValue// //MetadataAttributeValu e//
422 -)))|Represents the value for any Attribute reported in the Dataset, i.e., Data or Metadata Attribute.
423 -|//DataAttributeValu e//|(((
422 +//DataAttributeValue// //MetadataAttributeValue//
423 +)))|(% style="width:454px" %)Represents the value for any Attribute reported in the Dataset, i.e., Data or Metadata Attribute.
424 +|(% style="width:200px" %)//DataAttributeValue//|(% style="width:285px" %)(((
424 424  Abstract class
425 425  Inherits from
426 426  //AttributeValue//
... ... @@ -427,18 +427,18 @@
427 427  Sub classes
428 428  //UncodedAttributeValue
429 429  CodedAttributeValue//
430 -)))|The value of a Data Attribute, such as the instance of a Coded Attribute or of an Uncoded Attribute in a structure such as a Data Structure Definition.
431 -| |+valueFor|(((
431 +)))|(% style="width:454px" %)The value of a Data Attribute, such as the instance of a Coded Attribute or of an Uncoded Attribute in a structure such as a Data Structure Definition.
432 +|(% style="width:200px" %) |(% style="width:285px" %)+valueFor|(% style="width:454px" %)(((
432 432  Association to the Data Attribute defined in the Data Structure Definition. Note that this is conceptual association as the Concept is identified explicitly in the data set.
433 433  
434 434  The source multiplicity (1..*) indicates the possibility to provide more than one values for a Data Attribute, if the latter allows it.
435 435  )))
436 -|//MetadataAttribute Value//|(((
437 +|(% style="width:200px" %)//MetadataAttributeValue//|(% style="width:285px" %)(((
437 437  (explained further in section
438 438  
439 439  “Metadata Set”)
440 -)))|The value of a Metadata Attribute, as specified in the Metadata Structure Definition, which is linked in the Data Structure Definition
441 -|//UncodedAttributeV alue//|(((
441 +)))|(% style="width:454px" %)The value of a Metadata Attribute, as specified in the Metadata Structure Definition, which is linked in the Data Structure Definition
442 +|(% style="width:200px" %)//UncodedAttributeValue//|(% style="width:285px" %)(((
442 442  Inherits from
443 443  //AttributeValue//
444 444  Sub classes
... ... @@ -445,23 +445,23 @@
445 445  OtherUncodedAttribute
446 446  Value
447 447  TextAttributeValue
448 -)))|
449 -|OtherUncodedAttri buteValue|(((
449 +)))|(% style="width:454px" %)
450 +|(% style="width:200px" %)OtherUncodedAttributeValue|(% style="width:285px" %)(((
450 450  Inherits from
451 -//UncodedObservationVal ue//
452 -)))|An attribute value that has a text value
453 -| |value|The value of the Uncoded attribute.
454 -| |startTime|This attribute is only used if the textFormat of the attribute is of the Timespan type in the Data Structure Definition (in which case the value field takes a duration).
455 -|TextAttributeValu e|(((
452 +//UncodedObservationValue//
453 +)))|(% style="width:454px" %)An attribute value that has a text value
454 +|(% style="width:200px" %) |(% style="width:285px" %)value|(% style="width:454px" %)The value of the Uncoded attribute.
455 +|(% style="width:200px" %) |(% style="width:285px" %)startTime|(% style="width:454px" %)This attribute is only used if the textFormat of the attribute is of the Timespan type in the Data Structure Definition (in which case the value field takes a duration).
456 +|(% style="width:200px" %)TextAttributeValue|(% style="width:285px" %)(((
456 456  Inherits from
457 457  //UncodedAttributeValue//
458 -)))|An attribute that has a localised text value
459 -| |text|The localised text values.
460 -|CodedAttributeVal ue|(((
459 +)))|(% style="width:454px" %)An attribute that has a localised text value
460 +|(% style="width:200px" %) |(% style="width:285px" %)text|(% style="width:454px" %)The localised text values.
461 +|(% style="width:200px" %)CodedAttributeValue|(% style="width:285px" %)(((
461 461  Inherits from
462 462  //AttributeValue//
463 -)))|An attribute that takes it value from a Code in Code list.
464 -| |+valueOf|Association to the Code that is the value of the Attribute Value. Note that this is a conceptual association showing that the Code must exist in the Code list associated with the Data Attribute in the Data Structure Definition. In the actual Data Set the value of the Code is placed in the Attribute Value.
464 +)))|(% style="width:454px" %)An attribute that takes it value from a Code in Code list.
465 +|(% style="width:200px" %) |(% style="width:285px" %)+valueOf|(% style="width:454px" %)Association to the Code that is the value of the Attribute Value. Note that this is a conceptual association showing that the Code must exist in the Code list associated with the Data Attribute in the Data Structure Definition. In the actual Data Set the value of the Code is placed in the Attribute Value.
465 465  
466 466  ----
467 467