Include ROR IDs in DOI metadata

ROR is intended to help connect people (researchers), places (organizations, like funders and research institutions) and things (research outputs, like publications and datasets) through the power of open persistent identifiers (PIDs), in order to easily answer questions like:

  • Which publications and datasets were authored by researchers at a particular institution?
  • Which publications and datasets are the result of research supported by a particular funding agency?
  • Which researchers are affiliated with a given institution?

To harness the power of PIDs in this way, ROR identifiers need to be included in metadata for other identifiers, such as DOI metadata for publications and datasets, via publisher and repository systems.

ROR in Crossref DOIs

As of v5.3.0 (released in July 2021), the Crossref metadata schema supports ROR IDs for all types of content that have an affiliation or institution element, such as journal articles, book chapters, preprints, datasets, dissertations, and many more.

  • institution element is repeatable, to support multiple affiliations for a given contributor
  • Affiliations in Crossref schema align with JATS v1.1+

📘

Which Crossref tools/services support ROR?

Currently, ROR is supported only in direct XML deposits using v5.3.0. ROR is not yet supported in Crossref's Web Deposit Form or REST API, or in OJS' plugin, but work is underway and will be completed later in 2021.

Example: Contributor affiliation (journal article)

Below is an example showing just the contributors section for a journal article deposit using Crossref schema v5.3.0. For the full XML, see the v5.3.0 journal article best practice example

<contributors>
  <person_name sequence="first" contributor_role="author">
    <given_name>Minerva</given_name>
    <surname>Housecat</surname>
    <!--affiliations information (change from 4.x versions)-->
    <affiliations>
      <!-- This example includes all supported institution metadata for an individual affiliation, but if an identifier (ROR, ISNI, or Wikidata) is supplied, the name, place, and acronym metadata is not recommended.-->
      <institution>
        <!-- either institution_name or institution_id are required -->
        <institution_name>United States Department of Energy</institution_name>
        <!-- multiple institution_id values may be provided, IDs must be provided as a https URL -->
        <institution_id type="ror">https://ror.org/01bj3aw27</institution_id>
        <institution_id type="isni">https://www.isni.org/0000000123423717</institution_id>
        <!-- acronym is optional, not recommended if an identifier is supplied -->
        <institution_acronym>USDOE(EM)</institution_acronym>
        <!-- place metadata is not recommended if an institution_id is supplied -->
        <institution_place>Washington, DC</institution_place>
        <!-- Department may be supplied when relevant -->
        <institution_department>Office of Environmental Management</institution_department>
      </institution>
      <institution>
        <!-- A ROR, ISNI, or Wikidata ID may be provided on its own as it's all we need to identify an organization-->
        <institution_id type="ror">https://ror.org/05gq02987</institution_id>
      </institution>
    </affiliations>
    <ORCID authenticated="true">https://orcid.org/0000-0002-4011-3590</ORCID>
  </person_name>
  <person_name sequence="additional" contributor_role="author">
    <given_name>Josiah</given_name>
    <surname>Carberry</surname>
    <affiliations>
      <institution>
        <institution_id type="ror">https://ror.org/05gq02987</institution_id>
      </institution>
    </affiliations>
    <ORCID authenticated="true">https://orcid.org/0000-0002-1825-0097</ORCID>
  </person_name>
  <anonymous sequence="first" contributor_role="author">
    <!-- affiliations may be provided for an anonymous contributor -->
    <affiliations>
      <institution>
        <institution_id type="ror">https://ror.org/05gq02987</institution_id>
      </institution>
    </affiliations>
  </anonymous>
</contributors>

For more details about Crossref schema v5.3.0, see the release notes in Gitlab

ROR in DataCite DOIs

As of v4.3 (released in Aug 2019), the DataCite metadata schema supports ROR IDs in fundingReference and creator/contributor affiliation fields for all resource types.

ROR IDs are supported in DataCite's Fabrica form, as well as the MDS API and REST API.

When retrieving DOIs with the REST API, you'll need to add the parameter &affiliation=true to receive affiliation details in the response. See DataCite's support site for more information.

Example: Creator/contributor affiliation

Below are examples showing just the creator and contributor sections for a DataCite DOI. For the full XML, see the example with affiliation file linked from the latest DataCite metadata schema documentation.

  • affiliation element is repeatable, to support multiple affiliations for a given creator/contributor
<creator>
    <creatorName nameType="Personal">Carberry, Josiah</creatorName>
    <givenName>Josiah</givenName>
    <familyName>Carberry</familyName>
    <nameIdentifier schemeURI="https://orcid.org/" nameIdentifierScheme="ORCID">0000-0002-1825-0097</nameIdentifier>
    <affiliation affiliationIdentifier="https://ror.org/05gq02987" affiliationIdentifierScheme="ROR">Brown University</affiliation>
    <affiliation affiliationIdentifier="grid.268117.b" affiliationIdentifierScheme="GRID" schemeURI="https://grid.ac/institutes/">Wesleyan University</affiliation>
</creator>
<contributors>
  <contributor contributorType="ProjectLeader">
  <contributorName>Starr, Joan</contributorName>
  <givenName>Joan</givenName>
  <familyName>Starr</familyName>
  <nameIdentifier schemeURI="https://orcid.org/" nameIdentifierScheme="ORCID">0000-0002-7285-027X</nameIdentifier>
  <affiliation affiliationIdentifier="https://ror.org/03yrm5c26" affiliationIdentifierScheme="ROR">California Digital Library</affiliation>
  </contributor>
</contributors>

Example: Funding reference

Below is an example showing just the fundingReference section for a DataCite DOI.

  • fundingReference element is repeatable, to support describing multiple funding sources
<fundingReferences>
  <fundingReference>
    <funderName>European Commission</funderName>
    <funderIdentifier funderIdentifierType="ROR">https://ror.org/00k4n6c32</funderIdentifier>
    <awardNumber awardURI="https://cordis.europa.eu/project/rcn/100180_en.html">282625</awardNumber>
    <awardTitle>MOTivational strength of ecosystem services and alternative ways to express the value of BIOdiversity</awardTitle>
    </fundingReference>
  <fundingReference>
    <funderName>European Commission</funderName>
    <funderIdentifier funderIdentifierType="ROR">https://ror.org/00k4n6c32</funderIdentifier>
    <awardNumber awardURI="https://cordis.europa.eu/project/rcn/100603_en.html">284382</awardNumber>
    <awardTitle>Institutionalizing global genetic-resource commons. Global Strategies for accessing and using essential public knowledge assets in the life sciences</awardTitle>
  </fundingReference>
</fundingReferences>

For more details see DataCite's schema documentation at https://schema.datacite.org (also available on the DataCite support site)