Skip to content

search_stage

Schema for search stage of the review workflow.

URI: https://open-and-sustainable.github.io/revaise-model/schema/stages/search

Name: search_stage

Classes

Class Description
Affiliation Institutional affiliation
AgreementMetrics Metrics for measuring agreement between reviewers/extractors
Author Author of a review or publication
        Participant A person participating in the review process
ConfidenceInterval Confidence interval specification
ConflictPattern Pattern analysis of conflicts
ConflictResolution Resolution of conflicts or disagreements between reviewers
Database Information about a database used for searching
DatasetRef External dataset reference
DateRange A simple date range representation
ExternalTool External tool or platform used in the review process
FieldAgreement Agreement metrics for a specific field or item
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
ParticipantWorkload Workload statistics for a participant
PerformanceMetrics General performance metrics
ProcessMetrics Metrics related to process efficiency and completion
Protocol Scoping and registration details of the review
QualityControl Quality control measures and checks
RegistrationTemplate A template used for registering systematic reviews, defining required and opt...
ResolutionMethodCount Count of a specific resolution method usage
ResolutionStatistics Statistics about conflict resolution
Review Root container for a systematic review
SearchQuery Search query executed against a database
SoftwareEnv Software environment configuration
StageExecution Base class for executing a specific stage of the review
        SearchStage Executing literature search strategies
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
StageProtocol Base class for protocols defining how a review stage should be conducted
        SearchProtocol Protocol defining the search strategy and approach
StageQualityControl Base class for quality control measures across review stages
        SearchQualityControl Quality control measures for the search process
StageStatistics Base class for statistics collected about review stages
        SearchStatistics Statistics about the search process
StageTrainingInfo Shared training information for review stages
TemplateField A field within a registration template
ToolParameter Configuration parameter for a tool

Slots

Slot Description
abstract Abstract or summary of the publication
access_date Date when the database was accessed for searching
accuracy Overall accuracy
address Street address of the institution
affiliations Institutional affiliations of the author
agreement_rate Agreement rate for this field
agreement_sample_size Number of items compared
area_under_curve Area under the ROC curve
assigned_items_count Number of items assigned to this participant
authors List of authors of the publication
average_items_per_day Average items processed per day
average_resolution_time Average time to resolve in minutes
backlog_size Number of items remaining
balanced_accuracy Average of sensitivity and specificity
base_agreement_metrics Base agreement metrics
base_calibration_performed Base calibration performed flag
base_completed_date Base stage completion date
base_completion_rate Base completion rate
base_discrepancy_resolutions Base discrepancy resolutions
base_double_checking_rate Base double-checking rate
base_items_completed Base items completed
base_participant_workloads Base participant workloads
base_protocol_date Base protocol date
base_protocol_description Base protocol description
base_protocol_deviations Base protocol deviations
base_protocol_id Base protocol identifier
base_protocol_notes Base protocol notes
base_protocol_software Base protocol software
base_protocol_tools Base protocol tools
base_protocol_training Base protocol training
base_protocol_version Base protocol version
base_qc_id Base QC identifier
base_qc_notes Base QC notes
base_qc_type Base QC type
base_spot_check_rate Base spot check rate
base_started_date Base stage start date
base_stats_id Base statistics identifier
base_stats_notes Base statistics notes
base_total_hours Base total hours
base_total_items Base total items
checks_performed Specific checks performed
checksum Checksum of the output file
city City where the institution is located
cohen_kappa Cohen's kappa for inter-rater agreement
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
common_causes Common causes of this conflict pattern
completed_items Number of items completed
completed_items_count Number of items completed by this participant
completion_date Date when the review was completed
completion_rate Proportion of items completed
conditional_on Field ID that this field's visibility depends on
confidence_interval Confidence interval for the agreement rate
confidence_level Confidence level (e
conflict_of_interest_declared Whether conflicts of interest were declared
conflict_type Type of conflict being resolved
conflicting_items IDs of items in conflict
conflicts_of_interest Declared conflicts of interest
containers Container images used
corrective_actions Corrective actions taken
corresponding_author Primary contact author for the review
cost Estimated cost
count Number of times this method was used
country Country where the institution is located
created_at Timestamp when the review record was created
created_date Date when the template was created
database_name Name of the database being searched
database_notes Additional notes about the database or access limitations
database_url URL to access the database
database_version Version or release of the database
databases List of databases used for literature searching
dataset_name Name of the dataset
date_restrictions Date range restrictions for searches
department Department or division within the institution
deprecation_date Date when this template will be or was deprecated
diagnostic_odds_ratio Ratio of odds of positive test in diseased vs non-diseased
disagreement_count Number of disagreements
disagreement_types Types of disagreements observed
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
expertise_areas Areas of expertise relevant to the review
f1_score Harmonic mean of precision and recall
false_discovery_rate Expected proportion of false discoveries
false_negative_rate Type II error rate
false_omission_rate Proportion of false negatives among negative calls
false_positive_rate Type I error rate
family_name Family/last name of the author
field_definitions Formal definition of template fields (e
field_identifier Identifier of the field or item
field_level_agreements Agreement metrics for individual fields
final_decision Final resolved decision or value
first_item_date Date of first item processed
fleiss_kappa Fleiss' kappa for multiple raters
format File format or MIME type
frequency How often this pattern occurs
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
grey_literature_approach Approach for searching grey literature
grey_literature_sources Number of grey literature sources
inputs Input artifacts
institution_name Name of the affiliated institution
involved_fields Fields commonly involved in this pattern
involved_participants Participants commonly involved
is_repeatable Whether this field can have multiple values
issue Issue number of the journal
issues_found Number of issues identified
issues_resolved Number of issues resolved
items_per_day Average items processed per day
items_processed_count Total items processed
journal Name of the journal or publication venue
keywords Keywords associated with the publication
kind Kind or type of stage output
krippendorff_alpha Krippendorff's alpha reliability coefficient
language_restrictions Language restrictions for searches
last_item_date Date of last item processed
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
lower_bound Lower bound of the interval
matthews_correlation Matthews correlation coefficient
median_time_per_item Median time per item in minutes
method The resolution method
most_common_conflict_type Most frequently occurring conflict type
name Full name of the author
negative_predictive_value Negative predictive value
notes Additional notes
optional_fields Fields that may be completed in this template
orcid ORCID identifier for the author
original_decisions Original conflicting decisions or values
os Operating system description
output_created_at Creation timestamp
output_label Human-readable label
outputs Output artifacts
overall_agreement Overall agreement rate across all items
pages Page numbers (e
param_category Parameter category
param_default Default value
param_description Parameter description
param_id Parameter identifier
param_name Parameter name
param_required Whether parameter is required
param_type Parameter data type
param_value Parameter value
participant_agreement_matrix Matrix showing agreement patterns between participants
participant_avg_time_per_item Average time spent per item (minutes)
participant_id Reference to the participant
participant_notes Additional notes about the participant
participant_role Role(s) of the participant in the review
pattern_id Unique identifier for this pattern
pattern_type Type of conflict pattern
peak_items_per_day Maximum items processed in a single day
peer_review_search_strategy Whether the search strategy was peer-reviewed
pending_conflicts Number of conflicts pending resolution
percent_agreement Simple percentage agreement
picos Population, Intervention, Comparison, Outcomes, Study design details
pmid PubMed identifier of the publication
precision Positive predictive value
process_avg_time_per_item Average time per item in minutes
process_total_time_hours Total time spent in hours
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_type_restrictions Publication type restrictions
publication_year Year of publication
python_version Python version
qc_id Unique identifier for this quality control check
qc_pass_rate Proportion of items passing QC
qc_performed_by Who performed the QC
qc_sample_size Size of the sample checked
qc_timestamp When QC was performed
qc_type Type of quality control performed
query_date Date and time when the query was executed
query_filters Filters applied to the search (e
query_id Unique identifier for the search query
query_notes Additional notes about the query or its execution
query_string The actual search query string or expression
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
required_fields Fields that must be completed in this template
research_question Primary research question
resolution_confidence Confidence in the resolution
resolution_duration Time taken to resolve in minutes
resolution_id Unique identifier for this resolution
resolution_method Method used to resolve the conflict
resolution_methods_used Count of each resolution method used
resolution_notes Notes about the resolution process
resolution_rate Proportion of conflicts resolved
resolution_success_rate Success rate of resolutions
resolution_timestamp When the conflict was resolved
resolved_conflicts Number of conflicts resolved
resolver Person or process that resolved the conflict
resource_uri URI locating the resource
result_collection_id Reference to the collection containing search results
result_collections Collections of literature records from searches
results_count Number of results returned by the query
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
sample_method Method used for sampling
search_completeness_assessment Assessment of search completeness
search_limits Limits applied to searches
search_protocol Protocol defining the search strategy
search_quality_control Quality control for search process
search_queries List of search queries executed against databases
search_reproducibility_check Whether search reproducibility was verified
search_statistics Statistics about the search process
search_strategy_description Detailed description of the search strategy
search_strategy_validation How the search strategy was validated
search_update_schedule Schedule for updating searches
sensitivity True positive rate (recall)
snapshot_hash Checksum of the dataset snapshot
software_env Software environment used for the review
software_environments Software environments used in the review
specificity True negative rate
stage_description Detailed description
stage_label Human-readable label
stage_outputs Outputs generated by review stages
stage_training_completion_rate Stage training completion rate
stage_training_duration_hours Stage training duration in hours
stage_training_materials_uri URI to stage training materials
stage_training_notes Stage training notes
stage_training_provided Whether stage training was provided
stage_type Type of stage executed
stages Stages of the review process
start_date Date when the review started
started_at Start time
success_rate Success rate of this method
successor_template_id ID of the template that supersedes this one
supplementary_search_methods Supplementary search methods used
template_description Description of the template and its purpose
template_doi DOI of the template publication if available
template_field_constraints Constraints on the field value
template_field_description Description of what should be entered in this field
template_field_example Example value for this field
template_field_format Expected format for the field value
template_field_help_text Help text to guide users
template_field_id Unique identifier for this template field
template_field_label Human-readable label for the field
template_field_name Technical name of the field
template_field_order Display order of the field
template_field_section Section of the template this field belongs to
template_field_type Data type of the field
template_id Unique identifier for the registration template
template_language Language of the template content
template_last_updated Date and time when the template was last updated
template_name Human-readable name of the template
template_provider Organization or registry providing the template
template_type Type of registration template
template_uri URI where the template can be accessed
template_version Version number of the template
throughput_trend Trend in processing speed
time_spent_hours Total time spent in hours
title Title of the publication
tool_ai_models AI models used by the tool
tool_api_endpoint API endpoint URL
tool_api_version API version
tool_citation Recommended citation
tool_configuration_file URI to configuration file
tool_configuration_parameters Configuration parameters
tool_cost Cost information
tool_documentation_url URL to documentation
tool_export_formats Supported export formats
tool_features_used Features of the tool that were used
tool_id Unique identifier for the tool
tool_import_formats Supported import formats
tool_license_type Type of license
tool_limitations Known limitations
tool_name Name of the tool or platform
tool_notes Additional notes
tool_purpose Purpose for which the tool was used
tool_settings Tool settings description
tool_subscription_level Subscription level or plan
tool_url URL to access the tool
tool_vendor Vendor or organization providing the tool
tool_version Version of the tool
total_comparisons Total number of comparisons made
total_conflicts Total number of conflicts identified
total_databases_searched Number of databases searched
total_items Total number of items to process
total_queries_executed Total number of search queries executed
total_records_retrieved Total records retrieved before deduplication
training_completed Training or calibration exercises completed
unique_records_after_dedup Unique records after deduplication
updated_at Timestamp when the review record was last updated
upper_bound Upper bound of the interval
validation_rules Rules for validating template field values
version Version number of the review
volume Volume number of the journal

Enumerations

Enumeration Description
ConflictType Types of conflicts that can occur
DatasetKind Types of datasets used in systematic reviews
FieldType Data types for template fields
ParameterType Data types for tool parameters
ParticipantRole Roles that participants can have in the review process
QualityControlType Types of quality control checks
ResolutionMethod Methods for resolving conflicts
ReviewStatus Status of the review
ReviewType Types of reviews
SamplingMethod Methods for sampling items for quality control
StageOutputKind Types of outputs that can be produced by review stages
StageType Logical stages of a systematic review (typical flow)
TemplateType Types of registration templates
ToolLicenseType Types of tool licenses
ToolPurpose Purposes for which tools can be used

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