![]() |
IMS Vocabulary Definition Exchange Information Model Version 1.0 Final Specification |
Copyright © 2004 IMS Global Learning Consortium, Inc. All Rights Reserved.
The IMS Logo is a trademark of IMS Global Learning Consortium, Inc.
Document Name: IMS Vocabulary Definition Exchange Information Model
Revision: 23 February 2004
IPR and Distribution Notices
Recipients of this document are requested to submit, with their comments, notification of any relevant patent claims or other intellectual property rights of which they may be aware that might be infringed by any implementation of the specification set forth in this document, and to provide supporting documentation.
IMS takes no position regarding the validity or scope of any intellectual property or other rights that might be claimed to pertain to the implementation or use of the technology described in this document or the extent to which any license under such rights might or might not be available; neither does it represent that it has made any effort to identify any such rights. Information on IMS's procedures with respect to rights in IMS specifications can be found at the IMS Intellectual Property Rights web page: http://www.imsglobal.org/ipr/imsipr_policyFinal.pdf.
Copyright © 2004 IMS Global Learning Consortium. All Rights Reserved.
If you wish to copy or distribute this document, you must complete a valid Registered User license registration with IMS and receive an email from IMS granting the license to distribute the specification. To register, follow the instructions on the IMS website: http://www.imsglobal.org/specificationdownload.cfm.
This document may be copied and furnished to others by Registered Users who have registered on the IMS website provided that the above copyright notice and this paragraph are included on all such copies. However, this document itself may not be modified in any way, such as by removing the copyright notice or references to IMS, except as needed for the purpose of developing IMS specifications, under the auspices of a chartered IMS project group.
Use of this specification to develop products or services is governed by the license with IMS found on the IMS website: http://www.imsglobal.org/license.html.
The limited permissions granted above are perpetual and will not be revoked by IMS or its successors or assigns.
THIS SPECIFICATION IS BEING OFFERED WITHOUT ANY WARRANTY WHATSOEVER, AND IN PARTICULAR, ANY WARRANTY OF NONINFRINGEMENT IS EXPRESSLY DISCLAIMED. ANY USE OF THIS SPECIFICATION SHALL BE MADE ENTIRELY AT THE IMPLEMENTER'S OWN RISK, AND NEITHER THE CONSORTIUM, NOR ANY OF ITS MEMBERS OR SUBMITTERS, SHALL HAVE ANY LIABILITY WHATSOEVER TO ANY IMPLEMENTER OR THIRD PARTY FOR ANY DAMAGES OF ANY NATURE WHATSOEVER, DIRECTLY OR INDIRECTLY, ARISING FROM THE USE OF THIS SPECIFICATION.
This section is not normative.
The IMS Vocabulary Definition Exchange (VDEX) specification defines a grammar for the expression of value lists of various classes: collections often denoted "vocabulary". Section 1.3.2 provides some definitions of the classes of vocabulary that VDEX can be used for. The ISO prefers the terms "value domain" and "permitted value" for the data VDEX principally relates to.
VDEX does not seek to permit the expression of all possible vocabularies: rather to permit the light-weight expression of relatively simple value lists. Furthermore, VDEX is not a modelling language for vocabularies; there may be some properties of a term of interest to the vocabulary creator, an expert in a domain, but that are not required by the end user.
VDEX does permit the expression of simple machine-readable lists of human language terms together with information that may aid a human being in understanding the meaning or applicability of the various terms. Collections of such human language terms are often collected in the form of thesauri; VDEX enables thesauri to be expressed using arbitrary relationship types, inclusive of those specified in ISO 2788 and ISO 5964 standards.
VDEX may be also used to express valid data for use in instances of, for example: IEEE LOM, IMS Meta-Data, IMS Learner Information Package, ADL SCORM. In these specifications, the elements using value lists are often described as being of "vocabulary data type" and expressed through separate domain and value identifiers. The permitted values are formally codes to identify a concept and they may not be always be textually identical to human language terms
Whereas vocabulary data types typically have an associated unstructured list of terms, meta-data schemas often permit the expression of subject classifications from hierarchical vocabularies (taxonomies), for example Dewey Decimal (DDC) and specialist schemes such as the Medical Subject Headings (MeSH). VDEX can express strictly hierarchical schemes in a compact manner and allows for more loose networks of relationship to be expressed if required.
Polyhierarchical schemes and facetted schemes, such as Universal Decimal Classification (UDC), are a complex area. VDEX provides support for several use cases through the Information Model (this document) and makes some recommendations in the Best Practices and Implementation Guide. Experts in these fields with specialist use cases may need to apply techniques such as:
The VDEX documents permit simple collections of terms to be expressed and optionally exchanged. The specific types of terms are defined in section 1.3.2. This document is the IMS Vocabulary Definition Exchange Specification version 1.0. As such it forms one of a set that comprise the specification, each with distinct scope:
Describes the core aspects of the specification and contains parts that are normative for any binding claiming to use this information model. It contains details of: semantics, structure, data types, value spaces, multiplicity, and obligation (i.e., whether mandatory or optional).
Describes a binding of the Information Model to XML version 1.0 and is normative for any XML instance that claims to use this binding, whether by reference to the specification or by declaration of the namespace reserved by the specification. In cases of error or omission, the Information Model takes precedence. The VDEX XML Binding is released with a control document using W3C XML Schema 1.0 that should be used in implementations.
Provides non-normative guidance on application of the Information Model and XML Binding. This includes reference to existing practice in handling information that this specification seeks to support and guidance on practices that will promote interoperability and durability. It also includes examples to illustrate how the conceptual framework maps to practical uses and to identify the relationship between this specification and related IMS specifications. Implementers are encouraged, but not required, to follow guidance in this part of the specification.
Provides a set of testable statements that may be used in relation to applications of the information model and binding. These statements may form the basis of formal conformance testing and certification or informal assertions. This document makes no statement about the formal processes or method of certification or assertion; it only deals with criteria.
We adopt some widely accepted definitions for "vocabulary" and related terms. A useful collection of definitions is given in [CVLOM], drawing upon well-known authorities, and contains the following summary of various authorities:
Vocabulary:
"dictionary of terms related to a particular subject field." [ISO 5127/2-1983]1
"1.a A collection or list of words with brief explanations of their meanings; now esp. a list of this kind given in an elementary grammar or reading book of a foreign language. 2.a. The range of language of a particular person, class, profession, or the like. 3. The sum or aggregate of words composing a language."[OED]2
Classification:
"arrangement of concepts into classes (3) and their subdivisions to express the semantic relations between them; the classes are represented by means of a notation". [ISO 5127/6-1983]3
"1) The action of classifying or arranging in classes, according to common characteristics or affinities; assignment to the proper class. 2. The result of classifying; a systematic distribution, allocation, or arrangement, in the class or classes; esp. of things which form the subject-matter of a science or of a methodic enquiry."[OED]4
Taxonomy:
"1. Classification, esp. in relation to its general laws or principals; that department of science, or of a particular science or subject, which consists in or relates to classification; esp. the systematic classification of living things. 2. A classification of anything." [OED]5
Thesaurus:
"The vocabulary of a controlled indexing language, formally organized so that the a priori relationships between concepts (for example as broader and narrower) are made explicit." [ISO 2788:1986; and ISO 5964:1985] 6
"2.b. A collection of concepts or words arranged according to sense; also (U.S.) a dictionary of synonyms and antonyms. 2.c. A classified list of terms, esp. key-words, in a particular field, for us in indexing and information retrieval." 7
Glossary:
"dictionary of ancient, rare, little-known or new words in a given language." [ISO 5127/2-1983] 8
"A collection of glosses; a list with explanations of abstruse, antiquated, dialectical or technical terms; a partial dictionary." 9
Dictionary:
collection of words or a category of words from a language and explained or translated in one or more languages, arranged alphabetically or systematically. [ISO 5127/2-1983]10
"1.a. A book dealing with the individual words of a language (or certain specified classes of them), so as to set forth their orthography, pronunciation, signification, and use, their synonyms, derivation, and history, or at least some of these facts: for convenience of reference, the words are arranged in some stated order, now, in most languages, alphabetical; and in larger dictionaries the information given is illustrated by quotations from literature; a word-book, vocabulary of lexicon. 1.b. The vocabulary or whole list of words used or admitted by anyone. 2.a. By extension: A book of information or reference on any subject or branch of alphabetical knowledge, the items of which are arranged in alphabetical order; as an alphabetical encyclopaedia." [OED]11
[CVLOM] |
"Controlled Vocabularies for Learning Object Metadata. - Typology, impact analysis, guidelines and a web based Vocabularies Registry". F. Van Assche, L. Anido-Rifón , L. M. Campbell and M. Willem, CEN/ISSS Learning Technologies Workshop, DRAFT, http://office.eun.org/kms/sites/cenisss/index.html |
[DDC] |
Dewey Decimal Classification Scheme, OCLC Forest Press, http://www.oclc.org/dewey/ |
[IEEE LOM] |
IEEE 1484.12.1-2002, Standard for Learning Object Metadata, http://www.ieee.org |
[IMSBUND] |
Using IMS Content Packaging to Package Instances of LIP and Other IMS Specifications v1.0, B.Olivier, M.McKell, IMS Global Learning Consortium, Inc., August 2001 (http://www.imsglobal.org/implementationhandbook/imspack_handv1p0.html). |
[IMSPLID] |
IMS Persistent, Location-Independent, Resource Identifier Implementation Handbook v1.0, M.McKell, IMS Global Learning Consortium, Inc., April 2001 (http://www.imsglobal.org/implementationhandbook/imsrid_handv1p0.html). |
ISO 2788 |
ISO 2788:1986, Guidelines for the establishment and development of monolingual thesauri. |
ISO 5964 |
ISO 5964:1985, Guidelines for the establishment and development of multilingual thesauri. |
ISO 11404 |
ISO 11404, Language-independent Datatypes, http://www.iso.ch/cate/d19346.html |
[MESH] |
Medical Subject Headings, US National Library of Medicine, http://www.nlm.nih.gov/mesh/meshhome.html |
[RFC 1766] |
Tags for the Identification of Languages, http://www.ietf.org/rfc/rfc1766.txt |
[RFC 2119] |
IETF RFC 2119 - Key words for use in RFCs to Indicate Requirement Levels |
[RFC 2396] |
IETF RFC 2396 Uniform Resource Identifiers (URI): Generic Syntax |
[RFC3066] |
RFC 3066, Tags for the Identification of Languages, http://www.ietf.org/rfc/rfc3066.txt |
[UDC] |
Universal Decimal Classification Scheme, UDC Consortium, http://www.udcc.org/ |
[Z39.19] |
ANSI/NISO Z39.19-1993, Guideslines for the Construction, Format, and Management of Monolingual Thesauri, ISSN 1041-5653 |
This section is normative. The terms defined in RFC 2119 are used with the meaning there defined.
The overall structure of the information model is shown in the following diagram and explained in the following subsections. The term structure may be repeated and nested. It should be noted that the ordering of elements at any level in the information model diagram and in the textual description of information model elements is not significant unless a statement is made to the contrary. NB: some bindings of the information model may require particular ordering.
This section relates to properties of the collection of terms, the "value domain".
A vocabulary must consist of a non-empty set of permitted values. These are modeled as terms and relationships with properties as below.
This section is normative. The terms defined in RFC 2119 are used as defined therein.
The names used for elements in the VDEX information model are not normative names for any binding; named elements in a binding must only identify which of the elements described in this document they relate to.
Most of the VDEX information elements are optional to reflect the differing classes of vocabulary that VDEX can be used to express. Section 3.2 describes how the main classes handled by VDEX apply further constraints on the general grammar described in the following table.
Name | Description of Use | Value Space | Data Type | SPM | Mult1 | |
---|---|---|---|---|---|---|
1 |
Order Significant |
Whether the ordering of terms is significant. Default value is false. |
|
Boolean |
- |
0..1 |
2 |
Profile Type |
Describes the type of vocabulary being expressed. Can be used to support restrictive validation. Default value is "lax". |
See section 3.2 |
String (enum) |
- |
1 |
3 |
Vocabulary Name |
Human language name for vocabulary. May be expressed in multiple different languages. |
Repertoire of ISO/IEC 10646-1:2000 |
Langstring See Note * |
1000 chrs |
0..1 |
4 |
Vocabulary Identifier |
Identifier for the vocabulary as a whole. This identifies the value domain. This element is optional to support cases where no identifier is known. If there is a known identifier then it should be provided. |
See notes |
URI |
4096 chrs2 |
0..1 |
4.1 |
Registration Status |
Whether the vocabulary and its identifier is registered with some authority. Default value is false. |
|
Boolean |
- |
0..1 |
5 |
Default Language |
The default language for all elements of type "langstring" that do not independently declare a language. |
Language Code (see section 3.1) |
String |
see 3.1 |
0..1 |
6 |
{Term} |
See Table 3.2 |
|
Container |
|
1..* |
7 |
{ Relationship } |
See Table 3.3 |
|
Container |
|
0..* |
8 |
Metadata |
Meta-data for the vocabulary as a whole. This is a container for arbitrary meta-data. |
|
Container |
10 reps |
0..* |
Name | Description of Use | Value Space | Data Type | SPM | Mult | |
---|---|---|---|---|---|---|
6 |
Term |
A vocabulary item. |
|
Container |
|
1..* |
6.1 |
Identifier |
An identifier for the value within the scope of the vocabulary. |
See notes |
URI |
100 chrs |
1 |
6.2 |
Valid Index |
A flag indicating whether or not this is a valid term for use in indexing. Default value is true. |
|
Boolean |
|
0..1 |
6.3 |
Caption |
A human language caption. |
|
Langstring See Note * |
1000 chrs |
0..1 |
6.4 |
Description |
A human language description of the meaning of the vocabulary term and its usage. |
|
Langstring See Note * |
2000 chrs |
0..1 |
6.5 |
Media Descriptor |
URLs of an image (static or dynamic), non-verbal audio, etc. that provide a non-textual description. Useful in clarifying the precise meaning. |
|
Container |
|
0..* |
6.5.1 |
Media Location |
The location of a media file. |
See notes |
URI |
4096 chrs |
11 |
6.5.2 |
Interpretation Note |
|
|
Langstring See Note |
2000 chrs |
0..1 |
6.6 |
Order Significant |
Whether the ordering of child terms is significant. Default value is false. |
|
Boolean |
- |
0..1 |
6.7 |
Metadata |
Meta-data for the term. This is a container for arbitrary meta-data. |
|
Container |
|
0..* |
6.8 |
{Term} |
Nested Term elements for use in expressing taxonomies. |
|
Container |
|
0..* |
1
A mandatory child of an optional element should be taken to mean that the child must appear if the optional element is used.
|
Elements with type "langstring" and multiplicity "single" may only occur once but may contain multiple langstring constructs, each with an equivalent content. The SPM columns in Table 3.1 and Table 3.2 specify the individual constraints, which should be read in the context of the accompanying note on SPM notation and interpretation.
If an individual langstring element does not declare a language property then the Default Language of the instance must be taken to be the language of the langstring. If there is no Default Language then the language of the string is undefined.
Implementers must take care that:
The value space of the language property and the instance default language property is declared as "Language Code". This must conform to the requirements of RFC176613.
This sub-section is not normative.
Figure 3.1 shows a class diagram following UML notation that may help some readers in interpreting the information model descriptions elsewhere in section. Types are not provided except where this specification defines a type: for vocabulary data types and langstring collections. This is an informative diagram in that it does not define the information model but supplements Table 3.1 and Table 3.2.
Relations are shown as always being binary even though the source or target terms may be in a different vocabulary to the relationship.
This section is not normative.
The terminology "profile type" may be equivalently expressed as a "vocabulary type" but both terms run the risk of misinterpretation. We are not describing an application profile here; the VDEX "profile type" is more akin to a label for a subset of a more general information model. The subsets are intended to provide the necessary information elements for various well-known classes of vocabulary (see section 1.3.2). The VDEX "profile type" is not a property of the vocabulary to identify the class of vocabulary being expressed, hence we prefer not to use the terminology "vocabulary type" either.
The profile type is formally a property of the VDEX instance and makes explicit the subset of the VDEX grammar that is in use. This property is used to:
Profiling allows a single flexible information model with shared semantic units to be applied selectively if required. Making the profile type an explicit part of the model allows for easy profile-specific validity checking of, for example, XML instances by the use of more restrictive XML Schema control documents.
The profile types defined by VDEX are: "lax", "thesaurus", "flatTokenTerms", "hierarchicalTokenTerms", "glossaryOrDictionary". The non-profile, i.e., complete model, is identified by profileType="lax".
A profile type other than one of the specified profile types above should be declared as being "lax", even if only a small number of elements are used. If it is desired to express the identity of such a custom type then the information model should be extended to permit this information to be passed to systems that understand its meaning. Systems that do not understand the significance of a custom type would consider the type to be "lax" since that is the declared type as far as the VDEX information model is concerned.
Profile type: Element | lax | glossaryOrDictionary | flatTokenTerms | hierarchicalTokenTerms | thesaurus |
---|---|---|---|---|---|
Elements pertaining to the vocabulary as a whole |
|||||
Order Significant |
0..1 |
0..1 |
0..1 |
0..1 |
0..1 |
Profile Type1 |
0..1 |
1 |
1 |
1 |
1 |
Default Language |
0..1 |
0..1 |
0..1 |
0..1 |
0..1 |
Vocabulary Name |
0..1 |
0..1 |
0..1 |
0..1 |
0..1 |
Vocabulary Identifier |
0..1 |
0..1 |
0..1 |
0..1 |
0..1 |
Registration Status |
0..1 |
0 |
0..1 |
0..1 |
0..1 |
Term |
1..* |
1..* |
1..* |
1..* |
1..* |
Relationship |
0..* |
0..* |
0 |
0 |
0..* |
Elements pertaining to the term |
|||||
Identifier |
1 |
1 |
1 |
1 |
1 |
Caption2 |
[0..1]* |
1 |
[0..1]* |
[0..1]* |
1 |
Valid Index |
0..1 |
0 |
0..1 |
0..1 |
0 |
Description |
0..1 |
0..1 |
0..1 |
0..1 |
0..1 |
Media Descriptor |
0..* |
0..* |
0 |
0 |
0..* |
Media Location |
1 |
1 |
- |
- |
1 |
Interpretation Note |
0..1 |
0..1 |
- |
- |
0..1 |
Order Significant |
0..1 |
- |
- |
0..1 |
- |
{ Term} |
0..* |
0 |
0 |
0..* |
0 |
Metadata |
0..* |
0..* |
0..* |
0..* |
0..* |
1
Profile types with a required value must use the value specific to the relevant profile type. The full VDEX model assumes lax if no value is provided.
2
1 indicates a single langstring must used as the content of the caption. [0..1]* indicates any number langstrings may be used as the content of the caption (with equivalent content).
|
UML multiplicity notation: 0..1 - optional and not repeatable 0..* - optional and repeatable 1..* - required at least once and repeatable 1 - required once only 0 - must not be used |
Notes on using profiles: The most restrictive profile type should be declared that is sufficient to permit the elements in use.
This section is normative. The terms defined in RFC 2119 are used as specified therein.
Monolingual thesauri expressed using VDEX should follow the conventions of d 2788. Multilingual thesauri should follow the recommendations of ISO 5964.
Monolingual thesauri following ISO 2788 should use the following value domain to express the relationship types defined in ISO 2788:
Vocabulary Identifier: "http://www.imsglobal.org/vocabularies/iso2788_relations.xml"
Used for the "source" of a relationship type
Permitted terms: "USE", "UF", "RT", "BT", "NT", "TT"
Used for the "value" of a relationship type
Meaning of terms: Defined by ISO 2788
Multilingual thesauri following ISO 5964 should use the following value domain to express the degree of language equivalence:
Vocabulary Identifier: "http://www.imsglobal.org/vocabularies/iso5964_equivalences.xml"
Used for the "source" of a relationship type
Permitted terms: "exact", "inexact", "partial", "singleToMultiple", "NonEquivalent"
Used for the "value" of a relationship type
Meaning of terms: Defined by ISO 5964
IMS will maintain a persistent copy of definitions of these value domains at a URL identical to the vocabulary identifiers above. These definitions will be expressed according to the most recent VDEX version XML binding.
VDEX instances using the above vocabulary identifiers must only use values from the relevant list of permitted terms. IMS reserves all vocabulary identifiers starting "http://www.imsglobal.org/vocabularies/"; such identifiers may not be used without the authority of the Board of Directors of IMS Global Consortium. Implementers should also refer to the "IMS Persistent, Location-Independent, Resource Identifier Implementation Handbook v1.0" [IMSPLID].
The preferred use of these value domains is described in the Vocabulary Definition Exchange Specification Best Practice and Implementation Guide.
Note on other relationship types:
The recommendations of this section apply only in relation to thesauri that follow the ISO standards mentioned. Other types of relationship models are permitted in VDEX and VDEX imposes no requirements as to the value domains and permitted terms for the associated relationship types. Specific mention is made of Z39.19 for monolingual thesauri since it extends the relationship indicators used in ISO 2788.
Note on multilingual thesauri and exact equivalence:
Multilngual thesauri that are essentially sets of equivalent terms and these sets are related in various ways should probably avoid using the Relationship element but make use of the fact that the Caption element may contain multiple language strings. This makes for greater clarity and economy in expressing the information.
Title |
IMS Vocabulary Definition Exchange Information Model |
Editor |
Adam Cooper |
Version |
1.0 |
Version Date |
23 February 2004 |
Status |
Final Specification |
Summary |
This document describes the Vocabulary Definition Exchange Information Model |
Revision Information |
February 2004 |
Purpose |
Defines the VDEX Information Model |
Document Location |
http://www.imsglobal.org/vdex/vdexv1p0/imsvdex_infov1p0.html |
To register any comments about the VDEX specification, please visit: http://www.imsglobal.org/developers/ims/imsforum/categories.cfm?catid=18 |
The following individuals contributed to the development of this document:
I
identifier 1, 2, 3, 4, 5
IMS Specifications
Content Packaging 1
Learner Information Package 1
ISO 1, 2, 3
N
namespace 1
normative 1, 2, 3, 4, 5, 6
R
Relationship 1
relationship 1, 2, 3, 4, 5, 6, 7
T
taxonomy 1, 2, 3
term 1
thesauri 1, 2, 3
thesaurus 1, 2, 3, 4
X
XML 1
IMS Global Learning Consortium, Inc. ("IMS") is publishing the information contained in this IMS Vocabulary Definition Exchange Information Model ("Specification") for purposes of scientific, experimental, and scholarly collaboration only.
IMS makes no warranty or representation regarding the accuracy or completeness of the Specification.
This material is provided on an "As Is" and "As Available" basis.
The Specification is at all times subject to change and revision without notice.
It is your sole responsibility to evaluate the usefulness, accuracy, and completeness of the Specification as it relates to you.
IMS would appreciate receiving your comments and suggestions.
Please contact IMS through our website at http://www.imsglobal.org
Please refer to Document Name: IMS Vocabulary Definition Exchange Information Model Revision: 23 February 2004