neurobagel_data_dictionary.schema.json

{
  "title": "Neurobagel Data Dictionary Schema",
  "$ref": "#/definitions/DataDictionary",
  "definitions": {
    "Identifier": {
      "title": "Identifier",
      "description": "An identifier of a controlled term with an IRI",
      "type": "object",
      "properties": {
        "TermURL": {
          "title": "Termurl",
          "description": "An unambiguous identifier for the term, concept or entity that is referenced",
          "type": "string"
        },
        "Label": {
          "title": "Label",
          "description": "A human readable label. If more than one label exists for the term, then the preferred label should be used.",
          "type": "string"
        }
      },
      "required": [
        "TermURL",
        "Label"
      ]
    },
    "CategoricalNeurobagel": {
      "title": "CategoricalNeurobagel",
      "description": "A Neurobagel annotation for a categorical column",
      "type": "object",
      "properties": {
        "IsAbout": {
          "title": "Isabout",
          "description": "The concept or controlled term that describes this column",
          "allOf": [
            {
              "$ref": "#/definitions/Identifier"
            }
          ]
        },
        "MissingValues": {
          "title": "Missingvalues",
          "description": "A list of unique values that represent invalid responses, typos, or missing data",
          "default": [],
          "uniqueItems": true,
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "Levels": {
          "title": "Levels",
          "description": "For categorical variables: An object of values (keys) in the column and the semanticterm (URI and label) they are unambiguously mapped to.",
          "type": "object",
          "additionalProperties": {
            "$ref": "#/definitions/Identifier"
          }
        }
      },
      "required": [
        "IsAbout",
        "Levels"
      ],
      "additionalProperties": false
    },
    "ContinuousNeurobagel": {
      "title": "ContinuousNeurobagel",
      "description": "A Neurobagel annotation for a continuous column",
      "type": "object",
      "properties": {
        "IsAbout": {
          "title": "Isabout",
          "description": "The concept or controlled term that describes this column",
          "allOf": [
            {
              "$ref": "#/definitions/Identifier"
            }
          ]
        },
        "MissingValues": {
          "title": "Missingvalues",
          "description": "A list of unique values that represent invalid responses, typos, or missing data",
          "default": [],
          "uniqueItems": true,
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "Transformation": {
          "title": "Transformation",
          "description": "For continuous columns this field can be used to describea transformation that can be applied to the values in thiscolumn in order to match the desired format of a standardizeddata element referenced in the IsAbout attribute.",
          "allOf": [
            {
              "$ref": "#/definitions/Identifier"
            }
          ]
        }
      },
      "required": [
        "IsAbout",
        "Transformation"
      ],
      "additionalProperties": false
    },
    "IdentifierNeurobagel": {
      "title": "IdentifierNeurobagel",
      "description": "A Neurobagel annotation for an identifier column",
      "type": "object",
      "properties": {
        "IsAbout": {
          "title": "Isabout",
          "description": "The concept or controlled term that describes this column",
          "allOf": [
            {
              "$ref": "#/definitions/Identifier"
            }
          ]
        },
        "MissingValues": {
          "title": "Missingvalues",
          "description": "A list of unique values that represent invalid responses, typos, or missing data",
          "default": [],
          "uniqueItems": true,
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "Identifies": {
          "title": "Identifies",
          "description": "For identifier columns, the type of observation uniquely identified by this column.",
          "type": "string"
        }
      },
      "required": [
        "IsAbout",
        "Identifies"
      ],
      "additionalProperties": false
    },
    "ToolNeurobagel": {
      "title": "ToolNeurobagel",
      "description": "A Neurobagel annotation for an assessment tool column",
      "type": "object",
      "properties": {
        "IsAbout": {
          "title": "Isabout",
          "description": "The concept or controlled term that describes this column",
          "allOf": [
            {
              "$ref": "#/definitions/Identifier"
            }
          ]
        },
        "MissingValues": {
          "title": "Missingvalues",
          "description": "A list of unique values that represent invalid responses, typos, or missing data",
          "default": [],
          "uniqueItems": true,
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "IsPartOf": {
          "title": "Ispartof",
          "description": "If the column is a subscale or item of an assessment tool then the assessment tool should be specified here.",
          "allOf": [
            {
              "$ref": "#/definitions/Identifier"
            }
          ]
        }
      },
      "required": [
        "IsAbout",
        "IsPartOf"
      ],
      "additionalProperties": false
    },
    "ContinuousColumn": {
      "title": "ContinuousColumn",
      "description": "A BIDS column annotation for a continuous column",
      "type": "object",
      "properties": {
        "Description": {
          "title": "Description",
          "description": "Free-form natural language description",
          "type": "string"
        },
        "Annotations": {
          "title": "Annotations",
          "description": "Semantic annotations",
          "anyOf": [
            {
              "$ref": "#/definitions/CategoricalNeurobagel"
            },
            {
              "$ref": "#/definitions/ContinuousNeurobagel"
            },
            {
              "$ref": "#/definitions/IdentifierNeurobagel"
            },
            {
              "$ref": "#/definitions/ToolNeurobagel"
            }
          ]
        },
        "Units": {
          "title": "Units",
          "description": "Measurement units for the values in this column. SI units in CMIXF formatting are RECOMMENDED (see Units)",
          "type": "string"
        }
      },
      "required": [
        "Description"
      ]
    },
    "CategoricalColumn": {
      "title": "CategoricalColumn",
      "description": "A BIDS column annotation for a categorical column",
      "type": "object",
      "properties": {
        "Description": {
          "title": "Description",
          "description": "Free-form natural language description",
          "type": "string"
        },
        "Annotations": {
          "title": "Annotations",
          "description": "Semantic annotations",
          "anyOf": [
            {
              "$ref": "#/definitions/CategoricalNeurobagel"
            },
            {
              "$ref": "#/definitions/ContinuousNeurobagel"
            },
            {
              "$ref": "#/definitions/IdentifierNeurobagel"
            },
            {
              "$ref": "#/definitions/ToolNeurobagel"
            }
          ]
        },
        "Levels": {
          "title": "Levels",
          "description": "For categorical variables: An object of possible values (keys) and their descriptions (values). ",
          "type": "object",
          "additionalProperties": {
            "type": "string"
          }
        }
      },
      "required": [
        "Description",
        "Levels"
      ]
    },
    "DataDictionary": {
      "title": "DataDictionary",
      "description": "A data dictionary with human and machine readable information for a tabular data file",
      "type": "object",
      "additionalProperties": {
        "anyOf": [
          {
            "$ref": "#/definitions/ContinuousColumn"
          },
          {
            "$ref": "#/definitions/CategoricalColumn"
          }
        ]
      }
    }
  }
}