service definitions

Aeronautical Data Set Information Definition

This page is the information definition for the various Aeronautical Data Set Services. It follows the requirements found in the Specification for SWIM Information Definition v1.0.

Diagrams

Diagrams to illustrate the information definition are available on Aeronautical Data Set Information Definition Diagrams.


identification

titleAeronautical Data Set Information Definition
edition01.00.00
date2024-09-23

responsible party

organisation name

EUROCONTROL
contact informationais.aixm@eurocontrol.int
roleauthor

scope

abstractThe information definition covers the elements used by the various Aeronautical Data Set Services such as data product, data product series and data product specification.

namespace

namespacetbd

licence

BSD Licence

Copyright (c) 2024, EUROCONTROL
=====================================
All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
    * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
    * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
    * Neither the names of EUROCONTROL nor the names of their contributors may be used to endorse or promote products derived from this specification without specific prior written permission.

THIS SPECIFICATION IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
==========================================
Editorial note: this license is an instance of the BSD license template as
provided by the Open Source Initiative:
http://www.opensource.org/licenses/bsd-license.php

data catalogue

Resource

Feature

Attribute

Type, Multiplicity

Identifier

Definition

Resource



Resource
asset or means that fulfils a requirement
EXAMPLE Data set, service, document, person or organization.

Note: The Resource is the root for DataSet, DataSetSeries, DataProductSpecification, Notification, Subscription and File. Therefore these also have identifier and title.

Resource

identifier

IdentifierType

Resource.identifier

Special unique identifier permanently assigned to a resource.

Resource

title

string

Resource.title

Name by which the cited resource is known.

DataProductSpecification

Inherits from Resource.

Feature

Attribute

Type, Multiplicity

Identifier

Definition

DataProductSpecification



DataProductSpecificationDetailed description of a data set or data set series together with additional information that will enable it to be created, supplied to and used by another party. (ISO 19131)
DataProductSpecification

dataSetSeriesIdentifier

IdentifierType

DataProductSpecification.dataSetSeriesIdentifier

Identifier of the corresponding data set series.

DataProductSpecification

dpsFile

File [1..*]

DataProductSpecification.dpsFile

File that makes up the data product specification.

DataProductSpecification

releaseType

CodeReleaseType

DataProductSpecification.releaseType

Indication of the content of the data sets described by the data product specification.

DataProductSpecification

status

CodeResourceStatusType

DataProductSpecification.status

Status of the data product specification.

DataSet

Inherits from Resource.


Attribute

Type, Multiplicity

Identifier

Definition

DataSet



DataSetIdentifiable collection of data (ISO 19101*)
DataSet

conformance

CodeEncodingStandardType

DataSet.conformance

Standard to which the data conforms.

Note: the value specified for a data set must not conflict with that defined for the parent data set series.

DataSet

dataSetFile

File [1..*]

DataSet.dataSetFile

File that makes up a data set.

Note: a data set can consist of multiple files e.g. organised by subject or to reduce the size of individual files.

DataSet

dataSetSeriesIdentifier

IdentifierType

DataSet.dataSetSeriesIdentifier

Identifier of the data set series to which the data set belongs.

DataSet

description

string

DataSet.description

Brief narrative summary of the content of the resource(s).

DataSet

endValidity

date

DataSet.endValidity

End of the validity period for the data set.

Note: it is possible to set this to "indeterminatePosition" if the end of validity date is not known.

DataSet

form

CodeDataSetFormType

DataSet.form

Form of the data set.

Note: the value specified for a data set must not conflict with that defined for the parent data set series.

DataSet

geographicalExtent

Location [1..*]

DataSet.geographicalExtent

Location defining the scope of the data set.

Note: the value specified for a data set must not conflict with that defined for the parent data set series.

DataSet

isAiracUpdate

boolean

DataSet.isAiracUpdate

Indication that the data set has been updated according to the AIRAC System.

Note: Typically this attribute is only marked as "true" for AIP data sets.

DataSetproviderstring [0..1]DataSet.providerName of the organisation that provided the data set.
DataSet

publicationDate

date

DataSet.publicationDate

Date at which the data set became available.

DataSet

releaseType

CodeReleaseType

DataSet.releaseType

Indication of the content of the data set.

DataSet

startValidity

date

DataSet.startValidity

Start of the validity period for the data set.

DataSet

status

CodeResourceStatusType

DataSet.status

Status of the data set.

DataSet

subject

SubjectType [1..*]

DataSet.subject

Data subject covered by the data set.

Note: the value specified for a data set must not conflict with that defined for the parent data set series.

DataSet

useLimitations

string [0..1]

DataSet.useLimitations

Limitations with regard to the use of the data set.

Note: the value specified for a data set must not conflict with that defined for the parent data set series.

DataSetSeries

Inherits from Resource.

Feature

Attribute

Type, Multiplicity

Identifier

Definition

DataSetSeries



DataSetSeriesCollection of data sets sharing the same product specification (ISO 19115*)
DataSetSeries

conformance

CodeEncodingStandardType
[1..*]

DataSetSeries.conformance

Standard to which the data conforms.

DataSetSeries

description

string

DataSetSeries.description

Brief narrative summary of the content of the resource(s).

DataSetSeries

dpsIdentifier

IdentifierType

DataSetSeries.dpsIdentifier

Identifier of the data product specification that describes the data set series.

DataSetSeries

form

CodeDataSetFormType [1..*]

DataSetSeries.form

Form of the data sets contained in the data set series.

DataSetSeries

geographicalExtent

Location [1..*]

DataSetSeries.geographicalExtent

Location defining the scope of the data set series.

DataSetSeriesmilitaryOrCivilProviderCodeProviderType [0..1]DataSetSeries.militaryOrCivilProviderIndication if the data sets in the data set series are produced by military or civil organisations.
DataSetSeries

releaseType

CodeReleaseType

DataSetSeries.releaseType

Indication of the content of the data sets within the data set series.

DataSetSeries

status

CodeResourceStatusType

DataSetSeries.status

Status of the data set series.

DataSetSeries

subject

SubjectType [1..*]

DataSetSeries.subject

Data subject covered by the data set series.

DataSetSeries

useLimitations

string [0..1]

DataSetSeries.useLimitations

Limitations with regard to the use of the data set series.

File

Inherits from Resource.

Feature

Attribute

Type, Multiplicity

Identifier

Definition

File



FileMetadata about a file.
File

format

CodeFileFormatType

File.format

Format of the file.

File

size

double

File.size

Size of the file in Bytes.

Location

FeatureAttributeType, MultiplicityIdentifierDefinition

Location



Location
Geographical location used to express the geographical scope of a data set or data set series.

Note: Location is the root for Aerodrome, Airspace and State

Aerodrome

Inherits from Location.

Feature

Attribute

Type, Multiplicity

Identifier

Definition

Aerodrome



AerodromeA defined area on land or water (including any buildings, installations and equipment) intended to be used either wholly or in part for the arrival, departure and surface movement of aircraft.
Aerodrome

designator

string [0..1]

Aerodrome.designator

Designator for an aerodrome.

Aerodrome

designatorIATA

string [0..1]

Aerodrome.designatorIATA

Identifier that is assigned to a location in accordance with rules (resolution 767) governed by the International Air Transport Association (IATA).

Aerodrome

name

string

Aerodrome.name

Primary official name of an aerodrome as designated by an appropriate authority.

Airspace

Inherits from Location.

Feature

Attribute

Type, Multiplicity

Identifier

Definition

Airspace



AirspaceA defined three dimensional region of space relevant to air traffic.
Airspace

designator

string

Airspace.designator

Published sequence of characters allowing the identification of the airspace.

Airspace

name

string [0..1]

Airspace.name

Name given to an airspace by a responsible authority.

Airspace

type

CodeAirspaceType [0..1]

Airspace.type

Indicator of the general structure or characteristics of a particular airspace.

State

Inherits from Location.

Feature

Attribute

Type, Multiplicity

Identifier

Definition

State



StateAn internationally recognized geographic entity that provides air traffic service.
StateicaoNationalityLettersstring [0..1]

State.icaoNationalityLetters

Nationality letters as defined by ICAO.
State

isoCountryCode

string [0..1]

State.isoCountryCode

Country codes as defined by ISO.

State

name

string

State.name

Full official name of the state.

State

territory

string [0..1]

State.territory

Name of the territory within the state.

Notification

Inherits from Resource.

Feature

Attribute

Type, Multiplicity

Identifier

Definition

Notification



NotificationA notification when an event has occurred.
Notification

creationDate

date

Notification.creationDate

Date on which the notification was created.

NotificationdataSetIdentifier

IdentifierType [0..1]

Notification.dataSetIdentifier

Identifier of the data set which the notification concerns.

NotificationdataSetSeriesIdentifier

IdentifierType [0..1]

Notification.dataSetSeriesIdentifier

Identifier of the data set series which the notification concerns.

Notification

eventKind

CodeEventKindType

Notification.eventKind

Type of event that triggered the notification.

Notification

lastModificationDate

date

Notification.lastModificationDate

Date on which the notification was last modified.

Notification

messageText

string

Notification.messageText

Plain text notification message.

Example:  A new data set has been added. You can see the new data set at: http://...
Example:  The yyy data set series has been modified. You can see the modifications at: http://

Notification

status

CodeNotificationStatusType

Notification.status

Status of the notification.

Notification

subscriptionIdentifier

IdentifierType [0..1]

Notification.subscriptionIdentifier

Identifier of the subscription.

SelectionCriterion

Feature

Attribute

Type, Multiplicity

Identifier

Definition

SelectionCriterion



SelectionCriterionCriterion to select notifications to be sent as part of a subscription.
SelectionCriterion

field

string

SelectionCriterion.field

Name of the field to use in the selection.

SelectionCriterion

operator

CodeOperatorType

SelectionCriterion.operator

Operator to use.

SelectionCriterion

value

string

SelectionCriterion.value

Value to use.

Subscription

Inherits from Resource.

Feature

Attribute

Type, Multiplicity

Identifier

Definition

Subscription



SubscriptionA subscription, based on the selection criteria, to data set series and data sets.
Subscription

creationDate

date

Subscription.creationDate

Date on which the subscription was created.

Subscription

eventKind

CodeEventKindType

Subscription.eventKind

Type of event to be notified when the criterion is met.

Subscription

lastModificationDate

date

Subscription.lastModificationDate

Date on which the subscription was last modified.

Subscription

selectionCriterion

SelectionCriterion [1..*]

Subscription.selectionCriterion

Criterion to be used to select the notifications to be received.

Subscription

status

CodeSubscriptionStatusType

Subscription.status

Status of the subscription.

Subscription

userIdentifier

IdentifierType

Subscription.userIdentifier

Identifier of the subscriber.

simple types

FileNameType - string

Name of the file.

Note: Rules on file naming conventions are available at https://ext.eurocontrol.int/aixm_confluence/display/ACGAIP/Data+set+files and https://ext.eurocontrol.int/aixm_confluence/display/CGWIP/Data+set+files

IdentifierType - string

An identifier used to identify one instance of an entity within an identification scheme that is managed by a formal organisation.

SubjectType - anyURI

The theme/subject area the resource covers.

Example: https://airm.aero/developers/advanced-search/1.0.0/Airspace?model=LogicalModel

Attribute

Type, Multiplicity

Definition

scheme

string [0..1]

The scheme in which the theme/subject definition can be found.

CodeAirspaceType

CodelistAttributeTypeIdentifierDefinition

CodeAirspaceType



CodeAirspaceTypeA coded list of values that indicates a type of airspace.
CodeAirspaceTypeNASstringCodeAirspaceType.NAS

National Airspace System.

[note: The airspace within which a State provides Air Traffic Services is usually composed of:1) the territories over which the State has jurisdiction;2) those portions of the airspace over the high seas or in airspace of undetermined sovereignty where the provision of ATS are provided as determined by regional agreements. It can usually be determined by the UNION of FIRs (including, where appropriate, NO-FIRs) of the UNION of NAS-P. .]

CodeAirspaceTypeFIRstringCodeAirspaceType.FIR

Flight information region. Airspace of defined dimensions within which flight information service and alerting service are provided.

Description:

ICAO Recognized.

Might, for example, be used if service provided by more than one unit.

CodeAirspaceTypeTMAstringCodeAirspaceType.TMA

Terminal control area. Control area normally established at the confluence of ATS routes in the vicinity of one or more major aerodromes.

Description:

Non-ICAO Recognized.

Mainly used in Europe under the Flexible Use of Airspace concept.

CodeAirspaceTypeOTHERstringCodeAirspaceType.OTHEROther

CodeDataSetFormType

Codelist

Attribute

TypeIdentifier

Definition

CodeDataSetFormType



CodeDataSetFormTypeThe form of the data set.
Note: The different forms of ICAO data sets are listed in ICAO Annex 15 5.3.1.1:
a) AIP data set;
b) terrain data sets;
c) obstacle data sets;
d) aerodrome mapping data sets; and
e) instrument flight procedure data sets.
CodeDataSetFormType

AIP

stringCodeDataSetFormType.AIP

AIP data set

CodeDataSetFormType

OBSTACLE

stringCodeDataSetFormType.OBSTACLE

obstacle data set

CodeDataSetFormType

TERRAIN

stringCodeDataSetFormType.TERRAIN

terrain data set

CodeDataSetFormType

AERODROME_MAPPING

stringCodeDataSetFormType.AERODROME_MAPPING

aerodrome mapping data set

CodeDataSetFormType

IFP

stringCodeDataSetFormType.IFP

instrument flight procedure data set

CodeDataSetFormType

OTHER

stringCodeDataSetFormType.OTHER

A data set not found in the list of ICAO data sets.

CodeEncodingStandardType

Codelist

Attribute

TypeIdentifier

Definition

CodeEncodingStandardType



CodeEncodingStandardTypeThe standard used for encoding the data.
CodeEncodingStandardType

AIXM_5_1_1

stringCodeEncodingStandardType.AIXM_5_1_1

Aeronautical Information Exchange Model (AIXM) 5.1.1

CodeEncodingStandardTypeAIXM_5_2stringCodeEncodingStandardType.AIXM_5_2Aeronautical Information Exchange Model (AIXM) 5.2
CodeEncodingStandardTypeARINC_424stringCodeEncodingStandardType.ARINC_424ARINC 424
CodeEncodingStandardType

OTHER

stringCodeEncodingStandardType.OTHEROther

CodeEventKindType

Codelist

Attribute

TypeIdentifier

Definition

CodeEventKindType



CodeEventKindTypeThe event that has triggered a notification to be sent to a subscriber.
Note: the following events are not listed as no notification is sent to a subscriber concerning them: updated data sets, withdrawn data sets, withdrawn data set series.
CodeEventKindType

NEW_DATA_SET

stringCodeEventKindType.NEW_DATA_SET

A new data set entry with metadata and one or more data set files.

CodeEventKindType

NEW_DATA_SET_SERIES

stringCodeEventKindType.NEW_DATA_SET_SERIES

A new data set series entry with metadata.

CodeEventKindType

MODIFIED_DATA_SET_SERIES

stringCodeEventKindType.MODIFIED_DATA_SET_SERIES

An update of data set series metadata and/or an updated data product specification file.

CodeEventKindType

REMOVED_DATA_SET_SERIES

stringCodeEventKindType.REMOVED_DATA_SET_SERIES

A data set series is marked as expired and data sets will no longer be added. The data set series is no longer available in queries.

CodeEventKindType

ALL_EVENTS

stringCodeEventKindType.ALL_EVENTS

All of the other events.

CodeFileFormatType

Codelist

Attribute

TypeIdentifier

Definition

CodeFileFormatType



CodeFileFormatTypeThe format of the file (as can often be derived from the file extension, but not always).
CodeFileFormatType

XML

stringCodeFileFormatType.XML

Extensible Markup Language

CodeFileFormatType

CSV

stringCodeFileFormatType.CSV

Comma Separated Values

CodeFileFormatType

XLS

stringCodeFileFormatType.XLS

Microsoft Excel spreadsheet

CodeFileFormatType

PDF

stringCodeFileFormatType.PDF

Portable Document Format

CodeFileFormatTypeJSONstringCodeFileFormatType.JSONJavaScript Object Notation
CodeFileFormatType

OTHER

stringCodeFileFormatType.OTHER

Other file format.

CodeNotificationStatusType

Codelist

Attribute

TypeIdentifier

Definition

CodeNotificationStatusType



CodeNotificationStatusTypeIndication of the status of the Notification.
CodeNotificationStatusType

ACTIVE

stringCodeNotificationStatusType.ACTIVE

The notification is active.

CodeNotificationStatusType

ACKNOWLEDGED

stringCodeNotificationStatusType.ACKNOWLEDGED

The notification has been acknowledged.

CodeOperatorType

Codelist

Attribute

TypeIdentifier

Definition

CodeOperatorType



CodeOperatorType

The operator to apply to the selection criterion.

CodeOperatorType

LIKE

stringCodeOperatorType.LIKE

Like

CodeOperatorType

EQUALS

stringCodeOperatorType.EQUALS

Equals

CodeProviderType

Codelist

Attribute

TypeIdentifier

Definition

CodeProviderType



CodeProviderTypeA code distinguishing between military and civil status.
CodeProviderType

JOINT

stringCodeProviderType.JOINT

Both civil and military.

CodeProviderType

CIVIL

stringCodeProviderType.CIVIL

Civil.

CodeProviderTypeMILstringCodeProviderType.MILMilitary.
CodeProviderTypeOTHERstringCodeProviderType.OTHEROther.

CodeReleaseType

Codelist

Attribute

TypeIdentifier

Definition

CodeReleaseType



CodeReleaseTypeIndication if the data set has full content or represents an update.
CodeReleaseType

BASELINE_DS

stringCodeReleaseType.BASELINE_DS

The data set contains all and only Baseline TimeSlices that are valid or start their validity at the start of validity of the data set. No Baselines that end their validity. No Tempdelta, no exceptions (such as Baselines that start their validity a few days after the AIRAC date).

CodeReleaseType

BASELINE_DIFFERENCES_DS

stringCodeReleaseType.BASELINE_DIFFERENCES_DS

The data set contains only the differences in the form of BASELINES (new ones and the ones that ended their validity). Optionally, it can include also PERMDELTA TimeSlices for the same purpose, which have the advantage that they can indicate a bit more precisely the location of the change.

CodeReleaseType

SUPPLEMENTARY_DIFFERENCES_DS

stringCodeReleaseType.SUPPLEMENTARY_DIFFERENCES_DS

The data set contains the equivalent of AIP SUP - TEMPDELTA with long validity, New BASELINE with known end of validity. Exceptions from the AIRAC cycle.

CodeResourceStatusType

Codelist

Attribute

TypeIdentifier

Definition

CodeResourceStatusType



CodeResourceStatusTypeIndication of the status of the Resource.
CodeResourceStatusType

EXPIRED

stringCodeResourceStatusType.EXPIRED

The resource has expired.

CodeResourceStatusType

CANCELLED

stringCodeResourceStatusType.CANCELLED

The resource was cancelled.

CodeResourceStatusType

VALID

stringCodeResourceStatusType.VALID

The resource is valid.

CodeSubscriptionStatusType

Codelist

Attribute

TypeIdentifier

Definition

CodeSubscriptionStatusType



CodeSubscriptionStatusTypeIndication of the status of the Subscription.
CodeSubscriptionStatusType

ACTIVE

stringCodeSubscriptionStatusType.ACTIVE

The subscription has been created and messages are being queued in the subscriber's queue.

CodeSubscriptionStatusType

PAUSED

stringCodeSubscriptionStatusType.PAUSED

The subscription has been created but messages are not being queued in the subscriber's queue.

CodeSubscriptionStatusType

DELETED

stringCodeSubscriptionStatusType.DELETED

The subscription and the queue have been deleted.