Versions Compared

Version Old Version 5 New Version 6
Changes made by

WILSON Scott

WILSON Scott

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Panel
titlePage Table of Content

Table of Contents

Info
titleVersion

This page concerns v2.0 of the Specification. Supporting material on v1.0 is SWIM-SERV-022 Information definition



Requirement

Panel
borderColorlightgrey
bgColorwhitesmoke
borderStyledashed

Title

Information definition (extended)

Identifier

SWIM-SERV-300

Requirement

A service description should include or refer to information about the exchanged Information service payload including:

  • the cardinality applicable to the element, including whether the element is optional, conditional or mandatory in the exchange;
  • constraints applicable to the element, such as:
    • value ranges;
    • special values;
    • character set restrictions; and
  • the structure and relevant relationships between the elements.

Rationale

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

Verification

Completeness: Not Applicable.

Consistency: Not Applicable.

Correctness: Not Applicable.

Examples/Notes

Note: This requirement covers the best practice for what should be in an information definition. However, it does not require that the information definition be replicated in the service description.

Level of Implementation

Recommended

Guidance

Verification Support

There is no verification required.

Examples

The following example shows the content as a table.

TBD

The following example shows an extract of the content of a JSON file that conforms to the Service Metadata Schema

Code BlocklanguagejstitleExample of

See SWIM-SERV-

300 using Service Metadata Schematbd

290 Information definition - minimum

Complete examples are available at Example service description.