RCUK RIOXX Application Profile Version 1.3

This version of the application profile is obsolete

This is an updated version of the RIOXX applicaiton profile, enhanced following the outcomes of the V4OA project.

Changes since version 1.0

Note that we may introduce a controlled vocabulary of output types into this version, if RCUK can supply an authoritative list. This would then constrain the values of the dc:rights element

This section details the application profile for RIOXX. The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119.

Properties in this profile

dc:coverage | dc:description | dc:format | dc:identifier | dc:language | dc:publisher | dc:relation | dc:source | dc:subject | dc:title | dc:type | dcterms:audience | dcterms:references | free_to_read | license_ref | rioxxterms:acceptdate | rioxxterms:apc | rioxxterms:author | rioxxterms:contributor | rioxxterms:project | rioxxterms:version | rioxxterms:version-of-record

Property details and examples

Element Cardinality Description
dc:coverage Zero or more

This refers to the scope or extent of the content of the resource. It may include jurisdictional, temporal or spatial information. It is RECOMMENDED that, where possible, a recognised globally unique identifier is used, such as the Thesaurus of Geographic Names. For example, the place of publication may be recorded.

dc:description Zero or more

This field may be indexed and its contents presented to people conducting searches. The goal is to describe the content of the resource using free text. It is RECOMMENDED that an English language abstract be used where available. HTML or other markup tags SHOULD NOT be included in this field.

dc:format Zero or more

This refers to the form of the resource being described in the RIOXX record. The resource can be physical or digital and therefore this element can refer to the media-type or dimensions of that resource. Where the resource being described is digital, the MIME type of the object pointed to by this RIOXX record’s dc:identifier element MUST be entered here.

dc:identifier Exactly one

This field MUST contain a globally unique and persistent identifier for the resource being described. The identifier SHOULD be an HTTP URI that can be de-referenced (and is, thus, actionable). The purpose of this field is to allow access to the resource, therefore it is RECOMMENDED that this identifier should point to the actual resource being described by the RIOXX record (typically a PDF file), rather than to an intermediary resource such as a repository web page. This resource SHOULD be a version of the resource held in the local repository.

dc:language One or more

This refers to the primary language in which the content of the resource is presented. The element MAY be repeated if the resource contains multiple languages. Values used for this element MUST conform to ISO 639–3. This offers two and three letter tags e.g. “en" or “eng" for English and “en-GB" for English used in the UK.

dc:publisher Zero or more

A free text string giving the name of the entity responsible for making the version of record of a resource available. This could be a person, organisation or service.

dc:relation Zero or more

The format of this element SHOULD be an HTTP URI which points to a related resource.

Each related resource MUST appear as a separate instance of the field.

dc:source Exactly one

The source label describes a resource from which the current resource is derived (in whole or in part). It is RECOMMENDED that the source is referenced using a unique identifier from a recognised system e.g. the unique 8-digit International Standard Serial Numbers (ISSN) assigned to print and electronic periodicals.

dc:subject Zero or more

Normally keywords, phrases or classification codes are used to describe the topic of the resource. If using free text, the use of general keywords SHOULD be avoided. It is RECOMMENDED to use a formal classification scheme or controlled vocabulary e.g Library of Congress Classification Headings or Medical Subject Headings (MeSH). When including terms from multiple vocabularies, separate element iterations MUST be used. If multiple vocabulary terms or keywords are used, terms SHOULD be separated with one of the following approaches:

  • the use of semi-colons to separate individual terms

or

  • the use of separate iterations of this element for each term
dc:title Exactly one

This refers to the resource’s title and any sub-titles. The title is the form of words by which a resource will be formally known and should be represented using the original spelling and wording. The RECOMMENDED format for expressing subtitles is Title:Subtitle

dc:type Zero or more

Type refers to the nature or genre of the content of the resource and can be entered as free text. Take care not to confuse this with dc:format.

dcterms:audience Zero or more

This field is designed to contain information about the group for which the resource is intended or is considered to be useful. There is no controlled vocabulary for this but sometimes creators or publishers indicate the intended audience. Note that the Research Outcomes System (ROS) used by most of the UK’s Research Councils tracks whether a resource is for a "non-academic audience" (with a drop-down list of possible selections) and whether a resource is for an "international audience". In the absence of alternative formal vocabularies, following the ROS lead is a reasonable course of action.

dcterms:references Zero or more

The format of this element SHOULD be an HTTP URI which points to a resource referenced by the resource described in the RIOXX record. Common examples might include a data-set which underpins a paper being described in the record.

Each reference MUST appear as a separate instance of this element.

free_to_read Zero or one

This is defined in the NISO Open Access Metadata and Indicators. This element MUST NOT take a value. The semantics of <free_to_read> are conveyed by its presence or absence. The presence of this element means that the work being described is freely and openly available to be read. This element may be modified by two optional attributes

  • start_date
  • end_date

Each of these attributes, if present, takes a date value which MUST be encoded using ISO 8601 (post–2004 versions) which follows the following format: YYYY-MM-DD. Examples:

<free_to_read start_date="2013-03-28" end_date="2014-04-30">
<free_to_read start_date="2013-03-28">
<free_to_read>

The absence of a start_date attribute implies that the free_to_read status is current and immediate, unless an end_date attribute, which is a date in the subjective past, is present in the element.

license_ref One or one

This is defined in the NISO Open Access Metadata and Indicators. This element MUST take an HTTP URI for its value. This HTTP URI MUST point to a resource which expresses the license terms specifying how the resource being described in the RIOXX record may be used.

This element MAY include an optional attribute:

  • start_date

This attribute, if present, takes a date value which MUST be encoded using ISO 8601 (post–2004 versions) which follows the following format: YYYY-MM-DD.

This atribute is used to indicate the date upon which this license takes effect. Multiple <license_ref> elements may be included. Where several such elements are included, the one with the start_date attribute indicating the most recent date takes precendence. A <license_ref> element with a start_date element takes precedence over a <license_ref> element without a start_date.

A single RIOXX record MUST NOT have more than one <license_ref> element without a start_date

Examples:

<license_ref>http://www.samplejournal.org/license_v1.html</license_ref>

<license_ref start_date="2015-02-17">http://creativecommons.org/licenses/by/3.0/deed.en_US</license_ref>

This approach allows the expression of 'embargoes', where a particular license takes effect at a future date.

rioxxterms:acceptdate Exactly one

The date on which this resource was accepted for publication. The date SHOULD be encoded using ISO 8601 (post–2004 versions) which follows the following format: YYYY-MM-DD. Year (YYYY) or year and month (YYYY-MM) MAY be used if the full date is not known.

rioxxterms:apc Zero or one

This element expresses whether or not the resource being described has an associated 'article processing charge'. The value of this element MUST be one of the following:

  • paid
  • partially waived
  • fully waived
  • not charged
  • not required
  • unknown
rioxxterms:author One or more

The author of the resource may be a person, organisation or service, but is most commonly a person. Where there is more than one author, a separate rioxxterms:author element MUST be used for each one. As many authors may be entered as required. If the author is a person and it is desired to record that person’s affiliation, the affiliation SHOULD be recorded as a rioxxterms:contributor element (see rioxxterms:contributor). This element SHOULD take an optional attribute called id, designed to hold a machine-readable and unique identifier, if available, for the author. Any ID entered here MUST be in a form which allows it to be parsed and recognised automatically. The ideal use of this element is to include both a machine-readable ID in the id attribute, and a text string in the body of the element, thus:

<rioxxterms:author id="identifier-for-this-author-entity">
    name-of-this-author-entity
</rioxxterms:author>

Where the author is a person, the RECOMMENDED format is to add text in the form Last Name, First Name(s), and to include an ORCID ID, if known, in its HTTP URI form, e.g.

<rioxxterms:author id="http://orcid.org/0000-0002-1395-3092">
    Lawson, Gerald
</rioxxterms:author>

Where the rioxxterms:author element appears multiple times for one record, it CAN be assumed that the order is significant, in that the first element describes the 'first named author' of the resource. In order to make this more explicit, an extra attribute, first-named-author, SHOULD be used to indicate which of the rioxxterms:author elements describes the first named author of the resource, thus:

<rioxxterms:author id="http://orcid.org/0000-0002-1395-3092" first-named-author="true">
    Lawson, Gerald
</rioxxterms:author>
rioxxterms:contributor Zero or more

This field is designed to describe an entity – for example the name of a person, organisation or service – responsible for making contributions to the content of the resource. As many rioxxterms:contributor elements may be entered as required. If the contributor is a person and it is desired to record that person's affiliation, the affiliation MUST be recorded as a separate rioxxterms:contributor element. This element SHOULD take an optional attribute called id, designed to hold a machine-readable and unique identifier, if available, for the contributor. Any ID entered here MUST be in a form which allows it to be parsed and recognised automatically. The ideal use of this element is to include both a machine-readable ID in the id attribute, and a text string in the body of the element, thus:

<rioxxterms:contributor id="identifier-for-this-contributor-entity">
    name-of-this-contributor-entity
</rioxxterms:contributor>

Where the contributor is a person, the RECOMMENDED format is to add text in the form Last Name, First Name(s), and to include an ORCID ID, if known, in its HTTP URI form, e.g.

<rioxxterms:contributor id="http://orcid.org/0000-0002-1395-3092">
    Lawson, Gerald
</rioxxterms:contributor>
rioxxterms:project One or more

This is designed to collect the project IDs issued by funders that relate to the current resource, together with the name and/or global identifier for the funder.

The element is an 'empty' element, composed of three attributes, project_id, funder_name and funder_id. The project_id attribute, and one or both of funder_name and funder_id MUST be supplied.

project_id

It is REQUIRED to use the alphanumeric identifier provided by the funder in its original format e.g. ST/K001234/1. Sometimes publications have more than one project ID associated with them; these MUST be recorded using separate instances of rioxxterms:project. In cases where projects have been funded internally, use whichever internal code is appropriate.

funder_name

The canonical name of the entity responsible for funding the resource being described by this RIOXX record SHOULD be recorded here as text. A controlled list of funder names SHOULD be used for this. The list of funder names provided by the FundRef service is RECOMMENDED

funder_id

A globally unique identifier for the entity responsible for funding the resource being described by this RIOXX record SHOULD be recorded here. Where possible, an HTTP URI SHOULD be used for this. It is RECOMMENDED that the DOI (in its HTTP URI form) made available by the FundRef service is used for this.

Example

<rioxxterms:project
    project_id="ST/K001234/1"
    funder_name="Research Councils UK"
    funder_id="http://dx.doi.org/10.13039/501100000690"
/>

This element may be included multiple times in one record, so where a resource has been funded by more than one funder, a separate rioxxterms:project element MUST be added for each. Similarly, where several project IDs have been attached to the resource, a separate rioxxterms:project element MUST be added for each.

rioxxterms:version Exactly one

This element indicates which 'version' of the resource is being described. The value of this element MUST be one of the following:

  • AO
  • SMUR
  • AM
  • P
  • VoR
  • CVoR
  • EVoR
  • NA

These terms are adopted from the Journal Article Versions (JAV): Recommendations of the NISO/ALPSP JAV Technical Working Group and have the following meanings:

  • AO = Author's Original
  • SMUR = Submitted Manuscript Under Review
  • AM = Accepted Manuscript
  • P = Proof
  • VoR = Version of Record
  • CVoR = Corrected Version of Record
  • EVoR = Enhanced Version of Record
  • NA = Not Applicable (or Unknown)
rioxxterms:version-of-record Zero or one

This field MUST contain a globally unique and persistent identifier for the published version of the resource being described. The identifier SHOULD be an HTTP URI that can be de-referenced (and is, thus, actionable). If a DOI has been issued by the publisher then this MUST be used. Such a DOI MUST be represented in its HTTP form, for example:

<rioxxterms:version-of-record>
    http://dx.doi.org/10.1006/jmbi.1995.0238
</rioxxterms:version-of-record>