peer-review-2.0.xsd 9.57 KB
<?xml version="1.0" encoding="UTF-8"?> 
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
	xmlns:sch="http://purl.oclc.org/dsdl/schematron" elementFormDefault="qualified"
	targetNamespace="http://www.orcid.org/ns/peer-review" 
	xmlns:common="http://www.orcid.org/ns/common" 
	xmlns:work="http://www.orcid.org/ns/work"
	
	xmlns:peer-review="http://www.orcid.org/ns/peer-review">
	<xs:annotation> 
		<xs:documentation>
			=============================================================================

			ORCID (R) Open Source
			http://orcid.org

			Copyright (c) 2012-2014 ORCID,
			Inc.
			Licensed under an MIT-Style License (MIT)
			http://orcid.org/open-source-license

			This copyright and license
			information (including a link to the full
			license)
			shall be included in
			its entirety in all copies or substantial portion of
			the software.

			=============================================================================
			The schema describes the message format used for ORCID API requests
			and responses.
			The top level element is orcid-message.
		</xs:documentation>
		<xs:appinfo>
			<sch:title>Schematron validation</sch:title>
			<sch:ns prefix="orcid" uri="http://www.orcid.org/ns/orcid" />
		</xs:appinfo>
	</xs:annotation>

    <xs:import namespace="http://www.orcid.org/ns/common"
        schemaLocation="../common_2.0/common-2.0.xsd" />	
	<xs:import namespace="http://www.orcid.org/ns/work"
		schemaLocation="work-2.0.xsd" />

	<xs:element name="peer-review">
		<xs:complexType>
			<xs:complexContent>
				<xs:extension base="common:element-summary">
					<xs:sequence>
						<xs:element name="reviewer-role" type="peer-review:role" minOccurs="1" maxOccurs="1">
							<xs:annotation>
								<xs:documentation>The role played by a person in their
									contribution to a review.
								</xs:documentation>
							</xs:annotation>
						</xs:element>
						<xs:element name="review-identifiers" type="common:external-ids"
							minOccurs="1">
							<xs:annotation>
								<xs:documentation>Unique identifier(s) of the review. <i>This identifier refers to the review itself, NOT to the item that was reviewed.</i> At least one identifier is required. In the case where there is no persistent unique identifier for the review, the source providing the data should generate a locally-sourced unique identifier for the review (e.g., type "organization-defined-type"). This field will be checked when adding new reviews to prevent double counting of review activity.
								</xs:documentation>
							</xs:annotation>
						</xs:element>
						<xs:element name="review-url" type="common:url" minOccurs="0">
							<xs:annotation>
								<xs:documentation>A link to a representation of the review on the web. <i>This URL refers to the review itself, NOT to the item that was reviewed.</i>
								</xs:documentation>
							</xs:annotation>
						</xs:element>
						<xs:element name="review-type" type="peer-review:type"
							minOccurs="1" maxOccurs="1">
							<xs:annotation>
								<xs:documentation>The kind of review applied to the subject type
									reviewed
								</xs:documentation>
							</xs:annotation>
						</xs:element>
						<xs:element name="review-completion-date" type="common:fuzzy-date"
							minOccurs="1" maxOccurs="1">
							<xs:annotation>
								<xs:documentation>The date on which the review was completed. Allowable values: yyyy; yyyy-mm; yyyy-mm-dd, formatted using the ORCID fuzzy date format.
								</xs:documentation>
							</xs:annotation>
						</xs:element>
						<xs:element name="review-group-id" type="common:group-id" minOccurs="1" maxOccurs="1">
							<xs:annotation>
								<xs:documentation>Identifier for the group that this review should be a part of for aggregation purposes
								</xs:documentation>
							</xs:annotation>
						</xs:element>						
						<xs:element name="subject-external-identifier" type="common:external-id"
							minOccurs="0">
							<xs:annotation>
								<xs:documentation>The unique identifier of the subject being
								reviewed.
								</xs:documentation>
							</xs:annotation>
						</xs:element>						
						<xs:element name="subject-container-name" type="work:journal-title"
							minOccurs="0" maxOccurs="1">
							<xs:annotation>
								<xs:documentation>The name of the journal, conference, grant review panel, or other applicable object of which the review subject was a part.
								</xs:documentation>
							</xs:annotation>
						</xs:element>
						<xs:element name="subject-type" type="work:work-type" minOccurs="0" maxOccurs="1">
							<xs:annotation>
								<xs:documentation>The type of object that the review subject is (for example, a journal article, grant, etc).
								</xs:documentation>
							</xs:annotation>
						</xs:element>
						<xs:element name="subject-name" type="work:work-title"
							minOccurs="0" maxOccurs="1">
							<xs:annotation>
								<xs:documentation>The name/title of the subject object that was reviewed.
								</xs:documentation>
							</xs:annotation>
						</xs:element>
						<xs:element name="subject-url" type="common:url" minOccurs="0" maxOccurs="1">
							<xs:annotation>
								<xs:documentation>The URL of the subject object that was reviewed.
								</xs:documentation>
							</xs:annotation>
						</xs:element>
						<!-- orcid orgs doesn't match specification -->
						<xs:element name="convening-organization" type="common:organization"
							minOccurs="1" maxOccurs="1">
							<xs:annotation>
								<xs:documentation>Information about the organization convening the review (journal publisher, conference organizer, funding agency, etc). Whenever possible, this organization is identified by a unique identifier like the Ringgold ID or FundRef ID.
								</xs:documentation>
							</xs:annotation>
						</xs:element>																																	
					</xs:sequence>
				</xs:extension>
			</xs:complexContent>
		</xs:complexType>
	</xs:element>

	<xs:element name="peer-review-summary">
		<xs:complexType>
			<xs:complexContent>
				<xs:extension base="common:element-summary">
					<xs:sequence>						
						<!-- orcid orgs doesn't match specification -->
						<xs:element ref="common:external-ids"
							minOccurs="0">
							<xs:annotation>
								<xs:documentation>The unique generated identifier of the review.
								</xs:documentation>
							</xs:annotation>
						</xs:element>						
						<xs:element name="completion-date" type="common:fuzzy-date"
							minOccurs="1" maxOccurs="1">
							<xs:annotation>
								<xs:documentation>The date on which the review was completed. Allowable values: yyyy; yyyy-mm; yyyy-mm-dd, formatted using the ORCID fuzzy date format.
								</xs:documentation>
							</xs:annotation>
						</xs:element>
						<xs:element name="review-group-id" type="common:group-id" minOccurs="1" maxOccurs="1">
							<xs:annotation>
								<xs:documentation>Identifier for the group that this review should be a part of for aggregation purposes
								</xs:documentation>
							</xs:annotation>
						</xs:element>
						<xs:element name="convening-organization" type="common:organization"
							minOccurs="1" maxOccurs="1">
							<xs:annotation>
								<xs:documentation>Information about the organization convening the review (journal publisher, conference organizer, funding agency, etc). Whenever possible, this organization is identified by a unique identifier like the Ringgold ID or FundRef ID.
								</xs:documentation>
							</xs:annotation>
						</xs:element>	
					</xs:sequence>
				</xs:extension>
			</xs:complexContent>
		</xs:complexType>
	</xs:element>

	<xs:simpleType name="role">
		<xs:annotation>
			<xs:documentation>The role performed reviewer
			</xs:documentation>
		</xs:annotation>
		<xs:restriction base="xs:string">
			<xs:enumeration value="reviewer">
				<xs:annotation>
					<xs:documentation>
						A person who formally assess or examines an
						output with a view to
						commenting and evaluating it.
					</xs:documentation>
				</xs:annotation>
			</xs:enumeration>
			<xs:enumeration value="editor">
				<xs:annotation>
					<xs:documentation>A person who coordinates reviews and/or is
						responsible for decision making on the content of a publication.
					</xs:documentation>
				</xs:annotation>
			</xs:enumeration>
			<xs:enumeration value="member">
				<xs:annotation>
					<xs:documentation>A person participating in a process, committee or
						activity.
					</xs:documentation>
				</xs:annotation>
			</xs:enumeration>
			<xs:enumeration value="chair">
				<xs:annotation>
					<xs:documentation>A person who coordinates reviews and/or is
						responsible for decision making on the content of a conference.
					</xs:documentation>
				</xs:annotation>
			</xs:enumeration>
			<xs:enumeration value="organizer">
				<xs:annotation>
					<xs:documentation>A person who makes arrangements or preparations
						for an event or activity.
					</xs:documentation>
				</xs:annotation>
			</xs:enumeration>
		</xs:restriction>
	</xs:simpleType>

	<xs:simpleType name="type">
		<xs:annotation>
			<xs:documentation>The role performed reviewer
			</xs:documentation>
		</xs:annotation>
		<xs:restriction base="xs:string">
			<xs:enumeration value="review">
				<xs:annotation>
					<xs:documentation>An expert assessment of a scholarly output that
						contributes to a decision regarding on the object of the review.
					</xs:documentation>
				</xs:annotation>
			</xs:enumeration>
			<xs:enumeration value="evaluation">
				<xs:annotation>
					<xs:documentation>
						A post­peer review, expert evaluation of a
						scholarly output.
					</xs:documentation>
				</xs:annotation>
			</xs:enumeration>
		</xs:restriction>
	</xs:simpleType>	
</xs:schema>