Class: ScopingProtocol¶

Protocol describing how scoping work will be conducted.

```mermaid classDiagram class ScopingProtocol click ScopingProtocol href "../ScopingProtocol/" StageProtocol <|-- ScopingProtocol click StageProtocol href "../StageProtocol/"

  ScopingProtocol : base_protocol_date

  ScopingProtocol : base_protocol_description

  ScopingProtocol : base_protocol_deviations

  ScopingProtocol : base_protocol_id

  ScopingProtocol : base_protocol_notes

  ScopingProtocol : base_protocol_software





    ScopingProtocol --> "*" ExternalTool : base_protocol_software
    click ExternalTool href "../ExternalTool/"



  ScopingProtocol : base_protocol_tools





    ScopingProtocol --> "*" ExternalTool : base_protocol_tools
    click ExternalTool href "../ExternalTool/"



  ScopingProtocol : base_protocol_training





    ScopingProtocol --> "0..1" StageTrainingInfo : base_protocol_training
    click StageTrainingInfo href "../StageTrainingInfo/"



  ScopingProtocol : base_protocol_version

  ScopingProtocol : concept_scope

  ScopingProtocol : context_scope

  ScopingProtocol : initial_review_question

  ScopingProtocol : planned_scoping_methods

  ScopingProtocol : population_scope

  ScopingProtocol : scoping_objective

  ScopingProtocol : scoping_start_criteria

  ScopingProtocol : scoping_stop_criteria

```

Inheritance¶

StageProtocol
- ScopingProtocol

Slots¶

Name	Cardinality and Range	Description	Inheritance
scoping_objective	0..1 String	Purpose of the scoping work	direct
initial_review_question	0..1 String	Initial review question before refinement	direct
population_scope	0..1 String	Initial or refined population scope	direct
concept_scope	0..1 String	Initial or refined concept, intervention, exposure, or topic scope	direct
context_scope	0..1 String	Initial or refined context or setting scope	direct
planned_scoping_methods	* String	Methods planned for scoping	direct
scoping_start_criteria	0..1 String	Criteria for starting scoping work	direct
scoping_stop_criteria	0..1 String	Criteria for ending scoping work	direct
base_protocol_id	1 String	Unique identifier for this stage protocol	StageProtocol
base_protocol_version	0..1 String	Version of the protocol	StageProtocol
base_protocol_date	0..1 Date	Date the protocol was finalized	StageProtocol
base_protocol_description	0..1 String	Detailed description of the protocol	StageProtocol
base_protocol_tools	* ExternalTool	Tools used in this stage	StageProtocol
base_protocol_software	* ExternalTool	Software packages used in this stage	StageProtocol
base_protocol_deviations	* String	Deviations from the planned protocol	StageProtocol
base_protocol_notes	0..1 String	Additional notes about the protocol	StageProtocol
base_protocol_training	0..1 StageTrainingInfo	Training provided for this stage	StageProtocol

Usages¶

used by	used in	type	used
ScopingStage	scoping_protocol	range	ScopingProtocol

Identifier and Mapping Information¶

Schema Source¶

from schema: https://open-and-sustainable.github.io/revaise-model/schema

Mappings¶

Mapping Type	Mapped Value
self	revaise:ScopingProtocol
native	revaise:ScopingProtocol

LinkML Source¶

Direct¶

name: ScopingProtocol
description: Protocol describing how scoping work will be conducted.
from_schema: https://open-and-sustainable.github.io/revaise-model/schema
is_a: StageProtocol
slots:
- scoping_objective
- initial_review_question
- population_scope
- concept_scope
- context_scope
- planned_scoping_methods
- scoping_start_criteria
- scoping_stop_criteria
slot_usage:
  planned_scoping_methods:
    name: planned_scoping_methods
    multivalued: true

Induced¶

name: ScopingProtocol
description: Protocol describing how scoping work will be conducted.
from_schema: https://open-and-sustainable.github.io/revaise-model/schema
is_a: StageProtocol
slot_usage:
  planned_scoping_methods:
    name: planned_scoping_methods
    multivalued: true
attributes:
  scoping_objective:
    name: scoping_objective
    description: Purpose of the scoping work
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema
    rank: 1000
    owner: ScopingProtocol
    domain_of:
    - ScopingProtocol
    range: string
  initial_review_question:
    name: initial_review_question
    description: Initial review question before refinement
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema
    rank: 1000
    owner: ScopingProtocol
    domain_of:
    - ScopingProtocol
    range: string
  population_scope:
    name: population_scope
    description: Initial or refined population scope
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema
    rank: 1000
    owner: ScopingProtocol
    domain_of:
    - ScopingProtocol
    range: string
  concept_scope:
    name: concept_scope
    description: Initial or refined concept, intervention, exposure, or topic scope
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema
    rank: 1000
    owner: ScopingProtocol
    domain_of:
    - ScopingProtocol
    range: string
  context_scope:
    name: context_scope
    description: Initial or refined context or setting scope
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema
    rank: 1000
    owner: ScopingProtocol
    domain_of:
    - ScopingProtocol
    range: string
  planned_scoping_methods:
    name: planned_scoping_methods
    description: Methods planned for scoping
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema
    rank: 1000
    owner: ScopingProtocol
    domain_of:
    - ScopingProtocol
    range: string
    multivalued: true
  scoping_start_criteria:
    name: scoping_start_criteria
    description: Criteria for starting scoping work
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema
    rank: 1000
    owner: ScopingProtocol
    domain_of:
    - ScopingProtocol
    range: string
  scoping_stop_criteria:
    name: scoping_stop_criteria
    description: Criteria for ending scoping work
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema
    rank: 1000
    owner: ScopingProtocol
    domain_of:
    - ScopingProtocol
    range: string
  base_protocol_id:
    name: base_protocol_id
    description: Unique identifier for this stage protocol
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema
    rank: 1000
    identifier: true
    owner: ScopingProtocol
    domain_of:
    - StageProtocol
    range: string
    required: true
  base_protocol_version:
    name: base_protocol_version
    description: Version of the protocol
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema
    rank: 1000
    owner: ScopingProtocol
    domain_of:
    - StageProtocol
    range: string
  base_protocol_date:
    name: base_protocol_date
    description: Date the protocol was finalized
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema
    rank: 1000
    owner: ScopingProtocol
    domain_of:
    - StageProtocol
    range: date
  base_protocol_description:
    name: base_protocol_description
    description: Detailed description of the protocol
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema
    rank: 1000
    owner: ScopingProtocol
    domain_of:
    - StageProtocol
    range: string
  base_protocol_tools:
    name: base_protocol_tools
    description: Tools used in this stage
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema
    rank: 1000
    owner: ScopingProtocol
    domain_of:
    - StageProtocol
    range: ExternalTool
    multivalued: true
  base_protocol_software:
    name: base_protocol_software
    description: Software packages used in this stage
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema
    rank: 1000
    owner: ScopingProtocol
    domain_of:
    - StageProtocol
    range: ExternalTool
    multivalued: true
  base_protocol_deviations:
    name: base_protocol_deviations
    description: Deviations from the planned protocol
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema
    rank: 1000
    owner: ScopingProtocol
    domain_of:
    - StageProtocol
    range: string
    multivalued: true
  base_protocol_notes:
    name: base_protocol_notes
    description: Additional notes about the protocol
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema
    rank: 1000
    owner: ScopingProtocol
    domain_of:
    - StageProtocol
    range: string
  base_protocol_training:
    name: base_protocol_training
    description: Training provided for this stage
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema
    rank: 1000
    owner: ScopingProtocol
    domain_of:
    - StageProtocol
    range: StageTrainingInfo