RADx-DHT Metadata Mapping

This page explains how to take pre-existing RADx-DHT metadata and convert it into RADx Metadata.

id/doi

{
  "id": "https://doi.org/10.57895/me7r-vp06"
}

The RADx-DHT id/doi field represents the same information formatted in different ways. We chose to map the value of the id field to the RADx Metadata Specification Identifier field in the Data File Identity element.

RADx Metadata Field	Value
Identifier	Value of `$.id` prefixed with `"https://doi.org/"`. For example, `"https://doi.org/10.57895/ME7R-VP06"`.
Identifier Type	`"http://vocab.fairdatacollective.org/gdmt/DOI"`

url

{
  "url": "https://rapids.ll.mit.edu/10.57895/me7r-vp06"
}

The value of the RADx-DHT url field should be encoded in a Data File Related Resources element.

RADx Metadata Field	Value
Related Resource Identifier	Value of `$.url`.
Related Resource Identifier Type	`"http://vocab.fairdatacollective.org/gdmt/URL"`

types

{
  "types": {
    "ris": "DATA",
    "bibtex": "misc",
    "citeproc": "dataset",
    "schemaOrg": "Dataset",
    "resourceType": "Survey",
    "resourceTypeGeneral": "Dataset"
  }
}

There is no direct equivalent of this field. Types in the RADx-DHT may be recorded in the Auxiliary Metadata element.

creators

The value of the compound creators field should be encoded in a Data File Creators element. The fields inside this element directly parallel the fields used in the RADx-DHT specification.

Multiple Data File Creators elements may be specified. Use one element per creator.

The JSON below shows a RADx-DHT example of a creators JSON object.

{
    "creators": [
        {
            "name": "Marcus, Gregory",
            "nameType": "Personal",
            "givenName": "Gregory",
            "familyName": "Marcus",
            "affiliation": [
                {
                    "name": "University of California, San Francisco",
                    "schemeUri": "https://ror.org",
                    "affiliationIdentifier": "https://ror.org/043mz5j54",
                    "affiliationIdentifierScheme": "ROR"
                }
            ],
            "nameIdentifiers": [
                {
                    "schemeUri": "https://orcid.org",
                    "nameIdentifier": "https://orcid.org/0000-0001-5197-7696",
                    "nameIdentifierScheme": "ORCID"
                }
            ]
        }
    ]
}

Fields in a RADx-DHT creators object should be mapped as follows. Note that,

the RADx metadata specification only supports one creator affiliation per Data File Creators element.
the RADx metadata specification only supports one creator identifier per Data File Creators.

Set the value of the Creator Identifier Scheme field to one of the allowable options. If an ORCID has been used to identify the creator then https://orcid.org as the value for the Creator Identifier Scheme field.

RADx Metadata Field	Value
Creator Name	`creators[0].name`
Creator Type	Use `http://vocab.fairdatacollective.org/gdmt/Person` for `Personal`, Use `http://vocab.fairdatacollective.org/gdmt/Organization` for `Organizational`.
Creator Given Name	`creators[0].givenName`
Creator Family Name	`creators[0].familyName`
Creator Affiliation	`creators[0].affiliation[0].name`
Creator Affiliation Identifier	`creators[0].affiliation[0].affiliationIdentifier`
Creator Affiliation Identifier Scheme	`creators[0].affiliation[0].schemeUri`
Creator Identifier Scheme	`creators[0].nameIdentifiers[0].schemeUri`
Creator Identifier	`creators[0].nameIdentifiers[0].nameIdentifier`

titles

A RADx-DHT titles JSON object should be encoded as a Data File Titles element. Multiple Data File Titles elements may be specified. Use one element per title.

The JSON below shows a RADx-DHT example of a titles JSON object.

{
    "titles" : [
        {
            "lang": "en",
            "title": "Covidseeker and COVID-19 Citizen Science",
            "titleType": null
        }
    ]
}

RADx-DHT object fields should be mapped as follows:

RADx Metadata Field	Value
Title	`titles.title`
Language	`titles.lang`

The titles.titleType is not supported in the RADx Metadata. If this needs to be recorded then the Auxiliary Metadata element should be used.

publisher

The RADx-DHT publisher field should be encoded using fields from the Data File Distributions element.

{
  "publisher": "RAPIDS – Rapid AI Platform for Innovating Data Science "
}

RADx Metadata Field	Value
Distribution Publisher	`"MIT Lincoln Laboratory"`
Distribution Publisher Identifier	We suggest that this is set to `"https://ror.org/022z6jk58"`, which identifies MIT Lincoln Laboratory.
Distribution Publisher Identifier Scheme	`"https://ror.org"`
Distribution Identifier	The DOI for the data file
Distribution Identifier Type	`"http://vocab.fairdatacollective.org/gdmt/DOI"`

subjects

The RADx Metadata Specification uses the Medical Subject Headings Thesaurus (MeSH) for specifying the subjects for a data file. We possible subjects should be translated into MeSH terms. See the Data File Subjects element for documentation on encoding subjects.

{
    "subjects": [
        {
            "subject": "FOS: Medical and health sciences",
            "valueUri": "http://www.oecd.org/science/inno/38235147.pdf",
            "schemeUri": "http://www.oecd.org/science/inno",
            "subjectScheme": "Fields of Science and Technology (FOS)"
        }
    ]
}

For subjects that cannot be mapped into MeSH, the keywords free text field should be used.

contributors

The value of the compound contributors field should be encoded in a Data File Contributors element. The fields inside this element directly parallel the fields used in the RADx-DHT specification.

Multiple Data File Contributors elements may be specified. Use one element per contributor.

The JSON below shows a RADx-DHT example of a contributors JSON object.

"contributors": [
    {
      "name": "MIT Lincoln Laboratory",
      "nameType": "Organizational",
      "givenName": null,
      "familyName": null,
      "affiliation": [],
      "contributorType": "DataCurator",
      "nameIdentifiers": [
        {
          "schemeUri": "https://ror.org",
          "nameIdentifier": "https://ror.org/022z6jk58",
          "nameIdentifierScheme": "ROR"
        }
      ]
    }
  ]

Fields in a RADx-DHT contributors object should be mapped as follows. Note that,

the RADx metadata specification only supports one contributor affiliation per Data File Contributor element.
the RADx metadata specification only supports one contributor identifier per Data File Contributor element.

If the contributor is a person:

RADx Metadata Field	Value
Contributor Name	`contributors[0].name`
Contributor Type	`"http://vocab.fairdatacollective.org/gdmt/Person"`
Contributor Given Name	`contributors[0].givenName`
Contributor Family Name	`contributors[0].familyName`
Contributor Affiliation	`contributors[0].affiliation[0].name`
Contributor Affiliation Identifier Scheme	`contributors[0].affiliation[0].schemeUri`
Contributor Affiliation Identifier	`contributors[0].affiliation[0].affiliationIdentifier`
Contributor Identifier	`contributors[0].nameIdentifiers[0].nameIdentifier`
Contributor Identifier Scheme	`contributors[0].nameIdentifiers[0].schemeUri` If an ORCID has been used to identify the contributor then the value should be `"https://orcid.org"`.

If the contributor is an organization:

RADx Metadata Field	Value
Contributor Name	`contributors[0].name`
Contributor Type	`"http://vocab.fairdatacollective.org/gdmt/Organization"`
Contributor Identifier	`contributors[0].nameIdentifiers[0].nameIdentifier`
Contributor Identifier Scheme	`contributors[0].nameIdentifiers[0].schemeUri` If a Research Organization Registry (ROR) Id has been used to identify the contributing organization then the value should be `"https://ror.org"`

dates

The RADx-DHT dates field should be encoded in a Data File Dates element, except for publication date, which should be encoded in the Data File Publication Date element. There must be exactly one date per element. Dates represent events related to the data file itself. Dates of events related to the funded program should be encoded elsewhere.

publicationYear

The RADx-DHT publicationYear field should be encoded in a Data File Publication Date field inside a Data File Publication Date. This field can accept precise publication dates, which are preferred over "publication year", however if publication year is the only available metadata then please enter the publication year in yyyy format.

language

The RADx-DHT language field should be encoded in the Primary Language field contained in a Data File Language element. The encoding of languages uses standard language codes. These codes are directly mappable from the RADx-DHT specification.

identifiers

{
  "identifiers": []
}

Please consult with the Stanford Team. These identifiers may be enocded as Auxiliary Metadata.

sizes

The RADx-DHT sizes field should be encoded using fields from the Data File Distributions element. Values for this field should be merged with the values from the publisher field and formats field. Since RADx metadata pertains to a single file only the size related array element should be encoded.

{
  "sizes": [
    "6 MB",
    "33 Files"
  ]
}

RADx Metadata Field	Value
Distribution Size	The distribution size in bytes. To convert Megabytes to bytes multiply by 1,048,576. For example, 6MB is `6291456` bytes.

Since the RADx Metadata Specification applies to single files the "33 Files" value (or any other value) that indicates the number of files is not applicable here.

formats

The RADx-DHT formats field should be encoded using a field from the Distribution Format element. Values for this field should be merged with the values from the publisher field and sizes field.

{
  "formats": [
    "csv",
    "html",
    "pdf",
    "xlsx"
  ]
}

RADx Metadata Field	Value
Distribution Format	A value from the `formats` list, for example, `"csv"`.

version

Assuming that the RADx-DHT version field describes a version of the data file, it should be encoded in the Version field in the Data File Identity element. If the version field describes the version of something other than the data file then it should be encoded using the Auxiliary Metadata element.

{
  "version": "1.0"
}

rightsList

The Data File Rights element should be used to encode rights for the datafile. We recommend that an identifier for the license is chosen and entered into the License Name field.

If a standardized license is not used or if a license has been customized then the rights/license should be entered into the License Text field.

descriptions

The RADx-DHT descriptions field should be encoded using a Data File Descriptions element. One element should encode exactly one description.

{
    "descriptions": [
        {
            "lang": "en",
            "description": "This study integrated Covidseeker, a tool for real-tine geospatial temporal mobile data for digital contact tracing and COVID-19 hotspotting, into a customized version of the COVID-19 Citizen Science Study. ",
            "descriptionType": "Abstract"
        }
    ]
}

RADx Metadata Field	Value
Description	Value of `descriptions[0].description`
Description Language	Value of `descriptions[0].lang`

geoLocations

The RADx-DHT geoLocations field should be encoded using the Data File Spatial Coverage element. This element makes it possible to encode locations using bounded boxes/shapes that are described with lat/lon coordinates. Multiple locations can be specified.

If place names are used to specify locations then the Geopolitical Region field that is contained with in a Data File Geopolitical Coverage element should be used to provide an identifier for a place.

funding references

The RADx-DHT funding references field should be encoded using a Data File Funding Sources element.

The JSON below shows a RADx-DHT example of a funding element.

{
  "fundingReferences": [
    {
      "awardUri": "https://reporter.nih.gov/project-details/10274151",
      "awardTitle": "DIGITAL HEALTH SOLUTIONS FOR COVID-19: COVIDSEEKER AND COVID-19 CITIZEN SCIENCE",
      "funderName": "National Institutes of Health",
      "awardNumber": "75N91020C00039",
      "funderIdentifier": "https://doi.org/10.13039/100000002",
      "funderIdentifierType": "Crossref Funder ID"
    }
  ]
}

RADx Metadata Field	Value
Award Title	Value of `fundingReferences[0].awardTitle`
Award Page URL	Value of `fundingReferences[0].awardUri`
Funder Name	Value of `fundingReferences[0].funderName`
Award Local Identifier	`fundingReferences[0].awardNumber`
Funder Identifier	`fundingReferences[0].funderIdentifier`. We recommend that a Research Organization Registry identifier is used, if possible.
Funder Identifier Scheme	Choose one of the available values

relatedIdentifiers

{
  "relatedIdentifiers": []
}

This field may be encoded using the Data File Related Resources element. One element per related identifier should be used. For a given identifier, the Related Resource Identifier field should be used to encode the identifier and the other fields should be used to describe the type of identifier.

schemaVersion

{
  "schemaVersion": "http://datacite.org/schema/kernel-4"
}

This field is not applicable to the RADx Metadata Specification. You may however encode it using the Auxiliary Metadata element.

providerId

{
  "providerId": "mit"
}

This field is not directly supported in the RADx Metadata Specfification. You may encode it using the Auxiliary Metadata element.

clientId

{
  "clientId": "mit.rapids"
}

This field is not directly supported in the RADx Metadata Specfification. You may encode it using the Auxiliary Metadata element.

agency

{
  "agency": "datacite"
}

This field is not directly supported in the RADx Metadata Specfification. You may encode it using the Auxiliary Metadata element.

state

{
  "state": "draft"
}

This field is not directly supported in the RADx Metadata Specfification. You may encode it using the Auxiliary Metadata element.