Caliper Library

1EdTech Candidate Final Public
Version 1.2-extension

1EdTech Candidate Final Public

Date Issued:	20 November 2020
Status:	This document is for review and adoption by the 1EdTech membership.
This version:	https://www.imsglobal.org/spec/caliper-libraryuse/v1p2-extension/
Latest version:	https://www.imsglobal.org/spec/caliper-libraryuse/latest/
Errata:	https://www.imsglobal.org/spec/caliper-libraryuse/v1p2-extension/errata/

IPR and Distribution Notice

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.

1EdTech 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 1EdTech's procedures with respect to rights in 1EdTech specifications can be found at the 1EdTech Intellectual Property Rights web page: http://www.imsglobal.org/ipr/imsipr_policyFinal.pdf.

Use of this specification to develop products or services is governed by the license with 1EdTech found on the 1EdTech website: http://www.imsglobal.org/speclicense.html.

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 1EdTech 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.

Public contributions, comments and questions can be posted here: http://www.imsglobal.org/forums/ims-glc-public-forums-and-resources.

Trademark information: http://www.imsglobal.org/copyright.html

1. Abstract

This document extends Caliper 1.2 by defining a Library Profile that describes usage of library facilities, the library's physical and electronic resources, and interactions with library staff.

2. Overview

2.1 Design Goals and Rationale

This section is non-normative.

This document extends Caliper 1.2 by defining a Library Profile that describes usage of library facilities, the library's physical and electronic resources, and interactions with library staff.

The Caliper Library Profile models a Person making use of a Library, LibrarySpace, or a Library Resource. The profile defines a LibraryUseEvent, a LibraryResourceUseEvent, and a LibraryParticipationEvent for describing library-related activities all with the end goal of improving library support of student learning and success.

2.2 User Stories

This section is non-normative.

The Library Profile supports the following user stories:

As a librarian,
- I would like to understand the extent to which library spaces are used for course-assigned activities.
- I would like to control the level of specificity of the identity or interaction the library enters into the learner record store.
As a student,
- I would like to gauge my viewing of course readings and use of library resources in comparison to my peers.
- I would like to gauge my use of library services in comparison to my peers.
- I would like to have a record of the library resources I have used.
As a researcher, librarian, instructor, or student,
- I would like to determine if there is a correlation between student viewing of course readings or use of library resources and measures of student success.
- I would like to determine if there is a correlation between student use of library spaces and measures of student success.
- I would like to determine if there is a correlation between student engagement with library services and measures of student success.

Additional user stories can found in M. Oakleaf, Library Integration in Institutional Analytics (November, 2018).

2.3 Terminology

All terminology used in this specification is concordant with the term definitions in the Caliper 1.2 Specification [CALIPER-12].

2.4 Conformance Statements

As well as sections marked as non-normative, all authoring guidelines, diagrams, examples, and notes in this specification are non-normative. Everything else in this specification is normative.

The key words "MAY", "MUST", "MUST NOT", "OPTIONAL", "RECOMMENDED", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", and "SHOULD NOT" in this document are to be interpreted as described in [RFC2119].

An implementation of this specification that fails to implement a MUST/REQUIRED/SHALL requirement or fails to abide by a MUST NOT/SHALL NOT prohibition is considered nonconformant. SHOULD/SHOULD NOT/RECOMMENDED statements constitute a best practice. Ignoring a best practice does not violate conformance but a decision to disregard such guidance should be carefully considered. MAY/OPTIONAL statements indicate that implementers are entirely free to choose whether or not to implement the option.

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

2.5 Document Set

2.5.1 Normative Documents

Caliper 1.2: This profile is an extension to the Caliper 1.2 specification [CALIPER-12]. All requirements in the Caliper 1.2 specification also apply to implementations of this specification.
JSON-LD Context: The JSON-LD Context for this profile defines all relevant term-IRI mappings [CALIPER-LIBRARY-12-CONTEXT].
Errata: The errata [CALIPER-LIBRARY-12-ERRATA] details any errata registered for this version of this specification since its publication.
Conformance and Certification guide: The conformance and certification guide that accompanies the Caliper 1.2 specification defines the conformance requirements for Caliper Sensors [CALIPER-12-CERT].

2.5.2 Informative Documents

This section is non-normative.

Caliper 1.2 Implementation Guide: The implementation guide that accompanies the Caliper 1.2 specification provides advice and guidance for implementors [CALIPER-12-IMPL].

3. Events

The Library Profile is provisioned with a LibraryUseEvent for logging use of library facilities, a LibraryResourceUseEvent for describing the use of library-owned or licensed assets by library users, and a LibraryParticipationEvent for recording attendance at library-related activities.

3.1 LibraryUseEvent

A Caliper LibraryUseEvent models the use of library facilities.

IRI: https://purl.imsglobal.org/caliper/LibraryUseEvent
Term: LibraryUseEvent
Supertype: Event
Properties: The LibraryUseEvent inherits all properties defined by its supertype Event, of which id, type, actor, action, object, and eventTime are required. Profile-specific type restrictions are described below:

Property	Type	Description	Disposition
type	Term	The string value MUST be set to the Term LibraryUseEvent.	Required
actor	Person \| IRI	The Person who initiated the `action`. The `actor` value MUST be expressed either as an object or as a string corresponding to the actor’s IRI.	Required
action	Term	The action or predicate that binds the `actor` or subject to the `object`. The value range is limited to the Used action only.	Required
object	Library \| LibrarySpace \| IRI	The Library or LibrarySpace that constitutes the `object` of the interaction. The `object` value MUST be expressed either as an object or as a string corresponding to the object’s IRI.	Required
presenceDerivedFromSource	string	A non-standardized description of the source used to indicate presence in a Library. Examples include: `wifi`, `reservation`, `swipe card`, `sign in`.	Optional
presenceDerivedFromID	string	An identifier that correlates to the presenceDerivedFromSource to indicate which specific source was used if needed, for example, the MAC address of the WiFi router or the ID of the card swipe machine.	Optional

3.1.1 JSON Examples

Below are examples of LibraryUseEvents that describes the use of Library and LibrarySpace entities.

Figure 1 - A Person Used a LibrarySpace. In this example:

The actor is not identified.
The object is not identified.

{
  "@context": "http://purl.imsglobal.org/ctx/caliper/v1p2/LibraryProfile-extension",
  "id": "urn:uuid:fd245e24-d9fa-4384-8b0a-7d08d632e63f",
  "type": "LibraryUseEvent",
  "profile": "LibraryProfile",
  "actor": {
    "id": "http://purl.imsglobal.org/caliper/Person",
    "type": "Person"
  },
  "action": "Used",
  "object": {
    "id": "http://purl.imsglobal.org/caliper/LibrarySpace",
    "type": "LibrarySpace"
  },
  "eventTime": "2021-11-15T10:15:00.000Z"
}

Figure 2 - A Person Used a LibrarySpace. In this example:

The actor is not identified.
The object is identified by the MAC address of the a WiFi router in that space.

{
  "@context": "http://purl.imsglobal.org/ctx/caliper/v1p2/LibraryProfile-extension",
  "id": "urn:uuid:fd245e24-d9fa-4384-8b0a-7d08d632e63f",
  "type": "LibraryUseEvent",
  "profile": "LibraryProfile",
  "actor": {
    "id": "http://purl.imsglobal.org/caliper/Person",
    "type": "Person"
  },
  "action": "Used",
  "object": {
    "id": "https://example.edu/library/alcove2",
    "type": "LibrarySpace"
  },
  "eventTime": "2021-11-15T10:15:00.000Z",
  "presenceDerivedFromSource": "wifi",
  "presenceDerivedFromID": "00:A0:C9:14:C8:29"
}

Figure 3 - A Person Used the Library. In this example:

The actor is identified by a card swipe identifier.
The object is identified.

{
  "@context": "http://purl.imsglobal.org/ctx/caliper/v1p2/LibraryProfile-extension",
  "id": "urn:uuid:fd245e24-d9fa-4384-8b0a-7d08d632e63f",
  "type": "LibraryUseEvent",
  "profile": "LibraryProfile",
  "actor": {
    "id": "https://example.edu/users/554433",
    "type": "Person"
  },
  "action": "Used",
  "object": {
    "id": "https://example.edu/library",
    "type": "Library",
    "name": "University Library"
  },
  "eventTime": "2021-11-15T10:15:00.000Z",
  "presenceDerivedFromSource": "swipe card",
  "presenceDerivedFromID": "951357456852"
}

3.2 LibraryResourceUseEvent

A Caliper LibraryResourceUseEvent models the use of the library's physical and electronic resources.

IRI: https://purl.imsglobal.org/caliper/LibraryResourceUseEvent
Term: LibraryResourceUseEvent
Supertype: Event
Properties: The LibraryResourceUseEvent inherits all properties defined by its supertype Event, of which id, type, actor, action, object, and eventTime are required. Profile-specific type restrictions are described below:

Property	Type	Description	Disposition
type	Term	The string value MUST be set to the Term LibraryResourceUseEvent.	Required
actor	Person \| IRI	The Person who initiated the `action`. The `actor` value MUST be expressed either as an object or as a string corresponding to the actor’s IRI.	Required
action	Term	The action or predicate that binds the `actor` or subject to the `object`. The value range is limited to Accessed only.	Required
object	LibraryResource \| DigitalResource \| IRI	The resource that constitutes the `object` of the interaction. The `object` value MUST be expressed either as an object or as a string corresponding to the object’s IRI.	Required
accessLocation	string	A non-standardized description of the user's physical location from which the resource was accessed. Examples include: `on-campus`, `off-campus`.	Optional
forCourse	CourseOffering \| CourseSection \| IRI	If accessing for a specific CourseOffering or CourseSection it can be referenced here.	Optional

3.2.1 JSON Examples

Below are examples of LibraryResourceUseEvent that describes the use of a LibraryResource entity.

Figure 4 - A Person Accessed a LibraryResource for a CourseOffering. In this example:

The actor is not identified.
The object is identified.

{
  "@context": "http://purl.imsglobal.org/ctx/caliper/v1p2/LibraryProfile-extension",
  "id": "urn:uuid:ee80637e-0d57-4384-812b-f1f54810b195",
  "type": "LibraryResourceUseEvent",
  "profile": "LibraryProfile",
  "actor": {
    "id": "http://purl.imsglobal.org/caliper/Person",
    "type": "Person"
  },
  "action": "Accessed",
  "object": {
    "id": "https://example.edu/journals/231302",
    "type": "LibraryResource",
    "name": "Journal of Library Assessment"
  },
  "accessLocation": "off-campus",
  "eventTime": "2021-11-15T10:15:00.000Z",
  "forCourse": {
    "id": "https://example.edu/terms/202103/courses/7",
    "type": "CourseOffering",
    "courseNumber": "INFO 567"
  }
}

Figure 5 - A Person Accessed a LibraryResource for a CourseOffering. In this example:

The actor is identified.
The object is identified.

{
  "@context": "http://purl.imsglobal.org/ctx/caliper/v1p2/LibraryProfile-extension",
  "id": "urn:uuid:0652c71d-e477-4692-9b4e-89c4079e00e0",
  "type": "LibraryResourceUseEvent",
  "profile": "LibraryProfile",
  "actor": {
    "id": "https://example.edu/users/554433",
    "type": "Person"
  },
  "action": "Accessed",
  "object": {
    "id": "https://example.edu/catalog/record/013115849",
    "type": "LibraryResource",
    "name": "The Caliper Cookbook",
    "otherIdentifiers": [{
      "type": "SystemIdentifier",
      "identifierType": "ISBN",
      "identifier": "000-0-00-000000-0"
    }]
  },
  "accessLocation": "on-campus",
  "eventTime": "2021-11-15T10:15:00.000Z",
  "forCourse": {
    "id": "https://example.edu/terms/202103/courses/7",
    "type": "CourseOffering",
    "courseNumber": "INFO 115"
  }
}

3.3 LibraryParticipationEvent

A Caliper LibraryParticipationEvent models a Person participating in an appointment, meeting, lecture, workshop, or any other library function, whether ad-hoc or scheduled or in any location.

IRI: https://purl.imsglobal.org/caliper/LibraryParticipationEvent
Term: LibraryParticipationEvent
Supertype: Event
Properties: The LibraryParticipationEvent inherits all properties defined by its supertype Event, of which id, type, actor, action, object, and eventTime are required. Profile-specific type restrictions are described below:

Property	Type	Description	Disposition
type	Term	The string value MUST be set to the Term LibraryParticipationEvent.	Required
actor	Person \| IRI	The Person who initiated the `action`. The `actor` value MUST be expressed either as an object or as a string corresponding to the actor’s IRI.	Required
action	Term	The action or predicate that binds the `actor` or subject to the `object`. The value range is limited to the Attended only.	Required
object	LibraryActivity \| IRI	The LibraryActivity that constitutes the `object` of the interaction. The `object` value MUST be expressed either as an object or as a string corresponding to the object’s IRI.	Required
participationMode	string	A non-standardized description of how the Person participated in the LibraryActivity. Examples include: `online`, `in-person`.	Optional
forCourse	CourseOffering \| CourseSection \| IRI	If attending for a specific CourseOffering or CourseSection it can be referenced here.	Optional
arrivalTime	DateTime	An ISO 8601 date and time value. The value MUST be set to UTC with no offset specified.	Optional

3.3.1 JSON Examples

Below are examples of LibraryParticipationEvent that describes participation in a LibraryActivity entity.

Figure 6 - A Person Attended a LibraryActivity for a CourseOffering. In this example:

The actor is not identified.
The object is identified.

{
  "@context": "http://purl.imsglobal.org/ctx/caliper/v1p2/LibraryProfile-extension",
  "id": "urn:uuid:fd245e24-d9fa-4384-8b0a-7d08d632e666",
  "type": "LibraryParticipationEvent",
  "profile": "LibraryProfile",
  "actor": {
    "id": "http://purl.imsglobal.org/caliper/Person",
    "type": "Person"
  },
  "action": "Attended",
  "object": {
    "id": "https://example.edu/library/events/3",
    "type": "LibraryActivity"
  },
  "eventTime": "2021-11-06T19:30:00.000Z",
  "participationMode": "in-person"
}

Figure 7 - A Person Attended a LibraryActivity for a CourseOffering. In this example:

The actor is identified.
The object is identified.

{
  "@context": "http://purl.imsglobal.org/ctx/caliper/v1p2/LibraryProfile-extension",
  "id": "urn:uuid:fd245e24-d9fa-4384-8b0a-7d08d632e63f",
  "type": "LibraryParticipationEvent",
  "profile": "LibraryProfile",
  "actor": {
    "id": "https://example.edu/users/554433",
    "type": "Person"
  },
  "action": "Attended",
  "object": {
    "id": "https://example.edu/library/events/3",
    "type": "LibraryActivity"
  },
  "eventTime": "2021-11-06T17:55:01.000Z",
  "arrivalTime": "2021-11-06T17:55:00.000Z",
  "participationMode": "online",
  "forCourse": {
    "id": "https://example.edu/terms/202103/courses/101",
    "type": "CourseOffering",
    "courseNumber": "Eng 101"
  }
}

4. Actions

4.1 Accessed

The Accessed action signals that some Entity was opened, loaded, or retrieved.

IRI: https://purl.imsglobal.org/caliper/actions/Accessed
Term: Accessed
Related Gloss(es): WordNet: access - reach or gain access to
Supported by: Event, LibraryResourceUseEvent

4.2 Attended

The Attended action signals that a Person was present at a LibraryActivity.

IRI: https://purl.imsglobal.org/caliper/actions/Attended
Term: Attended
Related Gloss(es): WordNet: attend - be present at
Supported by: Event, LibraryParticipationEvent

4.3 Used

The Used action signals that an Agent utilized or employed an Entity for some purpose.

IRI: https://purl.imsglobal.org/caliper/actions/Used
Term: Used
Related Gloss(es): WordNet: utilise, use, employ, utilize, apply - put into service; make work or employ for a particular purpose or for its inherent or natural purpose
Supported by: Event, ToolUseEvent, LibraryUseEvent

5. Entities

5.1 Library

A Caliper Library entity represents libraries, archives, museums, and other cultural memory institutions and their sub-organizations.

As a subtype of Organization, a Library can act as an Agent. It can be linked both to a parent Organization and to its members.

IRI: http://purl.imsglobal.org/caliper/Library
Term: Library
Supertype: Organization
Properties: Library inherits all properties defined by its supertype Organization, of which id and type are required. LibrarySpace is also provisioned with the additional properties buildingName, buildingNumber. Additional type restrictions are described below:

Property	Type	Description	Disposition
type	Term	The string value MUST be set to the Term Library.	Required
buildingName	string	The building name for this Library.	Optional
buildingNumber	string	The building number for this Library.	Optional

5.1.1 JSON Examples

Below are examples of Library entities.

Figure 8 - A simple Library entity.

{
  "@context": "http://purl.imsglobal.org/ctx/caliper/v1p2/LibraryProfile-extension",
  "id": "https://example.edu/library",
  "type": "Library",
  "name": "University Library"
}

Figure 9 - A Library with building information and specifying a parent Organization.

{
  "@context": "http://purl.imsglobal.org/ctx/caliper/v1p2/LibraryProfile-extension",
  "id": "https://example.edu/library",
  "type": "Library",
  "name": "University Library",
  "description": "The primary library building on campus.",
  "buildingName": "Main Library Building",
  "buildingNumber": "100",
  "subOrganizationOf": {
    "id": "https://example.edu/coolschool",
    "type": "Organization"
  }
}

5.2 LibraryActivity

A Caliper LibraryActivity entity represents an activity organized or led by library staff or convened in a LibrarySpace.

IRI: https://purl.imsglobal.org/caliper/LibraryActivity
Term: LibraryActivity
Supertype: Entity
Properties: LibraryActivity inherits all properties defined by its supertype Entity, of which id and type are required. Additional type restrictions are described below:

Property	Type	Description	Disposition
type	Term	The string value MUST be set to the Term LibraryActivity.	Required
activityType	string	A non-standardized description of type of activity. Examples include: `reference`, `instruction`, `outreach`, `exhibit`.	Optional
interactionMode	string	A non-standardized description of the mode of interaction. Examples include: `in-person`, `online conference`, `chat`, `text`, `social media`, `phone`, `appointment`, `consultation`, `roving`, `embedded`, `email`.	Optional
synchronicity	Term	A description of how the LibraryActivity was intended to be consumed. Allowable values are: `synchronous`, `asynchronous`, `both`.	Optional
location	Library \| LibrarySpace \| IRI	The Library or LibrarySpace the LibraryActivity occurred in.	Optional
scheduledTime	DateTime	An ISO 8601 date and time value. The value MUST be set to UTC with no offset specified.	Optional
actualTime	DateTime	An ISO 8601 date and time value. The value MUST be set to UTC with no offset specified.	Optional
duration	Duration	The duration of the LibraryActivity. If a duration is specified the value MUST conform to the ISO 8601 duration format.	Optional
forCourse	CourseOffering \| CourseSection \| IRI	If the LibraryActivity is intended for a specific CourseOffering or CourseSection it can be referenced here.	Optional
academicSession	string	A string value that constitutes a human-readable identifier of the designated period in which this LibraryActivity occurs. Examples include: `Fall 2016`, `Spring 2021`.	Optional
exhibitMode	string	A non-standardized description of the mode of the exhibit. Examples include: `in-person`, `online`, `hybrid online`, `traveling`, `pop-up`.	Optional
reportingCategory	string	A non-standardized description to classify the type of interaction for external reporting (e.g., ACRL, ARL). Examples include: `directional`, `technical`, `reference`.	Optional

5.2.1 JSON Examples

Below are examples of LibraryActivity entities.

Figure 10 - A synchronous online instructional activity for a CourseOffering.

{
  "@context": "http://purl.imsglobal.org/ctx/caliper/v1p2/LibraryProfile-extension",
  "id": "https://example.edu/library/events/3",
  "type": "LibraryActivity",
  "name": "Using Databases for Thesis Research",
  "activityType": "instruction",
  "interactionMode": "online conference",
  "synchronicity": "synchronous",
  "forCourse": {
    "id": "https://example.edu/terms/202103/courses/7",
    "type": "CourseOffering",
    "courseNumber": "EDU 601"
  },
  "scheduledTime": "2021-11-06T18:00:00.000Z",
  "duration": "18m",
  "academicSession": "Fall 2021"
}

Figure 11 - An asynchronous in-person exhibit in a LibrarySpace.

{
  "@context": "http://purl.imsglobal.org/ctx/caliper/v1p2/LibraryProfile-extension",
  "id": "https://example.edu/library/events/56",
  "type": "LibraryActivity",
  "name": "A History of Dust",
  "activityType": "exhibit",
  "interactionMode": "in-person",
  "synchronicity": "asynchronous",
  "location": {
    "id": "https://example.edu/library/special_collections/22",
    "type": "LibrarySpace",
    "name": "Special Collections Reading Room"
  },
  "scheduledTime": "2021-11-06T18:00:00.000Z",
  "exhibitMode": "in-person"
}

Figure 12 - A synchronous in-person workshop in a LibrarySpace.

{
  "@context": "http://purl.imsglobal.org/ctx/caliper/v1p2/LibraryProfile-extension",
  "id": "https://example.edu/library/events/3",
  "type": "LibraryActivity",
  "name": "Privacy Workshop",
  "activityType": "instruction",
  "interactionMode": "in-person",
  "synchronicity": "synchronous",
  "location": {
    "id": "https://example.edu/library/auditoriums/2",
    "type": "LibrarySpace"
  },
  "scheduledTime": "2021-11-06T18:00:00.000Z",
  "duration": "1h",
  "academicSession": "Fall 2021"
}

Figure 13 - A reference consultation at a LibrarySpace.

{
  "@context": "http://purl.imsglobal.org/ctx/caliper/v1p2/LibraryProfile-extension",
  "id": "https://example.edu/library/events/3",
  "type": "LibraryActivity",
  "activityType": "reference",
  "interactionMode": "consultation",
  "location": {
    "id": "https://example.edu/library/service_point/2",
    "type": "LibrarySpace"
  },
  "reportingCategory": "reference"
}

5.3 LibraryResource

A Caliper LibraryResource is a generic type that represents any resource made available by a Library. Utilize LibraryResource only if no suitable subtype exists to represent the resource being described.

IRI: https://purl.imsglobal.org/caliper/LibraryResource
Term: LibraryResource
Supertype: Entity
Properties: LibraryResource inherits all properties defined by its supertype Entity, of which id and type are required. LibraryResource is also provisioned with the additional properties name, physicalOrDigital, referrer, MARC008, resourceType, and otherIdentifiers Additional type restrictions are described below:

Property	Type	Description	Disposition
type	Term	The string value MUST be set to the Term LibraryResource.	Required
physicalOrDigital	string	A description of how the LibraryResource is accessed. Values are: `physical`, `digital`.	Optional
marc008	string	A value drawn from the list of MARC 008 Data Elements.	Optional
resourceType	string	A non-standardized description of the type of LibraryResource. Examples include: `database`, `e-journal`, `article`, `journal`, `e-book`, `book`, `citation`.	Optional
learningObjectives	Array	An ordered collection of one or more LearningObjective entities that describe what a learner is expected to comprehend or accomplish after engaging with the resource. Each array item MUST be expressed either as an object or as a string corresponding to the item's IRI.	Optional
otherIdentifiers	Array	An ordered collection of SystemIdentifier entities that represent other identifiers for this resource. Each array item MUST be expressed either as an object or as a string corresponding to the item's IRI.	Optional

5.3.1 JSON Examples

Below are examples of LibraryResource entities.

Figure 14 - A digital article with a DOI.

{
  "@context": "http://purl.imsglobal.org/ctx/caliper/v1p2/LibraryProfile-extension",
  "id": "https://example.edu/articles/56445",
  "type": "LibraryResource",
  "physicalOrDigital": "digital",
  "resourceType": "article",
  "name": "Enriching College Students' Leadership Efficacy",
  "otherIdentifiers": [
    {
      "type": "SystemIdentifier",
      "identifier": "10.12806/V19/I4/R7",
      "identifierType": "DigitalObjectIdentifier"
    }
  ]
}

Figure 15 - A physical book with an ISBN.

{
  "@context": "http://purl.imsglobal.org/ctx/caliper/v1p2/LibraryProfile-extension",
  "id": "https://example.edu/equipment/0395487302",
  "type": "LibraryResource",
  "physicalOrDigital": "physical",
  "resourceType": "book",
  "name": "Dust: A History",
  "otherIdentifiers": [
    {
      "type": "SystemIdentifier",
      "identifier": "1234567890123",
      "identifierType": "InternationalStandardBookNumber"
    }
  ]
}

Figure 16 - A digital journal with a learning objective and an ISSN.

{
  "@context": "http://purl.imsglobal.org/ctx/caliper/v1p2/LibraryProfile-extension",
  "id": "https://example.edu/journals/231302",
  "type": "LibraryResource",
  "physicalOrDigital": "digital",
  "resourceType": "journal",
  "name": "Journal of Library Assessment",
  "learningObjectives": [
    {
      "id": "http://library.edu/services/library-instruction-services/library-learning-outcomes/1",
      "type": "LearningObjective"
    }
  ],
  "otherIdentifiers": [
    {
      "type": "SystemIdentifier",
      "identifier": "1564-4587",
      "identifierType": "InternationalStandardSerialNumber"
    }
  ]
}

Figure 17 - An unidentified book with an LCCN class.

{
  "@context": "http://purl.imsglobal.org/ctx/caliper/v1p2/LibraryProfile-extension",
  "id": "https://purl.imsglobal.org/caliper/LibraryResource",
  "type": "LibraryResource",
  "resourceType": "book",
  "otherIdentifiers": [
    {
      "type": "SystemIdentifier",
      "identifier": "JK",
      "identifierType": "LibraryCongressCallNumber"
    }
  ]
}

5.4 LibrarySpace

A Caliper LibrarySpace represents any space used for library services either permanently or temporarily.

IRI: http://purl.imsglobal.org/caliper/LibrarySpace
Term: LibrarySpace
Supertype: Entity
Properties: LibrarySpace inherits all properties defined by its supertype Entity, of which id and type are required. LibrarySpace is also provisioned with the additional properties buildingName, buildingNumber, roomNumber, floor, servicePoint, isPartOf. Additional type restrictions are described below:

Property	Type	Description	Disposition
type	Term	The string value MUST be set to the Term LibrarySpace.	Required
buildingName	string	The building name for this space if it's in a building.	Optional
buildingNumber	string	The building number for this space if it's in a building.	Optional
roomNumber	string	The room number for this space if applicable.	Optional
floor	string	The floor for this LibrarySpace.	Optional
servicePoint	string	A non-standardized description of the location where the interaction happened. Examples include `circulation desk`, `reference desk`, `roving reference`.	Optional
isPartOf	Library \| IRI	A related Library that this LibrarySpace belongs to. The `isPartOf` value MUST be expressed either as an object or as a string corresponding to the associated entity's IRI.	Optional

5.4.1 JSON Examples

Below are examples of LibrarySpace entities.

Figure 18 - A reference desk in the 4th floor alcove.

{
  "@context": "http://purl.imsglobal.org/ctx/caliper/v1p2/LibraryProfile-extension",
  "id": "https://example.edu/library/alcoves/42",
  "type": "LibrarySpace",
  "name": "Alcove 4-2",
  "floor": "4",
  "servicePoint": "reference desk",
  "isPartOf": {
    "id": "https://example.edu/library",
    "type": "Library"
  }
}

Figure 19 - An auditorium in another building used for a LibraryActivity.

{
  "@context": "http://purl.imsglobal.org/ctx/caliper/v1p2/LibraryProfile-extension",
  "id": "https://example.edu/humanities/auditoriums/1024",
  "type": "LibrarySpace",
  "name": "Humanities Auditorium",
  "buildingName": "Humanities Center of Excellence",
  "buildingNumber": "444",
  "roomNumber":  "1024"
}

A. System Identifier Types

Caliper provides a controlled vocabulary for enumerating various categories of SystemIdentifier types associated with a Caliper Entity that may prove meaningful when exchanging identifiers between systems (especially with respect to other 1EdTech standards).

Digital Object Identifier (DOI)

Set the SystemIdentifier.identifierType string value to DigitalObjectIdentifier if the SystemIdentifier is a Digital Object Identifier (DOI).

IRI: http://purl.imsglobal.org/vocab/systemIdentifiers/DigitalObjectIdentifier
Term: DigitalObjectIdentifier

International Standard Book Number (ISBN)

Set the SystemIdentifier.identifierType string value to InternationalStandardBookNumber if the SystemIdentifier is an International Standard Book Number (ISBN).

IRI: http://purl.imsglobal.org/vocab/systemIdentifiers/InternationalStandardBookNumber
Term: InternationalStandardBookNumber

International Standard Serial Number (ISSN)

Set the SystemIdentifier.identifierType string value to InternationalStandardSerialNumber if the SystemIdentifier is an International Standard Serial Number.

IRI: http://purl.imsglobal.org/vocab/systemIdentifiers/InternationalStandardSerialNumber
Term: InternationalStandardSerialNumber

OCLC Number (OCN)

Set the SystemIdentifier.identifierType string value to OCLCNumber if the SystemIdentifier is an OCLC number.

IRI: http://purl.imsglobal.org/vocab/systemIdentifiers/OCLCNumber
Term: OCLCNumber

Library of Congress Call Number (LCCN)

Set the SystemIdentifier.identifierType string value to LibraryCongressCallNumber if the SystemIdentifier is a Library of Congress Call Number.

IRI: http://purl.imsglobal.org/vocab/systemIdentifiers/LibraryCongressCallNumber
Term: LibraryCongressCallNumber

Dewey Decimal Call Number (DDC)

Set the SystemIdentifier.identifierType string value to DeweyDecimalCallNumber if the SystemIdentifier is a Dewey Decimal call number.

IRI: http://purl.imsglobal.org/vocab/systemIdentifiers/DeweyDecimalCallNumber
Term: DeweyDecimalCallNumber

Superintendent of Documents Classification (SuDoc)

Set the SystemIdentifier.identifierType string value to SuperintendentDocumentsClassification if the SystemIdentifier is a Superintendent of Documents Classification.

IRI: http://purl.imsglobal.org/vocab/systemIdentifiers/SuperintendentDocumentsClassification
Term: SuperintendentDocumentsClassification

Barcode

Set the SystemIdentifier.identifierType string value to Barcode if the SystemIdentifier is a Barcode.

IRI: http://purl.imsglobal.org/vocab/systemIdentifiers/Barcode
Term: Barcode

PubMed ID (PMID)

Set the SystemIdentifier.identifierType string value to PubMedID if the SystemIdentifier is a PubMed ID.

IRI: http://purl.imsglobal.org/vocab/systemIdentifiers/PubMedID
Term: PubMedID

LibGuide Identifier

Set the SystemIdentifier.identifierType string value to LibGuideID if the SystemIdentifier is a LibGuide identifier.

IRI: http://purl.imsglobal.org/vocab/systemIdentifiers/LibGuideID
Term: LibGuideID

B. Revision History

This section is non-normative.

B.1 Version History

Version No.	Release Date	Comments
1EdTech Candidate Final Public 1.0	20 November 2020	Public draft release.

B.2 Changes from previous version

As this is the first version of this document, no previous version change log exists.

C. References

C.1 Normative references

[CALIPER-12]: Caliper® Analytics Specification 1.2. Whyte, Anthony; Haag, Viktor; Feng, Linda; Gylling, Markus; Ashbourne, Matt; LaMarche, Wes; Pelaprat, Etienne. 1EdTech Consortium. URL: https://www.imsglobal.org/spec/caliper/v1p2
[CALIPER-12-CERT]: Caliper Analytics® Sensor Certification Guide 1.2. Mosbacker, Bracken; Whyte, Anthony. 1EdTech Consortium. URL: https://www.imsglobal.org/spec/caliper/v1p2/cert
[CALIPER-LIBRARY-12-CONTEXT]: Caliper Analytics® Library Use Profile Context 1.2 Extension. 1EdTech Consortium. URL: https://purl.imsglobal.org/spec/caliper-libraryuse/v1p2-extension/context/
[CALIPER-LIBRARY-12-ERRATA]: Caliper Analytics® Library Use Profile 1.2 Extension Errata. 1EdTech Consortium. URL: https://www.imsglobal.org/spec/caliper-libraryuse/v1p2-extension/errata/
[RFC2119]: Key words for use in RFCs to Indicate Requirement Levels. S. Bradner. IETF. March 1997. Best Current Practice. URL: https://tools.ietf.org/html/rfc2119

C.2 Informative references

[CALIPER-12-IMPL]: Caliper Analytics® Sensor Implementation Guide 1.2. Mosbacker, Bracken; Whyte, Anthony. 1EdTech Consortium. URL: https://www.imsglobal.org/spec/caliper/v1p2/impl

D. List of Contributors

The following individuals contributed to the development of this document:

Name	Organization	Role
Noah Botimer	University of Michigan (USA)	Author
Jan Fransen	University of Minnesota (USA)	Author
Don Hamparian	OCLC (USA)	Author
Sebastien Korner	University of Michigan (USA)	Author
Dennis Krieb	Lewis & Clark Community College (USA)	Author
Steve McCann	OCLC (USA)	Author
Joshua McGhee	1EdTech (USA)	Author
Bracken Mosbacker	1EdTech (USA)	Author
Shane Nackerud	University of Minnesota (USA)	Author
Megan Oakleaf	Syracuse University (USA)	Author
Andrew K. Pace	OCLC (USA)	Author
Etienne Pelaprat	Unizin (USA)	Author
Ken Varnum	University of Michigan (USA)	Author
Anthony Whyte	University of Michigan (USA)	Author
Maurice York	University of Michigan (USA)	Author

You are here

Caliper Library

1. Abstract

2. Overview

2.1 Design Goals and Rationale

2.2 User Stories

2.3 Terminology

2.4 Conformance Statements

2.5 Document Set

2.5.1 Normative Documents

2.5.2 Informative Documents

3. Events

3.1 LibraryUseEvent

3.1.1 JSON Examples

3.2 LibraryResourceUseEvent

3.2.1 JSON Examples

3.3 LibraryParticipationEvent

3.3.1 JSON Examples

4. Actions

4.1 Accessed

4.2 Attended

4.3 Used

5. Entities

5.1 Library

5.1.1 JSON Examples

5.2 LibraryActivity

5.2.1 JSON Examples

5.3 LibraryResource

5.3.1 JSON Examples

5.4 LibrarySpace

5.4.1 JSON Examples

A. System Identifier Types

Digital Object Identifier (DOI)

International Standard Book Number (ISBN)

International Standard Serial Number (ISSN)

OCLC Number (OCN)

Library of Congress Call Number (LCCN)

Dewey Decimal Call Number (DDC)

Superintendent of Documents Classification (SuDoc)

Barcode

PubMed ID (PMID)

LibGuide Identifier

B. Revision History

B.1 Version History

B.2 Changes from previous version

C. References

C.1 Normative references

C.2 Informative references

D. List of Contributors