Annotation Quick Reference Guide

On this page

Overview

Requirements

The tables below provides a summary of the required classes and terms. Term requirements are subject to the use of the parent class where a term that belongs to an optional class are required if and only if, their parent class is in use.

Required Classes
Class Label Required
ods:Annotation Annotation True
ods:AnnotationBody Annotation Body True
ods:AnnotationTarget Annotation Target True
Required Terms
Term Label Class Required
as:generator Generator ods:Annotation True
dcterms:modified Modified ods:Annotation True
dcterms:identifier Identifier ods:Annotation True
ods:fdoType Fdo Type ods:Annotation True
ods:version Version ods:Annotation True
dcterms:issued Issued ods:Annotation True
oa:motivation Motivation ods:Annotation True
oa:hasBody Has Body ods:Annotation True
dcterms:created Created ods:Annotation True
dcterms:creator Creator ods:Annotation True
oa:hasTarget Has Target ods:Annotation True
oa:value Value ods:AnnotationBody True
dcterms:title Title ods:Identifier True
ods:hasAgents Has Agents ods:TombstoneMetadata True
ods:tombstoneText Tombstone Text ods:TombstoneMetadata True
ods:tombstoneDate Tombstone Date ods:TombstoneMetadata True
schema:ratingValue Rating Value ods:hasAggregateRating True
schema:ratingCount Rating Count ods:hasAggregateRating True

Open Digital Specimen

ods:Agent

Agent schema:identifier schema:name ods:hasRoles schema:email schema:url ods:hasIdentifiers
ods:Agent Class
Qualified Term Agent
Label Agent
Definition A generic agent class, containing information about the actor who performed an activity. This could be a person, an organization or a machine.
schema:identifier Property
Qualified Term schema:identifier
Label Identifier
Definition The primary unique identifier of the Agent object. All identifiers will also be added to the ods:hasIdentifiers array
Examples
  • http://www.wikidata.org/entity/Q66581882
  • https://orcid.org/0000-0002-1825-0097
  • https://hdl.handle.net/20.5000.1025/XXX-XXX-XXX
schema:name Property
Qualified Term schema:name
Label Name
Definition Full name of the agent
Examples
  • John Smith
  • Sam Leeflang
ods:hasRoles Property
Qualified Term ods:hasRoles
Label Has Roles
Definition Contains all roles associated with the agent in the context of the Digital Object. Should always contain at least one role
schema:email Property
Qualified Term schema:email
Label Email
Definition Email of the agent
Examples
  • dissco@dissco.eu
schema:url Property
Qualified Term schema:url
Label URL
Definition URL to a website of the agent
Examples
  • https://dissco.eu
ods:hasIdentifiers Property
Qualified Term ods:hasIdentifiers
Label Has Identifiers
Definition Contains all identifiers associated with the agent

ods:Annotation

Annotation dcterms:identifier ods:fdoType ods:status ods:jobID ods:version oa:motivation oa:motivatedBy oa:hasTarget oa:hasBody dcterms:creator dcterms:created dcterms:modified dcterms:issued as:generator ods:hasAggregateRating ods:batchID ods:placeInBatch ods:mergingDecisionStatus ods:mergingStateChangeDate ods:hasMergingStateChangedBy ods:hasTombstoneMetadata
ods:Annotation Class
Qualified Term Annotation
Label Annotation
Definition A new or additional piece of information about a Digital Object. The Annotation model is based on the W3C Web Annotation Data Model (https://www.w3.org/TR/annotation-model/)
dcterms:identifier Property
Qualified Term dcterms:identifier
Label Identifier
Definition The handle of the annotation. It is a unique identifier for the annotation. It is composed of the handle of the document followed by a slash and a unique identifier for the annotation.
Examples
  • https://hdl.handle.net/20.5000.1025/XXX-XXX-XXX
ods:fdoType Property
Qualified Term ods:fdoType
Label Fdo Type
Definition The DOI to the FDO type of the object
Examples
  • https://doi.org/21.T11148/bbad8c4e101e8af01115
  • https://doi.org/21.T11148/894b1e6cad57e921764e
ods:status Property
Qualified Term ods:status
Label Status
Definition The status of the Digital Object. A digital object can be in Draft, when it is not published yet. Active when it is published and the object is active and Tombstone which means the object has been archived.
ods:jobID Property
Qualified Term ods:jobID
Label Job ID
Definition Handle of the job record, if the annotation was produced by a Machine Annotation Service, only filled when annotation was created by a MAS
Examples
  • https://hdl.handle.net/20.5000.1025/XXX-XXX-XXX
ods:version Property
Qualified Term ods:version
Label Version
Definition The version of the object, each change generates a new version. The version starts at 1 and each change will increment the version number with 1
Examples
  • 1
  • 3
  • 5
oa:motivation Property
Qualified Term oa:motivation
Label Motivation
Definition The motivation for why an annotation was proposed. Based on a selection of https://www.w3.org/TR/annotation-model/#motivation-and-purpose. The motivation ods:adding and ods:deleting are added for DiSSCo's purposes.
oa:motivatedBy Property
Qualified Term oa:motivatedBy
Label Motivated By
Definition Describes the reason for the annotation
Examples
  • The country is incorrect
  • Identified a new link to a record in ENA
oa:hasTarget Property
Qualified Term oa:hasTarget
Label Has Target
Definition Indicates the particular object and part of the object on which the annotation has been made
oa:hasBody Property
Qualified Term oa:hasBody
Label Has Body
Definition The body of the annotation contains the specific value of the annotation
dcterms:creator Property
Qualified Term dcterms:creator
Label Creator
Definition Contains information about the creator of the annotation
dcterms:created Property
Qualified Term dcterms:created
Label Created
Definition The date and time when the annotation was created, following the ISO Date Time Format yyyy-MM-dd'T'HH:mm:ss.SSSXXX
Examples
  • 2023-09-02T12:31:34.806Z
dcterms:modified Property
Qualified Term dcterms:modified
Label Modified
Definition The date and time when the annotation was last modified, generating a new version. Following the ISO Date Time Format yyyy-MM-dd'T'HH:mm:ss.SSSXXX
Examples
  • 2023-10-02T12:31:34.806Z
dcterms:issued Property
Qualified Term dcterms:issued
Label Issued
Definition The date and time when the annotation was generated. Generated is here seen as when the object was stored/indexed. In most case this will be the annotation-processing-service. Following the ISO Date Time Format yyyy-MM-dd'T'HH:mm:ss.SSSXXX
Examples
  • 2023-09-02T13:31:34.806Z
as:generator Property
Qualified Term as:generator
Label Generator
Definition Object containing information on who generated the object. Generated is here seen as who stored/indexed the object. In most case this will be the annotation-processing-service. Contains an ods:Agent object.
ods:hasAggregateRating Class
Qualified Term ods:hasAggregateRating
Label Has Aggregate Rating
Definition The average rating based on multiple ratings or reviews
ods:batchID Property
Qualified Term ods:batchID
Label Batch ID
Definition Internally generated PID to identify the batch the annotation was generated by
Examples
  • 123e4567-e89b-12d3-a456-426614174000
ods:placeInBatch Property
Qualified Term ods:placeInBatch
Label Place In Batch
Definition For batching only. Links annotation to batchMetadata provided in a batch event. If present, must correspond to an ods:placeInBatch in the batch metadata
Examples
  • 1
  • 5
ods:mergingDecisionStatus Property
Qualified Term ods:mergingDecisionStatus
Label Merging Decision Status
Definition The merging status of the annotation. Only present when motivation is ods:adding or oa:editing
ods:mergingStateChangeDate Property
Qualified Term ods:mergingStateChangeDate
Label Merging State Change Date
Definition The date and time when the annotation was merging state was changed. Only present when motivation is ods:adding or oa:editing. Following the ISO Date Time Format yyyy-MM-dd'T'HH:mm:ss.SSSXXX
ods:hasMergingStateChangedBy Property
Qualified Term ods:hasMergingStateChangedBy
Label Has Merging State Changed By
Definition Object containing information on who changed the merging state of the annotation. Only present when motivation is ods:adding or oa:editing. Contains an ods:Agent object.
ods:hasTombstoneMetadata Property
Qualified Term ods:hasTombstoneMetadata
Label Has Tombstone Metadata
Definition Object containing the tombstone metadata of the object. Only present when ods:status is ods:Tombstone

ods:AnnotationBody

AnnotationBody oa:value dcterms:references ods:score
ods:AnnotationBody Class
Qualified Term AnnotationBody
Label Annotation Body
Definition Describes the body of the annotation. The body is the full content of the annotation, as provided by the agent.
oa:value Property
Qualified Term oa:value
Label Value
Definition An array of multiple values in string representation specific for the particular selector. This value could contain a string representation of a json value.
dcterms:references Property
Qualified Term dcterms:references
Label References
Definition Provides information on how the value was derived. This could be a link to a service that provided the value or a link to the source of the value.
Examples
  • https://api.gbif.org/v1/occurrence/search?occurrenceID=https://herbarium.bgbm.org/object/BW00965020&catalogNumber=B -W 00965 -02 0&basisOfRecord=PreservedSpecimen
ods:score Property
Qualified Term ods:score
Label Score
Definition A score between 0 and 1 indicating the confidence in the value. 1 is the highest confidence and 0 is the lowest.

ods:AnnotationTarget

AnnotationTarget dcterms:identifier ods:fdoType oa:hasSelector
ods:AnnotationTarget Class
Qualified Term AnnotationTarget
Label Annotation Target
Definition The AnnotationTarget describes the Digital Object the annotation is attached to, could contain additional information on which part of the object the annotation is attached to.
dcterms:identifier Property
Qualified Term dcterms:identifier
Label Identifier
Definition This is the PID of the target object. Valid targets are the Digital Specimen, Digital Media Object or another Annotation.
Examples
  • https://hdl.handle.net/20.5000.1025/XXX-XXX-XXX
  • https://doi.org/10.3535/XXX-XXX-XXX
ods:fdoType Property
Qualified Term ods:fdoType
Label Fdo Type
Definition This is the handle to the type of the target object.
Examples
  • https://doi.org/21.T11148/bbad8c4e101e8af01115
  • https://doi.org/21.T11148/894b1e6cad57e921764e
oa:hasSelector Property
Qualified Term oa:hasSelector
Label Has Selector
Definition Optional field to indicate the part of the target object that is being annotated. It can be a field, a class or a region of interest.

ods:Identifier

Identifier dcterms:title dcterms:type dcterms:identifier dcterms:format dcterms:subject ods:isPartOfLabel ods:gupriLevel ods:identifierStatus
ods:Identifier Class
Qualified Term Identifier
Label Identifier
Definition A generic Identifier class which can be attached to multiple classes. It captures information about any identifier of the class.
dcterms:title Property
Qualified Term dcterms:title
Label Title
Definition A name for the identifier
Examples
  • abcd:UnitID
  • dwc:occurrenceID
  • ORCID
  • wikidata
  • ROR
  • cetaf stable identifier
dcterms:type Property
Qualified Term dcterms:type
Label Type
Definition The type of the value in the `dcterms:identifier` field
Examples
  • DOI
dcterms:identifier Property
Qualified Term dcterms:identifier
Label Identifier
Definition The value for the identifier
Examples
  • BMNH(E)1902475
  • RGM.800315
  • https://orcid.org/0000-0002-5669-2769
  • https://www.wikidata.org/wiki/Q66581882
  • https://ror.org/00bv4cx53
dcterms:format Property
Qualified Term dcterms:format
Label Format
Definition All possible mime types of content that can be returned by identifier in case the identifier is resolvable. Plain UUIDs for example do not have a dc:format return type, as they are not resolvable on their own. For a list of MIME types see the list maintained by IANA: http://www.iana.org/assignments/media-types/index.html, in particular the text http://www.iana.org/assignments/media-types/text/ and application http://www.iana.org/assignments/media-types/application/ types. Frequently used values are text/html, text/xml, application/rdf+xml, application/json
Examples
  • ['application/json', 'text/html']
  • ['application/rdf+xml', 'application/ld+json']
dcterms:subject Property
Qualified Term dcterms:subject
Label Subject
Definition Additional keywords that the publisher may prefer to be attached to the identifier
Examples
  • ['erecolnat', 'As available on label']
  • ['Registratie nummer', 'RMNH identifier']
ods:isPartOfLabel Property
Qualified Term ods:isPartOfLabel
Label Is Part Of Label
Definition Indicates whether the identifier is part of the physical label
ods:gupriLevel Property
Qualified Term ods:gupriLevel
Label GUPRI Level
Definition Indicates whether the identifier is a persistent identifier
ods:identifierStatus Property
Qualified Term ods:identifierStatus
Label Identifier Status
Definition Indicates the status of the identifier

ods:RelatedPID

RelatedPID dcterms:identifier schema:identifier ods:relationshipType
ods:RelatedPID Class
Qualified Term RelatedPID
Label Related PID
Definition Indicates to which other Digital Object the tombstoned record is related to. This can be used when a digital object has been split or merged into other Digital Objects.
dcterms:identifier Property
Qualified Term dcterms:identifier
Label Identifier
Definition The PID of the related object, used in cases of `ods:Annotation`, `ods:DigitalMedia` and `ods:DigitalSpecimen`
Examples
  • https://doi.org/10.3535/XXX-XXX-XXX
schema:identifier Property
Qualified Term schema:identifier
Label Identifier
Definition The PID of the related object, used in cases of `ods:DataMapping`, `ods:SourceSystem` and `ods:MachineAnnotationService`
Examples
  • https://hdl.handle.net/20.5000.1025/XXX-XXX-XXX
ods:relationshipType Property
Qualified Term ods:relationshipType
Label Relationship Type
Definition The type of relationship between the tombstoned object and the related object
Examples
  • RelatedTo
  • IsDuplicateOf
  • IsReplacedWith

ods:Role

Role schema:roleName schema:startDate schema:endDate schema:position
ods:Role Class
Qualified Term Role
Label Role
Definition A role is a named entity that can be assigned to an agent. It is used to describe the function of an agent in a specific context.
schema:roleName Property
Qualified Term schema:roleName
Label Role Name
Definition The category that best matches the nature of a role of an Agent
Examples
  • collector
  • preparer
  • identifier
  • recorder
schema:startDate Property
Qualified Term schema:startDate
Label Start Date
Definition Date the agent began the role
Examples
  • 2023-10-02T12:31:34.806Z
schema:endDate Property
Qualified Term schema:endDate
Label End Date
Definition Date the agent ended the role
Examples
  • 2023-09-02T12:31:34.806Z
schema:position Property
Qualified Term schema:position
Label Position
Definition Can be used to indicate the order of importance when there are multiple agents with the same role. Lower order means higher importance.
Examples
  • 1
  • 2
  • 3

ods:TombstoneMetadata

TombstoneMetadata ods:tombstoneDate ods:tombstoneText ods:hasAgents ods:hasRelatedPIDs
ods:TombstoneMetadata Class
Qualified Term TombstoneMetadata
Label Tombstone Metadata
Definition The tombstone metadata about the tombstoned digital object, including the what, who and when of the tombstoning.
ods:tombstoneDate Property
Qualified Term ods:tombstoneDate
Label Tombstone Date
Definition Timestamp the Digital Object was tombstoned and no longer active. Following the ISO Date Time Format yyyy-MM-dd'T'HH:mm:ss.SSSXXX
Examples
  • 2021-06-01T12:00:000Z
ods:tombstoneText Property
Qualified Term ods:tombstoneText
Label Tombstone Text
Definition A reason why the Digital Object was tombstoned
Examples
  • This is a duplicate of XXX
  • This object was made by mistake
ods:hasAgents Property
Qualified Term ods:hasAgents
Label Has Agents
Definition The agent(s) who tombstoned the Digital Object, contains an ods:Agent object
ods:hasRelatedPIDs Property
Qualified Term ods:hasRelatedPIDs
Label Has Related PIDs
Definition The PIDs of the object the tombstoned object is related to

ods:hasAggregateRating

schema:ratingCount schema:ratingValue
schema:ratingCount Property
Qualified Term schema:ratingCount
Label Rating Count
Definition The count of total number of ratings
Examples
  • 3
schema:ratingValue Property
Qualified Term schema:ratingValue
Label Rating Value
Definition The rating for the content
Examples
  • 4.5