Skip to content

revaise_review

Core review object with essential metadata and characteristics.

URI: https://open-and-sustainable.github.io/revaise-model/schema/objects/review

Name: revaise_review

Classes

Class Description
Affiliation Institutional affiliation
Author Author of a review or publication
DatasetRef External dataset reference
DateRange A simple date range representation
FundingSource Source of funding for the review
LiteratureRecord A literature record representing a publication that persists across review st...
LiteratureRecordCollection A collection of literature records
Protocol Scoping and registration details of the review
Review Root container for a systematic review
SoftwareEnv Software environment configuration
StageExecution Base class for executing a specific stage of the review
StageOutput Output file or log produced by a review stage (results, logs, code, visualiza...
StageOutputRef Reference to a stage output in this or another RevAIse bundle

Slots

Slot Description
abstract Abstract or summary of the publication
address Street address of the institution
affiliations Institutional affiliations of the author
authors List of authors of the publication
checksum Checksum of the output file
city City where the institution is located
collection_created_at Timestamp when the collection was created
collection_description Description of the collection's purpose or contents
collection_id Unique identifier for the collection containing this record
collection_name Name of the collection containing this record
completion_date Date when the review was completed
conflicts_of_interest Declared conflicts of interest
containers Container images used
corresponding_author Primary contact author for the review
cost Estimated cost
country Country where the institution is located
created_at Timestamp when the review record was created
dataset_name Name of the dataset
department Department or division within the institution
doi Digital Object Identifier of the publication
eligibility_criteria Inclusion and exclusion criteria
email Email address of the author
ended_at End time
ethical_approval Ethical approval information if applicable
family_name Family/last name of the author
format File format or MIME type
full_text_url URL to access the full text of the publication
funder_id Unique identifier for the funding organization
funder_name Name of the funding organization
funding_sources Sources of funding for the review
given_name Given/first name of the author
grant_number Grant or award number from the funder
inputs Input artifacts
institution_name Name of the affiliated institution
issue Issue number of the journal
journal Name of the journal or publication venue
keywords Keywords associated with the publication
kind Kind or type of stage output
last_updated Timestamp of last update to the review
license License governing the dataset
literature_records Literature records associated with this review
lockfiles Environment lockfiles
name Full name of the author
notes Additional notes
orcid ORCID identifier for the author
os Operating system description
output_created_at Creation timestamp
output_label Human-readable label
outputs Output artifacts
pages Page numbers (e
picos Population, Intervention, Comparison, Outcomes, Study design details
pmid PubMed identifier of the publication
protocol Protocol information for the review
protocol_start_date Protocol registration date
publication_language Language of the publication
publication_type Type of publication (e
publication_year Year of publication
python_version Python version
r_version R version
range_description Description of a date range
range_end End of a date range
range_start Start of a date range
record_count Number of records in the collection
record_created_at Timestamp when the record was created in the system
record_id Unique identifier for the literature record
record_updated_at Timestamp when the record was last updated
records List of literature records in the collection
registration_id Identifier assigned by the registry
registration_url URL to the registry entry
registry Registry where the protocol is recorded
research_question Primary research question
resource_uri URI locating the resource
review_abstract Abstract or summary of the review
review_artifacts Artifacts and quality assurance documents
review_authors Authors involved in the review
review_country Country where the review is conducted
review_id Unique identifier for the systematic review
review_keywords Keywords describing the review topic
review_language Primary language of the review
review_metadata Additional metadata about the review
review_question Primary research question addressed by the review
review_status Current status of the review
review_title Title of the systematic review
review_type Type of review (systematic review, scoping review, etc
ror_id Research Organization Registry identifier for the institution
snapshot_hash Checksum of the dataset snapshot
software_env Software environment used for the review
software_environments Software environments used in the review
stage_description Detailed description
stage_label Human-readable label
stage_outputs Outputs generated by review stages
stage_type Type of stage executed
stages Stages of the review process
start_date Date when the review started
started_at Start time
title Title of the publication
updated_at Timestamp when the review record was last updated
version Version number of the review
volume Volume number of the journal

Enumerations

Enumeration Description
DatasetKind Types of datasets used in systematic reviews
ReviewStatus Status of the review
ReviewType Types of reviews
StageOutputKind Types of outputs that can be produced by review stages
StageType Logical stages of a systematic review (typical flow)

Types

Type Description
Boolean A binary (true or false) value
Curie a compact URI
Date a date (year, month and day) in an idealized calendar
DateOrDatetime Either a date or a datetime
Datetime The combination of a date and time
Decimal A real number with arbitrary precision that conforms to the xsd:decimal speci...
Double A real number that conforms to the xsd:double specification
Float A real number that conforms to the xsd:float specification
Integer An integer
Jsonpath A string encoding a JSON Path
Jsonpointer A string encoding a JSON Pointer
Ncname Prefix part of CURIE
Nodeidentifier A URI, CURIE or BNODE that represents a node in a model
Objectidentifier A URI or CURIE that represents an object in the model
Sparqlpath A string encoding a SPARQL Property Path
String A character string
Time A time object represents a (local) time of day, independent of any particular...
Uri a complete URI
Uriorcurie a URI or a CURIE

Subsets

Subset Description