cmi5 Profile

This specification describes interoperable runtime communication between Learning Management Systems (LMS) and Assignable Units (AU). The runtime communication and behavior of all parts of the system are carefully described in the full specification, which can be found at https://github.com/AICC/CMI-5_Spec_Current/blob/quartz/cmi5_spec.md . This is a structured representation of cmi5 concepts, statement structure, and statement communications patterns that the additional rules in the full specification build upon and provide the definitive interpretation of.

Concepts (13)

abandoned

Indicates that the AU session was abnormally terminated by a learner's action (or due to a system failure).

Type	`Verb`
IRI	`https://w3id.org/xapi/adl/verbs/abandoned`
In Scheme	`https://w3id.org/xapi/cmi5/v1.0`

satisfied

Indicates that the authority or activity provider determined the actor has fulfilled the criteria of the object or activity.

Type	`Verb`
IRI	`https://w3id.org/xapi/adl/verbs/satisfied`
In Scheme	`https://w3id.org/xapi/cmi5/v1.0`

waived

Indicates that the learning activity requirements were met by means other than completing the activity. A waived statement is used to indicate that the activity may be skipped by the actor.

Type	`Verb`
IRI	`https://w3id.org/xapi/adl/verbs/waived`
In Scheme	`https://w3id.org/xapi/cmi5/v1.0`

block

A block represents a number of Assignable Units of which progress (completion/success) is rolled up to. In cmi5 it is every level above the AU and below the Course.

Type	`ActivityType`
IRI	`https://w3id.org/xapi/cmi5/activities/block`
In Scheme	`https://w3id.org/xapi/cmi5/v1.0`

course

A course represents an amount of content that is published and registered for with the purpose of gaining completion. It is represented with a Course Structure Format in cmi5 as the highest level of content (above Block and AU).

Type	`ActivityType`
IRI	`https://w3id.org/xapi/cmi5/activities/course`
In Scheme	`https://w3id.org/xapi/cmi5/v1.0`
Exact Match	`http://adlnet.gov/expapi/activities/course`

progress

An integer value between 0 and 100 (inclusive) indicating the completion of the AU as a percentage. The AU may set this value in statements to indicate level of completion. The AU SHOULD NOT set a progress value in a Completed statement or if it has previously issued a Completed statement for the AU in the current registration.

Type	`ResultExtension`
IRI	`https://w3id.org/xapi/cmi5/result/extensions/progress`
In Scheme	`https://w3id.org/xapi/cmi5/v1.0`

reason

Indicates the reason why an AU was 'waived' (marked complete by an alternative means)

Type	`ResultExtension`
IRI	`https://w3id.org/xapi/cmi5/result/extensions/reason`
In Scheme	`https://w3id.org/xapi/cmi5/v1.0`

session ID

A unique identifier for a single AU launch session based on actor and course registration.

Type	`ContextExtension`
IRI	`https://w3id.org/xapi/cmi5/context/extensions/sessionid`
In Scheme	`https://w3id.org/xapi/cmi5/v1.0`

mastery score

'masteryScore' as provided in the LMS Launch Data for the AU plus registration used to determine the pass/fail result based on score

Type	`ContextExtension`
IRI	`https://w3id.org/xapi/cmi5/context/extensions/masteryscore`
In Scheme	`https://w3id.org/xapi/cmi5/v1.0`

launch mode

Indicates what launch mode an AU was launched with by the LMS

Type	`ContextExtension`
IRI	`https://w3id.org/xapi/cmi5/context/extensions/launchmode`
In Scheme	`https://w3id.org/xapi/cmi5/v1.0`

launch URL

The URL used by the LMS to launch the AU

Type	`ContextExtension`
IRI	`https://w3id.org/xapi/cmi5/context/extensions/launchurl`
In Scheme	`https://w3id.org/xapi/cmi5/v1.0`

launch parameters

'launchParameters' as provided in the LMS Launch Data for the AU plus registration

Type	`ContextExtension`
IRI	`https://w3id.org/xapi/cmi5/context/extensions/launchparameters`
In Scheme	`https://w3id.org/xapi/cmi5/v1.0`

move on

'moveOn' as provided in the LMS Launch Data for the AU plus registration

Type	`ContextExtension`
IRI	`https://w3id.org/xapi/cmi5/context/extensions/moveon`
In Scheme	`https://w3id.org/xapi/cmi5/v1.0`

Statement Templates (10)

Restrictions for all cmi5-defined Statements

IRI https://w3id.org/xapi/cmi5#generalrestrictions

Rules:

$.id [included]
$.timestamp [included]
$.context.contextActivities.grouping[*] [included]
$.context.extensions['https://w3id.org/xapi/cmi5/context/extensions/sessionid'] [included]

Launched

IRI	`https://w3id.org/xapi/cmi5#launched`
Verb	`http://adlnet.gov/expapi/verbs/launched`

Rules:

$.result.score [excluded]
$.result.success [excluded]
$.result.completion [excluded]
$.context.contextActivities.category[*].id
$.context.extensions['https://w3id.org/xapi/cmi5/context/extensions/launchmode'] [included]
$.context.extensions['https://w3id.org/xapi/cmi5/context/extensions/launchurl'] [included]
$.context.extensions['https://w3id.org/xapi/cmi5/context/extensions/moveon'] [included]
$.context.extensions['https://w3id.org/xapi/cmi5/context/extensions/launchparameters'] [included]

Initialized

IRI	`https://w3id.org/xapi/cmi5#initialized`
Verb	`http://adlnet.gov/expapi/verbs/initialized`

Rules:

$.result.score [excluded]
$.result.success [excluded]
$.result.completion [excluded]
$.context.contextActivities.category[*].id

Completed

IRI	`https://w3id.org/xapi/cmi5#completed`
Verb	`http://adlnet.gov/expapi/verbs/completed`

Rules:

$.result.score [excluded]
$.result.success [excluded]
$.result.completion [included]
$.result.duration [included]
$.context.contextActivities.category[*].id [included]

Passed

IRI	`https://w3id.org/xapi/cmi5#passed`
Verb	`http://adlnet.gov/expapi/verbs/passed`

Rules:

$.result.score [recommended]
$.result.success [included]
$.result.completion [excluded]
$.result.duration [included]
$.context.contextActivities.category[*].id [included]

Failed

IRI	`https://w3id.org/xapi/cmi5#failed`
Verb	`http://adlnet.gov/expapi/verbs/failed`

Rules:

$.result.score [recommended]
$.result.success [included]
$.result.completion [excluded]
$.result.duration [included]
$.context.contextActivities.category[*].id [included]

Abandoned

IRI	`https://w3id.org/xapi/cmi5#abandoned`
Verb	`https://w3id.org/xapi/adl/verbs/abandoned`

Rules:

$.result.score [excluded]
$.result.success [excluded]
$.result.completion [excluded]
$.result.duration [included]
$.context.contextActivities.category[*].id

Waived

IRI	`https://w3id.org/xapi/cmi5#waived`
Verb	`http://adlnet.gov/expapi/verbs/waived`

Rules:

$.result.score [excluded]
$.result.success [included]
$.result.completion [included]
$.result['https://w3id.org/xapi/cmi5/result/extensions/reason'] [included]
$.context.contextActivities.category[*].id [included]

Terminated

IRI	`https://w3id.org/xapi/cmi5#terminated`
Verb	`http://adlnet.gov/expapi/verbs/terminated`

Rules:

$.result.score [excluded]
$.result.success [excluded]
$.result.completion [excluded]
$.result.duration [included]
$.context.contextActivities.category[*].id

Satisfied

IRI	`https://w3id.org/xapi/cmi5#satisfied`
Verb	`http://adlnet.gov/expapi/verbs/satisfied`

Rules:

$.result.score [excluded]
$.result.success [excluded]
$.result.completion [excluded]
$.context.contextActivities.category[*].id
$.object.definition.type [included]

Patterns (19)

Satisfieds

IRI	`https://w3id.org/xapi/cmi5#satisfieds`
Zero Or More	`https://w3id.org/xapi/cmi5#satisfied`

Waived Session

IRI	`https://w3id.org/xapi/cmi5#waivedsession`
Sequence	`https://w3id.org/xapi/cmi5#satisfieds` `https://w3id.org/xapi/cmi5#waived` `https://w3id.org/xapi/cmi5#satisfieds`

No Result Session

IRI	`https://w3id.org/xapi/cmi5#noresultsession`
Sequence	`https://w3id.org/xapi/cmi5#launched` `https://w3id.org/xapi/cmi5#initialized` `https://w3id.org/xapi/cmi5#terminatedorabandoned`

Completion No Success Session

IRI	`https://w3id.org/xapi/cmi5#completionnosuccesssession`
Sequence	`https://w3id.org/xapi/cmi5#launched` `https://w3id.org/xapi/cmi5#initialized` `https://w3id.org/xapi/cmi5#completed` `https://w3id.org/xapi/cmi5#satisfieds` `https://w3id.org/xapi/cmi5#terminatedorabandoned`

Completed And Maybe Failed

IRI	`https://w3id.org/xapi/cmi5#passedsession`
Sequence	`https://w3id.org/xapi/cmi5#launched` `https://w3id.org/xapi/cmi5#initialized` `https://w3id.org/xapi/cmi5#passed` `https://w3id.org/xapi/cmi5#satisfieds` `https://w3id.org/xapi/cmi5#terminatedorabandoned`

Completed And Passed Session

IRI	`https://w3id.org/xapi/cmi5#completionpassedsession`
Sequence	`https://w3id.org/xapi/cmi5#launched` `https://w3id.org/xapi/cmi5#initialized` `https://w3id.org/xapi/cmi5#completedandpassed` `https://w3id.org/xapi/cmi5#satisfieds` `https://w3id.org/xapi/cmi5#terminatedorabandoned`

Failed Session

IRI	`https://w3id.org/xapi/cmi5#failedsession`
Sequence	`https://w3id.org/xapi/cmi5#launched` `https://w3id.org/xapi/cmi5#initialized` `https://w3id.org/xapi/cmi5#failed` `https://w3id.org/xapi/cmi5#terminatedorabandoned`

Completion Maybe Failed Session

IRI	`https://w3id.org/xapi/cmi5#completionmaybefailedsession`
Sequence	`https://w3id.org/xapi/cmi5#launched` `https://w3id.org/xapi/cmi5#initialized` `https://w3id.org/xapi/cmi5#completedandmaybefailed` `https://w3id.org/xapi/cmi5#satisfieds` `https://w3id.org/xapi/cmi5#terminatedorabandoned`

Terminated Or Abandoned

IRI	`https://w3id.org/xapi/cmi5#terminatedorabandoned`
Alternates	`https://w3id.org/xapi/cmi5#terminated` `https://w3id.org/xapi/cmi5#abandoned`

Completed And Passed

IRI	`https://w3id.org/xapi/cmi5#completedandpassed`
Alternates	`https://w3id.org/xapi/cmi5#completedthenpassed` `https://w3id.org/xapi/cmi5#passedthencompleted`

Completed Then Passed

IRI	`https://w3id.org/xapi/cmi5#completedthenpassed`
Sequence	`https://w3id.org/xapi/cmi5#completed` `https://w3id.org/xapi/cmi5#satisfieds` `https://w3id.org/xapi/cmi5#passed`

Passed Then Completed

IRI	`https://w3id.org/xapi/cmi5#passedthencompleted`
Sequence	`https://w3id.org/xapi/cmi5#passed` `https://w3id.org/xapi/cmi5#satisfieds` `https://w3id.org/xapi/cmi5#completed`

Completed And Maybe Failed

IRI	`https://w3id.org/xapi/cmi5#completedandmaybefailed`
Alternates	`https://w3id.org/xapi/cmi5#maybecompletedthenfailed` `https://w3id.org/xapi/cmi5#failedthenmaybecompleted`

Maybe Completed Then Failed

IRI	`https://w3id.org/xapi/cmi5#maybecompletedthenfailed`
Sequence	`https://w3id.org/xapi/cmi5#maybecompleted` `https://w3id.org/xapi/cmi5#satisfieds` `https://w3id.org/xapi/cmi5#failed`

Failed Then Maybe Completed

IRI	`https://w3id.org/xapi/cmi5#failedthenmaybecompleted`
Sequence	`https://w3id.org/xapi/cmi5#failed` `https://w3id.org/xapi/cmi5#maybecompleted`

Maybe Completed

IRI	`https://w3id.org/xapi/cmi5#maybecompleted`
Optional	`https://w3id.org/xapi/cmi5#completed`

Typical Session

IRI	`https://w3id.org/xapi/cmi5#typicalsession`
Alternates	`https://w3id.org/xapi/cmi5#completionmaybefailedsession` `https://w3id.org/xapi/cmi5#completionpassedsession` `https://w3id.org/xapi/cmi5#failedsession` `https://w3id.org/xapi/cmi5#noresultsession` `https://w3id.org/xapi/cmi5#passedsession` `https://w3id.org/xapi/cmi5#completionnosuccesssession` `https://w3id.org/xapi/cmi5#waivedsession`

Typical Sessions

This pattern provides an option to use zero or more of the alernates for the Typical Session pattern.

IRI	`https://w3id.org/xapi/cmi5#typicalsessions`
Zero Or More	`https://w3id.org/xapi/cmi5#typicalsession`

General Pattern Primary

This pattern describes the sequence of statements sent over the an entire course registration.

IRI	`https://w3id.org/xapi/cmi5#toplevel`
Sequence	`https://w3id.org/xapi/cmi5#satisfieds` `https://w3id.org/xapi/cmi5#typicalsessions`

Profile IRI	`https://w3id.org/xapi/cmi5`
See Also	https://github.com/AICC/CMI-5_Spec_Current/blob/quartz/cmi5_spec.md
Author	cmi5 Working Group
Concepts	13
Statement Templates	10
Patterns	19