SWIM Supporting Material

SWIM-DEFN-290 Information definition (minimum)

Owned by WILSON Scott
Last updated: 2024 Jul 11
4 min read

Requirement

Title

Information definition (minimum)

Identifier

SWIM-DEFN-290

Requirement

A service definition shall include or refer to the following information about the exchanged information service payload:

  • the name of the element;

  • the definition of the element;

  • the data type used by the element if applicable; and

  • the semantic correspondence of the element with the AIRM

Rationale

This requirement ensures the service provider knows what information the service has to offer.

This requirement ensures that the precise meaning of the exchanged information is shared by all parties of the information exchange.

Verification

Completeness: Verify that the service description describes all elements of the exchanged information and that the required details are provided.

Consistency: Verify that the elements are consistent with each other and with the AIRM concepts used in the semantic correspondence.

Correctness: Not Applicable.

Examples/Notes

Note: The service definition must describe all elements of the exchanged information at all levels, down from the service operation parameters to attributes and data types.

Note: It is best practice to base the information definition on the requirements found in the EUROCONTROL Specification for SWIM Information Definition [RD 3], ensuring that it contains the extra details required by this requirement.

Note: The information definition can be provided by one or more reference, for example when using an AIRM [RD 6] conformant standardised information exchange model, such as Aeronautical Information Exchange Model 5.1.1 (AIXM) [RD 9] and ICAO Meteorological Information Exchange Model (IWXXM) 3.0.0 [RD 10].

Example based on Aeronautical Information Request Service - Service Definition [RD 17]:

  • The service shall offer features defined in the Aeronautical Information Exchange Model (AIXM) 5.1.1.

  • The service shall offer the subset of AIXM features listed: AircraftStand, AirportHeliport, Airspace…

  • The service may offer AIXM 5.1.1 features not listed above.

  • The service may offer features to be found in published AIXM 5.1.1. extensions that conform with the EUROCONTROL Specification for SWIM Information Definitions.

Level of
Implementation

Mandatory

Guidance

This requirements sets out the minimum detail needed to describe each element of the information that is exchanged. For example, if the exchange involves information about "aerodromes" the "aerodrome" element type should be described. This means the element type should be given a name, a description, etc. based on the bulleted list in the requirement. The result is called an information definition.

Most of the details required are self-explanatory. The semantic correspondence of the element type with the AIRM is established following the requirements found in the Guidance on semantic correspondence section of the SWIM Information Definition Handbook.

The information definition should be complete, covering all of the element types that are exchanged, including a definition of service operation parameters, attributes and data types. However, the information definition can be provided in several ways e.g.:

  • embedded into the service description

  • by reference to an external document

  • by reference to a standardised information exchange model.

Regardless of the option chosen, the information definition shall follow the semantic correspondence requirements in the EUROCONTROL Specification for SWIM Information Definition in order to provide evidence of its AIRM conformance.

Best Practice

It is best practice to base the information definition on the requirements found in the EUROCONTROL Specification for SWIM Information Definition, ensuring that it also contains the extra details required by this requirement.

Format of information definitions

The EUROCONTROL Specification for SWIM Information Definition does not require a specific format for an information definition. Some example formats are provided at SWIM-INFO-001 Need for information definitions. From a service description perspective this allows a degree of flexibility. For example, a JSON schema or XML schema is an acceptable mean of compliance if the schema provides all required information.

The EUROCONTROL Specification for SWIM Information Definition requires less detail to be provided for each element type: SWIM-INFO-007 Information definition concepts requires only a name, definition and (if needed) a data type.

However, the specification also goes beyond what is asked for by the EUROCONTROL Specification for SWIM Service Description. For example, it requires that each element type has a unique identifier (SWIM-INFO-008 Unique identifiers for concepts) and a dedicated namespace.

Verification Support

Completeness

Check that:

[  ] The service definition includes or refers to information about the exchanged information service payload.

[  ] The  information about the exchanged information service payload includes the name of the elements.

[  ] The  information about the exchanged information service payload includes the definition of the elements.

[  ] The  information about the exchanged information service payload includes the data type used by the elements if applicable.

[  ] The  information about the exchanged information service payload includes the semantic correspondence of the elements with the AIRM.

Consistency

Check that:

[  ] The elements are consistent with each other and with the AIRM concepts used in the semantic correspondence.

Examples

Links to example service definitions can be found in the example service definitions page. 

Status: Living Material