Requirement

Title

Service standard reference

Identifier

SWIM-SERV-010

Requirement

A service description shall include 

  • a statement indicating whether the service adheres to a service standard; and if so,
  • a reference to the service standard;
  • a statement on any implemented options of the service standard; and
  • a statement on any deviation from the service standard.

Rationale

The reference to standards is essential information, fostering reuse.

Verification

Completeness: Verify that the statement about adherence to a reference standard is included.

Consistency: If the service adheres to a service standard, verify that the reference to the service standard is included.

Correctness: Not Applicable.

Examples/Notes

Example service standard references:

  • “EUROCAE Arrival Sequence standardised service design, version 1.0”;
  • “Not adherent to a service standard”.

Level of Implementation

Mandatory


Guidance

Examples

See the Service Standard Reference section within the Donlon TOBT Setting Service Description.

Guidance for JSON service description 

Schema

The guidance concerns JSON Schema v0.0.3 (see Schema releases).

		"serviceDescriptionReferences":
				{
					"description" : "A container for references to documents describing specific aspects of the service instance.",
					"$ref" : "#/definitions/ServiceDescriptionReferences"
				}


		"ServiceDescriptionReferences" : 
		{
			"description" : "References to complementary documents that provide additional details about the service.",
			"type": "object",
			"additionalProperties": false,
			"required": ["implementedStandard"],
			"properties":
			{
				"implementedStandard":
				{
					"description" : "A standard used for the implementation of the service.",
					"type" : "array",
					"items" : { "$ref":"#/definitions/ImplementedStandard" },
					"minItems": 1
				},
				...
			}
		},


		"ImplementedStandard" : 
		{
			"description" : "A standard used for the implementation of the service.",
			"type": "object",
			"additionalProperties": false,
			"required": ["standardType", "isConformant"],
			"properties":
			{
				"standardType":
				{
					"description" : "The type of implemented standard.",
					"$ref" : "#/definitions/CodeServiceStandardType"
				},
				"isConformant":
				{
					"description" : "An indication whether the information service conforms to a reference. [SWIM-SERV-010]",
					"type" : "boolean"
				},
				"title":
				{
					"description" : "The name by which the document is formally known. [SWIM-SERV-005;SWIM-SERV-010]",
					"type" : "string",
					"minLength":1
				},
				"version":
				{
					"description" : "The current version or revision level of the document.",
					"type" : "string"
				},
				"conformanceStatement":
				{
					"description" : "A statement about the degree of conformance of the service against the standard.",
					"type" : "string",
					"minLength":1
				},
				"description":
				{
					"description" : "The description of the entity.",
					"type" : "string",
					"minLength":1
				},
				"reference":
				{
					"description" : "An external reference at which the standard can be retrieved or consulted.",
					"type" : "string"
				}
			}
		},

Rules expressed for the cases as defined in Registry URD.

caserules
COMPLIANTmandatory
CANDIDATEsame
DEFINITION(not relevant)

Guidance

Within "implementedStandard" field (itself within "serviceDescriptionReferences" field) create one instance of the ImplementedStandard type.

Two cases must be distinguished when filling that structure, depending on whether the service adheres to a service standard or not.


implementedStandard is designed to cover other needs. This guidance focuses on SWIM-SERV-010 only.

Case 1 - The service adheres to a service standard

attribute namedescriptionruleguidance
standardTypeThe type of implemented standard.Mandatory

Select code value SERVICE_STANDARD.

isConformant An indication whether the information service conforms to a reference. [SWIM-SERV-010]Mandatoryselect code value true
titleThe name by which the document is formally known.Mandatory

provide the name of the service standard or the title of the service standard document.

version

The current version or revision level of the document.

Mandatory

makes clear the version of the service standard this service version adheres to.

conformanceStatement A statement on any implemented options or deviation from the standard.Mandatory Conditional

state implemented options of the service standard, if any

state deviation from the service standard, if any

descriptionThe description of the entity.Optional

optionally provide a description of the service standard.

referenceAn external reference at which the standard can be retrieved or consulted.Optional

optionally provide an external link to the service standard.

Prefer using this field than an instance of the Document type with code value STANDARD_REFERENCE.

Note: In case of doubt, the version field makes clear the version of the standard.


Case 2 - The service does not adhere to a service standard

attribute namedescriptionruleguidance
standardTypeThe type of implemented standard.Mandatory

Select code value SERVICE_STANDARD.

isConformant An indication whether the information service conforms to a reference. [SWIM-SERV-010]Mandatoryselect code value false
titleThe name by which the document is formally known.No use


version

The current version or revision level of the document.

No use


conformanceStatement A statement on any implemented options or deviation from the standard.No use


descriptionThe description of the entity.Optional

optionally provide a comment.

referenceAn external reference at which the standard can be retrieved or consulted.No use


Example


		"serviceDescriptionReferences": {
			"implementedStandard": [
				{
					"standardType": "SERVICE_STANDARD",
					"isConformant": true,
					"title": "EUROCONTROL Specification for Airspace Management (ASM) Support System Requirements supporting the ASM processes at local and FAB level, Part II – ASM to ASM Systems Interface Requirements", 
					"version": "1.0",
					"conformanceStatement": "All interfaces have been implemented, except for the LongTermPlanning interface",
					"description": "ASM to ASM service as from EUROCONTROL-SPEC-179",
					"reference": ""
				}
			],
		"serviceDescriptionReferences": {
			"implementedStandard": [
				{
					"standardType": "SERVICE_STANDARD",
					"isConformant": false
				}
			],


A complete JSON example is available in page JSON example - Donlon TOBT Setting service description.