Comprehensive Learner Record Standard 2.0
type: Ontology
description: RDFS RDF-SCHEMA vocabulary used by the CLR Standard data model.
date: 2023-06-20

Achievement
type: Class
comment: A collection of information about the accomplishment recognized by the Assertion. Many assertions may be created corresponding to one Achievement.

AchievementCredential
type: Class
comment: AchievementCredentials are representations of an awarded achievement, used to share information about a achievement belonging to one earner. Maps to a Verifiable Credential as defined in the VC-DATA-MODEL-2.0. As described in [#data-integrity], at least one proof mechanism, and the details necessary to evaluate that proof, MUST be expressed for a credential to be a verifiable credential. In the case of an embedded proof, the credential MUST append the proof in the `proof` property.
subclass of: VerifiableCredential

AchievementCredentialv1p1
type: Class
comment: AchievementCredentials are representations of an awarded achievement, used to share information about a achievement belonging to one earner. Maps to a Verifiable Credential as defined in the VC-DATA-MODEL. As described in [#data-integrity], at least one proof mechanism, and the details necessary to evaluate that proof, MUST be expressed for a credential to be a verifiable credential. In the case of an embedded proof, the credential MUST append the proof in the `proof` property.
subclass of: VerifiableCredentialv1p1

AchievementSubject
type: Class
comment: A collection of information about the recipient of an achievement. Maps to Credential Subject in VC-DATA-MODEL-2.0.
subclass of: CredentialSubject

AchievementSubjectv1p1
type: Class
comment: A collection of information about the recipient of an achievement. Maps to Credential Subject in VC-DATA-MODEL-2.0.
subclass of: CredentialSubject

Achievementv1p1
type: Class
comment: A collection of information about the accomplishment recognized by the Assertion. Many assertions may be created corresponding to one Achievement.

Address
type: Class
comment: An address for the described entity.

Alignment
type: Class
comment: Describes an alignment between an achievement and a node in an educational framework.

AnyAchievementCredential
type: Class
comment: AnyAchievementCredential represents an AchievementCredential that might be built using VC-DATA-MODEL or VC-DATA-MODEL-2.0. The scope of this class is only for verification purposes. It is not intended to be used in the creation of new credentials, where the [#achievementcredential] class MUST be used.
subclass of: AchievementCredential
subclass of: AchievementCredentialv1p1

AnyClrCredential
type: Class
comment: AnyClrCredential represents an ClrCredential that might be built using VC-DATA-MODEL or VC-DATA-MODEL-2.0. The scope of this class is only for verification purposes. It is not intended to be used in the creation of new credentials, where the [#clrcredential class MUST be used.
subclass of: ClrCredentialv1p1
subclass of: ClrCredential

AnyEndorsementCredential
type: Class
comment: AnyEndorsementCredential represents an EndorsementCredential that might be built using VC-DATA-MODEL or VC-DATA-MODEL-2.0. The scope of this class is only for verification purposes. It is not intended to be used in the creation of new credentials, where the [#endorsementcredential class MUST be used.
subclass of: EndorsementCredential
subclass of: EndorsementCredentialv1p1

AnyIdentifier
type: Class
comment: AnyIdentifier

Association
type: Class
comment: An Association describes the semantic relationship between two achievements and the credentials that assert those achievements.

ClrCredential
type: Class
comment: A ClrCredential is a CLR with all the properties needed to conform with a Verifiable Credential as defined in the VC-DATA-MODEL-2.0.
subclass of: VerifiableCredential

ClrCredentialJwtPayload
type: Class
comment: Represents a Comprehensive Learner Record (CLR) expressed to conform with the `vc` claim in JSON Web Token Proof Format VC-DATA-MODEL. Nested credentials are represented as Compact JWS strings.
subclass of: ClrCredential

ClrCredentialv1p1
type: Class
comment: A ClrCredential is a CLR with all the properties needed to conform with a Verifiable Credential as defined in the VC-DATA-MODEL.
subclass of: VerifiableCredentialv1p1

ClrSubject
type: Class
comment: A collection of information about the learner that is the subject of this CLR credential.
subclass of: CredentialSubject

ClrSubjectJwtPayload
type: Class
comment: Claims about the subject learner.
subclass of: ClrSubject

ClrSubjectv1p1
type: Class
comment: A collection of information about the learner that is the subject of this CLR credential.
subclass of: CredentialSubject

Context
type: Class
comment: JSON-LD Context. Either a URI with the context definition or a Map with a local context definition MUST be supplied.
subclass of: Map
subclass of: URI

Criteria
type: Class
comment: Descriptive metadata about the achievements necessary to be recognized with an assertion of a particular achievement. This data is added to the Achievement class so that it may be rendered when the achievement assertion is displayed, instead of simply a link to human-readable criteria external to the achievement. Embedding criteria allows either enhancement of an external criteria page or increased portability and ease of use by allowing issuers to skip hosting the formerly-required external criteria page altogether. Criteria is used to allow would-be recipients to learn what is required of them to be recognized with an assertion of a particular achievement. It is also used after the assertion is awarded to a recipient to let those inspecting earned achievements know the general requirements that the recipients met in order to earn it.

EndorsementCredential
type: Class
comment: A verifiable credential that asserts a claim about an entity. As described in [#data-integrity], at least one proof mechanism, and the details necessary to evaluate that proof, MUST be expressed for a credential to be a verifiable credential. In the case of an embedded proof, the credential MUST append the proof in the `proof` property.
subclass of: VerifiableCredential

EndorsementCredentialv1p1
type: Class
comment: A verifiable credential that asserts a claim about an entity. As described in [#data-integrity], at least one proof mechanism, and the details necessary to evaluate that proof, MUST be expressed for a credential to be a verifiable credential. In the case of an embedded proof, the credential MUST append the proof in the `proof` property.
subclass of: VerifiableCredentialv1p1

EndorsementSubject
type: Class
comment: A collection of information about the subject of the endorsement.
subclass of: CredentialSubject

Evidence
type: Class
comment: Descriptive metadata about evidence related to the achievement assertion. Each instance of the evidence class present in an assertion corresponds to one entity, though a single entry can describe a set of items collectively. There may be multiple evidence entries referenced from an assertion. The narrative property is also in scope of the assertion class to provide an overall description of the achievement related to the assertion in rich text. It is used here to provide a narrative of achievement of the specific entity described. If both the description and narrative properties are present, displayers can assume the narrative value goes into more detail and is not simply a recapitulation of description.

GeoCoordinates
type: Class
comment: The geographic coordinates of a location.

GetClrCredentialsResponse
type: Class
comment: GetClrCredentialsResponse

IdentifierEntry
type: Class
comment: IdentifierEntry

IdentifierType
type: Class
comment: IdentifierType

IdentityObject
type: Class
comment: A collection of information about the recipient of an achievement.

Image
type: Class
comment: Metadata about images that represent assertions, achieve or profiles. These properties can typically be represented as just the id string of the image, but using a fleshed-out document allows for including captions and other applicable metadata.

JWK
type: Class
comment: A JSON Web Key (JWK) formatted according to RFC7517.

JWKS
type: Class
comment: A JWK Set (JWKS) formatted according to RFC7517.

Map
type: Class
comment: A map representing an object with unknown, arbitrary properties

Multikey
type: Class
comment: Multikey

Profile
type: Class
comment: A Profile is a collection of information that describes the entity or organization using Open Badges. Issuers must be represented as Profiles, and endorsers, or other entities may also be represented using this vocabulary. Each Profile that represents an Issuer may be referenced in many BadgeClasses that it has defined. Anyone can create and host an Issuer file to start issuing Open Badges. Issuers may also serve as recipients of Open Badges, often identified within an Assertion by specific properties, like their url or contact email address.

ProfileRef
type: Class
comment: A description of the individual, entity, or organization that issued the credential. Either a URI with the Unique URI for the Issuer/Profile file, or a Profile object MUST be supplied.
subclass of: Profile
subclass of: URI

Profilev1p1
type: Class
comment: A Profile is a collection of information that describes the entity or organization using Open Badges. Issuers must be represented as Profiles, and endorsers, or other entities may also be represented using this vocabulary. Each Profile that represents an Issuer may be referenced in many BadgeClasses that it has defined. Anyone can create and host an Issuer file to start issuing Open Badges. Issuers may also serve as recipients of Open Badges, often identified within an Assertion by specific properties, like their url or contact email address.

Related
type: Class
comment: Identifies a related achievement.

Result
type: Class
comment: Describes a result that was achieved.

ResultDescription
type: Class
comment: Describes a possible achievement result.

RubricCriterionLevel
type: Class
comment: Describes a rubric criterion level.

achievedLevel
type: Property
comment: If the result represents an achieved rubric criterion level (e.g. Mastered), the value is the `id` of the RubricCriterionLevel in linked ResultDescription.
range: anyURI
domain: Result

achievement
type: Property
comment: In AchievementSubject:The achievement being awarded.
comment: In AchievementSubjectv1p1:The achievement being awarded.
comment: In ClrSubject:The set of achievements the CLR issuer expects the learner to achieve.
comment: In ClrSubjectv1p1:The set of achievements the CLR issuer expects the learner to achieve.
range:
  union of: Achievementv1p1
  union of: Achievement
domain:
  union of: AchievementSubject
  union of: AchievementSubjectv1p1
  union of: ClrSubject
  union of: ClrSubjectv1p1

achievementType
type: Property
comment: In Achievement:The type of achievement. This is an extensible vocabulary.
comment: In Achievementv1p1:The type of achievement. This is an extensible vocabulary.
range: string
domain:
  union of: Achievement
  union of: Achievementv1p1

activityEndDate
type: Property
comment: In AchievementSubject:The datetime the activity ended.
comment: In AchievementSubjectv1p1:The datetime the activity ended.
range: dateTime
domain:
  union of: AchievementSubject
  union of: AchievementSubjectv1p1

activityStartDate
type: Property
comment: In AchievementSubject:The datetime the activity started.
comment: In AchievementSubjectv1p1:The datetime the activity started.
range: dateTime
domain:
  union of: AchievementSubject
  union of: AchievementSubjectv1p1

additionalName
type: Property
comment: In Profile:Additional name. Includes what is often referred to as 'middle name' in the western world.
comment: In Profilev1p1:Additional name. Includes what is often referred to as 'middle name' in the western world.
range: additionalName
domain:
  union of: Profile
  union of: Profilev1p1

address
type: Property
comment: In Profile:An address for the individual or organization.
comment: In Profilev1p1:An address for the individual or organization.
range: Address
domain:
  union of: Profile
  union of: Profilev1p1

addressCountry
type: Property
comment: A country.
range: addressCountry
domain: Address

addressCountryCode
type: Property
comment: A country code. The value must be a ISO 3166-1 alpha-2 country code ISO3166-1.
range: string
domain: Address

addressLocality
type: Property
comment: A locality within the region.
range: addressLocality
domain: Address

addressRegion
type: Property
comment: A region within the country.
range: addressRegion
domain: Address

alg
type: Property
comment: The `alg` (algorithm) parameter identifies the algorithm intended for use with the key, such as `RS256` or `PS256`.
range: string
domain: JWK

alignment
type: Property
comment: In Achievement:An object describing which objectives or educational standards this achievement aligns to, if any.
comment: In Achievementv1p1:An object describing which objectives or educational standards this achievement aligns to, if any.
comment: In Result:The alignments between this result and nodes in external frameworks. This set of alignments are in addition to the set of alignments defined in the corresponding ResultDescription object.
comment: In ResultDescription:Alignments between this result description and nodes in external frameworks.
comment: In RubricCriterionLevel:Alignments between this rubric criterion level and a rubric criterion levels defined in external frameworks.
range: Alignment
domain:
  union of: Achievement
  union of: Achievementv1p1
  union of: Result
  union of: ResultDescription
  union of: RubricCriterionLevel

allowedValue
type: Property
comment: An ordered list of allowed values. The values should be ordered from low to high as determined by the achievement creator.
range: string
domain: ResultDescription

association
type: Property
comment: In ClrSubject:Associations describe the semantic relationship between source and target achievements and their assertions.
comment: In ClrSubjectv1p1:Associations describe the semantic relationship between source and target achievements and their assertions.
range: Association
domain:
  union of: ClrSubject
  union of: ClrSubjectv1p1

associationType
type: Property
comment: The type of relationship between a source achievement and a target achievement. For example the source achievement is the child of the target achievement.
range: string
domain: Association

audience
type: Property
comment: A description of the intended audience for a piece of evidence.
range: audience
domain: Evidence

awardedDate
type: Property
comment: In AchievementCredential:Timestamp of when the credential was awarded. `validFrom` is used to determine the most recent version of a Credential in conjunction with `issuer` and `id`. Consequently, the only way to update a Credental is to update the `validFrom`, losing the date when the Credential was originally awarded. `awardedDate` is meant to keep this original date.
comment: In AchievementCredentialv1p1:Timestamp of when the credential was awarded. `validFrom` is used to determine the most recent version of a Credential in conjunction with `issuer` and `id`. Consequently, the only way to update a Credental is to update the `validFrom`, losing the date when the Credential was originally awarded. `awardedDate` is meant to keep this original date.
comment: In ClrCredential:Timestamp of when the credential was awarded. `validFrom` is used to determine the most recent version of a Credential in conjunction with `issuer` and `id`. Consequently, the only way to update a Credental is to update the `validFrom`, losing the date when the Credential was originally awarded. `awardedDate` is meant to keep this original date.
comment: In ClrCredentialv1p1:Timestamp of when the credential was awarded. `issuanceDate` is used to determine the most recent version of a Credential in conjunction with `issuer` and `id`. Consequently, the only way to update a Credental is to update the `issuanceDate`, losing the date when the Credential was originally awarded. `awardedDate` is meant to keep this original date.
comment: In EndorsementCredential:Timestamp of when the credential was awarded. `validFrom` is used to determine the most recent version of a Credential in conjunction with `issuer` and `id`. Consequently, the only way to update a Credental is to update the `validFrom`, losing the date when the Credential was originally awarded. `awardedDate` is meant to keep this original date.
comment: In EndorsementCredentialv1p1:Timestamp of when the credential was awarded. `validFrom` is used to determine the most recent version of a Credential in conjunction with `issuer` and `id`. Consequently, the only way to update a Credental is to update the `validFrom`, losing the date when the Credential was originally awarded. `awardedDate` is meant to keep this original date.
range: dateTime
domain:
  union of: AchievementCredential
  union of: AchievementCredentialv1p1
  union of: ClrCredential
  union of: ClrCredentialv1p1
  union of: EndorsementCredential
  union of: EndorsementCredentialv1p1

caption
type: Property
comment: The caption for the image.
range: caption
domain: Image

compactJwsString
type: Property
comment: ClrCredentials that have been signed with the VC-JWT Proof Format MUST be in the `compactJwsString` array.
range: string
domain: GetClrCredentialsResponse

controller
type: Property
comment: The identify of the entity that controls this public key.
range: anyURI
domain: Multikey

creator
type: Property
comment: In Achievement:The person or organization that created the achievement definition.
comment: In Achievementv1p1:The person or organization that created the achievement definition.
range:
  union of: Profilev1p1
  union of: Profile
domain:
  union of: Achievement
  union of: Achievementv1p1

credential
type: Property
comment: ClrCredentials that have not been signed with the VC-JWT Proof Format MUST be in the `credential` array.
range: ClrCredential
domain: GetClrCredentialsResponse

credentialSubject
type: Property
comment: In AchievementCredential:The recipient of the achievement.
comment: In AchievementCredentialv1p1:The recipient of the achievement.
comment: In ClrCredential:The learner that is the subject of this CLR credential.
comment: In ClrCredentialJwtPayload:Claims about the learner.
comment: In ClrCredentialv1p1:The learner that is the subject of this CLR credential.
comment: In EndorsementCredential:The individual, entity, organization, assertion, or achievement that is endorsed and the endorsement comment.
comment: In EndorsementCredentialv1p1:The individual, entity, organization, assertion, or achievement that is endorsed and the endorsement comment.
range:
  union of: AchievementSubject
  union of: AchievementSubjectv1p1
  union of: ClrSubjectv1p1
  union of: EndorsementSubject
  union of: ClrSubjectJwtPayload
  union of: ClrSubject
domain:
  union of: AchievementCredential
  union of: AchievementCredentialv1p1
  union of: ClrCredential
  union of: ClrCredentialJwtPayload
  union of: ClrCredentialv1p1
  union of: EndorsementCredential
  union of: EndorsementCredentialv1p1

creditsAvailable
type: Property
comment: In Achievement:Credit hours associated with this entity, or credit hours possible. For example 3.0.
comment: In Achievementv1p1:Credit hours associated with this entity, or credit hours possible. For example 3.0.
range: float
domain:
  union of: Achievement
  union of: Achievementv1p1

creditsEarned
type: Property
comment: In AchievementSubject:The number of credits earned, generally in semester or quarter credit hours. This field correlates with the Achievement `creditsAvailable` field.
comment: In AchievementSubjectv1p1:The number of credits earned, generally in semester or quarter credit hours. This field correlates with the Achievement `creditsAvailable` field.
range: float
domain:
  union of: AchievementSubject
  union of: AchievementSubjectv1p1

criteria
type: Property
comment: In Achievement:Criteria describing how to earn the achievement.
comment: In Achievementv1p1:Criteria describing how to earn the achievement.
range: Criteria
domain:
  union of: Achievement
  union of: Achievementv1p1

cryptosuite
type: Property
comment: The `cryptosuite` of the verification method MUST be the string `eddsa-rdf-2022`.
range: string
domain: Multikey

dateOfBirth
type: Property
comment: In Profile:Birthdate of the person.
comment: In Profilev1p1:Birthdate of the person.
range: date
domain:
  union of: Profile
  union of: Profilev1p1

description
type: Property
comment: In Achievement:A short description of the achievement.
comment: In AchievementCredential:The short description of the credential for display purposes in wallets.
comment: In AchievementCredentialv1p1:The short description of the credential for display purposes in wallets.
comment: In Achievementv1p1:A short description of the achievement.
comment: In ClrCredential:Optional description of the CLR. May be displayed by wallet user interfaces.
comment: In ClrCredentialv1p1:Optional description of the CLR. May be displayed by wallet user interfaces.
comment: In EndorsementCredential:The short description of the credential for display purposes in wallets.
comment: In EndorsementCredentialv1p1:The short description of the credential for display purposes in wallets.
comment: In Evidence:A longer description of the evidence.
comment: In Profile:A short description of the issuer entity or organization.
comment: In Profilev1p1:A short description of the issuer entity or organization.
comment: In RubricCriterionLevel:Description of the rubric criterion level.
range:
  union of: string
  union of: description
domain:
  union of: Achievement
  union of: AchievementCredential
  union of: AchievementCredentialv1p1
  union of: Achievementv1p1
  union of: ClrCredential
  union of: ClrCredentialv1p1
  union of: EndorsementCredential
  union of: EndorsementCredentialv1p1
  union of: Evidence
  union of: Profile
  union of: Profilev1p1
  union of: RubricCriterionLevel

email
type: Property
comment: In Profile:An email address.
comment: In Profilev1p1:An email address.
range: email
domain:
  union of: Profile
  union of: Profilev1p1

endorsement
type: Property
comment: In Achievement:Allows endorsers to make specific claims about the Achievement. These endorsements are signed with a Data Integrity proof format.
comment: In AchievementCredential:Allows endorsers to make specific claims about the credential, and the achievement and profiles in the credential. These endorsements are signed with a Data Integrity proof format.
comment: In AchievementCredentialv1p1:Allows endorsers to make specific claims about the credential, and the achievement and profiles in the credential. These endorsements are signed with a Data Integrity proof format.
comment: In Achievementv1p1:Allows endorsers to make specific claims about the Achievement. These endorsements are signed with a Data Integrity proof format.
comment: In ClrCredential:Allows endorsers to make specific claims about the ClrCredential, or any AssertionCredential, Achievement, or Profile referenced in the ClrCredential. These endorsements are signed with a Data Integrity proof format.
comment: In ClrCredentialv1p1:Allows endorsers to make specific claims about the ClrCredential, or any AssertionCredential, Achievement, or Profile referenced in the ClrCredential. These endorsements are signed with a Data Integrity proof format.
comment: In Profile:Allows endorsers to make specific claims about the individual or organization represented by this profile. These endorsements are signed with a Data Integrity proof format.
comment: In Profilev1p1:Allows endorsers to make specific claims about the individual or organization represented by this profile. These endorsements are signed with a Data Integrity proof format.
range:
  union of: EndorsementCredential
  union of: EndorsementCredentialv1p1
domain:
  union of: Achievement
  union of: AchievementCredential
  union of: AchievementCredentialv1p1
  union of: Achievementv1p1
  union of: ClrCredential
  union of: ClrCredentialv1p1
  union of: Profile
  union of: Profilev1p1

endorsementComment
type: Property
comment: Allows endorsers to make a simple claim in writing about the entity.
range: string
domain: EndorsementSubject

endorsementJwt
type: Property
comment: In Achievement:Allows endorsers to make specific claims about the Achievement. These endorsements are signed with the VC-JWT proof format.
comment: In AchievementCredential:Allows endorsers to make specific claims about the credential, and the achievement and profiles in the credential. These endorsements are signed with the VC-JWT proof format.
comment: In AchievementCredentialv1p1:Allows endorsers to make specific claims about the credential, and the achievement and profiles in the credential. These endorsements are signed with the VC-JWT proof format.
comment: In Achievementv1p1:Allows endorsers to make specific claims about the Achievement. These endorsements are signed with the VC-JWT proof format.
comment: In ClrCredential:Allows endorsers to make specific claims about the ClrCredential, or any AssertionCredential, Achievement, or Profile referenced in the ClrCredential. These endorsements are signed with the VC-JWT proof format.
comment: In ClrCredentialv1p1:Allows endorsers to make specific claims about the ClrCredential, or any AssertionCredential, Achievement, or Profile referenced in the ClrCredential. These endorsements are signed with the VC-JWT proof format.
comment: In Profile:Allows endorsers to make specific claims about the individual or organization represented by this profile. These endorsements are signed with the VC-JWT proof format.
comment: In Profilev1p1:Allows endorsers to make specific claims about the individual or organization represented by this profile. These endorsements are signed with the VC-JWT proof format.
range: string
domain:
  union of: Achievement
  union of: AchievementCredential
  union of: AchievementCredentialv1p1
  union of: Achievementv1p1
  union of: ClrCredential
  union of: ClrCredentialv1p1
  union of: Profile
  union of: Profilev1p1

evidence
type: Property
comment: In AchievementCredential:A description of the work that the recipient did to earn the achievement. This can be a page that links out to other pages if linking directly to the work is infeasible.
comment: In AchievementCredentialv1p1:Can't find any description.
range: Evidence
domain:
  union of: AchievementCredential
  union of: AchievementCredentialv1p1

familyName
type: Property
comment: In Profile:Family name. In the western world, often referred to as the 'last name' of a person.
comment: In Profilev1p1:Family name. In the western world, often referred to as the 'last name' of a person.
range: familyName
domain:
  union of: Profile
  union of: Profilev1p1

familyNamePrefix
type: Property
comment: In Profile:Family name prefix. As used in some locales, this is the leading part of a family name (e.g. 'de' in the name 'de Boer').
comment: In Profilev1p1:Family name prefix. As used in some locales, this is the leading part of a family name (e.g. 'de' in the name 'de Boer').
range: string
domain:
  union of: Profile
  union of: Profilev1p1

fieldOfStudy
type: Property
comment: In Achievement:Category, subject, area of study, discipline, or general branch of knowledge. Examples include Business, Education, Psychology, and Technology.
comment: In Achievementv1p1:Category, subject, area of study, discipline, or general branch of knowledge. Examples include Business, Education, Psychology, and Technology.
range: string
domain:
  union of: Achievement
  union of: Achievementv1p1

genre
type: Property
comment: A string that describes the type of evidence. For example, Poetry, Prose, Film.
range: genre
domain: Evidence

geo
type: Property
comment: The geographic coordinates of the location.
range: GeoCoordinates
domain: Address

givenName
type: Property
comment: In Profile:Given name. In the western world, often referred to as the 'first name' of a person.
comment: In Profilev1p1:Given name. In the western world, often referred to as the 'first name' of a person.
range: givenName
domain:
  union of: Profile
  union of: Profilev1p1

hashed
type: Property
comment: Whether or not the `identityHash` value is hashed.
range: boolean
domain: IdentityObject

honorificPrefix
type: Property
comment: In Profile:Honorific prefix(es) preceding a person's name (e.g. 'Dr', 'Mrs' or 'Mr').
comment: In Profilev1p1:Honorific prefix(es) preceding a person's name (e.g. 'Dr', 'Mrs' or 'Mr').
range: honorificPrefix
domain:
  union of: Profile
  union of: Profilev1p1

honorificSuffix
type: Property
comment: In Profile:Honorific suffix(es) following a person's name (e.g. 'M.D, PhD').
comment: In Profilev1p1:Honorific suffix(es) following a person's name (e.g. 'M.D, PhD').
range: honorificSuffix
domain:
  union of: Profile
  union of: Profilev1p1

humanCode
type: Property
comment: In Achievement:The code, generally human readable, associated with an achievement.
comment: In Achievementv1p1:The code, generally human readable, associated with an achievement.
range: string
domain:
  union of: Achievement
  union of: Achievementv1p1

identifier
type: Property
comment: In AchievementSubject:Other identifiers for the recipient of the achievement. Either `id` or at least one `identifier` MUST be supplied.
comment: In AchievementSubjectv1p1:Other identifiers for the recipient of the achievement. Either `id` or at least one `identifier` MUST be supplied.
comment: In AnyIdentifier:An identifier.
comment: In ClrSubject:Other identifiers for the recipient of the CLR credential. Either `id` or at least one `identifier`is required.
comment: In ClrSubjectv1p1:Other identifiers for the recipient of the CLR credential. Either `id` or at least one `identifier`is required.
comment: In IdentifierEntry:An identifier.
range:
  union of: IdentityObject
  union of: string
domain:
  union of: AchievementSubject
  union of: AchievementSubjectv1p1
  union of: AnyIdentifier
  union of: ClrSubject
  union of: ClrSubjectv1p1
  union of: IdentifierEntry

identifierType
type: Property
comment: In IdentifierEntry:The identifier type.
comment: In IdentifierType:The identifier type.
range: string
domain:
  union of: IdentifierEntry
  union of: IdentifierType

identityHash
type: Property
comment: Either the IdentityHash of the identity or the plaintext value. If it's possible that the plaintext transmission and storage of the identity value would leak personally identifiable information where there is an expectation of privacy, it is strongly recommended that an IdentityHash be used.
range: string
domain: IdentityObject

identityType
type: Property
comment: The identity type.
range: string
domain: IdentityObject

image
type: Property
comment: In Achievement:An image representing the achievement.
comment: In AchievementCredential:The image representing the credential for display purposes in wallets.
comment: In AchievementCredentialv1p1:The image representing the credential for display purposes in wallets.
comment: In AchievementSubject:An image representing this user's achievement. If present, this must be a PNG or SVG image, and should be prepared via the 'baking' instructions. An 'unbaked' image for the achievement is defined in the Achievement class and should not be duplicated here.
comment: In AchievementSubjectv1p1:An image representing this user's achievement. If present, this must be a PNG or SVG image, and should be prepared via the 'baking' instructions. An 'unbaked' image for the achievement is defined in the Achievement class and should not be duplicated here.
comment: In Achievementv1p1:An image representing the achievement.
comment: In ClrCredential:Optional image representing the CLR. May be displayed by wallet user interfaces. If present, MUST represent a PNG or SVG image. MAY be a 'baked' image.
comment: In ClrCredentialv1p1:Optional image representing the CLR. May be displayed by wallet user interfaces. If present, MUST represent a PNG or SVG image. MAY be a 'baked' image.
comment: In Profile:An image representing the issuer. This must be a PNG or SVG image.
comment: In Profilev1p1:An image representing the issuer. This must be a PNG or SVG image.
range: Image
domain:
  union of: Achievement
  union of: AchievementCredential
  union of: AchievementCredentialv1p1
  union of: AchievementSubject
  union of: AchievementSubjectv1p1
  union of: Achievementv1p1
  union of: ClrCredential
  union of: ClrCredentialv1p1
  union of: Profile
  union of: Profilev1p1

inLanguage
type: Property
comment: In Achievement:The language of the achievement.
comment: In Achievementv1p1:The language of the achievement.
comment: In Related:The language of the related achievement.
range: inLanguage
domain:
  union of: Achievement
  union of: Achievementv1p1
  union of: Related

key_ops
type: Property
comment: The `key_ops` (key operations) parameter identifies the operation(s) for which the key is intended to be used, such as `sign` (compute digital signature or MAC) or `verify` (verify digital signature or MAC).
range: string
domain: JWK

keys
type: Property
comment: A JWK Set is a JSON object that represents a set of JWKs.
range: JWK
domain: JWKS

kid
type: Property
comment: The `kid` (key ID) parameter is used to match a specific key.
range: string
domain: JWK

kty
type: Property
comment: The `kty` (key type) parameter identifies the cryptographic algorithm family used with the key, such as `RSA` or `EC`.
range: string
domain: JWK

latitude
type: Property
comment: The latitude of the location WGS84.
range: latitude
domain: GeoCoordinates

level
type: Property
comment: The rubric performance level in terms of success.
range: string
domain: RubricCriterionLevel

licenseNumber
type: Property
comment: In AchievementSubject:The license number that was issued with this credential.
comment: In AchievementSubjectv1p1:The license number that was issued with this credential.
range: string
domain:
  union of: AchievementSubject
  union of: AchievementSubjectv1p1

longitude
type: Property
comment: The longitude of the location WGS84.
range: longitude
domain: GeoCoordinates

name
type: Property
comment: In Achievement:The name of the achievement.
comment: In AchievementCredential:The name of the credential for display purposes in wallets. For example, in a list of credentials and in detail views.
comment: In AchievementCredentialv1p1:The name of the credential for display purposes in wallets. For example, in a list of credentials and in detail views.
comment: In Achievementv1p1:The name of the achievement.
comment: In ClrCredential:The name of the CLR. May be displayed by wallet user interfaces.
comment: In ClrCredentialv1p1:The name of the CLR. May be displayed by wallet user interfaces.
comment: In EndorsementCredential:The name of the credential for display purposes in wallets. For example, in a list of credentials and in detail views.
comment: In EndorsementCredentialv1p1:The name of the credential for display purposes in wallets. For example, in a list of credentials and in detail views.
comment: In Evidence:A descriptive title of the evidence.
comment: In Profile:The name of the entity or organization.
comment: In Profilev1p1:The name of the entity or organization.
comment: In ResultDescription:The name of the result.
comment: In RubricCriterionLevel:The name of the rubric criterion level.
range:
  union of: string
  union of: name
domain:
  union of: Achievement
  union of: AchievementCredential
  union of: AchievementCredentialv1p1
  union of: Achievementv1p1
  union of: ClrCredential
  union of: ClrCredentialv1p1
  union of: EndorsementCredential
  union of: EndorsementCredentialv1p1
  union of: Evidence
  union of: Profile
  union of: Profilev1p1
  union of: ResultDescription
  union of: RubricCriterionLevel

narrative
type: Property
comment: In AchievementSubject:A narrative that connects multiple pieces of evidence. Likely only present at this location if evidence is a multi-value array.
comment: In AchievementSubjectv1p1:A narrative that connects multiple pieces of evidence. Likely only present at this location if evidence is a multi-value array.
comment: In Criteria:A narrative of what is needed to earn the achievement. Markdown is allowed.
comment: In Evidence:A narrative that describes the evidence and process of achievement that led to an assertion.
range: string
domain:
  union of: AchievementSubject
  union of: AchievementSubjectv1p1
  union of: Criteria
  union of: Evidence

official
type: Property
comment: In Profile:If the entity is an organization, `official` is the name of an authorized official of the organization.
comment: In Profilev1p1:If the entity is an organization, `official` is the name of an authorized official of the organization.
range: string
domain:
  union of: Profile
  union of: Profilev1p1

otherIdentifier
type: Property
comment: In Achievement:A list of identifiers for the described entity.
comment: In Achievementv1p1:A list of identifiers for the described entity.
comment: In Profile:A list of identifiers for the described entity.
comment: In Profilev1p1:A list of identifiers for the described entity.
range: IdentifierEntry
domain:
  union of: Achievement
  union of: Achievementv1p1
  union of: Profile
  union of: Profilev1p1

parentOrg
type: Property
comment: In Profile:The parent organization of the entity.
comment: In Profilev1p1:The parent organization of the entity.
range: Profile
domain:
  union of: Profile
  union of: Profilev1p1

partial
type: Property
comment: In ClrCredential:True if CLR does not contain all the assertions known by the publisher for the learner at the time the CLR is issued. Useful if you are sending a small set of achievements in real time when they are achieved. If False or omitted, the CLR SHOULD be interpreted as containing all the assertions for the learner known by the publisher at the time of issue.
comment: In ClrCredentialv1p1:True if CLR does not contain all the assertions known by the publisher for the learner at the time the CLR is issued. Useful if you are sending a small set of achievements in real time when they are achieved. If False or omitted, the CLR SHOULD be interpreted as containing all the assertions for the learner known by the publisher at the time of issue.
range: boolean
domain:
  union of: ClrCredential
  union of: ClrCredentialv1p1

patronymicName
type: Property
comment: In Profile:Patronymic name.
comment: In Profilev1p1:Patronymic name.
range: string
domain:
  union of: Profile
  union of: Profilev1p1

phone
type: Property
comment: In Profile:A phone number.
comment: In Profilev1p1:A phone number.
range: string
domain:
  union of: Profile
  union of: Profilev1p1

points
type: Property
comment: The points associated with this rubric criterion level.
range: string
domain: RubricCriterionLevel

postOfficeBoxNumber
type: Property
comment: A post office box number for PO box addresses.
range: postOfficeBoxNumber
domain: Address

postalCode
type: Property
comment: A postal code.
range: postalCode
domain: Address

publicKeyMultibase
type: Property
comment: The `publicKeyMultibase` property of the verification method MUST be a public key encoded according to ?MULTICODEC and formatted according to ?MULTIBASE. The multicodec encoding of a Ed25519 public key is the two-byte prefix `0xed01` followed by the 32-byte public key data.
range: string
domain: Multikey

related
type: Property
comment: In Achievement:The related property identifies another Achievement that should be considered the same for most purposes. It is primarily intended to identify alternate language editions or previous versions of Achievements.
comment: In Achievementv1p1:The related property identifies another Achievement that should be considered the same for most purposes. It is primarily intended to identify alternate language editions or previous versions of Achievements.
range: Related
domain:
  union of: Achievement
  union of: Achievementv1p1

requiredLevel
type: Property
comment: The `id` of the rubric criterion level required to pass as determined by the achievement creator.
range: anyURI
domain: ResultDescription

requiredValue
type: Property
comment: A value from `allowedValue` or within the range of `valueMin` to `valueMax` required to pass as determined by the achievement creator.
range: string
domain: ResultDescription

result
type: Property
comment: In AchievementSubject:The set of results being asserted.
comment: In AchievementSubjectv1p1:The set of results being asserted.
range: Result
domain:
  union of: AchievementSubject
  union of: AchievementSubjectv1p1

resultDescription
type: Property
comment: In Achievement:The set of result descriptions that may be asserted as results with this achievement.
comment: In Achievementv1p1:The set of result descriptions that may be asserted as results with this achievement.
comment: In Result:An achievement can have many result descriptions describing possible results. The value of `resultDescription` is the `id` of the result description linked to this result. The linked result description must be in the achievement that is being asserted.
range:
  union of: anyURI
  union of: ResultDescription
domain:
  union of: Achievement
  union of: Achievementv1p1
  union of: Result

resultType
type: Property
comment: The type of result this description represents. This is an extensible enumerated vocabulary.
range: string
domain: ResultDescription

role
type: Property
comment: In AchievementSubject:Role, position, or title of the learner when demonstrating or performing the achievement or evidence of learning being asserted. Examples include 'Student President', 'Intern', 'Captain', etc.
comment: In AchievementSubjectv1p1:Role, position, or title of the learner when demonstrating or performing the achievement or evidence of learning being asserted. Examples include 'Student President', 'Intern', 'Captain', etc.
range: string
domain:
  union of: AchievementSubject
  union of: AchievementSubjectv1p1

rubricCriterionLevel
type: Property
comment: An ordered array of rubric criterion levels that may be asserted in the linked result. The levels should be ordered from low to high as determined by the achievement creator.
range: RubricCriterionLevel
domain: ResultDescription

salt
type: Property
comment: If the `identityHash` is hashed, this should contain the string used to salt the hash. If this value is not provided, it should be assumed that the hash was not salted.
range: string
domain: IdentityObject

source
type: Property
comment: In AchievementSubject:The person, organization, or system that assessed the achievement on behalf of the issuer. For example, a school may assess the achievement, while the school district issues the credential.
comment: In AchievementSubjectv1p1:The person, organization, or system that assessed the achievement on behalf of the issuer. For example, a school may assess the achievement, while the school district issues the credential.
range:
  union of: Profilev1p1
  union of: Profile
domain:
  union of: AchievementSubject
  union of: AchievementSubjectv1p1

sourceId
type: Property
comment: The `id` of the source achievement.
range: anyURI
domain: Association

specialization
type: Property
comment: In Achievement:Name given to the focus, concentration, or specific area of study defined in the achievement. Examples include 'Entrepreneurship', 'Technical Communication', and 'Finance'.
comment: In Achievementv1p1:Name given to the focus, concentration, or specific area of study defined in the achievement. Examples include 'Entrepreneurship', 'Technical Communication', and 'Finance'.
range: string
domain:
  union of: Achievement
  union of: Achievementv1p1

status
type: Property
comment: The status of the achievement. Required if `resultType` of the linked ResultDescription is Status.
range: string
domain: Result

streetAddress
type: Property
comment: A street address within the locality.
range: streetAddress
domain: Address

tag
type: Property
comment: In Achievement:One or more short, human-friendly, searchable, keywords that describe the type of achievement.
comment: In Achievementv1p1:One or more short, human-friendly, searchable, keywords that describe the type of achievement.
range: keywords
domain:
  union of: Achievement
  union of: Achievementv1p1

targetCode
type: Property
comment: If applicable, a locally unique string identifier that identifies the alignment target within its framework and/or targetUrl.
range: string
domain: Alignment

targetDescription
type: Property
comment: Short description of the alignment target.
range: targetDescription
domain: Alignment

targetFramework
type: Property
comment: Name of the framework the alignment target.
range: string
domain: Alignment

targetId
type: Property
comment: The `id` of the target achievement.
range: anyURI
domain: Association

targetName
type: Property
comment: Name of the alignment.
range: targetName
domain: Alignment

targetType
type: Property
comment: The type of the alignment target node.
range: string
domain: Alignment

targetUrl
type: Property
comment: URL linking to the official description of the alignment target, for example an individual standard within an educational framework.
range: anyURI
domain: Alignment

term
type: Property
comment: In AchievementSubject:The academic term in which this assertion was achieved.
comment: In AchievementSubjectv1p1:The academic term in which this assertion was achieved.
range: string
domain:
  union of: AchievementSubject
  union of: AchievementSubjectv1p1

url
type: Property
comment: In Profile:The homepage or social media profile of the entity, whether individual or institutional. Should be a URL/URI Accessible via HTTP.
comment: In Profilev1p1:The homepage or social media profile of the entity, whether individual or institutional. Should be a URL/URI Accessible via HTTP.
range: anyURI
domain:
  union of: Profile
  union of: Profilev1p1

use
type: Property
comment: The `use` (public key use) parameter identifies the intended use of the public key, such as `sig` (signature) or `end` (encryption).
range: string
domain: JWK

value
type: Property
comment: A string representing the result of the performance, or demonstration, of the achievement. For example, 'A' if the recipient received an A grade in class.
range: value
domain: Result

valueMax
type: Property
comment: The maximum possible `value` that may be asserted in a linked result.
range: string
domain: ResultDescription

valueMin
type: Property
comment: The minimum possible `value` that may be asserted in a linked result.
range: string
domain: ResultDescription

verifiableCredential
type: Property
comment: In ClrSubject:A set of AchievementCredentials, OpenBadgeCredentials, and other VerifiableCredentials the learner has been awarded. The credential issuers may not be the same entity as the ClrCredential issuer, but the ClrCredential's credential subject is guaranteed to be the same person as the credential subject of each included credential, even if they use different identifiers.
comment: In ClrSubjectJwtPayload:The set of achievements the publisher claims have been awarded to the learner in Compact JWS format. The CLR issuer publisher may not be the same entity as the assertion issuers, but the CLR subject MUST be the same entity as the assertion subjects even if they have different indentifiers.
comment: In ClrSubjectv1p1:A set of AchievementCredentials, OpenBadgeCredentials, and other VerifiableCredentials the learner has been awarded. The credential issuers may not be the same entity as the ClrCredential issuer, but the ClrCredential's credential subject is guaranteed to be the same person as the credential subject of each included credential, even if they use different identifiers.
range:
  union of: string
  union of: VerifiableCredential
domain:
  union of: ClrSubject
  union of: ClrSubjectJwtPayload
  union of: ClrSubjectv1p1

version
type: Property
comment: In Achievement:The version property allows issuers to set a version string for an Achievement. This is particularly useful when replacing a previous version with an update.
comment: In Achievementv1p1:The version property allows issuers to set a version string for an Achievement. This is particularly useful when replacing a previous version with an update.
comment: In Related:The version of the related achievement.
range: string
domain:
  union of: Achievement
  union of: Achievementv1p1
  union of: Related

x5c
type: Property
comment: The `x5c` (X.509 certificate chain) parameter contains a chain of one or more PKIX certificates RFC5280.
range: string
domain: JWK

x5t
type: Property
comment: The `x5t` (X.509 certificate SHA-1 thumbprint) parameter is a base64url-encoded SHA-1 thumbprint (a.k.a. digest) of the DER encoding of an X.509 certificate RFC5280.
range: string
domain: JWK

x5t_S256
type: Property
comment: The `x5t#S256` (X.509 certificate SHA-256 thumbprint) parameter is a base64url-encoded SHA-256 thumbprint (a.k.a. digest) of the DER encoding of an X.509 certificate RFC5280.
range: string
domain: JWK

x5u
type: Property
comment: The `x5u` (X.509 URL) parameter is a URI that refers to a resource for an X.509 public key certificate or certificate chain RFC5280.
range: anyURI
domain: JWK