GitHub Twitter

SemanticTextAnnotation DRAFT Profile

Version: 0.2-DRAFT-2020_12_03 (07 December 2020)

Bioschemas profile, based on Biotea model, describing a semantic annotation associated to a piece of text in a ScholarlyArticle in Life Sciences.


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 Scholarly Publications group.

Group Leader(s)
Other team members

Schema.org hierarchy

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

Thing > CreativeWork

Description

A SemanticTextAnnotation corresponds to an expression identified in a ScholarlyArticle and associated to an ontology term.

Summary of Changes

Changes since previous draft 0.1 of the SemanticAnnotation profile:
  • Add examples
  • Updates name to SemanticTextAnnotation as currently only text-based annotations are supported, if needd a supperclass SemanticAnnotation can be created and then add support to, for instance, images or so
  • Changes commentCount to optional as sometimes calculation is also possible
  • Changes creator and dates to optional as they can also be provided at container/dataset level only
  • Adds datePublished as optional
  • Removes isAccessibleForFree and license (most likely to be found at container/dataset level)
  • Adds isPartOf as optional to link to the dataset or collection containing this annotation
  • Double checks the property range as some has been updated in schema.org
  • Changes prepared by L. Garcia

Latest profiles

Latest release: none

Latest draft: 0.2-DRAFT-2020_12_03

Previous profiles

Previous version: 0.1-DRAFT-2019_11_19


Group Use Cases Cross Walk Task & Issues Examples Live Deploys
Scholarly Publications

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

View all examples
Property Expected Type Description CD Controlled Vocabulary Example
Marginality: Minimum.
mainEntity DefinedTerm
Schema:

Indicates the primary entity described in some page or other CreativeWork. Inverse property: mainEntityOfPage.


Bioschemas:

Ontology terms associated to this annotation. On the DefinedTerm, use additionalType to link to a Unified Medical Language System (UMLS) semantic type (TUI) or group, and sameAs to link to the corresponding concept unique identifier (CUI), if available. Note: Bioschemas recommends using DefinedTerm rather than Thing (as specified in schema.org)

MANY
View ≪mainEntity≫ example
text Text
Schema:

The textual content of this CreativeWork.


Bioschemas:

Expression found in the text corresponding to this annotation.

MANY
View ≪text≫ example
Marginality: Recommended.
subjectOf CreativeWork
Event
Schema:

A CreativeWork or Event about this Thing. Inverse property: about


Bioschemas:

ScholarlyArticle where this annotation is located. It is also possible to link from the ScholarlyArticle to the SemanticTextAnnotation via about Note: For the Bioschemas case, the preferred property range is ScholarlyArticle

ONE
View ≪subjectOf≫ example
Marginality: Optional.
commentCount Integer
Schema:

The number of comments this CreativeWork (e.g. Article, Question or Answer) has received. This is most applicable to works published in Web sites with commenting system; additional comments may exist elsewhere.


Bioschemas:

Number of times this annotation is found in the associated scholarly article.

ONE
View ≪commentCount≫ example
creator Organization
Person
Schema:

The creator/author of this CreativeWork. This is the same as the Author property for CreativeWork.


MANY
View ≪creator≫ example
dateCreated Date
DateTime
Schema:

The date on which the CreativeWork was created or the item was added to a DataFeed.


ONE
View ≪dateCreated≫ example
dateModified Date
DateTime
Schema:

The date on which the CreativeWork was most recently modified or when the item’s entry was modified within a DataFeed.


ONE
View ≪dateModified≫ example
datePublished Date
Schema:

Date of first broadcast/publication.


ONE
View ≪datePublished≫ example
identifier PropertyValue
Text
URL
Schema:

The identifier property represents any kind of identifier for any kind of Thing, such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See background notes for more details.


Bioschemas:

If available.

ONE
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
isPartOf CreativeWork
Trip
Journal
PublicationVolume
PublicationIssue
Schema:

Indicates an item or CreativeWork that this item, or CreativeWork (in some sense), is part of. Inverse property: hasPart.


Bioschemas:

Dataset or collection aggregating this annotation

MANY
View ≪isPartOf≫ example
position Integer
Text
Schema:

The position of an item in a series or sequence of items.


MANY

Top ▲