Source System 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:SourceSystem Source System True
Required Terms
Term Label Class Required
dcterms:title Title ods:Identifier True
dcterms:identifier Identifier ods:RelatedPID True
schema:identifier Identifier ods:SourceSystem True
ods:fdoType Fdo Type ods:SourceSystem True
schema:version Version ods:SourceSystem True
schema:dateCreated Date Created ods:SourceSystem True
schema:dateModified Date Modified ods:SourceSystem True
schema:creator Creator ods:SourceSystem True
ods:translatorType Translator Type ods:SourceSystem True
ods:dataMappingID Data Mapping ID ods:SourceSystem True
schema:url URL ods:SourceSystem True
ods:hasAgents Has Agents ods:TombstoneMetadata True
ods:tombstoneDate Tombstone Date ods:TombstoneMetadata True
ods:tombstoneText Tombstone Text ods:TombstoneMetadata 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: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.22/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:SourceSystem

SourceSystem schema:identifier ods:fdoType ods:status schema:version schema:name schema:description schema:dateCreated schema:dateModified schema:creator schema:url ltc:collectionManagementSystem ods:translatorType ods:maximumRecords ods:dataMappingID ods:hasTombstoneMetadata
ods:SourceSystem Class
Qualified Term SourceSystem
Label Source System
Definition The Source System describes the system from which the data is ingested. It contains information about the system, the endpoint and the data mapping.
schema:identifier Property
Qualified Term schema:identifier
Label Identifier
Definition The unique identifier (handle) of the Source System object
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/10.15468/1a2b3c
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.
schema:version Property
Qualified Term schema: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
  • 2
  • 3
schema:name Property
Qualified Term schema:name
Label Name
Definition Name of the Source System as provided by the user
Examples
  • Herbarium of University of Coimbra (COI)
  • Naturalis Biodiversity Center (NL) - Vermes
schema:description Property
Qualified Term schema:description
Label Description
Definition Description of the Source System as provided by the user
Examples
  • The herbarium collection of the University of Coimbra is one of the oldest in Portugal, with specimens dating back to the 18th century.
schema:dateCreated Property
Qualified Term schema:dateCreated
Label Date Created
Definition Timestamp of creation. Internally generated, https://schema.org/dateCreated
Examples
  • 2021-06-01T12:00:00.323Z
schema:dateModified Property
Qualified Term schema:dateModified
Label Date Modified
Definition Timestamp of last modification. Internally generated, follows the ISO Date Time Format yyyy-MM-dd'T'HH:mm:ss.SSSXXX
Examples
  • 2021-06-06T13:22:00.445Z
schema:creator Property
Qualified Term schema:creator
Label Creator
Definition Contains an ods:Agent object
schema:url Property
Qualified Term schema:url
Label URL
Definition Endpoint from which data may be retrieved
Examples
  • http://ipt.gbif.pt/ipt/archive.do?r=coi
ltc:collectionManagementSystem Property
Qualified Term ltc:collectionManagementSystem
Label Collection Management System
Definition The collection management system that the source system is using
Examples
  • Specify 7
ods:translatorType Property
Qualified Term ods:translatorType
Label Translator Type
Definition The serialisation of the data the endpoint provides indicating what type of Translator is required
ods:maximumRecords Property
Qualified Term ods:maximumRecords
Label Maximum Records
Definition An optional parameter to limit the number of records to be ingested from this sourceSystem, it will pick the first X number of records it encounters. If left empty or absent it will process all records.
ods:dataMappingID Property
Qualified Term ods:dataMappingID
Label Data Mapping ID
Definition The Handle of the Mapping Object needed for this Source System
Examples
  • https://hdl.handle.net/20.5000.1025/XXX-XXX-XXX
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: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 Pi Ds
Definition The PIDs of the object the tombstoned object is related to