Skip to content

Class: Review

Root container for a systematic review. This is the primary object that contains all review data, stages, literature records, and artifacts. Every RevAIse document should have a Review as its top-level object.

URI: revaise:Review

```mermaid classDiagram class Review click Review href "../Review/" Review : completion_date

  Review : conflicts_of_interest

  Review : corresponding_author





    Review --> "0..1" Author : corresponding_author
    click Author href "../Author/"



  Review : created_at

  Review : ethical_approval

  Review : funding_sources





    Review --> "*" FundingSource : funding_sources
    click FundingSource href "../FundingSource/"



  Review : last_updated

  Review : literature_records





    Review --> "*" LiteratureRecord : literature_records
    click LiteratureRecord href "../LiteratureRecord/"



  Review : protocol





    Review --> "0..1" Protocol : protocol
    click Protocol href "../Protocol/"



  Review : review_abstract

  Review : review_authors





    Review --> "1..*" Author : review_authors
    click Author href "../Author/"



  Review : review_country

  Review : review_id

  Review : review_keywords

  Review : review_language

  Review : review_status





    Review --> "1" ReviewStatus : review_status
    click ReviewStatus href "../ReviewStatus/"



  Review : review_title

  Review : review_type





    Review --> "1" ReviewType : review_type
    click ReviewType href "../ReviewType/"



  Review : software_env





    Review --> "0..1" SoftwareEnv : software_env
    click SoftwareEnv href "../SoftwareEnv/"



  Review : stage_outputs





    Review --> "*" StageOutput : stage_outputs
    click StageOutput href "../StageOutput/"



  Review : stages





    Review --> "*" StageExecution : stages
    click StageExecution href "../StageExecution/"



  Review : start_date

  Review : updated_at

  Review : version

```

Class Properties

Property Value
Tree Root Yes

Slots

Name Cardinality and Range Description Inheritance
review_id 1
String
Unique identifier for this review direct
review_title 1
String
Title of the systematic review direct
review_type 1
ReviewType
Type of review being conducted direct
review_abstract 0..1
String
Abstract or summary of the review direct
review_keywords *
String
Keywords or tags for the review direct
protocol 0..1
Protocol
Review protocol with registration details direct
review_authors 1..*
Author
Review authors direct
corresponding_author 0..1
Author
Corresponding author for the review direct
review_status 1
ReviewStatus
Current status of the review direct
version 0..1
String
Version of the review direct
review_language 0..1
String
Primary language of the review direct
review_country 0..1
String
Country where review is conducted direct
start_date 0..1
Date
Date review started direct
completion_date 0..1
Date
Date review completed direct
last_updated 0..1
Datetime
Last update to the review direct
created_at 0..1
Datetime
When this review record was created direct
updated_at 0..1
Datetime
When this review record was last updated direct
funding_sources *
FundingSource
Sources of funding for the review direct
conflicts_of_interest 0..1
String
Declaration of conflicts of interest direct
ethical_approval 0..1
String
Ethical approval information if applicable direct
stages *
StageExecution
Stages executed in this review direct
literature_records *
LiteratureRecord
Literature records managed in this review direct
stage_outputs *
StageOutput
Outputs and logs produced by the review stages direct
software_env 0..1
SoftwareEnv
Software environment for reproducibility direct

Identifier and Mapping Information

Schema Source

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

Mappings

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

LinkML Source

Direct

name: Review
description: Root container for a systematic review. This is the primary object that
  contains all review data, stages, literature records, and artifacts. Every RevAIse
  document should have a Review as its top-level object.
from_schema: https://open-and-sustainable.github.io/revaise-model/schema/stages/screening
slots:
- review_id
- review_title
- review_type
- review_abstract
- review_keywords
- protocol
- review_authors
- corresponding_author
- review_status
- version
- review_language
- review_country
- start_date
- completion_date
- last_updated
- created_at
- updated_at
- funding_sources
- conflicts_of_interest
- ethical_approval
- stages
- literature_records
- stage_outputs
- software_env
slot_usage:
  review_id:
    name: review_id
    description: Unique identifier for this review
    identifier: true
    required: true
  review_title:
    name: review_title
    description: Title of the systematic review
    required: true
  review_type:
    name: review_type
    description: Type of review being conducted
    range: ReviewType
    required: true
  review_abstract:
    name: review_abstract
    description: Abstract or summary of the review
    range: string
  review_keywords:
    name: review_keywords
    description: Keywords or tags for the review
    range: string
    multivalued: true
  protocol:
    name: protocol
    description: Review protocol with registration details
    range: Protocol
  review_authors:
    name: review_authors
    description: Review authors
    range: Author
    required: true
    multivalued: true
    minimum_cardinality: 1
  corresponding_author:
    name: corresponding_author
    description: Corresponding author for the review
    range: Author
  review_status:
    name: review_status
    description: Current status of the review
    range: ReviewStatus
    required: true
  version:
    name: version
    description: Version of the review
    range: string
  review_language:
    name: review_language
    description: Primary language of the review
    range: string
  review_country:
    name: review_country
    description: Country where review is conducted
    range: string
  start_date:
    name: start_date
    description: Date review started
    range: date
  completion_date:
    name: completion_date
    description: Date review completed
    range: date
  last_updated:
    name: last_updated
    description: Last update to the review
    range: datetime
  created_at:
    name: created_at
    description: When this review record was created
    range: datetime
  updated_at:
    name: updated_at
    description: When this review record was last updated
    range: datetime
  funding_sources:
    name: funding_sources
    description: Sources of funding for the review
    range: FundingSource
    multivalued: true
  conflicts_of_interest:
    name: conflicts_of_interest
    description: Declaration of conflicts of interest
    range: string
  ethical_approval:
    name: ethical_approval
    description: Ethical approval information if applicable
    range: string
  stages:
    name: stages
    description: Stages executed in this review
    range: StageExecution
    multivalued: true
  literature_records:
    name: literature_records
    description: Literature records managed in this review
    range: LiteratureRecord
    multivalued: true
  stage_outputs:
    name: stage_outputs
    description: Outputs and logs produced by the review stages
    range: StageOutput
    multivalued: true
  software_env:
    name: software_env
    description: Software environment for reproducibility
    range: SoftwareEnv
tree_root: true

Induced

name: Review
description: Root container for a systematic review. This is the primary object that
  contains all review data, stages, literature records, and artifacts. Every RevAIse
  document should have a Review as its top-level object.
from_schema: https://open-and-sustainable.github.io/revaise-model/schema/stages/screening
slot_usage:
  review_id:
    name: review_id
    description: Unique identifier for this review
    identifier: true
    required: true
  review_title:
    name: review_title
    description: Title of the systematic review
    required: true
  review_type:
    name: review_type
    description: Type of review being conducted
    range: ReviewType
    required: true
  review_abstract:
    name: review_abstract
    description: Abstract or summary of the review
    range: string
  review_keywords:
    name: review_keywords
    description: Keywords or tags for the review
    range: string
    multivalued: true
  protocol:
    name: protocol
    description: Review protocol with registration details
    range: Protocol
  review_authors:
    name: review_authors
    description: Review authors
    range: Author
    required: true
    multivalued: true
    minimum_cardinality: 1
  corresponding_author:
    name: corresponding_author
    description: Corresponding author for the review
    range: Author
  review_status:
    name: review_status
    description: Current status of the review
    range: ReviewStatus
    required: true
  version:
    name: version
    description: Version of the review
    range: string
  review_language:
    name: review_language
    description: Primary language of the review
    range: string
  review_country:
    name: review_country
    description: Country where review is conducted
    range: string
  start_date:
    name: start_date
    description: Date review started
    range: date
  completion_date:
    name: completion_date
    description: Date review completed
    range: date
  last_updated:
    name: last_updated
    description: Last update to the review
    range: datetime
  created_at:
    name: created_at
    description: When this review record was created
    range: datetime
  updated_at:
    name: updated_at
    description: When this review record was last updated
    range: datetime
  funding_sources:
    name: funding_sources
    description: Sources of funding for the review
    range: FundingSource
    multivalued: true
  conflicts_of_interest:
    name: conflicts_of_interest
    description: Declaration of conflicts of interest
    range: string
  ethical_approval:
    name: ethical_approval
    description: Ethical approval information if applicable
    range: string
  stages:
    name: stages
    description: Stages executed in this review
    range: StageExecution
    multivalued: true
  literature_records:
    name: literature_records
    description: Literature records managed in this review
    range: LiteratureRecord
    multivalued: true
  stage_outputs:
    name: stage_outputs
    description: Outputs and logs produced by the review stages
    range: StageOutput
    multivalued: true
  software_env:
    name: software_env
    description: Software environment for reproducibility
    range: SoftwareEnv
attributes:
  review_id:
    name: review_id
    description: Unique identifier for this review
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema/stages/screening
    rank: 1000
    identifier: true
    owner: Review
    domain_of:
    - Review
    range: string
    required: true
  review_title:
    name: review_title
    description: Title of the systematic review
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema/stages/screening
    rank: 1000
    owner: Review
    domain_of:
    - Review
    range: string
    required: true
  review_type:
    name: review_type
    description: Type of review being conducted
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema/stages/screening
    rank: 1000
    owner: Review
    domain_of:
    - Review
    range: ReviewType
    required: true
  review_abstract:
    name: review_abstract
    description: Abstract or summary of the review
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema/stages/screening
    rank: 1000
    owner: Review
    domain_of:
    - Review
    range: string
  review_keywords:
    name: review_keywords
    description: Keywords or tags for the review
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema/stages/screening
    rank: 1000
    owner: Review
    domain_of:
    - Review
    range: string
    multivalued: true
  protocol:
    name: protocol
    description: Review protocol with registration details
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema/stages/screening
    rank: 1000
    owner: Review
    domain_of:
    - Review
    range: Protocol
  review_authors:
    name: review_authors
    description: Review authors
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema/stages/screening
    rank: 1000
    owner: Review
    domain_of:
    - Review
    range: Author
    required: true
    multivalued: true
    minimum_cardinality: 1
  corresponding_author:
    name: corresponding_author
    description: Corresponding author for the review
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema/stages/screening
    rank: 1000
    owner: Review
    domain_of:
    - Review
    range: Author
  review_status:
    name: review_status
    description: Current status of the review
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema/stages/screening
    rank: 1000
    owner: Review
    domain_of:
    - Review
    range: ReviewStatus
    required: true
  version:
    name: version
    description: Version of the review
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema/stages/screening
    rank: 1000
    owner: Review
    domain_of:
    - Review
    range: string
  review_language:
    name: review_language
    description: Primary language of the review
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema/stages/screening
    rank: 1000
    owner: Review
    domain_of:
    - Review
    range: string
  review_country:
    name: review_country
    description: Country where review is conducted
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema/stages/screening
    rank: 1000
    owner: Review
    domain_of:
    - Review
    range: string
  start_date:
    name: start_date
    description: Date review started
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema/stages/screening
    rank: 1000
    owner: Review
    domain_of:
    - Review
    range: date
  completion_date:
    name: completion_date
    description: Date review completed
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema/stages/screening
    rank: 1000
    owner: Review
    domain_of:
    - Review
    range: date
  last_updated:
    name: last_updated
    description: Last update to the review
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema/stages/screening
    rank: 1000
    owner: Review
    domain_of:
    - Review
    range: datetime
  created_at:
    name: created_at
    description: When this review record was created
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema/stages/screening
    rank: 1000
    owner: Review
    domain_of:
    - Review
    range: datetime
  updated_at:
    name: updated_at
    description: When this review record was last updated
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema/stages/screening
    rank: 1000
    owner: Review
    domain_of:
    - Review
    range: datetime
  funding_sources:
    name: funding_sources
    description: Sources of funding for the review
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema/stages/screening
    rank: 1000
    owner: Review
    domain_of:
    - Review
    range: FundingSource
    multivalued: true
  conflicts_of_interest:
    name: conflicts_of_interest
    description: Declaration of conflicts of interest
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema/stages/screening
    rank: 1000
    owner: Review
    domain_of:
    - Review
    range: string
  ethical_approval:
    name: ethical_approval
    description: Ethical approval information if applicable
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema/stages/screening
    rank: 1000
    owner: Review
    domain_of:
    - Review
    range: string
  stages:
    name: stages
    description: Stages executed in this review
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema/stages/screening
    rank: 1000
    owner: Review
    domain_of:
    - Review
    range: StageExecution
    multivalued: true
  literature_records:
    name: literature_records
    description: Literature records managed in this review
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema/stages/screening
    rank: 1000
    owner: Review
    domain_of:
    - Review
    range: LiteratureRecord
    multivalued: true
  stage_outputs:
    name: stage_outputs
    description: Outputs and logs produced by the review stages
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema/stages/screening
    rank: 1000
    owner: Review
    domain_of:
    - Review
    range: StageOutput
    multivalued: true
  software_env:
    name: software_env
    description: Software environment for reproducibility
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema/stages/screening
    rank: 1000
    owner: Review
    domain_of:
    - Review
    range: SoftwareEnv
tree_root: true