IMS Learner Information Package Summary of Changes

Version 1.0.1 Final Specification

Copyright © 2005 IMS Global Learning Consortium, Inc. All Rights Reserved.
The IMS Logo is a registered trademark of IMS/GLC.
Document Name: IMS Learner Information Package Summary of Changes
Revision: 04 January 2005

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.

Permission is granted to all parties to use excerpts from this document as needed in producing requests for proposals.

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.

1. Introduction

1.1 Learner Information Package Overview

During the development of the Learner Information Package (LIP) specification the XML Binding was based upon the Document Type Definition (DTD). The equivalent XML Schema Definition (XSD) for LIP was not an official part of the specification but developed as a tool for the community. The DTD should be considered the definitive description for LIP v1.0. The changes in this document bring the XSD in line with the DTD and ensure that the DTD and Information Model correspond. Therefore, in all cases the LIP v1.0.1 XSD should be used in place of the LIP v1.0 schema.

The version 1.0 XSD is replaced by the version 1.0.1 XSD. The version 1.0.1 XSD is backwards compatible with the DTD and therefore no custom user types have been introduced that could not be supported by the DTD.

The LIP specification describes data structures, XML binding and accompanying best practices that are used for the formatting, storage, and exchange of learner information [LIP, 01a][LIP, 01b][LIP, 01c]. The specification supports the exchange of learner information among learning management systems, human resource systems, student information systems, enterprise e-learning systems, knowledge management systems, resume repositories, and other systems used in the learning process. In this document, such systems will be called learner information systems regardless of any other functionality they possess or roles they fulfil. The LIP specification does not address requests for learner information or the exchange transaction mechanism.

At the current time, it is the LIP v1.0 specification that is available in Final Release form to the public.

1.2 Scope and Context

This document describes amendments to be made by adopters of the LIP v1.0 specification, thereby creating the LIP v1.0.1 specification. Many typographical and elaborative changes were made to clarify and correct the supporting documents. The substantive differences between the v1.0 and the v1.0.1 specifications are limited to:

Updating the XML schema to use formally recommended XML Schema definitions;
Correcting typographical errors in the binding of the <learningactivityref> element in the Binding document;
<address> <street> Setting cardinality to O in the Binding in line with the Information Model;
<affiliation> <date> Setting cardinality to O n in the Binding in line with the Information Model;
<demographics> <date> Setting cardinality to O in the Binding in line with the Information Model;
<formname> <text> Setting cardinality to M in the Binding in line with the Information Model;
<goal><status> Setting cardinality to O in the Binding in line with the Information Model;
<qcl><title> Setting cardinality to M in the Binding in line with the Information Model;
<qcl><date> Setting cardinality to M n in the Binding in line with the Information Model;
<representation> <date> Setting cardinality to M n in the Binding in line with the Information Model;
<description><full> Setting cardinality to O in the Binding in line with the Information Model;
<description><long> Setting cardinality to O in the Binding in line with the Information Model;
Clarification for use of the <sourcedid> element;
Bringing XSD in line with the DTD.

1.3 Structure of this Document

The structure of this document is:

2. Amendments And Errata Instructions	The resolution of the issues that were not deferred until a later release. Each instruction describes the changes to be made to the documentation;
3. Deliverables	The set of documents and supporting information that is released to form the IMS Learner Information Package v1.0.1 specification;
Appendix A - The Initial Issues Presentation	The initial set of issues that were introduced as a part of this revision of the LIP specification.

1.4 Nomenclature

DTD	Document Type Definition
LIP	Learner Information Package
LMS	Learning Management System
PLIRI	Persistent Location Independent Resource Identifier
URI	Universal Resource Identifier
URL	Universal Resource Locator
W3C	World Wide Web Consortium
XML	Extensible Mark-up Language
XSD	XML Schema Definition
XSD	XML Schema Definition

1.5 References

[LIP, 01a]	IMS Learner Information Package Information Model v1.0, R.Robson, C.Smythe, F.Tansey, IMS/GLC, March 2001.
[LIP, 01b]	IMS Learner Information Package XML Binding v1.0, R.Robson, C.Smythe, F.Tansey, IMS/GLC, March 2001.
[LIP, 01c]	IMS Learner Information Package Best Practice & Implementation Guidelines v1.0, R.Robson, C.Smythe, F.Tansey, IMS/GLC, March 2001.

2. Amendments and Errata Instructions

2.1 LIP Schema Out of Date

2.1.1 Reference to LIP Issues List

Identifier	Issue
LIP 1-23	LIP schemas to use the correct W3C version.

2.1.2 Information Model Changes

None.

2.1.3 XML Binding Changes

Amendment Instructions:

Within the <xsd:schema> element change the xmlns:xsd attribute from:

xmlns:xsd="http://www.w3.org/2000/10/XMLSchema"

to:

xmlns:xsd="http://www.w3.org/2001/XMLSchema"

2.1.4 Best Practice Changes

None.

2.2 Dates and Times in IMS LIP

2.2.1 Reference to LIP Issues List

Identifier	Issue
LIP 1-43	Dates and times in IMS LIP.

2.2.2 Information Model Changes

None.

2.2.3 XML Binding Changes

The Schema should be brought in line with the DTD.

2.2.4 Best Practice Changes

None.

2.3 Wrong ISO8601 Date format

2.3.1 Reference to LIP Issues List

Identifier	Issue
LIP 1-43	Wrong ISO8601 format.
LIP 1-46	Wrong ISO8601 format - DTD perspective.

2.3.2 Information Model Changes

None.

2.3.3 XML Binding Changes

Amendment Instructions:

Section 3.13.4 <date> Elements of the XML Binding document currently reads
Example:

<date>
   <typename>
     <tysource sourcetype="imsdefault"/>
     <tyvalue>Award</tyvalue>
   </typename>
   <datetime>2000:11:06</datetime>
   <description>
     <short>The date of the ward</short>
   </description>
</date>

This should be changed to:

<date>
   <typename>
     <tysource sourcetype="imsdefault"/>
     <tyvalue>Award</tyvalue>
   </typename>
   <datetime>2000-11-06</datetime>
   <description>
     <short>The date of the ward</short>
   </description>
</date>

in line with ISO8601 format of YYYY-MM-DD. In addition the following examples also need to be changed

3.3.4       <date>
3.4.8       <date>
3.5.4       <date>
3.10.8     <date>
3.10.9     <status>

2.3.4 Best Practice Changes

None.

2.4 Inconsistent Cardinality of 'description'

2.4.1 Reference to LIP Issues List

Identifier	Issue
LIP 1-95	Description: inconsistent cardinality.
LIP 1-98	Description: inconsistent cardinality of Full.
LIP 1-98	Description: inconsistent cardinality of Long.

2.4.2 Information Model Changes

None.

2.4.3 XML Binding Changes

Amendment Instructions:

The Information Model describes short description as being a mandatory child of description but the Binding describes it as optional. Therefore:
'Section 3.13.3 Multiplicity: Occurs zero or more times within the <description> element.'

should, be altered to read:

'Section 3.13.3 Multiplicity: Occurs once or more times within the <description> element.'

The diagram should be altered to read:

The examples should be changed appropriately.

2.4.4 Best Practice Changes

None.

2.5 Usage of 'sourcedId'

2.5.1 Reference to LIP Issues List

Identifier	Issue
LIP 1-99	SourcedId: Clarification required.

2.5.2 Information Model Changes

Amendment Instructions:	Definition is given as "global user identifier"- if this is the case, it cannot be used to identify a component of LIP outside of a document. Section 13.3.1.1 of the Information Model should be altered to read:
Amendment Instructions:	13.3.1.1	sourcedid	The initiating system's source identification for the learner information.	C				If the entry is not defined as a 'sourcedid' it MUST be an 'indexid'. sourcedid is only to be used to identify the subject

2.5.3 XML Binding Changes

None.

2.5.4 Best Practice Changes

None.

2.6 'exrefrecord:recformat:entityref'

2.6.1 Reference to LIP Issues List

Identifier	Issue
LIP 1-100	Exrefrecord: Entityref undefined in original XSD binding.

2.6.2 Information Model Changes

None.

2.6.3 XML Binding Changes

Bring the Schema in line with the DTD.

2.6.4 Best Practice Changes

None.

2.7 'exrefrecord: recdata: entityref'

2.7.1 Reference to LIP Issues List

Identifier	Issue
LIP 1-101	Exrefrecord: RecData.Entityref undefined in original XSD binding.

2.7.2 Information Model Changes

None.

2.7.3 XML Binding Changes

Bring the Schema in line with the DTD.

2.7.4 Best Practice Changes

None.

2.8 Cardinality of 'demographics'

2.8.1 Reference to LIP Issues List

Identifier	Issue
LIP 1-102	General: Various cardinality inconsistencies.

2.8.2 Information Model Changes

Amendment Instructions:	<demographics> <date> Cardinality is inconsistent: between the Information Model which has O n, and the Binding has zero or once. Section 2.7.4.1 should be altered to read:
Amendment Instructions:	2.7.4.1	date	Recorded dates appropriate to the representation.	O		As per structure 13.6 (Table 6.13).

2.8.3 XML Binding Changes

None.

2.8.4 Best Practice Changes

None.

2.9 Cardinality of 'address'

2.9.1 Reference to LIP Issues List

Identifier	Issue
LIP 1-102	General: Various cardinality inconsistencies.

2.9.2 Information Model Changes

None.

2.9.3 XML Binding Changes

Amendment Instructions:

<address> <street>
Cardinality is inconsistent: The Information Model has zero; Binding has zero or more.
Binding document section 3.2.5.5 <street> element's multiplicity should be changed to read:

Multiplicity: Occurs zero or once within the <address> element.

The diagram is correct.

2.9.4 Best Practice Changes

None.

2.10 Cardinality of 'affiliation'

2.10.1 Reference to LIP Issues List

Identifier	Issue
LIP 1-102	General: Various cardinality inconsistencies.

2.10.2 Information Model Changes

None.

2.10.3 XML Binding Changes

Amendment Instructions:

<affiliation> <date>
Binding document section 3.10.6.4 <date> element's multiplicity should be changed to read:

Multiplicity: Occurs zero or many times within the <affiliation> element.

The diagram is correct.
The DTD and XSD are valid.

2.10.4 Best Practice Changes

None.

2.11 Cardinality of 'formname'

2.11.1 Reference to LIP Issues List

Identifier	Issue
LIP 1-102	General: Various cardinality inconsistencies.

2.11.2 Information Model Changes

Amendment Instructions:

<formname> <text>
Cardinality is inconsistent: Information Model has M, Binding has zero or once.
The Information Model should be changed to O.

2.11.3 XML Binding Changes

None.

2.11.4 Best Practice Changes

None.

2.12 Cardinality of 'geo'

2.12.1 Reference to LIP Issues List

Identifier	Issue
LIP 1-102	General: Various cardinality inconsistencies.

2.12.2 Information Model Changes

None.

2.12.3 XML Binding Changes

Bring the Schema in line with the DTD.

2.12.4 Best Practice Changes

None.

2.13 Cardinality of 'goal'

2.13.1 Reference to LIP Issues List

Identifier	Issue
LIP 1-102	General: Various cardinality inconsistencies.

2.13.2 Information Model Changes

Amendment Instructions:	<goal><status> Cardinality is inconsistent between the Information Model and the Binding. Section 4.6 of the Information Model should be altered to read:
Amendment Instructions:	4.6	Status	Recorded status of the goal.	O		As per structure 13.8 (Table 6.13).

2.13.3 XML Binding Changes

None.

2.13.4 Best Practice Changes

None.

2.14 Cardinality of 'qcl.title'

2.14.1 Reference to LIP Issues List

Identifier	Issue
LIP 1-102	General: Various cardinality inconsistencies.

2.14.2 Information Model Changes

None.

2.14.3 XML Binding Changes

Bring the Schema in line with the DTD.

2.14.4 Best Practice Changes

None.

2.15 Cardinality of 'qcl.date'

2.15.1 Reference to LIP Issues List

Identifier	Issue
LIP 1-102	General: Various cardinality inconsistencies.

2.15.2 Information Model Changes

None.

2.15.3 XML Binding Changes

Bring the Schema in line with the DTD.

2.15.4 Best Practice Changes

None.

2.16 Cardinality of 'representation.date'

2.16.1 Reference to LIP Issues List

Identifier	Issue
LIP 1-102	General: Various cardinality inconsistencies.

2.16.2 Information Model Changes

None.

2.16.3 XML Binding Changes

Amendment Instructions:

In Section 3.2.7.6 <date> of the Binding document Multiplicity should be altered to read:

Multiplicity: Occurs zero or many times within the <demographics> and <representation> elements.
Replace Figure 3.8 with:

2.16.4 Best Practice Changes

None.

2.17 Naming of 'learningacitivtyref'

2.17.1 Reference to LIP Issues List

Identifier	Issue
LIP 1-103	Typo: learning activity ref.

2.17.2 Information Model Changes

None.

2.17.3 XML Binding Changes

Amendment Instructions:

Learningactivityref is misspelled as "learneractivityref" in Binding section 3.5.7
Amend the example in section 3.5.7 of the Binding document from:

<learneractivityref>
  <sourcedid>
    <source>IMS_LIP_V1p0_Example</source>
    <id>course_101</id>
  </sourcedid>
</learneractivityref>

to the correct spelling:

<learningactivityref>
  <sourcedid>
      <source>IMS_LIP_V1p0_Example</source>
      <id>course_101</id>
  </sourcedid>
</learningactivityref>

The DTD and XSD Bindings and the diagram are correct.

2.17.4 Best Practice Changes

None.

2.18 Telephony Items

2.18.1 Reference to LIP Issues List

Identifier	Issue
LIP 1-143	Binding of telephony as Integers in XSD (from BSI).

2.18.2 Information Model Changes

None.

2.18.3 XML Binding Changes

Amendment Instructions:

Telephony items (numbers, codes, etc.) are defined in the Binding document as being declared as String, but are defined as Integer within the XML schemas.
The following datatypes should be changed from xsd:int to xsd:string:

<areacode>
<countrycode>
<extnumber>
<indnumber>

2.18.4 Best Practice Changes

None.

3. Deliverables

The set of deliverables to be issued as the IMS Content Packaging v1.1.4 specification and documentation set is:

IMS Learner Information Package Summary of Changes, Version 1.0.1 (this document);
IMS Learner Information Package v1.0.1 XSD;
IMS Learner Information Package v1.0.1 Examples set.

Appendix A - The Initial Issues

In Table A1 is the list of original issues that were reviewed as part of the maintenance process. There are four possible states for the issue:

Resolved - the resolution of this issue has been addressed in this document;
Rejected - the issue has been considered and rejected due to various reasons, e.g., a wrongly identified fault;
Duplicated - this issue is a duplicate of another in the list. An associated note identifies the other entry;
Deferred - this issue can only be resolved by the addition of new functionality or making changes that will cause problems with backwards compatibility. These issues will be considered as a part of a LIP v1.1 development.

Key: Type: O = Other
CI = Conflicting Information
LC = Lacks Clarity
T = Typographic error
DC = Document Content
FR = Feature Request

Table A1 List of LIP issues.

Issue	Type	Document	Title	Status
23	O	Schema	LIP Schemas out of date	Resolved
43	CI	Schema	Dates and times in IMS LIP	Resolved
92	CI	Information Model	Temporal: Cardinality Inconsistent	Resolved
93	CI	Information Model	Privacy: Cardinality Inconsistent	Resolved
94	CI	Information Model	Privacy: Cardinality Inconsistent	Resolved
95	CI	Information Model	Description: Cardinality Inconsistent	Resolved
96	O	Information Model	Description: Type Inconsistent	Resolved
97	CI	Information Model	Description: Cardinality Inconsistent	Resolved
98	CI	Information Model	Description: Cardinality Inconsistent	Resolved
99	LC	Information Model	Sourcedid Clarification Required	Resolved
100	CI	Information Model	Exrefrecord: entityref undefined in binding	Resolved
101	CI	Information Model	xrefrecord.recdata.entityref undefined in binding	Resolved
102	CI	Information Model	General: various Cardinality Inconsistencies	Resolved
103	T	Information Model	Typo: Learning activity ref	Resolved
104	DC	Information Model	Datetime: does not conform to IS8601	Resolved
105	DC	Information Model	Area Code: Cardinality Inappropriate	Deferred
106	O	Information Model	General: inconsistency in string lengths	Resolved
107	FR	Information Model	Identification Support Legacy Address Formats	Resolved
108	DC	Information Model	Activity units cardinality too restrictive	Deferred
109	DC	Information Model	Accessibility: Not consistent with ACCLIP	Deferred
111	O	Information Model	IndexID Binding	Resolved
114	O	Information Model	Product	Deferred
115	O	Information Model	Bring Extension Mechanism in line with more recent practice	Deferred
116	O	Information Model	Langstring-Various Issues	Deferred
131	FR	Schema	LIP/ACCLIP integration issues	Deferred
117	FR	Information Model	Need new statement	Deferred
118	O	Information Model	Bundling resource type identifiers	Deferred
119	O	Information Model	Result Hierarchy	Deferred
120	O	Information Model	UID Issues	Deferred
121	O	Information Model	Formatted Addresses	Deferred
122	O	Information Model	Representation of geographic information	Deferred
123	FR	Information Model	Ownership/Contribution rights - changes to identification and contenttype	Deferred
124	O	Information Model	Issues around vocabularies	Deferred
125	O	Information Model	LIP/Enterprise person reconciliation	Deferred
130	CI	Schema	LIP/ACCLIP integration issues	Deferred
143	CI	Schema	Binding of telephony as integers in XSD	Resolved
144	DC	Information Model	Datetimes and ISO8601: Length restriction	Resolved
145	DC	Information Model	Area code should be optional	Deferred
132	LC	Information Model	Demographics	Deferred
133	FR	Information Model	Reflection	Deferred
135	O	Information Model	Nationality	Deferred
137	DC	Information Model	Geo should conform to ISO 6709	Deferred
138	FR	Information Model	Owner and Creator Metadata	Deferred
139	DC	Information Model	Vocabularies	Deferred
140	FR	Information Model	Affiliation	Deferred
141	FR	Information Model	Name Context	Deferred
142	FR	Information Model	Review of identification	Deferred
146	FR	Information Model	Ink color in screenEnhancement	Deferred
151	FR	Information Model	Modularity in avoiding color combinations	Deferred

About This Document

Title	IMS Learner Information Package Summary of Changes
Editor	Colin Smythe (IMS)
Version	1.0.1
Version Date	04 January 2005
Status	Final Specification
Summary	This document describes the changes made to the Learner Information Package specification documents.
Revision Information	04 January 2005
Purpose	This document has been approved by the IMS Technical Board and is made available for adoption.
Document Location	http://www.imsglobal.org/profiles/lipv1p0p1/imslip_sumcv1p0p1.html

To register any comments or questions about this specification please visit: http://www.imsglobal.org/developers/ims/imsforum/

Revision History

Version No.	Release Date	Comments
Final 1.0.1	04 January 2005	The 'IMS Learner Information Package Summary of Changes' document describes the amendments and errata changes made to the LIP v1.0 specification.

IMS Global Learning Consortium, Inc. ("IMS/GLC") is publishing the information contained in this IMS Learner Information Package Summary of Changes ("Specification") for purposes of scientific, experimental, and scholarly collaboration only.

IMS/GLC 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/GLC would appreciate receiving your comments and suggestions.

Please contact IMS/GLC through our website at http://www.imsglobal.org

Please refer to Document Name: IMS Learner Information Package Summary of Changes Revision: 04 January 2005

Table of Contents

1. Introduction

1.1 Learner Information Package Overview

1.2 Scope and Context

1.3 Structure of this Document

1.4 Nomenclature

1.5 References

2. Amendments and Errata Instructions

2.1 LIP Schema Out of Date

2.1.1 Reference to LIP Issues List

2.1.2 Information Model Changes

2.1.3 XML Binding Changes

2.1.4 Best Practice Changes

2.2 Dates and Times in IMS LIP

2.2.1 Reference to LIP Issues List

2.2.2 Information Model Changes

2.2.3 XML Binding Changes

2.2.4 Best Practice Changes

2.3 Wrong ISO8601 Date format

2.3.1 Reference to LIP Issues List

2.3.2 Information Model Changes

2.3.3 XML Binding Changes

2.3.4 Best Practice Changes

2.4 Inconsistent Cardinality of 'description'

2.4.1 Reference to LIP Issues List

2.4.2 Information Model Changes

2.4.3 XML Binding Changes

2.4.4 Best Practice Changes

2.5 Usage of 'sourcedId'

2.5.1 Reference to LIP Issues List

2.5.2 Information Model Changes

2.5.3 XML Binding Changes

2.5.4 Best Practice Changes

2.6 'exrefrecord:recformat:entityref'

2.6.1 Reference to LIP Issues List

2.6.2 Information Model Changes

2.6.3 XML Binding Changes

2.6.4 Best Practice Changes

2.7 'exrefrecord: recdata: entityref'

2.7.1 Reference to LIP Issues List

2.7.2 Information Model Changes

2.7.3 XML Binding Changes

2.7.4 Best Practice Changes

2.8 Cardinality of 'demographics'

2.8.1 Reference to LIP Issues List

2.8.2 Information Model Changes

2.8.3 XML Binding Changes

2.8.4 Best Practice Changes

2.9 Cardinality of 'address'

2.9.1 Reference to LIP Issues List

2.9.2 Information Model Changes

2.9.3 XML Binding Changes

2.9.4 Best Practice Changes

2.10 Cardinality of 'affiliation'

2.10.1 Reference to LIP Issues List

2.10.2 Information Model Changes

2.10.3 XML Binding Changes

2.10.4 Best Practice Changes

2.11 Cardinality of 'formname'

2.11.1 Reference to LIP Issues List

2.11.2 Information Model Changes

2.11.3 XML Binding Changes

2.11.4 Best Practice Changes

2.12 Cardinality of 'geo'

2.12.1 Reference to LIP Issues List

2.12.2 Information Model Changes

2.12.3 XML Binding Changes

2.12.4 Best Practice Changes

2.13 Cardinality of 'goal'

2.13.1 Reference to LIP Issues List

2.13.2 Information Model Changes

2.13.3 XML Binding Changes

2.13.4 Best Practice Changes

2.14 Cardinality of 'qcl.title'

2.14.1 Reference to LIP Issues List

2.14.2 Information Model Changes

2.14.3 XML Binding Changes

2.14.4 Best Practice Changes

2.15 Cardinality of 'qcl.date'

2.15.1 Reference to LIP Issues List