Skip to content

revaise_scoping

Optional scoping stage for early review planning, feasibility assessment, and review question refinement.

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

Name: revaise_scoping

Classes

Class Description
Affiliation Institutional affiliation
AgreementMetrics Metrics for measuring agreement between reviewers/extractors
AIAssistance Configuration for AI assistance in any review stage
AIParameter AI model parameter configuration
AIPrompt Prompt configuration for AI interaction
AISession Session details for AI-assisted work
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
DatasetRef External dataset reference
DateRange A simple date range representation
ExploratorySearch Exploratory search used to test or refine the review scope
ExternalTool External tool or platform used in the review process
FeasibilityAssessment Feasibility assessment for the proposed review scope
FieldAgreement Agreement metrics for a specific field or item
HumanModification Record of human modification to AI output
ParticipantWorkload Workload statistics for a participant
PerformanceMetrics General performance metrics
        AIPerformanceMetrics Performance metrics for AI assistance, extending general performance metrics ...
ProcessMetrics Metrics related to process efficiency and completion
QualityControl Quality control measures and checks
ResolutionMethodCount Count of a specific resolution method usage
ResolutionStatistics Statistics about conflict resolution
ReviewQuestionCandidate Candidate review question considered during scoping
ScopingDecision Decision made during scoping
StageExecution Base class for executing a specific stage of the review
        ScopingStage Optional stage documenting exploratory work before or alongside protocol fina...
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
        ScopingProtocol Protocol describing how scoping work will be conducted
StageQualityControl Base class for quality control measures across review stages
        ScopingQualityControl Quality control measures for scoping
StageStatistics Base class for statistics collected about review stages
        ScopingStatistics Summary statistics for scoping
StageTrainingInfo Shared training information for review stages
StakeholderInput Input that informed scoping decisions
ToolParameter Configuration parameter for a tool

Slots

Slot Description
accuracy Overall accuracy
address Street address of the institution
affected_protocol_sections Protocol sections affected by the decision
affiliations Institutional affiliations of the author
agreement_rate Agreement rate for this field
agreement_sample_size Number of items compared
ai_assistance_config AI assistance configuration for a review stage
ai_confidence_threshold Minimum confidence score for accepting AI outputs
ai_config_id Reference to the AIAssistance configuration used
ai_error_handling Strategy for handling AI errors or failures
ai_id Unique identifier for AI assistance configuration
ai_model Name of the AI model
ai_parameters Model parameters and settings
ai_performance_metrics Performance metrics for the AI assistance
ai_prompts Prompts used to interact with the AI
ai_provider AI service provider
ai_purpose Purposes for which AI is used
ai_session_id Unique identifier for AI session
ai_training_description Description of training data or fine-tuning
ai_validation_rules Rules for validating AI outputs
ai_version Version of the AI model
api_calls Number of API calls made
area_under_curve Area under the ROC curve
assigned_items_count Number of items assigned to this participant
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
candidate_comparator Comparator component of the candidate question
candidate_context Context or setting component of the candidate question
candidate_intervention_or_exposure Intervention, exposure, or concept component of the candidate question
candidate_outcomes Outcome components of the candidate question
candidate_population Population component of the candidate question
candidate_questions_count Number of candidate questions considered
candidate_rationale Rationale for accepting, rejecting, or refining a candidate question
candidate_status Status of the candidate question
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
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_rate Proportion of items completed
concept_scope Initial or refined concept, intervention, exposure, or topic scope
confidence_calibration Calibration of AI confidence scores
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
context_scope Initial or refined context or setting scope
corrective_actions Corrective actions taken
cost Estimated cost
count Number of times this method was used
country Country where the institution is located
dataset_name Name of the dataset
decision_date Date and time when the decision was made
decision_made_by Participants who made the decision
department Department or division within the institution
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
email Email address of the author
ended_at End time
errors_encountered Errors encountered during the session
expertise_areas Areas of expertise relevant to the review
exploratory_notes Notes about the exploratory search
exploratory_outputs Outputs produced by the exploratory search
exploratory_query Exploratory query or search expression
exploratory_records_found Number of records found during exploratory searches
exploratory_relevant_count Number of records considered relevant during exploratory review
exploratory_results_count Number of records found by the exploratory search
exploratory_search_date Date and time of the exploratory search
exploratory_search_id Identifier for an exploratory search
exploratory_searches Exploratory searches used to understand the evidence landscape
exploratory_searches_count Number of exploratory searches conducted
exploratory_source Source used for the exploratory search
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
feasibility_assessment Assessment of whether the planned review scope is feasible
feasibility_conclusion Overall feasibility conclusion
feasibility_data_availability Feasibility assessment of expected data availability
feasibility_literature_volume Feasibility assessment of expected literature volume
feasibility_notes Notes about feasibility
feasibility_population Feasibility assessment of the population scope
feasibility_resource_constraints Known resource constraints affecting feasibility
feasibility_review_scope Feasibility assessment of review scope
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
given_name Given/first name of the author
human_agreement_rate Rate of agreement with human reviewers
human_modifications Modifications made by humans to AI outputs
human_oversight_level Level of human review required
initial_review_question Initial review question before refinement
inputs Input artifacts
institution_name Name of the affiliated institution
involved_fields Fields commonly involved in this pattern
involved_participants Participants commonly involved
issues_found Number of issues identified
issues_resolved Number of issues resolved
item_ids_processed IDs of items processed in this session
item_modified Item or field that was modified
items_per_day Average items processed per day
items_processed_count Total items processed
kind Kind or type of stage output
krippendorff_alpha Krippendorff's alpha reliability coefficient
last_item_date Date of last item processed
librarian_consulted Whether a librarian or information specialist was consulted
license License governing the dataset
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
modification_id Unique identifier for modification
modification_reason Reason for the modification
modification_timestamp When the modification was made
modified_value Value after human modification
modifier_id ID of the person who made the modification
most_common_conflict_type Most frequently occurring conflict type
name Full name of the author
negative_predictive_value Negative predictive value
notes Additional notes
orcid ORCID identifier for the author
original_ai_value Original value produced by AI
original_decisions Original conflicting decisions or values
output_created_at Creation timestamp
output_label Human-readable label
outputs Output artifacts
overall_agreement Overall agreement rate across all items
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
parameter_description Description of what this parameter controls
parameter_name Name of the parameter
parameter_value Value of the parameter
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
pending_conflicts Number of conflicts pending resolution
percent_agreement Simple percentage agreement
planned_scoping_methods Methods planned for scoping
population_scope Initial or refined population scope
precision Positive predictive value
process_avg_time_per_item Average time per item in minutes
process_total_time_hours Total time spent in hours
processing_speed Average processing time per item (seconds)
prompt_examples Few-shot examples included in the prompt
prompt_id Unique identifier for prompt
prompt_text The actual prompt text
prompt_type Type of prompting strategy
prompt_version Version of this prompt
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
question_candidate_id Identifier for a candidate question
question_framework Framework used to express the question, such as PICO, PECO, or SPIDER
question_text Candidate question text
range_description Description of a date range
range_end End of a date range
range_start Start of a date range
related_decision_id Identifier of a related scoping decision
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
resulting_changes Changes resulting from the decision
ror_id Research Organization Registry identifier for the institution
sample_method Method used for sampling
scoping_consistency_checks Consistency checks performed during scoping
scoping_decision_id Identifier for a scoping decision
scoping_decision_rationale Rationale for the scoping decision
scoping_decision_text Decision text
scoping_decision_type Type of scoping decision
scoping_decisions Decisions made while refining the review scope
scoping_decisions_count Number of scoping decisions documented
scoping_objective Purpose of the scoping work
scoping_outputs Outputs produced during scoping
scoping_peer_review Whether scoping work received peer review
scoping_protocol Protocol or plan for the scoping activity
scoping_quality_control Quality control measures for the scoping process
scoping_question_candidates Candidate review questions considered during scoping
scoping_start_criteria Criteria for starting scoping work
scoping_statistics Summary statistics for the scoping process
scoping_stop_criteria Criteria for ending scoping work
sensitivity True positive rate (recall)
session_duration Duration of the session in seconds
session_timestamp When this AI session occurred
snapshot_hash Checksum of the dataset snapshot
specificity True negative rate
stage_description Detailed description
stage_label Human-readable label
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
stakeholder_input_date Date and time when input was received
stakeholder_input_id Identifier for stakeholder input
stakeholder_input_source Source or record of the input
stakeholder_input_summary Summary of the input received
stakeholder_input_type Type of stakeholder input
stakeholder_input_used Whether the input influenced the review scope
stakeholder_inputs Input from stakeholders, domain experts, librarians, or methodologists
stakeholder_inputs_count Number of stakeholder input records documented
stakeholder_role Role of the stakeholder providing input
stakeholder_validation Whether stakeholders validated the proposed scope
started_at Start time
success_rate Success rate of this method
target_field Field or task this prompt targets
throughput_trend Trend in processing speed
time_spent_hours Total time spent in hours
token_usage Number of tokens used
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_items Total number of items to process
training_completed Training or calibration exercises completed
upper_bound Upper bound of the interval

Enumerations

Enumeration Description
AIPurpose Purpose for which AI is being used
ConflictType Types of conflicts that can occur
DatasetKind Types of datasets used in systematic reviews
FeasibilityConclusion Overall feasibility conclusion
HumanOversightLevel Level of human oversight required
ModificationReason Reason for modifying AI output
ParameterType Data types for tool parameters
ParticipantRole Roles that participants can have in the review process
PromptType Type of prompting strategy
QualityControlType Types of quality control checks
QuestionCandidateStatus Status values for candidate review questions
ResolutionMethod Methods for resolving conflicts
SamplingMethod Methods for sampling items for quality control
ScopingDecisionType Types of decisions made during scoping
StageOutputKind Types of outputs that can be produced by review stages
StageType Logical stages of a systematic review (typical flow)
StakeholderInputType Types of stakeholder input
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