CIMAC-CIDC/cidc-schemas

View on GitHub
cidc_schemas/schemas/aliquot.json

Summary

Maintainability
Test Coverage
{
  "$schema": "metaschema/strict_meta_schema.json#",
  "$id": "aliquot",
  "title": "Aliquot",
  "type": "object",
  "description": "Pertaining to a portion (volume or weight) of the whole.",
  "additionalProperties": false,
  "properties": {
    "slide_number": {
      "description": "Two digit number that indicates the sequential order of slide cuts, assigned by the CIMAC-CIDC Network.",
      "pattern": "^[0-9]{1,2}$",
      "type": "string"
    },
    "quantity": {
      "description": "Quantity of each aliquot shipped.",
      "type": "integer"
    },
    "aliquot_replacement": {
      "description": "Status of aliquot if replacement is/was requested.",
      "type": "string",
      "enum": ["Replacement Requested", "Replacement Tested", "N/A"]
    },
    "aliquot_status": {
      "description": "Status of aliquot used for other assay, exhausted, destroyed, or returned.",
      "type": "string",
      "enum": [
        "Aliquot Returned",
        "Aliquot Exhausted",
        "Remainder used for other Assay",
        "Other",
        "Aliquot Leftover"
      ]
    },
    "material_extracted": {
      "description": "The type of biological material that was extracted from this aliquot.",
      "type": "string",
      "enum": ["DNA", "RNA", "cfDNA", "Other"]
    },
    "extracted_concentration": {
      "description": "The concentration of biological material that was extracted from this aliquot.",
      "type": "string"
    },
    "aliquot_amount": {
      "$comment": "RECHECK Should this be moved to the sample level or renamed?",
      "description": "The amount of extracted aliquot shipped. Example: 400 ng",
      "type": "string"
    },
    "lymphocyte_influx": {
      "description": "Extent of lymphocytic infiltration into the tumor stroma or surrounding environment. Example: 2",
      "type": "string"
    }
  },
  "required": [
    "slide_number",
    "aliquot_replacement",
    "aliquot_status"
  ]
}