Create Update Tombstone Event Quick Reference Guide

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
Required Terms

Open Digital Specimen

ods:Agent

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:CreateUpdateTombstoneEvent

ods:CreateUpdateTombstoneEvent Class
Qualified Term CreateUpdateTombstoneEvent
Label Create Update Tombstone Event
Definition An provenance event describing any change that has been made to a Digital Object, this could be the creation, modification or tombstoning of an object. Model is based on the W3C PROV Data Model (https://www.w3.org/TR/prov-o/)
dcterms:identifier Property
Qualified Term dcterms:identifier
Label Identifier
Definition The unique identifier of the Create Update Tombstone Event, this includes the version of the object
Examples
  • https://hdl.handle.net/20.5000.1025/XXX-XXX-XXX/3
  • https://doi.org/TEST/PGD-QGK-S0R/1
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
prov:Activity Class
Qualified Term prov:Activity
Label Activity
Definition This class described the activity that was performed on the Digital Object, Based on the prov-ontology Activity Class
prov:Entity Class
Qualified Term prov:Entity
Label Entity
Definition The Digital Object on which the Activity took place, the resulting Digital Object is stored as the `prov:value`
ods:hasAgents Property
Qualified Term ods:hasAgents
Label Has Agents
Definition Contains zero or more prov:Agent objects, connected based on the identifier with the `prov:Activity`

ods:Identifier

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:Role

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:prov:Activity

prov:wasAssociatedWith Property
Qualified Term prov:wasAssociatedWith
Label Was Associated With
Definition Contains a reference to zero or more prov:Agent objects that were associated with the Activity
prov:endedAtTime Property
Qualified Term prov:endedAtTime
Label Ended At Time
Definition The date and time when the activity ended. This is also the moment the CreateUpdateTombstone Event is created, following the ISO Date Time Format yyyy-MM-dd'T'HH:mm:ss.SSSXXX
Examples
  • 2024-06-11T09:14:00.233Z
  • 2022-04-23T12:13:00.789Z
prov:used Property
Qualified Term prov:used
Label Used
Definition The unique identifier of the Digital Object that was the object of the Activity (as indicated at @id in the Activity Class)
Examples
  • https://hdl.handle.net/20.5000.1025/XXX-XXX-XXX/1
  • https://doi.org/10.15468/1a2b3c/3
rdfs:comment Property
Qualified Term rdfs:comment
Label Comment
Definition A comment about the activity
Examples
  • Digital Specimen was updated by user XXX at 2024-02-23T15:12:00.131Z
  • Annotation was created by user YYY at 2021-06-01T12:00:00.111Z
ods:changeValue Property
Qualified Term ods:changeValue
Label Change Value
Definition The json patch object that describes the changes made to the object as opposed to the previous version, empty if this is a ods:Create
Examples
  • [{'op': 'add', 'path': '/ods:attributes/dwc:collectionId', 'value': 'Herbarium Berolinense'}, {'op': 'copy', 'path': '/ods:attributes/dwc:identification/0/taxonIdentifications/0/dwc:infragenericEpithet', 'from': '/ods:attributes/dwc:identification/0/taxonIdentifications/0/dwc:specificEpithet'}]

ods:prov:Entity

prov:value Property
Qualified Term prov:value
Label Value
Definition The full object that is the result of the prov:Activity, the structure of this object is defined by the `@type` field.
Examples
  • {'@id': 'https://hdl.handle.net/20.5000.1025/ABC-DEF-GHI', '@type': 'ods:Mapping', 'schema:identifier': 'https://hdl.handle.net/20.5000.1025/ABC-DEF-GHI', 'ods:fdoType': 'https://doi.org/10.15468/1a2b3c', 'schema:version': 1, 'schema:name': 'Default Mapping for Herbarium of University of Coimbra (COI)', 'schema:description': 'The default mapping for the Herbarium of the University of Coimbra (COI) to the Darwin Core standard.', 'schema:dateCreated': '2021-06-01T12:00:00.111Z', 'schema:creator': {'@id': 'https://orcid.org/0000-0002-5669-2769', '@type': 'schema:Person', 'schema:name': 'John Doe'}, 'ods:Mapping': {'ods:DefaultMapping': [{'ods:physicalSpecimenIDType': 'Global'}, {'ods:fdoType': 'ZoologyVertebrateSpecimen'}, {'ods:organisationId': 'https://ror.org/05xg72x27'}], 'ods:FieldMapping': [{'ods:physicalSpecimenId': 'dwc:catalogNumber'}]}, 'ods:mappingDataStandard': 'dwc'}
prov:wasRevisionOf Property
Qualified Term prov:wasRevisionOf
Label Was Revision Of
Definition The unique identifier (handle) of the previous version of the object, only present when prov:Activity is of type ods:Update and ods:Tombstone
Examples
  • https://hdl.handle.net/20.5000.1025/XXX-XXX-XXX/1
prov:wasGeneratedBy Property
Qualified Term prov:wasGeneratedBy
Label Was Generated By
Definition The unique identifier of the prov:Activity that generated the Entity (as indicated at @id in the Activity Class), http://www.w3.org/ns/prov#wasGeneratedBy
Examples
  • 7ba628d4-2e28-4ce4-ad1e-e99c97c20507
  • 807f145c-11a1-41f0-af34-b2d7c580bcc1