GitHub Twitter

CourseInstance DRAFT Profile

Version: 0.8-DRAFT-2020_10_06 (06 October 2020)

Specification describing the instance of a course.


If you spot any errors or omissions with this type, please file an issue in our GitHub.


Contributors

The following people have been involved in the creation of this specification document. They are all members of the Training group.

Group Leader(s)
Other team members

Schema.org hierarchy

This Profile fits into the schema.org hierarchy as follows:

Thing > Event > CourseInstance

Description

This specification can be used in tandem with a Course. A course is used to describe the broad, common aspects of a recurring training event - whereas a course instance is about the specific times and location of when that course is held.

Summary of Changes

Changes since previous draft 0.7 of the CourseInstance profile:
  • Removed CourseInstance->mentions
  • Inserted CourseInstance->courseWorkLoad (it was missing)
  • Inserted Event->eventAttendanceMode
  • Inserted Event->eventSchedule
  • doorTime - added Time in Expected Type column (it was missing)
  • location - added VirtualLocation in Expected Type column (it was missing)
  • offers - added "Demand or" in Expected Type column (it was missing)
  • offers - modified Description column (it was not the same as in schema.org)
  • instructor - added BSC Description
  • duration - changed the BSC Description (changed timeRequired by duration, which was changed also in Course)
  • name - changed the BSC Description (made the description more explicit)
  • offers - changed the BSC Description (corrected wording)
  • description - extended the example
  • workFeatured - changed the BSC Description (extended the description)
  • Adjusted Authors: Patricia Palagi to editor; Niall Beard no longer editor
  • Changes prepared by Patricia Palagi

Latest profiles

Latest release: none

Latest draft: 0.8-DRAFT-2020_10_06

Previous profiles

Previous version: 0.7-DRAFT-2019_11_08


Group Use Cases Cross Walk Task & Issues Examples Live Deploys
Training

You can read the release version of this specification here.




Key to specification table

Schema.org properties where the Expected Types have been changed, or new (i.e., Bioschemas created) properties/types are green.

Schema.org properties/types are red.

Pending Schema.org properties/types are blue.

External (i.e., from 3rd party ontology) properties/types are black.


CD = Cardinality


View all examples
Property Expected Type Description CD Controlled Vocabulary Example
Marginality: Minimum.
courseMode Text
URL
Schema:

The medium or means of delivery of the course instance or the mode of study, either as a text label (e.g. “online”, “onsite” or “blended”; “synchronous” or “asynchronous”; “full-time” or “part-time”) or as a URL reference to a term from a controlled vocabulary (e.g. https://ceds.ed.gov/element/001311#Asynchronous ).


MANY
  • “online”, “onsite” or “blend of online and onsite”
  • “synchronous” or “asynchronous”
  • “full-time” or “part-time”
View ≪courseMode≫ example
location Place
PostalAddress
Text
VirtualLocation
Schema:

The location of for example where the event is happening, an organization is located, or where an action takes place.


Bioschemas:

Location of the Course Instance. If the Course Instance is online, add the connection details as text

ONE
View ≪location≫ example
Marginality: Recommended.
endDate Date
DateTime
Schema:

The end date and time of the item (in ISO 8601 date format).


ONE

ISO 8601

View ≪endDate≫ example
inLanguage Language
Text
Schema:

The language of the content or performance or used in an action. Please use one of the language codes from the IETF BCP 47 standard. See also availableLanguage. Supersedes language.


ONE
View ≪inLanguage≫ example
instructor Person
Schema:

A person assigned to instruct or provide instructional assistance for the CourseInstance.


Bioschemas:

An instructor can be the main teacher or trainer, as well as a training assistant, or a helper.

MANY
View ≪instructor≫ example
offers Demand
Offer
Schema:

An offer to provide this item—for example, an offer to sell a product, rent the DVD of a movie, perform a service, or give away tickets to an event. Use businessFunction to indicate the kind of transaction offered, i.e. sell, lease, etc. This property can also be used to describe a Demand. While this property is listed as expected on a number of common types, it can be used in others. In that case, using a second type, such as Product or a subtype of Product, can clarify the nature of the offer. Inverse property: itemOffered.


Bioschemas:

The price an attendee would pay to attend this CourseInstance.

MANY

Currency and value, Date specified price

View ≪offers≫ example
startDate Date
DateTime
Schema:

The start date and time of the item (in ISO 8601 date format).


ONE

ISO 8601

View ≪startDate≫ example
url URL
Schema:

URL of the item.


Bioschemas:

The preferred URL of this course instance. You must provide this value if it is known

ONE
View ≪url≫ example
Marginality: Optional.
alternateName Text
Schema:

An alias for the item.


MANY
View ≪alternateName≫ example
contributor Organization
Person
Schema:

A secondary contributor to the CreativeWork or Event.


Bioschemas:

Contributors are those who made non-authorship contributions: e.g., critical review, commentary or revision.

MANY
View ≪contributor≫ example
description Text
Schema:

A description of the item.


Bioschemas:

A description of the Course Instance.

(courseInstance) description can be used to override (course) description for specific course instances.

ONE
View ≪description≫ example
duration Duration
Schema:

The duration of the item (movie, audio recording, event, etc.) in ISO 8601 date format.


Bioschemas:

(CourseInstance) duration can be used to override (Course) duration for specific course instances.

ONE
View ≪duration≫ example
eventStatus EventStatusType
Schema:

An eventStatus of an event represents its status; particularly useful when an event is cancelled or rescheduled.


ONE
  • postponed
  • cancelled
  • date TBD
  • application open
  • registration closed
View ≪eventStatus≫ example
funder Organization
Person
Schema:

A person or organization that supports (sponsors) something through some kind of financial contribution.


MANY
View ≪funder≫ example
image ImageObject
URL
Schema:

An image of the item. This can be a URL or a fully described ImageObject.


ONE
View ≪image≫ example
maximumAttendeeCapacity Integer
Schema:

The total number of individuals that may attend an event or venue.


ONE
View ≪maximumAttendeeCapacity≫ example
name Text
Schema:

The name of the item.


Bioschemas:

The name of the course.

Course instance name can be used to override Course name for variations in specific Course instances. Use name from Course unless the Course instance has a different name from the course.

ONE
View ≪name≫ example
organizer Organization
Person
Schema:

An organizer of an Event.


MANY
View ≪organizer≫ example
subEvent Event
Schema:

An Event that is part of this event. For example, a conference event includes many presentations, each of which is a subEvent of the conference. Supersedes subEvents. Inverse property: superEvent.


Bioschemas:

For events within events e.g. guest lecture within a workshop event

MANY
View ≪subEvent≫ example
superEvent Event
Schema:

An event that this event is a part of. For example, a collection of individual music performances might each have a music festival as their superEvent. Inverse property: subEvent.


Bioschemas:

Use to describe the event a course instance takes place within. e.g. Galaxy Workshop during the ISMB Conference.

MANY
View ≪superEvent≫ example
workFeatured CreativeWork
Schema:

A work featured in some event, e.g. exhibited in an ExhibitionEvent. Specific subproperties are available for workPerformed (e.g. a play), or a workPresented (a Movie at a ScreeningEvent).


Bioschemas:

The training material used in this specific course instance, or produced for this course instance.

Inverse property: workFeatured

If this is the same for all Course Instances, use hasPart and/or mentions in Course instead

MANY
View ≪workFeatured≫ example

Top ▲