DOIs in References

In a reference, the DOI of the referenced publication, if known, should be tagged within a <pub-id> element with attribute pub-id-type="doi”.

If a referenced work has a DOI it is highly preferable for the reference to contain the DOI instead of a URL. References that include a correctly tagged DOI can be processed more reliably for linking and citation tracking. Also, URLs are prone to link rot and authentication barriers, whereas DOIs provide some safeguards against link rot and provide a public landing page. The majority of DOIs are for journal articles, although DOIs can be assigned to books, book chapters, reference works, datasets, dissertations, preprints, reports, standards, and other document types. During production, references to journal articles may have a DOI added if a DOI can be located by a Crossref lookup. Crossref lookups are not routinely performed for other publication types, although an author-supplied reference for any publication type may contain a DOI or a DOI-based URL.

Regardless of whether the DOI was included in the reference as provided by the author or added to the reference during production, if a DOI is present in a reference it should be tagged correctly using <pub-id pub-id-type="doi">. The presentation of the DOI may vary as required by the journal’s reference style. For example:

<pub-id pub-id-type="doi">https://doi.org/10.1080/14754835.2015.1103163</pub-id>

doi:<pub-id pub-id-type="doi">10.1080/14754835.2015.1103163</pub-id>

References that contain a DOI may fail Schematron validation if the DOI is not captured correctly. The Schematron rules that perform this validation are JATS-0034-007 and JATS-0034-008.

A validation error will occur if:

  • A reference contains a DOI that is not tagged in a <pub-id pub-id-type="doi"> element
  • <pub-id pub-id-type="doi"> element contains anything other than a bare DOI or DOI URL
  • A reference contains a URL that is based on a DOI but does not point to the doi.org resolver

The following steps can be applied to resolve validation errors that are related to DOIs in references.

  1. If a DOI is untagged within the <mixed-citation> element, add element <pub-id pub-id-type="doi"> around the DOI. This change can be made in the XML only.

    For example, these are invalid

    10.1080/01639374.2021.1998281
    
    doi:10.1080/01639374.2021.1998281
    
    https://doi.org/10.1080/01639374.2021.1998281
    
    http://dx.doi.org/10.1080/01639374.2021.1998281
    

    and should be changed to

    <pub-id pub-id-type="doi">10.1080/01639374.2021.1998281</pub-id>
    
    doi:<pub-id pub-id-type="doi">10.1080/01639374.2021.1998281</pub-id>
    
    <pub-id pub-id-type="doi">https://doi.org/10.1080/01639374.2021.1998281</pub-id>
    
    <pub-id pub-id-type="doi">http://dx.doi.org/10.1080/01639374.2021.1998281</pub-id>
    
  2. If there is any text beside the DOI that is incorrectly captured in <pub-id pub-id-type="doi"> move the text outside the element. This change can be made in the XML only.

    For example, these are invalid

    <pub-id pub-id-type="doi">https://doi.org/10.1080/01639374.2021.1998281.</pub-id>
    
    <pub-id pub-id-type="doi">doi:10.1080/01639374.2021.1998281</pub-id>
    
    <pub-id pub-id-type="doi"> 10.1080/01639374.2021.1998281 </pub-id>
    

    and should be changed to

    <pub-id pub-id-type="doi">https://doi.org/10.1080/01639374.2021.1998281</pub-id>.
    
    doi:<pub-id pub-id-type="doi">10.1080/01639374.2021.1998281</pub-id>
    
    <pub-id pub-id-type="doi">10.1080/01639374.2021.1998281</pub-id>
    
  3. If a DOI URL is tagged in an <ext-link> element change the tagging to replace the <ext-link> element with a <pub-id pub-id-type="doi"> element. This change can be made in the XML only.

    For example, this is invalid

    <ext-link ext-link-type="uri" xlink:href="https://doi.org/10.1080/01639374.2021.1998281" >https://doi.org/10.1080/01639374.2021.1998281</ext-link>
    

    and should be changed to

    <pub-id pub-id-type="doi">https://doi.org/10.1080/01639374.2021.1998281</pub-id>
    
  4. If a DOI URL is incorrectly formatted but still recognizable as a DOI, update the DOI to follow the correct format and be tagged in <pub-id pub-id-type="doi">. This change should be made consistently in both the XML and PDF.

    For example, these are invalid

    <ext-link ext-link-type="uri" xlink:href="https://doi.org/DO&#x130;:10.1136/bmj.k1674" >DO&#x130;:10.1136/bmj.k1674</ext-link>
    
    <pub-id pub-id-type="doi">https://doi.org/https://doi.org/10.1016/j.jcomdis.2021.106135</pub-id>
    

    and should be changed to

    doi:<pub-id pub-id-type="doi">10.1136/bmj.k1674</pub-id>
    
    <pub-id pub-id-type="doi">https://doi.org/10.1016/j.jcomdis.2021.106135</pub-id>
    
  5. If DOI-based URL contains a domain name that is not doi.org, the URL should be corrected to use the DOI Foundation’s resolver at doi.org. Replace all parts of the URL except the DOI to create the DOI URL in the format https://doi.org/{doi}. This change should be made consistently in both the XML and PDF.

    For example, these are invalid

    <pub-id pub-id-type="doi">https://dio.org/10.35594/kata.2010.17.3.005</pub-id>
    
    <ext-link ext-link-type="uri" xlink:href="https://www.tandfonline.com/doi/full/10.1080/01639374.2021.1998281" >https://www.tandfonline.com/doi/full/10.1080/01639374.2021.1998281</ext-link>
    
    <pub-id pub-id-type="doi">https://doi-org.ezaccess.libraries.psu.edu/10.3390/ijerph14111394</pub-id>
    

    and should be changed to

    <pub-id pub-id-type="doi">https://doi.org/10.35594/kata.2010.17.3.005</pub-id>
    
    <pub-id pub-id-type="doi">https://doi.org/10.1080/01639374.2021.1998281</pub-id>
    
    <pub-id pub-id-type="doi">https://doi.org/10.3390/ijerph14111394</pub-id>
    
  6. Try opening the DOI URL to see if it works. The DOI URL should resolve to the object that is being cited. If the DOI URL returns an error then try doing a Crossref lookup to find the correct DOI.

    • If the correct DOI can be found through a Crossref lookup then tag the DOI in <pub-id pub-id-type="doi">. This change should be made consistently in both the XML and PDF.

    • If the DOI returns an error and no DOI can be found through a Crossref lookup, then the URL should be tagged in an <ext-link> element. To prevent a validation error, in the text of the <ext-link> element insert a comment <!-- --> between the “10” and the “.". Keep the original URL in the xlink:href attribute. The comment will not display but will prevent the text from being detected as a DOI. This change can be made in the XML only.

      For example, this is invalid

      <ext-link ext-link-type="uri" xlink:href="https://www.cdc.gov/niosh/surveyreports/pdfs/152-11b.pdf?id=10.26613/NIOSHEPHB15211b" >https://www.cdc.gov/niosh/surveyreports/pdfs/152-11b.pdf?id=10.26613/NIOSHEPHB15211b</ext-link>
      

      and should be changed to

      <ext-link ext-link-type="uri" xlink:href="https://www.cdc.gov/niosh/surveyreports/pdfs/152-11b.pdf?id=10.26613/NIOSHEPHB15211b" >https://www.cdc.gov/niosh/surveyreports/pdfs/152-11b.pdf?id=10<!-- -->.26613/NIOSHEPHB15211b</ext-link>