dataset.json

{
  "$schema": "http://json-schema.org/draft-07/schema",
  "$id": "https://github.com/cdsig/CDSIG-Schema/blob/main/dataset.json",
  "title": "Dataset-level metadata",
  "description": "Dataset-level metadata is metadata concerning one specific, per-participant dataset",
  "type": "object",
  "properties": {
    "name": {
      "title": "Dataset name",
      "description": "Dataset name.",
      "example": "ACHM2019_Actigraphy_P01",
      "type": "string"
    },
    "device_internal_id": {
      "title": "Internal ID of Device",
      "description": "Unique identifier of the device in this dataset",
      "type": "string"
    },
    "participant_internal_id": {
      "title": "Internal ID of Participant",
      "description": "Unique identifier of the participant in this dataset",
      "type": "string"
    },
    "uuid": {
      "title": "UUID",
      "description": "MD5 hash generated from the `name` field",
      "example": "9b4cef4132e84329bc38dda4b2fa3f5b",
      "type": "string"
    },
    "description": {
      "title": "Description",
      "description": "Short description of the dataset.",
      "example": "",
      "type": "string"
    },
    "instructions": {
      "title": "Instructions",
      "description": "Description of the instructions that were given to the study participants prior to or during collection of this data set",
      "type": "object",
      "properties": {
        "verbatim_instruction": {
          "title": "Verbatim instruction",
          "description": "Verbatim instructions given to participant",
          "example": "",
          "type": "string"
        },
        "wear_time": {
          "title": "Wear time",
          "description": "Number of days the participants were instructed to wear the actigraph. Fractional values are allowed",
          "example": 21,
          "type": "number",
          "minimum": 0
        }
      },
      "required": ["wear_time"]
    },
    "contributors": {
      "title": "Contributors",
      "type": "array",
      "items": {
        "$ref": "https://raw.githubusercontent.com/cdsig/CDSIG-Schema/main/person.json"
      }
    },
    "acquisitions": {
      "title": "Acquisitions",
      "type": "array",
      "items": {
        "$ref": "https://raw.githubusercontent.com/cdsig/CDSIG-Schema/main/acquisition.json"
      }
    },
    "data_set": {
      "title": "Dataset",
      "description": "Information about the data collection effort.",
      "type": "object",
      "properties": {
        "period": {
          "title": "Period",
          "description": "Time period during which the data collection was performed",
          "type": "object",
          "properties": {
            "start_date_time": {
              "title": "Start datetime",
              "description": "Start date-time for the data collection",
              "type": "string",
              "format": "date-time"
            },
            "ongoing": {
              "title": "Ongoing?",
              "description": "Indicate if the data collection is still ongoing",
              "type": "boolean",
              "default": true
            }
          },
          "dependencies": {
            "ongoing": {
              "oneOf": [
                {
                  "properties": {
                    "ongoing": {
                      "const": true
                    }
                  }
                },
                {
                  "properties": {
                    "ongoing": {
                      "const": false
                    },
                    "stop_date_time": {
                      "title": "Stop datetime",
                      "description": "Stop date-time for the data collection",
                      "type": "string",
                      "format": "date-time"
                    }
                  },
                  "required": ["stop_date_time"]
                }
              ]
            }
          }
        }
      },
      "required": ["period"]
    }
  },
  "required": ["uuid", "description", "instructions", "contributors"]
}