Skip to content

Class: SpirometryProtocol

Protocol for lung function / spirometry assays. Captures spirometry standards, bronchodilator details, and plethysmography method.

URI: soma:SpirometryProtocol

 classDiagram
    class SpirometryProtocol
    click SpirometryProtocol href "../SpirometryProtocol/"
      Protocol <|-- SpirometryProtocol
        click Protocol href "../Protocol/"

      SpirometryProtocol : bronchodilator_agent

      SpirometryProtocol : bronchodilator_dose





        SpirometryProtocol --> "0..1" QuantityValue : bronchodilator_dose
        click QuantityValue href "../QuantityValue/"



      SpirometryProtocol : description

      SpirometryProtocol : equipment_required

      SpirometryProtocol : id

      SpirometryProtocol : institution

      SpirometryProtocol : last_updated

      SpirometryProtocol : name

      SpirometryProtocol : plethysmography_method

      SpirometryProtocol : protocol_author

      SpirometryProtocol : protocol_type

      SpirometryProtocol : protocol_version

      SpirometryProtocol : publication_reference

      SpirometryProtocol : quality_control_criteria

      SpirometryProtocol : replicate_requirements

      SpirometryProtocol : spirometry_standard

      SpirometryProtocol : sub_protocols





        SpirometryProtocol --> "*" Protocol : sub_protocols
        click Protocol href "../Protocol/"



      SpirometryProtocol : validation_status

Inheritance

Slots

Name Cardinality and Range Description Inheritance
spirometry_standard 0..1
String		 Spirometry standard followed (e direct
bronchodilator_agent 0..1
String		 Bronchodilator agent used (e direct
bronchodilator_dose 0..1
QuantityValue		 Dose of bronchodilator administered direct
plethysmography_method 0..1
String		 Method for plethysmography measurement direct
protocol_type 0..1
String		 The specific type of protocol Protocol
protocol_version 0..1
String		 Version of the protocol Protocol
equipment_required *
String		 Equipment required for this protocol Protocol
sub_protocols *
Protocol		 Other protocols that are part of this protocol's workflow Protocol
quality_control_criteria 0..1
String		 Quality control acceptance criteria Protocol
replicate_requirements 0..1
Integer		 Number of replicates required Protocol
protocol_author 0..1
String		 Author of the protocol Protocol
institution 0..1
String		 Institution where protocol was developed Protocol
publication_reference 0..1
String		 Reference to protocol publication Protocol
last_updated 0..1
Date		 Date protocol was last updated Protocol
validation_status 0..1
String		 Validation status of the protocol Protocol
id 1
Uriorcurie		 A unique identifier for the entity NamedThing
name 0..1
String		 A human-readable name for the entity NamedThing
description 0..1
String		 A detailed description of the entity NamedThing

Identifier and Mapping Information

Schema Source

  • from schema: https://w3id.org/EHS-Data-Standards/soma

Mappings

Mapping Type Mapped Value
self soma:SpirometryProtocol
native soma:SpirometryProtocol

LinkML Source

Direct

name: SpirometryProtocol
description: Protocol for lung function / spirometry assays. Captures spirometry standards,
  bronchodilator details, and plethysmography method.
from_schema: https://w3id.org/EHS-Data-Standards/soma
is_a: Protocol
slots:
- spirometry_standard
- bronchodilator_agent
- bronchodilator_dose
- plethysmography_method

Induced

name: SpirometryProtocol
description: Protocol for lung function / spirometry assays. Captures spirometry standards,
  bronchodilator details, and plethysmography method.
from_schema: https://w3id.org/EHS-Data-Standards/soma
is_a: Protocol
attributes:
  spirometry_standard:
    name: spirometry_standard
    description: Spirometry standard followed (e.g., ATS/ERS 2019).
    from_schema: https://w3id.org/EHS-Data-Standards/soma
    rank: 1000
    alias: spirometry_standard
    owner: SpirometryProtocol
    domain_of:
    - SpirometryProtocol
    range: string
  bronchodilator_agent:
    name: bronchodilator_agent
    description: Bronchodilator agent used (e.g., albuterol).
    from_schema: https://w3id.org/EHS-Data-Standards/soma
    rank: 1000
    alias: bronchodilator_agent
    owner: SpirometryProtocol
    domain_of:
    - SpirometryProtocol
    range: string
  bronchodilator_dose:
    name: bronchodilator_dose
    description: Dose of bronchodilator administered.
    from_schema: https://w3id.org/EHS-Data-Standards/soma
    rank: 1000
    alias: bronchodilator_dose
    owner: SpirometryProtocol
    domain_of:
    - SpirometryProtocol
    range: QuantityValue
    inlined: true
  plethysmography_method:
    name: plethysmography_method
    description: Method for plethysmography measurement.
    from_schema: https://w3id.org/EHS-Data-Standards/soma
    rank: 1000
    alias: plethysmography_method
    owner: SpirometryProtocol
    domain_of:
    - SpirometryProtocol
    range: string
  protocol_type:
    name: protocol_type
    description: The specific type of protocol. Used to designate which concrete class
      (e.g., ImagingProtocol, StainingProtocol, SpirometryProtocol, MolecularAssayProtocol)
      is instantiated for polymorphic protocol slots.
    from_schema: https://w3id.org/EHS-Data-Standards/soma
    rank: 1000
    designates_type: true
    alias: protocol_type
    owner: SpirometryProtocol
    domain_of:
    - Protocol
    range: string
  protocol_version:
    name: protocol_version
    description: Version of the protocol.
    from_schema: https://w3id.org/EHS-Data-Standards/soma
    rank: 1000
    alias: protocol_version
    owner: SpirometryProtocol
    domain_of:
    - Protocol
    range: string
  equipment_required:
    name: equipment_required
    description: Equipment required for this protocol.
    from_schema: https://w3id.org/EHS-Data-Standards/soma
    rank: 1000
    alias: equipment_required
    owner: SpirometryProtocol
    domain_of:
    - Protocol
    range: string
    multivalued: true
  sub_protocols:
    name: sub_protocols
    description: Other protocols that are part of this protocol's workflow. Use this
      to compose protocols from reusable steps (e.g., sample preparation, wash steps,
      fixation, post-processing). Any Protocol or Protocol subclass is valid.
    from_schema: https://w3id.org/EHS-Data-Standards/soma
    rank: 1000
    alias: sub_protocols
    owner: SpirometryProtocol
    domain_of:
    - Protocol
    range: Protocol
    multivalued: true
    inlined: true
    inlined_as_list: true
  quality_control_criteria:
    name: quality_control_criteria
    description: Quality control acceptance criteria.
    from_schema: https://w3id.org/EHS-Data-Standards/soma
    rank: 1000
    alias: quality_control_criteria
    owner: SpirometryProtocol
    domain_of:
    - Protocol
    range: string
  replicate_requirements:
    name: replicate_requirements
    description: Number of replicates required.
    from_schema: https://w3id.org/EHS-Data-Standards/soma
    rank: 1000
    alias: replicate_requirements
    owner: SpirometryProtocol
    domain_of:
    - Protocol
    range: integer
  protocol_author:
    name: protocol_author
    description: Author of the protocol.
    from_schema: https://w3id.org/EHS-Data-Standards/soma
    rank: 1000
    alias: protocol_author
    owner: SpirometryProtocol
    domain_of:
    - Protocol
    range: string
  institution:
    name: institution
    description: Institution where protocol was developed.
    from_schema: https://w3id.org/EHS-Data-Standards/soma
    rank: 1000
    alias: institution
    owner: SpirometryProtocol
    domain_of:
    - Protocol
    range: string
  publication_reference:
    name: publication_reference
    description: Reference to protocol publication.
    from_schema: https://w3id.org/EHS-Data-Standards/soma
    rank: 1000
    alias: publication_reference
    owner: SpirometryProtocol
    domain_of:
    - Protocol
    range: string
  last_updated:
    name: last_updated
    description: Date protocol was last updated.
    from_schema: https://w3id.org/EHS-Data-Standards/soma
    rank: 1000
    alias: last_updated
    owner: SpirometryProtocol
    domain_of:
    - Protocol
    range: date
  validation_status:
    name: validation_status
    description: Validation status of the protocol.
    from_schema: https://w3id.org/EHS-Data-Standards/soma
    rank: 1000
    alias: validation_status
    owner: SpirometryProtocol
    domain_of:
    - Protocol
    range: string
  id:
    name: id
    description: A unique identifier for the entity.
    from_schema: https://w3id.org/EHS-Data-Standards/soma
    rank: 1000
    identifier: true
    alias: id
    owner: SpirometryProtocol
    domain_of:
    - NamedThing
    - Unit
    - NamedEntity
    range: uriorcurie
    required: true
  name:
    name: name
    description: A human-readable name for the entity.
    from_schema: https://w3id.org/EHS-Data-Standards/soma
    rank: 1000
    slot_uri: schema:name
    alias: name
    owner: SpirometryProtocol
    domain_of:
    - NamedThing
    - Unit
    - NamedEntity
    range: string
  description:
    name: description
    description: A detailed description of the entity.
    from_schema: https://w3id.org/EHS-Data-Standards/soma
    rank: 1000
    slot_uri: schema:description
    alias: description
    owner: SpirometryProtocol
    domain_of:
    - NamedThing
    range: string