Specification

Required fields

The following fields are required fields. These fields MUST be filled out in a metadata instance for the instance to be valid.

Data File Titles >> Title

Data File Parent Studies >> PHS Identifier

Recommended fields

The following fields are recommended fields. These fields SHOULD be filled out in a metadata instance to greatly increase the likelihood of the associated data file being found by interested parties and to provide proper accreditation for the creators of the file.

Data File Identity >> Identifier

Data File Identity >> File Name

Data File Identity >> Version

Data File Identity >> SHA256 digest

Data File Subjects >> Subject Identifier

Data File Descriptions >> Description

Data File Descriptions >> Type Of Content

Data File Creators >> Creator Type

Data File Creators >> Creator Name

Data File Creators >> Creator Given Name

Data File Creators >> Creator Family Name

Data File Creators >> Creator Identifier

Data File Creators >> Creator Email

Data File Creators >> Creator Affiliation

Data File Creators >> Creator Role

Data File Parent Studies >> Study Identifier

Data File Parent Studies >> Study Name

Data File Funding Sources >> Award Local Identifier

Data File Funding Sources >> Funder Name

Data File Funding Sources >> Funder Identifier

Data File Titles

Multi-valued

A list of names or titles of the Data File being described. At least one Data File Title is required. Mutliple values may be specified to provide titles in different languages.

Title

Required

A title or descriptive name by which the Data File being described is known. This is a presentation name (i.e. title case with appropriate spacing) and is typically different from the actual file name of the data file.

Multiple titles and different languages may be specified by repeating this element. The language for a given title is specified with the Language field.

Example

COVID-19 Booster Shot Side Effects Survey Responses

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Title" : "http://purl.org/radx-terms/metadata-terms/title"
  },
  "Title" : {
    "@value" : "COVID-19 Booster Shot Side Effects Survey Responses"
  }
}

Language

Optional

The language tag that identifies the language in which the Data File Title is provided. Languages are identified using codes that are structured in accordance with RFC 5646. If no value is specified then the default code of en for English is assumed.

The value of this field is a language code. See the language code table for a list of possible language codes.

Example

en

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Language" : "http://purl.org/radx-terms/metadata-terms/language"
  },
  "Language" : {
    "@value" : "en"
  }
}

Example element in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Data File Titles" : "http://purl.org/radx-terms/metadata-terms/titleDescriptor"
  },
  "@id" : "",
  "Data File Titles" : [ {
    "@context" : {
      "Title" : "http://purl.org/radx-terms/metadata-terms/title",
      "Language" : "http://purl.org/radx-terms/metadata-terms/language"
    },
    "Title" : {
      "@value" : "COVID-19 Booster Shot Side Effects Survey Responses"
    },
    "Language" : {
      "@value" : "en"
    }
  } ]
}

Data File Identity

Information used to identify the Data File being described.

Identifier

Recommended

A globally unique string that identifies the Data File being described. It is typically a DOI (Digital Object Identifier) or IRI (International Resource Identifier, or Web address). The identifier is typically generated by data providers or data publishers who wish to have a citable and Web-accessible resource.

Example DOIs are doi:10.1000/182 or https://doi.org/10.1000/182, both of which identify the DOI Handbook, which has a DOI of 10.1000/182

Example

http://doi.org/10.1000/182

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Identifier" : "http://purl.org/radx-terms/metadata-terms/identifier"
  },
  "Identifier" : {
    "@value" : "http://doi.org/10.1000/182"
  }
}

Identifier Type

Optional

The identifier type used to identify the resource being described.

This need not be provided if the identifier is either a DOI that begins with "doi:" or "https://doi.org/", or it is an IRI that begins with either "http://" or "https://"

Values for this field are taken from the FDC-GDMT ontology. You may use BioPortal to search for values for this field.

ARK | arXiv | bibcode | DOI | EAN13 | EISSN | Handle | IGSN | IRI | ISBN | ISSN | ISTC | LISSN | LSID | PMID | PURL | UPC | URI | URL | URN | w3id

Example

DOI

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Identifier Type" : "http://purl.org/radx-terms/metadata-terms/identifierType"
  },
  "Identifier Type" : {
    "rdfs:label" : "DOI",
    "@id" : "http://vocab.fairdatacollective.org/gdmt/DOI"
  }
}

File Name

Recommended

The local name of the resource (for example, in a file-based operating system or web service).

Example

COVID-19_Booster_Shot_June_2022_Responses.csv

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "File Name" : "http://purl.org/radx-terms/metadata-terms/fileName"
  },
  "File Name" : {
    "@value" : "COVID-19_Booster_Shot_June_2022_Responses.csv"
  }
}

Version

Recommended

The string identifying the version of the data file or other resource being described.

This field accepts any version string, but we suggest that you use semantic versioning of the form major.minor.patch. for example, 2.1.4.

Example

1.0.1

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Version" : "http://purl.org/radx-terms/metadata-terms/version"
  },
  "Version" : {
    "@value" : "1.0.1"
  }
}

SHA256 digest

Recommended

A SHA256 digest of the Data File contents. This is a 64 characters long hexadecimal string.

For example, the SHA256 digest of the string, "RADx Data Hub" is ebff8d3da88b292622d3bfc36bdac4c4537ddc56cb07f344c5223d6b6f9cd011.

On macOS the following command may be used to generate the SHA256 digest of a file.

shasum -a 256 /path/to/file

Example

ebff8d3da88b292622d3bfc36bdac4c4537ddc56cb07f344c5223d6b6f9cd011

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "SHA256 digest" : "https://purl.org/radx-terms/sha256"
  },
  "SHA256 digest" : {
    "@value" : "ebff8d3da88b292622d3bfc36bdac4c4537ddc56cb07f344c5223d6b6f9cd011"
  }
}

Example element in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Data File Identity" : "http://purl.org/radx-terms/metadata-terms/identityDescriptor"
  },
  "@id" : "",
  "Data File Identity" : {
    "@context" : {
      "Identifier" : "http://purl.org/radx-terms/metadata-terms/identifier",
      "Identifier Type" : "http://purl.org/radx-terms/metadata-terms/identifierType",
      "File Name" : "http://purl.org/radx-terms/metadata-terms/fileName",
      "Version" : "http://purl.org/radx-terms/metadata-terms/version",
      "SHA256 digest" : "https://purl.org/radx-terms/sha256"
    },
    "Identifier" : {
      "@value" : "http://doi.org/10.1000/182"
    },
    "Identifier Type" : {
      "@id" : "http://vocab.fairdatacollective.org/gdmt/DOI"
    },
    "File Name" : {
      "@value" : "COVID-19_Booster_Shot_June_2022_Responses.csv"
    },
    "Version" : {
      "@value" : "1.0.1"
    },
    "SHA256 digest" : {
      "@value" : "ebff8d3da88b292622d3bfc36bdac4c4537ddc56cb07f344c5223d6b6f9cd011"
    }
  }
}

Data File Language

Language in which the data file being described is provided.

Primary Language

Optional

Primary language used to present the data file (if multiple languages are present, the Other Languages field may be used to add additional languages).

The value of this field is a language code. See the language code table for a list of possible language codes.

Example

en

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Primary Language" : "http://purl.org/radx-terms/metadata-terms/primaryLanguage"
  },
  "Primary Language" : {
    "@value" : "en"
  }
}

Other Languages

Optional Multi-valued

A list of other, non-primary, languages in which the data file being described is provided.

The value of this field is a language code. See the language code table for a list of possible language codes.

Example

es

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Other Languages" : "http://purl.org/radx-terms/metadata-terms/otherLanguage"
  },
  "Other Languages" : [ {
    "@value" : "es"
  } ]
}

Example element in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Data File Language" : "http://purl.org/radx-terms/metadata-terms/languageDescriptor"
  },
  "@id" : "",
  "Data File Language" : {
    "@context" : {
      "Primary Language" : "http://purl.org/radx-terms/metadata-terms/primaryLanguage",
      "Other Languages" : "http://purl.org/radx-terms/metadata-terms/otherLanguage"
    },
    "Primary Language" : {
      "@value" : "en"
    },
    "Other Languages" : [ {
      "@value" : "es"
    } ]
  }
}

Data File Subjects

Multi-valued

A list of concepts (keywords, classification, or free text terms) that define the data file or purpose (subjects which can be addressed) using the data file.

Subject Identifier

Recommended

The Medical Subject Headings (MeSH) subject code that identifies a classification subject that is pertinent to the data file.

Values for this field are taken from the MESH ontology. You may use BioPortal to search for values for this field.

Example

COVID-19 vaccine booster shot

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Subject Identifier" : "http://purl.org/radx-terms/metadata-terms/subjectIdentifier"
  },
  "Subject Identifier" : {
    "rdfs:label" : "COVID-19 vaccine booster shot",
    "@id" : "http://purl.bioontology.org/ontology/MESH/C000719227"
  }
}

Subject Identifier Scheme

Derived Optional

This value is derived This field should not be manually specified or edited.

The name of the scheme or authority used for the Subject Identifier.

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Subject Identifier Scheme" : "http://purl.org/radx-terms/metadata-terms/subjectIdentifierScheme"
  },
  "Subject Identifier Scheme" : {
    "@value" : "http://purl.bioontology.org/ontology/MESH"
  }
}

Keyword

Optional

Free text subject, keyword, classification code, or key phrase describing the data file or purpose for which the data file can be used. While MeSH codes are the preferred form of specifying subjects this free text field may be used for codes or subject keywords that do not have a corresponding MeSH terms.

Example

COVID-19 vaccine booster shot

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Keyword" : "http://purl.org/radx-terms/metadata-terms/keyword"
  },
  "Keyword" : {
    "@value" : "COVID-19 vaccine booster shot"
  }
}

Example element in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Data File Subjects" : "http://purl.org/radx-terms/metadata-terms/subjectsAndKeywordsDescriptor"
  },
  "@id" : "",
  "Data File Subjects" : [ {
    "@context" : {
      "Subject Identifier" : "http://purl.org/radx-terms/metadata-terms/subjectIdentifier",
      "Subject Identifier Scheme" : "http://purl.org/radx-terms/metadata-terms/subjectIdentifierScheme",
      "Keyword" : "http://purl.org/radx-terms/metadata-terms/keyword"
    },
    "Subject Identifier" : {
      "@id" : "http://purl.bioontology.org/ontology/MESH/C000719227"
    },
    "Subject Identifier Scheme" : {
      "@value" : "http://purl.bioontology.org/ontology/MESH"
    },
    "Keyword" : {
      "@value" : "COVID-19 vaccine booster shot"
    }
  } ]
}

Data File Descriptions

Multi-valued

A list of summaries of the Data File and its contents.

Description

Recommended

An account of the resource contained in the Data File; may include but is not limited to: an abstract, a table of contents, a graphical representation, or a free-text account of the resource.

Example

This dataset provides responses from a survey carried out in June 2022 whose purpose was to ascertain side-effects of receiving the COVID-19 booster shot.

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Description" : "http://purl.org/radx-terms/metadata-terms/description"
  },
  "Description" : {
    "@value" : "This dataset provides responses from a survey carried out in June 2022 whose purpose was to ascertain side-effects of receiving the COVID-19 booster shot."
  }
}

Description Language

Optional

Language in which the Data File description is provided. The default value is en for English.

The value of this field is a language code. See the language code table for a list of possible language codes.

Example

en

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Description Language" : "http://purl.org/radx-terms/metadata-terms/language"
  },
  "Description Language" : {
    "@value" : "en"
  }
}

Type Of Content

Derived Recommended

This value is always the same. This field should not be manually specified or edited.

This is the type of digital object being described, which for RADx Data Files is always Dataset.

Example

Dataset

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Type Of Content" : "http://purl.org/radx-terms/metadata-terms/typeOfContent"
  },
  "Type Of Content" : {
    "rdfs:label" : "Dataset",
    "@id" : "http://vocab.fairdatacollective.org/gdmt/Dataset"
  }
}

Example element in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Data File Descriptions" : "http://purl.org/radx-terms/metadata-terms/descriptionDescriptor"
  },
  "@id" : "",
  "Data File Descriptions" : [ {
    "@context" : {
      "Description" : "http://purl.org/radx-terms/metadata-terms/description",
      "Description Language" : "http://purl.org/radx-terms/metadata-terms/language",
      "Type Of Content" : "http://purl.org/radx-terms/metadata-terms/typeOfContent"
    },
    "Description" : {
      "@value" : "This dataset provides responses from a survey carried out in June 2022 whose purpose was to ascertain side-effects of receiving the COVID-19 booster shot."
    },
    "Description Language" : {
      "@value" : "en"
    },
    "Type Of Content" : {
      "@id" : "http://vocab.fairdatacollective.org/gdmt/Dataset"
    }
  } ]
}

Data File Data Dictionary

Information about the Data Dictionary associated with the Data File

Data Dictionary File Name

Optional

The file name of the Data Dictionary file that defines the Data File's data elements.

Each Data File submitted should have its own data dictionary. For example, survery_results_origcopy.csv and survery_results_transformcopy.csv should both have data dictionary files (survery_results_origcopy_DICT.csv and survery_results_transformcopy_DICT.csv) associated with them.

Example

COVID-19_Booster_Shot_June_2022_Responses--DICT.csv

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Data Dictionary File Name" : "http://purl.org/radx-terms/metadata-terms/dataDictionaryFileName"
  },
  "Data Dictionary File Name" : {
    "@value" : "COVID-19_Booster_Shot_June_2022_Responses--DICT.csv"
  }
}

Example element in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Data File Data Dictionary" : "http://purl.org/radx-terms/metadata-terms/dataDictionaryDescriptor"
  },
  "@id" : "",
  "Data File Data Dictionary" : {
    "@context" : {
      "Data Dictionary File Name" : "http://purl.org/radx-terms/metadata-terms/dataDictionaryFileName"
    },
    "Data Dictionary File Name" : {
      "@value" : "COVID-19_Booster_Shot_June_2022_Responses--DICT.csv"
    }
  }
}

Data File Creators

Multi-valued

A list of people and/or organizations that created the data file.

Creator Type

Recommended

The type of the creator. This is either a Person or an Organization.

Values for this field are taken from the FDC-GDMT ontology. You may use BioPortal to search for values for this field.

Organization | Person

Example

Person

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Creator Type" : "http://purl.org/radx-terms/metadata-terms/creatorType"
  },
  "Creator Type" : {
    "rdfs:label" : "Person",
    "@id" : "http://vocab.fairdatacollective.org/gdmt/Person"
  }
}

Creator Name

Recommended

The full name of the creator. For a person this is the combination of the given name and family name, in the appropriate order.

Example

Josiah Carberry

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Creator Name" : "http://purl.org/radx-terms/metadata-terms/creatorName"
  },
  "Creator Name" : {
    "@value" : "Josiah Carberry"
  }
}

Creator Given Name

Recommended

If the creator is a person, the personal name(s) of the creator (e.g., first and optionally middle name in Western languagues, optionally middle and last name in Asian languages).

Example

Josiah

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Creator Given Name" : "http://purl.org/radx-terms/metadata-terms/creatorGivenName"
  },
  "Creator Given Name" : {
    "@value" : "Josiah"
  }
}

Creator Family Name

Recommended

If the creator is a person, the surname(s) of the creator (e.g., last name in Western languagues, first name in Asian languages).

Example

Carberry

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Creator Family Name" : "http://purl.org/radx-terms/metadata-terms/creatorFamilyName"
  },
  "Creator Family Name" : {
    "@value" : "Carberry"
  }
}

Creator Identifier

Recommended

Globally unique string that identifies the creator (an individual or legal entity). For individuals, this is typically an ORCID; for research organizations, it is typically an ROR.

The ORCID iD is an https IRI with a 16-digit number that is compatible with the ISO Standard (ISO 27729), also known as the International Standard Name Identifier (ISNI), e.g. https://orcid.org/0000-0001-2345-6789

ORCID provides a persistent digital identifier (an ORCID iD) that distinguishes each researcher from every other researcher. You can connect your iD with your professional information—affiliations, grants, publications, peer review, and more. You can use your iD to share your information with other systems, ensuring you get recognition for all your contributions, saving you time and hassle, and reducing the risk of errors.

The ROR is an https IRI that uniquely identifies most research organizatiions.

The Research Organization Registry (ROR) is a community-led project to develop an open, sustainable, usable, and unique identifier for every research organization in the world.

Example

https://orcid.org/0000-0002-1825-0097

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Creator Identifier" : "http://purl.org/radx-terms/metadata-terms/creatorIdentifier"
  },
  "Creator Identifier" : {
    "@value" : "https://orcid.org/0000-0002-1825-0097"
  }
}

Creator Identifier Scheme

Optional

Values for this field are taken from the FDC-GDMT ontology. You may use BioPortal to search for values for this field.

Example

ORCID

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Creator Identifier Scheme" : "http://purl.org/radx-terms/metadata-terms/creatorIdentifierScheme"
  },
  "Creator Identifier Scheme" : {
    "rdfs:label" : "ORCID",
    "@id" : "https://orcid.org/"
  }
}

Creator Email

Recommended

The email address of the creator.

Example

josiah.carberry@example.com

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Creator Email" : "http://purl.org/radx-terms/metadata-terms/creatorEmail"
  },
  "Creator Email" : {
    "@value" : "josiah.carberry@example.com"
  }
}

Creator Affiliation

Recommended

If the creator is a Person who is affiliated with an instition then this field should specify the institution.

Example

Brown University

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Creator Affiliation" : "http://purl.org/radx-terms/metadata-terms/creatorAffiliation"
  },
  "Creator Affiliation" : {
    "@value" : "Brown University"
  }
}

Creator Affiliation Identifier

Optional

Globally unique string that identifies the organizational affiliation of the contributor.

We suggest that you an identifier from the Research Organization Registry (ROR), a community-led project to develop an open, sustainable, usable, and unique identifier for every research organization in the world.

Example

https://ror.org/05gq02987

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Creator Affiliation Identifier" : "http://purl.org/radx-terms/metadata-terms/creatorAffiliationIdentifier"
  },
  "Creator Affiliation Identifier" : {
    "@value" : "https://ror.org/05gq02987"
  }
}

Creator Affiliation Identifier Scheme

Optional

The name of the scheme or authority used for the Creator Affiliation Identifier.

Values for this field are taken from the FDC-GDMT ontology. You may use BioPortal to search for values for this field.

Example

ROR

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Creator Affiliation Identifier Scheme" : "http://purl.org/radx-terms/metadata-terms/creatorAffiliationIdentifierScheme"
  },
  "Creator Affiliation Identifier Scheme" : {
    "rdfs:label" : "ROR",
    "@id" : "https://ror.org"
  }
}

Creator Role

Recommended

The role of the Person or the Organization in relation to the data file creation.

Values for this field are taken from the FDC-GDMT ontology. You may use BioPortal to search for values for this field.

Example

Data Manager

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Creator Role" : "http://purl.org/radx-terms/metadata-terms/creatorRole"
  },
  "Creator Role" : {
    "rdfs:label" : "Data Manager",
    "@id" : "http://vocab.fairdatacollective.org/gdmt/DataManager"
  }
}

Example element in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Data File Creators" : "http://purl.org/radx-terms/metadata-terms/creatorDescriptor"
  },
  "@id" : "",
  "Data File Creators" : [ {
    "@context" : {
      "Creator Type" : "http://purl.org/radx-terms/metadata-terms/creatorType",
      "Creator Name" : "http://purl.org/radx-terms/metadata-terms/creatorName",
      "Creator Given Name" : "http://purl.org/radx-terms/metadata-terms/creatorGivenName",
      "Creator Family Name" : "http://purl.org/radx-terms/metadata-terms/creatorFamilyName",
      "Creator Identifier" : "http://purl.org/radx-terms/metadata-terms/creatorIdentifier",
      "Creator Identifier Scheme" : "http://purl.org/radx-terms/metadata-terms/creatorIdentifierScheme",
      "Creator Email" : "http://purl.org/radx-terms/metadata-terms/creatorEmail",
      "Creator Affiliation" : "http://purl.org/radx-terms/metadata-terms/creatorAffiliation",
      "Creator Affiliation Identifier" : "http://purl.org/radx-terms/metadata-terms/creatorAffiliationIdentifier",
      "Creator Affiliation Identifier Scheme" : "http://purl.org/radx-terms/metadata-terms/creatorAffiliationIdentifierScheme",
      "Creator Role" : "http://purl.org/radx-terms/metadata-terms/creatorRole"
    },
    "Creator Type" : {
      "@id" : "http://vocab.fairdatacollective.org/gdmt/Person"
    },
    "Creator Name" : {
      "@value" : "Josiah Carberry"
    },
    "Creator Given Name" : {
      "@value" : "Josiah"
    },
    "Creator Family Name" : {
      "@value" : "Carberry"
    },
    "Creator Identifier" : {
      "@value" : "https://orcid.org/0000-0002-1825-0097"
    },
    "Creator Identifier Scheme" : {
      "@id" : "https://orcid.org/"
    },
    "Creator Email" : {
      "@value" : "josiah.carberry@example.com"
    },
    "Creator Affiliation" : {
      "@value" : "Brown University"
    },
    "Creator Affiliation Identifier" : {
      "@value" : "https://ror.org/05gq02987"
    },
    "Creator Affiliation Identifier Scheme" : {
      "@id" : "https://ror.org"
    },
    "Creator Role" : {
      "@id" : "http://vocab.fairdatacollective.org/gdmt/DataManager"
    }
  } ]
}

Multi-valued

A list of resources related to the Data File being described. Resources may be publications, manuals, depositories, web pages, or other entities that related to this data set and its creation and use.

Optional

A globally unique string that identifies a resource that is related to the data file being described. Typically this is an IRI representing a Web page, but it can be some other type of unique identifier that identifies any digital or non-digital resource.

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Related Resource Identifier" : "http://purl.org/radx-terms/metadata-terms/relatedResourceIdentifier"
  },
  "Related Resource Identifier" : {
    "@value" : null
  }
}

Optional

The identifier type used to identify the related resource.

Values for this field are taken from the FDC-GDMT ontology. You may use BioPortal to search for values for this field.

ARK | arXiv | bibcode | DOI | EAN13 | EISSN | Handle | IGSN | IRI | ISBN | ISSN | ISTC | LISSN | LSID | PMID | PURL | UPC | URI | URL | URN | w3id

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Related Resource Identifier Type" : "http://purl.org/radx-terms/metadata-terms/relatedResourceIdentifierType"
  },
  "Related Resource Identifier Type" : { }
}

Optional

The local name of the related resource file (given by the operating system or web service), or for non-digital resources, the local name used to refer to it.

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Related Resource File Name" : "http://purl.org/radx-terms/metadata-terms/relatedResourceFileName"
  },
  "Related Resource File Name" : {
    "@value" : null
  }
}

Optional

Categorical type of the resource being described. (Corresponds to DataCite's resourceTypeGeneral.) For publications about the Data File, choose Text; for any other related publications, choose Text. For the Data Dictionary, choose Other Resource.

Values for this field are taken from the FDC-GDMT ontology. You may use BioPortal to search for values for this field.

Example

Text

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Related Resource Type Category" : "http://purl.org/radx-terms/metadata-terms/relatedResourceTypeCategory"
  },
  "Related Resource Type Category" : {
    "rdfs:label" : "Text",
    "@id" : "http://vocab.fairdatacollective.org/gdmt/Text"
  }
}

Optional

Description of the relationship of the related resource to the Data File being described.

Example

The publication describes how the data file is constructed and can be used.

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Related Resource Relation" : "http://purl.org/radx-terms/metadata-terms/relatedResourceRelation"
  },
  "Related Resource Relation" : {
    "@value" : "The publication describes how the data file is constructed and can be used."
  }
}

Example element in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Data File Related Resources" : "http://purl.org/radx-terms/metadata-terms/relatedResourceDescriptor"
  },
  "@id" : "",
  "Data File Related Resources" : [ {
    "@context" : {
      "Related Resource Identifier" : "http://purl.org/radx-terms/metadata-terms/relatedResourceIdentifier",
      "Related Resource Identifier Type" : "http://purl.org/radx-terms/metadata-terms/relatedResourceIdentifierType",
      "Related Resource File Name" : "http://purl.org/radx-terms/metadata-terms/relatedResourceFileName",
      "Related Resource Type Category" : "http://purl.org/radx-terms/metadata-terms/relatedResourceTypeCategory",
      "Related Resource Relation" : "http://purl.org/radx-terms/metadata-terms/relatedResourceRelation"
    },
    "Related Resource Identifier" : {
      "@value" : null
    },
    "Related Resource Identifier Type" : { },
    "Related Resource File Name" : {
      "@value" : null
    },
    "Related Resource Type Category" : {
      "@id" : "http://vocab.fairdatacollective.org/gdmt/Text"
    },
    "Related Resource Relation" : {
      "@value" : "The publication describes how the data file is constructed and can be used."
    }
  } ]
}

Data File Contributors

Multi-valued

A list of people and/or organizations that contributed in bringing into existence the data file being described. While data file creators are also contributors, data file creators should be provided in the Data File Creator section instead of here

Contributor Type

Optional

The type of the contributor of the described data file (person or organization).

Values for this field are taken from the FDC-GDMT ontology. You may use BioPortal to search for values for this field.

Organization | Person

Example

Person

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Contributor Type" : "http://purl.org/radx-terms/metadata-terms/contributorType"
  },
  "Contributor Type" : {
    "rdfs:label" : "Person",
    "@id" : "http://vocab.fairdatacollective.org/gdmt/Person"
  }
}

Contributor Name

Optional

The full name of the contributor.

Example

Josiah Carberry

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Contributor Name" : "http://purl.org/radx-terms/metadata-terms/contributorName"
  },
  "Contributor Name" : {
    "@value" : "Josiah Carberry"
  }
}

Contributor Given Name

Optional

If the contributor is a person, the personal name(s) of the contributor (e.g., first and optionally middle name in Western languagues, optionally middle and last name in Asian languages).

Example

Josiah

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Contributor Given Name" : "http://purl.org/radx-terms/metadata-terms/contributorGivenName"
  },
  "Contributor Given Name" : {
    "@value" : "Josiah"
  }
}

Contributor Family Name

Optional

If the contributor is a person, the surname(s) of the conributor (e.g., last name in Western languagues, first name in Asian languages).

Example

Carberry

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Contributor Family Name" : "http://purl.org/radx-terms/metadata-terms/contributorFamilyName"
  },
  "Contributor Family Name" : {
    "@value" : "Carberry"
  }
}

Contributor Identifier

Optional

Globally unique string that identifies the contributor (an individual or legal entity). For individuals, this is typically an ORCID; for research organizations, it is typically an ROR.

The ORCID iD is an https IRI with a 16-digit number that is compatible with the ISO Standard (ISO 27729), also known as the International Standard Name Identifier (ISNI), e.g. https://orcid.org/0000-0001-2345-6789

ORCID provides a persistent digital identifier (an ORCID iD) that distinguishes each researcher from every other researcher. You can connect your iD with your professional information—affiliations, grants, publications, peer review, and more. You can use your iD to share your information with other systems, ensuring you get recognition for all your contributions, saving you time and hassle, and reducing the risk of errors.

The ROR is an https IRI that uniquely identifies most research organizatiions.

The Research Organization Registry (ROR) is a community-led project to develop an open, sustainable, usable, and unique identifier for every research organization in the world.

Example

https://orcid.org/0000-0002-1825-0097

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Contributor Identifier" : "http://purl.org/radx-terms/metadata-terms/contributorIdentifier"
  },
  "Contributor Identifier" : {
    "@value" : "https://orcid.org/0000-0002-1825-0097"
  }
}

Contributor Identifier Scheme

Optional

The name of the scheme or authority used for the Contributor Identifier.

Values for this field are taken from the FDC-GDMT ontology. You may use BioPortal to search for values for this field.

Example

ORCID

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Contributor Identifier Scheme" : "http://purl.org/radx-terms/metadata-terms/contributorIdentifierScheme"
  },
  "Contributor Identifier Scheme" : {
    "rdfs:label" : "ORCID",
    "@id" : "https://orcid.org"
  }
}

Contributor Affiliation

Optional

If the contributor is a person, the organizational or institutional affiliation of the contributor.

Example

Brown University

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Contributor Affiliation" : "http://purl.org/radx-terms/metadata-terms/contributorAffiliation"
  },
  "Contributor Affiliation" : {
    "@value" : "Brown University"
  }
}

Contributor Affiliation Identifier

Optional

Globally unique string that identifies the organizational affiliation of the contributor.

We suggest that you an identifier from the Research Organization Registry (ROR), a community-led project to develop an open, sustainable, usable, and unique identifier for every research organization in the world.

Example

https://ror.org/05gq02987

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Contributor Affiliation Identifier" : "http://purl.org/radx-terms/metadata-terms/contributorAffiliationIdentifier"
  },
  "Contributor Affiliation Identifier" : {
    "@value" : "https://ror.org/05gq02987"
  }
}

Contributor Affiliation Identifier Scheme

Optional

The name of the scheme or authority used for the Contributor Affiliation Identifier.

Values for this field are taken from the FDC-GDMT ontology. You may use BioPortal to search for values for this field.

Example

ROR

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Contributor Affiliation Identifier Scheme" : "http://purl.org/radx-terms/metadata-terms/contributorAffiliationIdentifierScheme"
  },
  "Contributor Affiliation Identifier Scheme" : {
    "rdfs:label" : "ROR",
    "@id" : "https://ror.org"
  }
}

Contributor Email

Optional

An email address of the contributor.

Example

josiah.carberry@example.com

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Contributor Email" : "http://purl.org/radx-terms/metadata-terms/contributorEmail"
  },
  "Contributor Email" : {
    "@value" : "josiah.carberry@example.com"
  }
}

Contributor Role

Optional

The role of the contributor in bringing the described data file into existence.

Values for this field are taken from the FDC-GDMT ontology. You may use BioPortal to search for values for this field.

Example

Data Collector

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Contributor Role" : "http://purl.org/radx-terms/metadata-terms/contributorRole"
  },
  "Contributor Role" : {
    "rdfs:label" : "Data Collector",
    "@id" : "http://vocab.fairdatacollective.org/gdmt/DataCollector"
  }
}

Example element in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Data File Contributors" : "http://purl.org/radx-terms/metadata-terms/contributorDescriptor"
  },
  "@id" : "",
  "Data File Contributors" : [ {
    "@context" : {
      "Contributor Type" : "http://purl.org/radx-terms/metadata-terms/contributorType",
      "Contributor Name" : "http://purl.org/radx-terms/metadata-terms/contributorName",
      "Contributor Given Name" : "http://purl.org/radx-terms/metadata-terms/contributorGivenName",
      "Contributor Family Name" : "http://purl.org/radx-terms/metadata-terms/contributorFamilyName",
      "Contributor Identifier" : "http://purl.org/radx-terms/metadata-terms/contributorIdentifier",
      "Contributor Identifier Scheme" : "http://purl.org/radx-terms/metadata-terms/contributorIdentifierScheme",
      "Contributor Affiliation" : "http://purl.org/radx-terms/metadata-terms/contributorAffiliation",
      "Contributor Affiliation Identifier" : "http://purl.org/radx-terms/metadata-terms/contributorAffiliationIdentifier",
      "Contributor Affiliation Identifier Scheme" : "http://purl.org/radx-terms/metadata-terms/contributorAffiliationIdentifierScheme",
      "Contributor Email" : "http://purl.org/radx-terms/metadata-terms/contributorEmail",
      "Contributor Role" : "http://purl.org/radx-terms/metadata-terms/contributorRole"
    },
    "Contributor Type" : {
      "@id" : "http://vocab.fairdatacollective.org/gdmt/Person"
    },
    "Contributor Name" : {
      "@value" : "Josiah Carberry"
    },
    "Contributor Given Name" : {
      "@value" : "Josiah"
    },
    "Contributor Family Name" : {
      "@value" : "Carberry"
    },
    "Contributor Identifier" : {
      "@value" : "https://orcid.org/0000-0002-1825-0097"
    },
    "Contributor Identifier Scheme" : {
      "@id" : "https://orcid.org"
    },
    "Contributor Affiliation" : {
      "@value" : "Brown University"
    },
    "Contributor Affiliation Identifier" : {
      "@value" : "https://ror.org/05gq02987"
    },
    "Contributor Affiliation Identifier Scheme" : {
      "@id" : "https://ror.org"
    },
    "Contributor Email" : {
      "@value" : "josiah.carberry@example.com"
    },
    "Contributor Role" : {
      "@id" : "http://vocab.fairdatacollective.org/gdmt/DataCollector"
    }
  } ]
}

Data File Rights

Multi-valued

A list of ways in which the data file may or may not be accessed and used.

License Name

Optional

A standardized version of the license name.

Values for this field are taken from the FDC-GDMT ontology. You may use BioPortal to search for values for this field.

Example

CC BY-SA 4.0

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "License Name" : "http://purl.org/radx-terms/metadata-terms/licenseName"
  },
  "License Name" : {
    "rdfs:label" : "CC BY-SA 4.0",
    "@id" : "http://vocab.fairdatacollective.org/gdmt/CCBYSA4.0"
  }
}

License Text

Optional

Text string describing any rights information for the data file being described.

If a uniquely identiable license is named above, it is not necessary to repeat the text of the license in this field. This field allows additional rights information to be provided, either to expand licensing terms, clarify the license holder, or provide unique license terms that are not available in a standardized license.

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "License Text" : "http://purl.org/radx-terms/metadata-terms/licenseText"
  },
  "License Text" : {
    "@value" : null
  }
}

Example element in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Data File Rights" : "http://purl.org/radx-terms/metadata-terms/rightsDescriptor"
  },
  "@id" : "",
  "Data File Rights" : [ {
    "@context" : {
      "License Name" : "http://purl.org/radx-terms/metadata-terms/licenseName",
      "License Text" : "http://purl.org/radx-terms/metadata-terms/licenseText"
    },
    "License Name" : {
      "@id" : "http://vocab.fairdatacollective.org/gdmt/CCBYSA4.0"
    },
    "License Text" : {
      "@value" : null
    }
  } ]
}

Data File Dates

Multi-valued

A list of relevant dates related to the data file being described. Such dates pertain to some data-file-related event, for example "creation date", "submission date" etc. Dates are specified as a pair containing the actual date (in ISO-8601 format) and the event that the date relates to. See individual fields for specific examples.

The dates of some types of events can be captured by the RADx Data Hub, for example the "Submitted" date/time.

Event Type

Optional

Type of Data File event that the date is associated with. The Event Type is usually considered with respect to the corresponding actor; for example, Created is typically the initial creation of the Data File by its originator, Accepted is when an ingested Data File is approved (e.g., by the Data Hub), and Updated is the time of the most recent change to the Data File.

Values for this field are taken from the FDC-GDMT ontology. You may use BioPortal to search for values for this field.

Example

Created

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Event Type" : "http://purl.org/radx-terms/metadata-terms/eventType"
  },
  "Event Type" : {
    "rdfs:label" : "Created",
    "@id" : "http://vocab.fairdatacollective.org/gdmt/Created"
  }
}

Date

Optional

The date/time that is specific to the associated event.

Note that dates must be specified in ISO-8601 format. This format specifies date/times in a locale neutral way with temporal components ordered largest to smallest, for example year, month, day. Note that times are in 24 hour clock (military time) format, thus 13:43 is 1:43pm. When times are specified a time zone must also be specified (Z or +00:00 indicates Greenwich Mean Time).

The date time 2022-11-23T01:23:45.678-07:00 specifies November 23, 2022 at just past 1:23am Pacific Daylight Time. Hyphens and colons are optional.

The date 2022-09-23 specifies September 23, 2022 (without a time stamp). Dates are assumed GMT if no time zone is specified.

Example

2022-11-23T01:23:45.678-07:00

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Date" : "http://purl.org/radx-terms/metadata-terms/eventDate"
  },
  "Date" : {
    "@type" : "xsd:dateTime",
    "@value" : "2022-11-23T01:23:45.678-07:00"
  }
}

Example element in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Data File Dates" : "http://purl.org/radx-terms/metadata-terms/eventsDescriptor"
  },
  "@id" : "",
  "Data File Dates" : [ {
    "@context" : {
      "Event Type" : "http://purl.org/radx-terms/metadata-terms/eventType",
      "Date" : "http://purl.org/radx-terms/metadata-terms/eventDate"
    },
    "Event Type" : {
      "@id" : "http://vocab.fairdatacollective.org/gdmt/Created"
    },
    "Date" : {
      "@type" : "xsd:dateTime",
      "@value" : "2022-11-23T01:23:45.678-07:00"
    }
  } ]
}

Data File Parent Studies

Multi-valued

A list of research studies for which this data file was created.

PHS Identifier

Required

The PHS number that identifies the study for which this data file was created.

This corresponds to the local identifier in the DataCite standard. All RADx studies are required to have a PHS identifier; if you do not have one, please contact the Data Hub for information on filling out this field.

Example

phs000296

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "PHS Identifier" : "http://purl.org/radx-terms/metadata-terms/parentStudyPhsIdentifier"
  },
  "PHS Identifier" : {
    "@value" : "phs000296"
  }
}

Study Identifier

Recommended

Globally unique string that identifies the study for which this data file was created.

Example

https://www.ncbi.nlm.nih.gov/projects/gap/cgi-bin/study.cgi?study_id=phs000296

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Study Identifier" : "http://purl.org/radx-terms/metadata-terms/ParentStudyIdentifier"
  },
  "Study Identifier" : {
    "@value" : "https://www.ncbi.nlm.nih.gov/projects/gap/cgi-bin/study.cgi?study_id=phs000296"
  }
}

Study Identifier Scheme

Optional

The name of the scheme or authority used for the Study Identifier.

Values for this field are taken from the FDC-GDMT ontology. You may use BioPortal to search for values for this field.

ARK | arXiv | bibcode | DOI | EAN13 | EISSN | Handle | IGSN | IRI | ISBN | ISSN | ISTC | LISSN | LSID | PMID | PURL | UPC | URI | URL | URN | w3id

Example

IRI

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Study Identifier Scheme" : "http://purl.org/radx-terms/metadata-terms/parentStudyIdentifierScheme"
  },
  "Study Identifier Scheme" : {
    "rdfs:label" : "IRI",
    "@id" : "http://vocab.fairdatacollective.org/gdmt/IRI"
  }
}

Study Name

Recommended

The name of the research study for which this data file was created.

Example

NHLBI GO-ESP: Lung Cohorts Exome Sequencing Project (COPDGene)

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Study Name" : "http://purl.org/radx-terms/metadata-terms/parentStudyName"
  },
  "Study Name" : {
    "@value" : "NHLBI GO-ESP: Lung Cohorts Exome Sequencing Project (COPDGene)"
  }
}

Study Start Date

Optional

The official start date for the study for which this data file was created. This date must be in the ISO-8601 format of yyyy-mm-dd. For example, 2022-10-05 specifies October 5, 2022.

This field is considered auxiliary information to the initially registered Study Start Date. It will not update the registered information, but may trigger a verification that the registered Start Date has not changed.

Example

2021-10-05

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Study Start Date" : "http://purl.org/radx-terms/metadata-terms/startDate"
  },
  "Study Start Date" : {
    "@type" : "xsd:dateTime",
    "@value" : "2021-10-05"
  }
}

Study End Date

Optional

The official end date for the study for which this data file was created. This date must be in the ISO-8601 format of yyyy-mm-dd. For example, 2022-10-05 specifies October 5, 2022.

This field is considered auxiliary information to the initially registered Study End Date. It will not update the registered information, but may trigger a verification that the registered End Date has not changed.

Example

2022-10-05

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Study End Date" : "http://purl.org/radx-terms/metadata-terms/endDate"
  },
  "Study End Date" : {
    "@type" : "xsd:dateTime",
    "@value" : "2022-10-05"
  }
}

Example element in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Data File Parent Studies" : "http://purl.org/radx-terms/metadata-terms/parentStudyDescriptor"
  },
  "@id" : "",
  "Data File Parent Studies" : [ {
    "@context" : {
      "PHS Identifier" : "http://purl.org/radx-terms/metadata-terms/parentStudyPhsIdentifier",
      "Study Identifier" : "http://purl.org/radx-terms/metadata-terms/ParentStudyIdentifier",
      "Study Identifier Scheme" : "http://purl.org/radx-terms/metadata-terms/parentStudyIdentifierScheme",
      "Study Name" : "http://purl.org/radx-terms/metadata-terms/parentStudyName",
      "Study Start Date" : "http://purl.org/radx-terms/metadata-terms/startDate",
      "Study End Date" : "http://purl.org/radx-terms/metadata-terms/endDate"
    },
    "PHS Identifier" : {
      "@value" : "phs000296"
    },
    "Study Identifier" : {
      "@value" : "https://www.ncbi.nlm.nih.gov/projects/gap/cgi-bin/study.cgi?study_id=phs000296"
    },
    "Study Identifier Scheme" : {
      "@id" : "http://vocab.fairdatacollective.org/gdmt/IRI"
    },
    "Study Name" : {
      "@value" : "NHLBI GO-ESP: Lung Cohorts Exome Sequencing Project (COPDGene)"
    },
    "Study Start Date" : {
      "@type" : "xsd:dateTime",
      "@value" : "2021-10-05"
    },
    "Study End Date" : {
      "@type" : "xsd:dateTime",
      "@value" : "2022-10-05"
    }
  } ]
}

Data File Funding Sources

Multi-valued

A list of sources of funding that enabled and drove the creation of the data file. (Non-monetary sources are described under Contributor.) Each funding source may be described as a separate element (set of fields).

Award Title

Optional

The human readable title of the award, grant, or other specific funding mechanism for the described data file.

Example

Safer At School Early Alert (SASEA)

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Award Title" : "http://purl.org/radx-terms/metadata-terms/awardTitle"
  },
  "Award Title" : {
    "@value" : "Safer At School Early Alert (SASEA)"
  }
}

Award Page URL

Optional

The unique identifier (IRI) leading to a page provided by the funder for more information about the award (grant).

Example

https://reporter.nih.gov/search/44g5CsIy-EGIvKlnlFwXrA/project-details/10447530

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Award Page URL" : "http://purl.org/radx-terms/metadata-terms/awardPageUrl"
  },
  "Award Page URL" : {
    "@id" : "https://reporter.nih.gov/search/44g5CsIy-EGIvKlnlFwXrA/project-details/10447530"
  }
}

Award Local Identifier

Recommended

The code assigned by the funding provider to a sponsored award (grant). (This can be an IRI, but typically is not.)

Example

1U01HD108787-01

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Award Local Identifier" : "http://purl.org/radx-terms/metadata-terms/awardIdentifier"
  },
  "Award Local Identifier" : {
    "@value" : "1U01HD108787-01"
  }
}

Funder Name

Recommended

Name of the organization providing the funding for the described data file ('funding provider').

This is typically the NIH Institute that awarded the grant.

Example

Eunice Kennedy Shriver National Institute of Child Health and Human Development

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Funder Name" : "http://purl.org/radx-terms/metadata-terms/funderName"
  },
  "Funder Name" : {
    "@value" : "Eunice Kennedy Shriver National Institute of Child Health and Human Development"
  }
}

Funder Identifier

Recommended

Globally unique string that identifies the funding provider. A list of NIH Institute identifiers may be found here.

NIH Institute	Identifier
Center for Information Technology	https://ror.org/03jh5a977
Center for Scientific Review	https://ror.org/04r5s4b52
Eunice Kennedy Shriver National Institute of Child Health and Human Development	https://ror.org/04byxyr05
Fogarty International Center	https://ror.org/02xey9a22
National Cancer Institute	https://ror.org/040gcmg81
National Center for Advancing Translational Sciences	https://ror.org/04pw6fb54
National Center for Complementary and Integrative Health	https://ror.org/00190t495
National Eye Institute	https://ror.org/03wkg3b53
National Heart Lung and Blood Institute	https://ror.org/012pb6c26
National Human Genome Research Institute	https://ror.org/00baak391
National Institute of Allergy and Infectious Diseases	https://ror.org/043z4tv69
National Institute of Arthritis and Musculoskeletal and Skin Diseases	https://ror.org/006zn3t30
National Institute of Biomedical Imaging and Bioengineering	https://ror.org/00372qc85
National Institute of Dental and Craniofacial Research	https://ror.org/004a2wv92
National Institute of Diabetes and Digestive and Kidney Diseases	https://ror.org/00adh9b73
National Institute of Environmental Health Sciences	https://ror.org/00j4k1h63
National Institute of General Medical Sciences	https://ror.org/04q48ey07
National Institute of Mental Health	https://ror.org/04xeg9z08
National Institute of Neurological Disorders and Stroke	https://ror.org/01s5ya894
National Institute of Nursing Research	https://ror.org/01y3zfr79
National Institute on Aging	https://ror.org/049v75w11
National Institute on Alcohol Abuse and Alcoholism	https://ror.org/02jzrsm59
National Institute on Deafness and Other Communication Disorders	https://ror.org/04mhx6838
National Institute on Drug Abuse	https://ror.org/00fq5cm18
National Institute on Minority Health and Health Disparities	https://ror.org/0493hgw16
National Institutes of Health Clinical Center	https://ror.org/04vfsmv21
Office of the Director	https://ror.org/00fj8a872
United States National Library of Medicine	https://ror.org/0060t0j89

Example

https://ror.org/04byxyr05

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Funder Identifier" : "http://purl.org/radx-terms/metadata-terms/funderIdentifier"
  },
  "Funder Identifier" : {
    "@value" : "https://ror.org/04byxyr05"
  }
}

Funder Identifier Scheme

Optional

Name of the scheme or authority for the Funder Identifier. This field is optional as in most cases it can be determined from the Funder Identifier field.

Values for this field are taken from the FDC-GDMT ontology. You may use BioPortal to search for values for this field.

Example

ROR

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Funder Identifier Scheme" : "http://purl.org/radx-terms/metadata-terms/funderIdentifierScheme"
  },
  "Funder Identifier Scheme" : {
    "rdfs:label" : "ROR",
    "@id" : "https://ror.org"
  }
}

Example element in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Data File Funding Sources" : "http://purl.org/radx-terms/metadata-terms/fundingSourceDescriptor"
  },
  "@id" : "",
  "Data File Funding Sources" : [ {
    "@context" : {
      "Award Title" : "http://purl.org/radx-terms/metadata-terms/awardTitle",
      "Award Page URL" : "http://purl.org/radx-terms/metadata-terms/awardPageUrl",
      "Award Local Identifier" : "http://purl.org/radx-terms/metadata-terms/awardIdentifier",
      "Funder Name" : "http://purl.org/radx-terms/metadata-terms/funderName",
      "Funder Identifier" : "http://purl.org/radx-terms/metadata-terms/funderIdentifier",
      "Funder Identifier Scheme" : "http://purl.org/radx-terms/metadata-terms/funderIdentifierScheme"
    },
    "Award Title" : {
      "@value" : "Safer At School Early Alert (SASEA)"
    },
    "Award Page URL" : {
      "@id" : "https://reporter.nih.gov/search/44g5CsIy-EGIvKlnlFwXrA/project-details/10447530"
    },
    "Award Local Identifier" : {
      "@value" : "1U01HD108787-01"
    },
    "Funder Name" : {
      "@value" : "Eunice Kennedy Shriver National Institute of Child Health and Human Development"
    },
    "Funder Identifier" : {
      "@value" : "https://ror.org/04byxyr05"
    },
    "Funder Identifier Scheme" : {
      "@id" : "https://ror.org"
    }
  } ]
}

Data File Distributions

Multi-valued

A list of specific (non-Data Hub) distributions for this data file. If the only available distribution for the Data File is in the RADx Data Hub, there is no need to fill out Distribution information.

Distribution Publisher

Optional

The organization or resource that provides services to make publicly available this distribution of the data file.

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Distribution Publisher" : "http://purl.org/radx-terms/metadata-terms/distributionPublisher"
  },
  "Distribution Publisher" : {
    "@value" : null
  }
}

Distribution Publisher Identifier

Optional

Globally unique string that identifies the Distribution Publisher.

Values for this field are taken from the FDC-GDMT ontology. You may use BioPortal to search for values for this field.

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Distribution Publisher Identifier" : "http://purl.org/radx-terms/metadata-terms/distributionPublisherIdentifier"
  },
  "Distribution Publisher Identifier" : { }
}

Distribution Publisher Identifier Scheme

Optional

Name of the scheme or authority for the Distribution Publisher Identifier.

Values for this field are taken from the FDC-GDMT ontology. You may use BioPortal to search for values for this field.

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Distribution Publisher Identifier Scheme" : "http://purl.org/radx-terms/metadata-terms/distributionPublisherIdentifierScheme"
  },
  "Distribution Publisher Identifier Scheme" : { }
}

Distribution Identifier

Optional

A globally unique string that identifies the data file distribution.

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Distribution Identifier" : "http://purl.org/radx-terms/metadata-terms/distributionIdentifier"
  },
  "Distribution Identifier" : {
    "@value" : null
  }
}

Distribution Identifier Type

Optional

The identifier type used to identify the data file distribution.

Values for this field are taken from the FDC-GDMT ontology. You may use BioPortal to search for values for this field.

ARK | arXiv | bibcode | DOI | EAN13 | EISSN | Handle | IGSN | IRI | ISBN | ISSN | ISTC | LISSN | LSID | PMID | PURL | UPC | URI | URL | URN | w3id

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Distribution Identifier Type" : "http://purl.org/radx-terms/metadata-terms/distributionIdentifierType"
  },
  "Distribution Identifier Type" : { }
}

Distribution Format

Optional

An established standard to which the data file distribution conforms.

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Distribution Format" : "http://purl.org/radx-terms/metadata-terms/distributionFormat"
  },
  "Distribution Format" : {
    "@value" : null
  }
}

Distribution Media Type

Optional

A media type (formerly known as a MIME type) of data file distribution. The most common media type for dataset distributions in the RADx Data Hub is text/css

Values for this field are taken from the FDC-GDMT ontology. You may use BioPortal to search for values for this field.

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Distribution Media Type" : "http://purl.org/radx-terms/metadata-terms/distributionMediaType"
  },
  "Distribution Media Type" : { }
}

Distribution Size

Optional

Total size of data file distribution (in bytes).

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Distribution Size" : "http://purl.org/radx-terms/metadata-terms/distributionSizeInBytes"
  },
  "Distribution Size" : {
    "@value" : null
  }
}

Distribution Access Protocol

Optional

The protocol used to access the data file distribution.

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Distribution Access Protocol" : "http://purl.org/radx-terms/metadata-terms/distributionAccessProtocol"
  },
  "Distribution Access Protocol" : {
    "@value" : null
  }
}

Distribution Access Configuration

Optional

The access protocol configuration for querying the data file distribution.

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Distribution Access Configuration" : "http://purl.org/radx-terms/metadata-terms/distributionAccessConfiguration"
  },
  "Distribution Access Configuration" : {
    "@value" : null
  }
}

Distribution Query Statement

Optional

Technical statement(s) for querying the data file distribution.

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Distribution Query Statement" : "http://purl.org/radx-terms/metadata-terms/distributionQueryStatement"
  },
  "Distribution Query Statement" : {
    "@value" : null
  }
}

Data File Publication Date

Publication date of this distribution the data file.

Data File Publication Date

Optional

Date on which this distribution of the data file was published

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Data File Publication Date" : "http://purl.org/radx-terms/metadata-terms/distributionPublicationDate"
  },
  "Data File Publication Date" : {
    "@type" : "xsd:dateTime",
    "@value" : null
  }
}

Publication Date Type

Derived Optional

The value of this field is a fixed type and is automatically inserted. This field should not be manually specified or edited.

Type of the date ('Published') with respect to the data file. The value of this field is always Published.

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Publication Date Type" : "http://purl.org/radx-terms/metadata-terms/distributionPublicationDateType"
  },
  "Publication Date Type" : {
    "@value" : "http://vocab.fairdatacollective.org/gdmt/Published"
  }
}

Example element in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Data File Publication Date" : "http://purl.org/radx-terms/metadata-terms/distributionPublicationDescriptor"
  },
  "Data File Publication Date" : {
    "@context" : {
      "Data File Publication Date" : "http://purl.org/radx-terms/metadata-terms/distributionPublicationDate",
      "Publication Date Type" : "http://purl.org/radx-terms/metadata-terms/distributionPublicationDateType"
    },
    "Data File Publication Date" : {
      "@type" : "xsd:dateTime",
      "@value" : null
    },
    "Publication Date Type" : {
      "@value" : "http://vocab.fairdatacollective.org/gdmt/Published"
    }
  }
}

Example element in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Data File Distributions" : "http://purl.org/radx-terms/metadata-terms/distributionDescriptor"
  },
  "@id" : "",
  "Data File Distributions" : [ {
    "@context" : {
      "Distribution Publisher" : "http://purl.org/radx-terms/metadata-terms/distributionPublisher",
      "Distribution Publisher Identifier" : "http://purl.org/radx-terms/metadata-terms/distributionPublisherIdentifier",
      "Distribution Publisher Identifier Scheme" : "http://purl.org/radx-terms/metadata-terms/distributionPublisherIdentifierScheme",
      "Distribution Identifier" : "http://purl.org/radx-terms/metadata-terms/distributionIdentifier",
      "Distribution Identifier Type" : "http://purl.org/radx-terms/metadata-terms/distributionIdentifierType",
      "Distribution Format" : "http://purl.org/radx-terms/metadata-terms/distributionFormat",
      "Distribution Media Type" : "http://purl.org/radx-terms/metadata-terms/distributionMediaType",
      "Distribution Size" : "http://purl.org/radx-terms/metadata-terms/distributionSizeInBytes",
      "Distribution Access Protocol" : "http://purl.org/radx-terms/metadata-terms/distributionAccessProtocol",
      "Distribution Access Configuration" : "http://purl.org/radx-terms/metadata-terms/distributionAccessConfiguration",
      "Distribution Query Statement" : "http://purl.org/radx-terms/metadata-terms/distributionQueryStatement",
      "Data File Publication Date" : "http://purl.org/radx-terms/metadata-terms/distributionPublicationDescriptor"
    },
    "Distribution Publisher" : {
      "@value" : null
    },
    "Distribution Publisher Identifier" : { },
    "Distribution Publisher Identifier Scheme" : { },
    "Distribution Identifier" : {
      "@value" : null
    },
    "Distribution Identifier Type" : { },
    "Distribution Format" : {
      "@value" : null
    },
    "Distribution Media Type" : { },
    "Distribution Size" : {
      "@value" : null
    },
    "Distribution Access Protocol" : {
      "@value" : null
    },
    "Distribution Access Configuration" : {
      "@value" : null
    },
    "Distribution Query Statement" : {
      "@value" : null
    },
    "Data File Publication Date" : {
      "@context" : {
        "Data File Publication Date" : "http://purl.org/radx-terms/metadata-terms/distributionPublicationDate",
        "Publication Date Type" : "http://purl.org/radx-terms/metadata-terms/distributionPublicationDateType"
      },
      "Data File Publication Date" : {
        "@type" : "xsd:dateTime",
        "@value" : null
      },
      "Publication Date Type" : {
        "@value" : "http://vocab.fairdatacollective.org/gdmt/Published"
      }
    }
  } ]
}

Data Characteristics Summary

Characteristics of the data within the data file, particularly of the cohorts in the data file. This section provides multiple ways to enter such information; it is only necessary to enter the information in one of these formats.

Data Characteristics Table in HTML

Optional

Formatted HTML code for a table of summary statistics.

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Data Characteristics Table in HTML" : "http://purl.org/radx-terms/metadata-terms/dataCharacteristicsTableInHtml"
  },
  "Data Characteristics Table in HTML" : {
    "@value" : null
  }
}

Data Characteristics Table in CSV

Optional

Enter comma-separated values containing summary statistics characterizing this data file.

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Data Characteristics Table in CSV" : "http://purl.org/radx-terms/metadata-terms/dataCharacteristicsTableInCsv"
  },
  "Data Characteristics Table in CSV" : {
    "@value" : null
  }
}

Data Characteristics Table in TSV

Optional

Enter tab-separated values containing summary statistics characterizing this data file.

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Data Characteristics Table in TSV" : "http://purl.org/radx-terms/metadata-terms/dataCharacteristicsTableInTsv"
  },
  "Data Characteristics Table in TSV" : {
    "@value" : null
  }
}

Data Characteristics Table in Key-Value Pairs

Optional Multi-valued

Enter the name of the characteristic being described in the first (key) field, and the value for that characteristic in the second (value) field. Note this is a repeating field and so can support multiple key-value pairs.

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Data Characteristics Table in Key-Value Pairs" : "http://purl.org/radx-terms/metadata-terms/dataCharacteristicsTableInKeyValuePairs"
  },
  "Data Characteristics Table in Key-Value Pairs" : [ "" ]
}

Example element in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Data Characteristics Summary" : "http://purl.org/radx-terms/metadata-terms/dataCharacteristicsDescriptor"
  },
  "@id" : "",
  "Data Characteristics Summary" : {
    "@context" : {
      "Data Characteristics Table in HTML" : "http://purl.org/radx-terms/metadata-terms/dataCharacteristicsTableInHtml",
      "Data Characteristics Table in CSV" : "http://purl.org/radx-terms/metadata-terms/dataCharacteristicsTableInCsv",
      "Data Characteristics Table in TSV" : "http://purl.org/radx-terms/metadata-terms/dataCharacteristicsTableInTsv",
      "Data Characteristics Table in Key-Value Pairs" : "http://purl.org/radx-terms/metadata-terms/dataCharacteristicsTableInKeyValuePairs"
    },
    "Data Characteristics Table in HTML" : {
      "@value" : null
    },
    "Data Characteristics Table in CSV" : {
      "@value" : null
    },
    "Data Characteristics Table in TSV" : {
      "@value" : null
    },
    "Data Characteristics Table in Key-Value Pairs" : [ "" ]
  }
}

Data Sources

Multi-valued

A list of physical or conceptual entities (agents) that create the data streams that make up the described data file. A data source may or may not be associated with a fixed location; for example, a series of discrete sensors deployed over time, either to a single location or to a series of locations, may be considered a single data source in some systems.

Data Source Name

Optional

Human readable name of data source from which the variable(s) in the data stream(s) originate.

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Data Source Name" : "http://purl.org/radx-terms/metadata-terms/dataSourceName"
  },
  "Data Source Name" : {
    "@value" : null
  }
}

Data Source Identifier

Optional

Globally unique string that identifies the data source (e.g., PID of an instrument). This is a required field if you plan to describe the original source of a given Data Stream.

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Data Source Identifier" : "http://purl.org/radx-terms/metadata-terms/dataSourceIdentifier"
  },
  "Data Source Identifier" : {
    "@value" : null
  }
}

Data Source Identifier Scheme

Optional

The name of the scheme or authority used for the Data Source Identifier.

Values for this field are taken from the FDC-GDMT ontology. You may use BioPortal to search for values for this field.

ARK | arXiv | bibcode | DOI | EAN13 | EISSN | Handle | IGSN | IRI | ISBN | ISSN | ISTC | LISSN | LSID | PMID | PURL | UPC | URI | URL | URN | w3id

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Data Source Identifier Scheme" : "http://purl.org/radx-terms/metadata-terms/dataSourceIdentifierScheme"
  },
  "Data Source Identifier Scheme" : { }
}

Example element in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Data Sources" : "http://purl.org/radx-terms/metadata-terms/dataSourceDescriptor"
  },
  "@id" : "",
  "Data Sources" : [ {
    "@context" : {
      "Data Source Name" : "http://purl.org/radx-terms/metadata-terms/dataSourceName",
      "Data Source Identifier" : "http://purl.org/radx-terms/metadata-terms/dataSourceIdentifier",
      "Data Source Identifier Scheme" : "http://purl.org/radx-terms/metadata-terms/dataSourceIdentifierScheme"
    },
    "Data Source Name" : {
      "@value" : null
    },
    "Data Source Identifier" : {
      "@value" : null
    },
    "Data Source Identifier Scheme" : { }
  } ]
}

Data Streams

Multi-valued

A list of one or more variable records that contribute to this data file. Each data stream originates from a single data source (e.g., sensor, process, or person). A data stream can grow over time.

Data Stream Name

Optional

Human readable name of collection of records coming from a data source. A data stream is a collection of one or more variable records originating from a single data source (e.g., sensor, process, or person). A data stream can grow over time.

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Data Stream Name" : "http://purl.org/radx-terms/metadata-terms/dataStreamName"
  },
  "Data Stream Name" : {
    "@value" : null
  }
}

Data Stream Identifier

Optional

Globally unique string that identifies the collection of records coming from a data source.

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Data Stream Identifier" : "http://purl.org/radx-terms/metadata-terms/dataStreamIdentifier"
  },
  "Data Stream Identifier" : {
    "@value" : null
  }
}

Data Stream Identifier Scheme

Optional

The name of the scheme or authority used for the Data Stream Identifier.

Values for this field are taken from the FDC-GDMT ontology. You may use BioPortal to search for values for this field.

ARK | arXiv | bibcode | DOI | EAN13 | EISSN | Handle | IGSN | IRI | ISBN | ISSN | ISTC | LISSN | LSID | PMID | PURL | UPC | URI | URL | URN | w3id

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Data Stream Identifier Scheme" : "http://purl.org/radx-terms/metadata-terms/dataStreamIdentifierScheme"
  },
  "Data Stream Identifier Scheme" : { }
}

Data Stream Variable Names

Optional Multi-valued

The local names of variables contained in the data stream.

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Data Stream Variable Names" : "http://purl.org/radx-terms/metadata-terms/dataStreamVariableName"
  },
  "Data Stream Variable Names" : [ {
    "@value" : null
  } ]
}

Data Stream Data Source Identifier

Optional

Globally unique string that identifies the data source (e.g., PID of an instrument) that generated this Data Stream.

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Data Stream Data Source Identifier" : "http://purl.org/radx-terms/metadata-terms/dataStreamDataSourceIdentifier"
  },
  "Data Stream Data Source Identifier" : {
    "@value" : null
  }
}

Example element in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Data Streams" : "http://purl.org/radx-terms/metadata-terms/dataStreamDescriptor"
  },
  "@id" : "",
  "Data Streams" : [ {
    "@context" : {
      "Data Stream Name" : "http://purl.org/radx-terms/metadata-terms/dataStreamName",
      "Data Stream Identifier" : "http://purl.org/radx-terms/metadata-terms/dataStreamIdentifier",
      "Data Stream Identifier Scheme" : "http://purl.org/radx-terms/metadata-terms/dataStreamIdentifierScheme",
      "Data Stream Variable Names" : "http://purl.org/radx-terms/metadata-terms/dataStreamVariableName",
      "Data Stream Data Source Identifier" : "http://purl.org/radx-terms/metadata-terms/dataStreamDataSourceIdentifier"
    },
    "Data Stream Name" : {
      "@value" : null
    },
    "Data Stream Identifier" : {
      "@value" : null
    },
    "Data Stream Identifier Scheme" : { },
    "Data Stream Variable Names" : [ {
      "@value" : null
    } ],
    "Data Stream Data Source Identifier" : {
      "@value" : null
    }
  } ]
}

Data File Creation Processes

Multi-valued

A list of processes (activities) used to make the data file.

Process Name

Optional

Full name of the process that operates to make the data file or product.

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Process Name" : "http://purl.org/radx-terms/metadata-terms/creationProcessName"
  },
  "Process Name" : {
    "@value" : null
  }
}

Process IRI

Optional

Unique identifier (IRI) for the process used to make the data file or product (preferably a resolvable and persistent identifier).

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Process IRI" : "http://purl.org/radx-terms/metadata-terms/creationProcessIri"
  },
  "Process IRI" : {
    "@value" : null
  }
}

Process Version

Optional

Version of the process used to make this data file, typically a string (e.g., '3.0.3'). It may be a software release tag, e.g., in GitHub.

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Process Version" : "http://purl.org/radx-terms/metadata-terms/creationProcessVersion"
  },
  "Process Version" : {
    "@value" : null
  }
}

Process Execution Identifier

Optional

Identification of the particular run of the process used to make this data file.

This is a deterministic string; in software, typically it is either a timestamp combined with the machine on which the software was executed; or a unique identifier generated by the controlling software for each run of the process.

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Process Execution Identifier" : "http://purl.org/radx-terms/metadata-terms/creationProcessExecutionIdentifier"
  },
  "Process Execution Identifier" : {
    "@value" : null
  }
}

Example element in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Data File Creation Processes" : "http://purl.org/radx-terms/metadata-terms/dataFileCreationProcessDescriptor"
  },
  "@id" : "",
  "Data File Creation Processes" : [ {
    "@context" : {
      "Process Name" : "http://purl.org/radx-terms/metadata-terms/creationProcessName",
      "Process IRI" : "http://purl.org/radx-terms/metadata-terms/creationProcessIri",
      "Process Version" : "http://purl.org/radx-terms/metadata-terms/creationProcessVersion",
      "Process Execution Identifier" : "http://purl.org/radx-terms/metadata-terms/creationProcessExecutionIdentifier"
    },
    "Process Name" : {
      "@value" : null
    },
    "Process IRI" : {
      "@value" : null
    },
    "Process Version" : {
      "@value" : null
    },
    "Process Execution Identifier" : {
      "@value" : null
    }
  } ]
}

Data File Temporal Coverage

Multi-valued

A list of temporal descriptions that specify the temporal coverage of the data contained within the data file associated with this metadata.

Temporal Extent Minimum Value

Optional

The start date (and optionally time) of the data.

Note that dates must be specified in ISO-8601 format. This format specifies date/times in a locale neutral way with temporal components ordered largest to smallest, for example year, month, day. Note that times are in 24 hour clock (military time) format, thus 13:43 is 1:43pm. When times are specified a time zone must also be specified (Z or +00:00 indicates Greenwich Mean Time).

The date time 2022-11-23T01:23:45.678-07:00 specifies November 23, 2022 at just past 1:23am Pacific Daylight Time. Hyphens and colons are optional.

The date 2022-09-23 specifies September 23, 2022 (without a time stamp). Dates are assumed GMT if no time zone is specified.

Example

2022-06-01

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Temporal Extent Minimum Value" : "http://purl.org/radx-terms/metadata-terms/temporalExtentMinimumValue"
  },
  "Temporal Extent Minimum Value" : {
    "@type" : "xsd:dateTime",
    "@value" : "2022-06-01"
  }
}

Temporal Extent Maximum Value

Optional

The end date (and optionally time) of the data.

Note that dates must be specified in ISO-8601 format. This format specifies date/times in a locale neutral way with temporal components ordered largest to smallest, for example year, month, day. Note that times are in 24 hour clock (military time) format, thus 13:43 is 1:43pm. When times are specified a time zone must also be specified (Z or +00:00 indicates Greenwich Mean Time).

The date time 2022-11-23T01:23:45.678-07:00 specifies November 23, 2022 at just past 1:23am Pacific Daylight Time. Hyphens and colons are optional.

The date 2022-09-23 specifies September 23, 2022 (without a time stamp). Dates are assumed GMT if no time zone is specified.

Example

2022-06-29

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Temporal Extent Maximum Value" : "http://purl.org/radx-terms/metadata-terms/temporalExtentMaximumValue"
  },
  "Temporal Extent Maximum Value" : {
    "@type" : "xsd:dateTime",
    "@value" : "2022-06-29"
  }
}

Temporal Resolution

Optional

The nominal time interval between the measurement time of one data record and that of the following data record, in seconds. Measurement time can be considered as the beginning, end, or other known point in the measurement process.

Most repeating measurement processes have some variation in the interval between measurements. If there is no planned schedule for the measurements, this value can be set to 0.

Example

3600

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Temporal Resolution" : "http://purl.org/radx-terms/metadata-terms/temporalResolution"
  },
  "Temporal Resolution" : {
    "@value" : "3600"
  }
}

Duration

Derived Optional

The value of this field is computed from the difference between the Temporal Extent Minimum Value and Temporal Extent Maximum Value fields, if both those fields are available. This field should not be manually specified or edited.

The total duration of data temporal coverage, specified in in ISO-8601 duration format.

P is the duration designator (for period) placed at the start of the duration representation. - Y is the year designator that follows the value for the number of calendar years. - M is the month designator that follows the value for the number of calendar months. - W is the week designator that follows the value for the number of weeks. - D is the day designator that follows the value for the number of calendar days. T is the time designator that precedes the time components of the representation. - H is the hour designator that follows the value for the number of hours. - M is the minute designator that follows the value for the number of minutes. - S is the second designator that follows the value for the number of seconds.

The duration format must begin with P, and include at least one designator and value; other designators may be dropped. The smallest designator may include a decimal fraction. For example, P8DT1.5H indicates a duration of 8 calendar days + 1.5 hours.

Example

P8DT1.5H

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Duration" : "http://purl.org/radx-terms/metadata-terms/temporalCoverageDuration"
  },
  "Duration" : {
    "@value" : "P8DT1.5H"
  }
}

Example element in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Data File Temporal Coverage" : "http://purl.org/radx-terms/metadata-terms/temporalCoverageDescriptor"
  },
  "@id" : "",
  "Data File Temporal Coverage" : [ {
    "@context" : {
      "Temporal Extent Minimum Value" : "http://purl.org/radx-terms/metadata-terms/temporalExtentMinimumValue",
      "Temporal Extent Maximum Value" : "http://purl.org/radx-terms/metadata-terms/temporalExtentMaximumValue",
      "Temporal Resolution" : "http://purl.org/radx-terms/metadata-terms/temporalResolution",
      "Duration" : "http://purl.org/radx-terms/metadata-terms/temporalCoverageDuration"
    },
    "Temporal Extent Minimum Value" : {
      "@type" : "xsd:dateTime",
      "@value" : "2022-06-01"
    },
    "Temporal Extent Maximum Value" : {
      "@type" : "xsd:dateTime",
      "@value" : "2022-06-29"
    },
    "Temporal Resolution" : {
      "@value" : "3600"
    },
    "Duration" : {
      "@value" : "P8DT1.5H"
    }
  } ]
}

Data File Spatial Coverage

Multi-valued

A list of geospatial descriptions that specify the geographical coverage of the data contained within the data file associated with this metadata.

Bounding Boxes

Multi-valued

A list of geographical bounding boxes that specifies the geographical coverage of the data contained within the data file associated with this metadata.

Maximum Latitude

Optional

Location of the maximum, or northernmost, data point in this data file, expressed in decimal degrees (southern latitudes are negative).

37.5 specifies 37.5 degrees North (37 degrees and 30 minutes North)

-5.5 specifies 5.5 degrees South (5 degrees and 30 minutes South)

Example

-121.208178

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Maximum Latitude" : "http://purl.org/radx-terms/metadata-terms/maxLatitude"
  },
  "Maximum Latitude" : {
    "@value" : "-121.208178"
  }
}

Minimum Latitude

Optional

Location of the minimum, or southernmost, data point in this data file, expressed in decimal degrees (southern latitudes are negative).

37.5 specifies 37.5 degrees North (37 degrees and 30 minutes North)

-5.5 specifies 5.5 degrees South (5 degrees and 30 minutes South)

Example

-122.202653

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Minimum Latitude" : "http://purl.org/radx-terms/metadata-terms/minLatitude"
  },
  "Minimum Latitude" : {
    "@value" : "-122.202653"
  }
}

Minimum Longitude

Optional

Location of the minimum, or westernmost, data point in this data file, expressed in decimal degrees (western longitudes are negative)

150.0 specifies 150 degrees East

-122.0 specifies 122 degrees West

Example

36.892976

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Minimum Longitude" : "http://purl.org/radx-terms/metadata-terms/minLongitude"
  },
  "Minimum Longitude" : {
    "@value" : "36.892976"
  }
}

Maximum Longitude

Optional

Location of the maximum, or easternmost, data point in this data file, expressed in decimal degrees (western longitudes are negative)

150.0 specifies 150 degrees East

-122.0 specifies 122 degrees West

Example

37.484637

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Maximum Longitude" : "http://purl.org/radx-terms/metadata-terms/maxLongitude"
  },
  "Maximum Longitude" : {
    "@value" : "37.484637"
  }
}

Example element in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Bounding Boxes" : "http://purl.org/radx-terms/metadata-terms/boundingBoxDescriptor"
  },
  "Bounding Boxes" : [ {
    "@context" : {
      "Maximum Latitude" : "http://purl.org/radx-terms/metadata-terms/maxLatitude",
      "Minimum Latitude" : "http://purl.org/radx-terms/metadata-terms/minLatitude",
      "Minimum Longitude" : "http://purl.org/radx-terms/metadata-terms/minLongitude",
      "Maximum Longitude" : "http://purl.org/radx-terms/metadata-terms/maxLongitude"
    },
    "Maximum Latitude" : {
      "@value" : "-121.208178"
    },
    "Minimum Latitude" : {
      "@value" : "-122.202653"
    },
    "Minimum Longitude" : {
      "@value" : "36.892976"
    },
    "Maximum Longitude" : {
      "@value" : "37.484637"
    }
  } ]
}

Bounding Shapes

Multi-valued

A list of geographical coordinates that specifies the external bounday of the polygon that describes the coverage of the data contained within the data file being described.

Point Number

Optional

Monotonically increasing identifier of the point in the shape being defined (defined in clockwise order and containing the right side of the closed shape). The last point must be the same as the first point.

Example

1

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Point Number" : "http://purl.org/radx-terms/metadata-terms/pointNumber"
  },
  "Point Number" : {
    "@type" : "xsd:decimal",
    "@value" : "1"
  }
}

Latitude

Optional

Location of this point in north latitude decimal degrees (southern latitudes are negative)

37.5 specifies 37.5 degrees North (37 degrees and 30 minutes North)

-5.5 specifies 5.5 degrees South (5 degrees and 30 minutes South)

Example

10

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Latitude" : "http://purl.org/radx-terms/metadata-terms/latitude"
  },
  "Latitude" : {
    "@type" : "xsd:decimal",
    "@value" : "10"
  }
}

Longitude

Optional

Location of this point in east longitude decimal degrees (western longitudes are negative)

150.0 specifies 150 degrees East

-122.0 specifies 122 degrees West

Example

150

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Longitude" : "http://purl.org/radx-terms/metadata-terms/longitude"
  },
  "Longitude" : {
    "@type" : "xsd:decimal",
    "@value" : "150"
  }
}

Example element in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Bounding Shapes" : "http://purl.org/radx-terms/metadata-terms/boundingShapeDescriptor"
  },
  "Bounding Shapes" : [ {
    "@context" : {
      "Point Number" : "http://purl.org/radx-terms/metadata-terms/pointNumber",
      "Latitude" : "http://purl.org/radx-terms/metadata-terms/latitude",
      "Longitude" : "http://purl.org/radx-terms/metadata-terms/longitude"
    },
    "Point Number" : {
      "@type" : "xsd:decimal",
      "@value" : "1"
    },
    "Latitude" : {
      "@type" : "xsd:decimal",
      "@value" : "10"
    },
    "Longitude" : {
      "@type" : "xsd:decimal",
      "@value" : "150"
    }
  } ]
}

Data File Geopolitical Coverage

Multi-valued

A list of regions specified by the totality of one or more place names

Geopolitical region

Optional Multi-valued

Place name depicting a geopolitical region. Recommended practice is to use Geonames to find an identifier matching any particular place.

Example

New York City

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Geopolitical region" : "http://purl.org/radx-terms/metadata-terms/geographicalPlaceName"
  },
  "Geopolitical region" : [ {
    "@value" : "[New York City](https://www.geonames.org/5128581)"
  } ]
}

Example element in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Data File Geopolitical Coverage" : "http://purl.org/radx-terms/metadata-terms/geopoliticalCoverageDescriptor"
  },
  "Data File Geopolitical Coverage" : [ {
    "@context" : {
      "Geopolitical region" : "http://purl.org/radx-terms/metadata-terms/geographicalPlaceName"
    },
    "Geopolitical region" : [ {
      "@value" : "[New York City](https://www.geonames.org/5128581)"
    } ]
  } ]
}

Example element in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Data File Spatial Coverage" : "http://purl.org/radx-terms/metadata-terms/spatialCoverageDescriptor"
  },
  "@id" : "",
  "Data File Spatial Coverage" : [ {
    "@context" : {
      "Bounding Boxes" : "http://purl.org/radx-terms/metadata-terms/boundingBoxDescriptor",
      "Bounding Shapes" : "http://purl.org/radx-terms/metadata-terms/boundingShapeDescriptor",
      "Data File Geopolitical Coverage" : "http://purl.org/radx-terms/metadata-terms/geopoliticalCoverageDescriptor"
    },
    "Bounding Boxes" : [ {
      "@context" : {
        "Maximum Latitude" : "http://purl.org/radx-terms/metadata-terms/maxLatitude",
        "Minimum Latitude" : "http://purl.org/radx-terms/metadata-terms/minLatitude",
        "Minimum Longitude" : "http://purl.org/radx-terms/metadata-terms/minLongitude",
        "Maximum Longitude" : "http://purl.org/radx-terms/metadata-terms/maxLongitude"
      },
      "Maximum Latitude" : {
        "@value" : "-121.208178"
      },
      "Minimum Latitude" : {
        "@value" : "-122.202653"
      },
      "Minimum Longitude" : {
        "@value" : "36.892976"
      },
      "Maximum Longitude" : {
        "@value" : "37.484637"
      }
    } ],
    "Bounding Shapes" : [ {
      "@context" : {
        "Point Number" : "http://purl.org/radx-terms/metadata-terms/pointNumber",
        "Latitude" : "http://purl.org/radx-terms/metadata-terms/latitude",
        "Longitude" : "http://purl.org/radx-terms/metadata-terms/longitude"
      },
      "Point Number" : {
        "@type" : "xsd:decimal",
        "@value" : "1"
      },
      "Latitude" : {
        "@type" : "xsd:decimal",
        "@value" : "10"
      },
      "Longitude" : {
        "@type" : "xsd:decimal",
        "@value" : "150"
      }
    } ],
    "Data File Geopolitical Coverage" : [ {
      "@context" : {
        "Geopolitical region" : "http://purl.org/radx-terms/metadata-terms/geographicalPlaceName"
      },
      "Geopolitical region" : [ {
        "@value" : "[New York City](https://www.geonames.org/5128581)"
      } ]
    } ]
  } ]
}

Data File Elevation Coverage

Multi-valued

A list of elevation ranges encompassed by the data within the data file being described.

Vertical Extent Minimum Value

Optional

The minimum vertical extent of the data file collection, specified in meters.

In case of depth, this is the maximum depth of data file collection (that is, it is a negative number of greater absolute magnitude than the Vertical Extent Maximum Value if that is also a depth).

Example

-1223

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Vertical Extent Minimum Value" : "http://purl.org/radx-terms/metadata-terms/minElevation"
  },
  "Vertical Extent Minimum Value" : {
    "@type" : "xsd:decimal",
    "@value" : "-1223"
  }
}

Vertical Extent Maximum Value

Optional

The maximum vertical extent of the collected, specified in meters.

In case of depth, this is the minimum depth of data file collection (that is, it is a negative number of lesser absolute magnitude than the Vertical Extent Minimum Value).

Example

-2.5

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Vertical Extent Maximum Value" : "http://purl.org/radx-terms/metadata-terms/maxElevation"
  },
  "Vertical Extent Maximum Value" : {
    "@type" : "xsd:decimal",
    "@value" : "-2.5"
  }
}

Vertical Extent Datum

Optional

The name of the Datum (reference frame) used for the Vertical Extent values.

Example

WGS84

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Vertical Extent Datum" : "http://purl.org/radx-terms/metadata-terms/elevationReferenceFrame"
  },
  "Vertical Extent Datum" : {
    "@value" : "WGS84"
  }
}

Vertical Extent Datum IRI

Optional

The IRI (Internationalized Resource Identifier) of the Datum (reference frame) used for the Vertical Extent values.

Example

https://epsg.io/4326

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Vertical Extent Datum IRI" : "http://purl.org/radx-terms/metadata-terms/elevationReferenceFrameIri"
  },
  "Vertical Extent Datum IRI" : {
    "@id" : "https://epsg.io/4326"
  }
}

Example element in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Data File Elevation Coverage" : "http://purl.org/radx-terms/metadata-terms/elevationCoverageDescriptor"
  },
  "@id" : "",
  "Data File Elevation Coverage" : [ {
    "@context" : {
      "Vertical Extent Minimum Value" : "http://purl.org/radx-terms/metadata-terms/minElevation",
      "Vertical Extent Maximum Value" : "http://purl.org/radx-terms/metadata-terms/maxElevation",
      "Vertical Extent Datum" : "http://purl.org/radx-terms/metadata-terms/elevationReferenceFrame",
      "Vertical Extent Datum IRI" : "http://purl.org/radx-terms/metadata-terms/elevationReferenceFrameIri"
    },
    "Vertical Extent Minimum Value" : {
      "@type" : "xsd:decimal",
      "@value" : "-1223"
    },
    "Vertical Extent Maximum Value" : {
      "@type" : "xsd:decimal",
      "@value" : "-2.5"
    },
    "Vertical Extent Datum" : {
      "@value" : "WGS84"
    },
    "Vertical Extent Datum IRI" : {
      "@id" : "https://epsg.io/4326"
    }
  } ]
}

Auxiliary Metadata

Information about the data file or metadata submission that does not fit into the other categories

Data File Descriptive Key-Value Pairs

Optional Multi-valued

This field supports entry of both the metadata attribute name (in the first field), and the value for that attribute (in the second field). Note this is a repeating field and so can support multiple key-value pairs.

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Data File Descriptive Key-Value Pairs" : "http://purl.org/radx-terms/metadata-terms/auxiliaryMetadataKeyValuePair"
  },
  "Data File Descriptive Key-Value Pairs" : [ "" ]
}

Additional Commentary

Optional Multi-valued

This text field can contain additional information about the data file or provided metadata. Multiple Additional Commentary fields may be filled out to address different topics.

Example in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Additional Commentary" : "http://purl.org/radx-terms/metadata-terms/auxiliaryMetadataCommentary"
  },
  "Additional Commentary" : [ {
    "@value" : null
  } ]
}

Example element in RADx Metadata Model JSON-LD

{
  "@context" : {
    "Auxiliary Metadata" : "http://purl.org/radx-terms/metadata-terms/auxiliaryMetadataDescriptor"
  },
  "@id" : "",
  "Auxiliary Metadata" : {
    "@context" : {
      "Data File Descriptive Key-Value Pairs" : "http://purl.org/radx-terms/metadata-terms/auxiliaryMetadataKeyValuePair",
      "Additional Commentary" : "http://purl.org/radx-terms/metadata-terms/auxiliaryMetadataCommentary"
    },
    "Data File Descriptive Key-Value Pairs" : [ "" ],
    "Additional Commentary" : [ {
      "@value" : null
    } ]
  }
}