Class: Sample event (SampleEvent)

Realisation of a study event which contains time relevant information.

 classDiagram
    class SampleEvent
    click SampleEvent href "../SampleEvent/"
      SampleEvent : additional_information

      SampleEvent : collection_relative_time_point_event_label

      SampleEvent : collection_relative_time_point_unit





        SampleEvent --> "0..1" TimeUnits : collection_relative_time_point_unit
        click TimeUnits href "../TimeUnits/"



      SampleEvent : collection_relative_time_point_value

      SampleEvent : sample_collection_method

      SampleEvent : sample_event_id

Slots

Name	Cardinality and Range	Description	Inheritance
sample_event_id	1 String	A sample ID to associate the subjects with a sample event	direct
sample_collection_method	0..1 recommended String	The method used to collect the sample (e	direct
collection_relative_time_point_event_label	1 String	The baseline event relative to which the time point is measured	direct
collection_relative_time_point_value	0..1 Integer	The numeric value of the collection time point relative to the baseline event	direct
collection_relative_time_point_unit	0..1 TimeUnits	The unit of the collection time point relative to the baseline event	direct
additional_information	0..1 String	Additional information related to this object	direct

Usages

used by	used in	type	used
SampleEventCollection	sample_event_entries	range	SampleEvent

Identifier and Mapping Information

Schema Source

from schema: https://codebase.helmholtz.cloud/nfdi4immuno/portal-infra/metadata_schema

Mappings

Mapping Type	Mapped Value
self	nfdi4immuno:SampleEvent
native	nfdi4immuno:SampleEvent

LinkML Source

Direct

name: SampleEvent
description: Realisation of a study event which contains time relevant information.
title: Sample event
from_schema: https://codebase.helmholtz.cloud/nfdi4immuno/portal-infra/metadata_schema
slots:
- sample_event_id
- sample_collection_method
- collection_relative_time_point_event_label
- collection_relative_time_point_value
- collection_relative_time_point_unit
- additional_information

Induced

name: SampleEvent
description: Realisation of a study event which contains time relevant information.
title: Sample event
from_schema: https://codebase.helmholtz.cloud/nfdi4immuno/portal-infra/metadata_schema
attributes:
  sample_event_id:
    name: sample_event_id
    description: 'A sample ID to associate the subjects with a sample event.

      '
    title: SampleEvent ID
    from_schema: https://codebase.helmholtz.cloud/nfdi4immuno/portal-infra/metadata_schema
    rank: 1000
    is_a: abstract_id
    identifier: true
    alias: sample_event_id
    owner: SampleEvent
    domain_of:
    - SampleEventCollection
    - SampleEvent
    - Sample
    range: string
    required: true
    pattern: ^.+$
  sample_collection_method:
    name: sample_collection_method
    description: The method used to collect the sample (e.g. fine-needle aspirate,
      organ harvest, venous puncture).
    title: Sample collection method
    examples:
    - value: Peripheral venous puncture
    from_schema: https://codebase.helmholtz.cloud/nfdi4immuno/portal-infra/metadata_schema
    rank: 1000
    alias: sample_collection_method
    owner: SampleEvent
    domain_of:
    - SampleEvent
    range: string
    recommended: true
  collection_relative_time_point_event_label:
    name: collection_relative_time_point_event_label
    description: The baseline event relative to which the time point is measured.
    title: Reference point
    examples:
    - value: Primary vaccination
    from_schema: https://codebase.helmholtz.cloud/nfdi4immuno/portal-infra/metadata_schema
    rank: 1000
    alias: collection_relative_time_point_event_label
    owner: SampleEvent
    domain_of:
    - SampleEvent
    range: string
    required: true
    pattern: ^.+$
  collection_relative_time_point_value:
    name: collection_relative_time_point_value
    description: The numeric value of the collection time point relative to the baseline
      event.
    title: Time since reference point
    examples:
    - value: '14'
    from_schema: https://codebase.helmholtz.cloud/nfdi4immuno/portal-infra/metadata_schema
    rank: 1000
    alias: collection_relative_time_point_value
    owner: SampleEvent
    domain_of:
    - SampleEvent
    range: integer
  collection_relative_time_point_unit:
    name: collection_relative_time_point_unit
    description: The unit of the collection time point relative to the baseline event.
    title: Time unit
    examples:
    - value: day
    from_schema: https://codebase.helmholtz.cloud/nfdi4immuno/portal-infra/metadata_schema
    rank: 1000
    alias: collection_relative_time_point_unit
    owner: SampleEvent
    domain_of:
    - SampleEvent
    range: TimeUnits
  additional_information:
    name: additional_information
    annotations:
      preferred_format:
        tag: preferred_format
        value: json
    description: 'Additional information related to this object. Can be in any format,
      but JSON key-value pairs are preferred.

      '
    title: Additional information
    from_schema: https://codebase.helmholtz.cloud/nfdi4immuno/portal-infra/metadata_schema
    rank: 1000
    alias: additional_information
    owner: SampleEvent
    domain_of:
    - SampleEvent
    - Sample
    - Study
    - AbstractSubject
    range: string