SWIM Supporting Material

SWIM-INFO-003 Information definition identification

Owned by WILSON Scott
Last updated: 2020 Jan 14
Page Table of Content

Requirement

 Requirement [+]

Title

Information definition identification

Identifier

SWIM-INFO-003

Requirement

An information definition shall have:
  • a title by which it is known;
  • an edition; and
  • a reference date for use in citing the information definition.

Rationale

This requirement supports the identification and citation of an information definition.

Verification

Completeness

Examples/Notes

Example: “Aerodrome Mapping Exchange Model (AMXM), 2.0.0, 2015-08-24” [RD 12].

Example: Identification information contained in a service description.

Level of Implementation

Mandatory

Guidance

The ability to provide an exact citation, a standardised reference to the information definition, is very basic. It is hard to envisage interoperability being supported without it.

Examples of where information definitions can be cited are:

  • service descriptions
  • SWIM registries
  • academic papers


The specification caters for the fact that information definitions are often contained in service descriptions.  The identification information can, in effect, be assumed to be the same as for the service being described in a service description. This will avoid unnecessary duplication.

Verification Support

Completeness

Check that:

[  ] The information definition has a title.

[  ] The information definition has an edition.

[  ] The information definition has a reference date.

Examples

The example below shows how the identification information can be embedded into an XML schema. It makes use the annotation element within the XML schema definition language.

The current examples mirror the structure of the specification on purpose without implying that this would be a real-world implementation example.

A complete example is available at: complete example.

Example of SWIM-INFO-003
<xs:annotation>
 <xs:documentation>
  <identification>
   <title>Donlon TOBT Setting Service Information Definition</title>
   <edition>0.93</edition>
   <date>2018-10-17</date>
  </identification>
 </xs:documentation>
</xs:annotation>

Status: Living Material