SemanticTextAnnotation DRAFT Profile
Version: 0.1-DRAFT-2019_11_19 (08 February 2019)
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.
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 | 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 | ||
@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 | |
@id | IRI | Used to distinguish the resource being described in JSON-LD. For other serialisations use the appropriate approach. | ONE | ||
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 | |
mainEntity |
Thing DefinedTerm DefinedTermSet |
Schema: Indicates the primary entity described in some page or other CreativeWork. Inverse property: mainEntityOfPage. Bioschemas: DefinedTerm(s), i.e., ontology terms, associated to this annotation. Use DefinedTermSet if multiple related terms should be seen as a whole, for instance MeSH descriptors accompanied by MeSH qualifiers . 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. |
MANY | ||
text |
Text |
Schema: The textual content of this CreativeWork. Bioschemas: Expression found in the text corresponding to this annotation. |
MANY | ||
Marginality: Recommended. | |||||
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 | ||
creator |
Organization Person SoftwareApplication |
Schema: The creator/author of this CreativeWork. This is the same as the Author property for CreativeWork. Bioschemas: Person, organization or software application used to create this annotation. |
MANY | ||
dateCreated |
Date DateTime |
Schema: The date on which the CreativeWork was created or the item was added to a DataFeed. |
ONE | ||
position |
Integer Text BreadcrumbList URL |
Schema: The position of an item in a series or sequence of items. Bioschemas: A list of links that can help a user understand and navigate to a section or paragraph in the scholarly article where this annotation is located. If a text is used, different steps on the list should be separated with the character ‘>’, being the sentence where the annotation is found the last element. If a URL is used, it should identify the section or paragraph where this annoation is found. |
ONE | ||
subjectOf |
CreativeWork Event ScholarlyPublication |
Schema: A CreativeWork or Event about this Thing. Bioschemas: The ScholarlyPublication where this annotation is found. |
ONE | ||
Marginality: Optional. | |||||
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. |
MANY | ||
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 | ||
isAccessibleForFree |
Boolean |
Schema: A flag to signal that the item, event, or place is accessible for free. Supersedes free. |
ONE | ||
license |
CreativeWork URL |
Schema: A license document that applies to this content, typically indicated by URL. |
ONE |