DOI

Element Description

Choice of:

DOI/DOI: The DOI element stores the DOI (Digital Object Identifier) that identifies the collection.

DOI/Authority: The DOI organization that is responsible for creating the DOI is described in the Authority element.

or

DOI/MissingReason: This element stores the fact that a DOI is not applicable for a record.

DOI/Explanation: This element describes the reason the DOI is not applicable.

Best Practices

Just the DOI string should be provided in the DOI/DOI field. The DOI URL should not be stored here; it should be stored as a RelatedURL. The DOI value should start with the directory indicator.

For ESDIS providers:

The directory indicator for ESDIS is "10"
If the DOI was registered through ESDIS, the beginning of the DOI string should be "10.5067"
The DOI/Authority element value should be "https://doi.org/"
DOI is a required metadata element for ESDIS providers. While the majority of ESDIS datasets will have a DOI, there are certain cases where having a DOI is not appropriate. These cases include near real time datasets and datasets that will soon be replaced by a new version. In the case that a DOI is not applicable for a dataset, the DOI/MissingReason element should be used to indicate this; and the DOI/Explanation element should be used to describe why the dataset was not assigned a DOI.
A list of DOIs registered through ESDIS can be found here: EOSDIS DOIs Status and Listing

Examples:

DOI/DOI: "10.5067/ISS/CATS/L2O_N-M7.1-V2-01_05KMPRO"

DOI/Authority: "https://doi.org/"

DOI/DOI: "10.5067/MEASURES/GWELD/GWELDYR.003"

DOI/Authority: "https://doi.org/"

or

DOI/MissingReason: "Not Applicable"

DOI/Explanation: "The collection is near real time and only exists for a couple of days, therefore, the collection was not assigned a DOI."

DOI/MissingReason: "Not Applicable"

DOI/Explanation: "A new version of this dataset will be released in a month (May 2018). This version will be removed from CMR and the new version will be assigned a DOI."

Element Specification

Choice of:

Model	Element	Type	Constraints	Required?	Cardinality
UMM-C	DOI/DOI	String	? maximum number of characters	Yes	1
UMM-C	DOI/Authority	String	? maximum number of characters	No	0..1

or

Model	Element	Type	Usable Valid Values	Constraints	Required?	Cardinality
UMM-C	DOI/MissingReason	Enumeration	Not Applicable	N/A	Yes	1
UMM-C	DOI/Explanation	String	N/A	? maximum number of characters	No	0..1

ARC Priority Matrix

Priority Categorization	Justification
	This element is categorized as highest priority when: The element is not included at all. The element is included but is empty. The dataset has a DOI but the metadata indicates that it does not. The incorrect DOI is listed for the dataset. The DOI listed leads to a broken link. The DOI is provided in the incorrect format (e.g. as a URL rather than just the DOI string). The DOI/Explanation includes spelling or grammatical errors.
	This element is categorized as medium priority when: The DOI/MissingReason option is used but no DOI/Explanation is provided.
	This element is categorized as low priority when: A DOI is provided but the DOI/Authority element is not provided.
	The element is provided, and follows all applicable criteria specified in the best practices section above.

Dialect Mappings

DIF 9

DIF 9 ^{(Note: DIF-9 is being phased out and will no longer be supported after 2018)}

DIF 10

DIF 10

Choice of:

Specification

Path

Type

Usable Valid Values

Constraints

Required in DIF 10?

Cardinality

Notes

DIF 10

/DIF/Dataset_Citation/Persistent_Identifier/Type

Enumeration

DOI

ARK

n/a

Yes

1

Only DOI will map to CMR. ARK will not map. This element does not directly map to a UMM element - choosing 'DOI' indicates to CMR that the Identifier and Authority elements should be mapped.

DIF 10

/DIF/Dataset_Citation/Persistent_Identifier/Identifier

String

n/a

1 minimum number of characters

80 maximum number of characters

Yes

1

n/a

DIF 10

/DIF/Dataset_Citation/Persistent_Identifier/Authority

String

n/a

1 minimum number of characters

80 maximum number of characters

No

0..1

For ESDIS providers, recommend providing "https://doi.org/" as the DOI authority.

or

Specification	Path	Type	Usable Valid Values	Constraints	Required in DIF 10?	Cardinality	Notes
DIF 10	/DIF/Dataset_Citation/Persistent_Identifier/MissingReason	Enumeration	Not Applicable	n/a	Yes	1	Use this option if a dataset does not have a persistent identifier.
DIF 10	/DIF/Dataset_Citation/Persistent_Identifier/Explanation	String	n/a	?	No	0..1	While not required, it is highly recommended to provide an explanation for why a persistent identifier is not applicable for a dataset.

Enumeration Mapping

DIF 10

Translation

Direction

UMM

Not Applicable

↔

Not Applicable

Example Mapping

DIF 10

<Dataset_Citation>
 ...
  <Persistent_Identifier>
    <Type>DOI</Type>
    <Identifier>10.5067/IAGYM8Q26QRE</Identifier>
    <Authority>https://doi.org/</Authority>
  </Persistent_Identifier>
</Dataset_Citation>

or

<Dataset_Citation>
 ...
  <Persistent_Identifier>
    <MissingReason>Not Applicable</MissingReason>
    <Explanation>The collection is near real time and only exists for a couple of days, therefore, the collection was not assigned a DOI.</Explanation>
  </Persistent_Identifier>
</Dataset_Citation>

UMM

"DOI": {
  "DOI" : "10.5067/IAGYM8Q26QRE",
  "Authority" : "https://doi.org/"
},

or

"DOI": {
  "MissingReason" : "Not Applicable",
  "MissingExplanation" : "The collection is near real time and only exists for a couple of days, therefore, the collection was not assigned a DOI."
},

ECHO 10

ECHO 10

Choice of:

Specification

Path

Type

Constraints

Required in ECHO10?

Cardinality

Notes

ECHO 10

/Collection/DOI/DOI

String

1 minimum number of characters

1024 maximum number of characters

No

0..1

n/a

ECHO 10

/Collection/DOI/Authority

String

1 minimum number of characters

80 maximum number of characters

No

0..1

For ESDIS providers, recommend providing "https://doi.org/" as the DOI authority.

or

Specification	Path	Type	Usable Valid Values	Constraints	Required in ECHO10?	Cardinality	Notes
ECHO 10	/Collection/DOI/MissingReason	Enumeration	Not Applicable	n/a	No	0..1	Use this option if a dataset does not have a DOI.
ECHO 10	/Collection/DOI/Explanation	String	n/a	?	No	0..1	While not required, it is highly recommended to provide an explanation for why a persistent identifier is not applicable for a dataset.

Enumeration Mapping

ECHO 10

Translation

Direction

UMM

Not Applicable

↔

Not Applicable

Example Mapping

ECHO 10

<DOI>
  <DOI>10.5067/IAGYM8Q26QRE</DOI>
  <Authority>https://doi.org/</Authority>
</DOI>

or

<DOI>
  <MissingReason>Not Applicable</MissingReason>
  <Explanation>The collection is near real time and only exists for a couple of days, therefore, the collection was not assigned a DOI.</Explanation>
</DOI>

UMM

"DOI": {
  "DOI" : "10.5067/IAGYM8Q26QRE",
  "Authority" : "https://doi.org/"
},

or

"DOI": {
  "MissingReason" : "Not Applicable",
  "MissingExplanation" : "The collection is near real time and only exists for a couple of days, therefore, the collection was not assigned a DOI."
},

ISO 19115-2 MENDS

ISO 19115-2 MENDS

Choice of:

Specification	Path	Type	Notes
ISO 19115-2 MENDS	/gmi:MI_Metadata/gmd:identificationInfo/gmd:MD_DataIdentification/gmd:citation/gmd:CI_Citation/gmd:identifier/gmd:MD_Identifier/gmd:code/gco:CharacterString	String	Where the DOI string is provided.
	/gmi:MI_Metadata/gmd:identificationInfo/gmd:MD_DataIdentification/gmd:citation/gmd:CI_Citation/gmd:identifier/gmd:MD_Identifier/gmd:codeSpace/gco:CharacterString = gov.nasa.esdis.umm.doi	String	The value of "gov.nasa.esdis.umm.doi" should be provided here so that CMR can properly parse out the DOI.
	/gmi:MI_Metadata/gmd:identificationInfo/gmd:MD_DataIdentification/gmd:citation/gmd:CI_Citation/gmd:identifier/gmd:MD_Identifier/gmd:description/gco:CharacterString contains DOI	String	The value must contain the string "DOI" so that CMR can properly identify and translate the DOI.
ISO 19115-2 MENDS	/gmi:MI_Metadata/gmd:identificationInfo/gmd:MD_DataIdentification/gmd:citation/gmd:CI_Citation/gmd:identifier/gmd:MD_Identifier/gmd:authority/gmd:CI_Citation/gmd:title - empty element	String	Leave this element empty.
	/gmi:MI_Metadata/gmd:identificationInfo/gmd:MD_DataIdentification/gmd:citation/gmd:CI_Citation/gmd:identifier/gmd:MD_Identifier/gmd:authority/gmd:CI_Citation/gmd:date - empty element	String	Leave this element empty.
	/gmi:MI_Metadata/gmd:identificationInfo/gmd:MD_DataIdentification/gmd:citation/gmd:CI_Citation/gmd:identifier/gmd:MD_Identifier/gmd:authority/gmd:CI_Citation/ gmd:citedResponsibleParty/gmd:CI_ResponsibleParty/gmd:organisationName/gco:CharacterString	String	Provide the authority here. For ESDIS providers, recommend listing "https://doi.org" as the DOI authority.
	/gmi:MI_Metadata/gmd:identificationInfo/gmd:MD_DataIdentification/gmd:citation/gmd:CI_Citation/gmd:identifier/gmd:MD_Identifier/gmd:authority/gmd:CI_Citation/ gmd:citedResponsibleParty/gmd:CI_ResponsibleParty/gmd:role/gmd:CI_RoleCode codeList="https://cdn.earthdata.nasa.gov/iso/resources/Codelist/gmxCodelists.xml#CI_RoleCode" codeListValue="" = authority	Codelist	Choose the "authority" codelist value so that CMR can properly identify the DOI/Authority element. This codelist value does not directly map to a UMM element - choosing 'authority' indicates to CMR that the Authority element should be mapped.

or

Specification	Path	Type	Notes
ISO 19115-2 MENDS	/gmi:MI_Metadata/gmd:identificationInfo/gmd:MD_DataIdentification/gmd:citation/gmd:CI_Citation/gmd:identifier/gmd:MD_Identifier/gmd:code nilReason="inapplicable"	Code	This indicates that the DOI is "Not Applicable".
	/gmi:MI_Metadata/gmd:identificationInfo/gmd:MD_DataIdentification/gmd:citation/gmd:CI_Citation/gmd:identifier/gmd:MD_Identifier/gmd:codeSpace/gco:CharacterString = gov.nasa.esdis.umm.doi	String	The value of "gov.nasa.esdis.umm.doi" should be provided here so that CMR can properly parse out the DOI information.
	/gmi:MI_Metadata/gmd:identificationInfo/gmd:MD_DataIdentification/gmd:citation/gmd:CI_Citation/gmd:identifier/gmd:MD_Identifier/gmd:description/gco:CharacterString contains DOI	String	The value must contain the string "DOI" so that CMR can properly identify and translate the DOI information.
ISO 19115-2 MENDS	/gmi:MI_Metadata/gmd:identificationInfo/gmd:MD_DataIdentification/gmd:citation/gmd:CI_Citation/gmd:identifier/gmd:MD_Identifier/gmd:description/gco:CharacterString contains Explanation:	String	If the dataset does not have a DOI, it is highly recommended to provide an explanation why here. The value must contain the string "Explanation:" so that CMR can properly parse out the text.

Enumeration/Code List Mapping

ISO MENDS

Translation

Direction

UMM

inapplicable

↔

Not Applicable

Example Mapping

ISO 19115-2 MENDS

...
<gmd:identifier>
  <gmd:MD_Identifier>
    <gmd:authority>
      <gmd:CI_Citation>
        <gmd:title/>
        <gmd:date/>
        <gmd:citedResponsibleParty>
          <gmd:CI_ResponsibleParty>
            <gmd:organisationName>
              <gco:CharacterString>https://doi.org/</gco:CharacterString>
            </gmd:organisationName>
            <gmd:role>
              <gmd:CI_RoleCode codeList="https://cdn.earthdata.nasa.gov/iso/resources/Codelist/gmxCodelists.xml#CI_RoleCode" codeListValue="">authority</gmd:CI_RoleCode>
            </gmd:role>
          </gmd:CI_ResponsibleParty>
        </gmd:citedResponsibleParty>
      </gmd:CI_Citation>
  </gmd:authority>
    <gmd:code>
      <gco:CharacterString>10.5067/IAGYM8Q26QRE</gco:CharacterString>
    </gmd:code>
    <gmd:codeSpace>
      <gco:CharacterString>gov.nasa.esdis.umm.doi</gco:CharacterString>
    </gmd:codeSpace>
    <gmd:description>
      <gco:CharacterString>A Digital Object Identifier (DOI)</gco:CharacterString>
    </gmd:description>
  </gmd:MD_Identifier>
</gmd:identifier>
...
 
or
 
...
<gmd:identifier>
  <gmd:MD_Identifier>
    <gmd:code gco:nilReason="inapplicable"/>
      </gmd:code>
    <gmd:codeSpace>
      <gco:CharacterString>gov.nasa.esdis.umm.doi</gco:CharacterString>
    </gmd:codeSpace>
    <gmd:description>
      <gco:CharacterString>DOI Explanation: The collection is near real time and only exists for a couple of days, therefore, the collection was not assigned a DOI.</gco:CharacterString>
    </gmd:description>
  </gmd:MD_Identifier>
</gmd:identifier>
...

UMM

"DOI": {
  "DOI" : "10.5067/IAGYM8Q26QRE",
  "Authority" : "https://doi.org/"
},

or

"DOI": {
  "MissingReason" : "Not Applicable",
  "MissingExplanation" : "The collection is near real time and only exists for a couple of days, therefore, the collection was not assigned a DOI."
},

ISO 19115-2 SMAP

ISO 19115-2 SMAP

Choice of:

Specification

Path

Type

Notes

ISO 19115-2 SMAP

String

or

Specification

Path

Type

Notes

ISO 19115-2 SMAP

String

Enumeration/Code List Mapping

ISO SMAP

Translation

Direction

UMM

inapplicable

↔

Not Applicable

Example Mapping

ISO 19115-2 SMAP

UMM

"DOI": {
  "DOI" : "10.5067/IAGYM8Q26QRE",
  "Authority" : "https://doi.org/"
},

or

"DOI": {
  "MissingReason" : "Not Applicable",
  "MissingExplanation" : "The collection is near real time and only exists for a couple of days, therefore, the collection was not assigned a DOI."
},

UMM Migration

None

Future Mappings

ISO 19115-1

ISO 19115-1

Choice of:

Specification	Path	Type	Notes
ISO 19115-1		String

or

Specification

Path

Type

Notes

ISO 19115-1

String

Enumeration/Code List Mapping

ISO 19115-1

Translation

Direction

UMM

inapplicable

↔

Not Applicable

ISO 19115-1

UMM

"DOI": {
  "DOI" : "10.5067/IAGYM8Q26QRE",
  "Authority" : "https://doi.org/"
},

or

"DOI": {
  "MissingReason" : "Not Applicable",
  "MissingExplanation" : "The collection is near real time and only exists for a couple of days, therefore, the collection was not assigned a DOI."
},

History

UMM Versioning

Version	Date	What Changed
1.0.0		Initial Release

ARC Documentation

Version	Date	What Changed	Author
1.0	4/30/18	Recommendations/priority matrix transferred from internal ARC documentation to wiki space	Jeanne' le Roux

Page tree

DOI

Element Description

Best Practices

Element Specification

ARC Priority Matrix

Dialect Mappings

UMM Migration

Future Mappings

History

UMM Versioning

ARC Documentation