Skip to content
Switch branches/tags
Go to file
Cannot retrieve contributors at this time

Experience API Faculty Profile

Medbiquitous Learning Experience Working Group

Licensed under Creative Commons, Attribution ( CC BY) Authors: David Topps, Corey Wirun

Table of Contents

Recipes Vocabulary


Can be categorized by situation type or by activity type, or whatever makes sense in context.

General structure:

The focus of this Profile is on faculty member activities that are mediated electronically because this is more pertinent to the context in which xAPI data is likely to be gathered.

Use Case This is for tracking the typical activities that faculty members (not faculties per se) engage in and that might be reported in their annual report, CV. Could also be used by Med Ed Research Centre Directors to provide reporting on their activities.

Basics/Core Recommendations

  • Most statements include an Agent with the user as the 'actor' property.
  • All timestamps in statements must be compliant with ISO 8601 format. (this is part of the xAPI specification)
  • This Profile acts as an extension to the Virtual Patient Profile and was developed from it.

Activity Definition includes the following:

An example of usage in a statement:

   "timestamp": 2016-09-22T14:48:06.807818Z,
    "actor": {
         "objectType": "Agent",
        "name": <...>,
        "account": {
            "name": <user_id>
            "homePage": ""
    "verb": {
         id :,
         display : {
            en-US :  arrived
    "object": {
        "id": <node_id>,
        "definition": {
          "extensions": {
            "": {
              "@id": "",
          "name": {
            "en-US": <title of the Course>
          "type": ""
        "objectType": "Activity"
    "context": {
        "registration": 37933467-d275-4e0e-ab26-e2670b2fce6d,
        "contextActivities": {
            "parent": [
                {id: <course_id>}
    "result": {
        "completion": true
        "score": {<score object>}
        "extensions": {
            <key>: {<counter values object>}


Verb usage:

Created the session, meeting, webinar, discussion channel

  • this is done by the moderator/facilitator/administrator
  • this may just be the booking

Verb IRI:

Includes a timestamp and identifier of the node in the scenario learning design when playing was started. Most scenarios will have a fixed starting node but this is not always true and is not a requirement for the statement to be true.
Note that this may need several timestamps eg the meeting scheduled start time(SST), actual start time(AST)

  • note that some participants may join a session before it is Opened, since it is the moderator/facilitator who Opens the session
  • Participants may not Join a Session that has not been Initialized

Note that this is not the same as Opened

The Actor who initializes the session is commonly the moderator/facilitator who Opens the session but it does not have to be the same person.

We recommend the use of ISO 8601 timestamps because time zones are a challenge for distributed teams

Opened Started the session

Verb IRI:

Not just journal articles. Any scholarly output that is made available to a group via a publication or distribution mechanism This includes scholarly materials that are needed but not made public e.g. Exams or questions or cases that are kept within a private repository. While the content may be kept private, it is recommended that for validation purposes, the activity metadata is made available for scrutiny

Verb IRI:

Granted Activities relating to a Grant

  • Applied for
  • Received
  • Reviewed Generally relates to Grant work but the past tense of ‘Granted’ tends to imply that you were successful

Verb IRI:

Suggests a live action component. Does not need to be face-to-face. Can be online or broadcast

  • Includes seminars, webinars, keynotes, conference oral presentations, posters
  • Context, audience etc could be specified within the Object clause, or within the associated Activity Resource Profile

Verb IRI: The above verb is close and might suffice

Patented Activities relating to a Patent

  • Applied for
  • Received High enough value for its own verb

Verb IRI:

Awarded Activities relating to an award and honours

  • Received an award
  • Distinguish from Granted
  • Applied for an award
  • Nominated for an award

Administered Activities relating to manage and be responsible for the operation or use of a resource, team, organization, etc.

Verb IRI: