You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 6
Next »
The specification contains a conformity checklist. It sets out whether conformance with the requirement is "mandatory", "recommended" or "mandatory when the conditions apply". Authors of information definitions are expected to complete the checklist. It is possible to attach the checklist to the information definitions as evidence of conformance.
To conform with a requirement, the entire requirement has to be satisfied. This includes the need to perform verification. Each requirement contains a statement on the type of verification that is expected (i.e. "completeness", "correctness", "consistency"). The guidance pages in this handbook elaborate on these statements.
The checklist below is a summary of all of the details for easy reference.
Requirement | Verification Type | Checklist |
---|
SWIM-INFO-001 Need for information definitions | Completeness | Check that: - There is an information definition.
- The information definition covers all of the information that is exchanged between the actors.
Notes: - The information definition can be a standalone document or embedded into another document such as a service description
- The information definition can be made up of a set of documents. This is common practice when designing XML schemas.
|
SWIM-INFO-002 Information definition language | Correctness | Check that: - The information definition is written in English.
- The information definition uses the primary British spelling when conflicting spellings of a word exist.
|
SWIM-INFO-003 Information definition identification | Completeness | Check that: - The information definition has a title.
- The information definition has an edition.
- The information definition has a reference date.
|
SWIM-INFO-004 Information definition responsible party | Completeness | Check that: - The information definition contains the name of the responsible person or organisation.
- The information definition contains contact information for the responsible party.
- The information definition contains the role played by the responsible party.
|
SWIM-INFO-005 Information definition scope | Completeness | Check that: - The information definition has a textual description of the scope of the information covered by the information definition.
- The scope clearly delineates what is covered by the information definition.
|
SWIM-INFO-006 Information definition namespace | Completeness | Check that: - The information definition declares a dedicated namespace for its concepts.
|
SWIM-INFO-007 Information definition concepts | Completeness | Check that: - The information definition contains a name for each of its information concepts and data concepts.
- The information definition contains a definition for each of its information concepts and data concepts.
- The information definition contains a data type for each of its data concepts.
|
| Consistency | Check that: - The concepts within the information definition are consistent i.e. that concepts do not contradict each other or their reference material.
- There are no duplicated concepts in the same namespace within the information definition.
|
| Correctness | Check that: - Each concept's name, definition and data type are correct i.e. that they actually represent what they should.
|
SWIM-INFO-008 Unique identifiers for concepts | Completeness | Check that either: - Each concept has a unique identifiers in accordance with IETF RFC 3986.
or - Each concept can be uniquely identified through some other mechanism e.g. by being uniquely named in a namespace.
|
SWIM-INFO-009 Preservation of meaning | Consistency | Check that: - The information definition uses definitions that are consistent with the AIRM when the concept's name is the same as that in the AIRM.
|
SWIM-INFO-010 Principles for definitions for concepts | Correctness | Check that: - The information definition has applied the principles for definitions for each of its concepts.
|
SWIM-INFO-011 Semantics of metadata | Consistency | Check that: - The definitions of the metadata fields in the information definition are consistent (not contradictory) with the AIRM's metadata standard.
|
SWIM-INFO-012 Use of data types | Consistency | Check that: - The information definition’s basic data types do not contradict those in the AIRM.
|
SWIM-INFO-013 Establish semantic correspondence | Completeness | Check that: - The information definition has a semantic correspondence statement for each concept.
|
SWIM-INFO-014 Forms of semantic correspondence | Completeness | Check that: - Each semantic correspondence statements contains one of the four options allowed by the specification.
|
SWIM-INFO-015 Out-of-scope or no correspondence | Completeness | Check that: - Each semantic correspondence declaring that a concept in an information definition is out-of-scope of the AIRM has a rationale.
- Each semantic correspondence declaring that no semantic correspondence has been established has a rationale.
|
SWIM-INFO-016 Mapping of information concepts | Correctness | Check that: - Each trace from the information concept in the information definition to the AIRM concept that has an equivalent or wider meaning is correct.
|
SWIM-INFO-017 Mapping of data concepts | Correctness | Check that: - Each trace from the data concept in the information definition to the AIRM concept that has an equivalent or wider meaning is correct.
- Each trace to the data type in the AIRM that has an equivalent or wider meaning is correct.
|
SWIM-INFO-018 Additional traces to clarify the mapping | Correctness | Check that: - Each additional trace to AIRM concepts to fully describe the narrowing of the concept being mapped is correct.
|
SWIM-INFO-019 Use of the AIRM's unique identifiers in traces | Correctness | Check that: - Each trace in the information definition use the unique identifier provided by the AIRM concept at its end-point.
|
|
|
|