Virtual Collection 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:Agent Agent True
ods:Identifier Identifier True
ods:VirtualCollection Virtual Collection True
Required Terms
Term Label Class Required
dwc:relatedResourceID Related Resource ID ods:EntityRelationship True
dwc:relationshipOfResource Relationship Of Resource ods:EntityRelationship True
ods:predicateType Predicate Type ods:Identifier True
ods:hasAgents Has Agents ods:TombstoneMetadata True
ods:tombstoneText Tombstone Text ods:TombstoneMetadata True
ods:tombstoneDate Tombstone Date ods:TombstoneMetadata True
ltc:collectionName Collection Name ods:VirtualCollection True
schema:version Version ods:VirtualCollection True
ods:status Status ods:VirtualCollection True
ods:fdoType Fdo Type ods:VirtualCollection True
dcterms:identifier Identifier ods:VirtualCollection True
schema:dateCreated Date Created ods:VirtualCollection True
schema:creator Creator ods:VirtualCollection True
ods:hasTargetDigitalObjectFilter Has Target Digital Object Filter ods:VirtualCollection True
ltc:basisOfScheme Basis Of Scheme ods:VirtualCollection 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:EntityRelationship

EntityRelationship dwc:relationshipOfResource dwc:relationshipOfResourceID dwc:relatedResourceID ods:relatedResourceURI dwc:relationshipEstablishedDate dwc:relationshipRemarks ods:hasAgents
ods:EntityRelationship Class
Qualified Term EntityRelationship
Label Entity Relationship
Definition Describes relationships between digital object and any external resources. An example could be a relationship to the Sequence record of the specimen in a DNA database.
dwc:relationshipOfResource Property
Qualified Term dwc:relationshipOfResource
Label Relationship Of Resource
Definition The relationship of the subject (identified by dwc:resourceID) to the object (identified by dwc:relatedResourceID)
Examples
  • hasGBIFID
  • hasCOLID
  • hasCollectorID
dwc:relationshipOfResourceID Property
Qualified Term dwc:relationshipOfResourceID
Label Relationship Of Resource ID
Definition An identifier for the relationship type (predicate) that connects the subject identified by dwc:resourceID to its object identified by dwc:relatedResourceID
Examples
  • https://purl.obolibrary.org/obo/RO_0002456
dwc:relatedResourceID Property
Qualified Term dwc:relatedResourceID
Label Related Resource ID
Definition An identifier for a related resource (the object, rather than the subject of the relationship)
Examples
  • 3024470157
  • 5TXLM
  • 00bv4cx53
ods:relatedResourceURI Property
Qualified Term ods:relatedResourceURI
Label Related Resource URI
Definition The full resolvable URI to the related resource
Examples
  • https://www.gbif.org/occurrence/3024470157
  • https://ror.org/00bv4cx53
  • https://www.catalogueoflife.org/data/taxon/5TXLM
dwc:relationshipEstablishedDate Property
Qualified Term dwc:relationshipEstablishedDate
Label Relationship Established Date
Definition The date-time on which the relationship between the two resources was established, following the ISO Date Time Format yyyy-MM-dd'T'HH:mm:ss.SSSXXX
Examples
  • 2024-05-30T09:46:20.120Z
  • 2024-10-10T12:12:21.310Z
dwc:relationshipRemarks Property
Qualified Term dwc:relationshipRemarks
Label Relationship Remarks
Definition Comments or notes about the relationship between the two resources
Examples
  • Mother and offspring collected from the same nest
ods:hasAgents Property
Qualified Term ods:hasAgents
Label Has Agents
Definition The agent(s) who created the entityRelationship, contains an ods:Agent object

ods:Identifier

Identifier ods:predicateType ods:predicateKey ods:predicateValue ods:predicateValues ods:hasPredicates
ods:Identifier Class
Qualified Term Identifier
Label Identifier
Definition A generic class indicating to which cross-section of the Digital Objects this object applies to.
ods:predicateType Property
Qualified Term ods:predicateType
Label Predicate Type
Definition The type of the filter, which can be one of the following: equals, and, or, not. This is used to indicate how the filter should be applied to the Digital Object.
ods:predicateKey Property
Qualified Term ods:predicateKey
Label Predicate Key
Definition The propertyName of the Digital Object to filter on. This should be the full path
Examples
  • $[ods:id]
  • $['ods:topicDiscipline']
  • $['ods:hasEvents'][*]['dwc:year']
ods:predicateValue Property
Qualified Term ods:predicateValue
Label Predicate Value
Definition Contains a single value that the Digital Object property should match.
Examples
  • https://doi.org/10.3535/DY5-8NC-L2A
  • Zoology
ods:predicateValues Property
Qualified Term ods:predicateValues
Label Predicate Values
Definition Contains a list of values that the Digital Object property should match. This is together with the predicateType 'in'.
ods:hasPredicates Property
Qualified Term ods:hasPredicates
Label Has Predicates
Definition A list of sub-filters that can be used to filter on multiple properties or values. This is used to create more complex filters.

ods:Predicate

Predicate ods:predicateType ods:predicateKey ods:predicateValue ods:predicateValues
ods:Predicate Class
Qualified Term Predicate
Label Predicate
Definition Describes a predicate that can be used to filter the target Digital Objects this object applies to.
ods:predicateType Property
Qualified Term ods:predicateType
Label Predicate Type
Definition The type of the filter, which can be one of the following: equals, and, or, not. This is used to indicate how the filter should be applied to the Digital Object.
ods:predicateKey Property
Qualified Term ods:predicateKey
Label Predicate Key
Definition The propertyName of the Digital Object to filter on. This should be the full path
Examples
  • $[ods:id]
  • $['ods:topicDiscipline']
ods:predicateValue Property
Qualified Term ods:predicateValue
Label Predicate Value
Definition A list of values that
Examples
  • https://doi.org/10.3535/DY5-8NC-L2A
  • Zoology
ods:predicateValues Property
Qualified Term ods:predicateValues
Label Predicate Values
Definition -1

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 Pi Ds
Definition The PIDs of the object the tombstoned object is related to

ods:VirtualCollection

VirtualCollection dcterms:identifier ods:fdoType ods:status schema:version ltc:collectionName ltc:description ltc:basisOfScheme schema:dateCreated schema:dateModified schema:contentURL schema:creator ods:hasTargetDigitalObjectFilter ods:significanceForCountries ods:hasEntityRelationships ods:hasTombstoneMetadata
ods:VirtualCollection Class
Qualified Term VirtualCollection
Label Virtual Collection
Definition The Virtual Collection class represents a collection of digital objects that are grouped together based on a common theme or purpose.
dcterms:identifier Property
Qualified Term dcterms:identifier
Label Identifier
Definition PID of the object.
Examples
  • https://hdl.handle.net/20.5000.1025/XXX-XXX-XXX
ods:fdoType Property
Qualified Term ods:fdoType
Label Fdo Type
Definition The Handle to the FDO type of the object
Examples
  • https://hdl.handle.net/21.T11148/2ac65a933b7a0361b651
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
ltc:collectionName Property
Qualified Term ltc:collectionName
Label Collection Name
Definition A short title that summarizes the collection objects contained in the virtual collection.
Examples
  • Bumblebee Collection of South Holland
ltc:description Property
Qualified Term ltc:description
Label Description
Definition A description or narrative about the collection.
Examples
  • A virtual reference collection including key bumblebee specimens
ltc:basisOfScheme Property
Qualified Term ltc:basisOfScheme
Label Basis Of Scheme
Definition This property is intended to summarise the reason for grouping a number of objects together.
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:contentURL Property
Qualified Term schema:contentURL
Label Content URL
Definition URI for a media item that is representative for the virtual collection
Examples
  • https://image.bgbm.org/images/internal/HerbarThumbs/B100272813_1700
  • https://medialib.naturalis.nl/file/id/RGM.924559/format/large
schema:creator Property
Qualified Term schema:creator
Label Creator
Definition Contains an ods:Agent object
ods:hasTargetDigitalObjectFilter Property
Qualified Term ods:hasTargetDigitalObjectFilter
Label Has Target Digital Object Filter
Definition Contains the filters that the collection uses
ods:significanceForCountries Property
Qualified Term ods:significanceForCountries
Label Significance For Countries
Definition Contains all countries for which the virtual collection has significance, when empty or absent it signals that significance is not limited to specific countries. A controlled value list will be used.
ods:hasEntityRelationships Property
Qualified Term ods:hasEntityRelationships
Label Has Entity Relationships
Definition Contains relationships to external resources that provide further information about the virtual collection, for example references to non-DiSSCo specimens or publications
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