Skip to Content
Last modified by Artur on 2025/09/10 11:19
From version 5.7
edited by Helena
on 2025/05/22 11:27
Change comment: There is no comment for this version
To version 5.3
edited by Helena
on 2025/05/22 11:23
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -188,10 +188,12 @@
188 188  
189 189  === {{id name="_Toc371036"/}}7.4.2 Explanation of the Diagram ===
190 190  
191 -==== 7.4.2.1 Narrative ====
191 +**7.4.2.1 Narrative**
192 192  
193 -Note that the MetadataSet must conform to the MetadataStructureDefinition associated to the MetadataflowDefinition for which this MetadataSet is an “instance of metadata”. Whilst the model shows the association to the classes of the MetadataStructureDefinition, this is for conceptual purposes to show the link to the MetadataStructureDefinition. In the actual MetadataSet as exchanged there must, of course, be a reference to the MetadataStructureDefinition and the ReportStructure, and optionally a MetadataflowDefinition, but the MetadataStructureDefinition is not necessarily exchanged with the metadata. Therefore, the MetadataStructureDefinition classes are shown in the grey areas, as these are not a part of the MetadataSet itself.
193 +Note that the MetadataSet must conform to the MetadataStructureDefinition associated to the MetadataflowDefinition for which this MetadataSet is an “instance of metadata”. Whilst the model shows the association to the classes of the MetadataStructureDefinition, this is for conceptual purposes to show the link to the
194 194  
195 +MetadataStructureDefinition. In the actual MetadataSet as exchanged there must, of course, be a reference to the MetadataStructureDefinition and the ReportStructure, and optionally a MetadataflowDefinition, but the MetadataStructureDefinition is not necessarily exchanged with the metadata. Therefore, the MetadataStructureDefinition classes are shown in the grey areas, as these are not a part of the MetadataSet itself.
196 +
195 195  An organisation playing the role of DataProvider can be responsible for one or more MetadataSet.
196 196  
197 197  A MetadataSet comprises one or more MetadataReport, each of which must be for the same ReportStructure. It references both a MetadataTarget, defined in the MetadataStructureDefinition, and contains a TargetObjectKey and ReportedAttributes.
... ... @@ -202,20 +202,21 @@
202 202  
203 203  * TargetDataKey – this can contain:
204 204  ** a SeriesKey (set of dimension values)
205 -** a SeriesKey plus a value or values (giving time range) for the TimeDimension (TimeDimensionValue)
206 -** a value of values for the TimeDimension
207 -* TargetIdentifiableObject – this identifies any identifiable object (which includes both Maintainable and Identifiable objects
208 -* TargetDataSet – this identifies a DataSet
209 -* TargetReportPeriod – this specifies the report period for the Report
207 +** a SeriesKey plus a value or values (giving time range) for the
210 210  
211 -A simple text value for the //ReportedAttribute// uses the //NonEnumeratedAttributeValue //sub class of //ReportedAttribute// whilst a coded value uses the EnumeratedAttributeValue sub class.
209 +TimeDimension (TimeDimensionValue) o a value of values for the TimeDimension
212 212  
211 +* TargetIdentifiableObject -this identifies any identifiable object (which includes both Maintainable and Identifiable objects  TargetDataSet – this identifies a DataSet
212 +* TargetReportPeriod – this specifies the report period for the Report A simple text value for the //ReportedAttribute// uses the //NonEnumeratedAttributeValue  //sub class of //ReportedAttribute// whilst a coded value uses the EnumeratedAttributeValue sub class.
213 +
213 213  The //NonEnumeratedAttributeValue// can be one of:
214 214  
215 215  * XHTMLAttributeValue – the content is XHTML
216 216  * TextAttributeValue – the content is textual and may contain the text in multiple languages
217 -* OtherNonEnumeratedAttributeValue – the content is a string value that must conform to the Representation specified for the MetadataAttribute in the MetadataStructureDefinition for the relevant ReportStructure
218 +* OtherNonEnumeratedAttributeValue – the content is a string value that must conform to the Representation specified for the MetadataAttribute in the
218 218  
220 +MetadataStructureDefinition for the relevant ReportStructure
221 +
219 219  The EnumeratedAttributeValue contains a value for a Code specified as the
220 220  
221 221  Representation for the MetadataAttribute in the MetadataStructureDefinition for the relevant ReportStructure.
... ... @@ -222,87 +222,98 @@
222 222  
223 223  ==== 7.4.2.2 Definitions ====
224 224  
225 -(% style="width:1118.29px" %)
226 -|(% style="width:166px" %)**Class**|(% style="width:227px" %)**Feature**|(% style="width:716px" %)**Description**
227 -|(% style="width:166px" %)MetadataSet|(% style="width:227px" %) |(% style="width:716px" %)Any organised collection of metadata.
228 -|(% style="width:166px" %) |(% style="width:227px" %)reportingBegin|(% style="width:716px" %)A specific time period in a known system of time periods that identifies the start period of a report.
229 -|(% style="width:166px" %) |(% style="width:227px" %)reportingEnd|(% style="width:716px" %)A specific time period in a known system of time periods that identifies the ebd period of a report.
230 -|(% style="width:166px" %) |(% style="width:227px" %)dataExtractionDate|(% style="width:716px" %)A specific time period that identifies the date and time that the data are extracted from a data source.
231 -|(% style="width:166px" %) |(% style="width:227px" %)validFrom|(% style="width:716px" %)Indicates the inclusive start time indicating the validity of the information in the data set.
232 -|(% style="width:166px" %) |(% style="width:227px" %)validTo|(% style="width:716px" %)Indicates the inclusive end time indicating the validity of the information in the metadata set.
233 -|(% style="width:166px" %) |(% style="width:227px" %)publicationYear|(% style="width:716px" %)Specifies the year of publication of the data or metadata in terms of whatever provisioning agreements might be in force.
234 -|(% style="width:166px" %) |(% style="width:227px" %)publicationPeriod|(% style="width:716px" %)Specifies the period of publication of the data or metadata in terms of whatever provisioning agreements might be in force.
235 -|(% style="width:166px" %) |(% style="width:227px" %)setId|(% style="width:716px" %)Provides an identification of the metadata set.
236 -|(% style="width:166px" %) |(% style="width:227px" %)action|(% style="width:716px" %)Defines the action to be taken by the recipient system (update, replace, delete)
237 -|(% style="width:166px" %) |(% style="width:227px" %)+describedBy|(% style="width:716px" %)Associates a Metadataflow Definition to the Metadata Set.
238 -|(% style="width:166px" %) |(% style="width:227px" %)+structuredBy|(% style="width:716px" %)Associates the Metadata Structure Definition that defines the structure of the Metadata Set. Note that the Metadata Structure Definition is the same as that associated (nonmandatory) to the Metadataflow Definition.
239 -|(% style="width:166px" %) |(% style="width:227px" %)+publishedBy|(% style="width:716px" %)Associates the Data Provider that reports/publishes the metadata.
240 -|(% style="width:166px" %) |(% style="width:227px" %)+describedBy|(% style="width:716px" %)Reference to the Report Structure.
241 -|(% style="width:166px" %)MetadataReport|(% style="width:227px" %) |(% style="width:716px" %)A set of values for Metadata Attributes defined in a Report Structure of a Metadata Structure Definition.
242 -|(% style="width:166px" %) |(% style="width:227px" %)+attachesTo|(% style="width:716px" %)Associates the object key to which metadata is to be attached.
243 -|(% style="width:166px" %) |(% style="width:227px" %)+target|(% style="width:716px" %)Associates the Metadata Target that defines the target object to which the metadata are to be associated.
244 -|(% style="width:166px" %) |(% style="width:227px" %)+metadata|(% style="width:716px" %)Associates the Reported Attribute values which are to be associated with the object or objects identified by the Target Object Key.
245 -|(% style="width:166px" %)TargetObjectKey|(% style="width:227px" %) |(% style="width:716px" %)Identifies the key of the object to which the metadata are to be attached.
246 -|(% style="width:166px" %) |(% style="width:227px" %)+valueFor|(% style="width:716px" %)(((
228 +|**Class**|**Feature**|**Description**
229 +|MetadataSet| |Any organised collection of metadata.
230 +| |reportingBegin|A specific time period in a known system of time periods that identifies the start period of a report.
231 +| |reportingEnd|A specific time period in a known system of time periods that identifies the ebd period of a report.
232 +| |dataExtractionDate|A specific time period that identifies the date and time that the data are extracted from a data source.
233 +| |validFrom|Indicates the inclusive start time indicating the validity of the information in the data set.
234 +| |validTo|Indicates the inclusive end time indicating the validity of the information in the metadata set.
235 +| |publicationYear|Specifies the year of publication of the data or metadata in terms of whatever provisioning agreements might be in force.
236 +| |publicationPeriod|Specifies the period of publication of the data or metadata in terms of whatever provisioning agreements might be in force.
237 +| |setId|Provides an identification of the metadata set.
238 +| |action|Defines the action to be taken by the recipient system (update, replace, delete)
239 +| |+describedBy|Associates a Metadataflow Definition to the Metadata Set.
240 +| |+structuredBy|Associates the Metadata Structure Definition that defines the structure of the Metadata Set. Note that the Metadata Structure Definition is the same as that associated (nonmandatory) to the Metadataflow Definition.
241 +| |+publishedBy|Associates the Data Provider that reports/publishes the metadata.
242 +| |+describedBy|Reference to the Report Structure.
243 +|MetadataReport| |A set of values for Metadata Attributes defined in a Report Structure of a Metadata Structure Definition.
244 +| |+attachesTo|Associates the object key to which metadata is to be attached.
245 +| |+target|Associates the Metadata Target that defines the target object to which the metadata are to be associated.
246 +| |+metadata|Associates the Reported Attribute values which are to be associated with the object or objects identified by the Target Object Key.
247 +|TargetObjectKey| |Identifies the key of the object to which the metadata are to be attached.
248 +| |+valueFor|(((
247 247  Associates the Metadata Target that identifies the object type and the component structure of the Target Object Key.
248 248  
249 249  Note that this is a conceptual association showing the link to the MSD construct.
250 250  )))
251 -|(% style="width:166px" %) |(% style="width:227px" %)+keyValues|(% style="width:716px" %)Associates the Target Object Values of the Target Object Key.
252 -|(% style="width:166px" %)//TargetObjectValue//|(% style="width:227px" %)(((
253 +| |+keyValues|Associates the Target Object Values of the Target Object Key.
254 +|//TargetObjectValue//|(((
253 253  Abstract class
256 +
254 254  Sub classes are
258 +
255 255  TargetDataKey
256 -TargetIdentifiableObject
257 -TargetDataSet
260 +
261 +TargetIdentifiableObject TargetDataSet
262 +
258 258  TargetReportPeriod
259 -)))|(% style="width:716px" %)The key of an individual object of the type specified in the Metadata Target of the Metadata Structure Definition.
260 -|(% style="width:166px" %) |(% style="width:227px" %)+valueFor|(% style="width:716px" %)(((
264 +)))|The key of an individual object of the type specified in the Metadata Target of the Metadata Structure Definition.
265 +| |+valueFor|(((
261 261  Associates the Target Object for which this value is provided.
262 262  
263 263  Note that this is a conceptual association showing the link to the MSD construct.
264 264  )))
265 -|(% style="width:166px" %)TargetDataKey|(% style="width:227px" %)(((
270 +|TargetDataKey|(((
266 266  Inherits from
272 +
267 267  //TargetObjectValue//
268 -)))|(% style="width:716px" %)The identification of the components and the values that form the data or metadata key.
269 -|(% style="width:166px" %)ComponentValue|(% style="width:227px" %) |(% style="width:716px" %)Collectively contain the identification of the components and the values that form the data key.
270 -|(% style="width:166px" %)value|(% style="width:227px" %) |(% style="width:716px" %)The key value.
271 -|(% style="width:166px" %) |(% style="width:227px" %)+valueFor|(% style="width:716px" %)Associates the Component for which the value is declared.
272 -|(% style="width:166px" %)TimeDimensionValue|(% style="width:227px" %) |(% style="width:716px" %)Contains identification of the Time Dimension and the value.
273 -|(% style="width:166px" %)TargetIdentifiable Object|(% style="width:227px" %)(((
274 +)))|The identification of the components and the values that form the data or metadata key.
275 +|ComponentValue| |Collectively contain the identification of the components and the values that form the data key.
276 +|value| |The key value.
277 +| |+valueFor|Associates the Component for which the value is declared.
278 +|TimeDimensionValue| |Contains identification of the Time Dimension and the value.
279 +|TargetIdentifiable Object|(((
274 274  Inherits from
275 -//TargetObjectValue//
276 -)))|(% style="width:716px" %)Specifies the identification of an Identifiable object.
277 -|(% style="width:166px" %)StructureRef|(% style="width:227px" %) |(% style="width:716px" %)Contains the identification of an Identifiable object.
278 -|(% style="width:166px" %) |(% style="width:227px" %)structureType|(% style="width:716px" %)The object type of the target object.
279 -|(% style="width:166px" %)(((
281 +
282 +//TargetObjectValue    //
283 +)))|Specifies the identification of an Identifiable object.
284 +|StructureRef| |Contains the identification of an Identifiable object.
285 +| |structureType|The object type of the target object.
286 +|(((
280 280  Maintainable
288 +
281 281  ArtefactRef
290 +
282 282  Identifiable
292 +
283 283  ArtefactRef
284 -)))|(% style="width:227px" %) |(% style="width:716px" %)Identification of the target object by means of its identifier constructs i.e agency ID, id, version for Maintainable Object plus, for Identifiable Object, the id.
285 -|(% style="width:166px" %) |(% style="width:227px" %)+containedObject|(% style="width:716px" %)Association to a contained object in a hierarchy of Identifiable Objects such as a Transition in a Process Step.
286 -|(% style="width:166px" %)TargetDataSet|(% style="width:227px" %)(((
294 +)))| |Identification of the target object by means of its identifier constructs i.e agency ID, id, version for Maintainable Object plus, for Identifiable Object, the id.
295 +| |+containedObject|Association to a contained object in a hierarchy of Identifiable Objects such as a Transition in a Process Step.
296 +|TargetDataSet|(((
287 287  Inherits from
298 +
288 288  //TargetObjectValue//
289 -)))|(% style="width:716px" %)Contains the identification of a Data Set
290 -|(% style="width:166px" %)TargetReportPeriod|(% style="width:227px" %)(((
300 +)))|Contains the identification of a Data Set
301 +|TargetReportPeriod|(((
291 291  Inherits from
303 +
292 292  //TargetObjectValue//
293 -)))|(% style="width:716px" %)Contains the period covered by the Metadata Report.
294 -|(% style="width:166px" %)//ReportedAttribute//|(% style="width:227px" %)(((
305 +)))|Contains the period covered by the Metadata Report.
306 +|//ReportedAttribute//|(((
295 295  Abstract class Sub classes are:
308 +
296 296  //NonEnumeratedAttributeValue//
297 -EnumeratedAttributeValue
298 -)))|(% style="width:716px" %)The value for a Metadata Attribute.
299 -|(% style="width:166px" %) |(% style="width:227px" %)+valueFor|(% style="width:716px" %)(((
310 +
311 +EnumeratedAttributeValue//    //
312 +)))|The value for a Metadata Attribute.
313 +| |+valueFor|(((
300 300  Association to the Metadata Attribute in the Metadata Structure Definition that identifies the Concept and allowed Representation for the Reported Attribute.
301 301  
302 302  Note that this is a conceptual association showing the link to the MSD construct. The syntax for the Reported Attribute will state, in some form, the id of the Metadata Attribute.
303 303  )))
304 -|(% style="width:166px" %) |(% style="width:227px" %)+child|(% style="width:716px" %)Association to a child Reported Attribute consistent with the hierarchy defined in the Report Structure for the Metadata Attribute for which this child is a Reported Attribute.
305 -|(% style="width:166px" %)//NonEnumerated AttributeValue//|(% style="width:227px" %)(((
318 +| |+child|Association to a child Reported Attribute consistent with the hierarchy defined in the Report Structure for the Metadata Attribute for which this child is a Reported Attribute.
319 +|//NonEnumerated AttributeValue//|(((
306 306  Inherits from
307 307  
308 308  //ReportedAttribute//
... ... @@ -316,20 +316,20 @@
316 316  //OtherNonEnumerated//
317 317  
318 318  //AttributeValue//
319 -)))|(% style="width:716px" %)The content of a Reported Attribute where this is textual.
320 -|(% style="width:166px" %)XHTMLAttributeValue|(% style="width:227px" %) |(% style="width:716px" %)This contains XHTML.
321 -|(% style="width:166px" %) |(% style="width:227px" %)value|(% style="width:716px" %)The string value of the XHTML.
322 -|(% style="width:166px" %)TextAttributeValue|(% style="width:227px" %) |(% style="width:716px" %)This value of a Reported Attribute where the content is humanreadable text.
323 -|(% style="width:166px" %) |(% style="width:227px" %)text|(% style="width:716px" %)The string value is text. This can be present in multiple language versions.
324 -|(% style="width:166px" %)OtherNonEnumerated AttributeValue|(% style="width:227px" %) |(% style="width:716px" %)The value of a Reported Attribute where the content is not of humanreadable text.
325 -|(% style="width:166px" %) |(% style="width:227px" %)value|(% style="width:716px" %)A text string that is consistent in format to that defined in the Representation of the Metadata Attribute for which this is a Reported Attribute.
326 -|(% style="width:166px" %)EnumeratedAttribute Value|(% style="width:227px" %)(((
333 +)))|The content of a Reported Attribute where this is textual.
334 +|XHTMLAttributeValue| |This contains XHTML.
335 +| |value|The string value of the XHTML.
336 +|TextAttributeValue| |This value of a Reported Attribute where the content is humanreadable text.
337 +| |text|The string value is text. This can be present in multiple language versions.
338 +|OtherNonEnumerated AttributeValue| |The value of a Reported Attribute where the content is not of humanreadable text.
339 +| |value|A text string that is consistent in format to that defined in the Representation of the Metadata Attribute for which this is a Reported Attribute.
340 +|EnumeratedAttribute Value|(((
327 327  Inherits from
328 328  
329 329  //MetadataAttributeValue//
330 -)))|(% style="width:716px" %)The content of a Reported Attribute that is taken from a Code in a Code list.
331 -|(% style="width:166px" %) |(% style="width:227px" %)value|(% style="width:716px" %)The Code value of the Reported Attribute.
332 -|(% style="width:166px" %) |(% style="width:227px" %)+value|(% style="width:716px" %)(((
344 +)))|The content of a Reported Attribute that is taken from a Code in a Code list.
345 +| |value|The Code value of the Reported Attribute.
346 +| |+value|(((
333 333  Association to a Code in the Code list specified in the Representation of the Metadata Attribute for which this Reported Attribute is the value
334 334  
335 335  Note that this shows the conceptual link to the Item that is the value. In reality, the value itself will be contained in the Enumerated Attribute Value.