Skip to content

Class: Contribution (Contribution)

An action or actions taken by a particular agent in the creation, modification, assessment, or deprecation of some entity (e.g. a Statement, Evidence Line, DataSet, Publication, etc.).

Comments

  • Contributions are used to organize information about when, where, how (e.g. what roles were played), and on whose behalf these actions were performed.
  • The scope of a Contribution instance includes only the actions of a single agent in contributing to a single artifact, which may be performed in one continuous effort, or several discontinuous sessions of work. The agent can be an individual person, a software agent, or a group or organization of individuals acting together.'

URI: sepio_linkml:Contribution

classDiagram class Contribution click Contribution href "../Contribution" Activity <|-- Contribution click Activity href "../Activity" Contribution : activityType Contribution --> "*" Coding : activityType click Coding href "../Coding" Contribution : alternativeLabels Contribution : contributionMadeTo Contribution --> "0..1" InformationEntity : contributionMadeTo click InformationEntity href "../InformationEntity" Contribution : contributor Contribution --> "0..1" Agent : contributor click Agent href "../Agent" Contribution : date Contribution : description Contribution : extensions Contribution --> "*" Extension : extensions click Extension href "../Extension" Contribution : id Contribution : identifiers Contribution : input Contribution --> "*" Entity : input click Entity href "../Entity" Contribution : label Contribution : output Contribution --> "*" Entity : output click Entity href "../Entity" Contribution : performedBy Contribution --> "*" Agent : performedBy click Agent href "../Agent" Contribution : specifiedBy Contribution --> "*" Method : specifiedBy click Method href "../Method" Contribution : subtype Contribution --> "0..1" Coding : subtype click Coding href "../Coding" Contribution : type

Inheritance

Slots

Direct slots

contributor --> Agent [0..1]

The Agent that made the contribution.

Implementation Guidance * Note that this must be a single agent (which can be a Person, or an Organization). If multiple Agents contributed to an entity, a separate Contribution instances MUST be created for each.

activityType --> Coding [*]

The specific type of activity performed or role played by an agent in making the contribution (e.g. for a publication, agents may contribute as a primary author, editor, figure designer, data generator, etc. . Values of this property may be framed as activities or as contribution roles (e.g. using terms from the Contribution Role Ontology (CRO)).

Implementation Guidance * Each implementation can define terms for the specific types of activities relevant to their use case/application. \n- Note that if the same Agent performed multiple types of activities in contributing to some artifact, they may all be captured in a single Contribution object. However, if data creators want to provide metadata specific to each activity (e.g. when or how each was performed), then a separate Contribution object should be created for each activity.

contributionMadeTo --> InformationEntity [0..1]

The artifact toward which the contribution was made.


Inherited slots

subtype --> Coding [0..1]

A specific type of activity the Activity instance represents.

Inherited from: Activity

Implementation Guidance * This attribute can be used to report a specific type for the Activity, in cases where a model does not define Activity subclasses for this purpose. Implementers can define their own set of data set type codes/terms, to match the needs of the domain or application.

date --> date [0..1]

The date that the Activity was completed.

Inherited from: Activity

Implementation Guidance * By convention, populate this attribute with the date the activity was completed (e.g. in cases where the activity spans multiple days). The date SHOULD be formatted as a date string in ISO format "YYYY-MM-DD".

performedBy --> Agent [*]

An Agent who participated in executing the Activity.

Inherited from: Activity

specifiedBy --> Method [*]

A method that was followed in performing an Activity, that describes how it was executed.

Inherited from: Activity

input --> Entity [*]

An entity that was input into the Activity (could be material or information)

Inherited from: Activity

output --> Entity [*]

An entity that was output from the Activity (could be material or information)

Inherited from: Activity

id --> String [1]

The 'logical' identifier of the entity in the system of record, e.g. a UUID. This 'id' is unique within a given system, but may or may not be globally unique outside the system. It is used within a system to reference one object from another.

Inherited from: Entity

Implementation Guidance * Note that it is common for implementers to create their own internal logical ids - typically a serially or randomly generated value like a UUID that is assigned to the data object as it is created in a system. But an implementer may choose to reuse an existing, globally unique id from an external system or authority for this purpose (e.g. an HGNC id for a Gene object) - as long as it is unique within the implementing system, and can be used to reference the identified object in this context.

identifiers --> String [*]

A globally-unique 'business' identifier or accession number for the real-world entity represented by a data object. These are typically assigned by an external system or authority, and used to connect entities and share content across different systems.

Inherited from: Entity

Implementation Guidance * Preferred values for this attribute are CURIEs or URIs - so the system that provisioned the identifier is clear.
* A given real world entity - e.g. a genetic variant - may have many business identifiers defined by different systems, which can be captured in the "identifiers" property to indicate that they represent the same thing.

type --> String [1]

The name of the class that is instantiated by a data object representing the Entity.

Inherited from: Entity

Implementation Guidance * MUST be the label of a concrete class from the data model.

label --> String [0..1]

A primary name for the Entity.

Inherited from: Entity

alternativeLabels --> String [*]

Alternative name(s) for the Entity.

Inherited from: Entity

description --> String [0..1]

A free text description of the Entity.

Inherited from: Entity

extensions --> Extension [*]

A list of extensions to the Entity, that allow for capture of information not directly supported by elements defined in the model.

Inherited from: Entity

Implementation Guidance * Extension objects have a key-value data structure that allows definition of custom fields in the data itself. Extensions are not expected to be natively understood, but may be used for pre-negotiated exchange of message attributes between systems.

Usages

used by used in type used
InformationEntity contributions range Contribution
Method contributions range Contribution
Document contributions range Contribution
DataItem contributions range Contribution
DataSet contributions range Contribution
Statement contributions range Contribution
StudyResult contributions range Contribution
EvidenceLine contributions range Contribution
RecordMetadata contributions range Contribution

Identifier and Mapping Information

Schema Source

  • from schema: https://w3id.org/sepio-framework/sepio-linkml

Mappings

Mapping Type Mapped Value
self sepio_linkml:Contribution
native sepio_linkml:Contribution

LinkML Source

Direct

name: Contribution
description: An action or actions taken by a particular agent in the creation, modification,
  assessment, or deprecation of some entity (e.g. a Statement, Evidence Line, DataSet,
  Publication, etc.).
title: Contribution
comments:
- Contributions are used to organize information about when, where, how (e.g. what
  roles were played), and on whose behalf these actions were performed.
- The scope of a Contribution instance includes only the actions of a single agent
  in contributing to a single artifact, which may be performed in one continuous effort,
  or several discontinuous sessions of work.  The agent can be an individual person,
  a software agent, or a group or organization of individuals acting together.'
from_schema: https://w3id.org/sepio-framework/sepio-linkml
status: Draft
is_a: Activity
attributes:
  contributor:
    name: contributor
    description: The Agent that made the contribution.
    comments:
    - Note that this must be a single agent (which can be a Person, or an Organization).  If
      multiple Agents contributed to an entity, a separate Contribution instances
      MUST be created for each.
    from_schema: https://w3id.org/sepio-model
    status: Draft
    rank: 1000
    domain_of:
    - Contribution
    range: Agent
    required: false
    multivalued: false
  activityType:
    name: activityType
    description: The specific type of activity performed or role played by an agent
      in making the contribution (e.g. for a publication, agents may contribute as
      a primary author, editor, figure designer, data generator, etc. . Values of
      this property may be framed as activities or as contribution roles (e.g. using
      terms from the Contribution Role Ontology (CRO)).
    comments:
    - Each implementation can define terms for the specific types of activities relevant
      to their use case/application. \n- Note that if the same Agent performed multiple
      types of activities in contributing to some artifact, they may all be captured
      in a single Contribution object. However, if data creators want to provide metadata
      specific to each activity (e.g. when or how each was performed), then a separate
      Contribution object should be created for each activity.
    from_schema: https://w3id.org/sepio-model
    status: Draft
    rank: 1000
    domain_of:
    - Contribution
    range: Coding
    required: false
    multivalued: true
  contributionMadeTo:
    name: contributionMadeTo
    description: The artifact toward which the contribution was made.
    from_schema: https://w3id.org/sepio-model
    status: Informative
    rank: 1000
    domain_of:
    - Contribution
    range: InformationEntity
    required: false
    multivalued: false

Induced

name: Contribution
description: An action or actions taken by a particular agent in the creation, modification,
  assessment, or deprecation of some entity (e.g. a Statement, Evidence Line, DataSet,
  Publication, etc.).
title: Contribution
comments:
- Contributions are used to organize information about when, where, how (e.g. what
  roles were played), and on whose behalf these actions were performed.
- The scope of a Contribution instance includes only the actions of a single agent
  in contributing to a single artifact, which may be performed in one continuous effort,
  or several discontinuous sessions of work.  The agent can be an individual person,
  a software agent, or a group or organization of individuals acting together.'
from_schema: https://w3id.org/sepio-framework/sepio-linkml
status: Draft
is_a: Activity
attributes:
  contributor:
    name: contributor
    description: The Agent that made the contribution.
    comments:
    - Note that this must be a single agent (which can be a Person, or an Organization).  If
      multiple Agents contributed to an entity, a separate Contribution instances
      MUST be created for each.
    from_schema: https://w3id.org/sepio-model
    status: Draft
    rank: 1000
    alias: contributor
    owner: Contribution
    domain_of:
    - Contribution
    range: Agent
    required: false
    multivalued: false
  activityType:
    name: activityType
    description: The specific type of activity performed or role played by an agent
      in making the contribution (e.g. for a publication, agents may contribute as
      a primary author, editor, figure designer, data generator, etc. . Values of
      this property may be framed as activities or as contribution roles (e.g. using
      terms from the Contribution Role Ontology (CRO)).
    comments:
    - Each implementation can define terms for the specific types of activities relevant
      to their use case/application. \n- Note that if the same Agent performed multiple
      types of activities in contributing to some artifact, they may all be captured
      in a single Contribution object. However, if data creators want to provide metadata
      specific to each activity (e.g. when or how each was performed), then a separate
      Contribution object should be created for each activity.
    from_schema: https://w3id.org/sepio-model
    status: Draft
    rank: 1000
    alias: activityType
    owner: Contribution
    domain_of:
    - Contribution
    range: Coding
    required: false
    multivalued: true
  contributionMadeTo:
    name: contributionMadeTo
    description: The artifact toward which the contribution was made.
    from_schema: https://w3id.org/sepio-model
    status: Informative
    rank: 1000
    alias: contributionMadeTo
    owner: Contribution
    domain_of:
    - Contribution
    range: InformationEntity
    required: false
    multivalued: false
  subtype:
    name: subtype
    description: A specific type of activity the Activity instance represents.
    comments:
    - This attribute can be used to report a specific type for the Activity, in cases
      where a model does not define Activity subclasses for this purpose.  Implementers
      can define their own set of data set type codes/terms, to match the needs of
      the domain or application.
    from_schema: https://w3id.org/sepio-model
    status: Informative
    alias: subtype
    owner: Contribution
    domain_of:
    - Method
    - Document
    - DataItem
    - DataSet
    - Activity
    - Agent
    - EvidenceLine
    range: Coding
    required: false
    multivalued: false
  date:
    name: date
    description: The date that the Activity was completed.
    comments:
    - By convention, populate this attribute with the date the activity was completed
      (e.g.  in cases where the activity spans multiple days). The date SHOULD be
      formatted as a date string in ISO format "YYYY-MM-DD".
    from_schema: https://w3id.org/sepio-model
    status: Draft
    rank: 1000
    alias: date
    owner: Contribution
    domain_of:
    - Activity
    range: date
    required: false
    multivalued: false
  performedBy:
    name: performedBy
    description: An Agent who participated in executing the Activity.
    from_schema: https://w3id.org/sepio-model
    status: Draft
    rank: 1000
    alias: performedBy
    owner: Contribution
    domain_of:
    - Activity
    range: Agent
    required: false
    multivalued: true
  specifiedBy:
    name: specifiedBy
    description: A method that was followed in performing an Activity, that describes
      how it was executed.
    from_schema: https://w3id.org/sepio-model
    status: Informative
    alias: specifiedBy
    owner: Contribution
    domain_of:
    - InformationEntity
    - Activity
    range: Method
    required: false
    multivalued: true
  input:
    name: input
    description: An entity that was input into the Activity (could be material or
      information)
    from_schema: https://w3id.org/sepio-model
    status: Informative
    rank: 1000
    alias: input
    owner: Contribution
    domain_of:
    - Activity
    range: Entity
    required: false
    multivalued: true
  output:
    name: output
    description: An entity that was output from the Activity (could be material or
      information)
    from_schema: https://w3id.org/sepio-model
    status: Informative
    rank: 1000
    alias: output
    owner: Contribution
    domain_of:
    - Activity
    range: Entity
    required: false
    multivalued: true
  id:
    name: id
    description: The 'logical' identifier of the entity in the system of record, e.g.
      a UUID.  This 'id' is unique within a given system, but may or may not be globally
      unique outside the system. It is used within a system to reference one object
      from another.
    comments:
    - Note that it is common for implementers to create their own internal logical
      ids - typically a serially or randomly generated value like a UUID that is assigned
      to the data object as it is created in a system. But an implementer may choose
      to reuse an existing, globally unique id from an external system or authority
      for this purpose (e.g. an HGNC id for a Gene object) - as long as it is unique
      within the implementing system, and can be used to reference the identified
      object in this context.
    from_schema: https://w3id.org/sepio-model
    status: Draft
    rank: 1000
    alias: id
    owner: Contribution
    domain_of:
    - Entity
    range: string
    required: true
    multivalued: false
  identifiers:
    name: identifiers
    description: A globally-unique 'business' identifier or accession number for the
      real-world entity represented by a data object. These are typically assigned
      by an external system or authority, and used to connect entities and share content
      across different systems.
    comments:
    - Preferred values for this attribute are CURIEs or URIs - so the system that
      provisioned the identifier is clear.
    - A given real world entity - e.g. a genetic variant - may have many business
      identifiers defined by different systems, which can be captured in the "identifiers"
      property to indicate that they represent the same thing.
    from_schema: https://w3id.org/sepio-model
    status: Informative
    rank: 1000
    alias: identifiers
    owner: Contribution
    domain_of:
    - Entity
    range: string
    required: false
    multivalued: true
  type:
    name: type
    description: The name of the class that is instantiated by a data object representing
      the Entity.
    comments:
    - MUST be the label of a concrete class from the data model.
    from_schema: https://w3id.org/sepio-model
    status: Draft
    rank: 1000
    alias: type
    owner: Contribution
    domain_of:
    - Entity
    range: string
    required: true
    multivalued: false
  label:
    name: label
    description: A primary name for the Entity.
    from_schema: https://w3id.org/sepio-model
    status: Draft
    rank: 1000
    alias: label
    owner: Contribution
    domain_of:
    - Entity
    - Coding
    range: string
    required: false
    multivalued: false
  alternativeLabels:
    name: alternativeLabels
    description: Alternative name(s) for the Entity.
    from_schema: https://w3id.org/sepio-model
    status: Draft
    rank: 1000
    alias: alternativeLabels
    owner: Contribution
    domain_of:
    - Entity
    range: string
    required: false
    multivalued: true
  description:
    name: description
    description: A free text description of the Entity.
    from_schema: https://w3id.org/sepio-model
    status: Draft
    rank: 1000
    alias: description
    owner: Contribution
    domain_of:
    - Entity
    range: string
    required: false
    multivalued: false
  extensions:
    name: extensions
    description: A list of extensions to the Entity, that allow for capture of information
      not directly supported by elements defined in the model.
    comments:
    - Extension objects have a key-value data structure that allows definition of
      custom fields in the data itself. Extensions are not expected to be natively
      understood, but may be used for pre-negotiated exchange of message attributes
      between systems.
    from_schema: https://w3id.org/sepio-model
    status: Draft
    rank: 1000
    alias: extensions
    owner: Contribution
    domain_of:
    - Entity
    range: Extension
    required: false
    multivalued: true