Skip to content

revaise_literature_record

Shared literature and manuscript records that persist across review stages.

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

Name: revaise_literature_record

Classes

Class Description
Affiliation Institutional affiliation
Author Author of a review or publication
        Participant A person participating in the review process
ChecklistItem Individual item in a quality checklist
ConformanceAssertion Stored result of checking a review or record against a declared protocol, inc...
ConformanceItemResult Result for a single protocol item or constraint within a conformance assertio...
DatasetRef External dataset reference
DateRange A simple date range representation
DomainAssessment Assessment of a specific quality domain
LiteratureRecord A literature record representing a publication that persists across review st...
LiteratureRecordCollection A collection of literature records
ParticipantWorkload Workload statistics for a participant
ProtocolReference Reference to a versioned review protocol or guideline that a review or record...
QualityAssessment Quality or risk of bias assessment for a study or item
QualityChecklist Checklist for quality assessment
RiskOfBiasDomainAssessment Assessment of a specific risk-of-bias domain
SignallingQuestionAssessment Assessment of a risk-of-bias signalling question
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
StudyCharacteristics Key characteristics of a study
StudyResult A single result reported by a study for a specific outcome, with full numeric...

Slots

Slot Description
abstract Abstract or summary of the publication
address Street address of the institution
affiliations Institutional affiliations of the author
applicable_review_types Review types the protocol applies to
asserted_at When the conformance check was performed
asserted_by Agent or person that performed the conformance check
asserted_protocol URI of the protocol the assertion was checked against
assertion_id Unique identifier for a conformance assertion
assessment_date Date and time of assessment
assessment_id Unique identifier for this assessment
assessment_notes Notes about the assessment
assessment_purpose Purpose of this assessment
assessment_time_minutes Time taken to complete assessment in minutes
assessment_tool Tool used for quality assessment
assessment_unit Unit at which the assessment is made
assessor Person who performed the assessment
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
checklist_id Unique identifier for the checklist
checklist_items Items in the checklist
checklist_name Name of the checklist
checklist_version Version of the checklist
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
comparator_details Details of the comparator
completed_items_count Number of items completed by this participant
confidence_rating Assessor's confidence in the assessment
conflict_of_interest_declared Whether conflicts of interest were declared
conformance_assertions Stored results of conformance checks against declared protocols
conformance_result Overall outcome of the conformance check
conformance_tool_name Name of the tool that performed the conformance check
conformance_tool_version Version of the tool that performed the conformance check
conforms_to Protocols or guidelines this review or record declares conformance to
cost Estimated cost
country Country where the institution is located
dataset_name Name of the dataset
department Department or division within the institution
doi Digital Object Identifier of the publication
domain_assessments Assessment of individual quality domains
domain_justification Justification for the rating
domain_name Name of the quality domain
domain_rating Rating for this domain
email Email address of the author
ended_at End time
expertise_areas Areas of expertise relevant to the review
family_name Family/last name of the author
first_item_date Date of first item processed
format File format or MIME type
full_text_url URL to access the full text of the publication
funding_source Source of study funding
given_name Given/first name of the author
guidance_text Guidance for answering this item
inputs Input artifacts
institution_name Name of the affiliated institution
interpretation_guide Guide for interpreting scores
intervention_details Details of the intervention
issue Issue number of the journal
item_category Category this item belongs to
item_id ID of the item being assessed
item_label Short label for the protocol item
item_location Location in the review or record where the item is addressed
item_message Message describing the item result, such as a violation reason
item_result_id Identifier of a protocol item or constraint
item_results Per-item results from a conformance check
item_status Outcome for a single protocol item
item_text Text of the checklist item
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
last_item_date Date of last item processed
license License governing the dataset
name Full name of the author
notes Additional notes
orcid ORCID identifier for the author
outcome_measures Outcome measures used
output_created_at Creation timestamp
output_label Human-readable label
outputs Output artifacts
overall_quality Overall quality rating
overall_risk_of_bias Overall risk-of-bias judgement
page_references Page references for the assessment
pages Page numbers (e
participant_avg_time_per_item Average time spent per item (minutes)
participant_characteristics Description of participants
participant_id Reference to the participant
participant_notes Additional notes about the participant
participant_role Role(s) of the participant in the review
peak_items_per_day Maximum items processed in a single day
pmid PubMed identifier of the publication
protocol_citation Bibliographic citation for the protocol
protocol_id Unique identifier for a protocol reference
protocol_kind Category of the protocol
protocol_name Name of the protocol or guideline
protocol_uri Versioned URI identifying the external protocol specification
protocol_version Version of the protocol or guideline
publication_language Language of the publication
publication_status Publication status of the study
publication_type Type of publication (e
publication_year Year of publication
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
resource_uri URI locating the resource
response_options Possible responses to this item
result_ci_lower Lower bound of the confidence interval
result_ci_upper Upper bound of the confidence interval
result_comparator_n Sample size in the comparator or unexposed group
result_effect_estimate Point estimate of the effect
result_intervention_n Sample size in the intervention or exposed group
result_measure Effect measure or statistic reported
result_notes Additional notes on this result
result_outcome Name of the outcome this result refers to
result_p_value Reported p-value for this result
result_total_n Total sample size contributing to this result
risk_of_bias Full risk-of-bias / quality assessment for this study
risk_of_bias_domains Risk-of-bias domain judgements, including signalling questions
rob_assessment_version Version or variant of the risk-of-bias assessment tool
rob_consensus_status Consensus status for the assessment
rob_direction Assessed direction of bias if evaluated
rob_domain_description Description of the risk-of-bias domain
rob_domain_direction Assessed direction of bias for this domain if evaluated
rob_domain_id Identifier for the risk-of-bias domain
rob_domain_judgement Risk-of-bias judgement for this domain
rob_domain_name Name of the risk-of-bias domain
rob_domain_rationale Rationale for the domain judgement
rob_justification Overall justification for the risk-of-bias judgement
ror_id Research Organization Registry identifier for the institution
scoring_method Method for scoring the checklist
scoring_weight Weight of this item in scoring
shapes_version Version of the SHACL shapes used for the check
signalling_question_id Identifier for the signalling question
signalling_question_rationale Rationale for the signalling-question response
signalling_question_response Response to the signalling question
signalling_question_support Supporting evidence for the signalling-question response
signalling_question_text Text of the signalling question
signalling_questions Signalling-question assessments for this domain
snapshot_hash Checksum of the dataset snapshot
stage_category Concrete stage class this execution represents; used as a type designator
stage_description Detailed description
stage_label Human-readable label
stage_status Completion status of a stage execution
stage_type Type of stage executed
started_at Start time
study_country Countries where study was conducted
study_design Design of the study
study_duration Duration of the study
study_registration_id Clinical trial registration ID
study_results Per-outcome results reported by this study
study_sample_size Total sample size
study_setting Setting where study was conducted
supporting_quotes Quotes supporting the assessment
target_effect Effect estimate, contrast, or estimand targeted by the assessment if applicab...
target_outcome Outcome targeted by the assessment if outcome-specific
time_spent_hours Total time spent in hours
title Title of the publication
training_completed Training or calibration exercises completed
volume Volume number of the journal

Enumerations

Enumeration Description
AssessmentConsensusStatus Consensus status for an assessment
AssessmentPurpose Purpose of a quality or risk-of-bias assessment
AssessmentUnit Unit at which a quality or risk-of-bias assessment is made
BiasDirection Assessed direction of bias
ConfidenceLevel Confidence levels
ConformanceItemStatus Outcome for a single protocol item or constraint
ConformanceResult Overall outcome of a conformance check
DatasetKind Types of datasets used in systematic reviews
ParticipantRole Roles that participants can have in the review process
ProtocolKind Category of a review protocol or guideline
PublicationStatus Publication status of studies
QualityAssessmentTool Tools for quality assessment
QualityRating Quality rating levels
ReviewType Types of reviews
RiskOfBiasJudgement Risk-of-bias judgement values
SignallingQuestionResponse Responses to risk-of-bias signalling questions
StageOutputKind Types of outputs that can be produced by review stages
StageStatus Completion status of a stage execution
StageType Logical stages of a systematic review (typical flow)
StudyDesign Types of study designs

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