Peer Review Technical Documentation

[Laura Paglione]

Hi, Now in addition to the Getting Started Guide, we've just finalized the technical documentation for the peer review data structure and API calls. You can find the most up-to-date version in our Github repo: https://github.com/ORCID/ORCID-Source/blob/master/orcid-model/src/main/resources/record_2.0_rc1/peer-review-guide-v2.0_rc1.md (the updated documentation on the Getting Started Guide will be complete later today.)

To help plan integrations and to more easily communicate to researchers what to expect, we have established three "integration levels" for those using the peer review functionality (see below). As you think through your integration and workflow, please consider these integration levels.

TECHNICAL ORIENTATION CALLS: Would anyone be interested in attending a call with me to talk through the Peer Review XML and/or API calls or any of the workflows/integration levels listed below? If so, please indicate your availability in the following doodlepoll: http://doodle.com/cr8sh9vts95hizq4

Integration levels

LEVEL 1: COLLECT ORCID IDS FOR PEER REVIEWERS

• You collect and store ORCID iDs for peer reviewers that work with you, either on a voluntary or mandatory basis
• You collect and store the permission access tokens to add to and update the reviewer’s ORCID record (but don’t yet add anything to the ORCID record)
• You display ORCID iDs on your site(s) as links and metadata anywhere that the reviewer’s name would appear, for example, in recognition lists, review displays, communications to those for whom the review was performed (if applicable), etc. Your display follows ORCID’s display guidelines

LEVEL 2: RECOGNIZE UPCOMING PEER REVIEW ACTIVITY ON THE ORCID RECORD

Everything in LEVEL 1 plus:

• You determine an appropriate interval at which to post peer review activity information to a reviewer’s ORCID Record, and activate the posting process
• At a minimum, you have an internal unique reference code to represent the recognized peer review activity.(This code/identifier does not need to have meaning outside of your own systems)
• You use a model that enables you to ask the reviewer’s permission when you first add items, and to reuse this permission so that reviewer’s ORCID records are updated automatically by your systems

LEVEL 3: RECOGNIZE UPCOMING AND PAST PEER REVIEW ACTIVITY ON THE ORCID RECORD

Everything in LEVELS 1 and 2 plus:

• You have developed a model to add past review activity to the reviewer's ORCID record
• (optional) You have developed a search & link wizard that can be plugged into the ORCID site, to enable reviewers to connect to your system and add their past review activities to their ORCID record

[Laura Paglione]

Hi all, I hope that you are well.

I wanted to let you know that I recently updated several resources related to peer review, and thought I'd pass along some links for your reference (below). Please don't hesitate to reach out if you have any questions about them.

Resources:

• Peer Review Getting Started Guide: https://members.orcid.org/api/peer-review-getting-started
  
• Sample files & example of posting peer review activity: https://github.com/ORCID/ORCID-Example-Peer-Review
  
• Peer Review API guide: https://github.com/ORCID/ORCID-Source/blob/master/orcid-model/src/main/resources/record_2.0_rc1/peer-review-guide-v2.0_rc1.md
  
• Peer Review Groups API guide: https://github.com/ORCID/ORCID-Source/blob/master/orcid-model/src/main/resources/group-id-2.0_rc1/README.md
  
• Example ORCID record with peer review activity on it: http://sandbox.orcid.org/0000-0002-4955-8190?peer (note: there are a couple of small interface items that we're still working on, but it should give you an idea of how it works.

As you look at this functionality, please don't hesitate to reach out to me or to this forum with any questions or comments. I'm looking forward to working with you as we launch this exciting functionality!

Best, L