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.

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: 1.0-RELEASE

Latest draft: 1.1-DRAFT

Previous profiles

Previous version: 0.7-DRAFT-2019_11_08

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)

Patricia Palagi

Michelle Brazas

Leyla Jael Castro

Other team members

Victoria Dominguez Del Angel

Chris Child

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

Green properties/types are proposed by Bioschemas, or indicate proposed changes by Bioschemas to Schema.org
Red properties/types exist in the core of Schema.org
Blue properties/types exist in the pending area of Schema.org
Black properties/types are reused from external vocabularies/ontologies

CD = Cardinality

//Property: alternateName
"alternateName": "CS101 as part of M.130"

//Property: contributor
"contributor": [{
  "@type": "Person",
  "name": "John Smith"
},{ 
  "@type": "Person",
  "name": "Janet Jones",
 "url": "https://manchester.ac.uk/staff/profiles/janet-jones"
}]

//Property: courseMode
"courseMode": ["online", "synchronous", "part-time"]

//Property: description
"description": "An instance of a course being ran in an institution Y in the Fall 2020 onsite"

//Property: duration
"duration": "P1DT6H"

//Property: endDate
"endTime": "2019-02-05T17:00:00"

//Property: eventStatus
"eventStatus": "postponed"

//Property: funder
"funder":  [{
  "@type": "Person",
  "name": "John Smith"
},{ 
  "@type": "Organization",
  "name": "University of South Africa"
}]

//Property: image
"image": "https://image.server.com/my-image.jpg"

//Property: inLanguage
"inLanguage": "en-GB"

//Property: instructor
"instructor": [{
  "@type": "Person",
  "name": "Alan Jones"
},{ 
  "@type": "Person",
  "name": "John Smith",
  "url": "https://manchester.ac.uk/staff/profiles/john-smith"
}]

//Property: location
"location": {
    "@type": "Place",
    "address": {
      "@type": "PostalAddress",
      "streetAddress": "1.17, Kilburn Building, University of Manchester",
      "addressLocality": "Manchester",
      "addressRegion": "Greater Manchester",
      "addressCountry": "United Kingdom",
      "postalCode": "M13 9PL"
    }
}

//Property: maximumAttendeeCapacity
 "maximumAttendeeCapacity": "35"

//Property: name
"name": "RNA-seq data analysis in R in Autumn 2020 CS101"

//Property: offers
"offers": [
    //Early bird tickets
    {
        "@type": "Offer",
        "name": "Early Bird Tickets",
        "priceValidUntil": "2021-02-04T09:00:00",
        "price": "50.00",
        "priceCurrency": "GBP"
    },

    //Academic Pricing
    {
      "@type": "Offer",
      "name": "Academic Price",
      "price": "100.00",
      "priceValidUntil": "2021-02-05T17:00:00",
      "eligibleCustomerType": {
        "@type": "BusinessEntityType",
        "name": "Academic"
      },
      "priceCurrency": "GBP",
    },
    //Industry Pricing
    {
      "@type": "Offer",
      "name": "Industry Price",
      "price": "500.00",
      "priceCurrency": "GBP",
        "eligibleCustomerType": {
        "@type": "BusinessEntityType",
        "name": "Industrial"
      },
    },
    //First 50 tickets free
    {
      "@type": "Offer",
      "name": "Free bursary for first 50 registrants",
      "price": "0.00",
      "priceCurrency": "GBP",
      "url": "http://www.eventbrite.com/my-workshop",
      "eligibleQuantity": {
        "@type": "QuantitativeValue",
        "value": 50
      }
    }
]

//Property: organizer
"organizer":  [{
  "@type": "Person",
  "name": "Elizabeth Windsor",
  "email": "e.r.windsor@gmail.com"
},{ 
  "@type": "Organization",
  "name": "University of Soth Wales"
}]


//Property: startDate
"startDate": "2019-02-04T09:00:00"

//Property: subEvent
"subEvent": [{
      "@type": "Event",
      "name": "Lunch time Lecture",
      "url": "https://lectureatlunch.com",
      "description": "This special lecture hosted during lunchtime as part of the RNA-SEQ in R workshop demonstrates some of the latest technologies available."
  }]


//Property: superEvent
"superEvent": [{
      "@type": "Event",
      "name": "ISCB Conference",
      "url": "https://www.iscb.org",
      "description": "This years ISCB conference will contain a special education section"
  },
{
      "@type": "Event",
      "name": "Online lecture",
      "url": "https://onlinelectureat.org",
      "description": "This online lecture describes the neXtProt database. It closes the general, and in person, course on protein sequence databases."
}]

//Property: url
"url": "http://example.com/rna-seq_in_r"

//Property: workFeatured
"workFeatured": [{
  "@type": "TrainingMaterial",
  "name": "Course Slides for Autumn 2020 offering of CS101",
  "url": "http://example.com/slides_website"
  "description": "The course slides contain diagrams, questions, and links to various resources about this course" 
  "keywords": "Computer Science, CS, Introductory"
},
{
  "@type": "Thing",
  "name": "neXtProt database",
  "url": "https://www.nextprot.org"
  "description": "The course instance was dedicated to the neXtProt datbase and how to explore the universe of human proteins" 
  "keywords": "Molecular Biology, Introductory"
}
]

Property	Expected Type	Description	CD	Controlled Vocabulary	Example
Marginality: Minimum.
@context	URL	Used to provide the context (namespaces) for the JSON-LD file. Not needed in other serialisations.	ONE		Property ≪@context≫ example `{ "@context": "https://schema.org/" }`
@type	Text	Schema.org/Bioschemas class for the resource declared using JSON-LD syntax. For other serialisations please use the appropriate mechanism. While it is permissible to provide multiple types, it is preferred to use a single type.	MANY	Schema.org, Bioschemas	Property ≪@type≫ example `{ "@type": "CourseInstance" }`
@id	IRI	Used to distinguish the resource being described in JSON-LD. For other serialisations use the appropriate approach.	ONE		Property ≪@id≫ example `{ "@id": "http://example.com/entity/A12345" }`
dct:conformsTo	IRI	Used to state the Bioschemas profile that the markup relates to. The versioned URL of the profile must be used. Note that we use a CURIE in the table here but the full URL for Dublin Core terms must be used in the markup (http://purl.org/dc/terms/conformsTo), see example.	ONE	Bioschemas profile versioned URL	Property ≪dct:conformsTo≫ example `{ "http://purl.org/dc/terms/conformsTo": { "@id": "https://bioschemas.org/profiles/CourseInstance/0.8-DRAFT-2020_10_06", "@type": "CreativeWork" } }`
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”	Property ≪courseMode≫ example `"courseMode": ["online", "synchronous", "part-time"]`
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		Property ≪location≫ example `"location": { "@type": "Place", "address": { "@type": "PostalAddress", "streetAddress": "1.17, Kilburn Building, University of Manchester", "addressLocality": "Manchester", "addressRegion": "Greater Manchester", "addressCountry": "United Kingdom", "postalCode": "M13 9PL" } }`
Marginality: Recommended.
endDate	Date DateTime	Schema: The end date and time of the item (in ISO 8601 date format).	ONE	ISO 8601	Property ≪endDate≫ example `"endTime": "2019-02-05T17:00:00"`
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		Property ≪inLanguage≫ example `"inLanguage": "en-GB"`
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		Property ≪instructor≫ example `"instructor": [{ "@type": "Person", "name": "Alan Jones" },{ "@type": "Person", "name": "John Smith", "url": "https://manchester.ac.uk/staff/profiles/john-smith" }]`
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	Property ≪offers≫ example "offers": [ //Early bird tickets { "@type": "Offer", "name": "Early Bird Tickets", "priceValidUntil": "2021-02-04T09:00:00", "price": "50.00", "priceCurrency": "GBP" }, //Academic Pricing { "@type": "Offer", "name": "Academic Price", "price": "100.00", "priceValidUntil": "2021-02-05T17:00:00", "eligibleCustomerType": { "@type": "BusinessEntityType", "name": "Academic" }, "priceCurrency": "GBP", }, //Industry Pricing { "@type": "Offer", "name": "Industry Price", "price": "500.00", "priceCurrency": "GBP", "eligibleCustomerType": { "@type": "BusinessEntityType", "name": "Industrial" }, }, //First 50 tickets free { "@type": "Offer", "name": "Free bursary for first 50 registrants", "price": "0.00", "priceCurrency": "GBP", "url": "http://www.eventbrite.com/my-workshop", "eligibleQuantity": { "@type": "QuantitativeValue", "value": 50 } } ]
startDate	Date DateTime	Schema: The start date and time of the item (in ISO 8601 date format).	ONE	ISO 8601	Property ≪startDate≫ example `"startDate": "2019-02-04T09:00:00"`
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		Property ≪url≫ example `"url": "http://example.com/rna-seq_in_r"`
Marginality: Optional.
alternateName	Text	Schema: An alias for the item.	MANY		Property ≪alternateName≫ example `"alternateName": "CS101 as part of M.130"`
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		Property ≪contributor≫ example `"contributor": [{ "@type": "Person", "name": "John Smith" },{ "@type": "Person", "name": "Janet Jones", "url": "https://manchester.ac.uk/staff/profiles/janet-jones" }]`
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		Property ≪description≫ example `"description": "An instance of a course being ran in an institution Y in the Fall 2020 onsite"`
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		Property ≪duration≫ example `"duration": "P1DT6H"`
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	Property ≪eventStatus≫ example `"eventStatus": "postponed"`
funder	Organization Person	Schema: A person or organization that supports (sponsors) something through some kind of financial contribution.	MANY		Property ≪funder≫ example `"funder": [{ "@type": "Person", "name": "John Smith" },{ "@type": "Organization", "name": "University of South Africa" }]`
image	ImageObject URL	Schema: An image of the item. This can be a URL or a fully described ImageObject.	ONE		Property ≪image≫ example `"image": "https://image.server.com/my-image.jpg"`
maximumAttendeeCapacity	Integer	Schema: The total number of individuals that may attend an event or venue.	ONE		Property ≪maximumAttendeeCapacity≫ example `"maximumAttendeeCapacity": "35"`
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		Property ≪name≫ example `"name": "RNA-seq data analysis in R in Autumn 2020 CS101"`
organizer	Organization Person	Schema: An organizer of an Event.	MANY		Property ≪organizer≫ example `"organizer": [{ "@type": "Person", "name": "Elizabeth Windsor", "email": "e.r.windsor@gmail.com" },{ "@type": "Organization", "name": "University of Soth Wales" }]`
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		Property ≪subEvent≫ example `"subEvent": [{ "@type": "Event", "name": "Lunch time Lecture", "url": "https://lectureatlunch.com", "description": "This special lecture hosted during lunchtime as part of the RNA-SEQ in R workshop demonstrates some of the latest technologies available." }]`
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		Property ≪superEvent≫ example `"superEvent": [{ "@type": "Event", "name": "ISCB Conference", "url": "https://www.iscb.org", "description": "This years ISCB conference will contain a special education section" }, { "@type": "Event", "name": "Online lecture", "url": "https://onlinelectureat.org", "description": "This online lecture describes the neXtProt database. It closes the general, and in person, course on protein sequence databases." }]`
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		Property ≪workFeatured≫ example "workFeatured": [{ "@type": "TrainingMaterial", "name": "Course Slides for Autumn 2020 offering of CS101", "url": "http://example.com/slides_website" "description": "The course slides contain diagrams, questions, and links to various resources about this course" "keywords": "Computer Science, CS, Introductory" }, { "@type": "Thing", "name": "neXtProt database", "url": "https://www.nextprot.org" "description": "The course instance was dedicated to the neXtProt datbase and how to explore the universe of human proteins" "keywords": "Molecular Biology, Introductory" } ]