Comprehensive Learner Record Standard Information Model

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.

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.

Abstract

The IMS Comprehensive Learner Record Standard (CLR Standard) has been designed to create, transmit, and render an individual's set of achievements from one issuer, in a digital, machine-readable format. The standard allows for global adoption and supports shared tools within the IMS Global community.

The CLR Standard supports interoperability in that CLR Providers and Consumers can consistently send and receive records among conformant entities. The 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 and co-curricular activities, and to define and facilitate an institution's learner achievements record store for collection of CLRs.

The CLR Standard digitized information can be consumed by other schools, institutions, employers, and any other entities that are conformant as CLR consumers. In this machine readable format, CLR Standard data enables granular and expansive discoverability of learning achievements that was not previously possible.

List of Figures

List of Tables

Table 4.1 The set of interfaces.

Table 4.2 The set of operations for the "AssertionsManager" interface.

Table 4.3 The set of operations for the "ClrsManager" interface.

Table 4.4 The set of operations for the "DiscoveryManager" interface.

Table 4.5 The set of operations for the "EndorsementsManager" interface.

Table 4.6 The set of operations for the "KeysManager" interface.

Table 4.7 The set of operations for the "RevocationsManager" interface.

Table 5.1 "ClrSet" Class Description

Table 5.1.1 "id" Attribute Description

Table 5.1.2 "type" Attribute Description

Table 5.1.3 "clrs" Attribute Description

Table 5.1.4 "signedClrs" Attribute Description

Table 5.2 "DiscoveryDocument" Class Description

Table 5.2.1 "authorizationUrl" Attribute Description

Table 5.2.2 "image" Attribute Description

Table 5.2.3 "name" Attribute Description

Table 5.2.4 "privacyPolicyUrl" Attribute Description

Table 5.2.5 "registrationUrl" Attribute Description

Table 5.2.6 "scopesOffered" Attribute Description

Table 5.2.7 "termsOfServiceUrl" Attribute Description

Table 5.2.8 "tokenUrl" Attribute Description

Table 5.3 "GetAssertionPayload" Class Description

Table 5.3.1 "@context" Attribute Description

Table 5.4 "GetClrPayload" Class Description

Table 5.4.1 "@context" Attribute Description

Table 5.5 "GetCryptographicKeyPayload" Class Description

Table 5.5.1 "@context" Attribute Description

Table 5.6 "GetEndorsementPayload" Class Description

Table 5.6.1 "@context" Attribute Description

Table 5.7 "GetRevocationListPayload" Class Description

Table 5.7.1 "@context" Attribute Description

Table 5.8 "PostClrPayload" Class Description

Table 5.8.1 "clr" Attribute Description

Table 5.8.2 "signedClr" Attribute Description

Table 5.9 "imsx_StatusInfo" Class Description

Table 5.9.1 "imsx_codeMajor" Attribute Description

Table 5.9.2 "imsx_severity" Attribute Description

Table 5.9.3 "imsx_description" Attribute Description

Table 5.9.4 "imsx_codeMinor" Attribute Description

Table 6.1.1 Achievement class definitions

Table 6.1.1.1 Description of the "id" attribute for the "Achievement" class

Table 6.1.1.2 Description of the "type" attribute for the "Achievement" class

Table 6.1.1.3 Description of the "achievementType" attribute for the "Achievement" class

Table 6.1.1.4 Description of the "alignments" attribute for the "Achievement" class

Table 6.1.1.5 Description of the "associations" attribute for the "Achievement" class

Table 6.1.1.6 Description of the "creditsAvailable" attribute for the "Achievement" class

Table 6.1.1.7 Description of the "description" attribute for the "Achievement" class

Table 6.1.1.8 Description of the "endorsements" attribute for the "Achievement" class

Table 6.1.1.9 Description of the "humanCode" attribute for the "Achievement" class

Table 6.1.1.10 Description of the "identifiers" attribute for the "Achievement" class

Table 6.1.1.11 Description of the "name" attribute for the "Achievement" class

Table 6.1.1.12 Description of the "fieldOfStudy" attribute for the "Achievement" class

Table 6.1.1.13 Description of the "image" attribute for the "Achievement" class

Table 6.1.1.14 Description of the "issuer" attribute for the "Achievement" class

Table 6.1.1.15 Description of the "level" attribute for the "Achievement" class

Table 6.1.1.16 Description of the "requirement" attribute for the "Achievement" class

Table 6.1.1.17 Description of the "resultDescriptions" attribute for the "Achievement" class

Table 6.1.1.18 Description of the "signedEndorsements" attribute for the "Achievement" class

Table 6.1.1.19 Description of the "specialization" attribute for the "Achievement" class

Table 6.1.1.20 Description of the "tags" attribute for the "Achievement" class

Table 6.1.1.21 Description of the "extensions" attribute for the "Achievement" class

Table 6.1.2 Address class definitions

Table 6.1.2.1 Description of the "id" attribute for the "Address" class

Table 6.1.2.2 Description of the "type" attribute for the "Address" class

Table 6.1.2.3 Description of the "addressCountry" attribute for the "Address" class

Table 6.1.2.4 Description of the "addressLocality" attribute for the "Address" class

Table 6.1.2.5 Description of the "addressRegion" attribute for the "Address" class

Table 6.1.2.6 Description of the "postalCode" attribute for the "Address" class

Table 6.1.2.7 Description of the "postOfficeBoxNumber" attribute for the "Address" class

Table 6.1.2.8 Description of the "streetAddress" attribute for the "Address" class

Table 6.1.2.9 Description of the "extensions" attribute for the "Address" class

Table 6.1.3 Alignment class definitions

Table 6.1.3.1 Description of the "id" attribute for the "Alignment" class

Table 6.1.3.2 Description of the "type" attribute for the "Alignment" class

Table 6.1.3.3 Description of the "targetCode" attribute for the "Alignment" class

Table 6.1.3.4 Description of the "targetDescription" attribute for the "Alignment" class

Table 6.1.3.5 Description of the "targetName" attribute for the "Alignment" class

Table 6.1.3.6 Description of the "targetFramework" attribute for the "Alignment" class

Table 6.1.3.7 Description of the "targetType" attribute for the "Alignment" class

Table 6.1.3.8 Description of the "targetUrl" attribute for the "Alignment" class

Table 6.1.3.9 Description of the "extensions" attribute for the "Alignment" class

Table 6.1.4 Artifact class definitions

Table 6.1.4.1 Description of the "type" attribute for the "Artifact" class

Table 6.1.4.2 Description of the "description" attribute for the "Artifact" class

Table 6.1.4.3 Description of the "name" attribute for the "Artifact" class

Table 6.1.4.4 Description of the "url" attribute for the "Artifact" class

Table 6.1.4.5 Description of the "extensions" attribute for the "Artifact" class

Table 6.1.5 Assertion class definitions

Table 6.1.5.1 Description of the "id" attribute for the "Assertion" class

Table 6.1.5.2 Description of the "type" attribute for the "Assertion" class

Table 6.1.5.3 Description of the "achievement" attribute for the "Assertion" class

Table 6.1.5.4 Description of the "activityEndDate" attribute for the "Assertion" class

Table 6.1.5.5 Description of the "activityStartDate" attribute for the "Assertion" class

Table 6.1.5.6 Description of the "creditsEarned" attribute for the "Assertion" class

Table 6.1.5.7 Description of the "endorsements" attribute for the "Assertion" class

Table 6.1.5.8 Description of the "evidence" attribute for the "Assertion" class

Table 6.1.5.9 Description of the "expires" attribute for the "Assertion" class

Table 6.1.5.10 Description of the "image" attribute for the "Assertion" class

Table 6.1.5.11 Description of the "issuedOn" attribute for the "Assertion" class

Table 6.1.5.12 Description of the "licenseNumber" attribute for the "Assertion" class

Table 6.1.5.13 Description of the "narrative" attribute for the "Assertion" class

Table 6.1.5.14 Description of the "recipient" attribute for the "Assertion" class

Table 6.1.5.15 Description of the "results" attribute for the "Assertion" class

Table 6.1.5.16 Description of the "revocationReason" attribute for the "Assertion" class

Table 6.1.5.17 Description of the "revoked" attribute for the "Assertion" class

Table 6.1.5.18 Description of the "role" attribute for the "Assertion" class

Table 6.1.5.19 Description of the "signedEndorsements" attribute for the "Assertion" class

Table 6.1.5.20 Description of the "source" attribute for the "Assertion" class

Table 6.1.5.21 Description of the "term" attribute for the "Assertion" class

Table 6.1.5.22 Description of the "verification" attribute for the "Assertion" class

Table 6.1.5.23 Description of the "extensions" attribute for the "Assertion" class

Table 6.1.6 Association class definitions

Table 6.1.6.1 Description of the "associationType" attribute for the "Association" class

Table 6.1.6.2 Description of the "targetId" attribute for the "Association" class

Table 6.1.6.3 Description of the "title" attribute for the "Association" class

Table 6.1.6.4 Description of the "extensions" attribute for the "Association" class

Table 6.1.7 Clr class definitions

Table 6.1.7.1 Description of the "id" attribute for the "Clr" class

Table 6.1.7.2 Description of the "type" attribute for the "Clr" class

Table 6.1.7.3 Description of the "achievements" attribute for the "Clr" class

Table 6.1.7.4 Description of the "assertions" attribute for the "Clr" class

Table 6.1.7.5 Description of the "endorsements" attribute for the "Clr" class

Table 6.1.7.6 Description of the "issuedOn" attribute for the "Clr" class

Table 6.1.7.7 Description of the "learner" attribute for the "Clr" class

Table 6.1.7.8 Description of the "name" attribute for the "Clr" class

Table 6.1.7.9 Description of the "partial" attribute for the "Clr" class

Table 6.1.7.10 Description of the "publisher" attribute for the "Clr" class

Table 6.1.7.11 Description of the "revocationReason" attribute for the "Clr" class

Table 6.1.7.12 Description of the "revoked" attribute for the "Clr" class

Table 6.1.7.13 Description of the "signedAssertions" attribute for the "Clr" class

Table 6.1.7.14 Description of the "signedEndorsements" attribute for the "Clr" class

Table 6.1.7.15 Description of the "verification" attribute for the "Clr" class

Table 6.1.7.16 Description of the "extensions" attribute for the "Clr" class

Table 6.1.8 ClrSet class definitions

Table 6.1.8.1 Description of the "id" attribute for the "ClrSet" class

Table 6.1.8.2 Description of the "type" attribute for the "ClrSet" class

Table 6.1.8.3 Description of the "clrs" attribute for the "ClrSet" class

Table 6.1.8.4 Description of the "signedClrs" attribute for the "ClrSet" class

Table 6.1.9 Criteria class definitions

Table 6.1.9.1 Description of the "id" attribute for the "Criteria" class

Table 6.1.9.2 Description of the "type" attribute for the "Criteria" class

Table 6.1.9.3 Description of the "narrative" attribute for the "Criteria" class

Table 6.1.9.4 Description of the "extensions" attribute for the "Criteria" class

Table 6.1.10 CryptographicKey class definitions

Table 6.1.10.1 Description of the "id" attribute for the "CryptographicKey" class

Table 6.1.10.2 Description of the "type" attribute for the "CryptographicKey" class

Table 6.1.10.3 Description of the "owner" attribute for the "CryptographicKey" class

Table 6.1.10.4 Description of the "publicKeyPem" attribute for the "CryptographicKey" class

Table 6.1.10.5 Description of the "extensions" attribute for the "CryptographicKey" class

Table 6.1.11 DiscoveryDocument class definitions

Table 6.1.11.1 Description of the "authorizationUrl" attribute for the "DiscoveryDocument" class

Table 6.1.11.2 Description of the "image" attribute for the "DiscoveryDocument" class

Table 6.1.11.3 Description of the "name" attribute for the "DiscoveryDocument" class

Table 6.1.11.4 Description of the "privacyPolicyUrl" attribute for the "DiscoveryDocument" class

Table 6.1.11.5 Description of the "registrationUrl" attribute for the "DiscoveryDocument" class

Table 6.1.11.6 Description of the "scopesOffered" attribute for the "DiscoveryDocument" class

Table 6.1.11.7 Description of the "termsOfServiceUrl" attribute for the "DiscoveryDocument" class

Table 6.1.11.8 Description of the "tokenUrl" attribute for the "DiscoveryDocument" class

Table 6.1.12 Endorsement class definitions

Table 6.1.12.1 Description of the "id" attribute for the "Endorsement" class

Table 6.1.12.2 Description of the "type" attribute for the "Endorsement" class

Table 6.1.12.3 Description of the "claim" attribute for the "Endorsement" class

Table 6.1.12.4 Description of the "issuedOn" attribute for the "Endorsement" class

Table 6.1.12.5 Description of the "issuer" attribute for the "Endorsement" class

Table 6.1.12.6 Description of the "revocationReason" attribute for the "Endorsement" class

Table 6.1.12.7 Description of the "revoked" attribute for the "Endorsement" class

Table 6.1.12.8 Description of the "verification" attribute for the "Endorsement" class

Table 6.1.12.9 Description of the "extensions" attribute for the "Endorsement" class

Table 6.1.13 EndorsementClaim class definitions

Table 6.1.13.1 Description of the "id" attribute for the "EndorsementClaim" class

Table 6.1.13.2 Description of the "type" attribute for the "EndorsementClaim" class

Table 6.1.13.3 Description of the "endorsementComment" attribute for the "EndorsementClaim" class

Table 6.1.13.4 Description of the "extensions" attribute for the "EndorsementClaim" class

Table 6.1.14 EndorsementProfile class definitions

Table 6.1.14.1 Description of the "id" attribute for the "EndorsementProfile" class

Table 6.1.14.2 Description of the "type" attribute for the "EndorsementProfile" class

Table 6.1.14.3 Description of the "additionalName" attribute for the "EndorsementProfile" class

Table 6.1.14.4 Description of the "address" attribute for the "EndorsementProfile" class

Table 6.1.14.5 Description of the "description" attribute for the "EndorsementProfile" class

Table 6.1.14.6 Description of the "email" attribute for the "EndorsementProfile" class

Table 6.1.14.7 Description of the "familyName" attribute for the "EndorsementProfile" class

Table 6.1.14.8 Description of the "givenName" attribute for the "EndorsementProfile" class

Table 6.1.14.9 Description of the "identifiers" attribute for the "EndorsementProfile" class

Table 6.1.14.10 Description of the "image" attribute for the "EndorsementProfile" class

Table 6.1.14.11 Description of the "name" attribute for the "EndorsementProfile" class

Table 6.1.14.12 Description of the "official" attribute for the "EndorsementProfile" class

Table 6.1.14.13 Description of the "publicKey" attribute for the "EndorsementProfile" class

Table 6.1.14.14 Description of the "revocationList" attribute for the "EndorsementProfile" class

Table 6.1.14.15 Description of the "sourcedId" attribute for the "EndorsementProfile" class

Table 6.1.14.16 Description of the "studentId" attribute for the "EndorsementProfile" class

Table 6.1.14.17 Description of the "telephone" attribute for the "EndorsementProfile" class

Table 6.1.14.18 Description of the "url" attribute for the "EndorsementProfile" class

Table 6.1.14.19 Description of the "verification" attribute for the "EndorsementProfile" class

Table 6.1.14.20 Description of the "extensions" attribute for the "EndorsementProfile" class

Table 6.1.15 Evidence class definitions

Table 6.1.15.1 Description of the "id" attribute for the "Evidence" class

Table 6.1.15.2 Description of the "type" attribute for the "Evidence" class

Table 6.1.15.3 Description of the "artifacts" attribute for the "Evidence" class

Table 6.1.15.4 Description of the "audience" attribute for the "Evidence" class

Table 6.1.15.5 Description of the "description" attribute for the "Evidence" class

Table 6.1.15.6 Description of the "genre" attribute for the "Evidence" class

Table 6.1.15.7 Description of the "name" attribute for the "Evidence" class

Table 6.1.15.8 Description of the "narrative" attribute for the "Evidence" class

Table 6.1.15.9 Description of the "extensions" attribute for the "Evidence" class

Table 6.1.16 GetAssertionPayload class definitions

Table 6.1.16.1 Description of the "@context" attribute for the "GetAssertionPayload" class

Table 6.1.17 GetClrPayload class definitions

Table 6.1.17.1 Description of the "@context" attribute for the "GetClrPayload" class

Table 6.1.18 GetCryptographicKeyPayload class definitions

Table 6.1.18.1 Description of the "@context" attribute for the "GetCryptographicKeyPayload" class

Table 6.1.19 GetEndorsementPayload class definitions

Table 6.1.19.1 Description of the "@context" attribute for the "GetEndorsementPayload" class

Table 6.1.20 GetRevocationListPayload class definitions

Table 6.1.20.1 Description of the "@context" attribute for the "GetRevocationListPayload" class

Table 6.1.21 Identity class definitions

Table 6.1.21.1 Description of the "id" attribute for the "Identity" class

Table 6.1.21.2 Description of the "type" attribute for the "Identity" class

Table 6.1.21.3 Description of the "identity" attribute for the "Identity" class

Table 6.1.21.4 Description of the "hashed" attribute for the "Identity" class

Table 6.1.21.5 Description of the "salt" attribute for the "Identity" class

Table 6.1.21.6 Description of the "extensions" attribute for the "Identity" class

Table 6.1.22 PostClrPayload class definitions

Table 6.1.22.1 Description of the "clr" attribute for the "PostClrPayload" class

Table 6.1.22.2 Description of the "signedClr" attribute for the "PostClrPayload" class

Table 6.1.23 Profile class definitions

Table 6.1.23.1 Description of the "id" attribute for the "Profile" class

Table 6.1.23.2 Description of the "type" attribute for the "Profile" class

Table 6.1.23.3 Description of the "address" attribute for the "Profile" class

Table 6.1.23.4 Description of the "additionalName" attribute for the "Profile" class

Table 6.1.23.5 Description of the "birthDate" attribute for the "Profile" class

Table 6.1.23.6 Description of the "description" attribute for the "Profile" class

Table 6.1.23.7 Description of the "email" attribute for the "Profile" class

Table 6.1.23.8 Description of the "endorsements" attribute for the "Profile" class

Table 6.1.23.9 Description of the "familyName" attribute for the "Profile" class

Table 6.1.23.10 Description of the "givenName" attribute for the "Profile" class

Table 6.1.23.11 Description of the "identifiers" attribute for the "Profile" class

Table 6.1.23.12 Description of the "image" attribute for the "Profile" class

Table 6.1.23.13 Description of the "name" attribute for the "Profile" class

Table 6.1.23.14 Description of the "official" attribute for the "Profile" class

Table 6.1.23.15 Description of the "parentOrg" attribute for the "Profile" class

Table 6.1.23.16 Description of the "publicKey" attribute for the "Profile" class

Table 6.1.23.17 Description of the "revocationList" attribute for the "Profile" class

Table 6.1.23.18 Description of the "signedEndorsements" attribute for the "Profile" class

Table 6.1.23.19 Description of the "sourcedId" attribute for the "Profile" class

Table 6.1.23.20 Description of the "studentId" attribute for the "Profile" class

Table 6.1.23.21 Description of the "telephone" attribute for the "Profile" class

Table 6.1.23.22 Description of the "url" attribute for the "Profile" class

Table 6.1.23.23 Description of the "verification" attribute for the "Profile" class

Table 6.1.23.24 Description of the "extensions" attribute for the "Profile" class

Table 6.1.24 Result class definitions

Table 6.1.24.1 Description of the "id" attribute for the "Result" class

Table 6.1.24.2 Description of the "type" attribute for the "Result" class

Table 6.1.24.3 Description of the "achievedLevel" attribute for the "Result" class

Table 6.1.24.4 Description of the "alignments" attribute for the "Result" class

Table 6.1.24.5 Description of the "resultDescription" attribute for the "Result" class

Table 6.1.24.6 Description of the "status" attribute for the "Result" class

Table 6.1.24.7 Description of the "value" attribute for the "Result" class

Table 6.1.24.8 Description of the "extensions" attribute for the "Result" class

Table 6.1.25 ResultDescription class definitions

Table 6.1.25.1 Description of the "id" attribute for the "ResultDescription" class

Table 6.1.25.2 Description of the "type" attribute for the "ResultDescription" class

Table 6.1.25.3 Description of the "alignments" attribute for the "ResultDescription" class

Table 6.1.25.4 Description of the "allowedValues" attribute for the "ResultDescription" class

Table 6.1.25.5 Description of the "name" attribute for the "ResultDescription" class

Table 6.1.25.6 Description of the "requiredLevel" attribute for the "ResultDescription" class

Table 6.1.25.7 Description of the "requiredValue" attribute for the "ResultDescription" class

Table 6.1.25.8 Description of the "resultType" attribute for the "ResultDescription" class

Table 6.1.25.9 Description of the "rubricCriterionLevels" attribute for the "ResultDescription" class

Table 6.1.25.10 Description of the "valueMax" attribute for the "ResultDescription" class

Table 6.1.25.11 Description of the "valueMin" attribute for the "ResultDescription" class

Table 6.1.25.12 Description of the "extensions" attribute for the "ResultDescription" class

Table 6.1.26 RevocationList class definitions

Table 6.1.26.1 Description of the "id" attribute for the "RevocationList" class

Table 6.1.26.2 Description of the "type" attribute for the "RevocationList" class

Table 6.1.26.3 Description of the "issuer" attribute for the "RevocationList" class

Table 6.1.26.4 Description of the "revokedAssertions" attribute for the "RevocationList" class

Table 6.1.27 RubricCriterionLevel class definitions

Table 6.1.27.1 Description of the "id" attribute for the "RubricCriterionLevel" class

Table 6.1.27.2 Description of the "type" attribute for the "RubricCriterionLevel" class

Table 6.1.27.3 Description of the "alignments" attribute for the "RubricCriterionLevel" class

Table 6.1.27.4 Description of the "description" attribute for the "RubricCriterionLevel" class

Table 6.1.27.5 Description of the "level" attribute for the "RubricCriterionLevel" class

Table 6.1.27.6 Description of the "name" attribute for the "RubricCriterionLevel" class

Table 6.1.27.7 Description of the "points" attribute for the "RubricCriterionLevel" class

Table 6.1.27.8 Description of the "extensions" attribute for the "RubricCriterionLevel" class

Table 6.1.28 SystemIdentifier class definitions

Table 6.1.28.1 Description of the "type" attribute for the "SystemIdentifier" class

Table 6.1.28.2 Description of the "identifier" attribute for the "SystemIdentifier" class

Table 6.1.28.3 Description of the "identifierType" attribute for the "SystemIdentifier" class

Table 6.1.28.4 Description of the "extensions" attribute for the "SystemIdentifier" class

Table 6.1.29 Verification class definitions

Table 6.1.29.1 Description of the "id" attribute for the "Verification" class

Table 6.1.29.2 Description of the "type" attribute for the "Verification" class

Table 6.1.29.3 Description of the "allowedOrigins" attribute for the "Verification" class

Table 6.1.29.4 Description of the "creator" attribute for the "Verification" class

Table 6.1.29.5 Description of the "startsWith" attribute for the "Verification" class

Table 6.1.29.6 Description of the "verificationProperty" attribute for the "Verification" class

Table 6.1.29.7 Description of the "extensions" attribute for the "Verification" class

Table 6.1.30 imsx_CodeMinor class definitions

Table 6.1.30.1 Description of the "imsx_codeMinorField" attribute for the "imsx_CodeMinor" class

Table 6.1.31 imsx_CodeMinorField class definitions

Table 6.1.31.1 Description of the "imsx_codeMinorFieldName" attribute for the "imsx_CodeMinorField" class

Table 6.1.31.2 Description of the "imsx_codeMinorFieldValue" attribute for the "imsx_CodeMinorField" class

Table 6.1.32 imsx_StatusInfo class definitions

Table 6.1.32.1 Description of the "imsx_codeMajor" attribute for the "imsx_StatusInfo" class

Table 6.1.32.2 Description of the "imsx_severity" attribute for the "imsx_StatusInfo" class

Table 6.1.32.3 Description of the "imsx_description" attribute for the "imsx_StatusInfo" class

Table 6.1.32.4 Description of the "imsx_codeMinor" attribute for the "imsx_StatusInfo" class

Table 6.2.1 CompactJws class definitions

Table 6.2.1.1 Description of the "pattern" attribute for the "CompactJws" class

Table 6.2.2 EnumExtString class definitions

Table 6.2.2.1 Description of the "pattern" attribute for the "EnumExtString" class

Table 6.2.3 IRI class definitions

Table 6.2.4 Markdown class definitions

Table 6.2.5 UUID class definitions

Table 6.2.5.1 Description of the "pattern" attribute for the "UUID" class

Table 6.3.1 AchievementType class definitions

Table 6.3.2 AlignmentTargetType class definitions

Table 6.3.3 AssociationType class definitions

Table 6.3.4 ResultStatusType class definitions

Table 6.3.5 ResultType class definitions

Table 6.3.6 SystemIdentifierType class definitions

Table 6.3.7 VerificationType class definitions

Table 6.3.8 imsx_CodeMajorEnum class definitions

Table 6.3.9 imsx_CodeMinorValueEnum class definitions

Table 6.3.10 imsx_SeverityEnum class definitions

Table 6.4.1 ExtensibleAchievementType class description

Table 6.4.2 ExtensibleAlignmentTargetType class description

Table 6.4.3 ExtensibleResultType class description

Table 6.4.4 ExtensibleSystemIdentifierType class description

Table A3.1 The key to the descriptions of data model diagrams

Table A3.2 The key to the descriptions of the data class tables

Table A3.3 The key to the descriptions of the data attribute/characteristic tables

Table A3.4 The key to the descriptions of the enumerated vocabulary tables

Table A3.5 The key to the descriptions of the external vocabulary tables

Table A3.6 The key to the descriptions of the import class tables

1. Introduction

1.1. Scope and Context

This document is the IMS Comprehensive Learner Record Standard Information Model Version 1.0 and as such it is used as the basis for the development of the following documents:

This information model defines the IMS Comprehensive Learner Record Standard Abstract Application Programming Interface (a-API). This service model is described using the Unified Modeling Language (UML) based upon the IMS Global Model Driven Specification approach and the associated modelling toolkit [I-BAT, 06]. This means that this specification is based upon the concepts of:

1.2. Conventions

All sections marked as non-normative, all authoring guidelines, diagrams (with the exception of the UML diagrams), examples, and notes in this specification are non-normative. Everything else in this specification is normative.

The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in [RFC 2119]. This means that from the perspective of conformance:

The Conformance and Certification Guide for this specification may introduce greater normative constraints than those defined here for specific service or implementation categories.

The SHOULD/SHOULD NOT/RECOMMENDED statements MUST NOT be used in any document, or section of a document, that is responsible for defining the information model and/or the associated bindings and/or conformance and certification.

1.3. Structure of this Document

1.4. Terms and Nomenclature

2. Service Architecture and Specification Model

2.1. An Abstract Representation

It is important to remember that this document contains a description of the underlying information model in terms of the abstract Application Programming Interface (API). The manner in which this abstract representation is visualized is not intended to dictate the implementation form of the Service. The breakdown of the service into its interface classes is a convenient way to document the set of behaviors. The objective for producing these interfaces is to identify and define the messages that are exchanged between the end-systems to realize the system behaviors required of the service.

The internal organization of an implementation of the full abstract API is beyond the scope of this specification. The only constraint is that the external behavior of the abstract API complies with this specification. This means that a .NET, J2EE, etc. physical implementation of this abstract API does not have to represent the functionality using the same breakdown of operations/methods. This physical implementation is not subject to the conformance specification.

It is important to note that the UML representation of the interfaces is used to help develop and document the Information Model and various Bindings. It is not a requirement for a system to implement this interface as defined i.e. to use the same parameters, etc. Conformance against this specification will be confirmed by inspecting the appropriate binding of the information model and ensuring that the relevant information is present and that different sequences of activity result in the predicted and mandated behavior. It is essential that the behaviors described by each of the operations are fully supported and that the behaviors described by different sequences are also maintained.

2.2. A Synchronous Service

The CLR Standard service is a synchronous service i.e. the consumer is blocked until the response from the provider is received. This means that a consumer can only have one outstanding request with a service provider. The corresponding sequence of actions is shown in the figure below:

The figure above shows the action sequence from the prespective of the consumer but It must be noted that a Service Provider will be expected to support concurrent requests (perhaps hundreds to thousands) from many consumers.

3. Conceptual Model

3.1. Logical Data Model

The data model for the CLR Standard consists of a set of core classes which are used to define the data properties.

3.2. Interoperability Model

Diagram of the interoperability supplied by the Comprehensive Learner Record Standard.

The CLR Standard defines how comprehensive learner record data is exchanged (indicated by the arrows in the diagram). It does not address how the data is stored and/or processed in the systems that exchange the information. Nor does it address how the data is displayed or used by applications.

The CLR Standard is realized as a web service (the actual implementation is defined by the associated binding specification and, currently, only a REST/JSON based binding is available). Intermediate systems must support both Consumer and Provider functionality.

4. The Behavior Model

4.1 Service Definition

Table 4.1 The set of interfaces.
Interface	Description
AssertionsManager	The set of service operations that manage access to Assertions for Hosted Verification.
ClrsManager	The set of service operations that manage access to CLRs.
DiscoveryManager	The set of service operations that manage access to the DiscoveryDocument for dynamic consumer registration.
EndorsementsManager	The set of service operations that manage access to Endorsements for Hosted Verification.
KeysManager	The set of service operations that manage access to CryptographicKeys for Signed Verification.
RevocationsManager	The set of service operations that manage access to RevocationLists for Signed Verification.

4.2 AssertionsManager Interface Description

Table 4.2 The set of operations for the "AssertionsManager" interface.
Operation	Description
getAssertion	Returns the current version of the specified Assertion. This operation is used to verify a Hosted Assertion.

4.2.1 "getAssertion" Operation

4.3 ClrsManager Interface Description

Table 4.3 The set of operations for the "ClrsManager" interface.
Operation	Description
getClrs	The set of CLRs the user is authorized to access are returned in the payload of the response message.
postClr	Create or replace a CLR.
deleteClr	Delete a CLR.
getClr	Returns the current version of the specified Clr. This operation is used to verify a Hosted Clr.

4.3.1 "getClrs" Operation

4.3.2 "postClr" Operation

4.3.3 "deleteClr" Operation

4.3.4 "getClr" Operation

4.4 DiscoveryManager Interface Description

Table 4.4 The set of operations for the "DiscoveryManager" interface.
Operation	Description
getDiscoveryDocument	Returns the DiscoveryDocument if the provider supports dynamic CLR consumer registration.

4.4.1 "getDiscoveryDocument" Operation

4.5 EndorsementsManager Interface Description

Table 4.5 The set of operations for the "EndorsementsManager" interface.
Operation	Description
getEndorsement	Returns the current version of the specified Endorsement. This operation is used to verify a Hosted Endorsement.

4.5.1 "getEndorsement" Operation

4.6 KeysManager Interface Description

Table 4.6 The set of operations for the "KeysManager" interface.
Operation	Description
getKey	Returns the current version of the specified CryptographicKey. This operation is used to verify a Signed Assertion, Clr, or Endorsement.

4.6.1 "getKey" Operation

4.7 RevocationsManager Interface Description

Table 4.7 The set of operations for the "RevocationsManager" interface.
Operation	Description
getRevocationList	Returns the current version of the issuer's RevocationList. This operation is used to verify a Signed Assertion, Clr, or Endorsement.

4.7.1 "getRevocationList" Operation

5. The Interface Model

5.1 ClrSet Class Description

Table 5.1 Description of the "ClrSet" class.
Descriptor	Definition
Class Name	ClrSet
Class Type	Container [ Unordered ]
Parents	Service parameter data-type used in the following operations: getClrs
Characteristics	There are no characteristics.
Children	The set of children attributes are: id type clrs signedClrs
Description	A set of CLRs.

5.1.1 "id" Attribute Description

Table 5.1.1 Description of the "id" attribute for the "ClrSet" class.
Descriptor	Definition
Attribute Name	id
Data Type	IRI
Value Space	Container [ DerivedType ]
Scope	Local ("-")
Multiplicity	[0..1]
Description	Unique IRI for the ClrSet.

5.1.2 "type" Attribute Description

Table 5.1.2 Description of the "type" attribute for the "ClrSet" class.
Descriptor	Definition
Attribute Name	type
Data Type	IRI
Value Space	Container [ DerivedType ]
Scope	Local ("-")
Multiplicity	[0..1]
Description	The JSON-LD type of this object. Normally 'ClrSet'.

5.1.3 "clrs" Attribute Description

Table 5.1.3 Description of the "clrs" attribute for the "ClrSet" class.
Descriptor	Definition
Attribute Name	clrs
Data Type	Clr
Value Space	Container [ Unordered ]
Scope	Local ("-")
Multiplicity	[0.. unbounded]
Description	A set of Clrs

5.1.4 "signedClrs" Attribute Description

Table 5.1.4 Description of the "signedClrs" attribute for the "ClrSet" class.
Descriptor	Definition
Attribute Name	signedClrs
Data Type	CompactJws
Value Space	Container [ DerivedType ]
Scope	Local ("-")
Multiplicity	[0.. unbounded]
Description	A set of Clrs in JWS Compact Serialization format.

5.2 DiscoveryDocument Class Description

Table 5.2 Description of the "DiscoveryDocument" class.
Descriptor	Definition
Class Name	DiscoveryDocument
Class Type	Container [ Unordered ]
Parents	Service parameter data-type used in the following operations: getDiscoveryDocument
Characteristics	There are no characteristics.
Children	The set of children attributes are: authorizationUrl image name privacyPolicyUrl registrationUrl scopesOffered termsOfServiceUrl tokenUrl
Description	Configuration information about the provider implementation.

5.2.1 "authorizationUrl" Attribute Description

Table 5.2.1 Description of the "authorizationUrl" attribute for the "DiscoveryDocument" class.
Descriptor	Definition
Attribute Name	authorizationUrl
Data Type	AnyURI (Primitive-type)
Value Space	See Appendix A3.3.
Scope	Local ("-")
Multiplicity	[1]
Description	A fully qualifed URL to the provider's OAuth 2.0 Authorization endpoint.

5.2.2 "image" Attribute Description

Table 5.2.2 Description of the "image" attribute for the "DiscoveryDocument" class.
Descriptor	Definition
Attribute Name	image
Data Type	IRI
Value Space	Container [ DerivedType ]
Scope	Local ("-")
Multiplicity	[0..1]
Description	An image representing the provider. May be a Data URI or the URL where the image may be found.

5.2.3 "name" Attribute Description

Table 5.2.3 Description of the "name" attribute for the "DiscoveryDocument" class.
Descriptor	Definition
Attribute Name	name
Data Type	String (Primitive-type)
Value Space	See Appendix A3.3.
Scope	Local ("-")
Multiplicity	[1]
Description	The user-facing name of the platform providing CLR services.

5.2.4 "privacyPolicyUrl" Attribute Description

Table 5.2.4 Description of the "privacyPolicyUrl" attribute for the "DiscoveryDocument" class.
Descriptor	Definition
Attribute Name	privacyPolicyUrl
Data Type	AnyURI (Primitive-type)
Value Space	See Appendix A3.3.
Scope	Local ("-")
Multiplicity	[1]
Description	A fully qualified URL to the provider's privacy policy.

5.2.5 "registrationUrl" Attribute Description

Table 5.2.5 Description of the "registrationUrl" attribute for the "DiscoveryDocument" class.
Descriptor	Definition
Attribute Name	registrationUrl
Data Type	AnyURI (Primitive-type)
Value Space	See Appendix A3.3.
Scope	Local ("-")
Multiplicity	[1]
Description	A fully qualified URL to the provider's OAuth 2.0 Registration endpoint.

5.2.6 "scopesOffered" Attribute Description

Table 5.2.6 Description of the "scopesOffered" attribute for the "DiscoveryDocument" class.
Descriptor	Definition
Attribute Name	scopesOffered
Data Type	AnyURI (Primitive-type)
Value Space	See Appendix A3.3.
Scope	Local ("-")
Multiplicity	[1.. unbounded]
Description	An array of OAuth 2.0 Scopes supported by the provider.

5.2.7 "termsOfServiceUrl" Attribute Description

Table 5.2.7 Description of the "termsOfServiceUrl" attribute for the "DiscoveryDocument" class.
Descriptor	Definition
Attribute Name	termsOfServiceUrl
Data Type	AnyURI (Primitive-type)
Value Space	See Appendix A3.3.
Scope	Local ("-")
Multiplicity	[1]
Description	A fully qualified URL to the provider's terms of service.

5.2.8 "tokenUrl" Attribute Description

Table 5.2.8 Description of the "tokenUrl" attribute for the "DiscoveryDocument" class.
Descriptor	Definition
Attribute Name	tokenUrl
Data Type	AnyURI (Primitive-type)
Value Space	See Appendix A3.3.
Scope	Local ("-")
Multiplicity	[1]
Description	A fully qualified URL to the provider's OAuth 2.0 Token endpoint.

5.3 GetAssertionPayload Class Description

Table 5.3 Description of the "GetAssertionPayload" class.
Descriptor	Definition
Class Name	GetAssertionPayload
Class Type	Container [ Unordered ]
Parents	Service parameter data-type used in the following operations: getAssertion
Characteristics	There are no characteristics.
Children	The set of children attributes are: @context The set of directly inherited children attributes are: id type achievement activityEndDate activityStartDate creditsEarned endorsements evidence expires image issuedOn licenseNumber narrative recipient results revocationReason revoked role signedEndorsements source term verification extensions
Description	Payload for the 'getAssertion' operation.

5.3.1 "@context" Attribute Description

Table 5.3.1 Description of the "@context" attribute for the "GetAssertionPayload" class.
Descriptor	Definition
Attribute Name	@context
Data Type	String (Primitive-type)
Value Space	See Appendix A3.3.
Scope	Local ("-")
Multiplicity	[1]
Description	The JSON-LD @context.

5.4 GetClrPayload Class Description

Table 5.4 Description of the "GetClrPayload" class.
Descriptor	Definition
Class Name	GetClrPayload
Class Type	Container [ Unordered ]
Parents	Service parameter data-type used in the following operations: getClr
Characteristics	There are no characteristics.
Children	The set of children attributes are: @context The set of directly inherited children attributes are: id type achievements assertions endorsements issuedOn learner name partial publisher revocationReason revoked signedAssertions signedEndorsements verification extensions
Description	Payload for the 'getClr' operation.

5.4.1 "@context" Attribute Description

Table 5.4.1 Description of the "@context" attribute for the "GetClrPayload" class.
Descriptor	Definition
Attribute Name	@context
Data Type	String (Primitive-type)
Value Space	See Appendix A3.3.
Scope	Local ("-")
Multiplicity	[1]
Description	The JSON-LD @context.

5.5 GetCryptographicKeyPayload Class Description

Table 5.5 Description of the "GetCryptographicKeyPayload" class.
Descriptor	Definition
Class Name	GetCryptographicKeyPayload
Class Type	Container [ Unordered ]
Parents	Service parameter data-type used in the following operations: getKey
Characteristics	There are no characteristics.
Children	The set of children attributes are: @context The set of directly inherited children attributes are: id type owner publicKeyPem extensions
Description	Payload for the 'getKey' operation.

5.5.1 "@context" Attribute Description

Table 5.5.1 Description of the "@context" attribute for the "GetCryptographicKeyPayload" class.
Descriptor	Definition
Attribute Name	@context
Data Type	String (Primitive-type)
Value Space	See Appendix A3.3.
Scope	Local ("-")
Multiplicity	[1]
Description	The JSON-LD @context.

5.6 GetEndorsementPayload Class Description

Table 5.6 Description of the "GetEndorsementPayload" class.
Descriptor	Definition
Class Name	GetEndorsementPayload
Class Type	Container [ Unordered ]
Parents	Service parameter data-type used in the following operations: getEndorsement
Characteristics	There are no characteristics.
Children	The set of children attributes are: @context The set of directly inherited children attributes are: id type claim issuedOn issuer revocationReason revoked verification extensions
Description	Payload for the 'getEndorsement' operation.

5.6.1 "@context" Attribute Description

Table 5.6.1 Description of the "@context" attribute for the "GetEndorsementPayload" class.
Descriptor	Definition
Attribute Name	@context
Data Type	String (Primitive-type)
Value Space	See Appendix A3.3.
Scope	Local ("-")
Multiplicity	[1]
Description	The JSON-LD @context.

5.7 GetRevocationListPayload Class Description

Table 5.7 Description of the "GetRevocationListPayload" class.
Descriptor	Definition
Class Name	GetRevocationListPayload
Class Type	Container [ Unordered ]
Parents	Service parameter data-type used in the following operations: getRevocationList
Characteristics	There are no characteristics.
Children	The set of children attributes are: @context The set of directly inherited children attributes are: id type issuer revokedAssertions
Description	Payload for the 'getRevocationList' operation.

5.7.1 "@context" Attribute Description

Table 5.7.1 Description of the "@context" attribute for the "GetRevocationListPayload" class.
Descriptor	Definition
Attribute Name	@context
Data Type	String (Primitive-type)
Value Space	See Appendix A3.3.
Scope	Local ("-")
Multiplicity	[1]
Description	The JSON-LD @context.

5.8 PostClrPayload Class Description

Table 5.8 Description of the "PostClrPayload" class.
Descriptor	Definition
Class Name	PostClrPayload
Class Type	Container [ Unordered ]
Parents	Service parameter data-type used in the following operations: postClr
Characteristics	There are no characteristics.
Children	The set of children attributes are: clr signedClr
Description	Payload for the 'postClr' operation. Only one format (signed or unsigned) is allowed.

5.8.1 "clr" Attribute Description

Table 5.8.1 Description of the "clr" attribute for the "PostClrPayload" class.
Descriptor	Definition
Attribute Name	clr
Data Type	Clr
Value Space	Container [ Unordered ]
Scope	Local ("-")
Multiplicity	[0..1]
Description	The Clr if not signed.

5.8.2 "signedClr" Attribute Description

Table 5.8.2 Description of the "signedClr" attribute for the "PostClrPayload" class.
Descriptor	Definition
Attribute Name	signedClr
Data Type	CompactJws
Value Space	Container [ DerivedType ]
Scope	Local ("-")
Multiplicity	[0..1]
Description	The signed Clr in JWS Compact Serialization format.

5.9 imsx_StatusInfo Class Description

Table 5.9 Description of the "imsx_StatusInfo" class.
Descriptor	Definition
Class Name	imsx_StatusInfo
Class Type	Container [ Sequence ]
Parents	Service parameter data-type used in the following operations: getClrs postClr deleteClr getClr getAssertion getKey getEndorsement getRevocationList
Characteristics	There are no characteristics.
Children	The set of children attributes are: imsx_codeMajor imsx_severity imsx_description imsx_codeMinor
Description	This is the container for the status code and associated information returned within the HTTP messages received from the Service Provider.

5.9.1 "imsx_codeMajor" Attribute Description

Table 5.9.1 Description of the "imsx_codeMajor" attribute for the "imsx_StatusInfo" class.
Descriptor	Definition
Attribute Name	imsx_codeMajor
Data Type	imsx_CodeMajorEnum
Value Space	Enumerated value set of: { success \| failure \| processing \| unsupported }
Scope	Local ("-")
Multiplicity	[1]
Description	The code major value (from the corresponding enumerated vocabulary).

5.9.2 "imsx_severity" Attribute Description

Table 5.9.2 Description of the "imsx_severity" attribute for the "imsx_StatusInfo" class.
Descriptor	Definition
Attribute Name	imsx_severity
Data Type	imsx_SeverityEnum
Value Space	Enumerated value set of: { status \| warning \| error }
Scope	Local ("-")
Multiplicity	[1]
Description	The severity value (from the corresponding enumerated vocabulary).

5.9.3 "imsx_description" Attribute Description

Table 5.9.3 Description of the "imsx_description" attribute for the "imsx_StatusInfo" class.
Descriptor	Definition
Attribute Name	imsx_description
Data Type	String (Primitive-type)
Value Space	See Appendix A3.3.
Scope	Local ("-")
Multiplicity	[0..1]
Description	A human readable description supplied by the entity creating the status code information.

5.9.4 "imsx_codeMinor" Attribute Description

6. Data Model

6.1. Data Class Descriptions

All of the data classes used within this Information Model are described in this Section. The syntax and semantics for this representation is described in Appendix A3.2.

6.1.1 Achievement Class Description

6.1.1.1 "id" Attribute Description

6.1.1.2 "type" Attribute Description

6.1.1.3 "achievementType" Attribute Description

6.1.1.4 "alignments" Attribute Description

6.1.1.5 "associations" Attribute Description

6.1.1.6 "creditsAvailable" Attribute Description

6.1.1.7 "description" Attribute Description

6.1.1.8 "endorsements" Attribute Description

6.1.1.9 "humanCode" Attribute Description

6.1.1.10 "identifiers" Attribute Description

6.1.1.11 "name" Attribute Description

6.1.1.12 "fieldOfStudy" Attribute Description

6.1.1.13 "image" Attribute Description

6.1.1.14 "issuer" Attribute Description

6.1.1.15 "level" Attribute Description

6.1.1.16 "requirement" Attribute Description

6.1.1.17 "resultDescriptions" Attribute Description

6.1.1.18 "signedEndorsements" Attribute Description

6.1.1.19 "specialization" Attribute Description

6.1.1.20 "tags" Attribute Description

6.1.1.21 "extensions" Attribute Description

6.1.2 Address Class Description

6.1.2.1 "id" Attribute Description

6.1.2.2 "type" Attribute Description

6.1.2.3 "addressCountry" Attribute Description

6.1.2.4 "addressLocality" Attribute Description

6.1.2.5 "addressRegion" Attribute Description

6.1.2.6 "postalCode" Attribute Description

6.1.2.7 "postOfficeBoxNumber" Attribute Description

6.1.2.8 "streetAddress" Attribute Description

6.1.2.9 "extensions" Attribute Description

6.1.3 Alignment Class Description

6.1.3.1 "id" Attribute Description

6.1.3.2 "type" Attribute Description

6.1.3.3 "targetCode" Attribute Description

6.1.3.4 "targetDescription" Attribute Description

6.1.3.5 "targetName" Attribute Description

6.1.3.6 "targetFramework" Attribute Description

6.1.3.7 "targetType" Attribute Description

6.1.3.8 "targetUrl" Attribute Description

6.1.3.9 "extensions" Attribute Description

6.1.4 Artifact Class Description

6.1.4.1 "type" Attribute Description

6.1.4.2 "description" Attribute Description

6.1.4.3 "name" Attribute Description

6.1.4.4 "url" Attribute Description

6.1.4.5 "extensions" Attribute Description

6.1.5 Assertion Class Description

6.1.5.1 "id" Attribute Description

6.1.5.2 "type" Attribute Description

6.1.5.3 "achievement" Attribute Description

6.1.5.4 "activityEndDate" Attribute Description

6.1.5.5 "activityStartDate" Attribute Description

6.1.5.6 "creditsEarned" Attribute Description

6.1.5.7 "endorsements" Attribute Description

6.1.5.8 "evidence" Attribute Description

6.1.5.9 "expires" Attribute Description

6.1.5.10 "image" Attribute Description

6.1.5.11 "issuedOn" Attribute Description

6.1.5.12 "licenseNumber" Attribute Description

6.1.5.13 "narrative" Attribute Description

6.1.5.14 "recipient" Attribute Description

6.1.5.15 "results" Attribute Description

6.1.5.16 "revocationReason" Attribute Description

6.1.5.17 "revoked" Attribute Description

6.1.5.18 "role" Attribute Description

6.1.5.19 "signedEndorsements" Attribute Description

6.1.5.20 "source" Attribute Description

6.1.5.21 "term" Attribute Description

6.1.5.22 "verification" Attribute Description

6.1.5.23 "extensions" Attribute Description

6.1.6 Association Class Description

6.1.6.1 "associationType" Attribute Description

6.1.6.2 "targetId" Attribute Description

6.1.6.3 "title" Attribute Description

6.1.6.4 "extensions" Attribute Description

6.1.7 Clr Class Description

6.1.7.1 "id" Attribute Description

6.1.7.2 "type" Attribute Description

6.1.7.3 "achievements" Attribute Description

6.1.7.4 "assertions" Attribute Description

6.1.7.5 "endorsements" Attribute Description

6.1.7.6 "issuedOn" Attribute Description

6.1.7.7 "learner" Attribute Description

6.1.7.8 "name" Attribute Description

6.1.7.9 "partial" Attribute Description

6.1.7.10 "publisher" Attribute Description

6.1.7.11 "revocationReason" Attribute Description

6.1.7.12 "revoked" Attribute Description

6.1.7.13 "signedAssertions" Attribute Description

6.1.7.14 "signedEndorsements" Attribute Description

6.1.7.15 "verification" Attribute Description

6.1.7.16 "extensions" Attribute Description

6.1.8 ClrSet Class Description

6.1.8.1 "id" Attribute Description

6.1.8.2 "type" Attribute Description

6.1.8.3 "clrs" Attribute Description

6.1.8.4 "signedClrs" Attribute Description

6.1.9 Criteria Class Description

6.1.9.1 "id" Attribute Description

6.1.9.2 "type" Attribute Description

6.1.9.3 "narrative" Attribute Description

6.1.9.4 "extensions" Attribute Description

6.1.10 CryptographicKey Class Description

6.1.10.1 "id" Attribute Description

6.1.10.2 "type" Attribute Description

6.1.10.3 "owner" Attribute Description

6.1.10.4 "publicKeyPem" Attribute Description

6.1.10.5 "extensions" Attribute Description

6.1.11 DiscoveryDocument Class Description

6.1.11.1 "authorizationUrl" Attribute Description

6.1.11.2 "image" Attribute Description

6.1.11.3 "name" Attribute Description

6.1.11.4 "privacyPolicyUrl" Attribute Description

6.1.11.5 "registrationUrl" Attribute Description

6.1.11.6 "scopesOffered" Attribute Description

6.1.11.7 "termsOfServiceUrl" Attribute Description

6.1.11.8 "tokenUrl" Attribute Description

6.1.12 Endorsement Class Description

6.1.12.1 "id" Attribute Description

6.1.12.2 "type" Attribute Description

6.1.12.3 "claim" Attribute Description

6.1.12.4 "issuedOn" Attribute Description

6.1.12.5 "issuer" Attribute Description

6.1.12.6 "revocationReason" Attribute Description

6.1.12.7 "revoked" Attribute Description

6.1.12.8 "verification" Attribute Description

6.1.12.9 "extensions" Attribute Description

6.1.13 EndorsementClaim Class Description

6.1.13.1 "id" Attribute Description

6.1.13.2 "type" Attribute Description

6.1.13.3 "endorsementComment" Attribute Description

6.1.13.4 "extensions" Attribute Description

6.1.14 EndorsementProfile Class Description

6.1.14.1 "id" Attribute Description

6.1.14.2 "type" Attribute Description

6.1.14.3 "additionalName" Attribute Description

6.1.14.4 "address" Attribute Description

6.1.14.5 "description" Attribute Description

6.1.14.6 "email" Attribute Description

6.1.14.7 "familyName" Attribute Description

6.1.14.8 "givenName" Attribute Description

6.1.14.9 "identifiers" Attribute Description

6.1.14.10 "image" Attribute Description

6.1.14.11 "name" Attribute Description

6.1.14.12 "official" Attribute Description

6.1.14.13 "publicKey" Attribute Description

6.1.14.14 "revocationList" Attribute Description

6.1.14.15 "sourcedId" Attribute Description

6.1.14.16 "studentId" Attribute Description

6.1.14.17 "telephone" Attribute Description

6.1.14.18 "url" Attribute Description

6.1.14.19 "verification" Attribute Description

6.1.14.20 "extensions" Attribute Description

6.1.15 Evidence Class Description

6.1.15.1 "id" Attribute Description

6.1.15.2 "type" Attribute Description

6.1.15.3 "artifacts" Attribute Description

6.1.15.4 "audience" Attribute Description

6.1.15.5 "description" Attribute Description

6.1.15.6 "genre" Attribute Description

6.1.15.7 "name" Attribute Description

6.1.15.8 "narrative" Attribute Description

6.1.15.9 "extensions" Attribute Description

6.1.16 GetAssertionPayload Class Description

6.1.16.1 "@context" Attribute Description

6.1.17 GetClrPayload Class Description

6.1.17.1 "@context" Attribute Description

6.1.18 GetCryptographicKeyPayload Class Description

6.1.18.1 "@context" Attribute Description

6.1.19 GetEndorsementPayload Class Description

6.1.19.1 "@context" Attribute Description

6.1.20 GetRevocationListPayload Class Description

6.1.20.1 "@context" Attribute Description

6.1.21 Identity Class Description

6.1.21.1 "id" Attribute Description

6.1.21.2 "type" Attribute Description

6.1.21.3 "identity" Attribute Description

6.1.21.4 "hashed" Attribute Description

6.1.21.5 "salt" Attribute Description

6.1.21.6 "extensions" Attribute Description

6.1.22 PostClrPayload Class Description

6.1.22.1 "clr" Attribute Description

6.1.22.2 "signedClr" Attribute Description

6.1.23 Profile Class Description

6.1.23.1 "id" Attribute Description

6.1.23.2 "type" Attribute Description

6.1.23.3 "address" Attribute Description

6.1.23.4 "additionalName" Attribute Description

6.1.23.5 "birthDate" Attribute Description

6.1.23.6 "description" Attribute Description

6.1.23.7 "email" Attribute Description

6.1.23.8 "endorsements" Attribute Description

6.1.23.9 "familyName" Attribute Description

6.1.23.10 "givenName" Attribute Description

6.1.23.11 "identifiers" Attribute Description

6.1.23.12 "image" Attribute Description

6.1.23.13 "name" Attribute Description

6.1.23.14 "official" Attribute Description

6.1.23.15 "parentOrg" Attribute Description

6.1.23.16 "publicKey" Attribute Description

6.1.23.17 "revocationList" Attribute Description

6.1.23.18 "signedEndorsements" Attribute Description

6.1.23.19 "sourcedId" Attribute Description

6.1.23.20 "studentId" Attribute Description

6.1.23.21 "telephone" Attribute Description

6.1.23.22 "url" Attribute Description

6.1.23.23 "verification" Attribute Description

6.1.23.24 "extensions" Attribute Description

6.1.24 Result Class Description

6.1.24.1 "id" Attribute Description

6.1.24.2 "type" Attribute Description

6.1.24.3 "achievedLevel" Attribute Description

6.1.24.4 "alignments" Attribute Description

6.1.24.5 "resultDescription" Attribute Description

6.1.24.6 "status" Attribute Description

6.1.24.7 "value" Attribute Description

6.1.24.8 "extensions" Attribute Description

6.1.25 ResultDescription Class Description

6.1.25.1 "id" Attribute Description

6.1.25.2 "type" Attribute Description

6.1.25.3 "alignments" Attribute Description

6.1.25.4 "allowedValues" Attribute Description

6.1.25.5 "name" Attribute Description

6.1.25.6 "requiredLevel" Attribute Description

6.1.25.7 "requiredValue" Attribute Description

6.1.25.8 "resultType" Attribute Description

6.1.25.9 "rubricCriterionLevels" Attribute Description

6.1.25.10 "valueMax" Attribute Description

6.1.25.11 "valueMin" Attribute Description

6.1.25.12 "extensions" Attribute Description

6.1.26 RevocationList Class Description

6.1.26.1 "id" Attribute Description

6.1.26.2 "type" Attribute Description

6.1.26.3 "issuer" Attribute Description

6.1.26.4 "revokedAssertions" Attribute Description

6.1.27 RubricCriterionLevel Class Description

6.1.27.1 "id" Attribute Description

6.1.27.2 "type" Attribute Description

6.1.27.3 "alignments" Attribute Description

6.1.27.4 "description" Attribute Description

6.1.27.5 "level" Attribute Description

6.1.27.6 "name" Attribute Description

6.1.27.7 "points" Attribute Description

6.1.27.8 "extensions" Attribute Description

6.1.28 SystemIdentifier Class Description

6.1.28.1 "type" Attribute Description

6.1.28.2 "identifier" Attribute Description

6.1.28.3 "identifierType" Attribute Description

6.1.28.4 "extensions" Attribute Description

6.1.29 Verification Class Description

6.1.29.1 "id" Attribute Description

6.1.29.2 "type" Attribute Description

6.1.29.3 "allowedOrigins" Attribute Description

6.1.29.4 "creator" Attribute Description

6.1.29.5 "startsWith" Attribute Description

6.1.29.6 "verificationProperty" Attribute Description

6.1.29.7 "extensions" Attribute Description

6.1.30 imsx_CodeMinor Class Description

6.1.30.1 "imsx_codeMinorField" Attribute Description

6.1.31 imsx_CodeMinorField Class Description

6.1.31.1 "imsx_codeMinorFieldName" Attribute Description

6.1.31.2 "imsx_codeMinorFieldValue" Attribute Description

6.1.32 imsx_StatusInfo Class Description

6.1.32.1 "imsx_codeMajor" Attribute Description

6.1.32.2 "imsx_severity" Attribute Description

6.1.32.3 "imsx_description" Attribute Description

6.1.32.4 "imsx_codeMinor" Attribute Description

6.2. Derived Class Descriptions

All of the derived data classes used within this Information Model are described in this Section. The syntax and semantics for this representation is described in Appendix A3.2.

6.2.1 CompactJws Class Description

6.2.1.1 "pattern" Attribute Description

6.2.2 EnumExtString Class Description

6.2.2.1 "pattern" Attribute Description

6.2.3 IRI Class Description

6.2.4 Markdown Class Description

6.2.5 UUID Class Description

6.2.5.1 "pattern" Attribute Description

6.3. Enumerated Vocabulary Descriptions

All of the enumerated vocabularies used within this Information Model are described in this Section. The syntax and semantics for this representation is described in Appendix A3.4.

6.3.1 AchievementType Vocabulary Description

6.3.2 AlignmentTargetType Vocabulary Description

6.3.3 AssociationType Vocabulary Description

6.3.4 ResultStatusType Vocabulary Description

6.3.5 ResultType Vocabulary Description

6.3.6 SystemIdentifierType Vocabulary Description

6.3.7 VerificationType Vocabulary Description

6.3.8 imsx_CodeMajorEnum Vocabulary Description

6.3.9 imsx_CodeMinorValueEnum Vocabulary Description

6.3.10 imsx_SeverityEnum Vocabulary Description

6.4. Union Class Descriptions

6.4.1 ExtensibleAchievementType Class Description

6.4.2 ExtensibleAlignmentTargetType Class Description

6.4.3 ExtensibleResultType Class Description

6.4.4 ExtensibleSystemIdentifierType Class Description

7. Extending and Profiling the Standard

7.1. Extending the Standard

It is NOT permitted to change the behavior of the current set of operations. Such changes MUST be supported by the creation of new operations.

7.1.1. Proprietary Operations

The definition of new operations should follow the same format as adopted herein. The new operations should be defined using a new interface type. Every operation must result in the return of a status code that describes the final state of the request on the target end system.

7.1.2. Proprietary Data Elements

Extensions to the data model are permitted, but must not collide with already defined data model names and/or semantics. It is strongly recommended to define extensions in collaboration with IMS Global, and only after communicating with the IMS Comprehensive Learner Record working group.

7.2. Profiling the Standard

Valid Profiles must be restrictive i.e. optional features can be removed or constraints increased but new features must not be added. A Profile of this service is made by annotating the UML supplied with the documentation for the specification.

It is strongly recommended that a profile of this specification is undertaken either by, or with the close support, of IMS Global. However, no matter who is responsible for creating the profile artefacts (documents, XSDs, etc.), it is strongly recommended that the IMS specification tools are used. This will ensure that the artefacts are consistent with the base specifications and that useful support documentation is automatically produced e.g. creation of a document that summarises the differences between the base specification and the profile. Organizations wishing to produce a profile of this specification should contact Lisa Mattson (IMS Global Chief Operations Officer) at: lmattson@imsglobal.org.

References

Appendix A Modelling Concepts and Terms

A1 Behavior Descriptions Explanations

A1.1 Service Model Diagrams

A1.2 Operation Descriptions

A2 Interface Descriptions Explanations

A2.1 Parameter Model Diagrams

A2.2 Class Descriptions

A2.3 Attribute Descriptions

A3 Data Model Descriptions Explanations

A3.1 Data Model Diagrams

A3.2 Class Descriptions

A3.3 Attribute and Characteristic Descriptions

Table A3.3 provides the key to the descriptions of the data attributes/characteristics for the data classes.

A3.4 Enumerated Vocabulary Descriptions

Table A3.4 provides the key to the descriptions of the enumerated vocabulary classes. These are vocabularies that will be contained within the binding form itself. They are contained within a class that has a stereotype of either « Enumeration » or « EnumeratedList ».

A3.5 External Vocabulary Descriptions

Table A3.5 provides the key to the descriptions of the external vocabulary classes. These are vocabularies that will be contained in some independent format e.g. using the IMS VDEX [VDEX, 04].

A3.6 Import Class Descriptions

A3.7 Link Data Descriptions

Appendix B Service Status Codes

B1 Definition of the Status Codes

The interpretation of the "CodeMajor/Severity" behavior matrix is summarized in Table B1.1.

B1.1 Definition of the "CodeMajor" Values

B1.2 Definition of the "Severity" Values

B1.3 Definition of the "CodeMinor" Values

About this Document

List of Contributors

Revision History

IMS Global Learning Consortium, Inc. ("IMS Global") is publishing the information contained in this document ("Specification") for purposes of scientific, experimental, and scholarly collaboration only.

IMS Global makes no warranty or representation regarding the accuracy or completeness of the Specification.

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.

Please refer to Document Name: IMS Comprehensive Learner Record Standard Information Model v1.0

Date Issued:	January 14, 2021
Latest version:	http://www.imsglobal.org/clr/

A-API	Abstract API
API	Application Programming Interface
CASE	IMS Competencies and Standards Exchange specification
CBE	Competency Based Education
CLR	Comprehensive Learner Record
HE	Higher Education
IETF	Internet Engineering Task Force
IdentityHash	A hash string preceded by a dollar sign ('$') and the algorithm used to generate the hash. The supported algorithms are MD5 and SHA-256, identified by the strings md5 and sha256 respectively. For example: sha256$28d50415252ab6c689a54413da15b083034b66e5 represents the result of calculating a SHA-256 hash on the string 'mayze'.
JSON	Java Script Object Notation
JSON-LD	A JSON-based serialization for Linked Data
REST	Representation State TRansfer
RFC	Request for Comments
UML	Unified Modelling Language
URI	Uniform Resource Identifier
URL	Uniform Resource Locator
XML	Exchange Markup Language
XSD	XML Schema Definition

Name:	getAssertion ()
Return Function Parameter:	: imsx_StatusInfo - returns the current version of the specified Assertion. This operation is used to verify a Hosted Assertion.
Supplied (in) Parameters:	sourcedId : String - the unique identifier of the Assertion.
Returned (out) Parameters:	assertion : GetAssertionPayload -
Behavior:	Returns the current version of the specified Assertion. This operation is used to verify a Hosted Assertion.

Name:	getClrs ()
Return Function Parameter:	: imsx_StatusInfo - the set of CLRs the user is authorized to access are returned in the payload of the response message.
Supplied (in) Parameters:	None.
Returned (out) Parameters:	clrs : ClrSet - the container for the set of CLRs that have been supplied by the service provider. The order of CLRs is not significant.
Behavior:	The set of CLRs the user is authorized to access are returned in the payload of the response message.

Name:	postClr ()
Return Function Parameter:	: imsx_StatusInfo - create or replace a CLR.
Supplied (in) Parameters:	clrIn : PostClrPayload - the CLR to be created or replaced.
Returned (out) Parameters:	clrOut : PostClrPayload -
Behavior:	Create or replace a CLR.

2. Service Architecture and Specification Model	An overview of the service architecture and end-system service objects.
3. Conceptual Model	The underlying conceptual data model and the set of relationships between the various learning standard and competency components. This includes schematic visualizations that are not based upon UML.
4. The Behavior Model	The definition of the operations of the service. This focuses on the description of the behaviors supported by the service. The behaviors are group as interfaces.
5. The Interface Model	The definition of the data models exchanged between the service End Systems. These are the parameters exchanged across the interoperability interface. These are an abbreviated description with the full set of details in the corresponding data class description.
6. Data Model	The definition of the data classes for the full data exchange. This addresses the data classes used to supplement the interface parameters. The descriptions are grouped according to their type e.g. data, enumeration, and derived.
7. Extending and Profiling the Standard	An explanation of how the standard can be extended, using the permitted points of extension, and/or profiled. Profiling is the process by which the specification is tailored to a specific set of market/domain requirements.
References	A list of references used throughout this document.
Appendix A Modelling Concepts and Terms	An overview of the model driven approach, the concepts and the terms used by IMS to create the service model representations (based upon a profile of UML), the corresponding set of bindings and the accompanying documentation (including this information model).
Appendix B Service Status Codes	A summary list of the status codes, and their causes, that can be returned by each of the operations forming the service. These describe the end-to-end status of the transaction.

Name:	deleteClr ()
Return Function Parameter:	: imsx_StatusInfo - delete a CLR.
Supplied (in) Parameters:	sourcedId : String - the unique identifier of the CLR to delete.
Returned (out) Parameters:	None.
Behavior:	Delete a CLR.

Name:	getClr ()
Return Function Parameter:	: imsx_StatusInfo - returns the current version of the specified Clr. This operation is used to verify a Hosted Clr.
Supplied (in) Parameters:	sourcedId : String - the unique identifier of the Clr.
Returned (out) Parameters:	clr : GetClrPayload -
Behavior:	Returns the current version of the specified Clr. This operation is used to verify a Hosted Clr.

Name:	getDiscoveryDocument ()
Return Function Parameter:	None.
Supplied (in) Parameters:	None.
Returned (out) Parameters:	discoveryDocument : DiscoveryDocument -
Behavior:	Returns the DiscoveryDocument if the provider supports dynamic CLR consumer registration.

Name:	getEndorsement ()
Return Function Parameter:	: imsx_StatusInfo - returns the current version of the specified Endorsement. This operation is used to verify a Hosted Endorsement.
Supplied (in) Parameters:	sourcedId : String - the unique identifier of the Endorsement.
Returned (out) Parameters:	endorsement : GetEndorsementPayload -
Behavior:	Returns the current version of the specified Endorsement. This operation is used to verify a Hosted Endorsement.

Name:	getKey ()
Return Function Parameter:	: imsx_StatusInfo - returns the current version of the specified CryptographicKey. This operation is used to verify a Signed Assertion, Clr, or Endorsement.
Supplied (in) Parameters:	sourcedId : String - the unique identifier of the CryptographicKey.
Returned (out) Parameters:	key : GetCryptographicKeyPayload -
Behavior:	Returns the current version of the specified CryptographicKey. This operation is used to verify a Signed Assertion, Clr, or Endorsement.

Name:	getRevocationList ()
Return Function Parameter:	: imsx_StatusInfo - returns the current version of the issuer's RevocationList. This operation is used to verify a Signed Assertion, Clr, or Endorsement.
Supplied (in) Parameters:	sourcedId : String - the unique identifier of the RevocationList.
Returned (out) Parameters:	revocations : GetRevocationListPayload -
Behavior:	Returns the current version of the issuer's RevocationList. This operation is used to verify a Signed Assertion, Clr, or Endorsement.

Descriptor	Definition
Attribute Name	imsx_codeMinor
Data Type	imsx_CodeMinor
Value Space	Container [ Sequence ]
Scope	Local ("-")
Multiplicity	[0..1]
Description	The set of reported code minor status codes.

Descriptor	Definition
Class Name	Achievement
Class Type	Container [ Unordered ]
Parents	The set of parent classes are: Assertion Clr
Derived Classes	There are no derived classes.
Super Classes	This class is not derived from another class.
Characteristics	There are no characteristics.
Children	The set of children attributes are: id type achievementType alignments associations creditsAvailable description endorsements humanCode identifiers name fieldOfStudy image issuer level requirement resultDescriptions signedEndorsements specialization tags extensions
Description	An accomplishment such as completing a degree, mastering a competency, or course completion that may be asserted about one or more learners.

Descriptor	Definition
Attribute Name	achievementType
Data Type	ExtensibleAchievementType
Value Space	Container [ Union ]
Scope	Local ("-")
Multiplicity	[0..1]
Description	A CLR Achievement can represent many different types of achievement from an assessment result to membership. Use 'Achievement' to indicate an achievement not in the list of allowed values.

Descriptor	Definition
Attribute Name	alignments
Data Type	Alignment
Value Space	Container [ Unordered ]
Scope	Local ("-")
Multiplicity	[0.. unbounded]
Description	Alignment objects describe an alignment between this achievement and a node in an educational framework.

Descriptor	Definition
Attribute Name	associations
Data Type	Association
Value Space	Container [ Unordered ]
Scope	Local ("-")
Multiplicity	[0.. unbounded]
Description	Associations between this achievement and other achievements.

Descriptor	Definition
Attribute Name	creditsAvailable
Data Type	Float (Primitive-type)
Value Space	See Appendix A3.3.
Scope	Local ("-")
Multiplicity	[0..1]
Description	Credit hours associated with this entity, or credit hours possible. For example '3.0'.

Descriptor	Definition
Attribute Name	endorsements
Data Type	Endorsement
Value Space	Container [ Unordered ]
Scope	Local ("-")
Multiplicity	[0.. unbounded]
Description	Allows endorsers to make specific claims about the Achievement.

Descriptor	Definition
Attribute Name	humanCode
Data Type	String (Primitive-type)
Value Space	See Appendix A3.3.
Scope	Local ("-")
Multiplicity	[0..1]
Description	The code, generally human readable, associated with an achievement.

Descriptor	Definition
Attribute Name	identifiers
Data Type	SystemIdentifier
Value Space	Container [ Unordered ]
Scope	Local ("-")
Multiplicity	[0.. unbounded]
Description	A set of System Identifiers that represent other identifiers for this Achievement.

Descriptor	Definition
Attribute Name	fieldOfStudy
Data Type	String (Primitive-type)
Value Space	See Appendix A3.3.
Scope	Local ("-")
Multiplicity	[0..1]
Description	Category, subject, area of study, discipline, or general branch of knowledge. Examples include Business, Education, Psychology, and Technology.

Descriptor	Definition
Attribute Name	issuer
Data Type	Profile
Value Space	Container [ Unordered ]
Scope	Local ("-")
Multiplicity	[1]
Description	A profile describing the individual or organization that issues assertions of this achievement.

Descriptor	Definition
Attribute Name	level
Data Type	String (Primitive-type)
Value Space	See Appendix A3.3.
Scope	Local ("-")
Multiplicity	[0..1]
Description	Text that describes the level of achievement apart from how the achievement was performed or demonstrated. Examples would include 'Level 1', 'Level 2', 'Level 3', or 'Bachelors', 'Masters', 'Doctoral'.

Descriptor	Definition
Attribute Name	requirement
Data Type	Criteria
Value Space	Container [ Unordered ]
Scope	Local ("-")
Multiplicity	[0..1]
Description	Criteria object describing how to earn the achievement.

IMS Comprehensive Learner Record Standard Information Model Version 1.0

IMS Final ReleaseVersion 1.0

IMS Final Release
Version 1.0

Descriptor	Definition
Attribute Name	resultDescriptions
Data Type	ResultDescription
Value Space	Container [ Unordered ]
Scope	Local ("-")
Multiplicity	[0.. unbounded]
Description	The set of result descriptions that may be asserted as results with this achievement.

Descriptor	Definition
Attribute Name	signedEndorsements
Data Type	CompactJws
Value Space	Container [ DerivedType ]
Scope	Local ("-")
Multiplicity	[0.. unbounded]
Description	Signed endorsements in JWS Compact Serialization format.

Descriptor	Definition
Attribute Name	specialization
Data Type	String (Primitive-type)
Value Space	See Appendix A3.3.
Scope	Local ("-")
Multiplicity	[0..1]
Description	Name given to the focus, concentration, or specific area of study defined in the achievement. Examples include Entrepreneurship, Technical Communication, and Finance.

Descriptor	Definition
Attribute Name	tags
Data Type	String (Primitive-type)
Value Space	See Appendix A3.3.
Scope	Local ("-")
Multiplicity	[0.. unbounded]
Description	Tags that describe the type of achievement.

Descriptor	Definition
Attribute Name	extensions
Data Type	Namespace (Primitive-type)
Value Space	See Appendix A3.3.
Scope	Global ("+")
Multiplicity	[0.. unbounded]
Description	The Achievement object can be extended with additional properties.

Descriptor	Definition
Class Name	Address
Class Type	Container [ Unordered ]
Parents	The set of parent classes are: EndorsementProfile Profile
Derived Classes	There are no derived classes.
Super Classes	This class is not derived from another class.
Characteristics	There are no characteristics.
Children	The set of children attributes are: id type addressCountry addressLocality addressRegion postalCode postOfficeBoxNumber streetAddress extensions
Description	Based on schema.org Address object.

Descriptor	Definition
Attribute Name	addressCountry
Data Type	String (Primitive-type)
Value Space	See Appendix A3.3.
Scope	Local ("-")
Multiplicity	[0..1]
Description	The country. For example, USA. You can also provide the two-letter ISO 3166-1 alpha-2 country code.

Descriptor	Definition
Attribute Name	addressLocality
Data Type	String (Primitive-type)
Value Space	See Appendix A3.3.
Scope	Local ("-")
Multiplicity	[0..1]
Description	The locality. For example, Mountain View.

Descriptor	Definition
Attribute Name	addressRegion
Data Type	String (Primitive-type)
Value Space	See Appendix A3.3.
Scope	Local ("-")
Multiplicity	[0..1]
Description	The region. For example, CA.

Descriptor	Definition
Attribute Name	postalCode
Data Type	String (Primitive-type)
Value Space	See Appendix A3.3.
Scope	Local ("-")
Multiplicity	[0..1]
Description	The postal code. For example, 94043.