Comprehensive Learner Record Specification Version 1.0 | IMS Global Learning Consortium

Comprehensive Learner Record Specification Version 1.0 | IMS Global Learning Consortium
You are here
Specifications
Comprehensive Learner Record Standard™
Comprehensive Learner Record Specification Version 1.0
Abstract
The 1EdTech Comprehensive Learner Record (CLR) Standard has been designed to create,
transmit, and render an individual's set of achievements, as issued by multiple learning
providers, in a machine-readable format that can be curated into verifiable digital
records of achievement.
1.
Introduction
The 1EdTech Comprehensive Learner Record (CLR) Standard supports interoperability in that CLR publishers and consumers
can consistently send, receive, and verify records among conformant systems. The
CLR Standard describes an information model, service definition, and implementation
guide to allow institutions, suppliers, and others to 'extend' the traditional transcript
with records and types of information that are typically not found in a traditional
transcript, such as competency attainment, co-curricular activities, Open Badges, and to define
and facilitate an institution's learner achievements record store for collection
of CLRs.
CLR Standard data can be consumed by other schools, institutions, employers, and any other
entities that are conformant as CLR consumers. In this machine readable format, CLR
data enables granular and expansive discoverability of learning achievements and competencies that
was not previously possible.
1.1
Status of this Document
This document is intended as a starting point for those looking to implement the Comprehensive Learner Record Standard in their system. This guide can be used to get a fundamental understanding of the CLR Standard data structure and API through the examples and definitions included in the guide, as well as a central hub containing links to the specification documents, conformance certification requirements, and other important resources. This guide may be updated over time.
1EdTech strongly encourages its members and the community to provide feedback to continue
the evolution and improvement of the CLR Standard. To join the 1EdTech developer and
conformance certification community focused on CLR please visit the 1EdTech Digital Credentials
and Badging Alliance online here:
1.2
Specification Documents
CLR Standard specification documents are available on the 1EdTech website:
1EdTech Comprehensive Learner Record Standard Version 1.0
1EdTech Comprehensive Learner Record Standard v1.0: Implementation Guide
1EdTech Comprehensive Learner Record Standard v1.0: Conformance and Certification Guide
1EdTech Comprehensive Learner Record Standard v1.0: OpenAPI Schema
1EdTech Comprehensive Learner Record Standard v1.0: JSON Schema
1EdTech Comprehensive Learner Record Standard v1.0: JSON-LD Context
1.3
Where Can I Get Help?
If you have questions or need help with implementing the CLR Standard or achieving conformance
certification, here are some available resources:
Public
Forum
for all parties interested in CLR.
Affiliates
Forum
for 1EdTech Digital Credentials and Badging Alliance Members, Affiliate, and Contributing Members.
Reference Implementations
for a CLR Client Application,
a Resource Server, and an Authentication Server.
1EdTech Contributing Members have access to private GitHub repositories and a Slack
channel for CLR Project Group discussions and collaborations. Contact an 1EdTech staff
member to gain access.
1.4
Conformance Certification
1EdTech offers a process for testing the conformance of products using the 1EdTech certification test suite.
Certification designates passing a set of tests that verify the standard has been implemented correctly
and guarantees a product’s interoperability across hundreds of other certified products. The CLR
Conformance Certification Guide [
CLR-CERT-10
] provides details about the testing process, requirements,
and how to get started.
Conformance certification is much better than claims of “compliance," since the only way 1EdTech can guarantee
interoperability is by obtaining certification for the latest version of the standard. Only products listed
in the official
1EdTech Certified Product Directory
can claim conformance
certification. 1EdTech certification provides the assurance that a solution will integrate securely and
seamlessly into an institution's digital learning ecosystem.
In order to become certified a paid 1EdTech membership is necessary. Here's why: while conformance
certification provides a "seal" for passing prescribed tests it is much more than that. It is a commitment
by a supplier to the 1EdTech community for continuous support for achieving "plug and play" integration.
Certification implies ongoing community commitment to resolve problems, revise implementations and retest
as need. For that reason, only 1EdTech Contributing Members, Affiliate Members and Alliance members are eligible
to apply for conformance certification. Details and benefits of membership are listed here:
As well as sections marked as non-normative, all authoring guidelines,
diagrams, examples, and notes in this specification are non-normative.
Everything else in this specification is normative.
The key words "
MAY
", "
MUST
", "
MUST NOT
", "
OPTIONAL
", "
RECOMMENDED
", "
REQUIRED
", "
SHALL
", "
SHALL NOT
", "
SHOULD
", and "
SHOULD NOT
" in this document
are to be interpreted as described in
RFC2119
].
An implementation of this specification that fails to implement a
MUST/REQUIRED/SHALL requirement or fails to abide by a MUST NOT/SHALL NOT
prohibition is considered nonconformant. SHOULD/SHOULD NOT/RECOMMENDED
statements constitute a best practice. Ignoring a best practice does not
violate conformance but a decision to disregard such guidance should be
carefully considered. MAY/OPTIONAL statements indicate that implementers
are entirely free to choose whether or not to implement the option.
1.5
Product Directory Listing
The
1EdTech Certified Product Directory
is the official listing of products that have passed 1EdTech conformance
certification testing. Products that are listed in this directory are guaranteed
to meet the 1EdTech standards for which they have passed testing. If you experience an
integration issue with a product listed here, 1EdTech will work with the supplier to
resolve the problem. If a product is NOT listed here it has either not passed 1EdTech
testing or its certification has expired.
1.6
Key Terms and Definitions
CLR
A document of structured data created by a Publisher containing one or more Assertions about one
Learner.
Achievement
An accomplishment such as a degree, evidence of competency mastery, a course completion, or other
accomplishment. An achievement may be asserted about one or more Learners (though a CLR contains records
for only one Learner).
Alignment
A relationship between an Achievement and a node in an external educational framework such as a
CASE-10
] framework.
Assertion
The attestation made by an Issuer about a Learner regarding an Achievement. The Assertion may also
include associated evidence, results, or other metadata regarding a specific Achievement.
Association
A relationship (e.g. isChildOf, precedes, etc.) between multiple achievements.
Consumer
A REST API actor that makes requests to CLR endpoints on a Provider.
Evidence
Information supporting the issuance of an assertion such as URL to an artifact produced by the Learner.
Inspector
A Consumer that inspects a CLR to verify or validate the data.
Issuer
The profile of an organization or entity that has made a particular Assertion about a Learner. The
Issuer of an Assertion is the authoritative source for that specific Assertion.
Learner
The profile of the person who is the subject of the CLR and assertions contained in a CLR.
Protected Information
In the United States, the Family Educational Rights and Privacy Act (
FERPA
) is a Federal Law that
protects personally identifiable information (PII) from students' educational records from unauthorized
disclosure. CLRs fall within the definition of educational records; and the CLR Learner Profile contains
PII. Therefore FERPA may apply to some uses of the CLR spec.
Provider
A REST API actor that responds to requests to CLR endpoints from a Consumer.
Publisher
The profile of the organization providing the CLR (typically the educational institution, a 3rd-party
agent, or the learner). The Publisher is the official record keeper for Assertions in a CLR. In the
majority of cases, the Publisher is also the Issuer of some or all of the Assertions in a CLR. Except
in the case of a self-curated CLR, the publisher is either the issuer or has a trusted relationship
with the issuer of all the Assertions in the CLR. In the case of a self-curated collection of Assertions,
the Learner is the Publisher of the CLR.
Verification
Instructive information for third parties to verify Assertions.
2.
Specification
The Comprehensive Learner Record (CLR) Standard has four layers split between two documents:
From
A Four-Layer Framework for Data Standards
by Brandt Redd, http://EdMatrix.org
2.1
1EdTech Comprehensive Learner Record Standard Information Model Version 1.0
Data Dictionary
which defines the data elements including their name,
type, and description.
Logical Data Model
which defines the logical grouping of entities and
elements, and the relationship between entities.
2.2
1EdTech Comprehensive Learner Record Standard REST/JSON Binding Version 1.0
Serialization
which defines the specific digital format (JSON-LD) for
transmission of entities. The CLR Standard DOES NOT define a serialization format for storage.
Protocol
which defines the messaging framework (REST), security
framework (OAuth 2.0), transport layer (HTTPS), and message formats for exchanging serialized entities.
A.
Revision History
This section is non-normative.
Version No.
Release Date
Comments
CLR 1.0 Final
January 14, 2021
First release of CLR 1.0 Final. Incorporates changes since May 2020.
B.
References
B.1
Normative references
[CASE-10]
Competencies and Academic Standards Exchange (CASE) Service Version 1.0
. 1EdTech Consortium. July 2017. 1EdTech Final Release. URL:
[CLR-10]
1EdTech Comprehensive Learner Record Standard Version 1.0
. 1EdTech. January 14, 2021. 1EdTech Final Release. URL:
[CLR-CERT-10]
1EdTech Comprehensive Learner Record Standard v1.0: Conformance and Certification Guide
. 1EdTech. February 5, 2021. 1EdTech Final Release. URL:
[CLR-IMPL-10]
1EdTech Comprehensive Learner Record Standard v1.0: Implementation Guide
. 1EdTech. January 14, 2021. 1EdTech Final Release. URL:
[CLR-INFO-10]
1EdTech Comprehensive Learner Record Standard Information Model Version 1.0
. 1EdTech. January 14, 2021. 1EdTech Final Release. URL:
[CLR-JSON-10]
1EdTech Comprehensive Learner Record Standard v1.0: JSON Schema
. 1EdTech. January 14, 2021. 1EdTech Final Release. URL:
[CLR-JSONLD-10]
1EdTech Comprehensive Learner Record Standard v1.0: JSON-LD Context
. 1EdTech. January 14, 2021. 1EdTech Final Release. URL:
[CLR-OPEN-10]
1EdTech Comprehensive Learner Record Standard v1.0: OpenAPI Schema
. 1EdTech. January 14, 2021. 1EdTech Final Release. URL:
[CLR-REST-10]
1EdTech Comprehensive Learner Record Standard REST/JSON Binding Version 1.0
. 1EdTech. January 14, 2021. 1EdTech Final Release. URL:
[RFC2119]
Key words for use in RFCs to Indicate Requirement Levels
. S. Bradner. IETF. March 1997. Best Current Practice. URL:
C.
List of Contributors
The following individuals contributed to the development of this document:
Name
Organization
Role
Tamer Abuelsaad
IBM
Jeff Bohrer
1EdTech
Sherri Braxton
University of Maryland, Baltimore County
Deb Everhart
Learning Objects
Steve Gance
WA Comm & Tech Colleges
Jeff Grann
Capella University
Matthew Hailstone
Brigham Young University
Chris Houston
Capella University and eLumen
Co-Chair
Alex Hripak
Credly
Tracy Korsmo
North Dakota Information Technology
Mark Leuba
1EdTech
Jeff McNeal
State of Michigan Department of Education
Andy Miller
1EdTech
Greg Nadeau
Public Consulting Group
Co-Chair
Nate Otto
Concentric Sky
David Ward
Public Consulting Group
Ozgur Yogurtcu
AEFIS
Co-Chair
Specification Images:
Sharebar?