treatment_schema.json

{
  "$id": "https://w3id.org/dats/schema/treatment_schema.json",
  "$schema": "http://json-schema.org/draft-07/schema",
  "title": "DATS treatment schema",
  "description": "Process, part of a study, consisting in exposing participants to the study to different conditions or group those participants into different categories based on specific criteria and compare their outcomes",
  "type": "object",
  "properties": {
    "@context": {
      "description": "The JSON-LD context",
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "object"
        },
        {
          "type": "array"
        }
      ]
    },
    "@id": {
      "description": "The JSON-LD identifier",
      "type": "string",
      "format": "uri"
    },
    "@type": {
      "description": "The JSON-LD type",
      "type": "string",
      "const": "Treatment"
    },
    "identifier": {
      "description": "The identifier of the treatment.",
      "$ref": "identifier_info_schema.json#"
    },
    "alternateIdentifiers": {
      "description": "Alternate identifiers for the activity.",
      "type": "array",
      "items": {
        "$ref": "alternate_identifier_info_schema.json#"
      }
    },
    "relatedIdentifiers": {
      "description": "Related identifiers for the activity.",
      "type": "array",
      "items": {
        "$ref": "related_identifier_info_schema.json#"
      }
    },
    "name": {
      "description": "The name of the activity, usually one sentece or short description of the treatment.",
      "type" :  "string"
    },
    "description" : {
      "description": "A textual narrative comprised of one or more statements describing the treatment.",
      "type" : "string"
    },
    "startDate": {
      "description": "A timestamp to record the starting point of the activity.",
      "$ref": "date_info_schema.json#"
    },
    "endDate": {
      "description": "A timestamp to record the end point of the activity.",
      "$ref": "date_info_schema.json#"
    },
    "dates" : {
      "description": "Relevant dates for the datasets, a date must be added, e.g. creation date or last modification date should be added.",
      "type" : "array",
      "items" : {
        "$ref" : "date_info_schema.json#"
      }
    },
    "duration": {
      "description": "The time during which the activity takes place.",
      "type" :  "string"
    },
    "location" : {
      "description": "The location where the activity takes place.",
      "$ref" : "place_schema.json#"
    },
    "performedBy" : {
      "description": "The person(s) or organisation(s) responsible for executing the process.",
      "type" : "array",
      "items" : {
        "anyOf": [
          {"$ref" : "person_schema.json#"},
          {"$ref" : "organization_schema.json#"}
        ]
      }
    },

    "keywords": {
      "description": "Tags associated with the activity, which will help in its discovery.",
      "type": "array",
      "items": {
        "$ref" : "annotation_schema.json#"
      }
    },
    "input" : {
      "description": "The entities used as input.",
      "type": "array",
      "items":{
        "$ref" : "study_group_schema.json#"
      },
      "minItems": 1
    },
    "output" : {
      "description": "The entities resulting from applying the activity.",
      "type": "array",
      "items":{
        "$ref" : "study_group_schema.json#"
      }
    },
    "agent": {
      "description": "The nature of the perturbation or intervention used in the treatment.",
      "oneOf": [
        {"$ref": "molecular_entity_schema.json#"},
        {"$ref": "material_schema.json#"},
        {"$ref": "activity_schema.json#"},
        {
          "type": "string",
          "format": "uri"
        }
      ]
    },
    "intensity": {
      "description": "A measurement about how acute the perturbation is.",
      "type": "array",
      "items": {
        "oneOf": [
          {"type": "string"},
          {"type": "number"}
        ]
      }
    },
    "concomitance": {
      "description": "A boolean value to indicate if more that one perturbations are applied at the same time to the same subject.",
      "type": "boolean"
    },
    "order": {
      "description": "The rank in which perturbations are being applied to study subjects.",
      "type": "number"
    },
    "extraProperties": {
      "description": "Extra properties that do not fit in the previous specified attributes. ",
      "type": "array",
      "items": {
        "$ref" : "category_values_pair_schema.json#"
      }
    }
  },
  "additionalProperties": false,
  "required": [ "name", "input" ]
}