The Crossref Curriculum

Peer reviews markup guide

Prior learning: Introduction to peer reviews

This page gives markup examples for members registering peer reviews by direct deposit of XML. It is not currently possible to register the peer reviews content type using one of our helper tools.

Getting started with registering peer reviews

Registration of peer reviews is supported as of schema version 4.4.1. Peer reviews include referee reports, decision letters, and author responses. You may also register post-publication reviews using our peer review content type.

Peer review metadata includes a number of review-specific elements. Many are optional to accommodate differences in review practices, but please include all elements relevant to your reviews when submitting your metadata records.

Our schema includes support for the following fields:

  • contributor, to capture reviewer name and role, choose from:
    • reviewer
    • review-assistant
    • stats-reviewer
    • reviewer-external
    • reader
    • translator
    • anonymous
  • title
  • review_date
  • institution
  • competing_interest_statement
  • running_number
  • license data
  • relations
  • stage
  • type
  • recommendation
  • revision-round
  • language

Note that all reviews must include relationship metadata linking the review with the item being reviewed. Learn more about structural metadata.

Element Description Limits
contributor, includes person_name or anonymous Captures reviewer name and role. If anonymous, must capture as .
Peer review roles are: reviewer, review-assistant, stats-reviewer, reviewer-external, reader, translator, author, editor
optional
title Title of review. If you don’t have a review-specific title convention, we recommend that you include Review (or member’s own term for review) in your peer review registration, as well as a revision and review number.
For example, a review pattern of Review: title of article (Revision number/Review number) will be:
Review: Analysis of the effects of bad metadata on discoverability (R2/RC3)
required
review_date Date of review, including month, day, year year is required
institution Organization (member or other) submitting the peer review, strongly advised if submitter differs from publisher of item being reviewed optional, may include up to 5
competing_interest_statement Competing interest statement provided by review author during review process optional
running_number Internal number/identifier used to identify specific review optional
license data Text or data mining license info optional
relations Relate review to item being reviewed through relationships - must supply the DOI of item being reviewed as an inter-work relation with review type isReviewOf required

Some metadata is captured as attributes with specific enumerated values:

Attributes Description Limits
stage Options are pre-publication and post-publication optional
type Types of report include: referee-report, editor-report, author-comment, community-comment, aggregate, recommendation optional
recommendation Values are: major-revision, minor-revision, reject, reject-with-resubmit, accept optional
revision-round Revision round number, first submission is defined as revision round 0 optional
language Language of review optional

Example of connecting a review to the reviewed item through relations

<program xmlns="https://0-www-crossref-org.lib.rivier.edu/relations.xsd">
   <related_item>
      <description>Referee report of Treatment of plaque psoriasis with an ointment
formulation of the Janus kinase inhibitor, tofacitinib: a Phase 2b randomized
clinical trial</description>
      <inter_work_relation relationship-type="isReviewOf" identifier-type="doi"
>10.1186/s12895-016-0051-4</inter_work_relation>
   </related_item>
</program>

Example of a complete review

<?xml version="1.0" encoding="UTF-8"?>
   <doi_batch xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://0-www.crossref.org.lib.rivier.edu/schema/4.4.2 http://0-www.crossref.org.lib.rivier.edu/schema/crossref4.4.2.xsd"
xmlns="http://0-www.crossref.org.lib.rivier.edu/schema/4.4.2" version="4.4.2">
  	<head>
     	<doi_batch_id>20170807</doi_batch_id>
     	<timestamp>2017080715731</timestamp>
     	<depositor>
       	<depositor_name>Crossref</depositor_name>
       	<email_address>support@crossref.org</email_address>
     	</depositor>
     	<registrant>Crossref</registrant>
  	</head>
  	<body>
     	<peer_review stage="pre-publication" revision-round="1" recommendation="accept">
         	<contributors>
           	<person_name contributor_role="reviewer" sequence="first">
              	<given_name>Wilson</given_name>
              	<surname>Liao</surname>
           	</person_name>
         	</contributors>
         	<titles>
            	<title>Review: Treatment of plaque psoriasis with an ointment formulation of the Januskinase inhibitor, tofacitinib: a Phase 2b randomized clinical trial. V1</title>
         	</titles>
         	<review_date>
            	<month>08</month>
            	<day>19</day>
            	<year>2016</year>
         	</review_date>
         	<competing_interest_statement> There were no competing interests</competing_interest_statement>
         	<running_number>RC1 </running_number>
         	<program xmlns="http://0-www.crossref.org.lib.rivier.edu/relations.xsd">
            	<related_item>
              	<description>Referee report of Treatment of plaque psoriasis with an ointment formulation of the Janus kinase inhibitor, tofacitinib: a Phase 2b randomized clinical trial</description>
              	<inter_work_relation relationship-type="isReviewOf" identifier-type="doi"
>10.1186/s12895-016-0051-4 </inter_work_relation>
            	</related_item>
         	</program>
         	<doi_data>
            	<doi>10.5555/abc123</doi>
            	<resource>https://www.example.org/openpeerreview/art%3A10.1186%2Fs12895-016-0051-4/12895_2016_51_ReviewerReport_V2_R1.pdf</resource>
         	</doi_data>
     	</peer_review>
   	</body>
   </doi_batch>

Last Updated: 2020 April 8 by Laura J. Wilkinson