Skip to content

Metadata spec and JSON schema

Compare
Choose a tag to compare
@malloryfreeberg malloryfreeberg released this 05 Dec 15:58
· 4331 commits to master since this release

This is a minor update release to the V4 metadata spec. Changes in V4.2.0 include:

  1. Changed the following donor.json fields from number type to string type with a regex to allow entering a number range (e.g. to enter "50-60" for age). The regex is: ^[0-9]+\\.?[0-9]*-?[0-9]*\\.?[0-9]*$
  • donor.height
  • donor.weight
  • donor.age
  1. Extended enums for "donor.age_unit" to allow for the plural form (e.g. "years" in addition to "year")

  2. Changed "time_of_death" from required field to optional field in death.json because some users would not have access to this information (could be used to identify a patient).

All changes maintain backwards compatibility.

The V4 metadata schema is found here:
https://docs.google.com/document/d/12BTAyZip9Q3r0Nm-L3ws6WzMmVi_kmUUcvOTrO47l2s/edit

The V4 metadata schema was developed by the HCA metadata team at EMBL-EBI. It consists primarily of structural changes to the V3 schema to make the HCA metadata schema fully compatible with JSON schema and facilitate automatic schema validation. The release contains some sample data for testing and the metadata team are currently updating previous example data from the Q3 demo to conform to the V4 metadata schema.

A template spreadsheet to capture V4 metadata can be found here: https://docs.google.com/spreadsheets/d/1OboVETG6lQpdRm2-m5uRbk1gk80o_Yo2FqSzXDb_VxY

A document detailing the field-by-field changes from V3 to V4 can be found here:
https://docs.google.com/document/d/1DouNpWH6xaFICqPZ6fwxzfPzJOmf5FUuQ8h_MrDEKdA

A high-level overview document of V3-to-V4 changes can be found here:
https://docs.google.com/a/ebi.ac.uk/document/d/12BTAyZip9Q3r0Nm-L3ws6WzMmVi_kmUUcvOTrO47l2s