expression_result.yaml

$schema: "http://json-schema.org/draft-04/schema#"

id: "expression_result"
title: Expression Result
type: object
nodeTerms: null
namespace: https://gen3.datacommons.io/
category: data_observations
program: '*'
project: '*'
description: Expression profiling results.
additionalProperties: false
submittable: true
validators: null

systemProperties:
  - id
  - project_id
  - state
  - created_datetime
  - updated_datetime

links:
  - exclusive: false
    required: true
    subgroup:
      - name: subjects
        backref: expression_results
        label: related_to
        target_type: subject
        multiplicity: many_to_many
        required: false
      - name: aliquots
        backref: expression_results
        label: related_to
        target_type: aliquot
        multiplicity: many_to_many
        required: false

required:
  - submitter_id
  - type

uniqueKeys:
  - [id]
  - [project_id, submitter_id]

properties:

  $ref: "_definitions.yaml#/ubiquitous_properties"

  analyte_name:
    description: The name of the gene, protein, miRNA, RNA, antibody or other molecule
      that corresponds to the 'test_result' or 'test_value
    type: string

  comments:
    description: Specific comments about or customization of the experiment
    type: string

  days_to_test:
    description: The total number of days between the test and the index date. The
      date of the test less the date of index.
    type: integer

  experimental_method:
    description: The experimental method used for the expression assay.
    type: string

  experimental_method_other:
    description: The test method if 'Other (specify)' was chosen for 'test_method
    type: string

  gene_category:
    description: Gene Category
    type: string

  gene_category_other:
    description: Specify the Gene Category if 'Other (specify)' was chosen for 'gene_category
    type: string

  high_range:
    description: The high range of expression for this assay.
    type: number

  low_range:
    description: The low range of expression for this assay.
    type: number

  mutant_fraction_percent:
    description: Percent of the target that is identified as mutant.
    type: number

  mutation_result:
    description: Observed mutation type.
    type: string

  sample_composition:
    description: The type or composition of the sample or biological specimen taken
      from a study subject used for the test.
    type: string

  analyte_type:
    description: A biological molecule assayed in the test.
    type: string

  test_code:
    description: The code used for an expression assay.
    type: string

  assay_method:
    description: The method used to obtain the expression results.
    type: string

  test_name:
    description: The name of the assay used to obtain the expression results.
    type: string
  test_version:
    description: The version of the assay used to obtain the expression results.
    type: string

  test_project_id:
    description: The identifier of a project for the laboratory test
    type: string

  test_result:
    description: The categorical result of the laboratory test.
    type: string

  test_units:
    description: The units corresponding to a test_value for a test_analyte_type
    type: string

  test_units_other:
    description: The units corresponding to a test_value for a test_analyte_type if
      'Other (specify)' was chosen for 'test_units
    type: string

  test_value:
    description: The numerical value representing the laboratory test result for the
      analyte_type
    type: number

  year_of_test:
    description: Year of Test
    type: integer

  panel_definition_ids:
    description: The ids or submitter_ids of any associated panel definitions.
    type: array
    items:
      type: string

  aliquots:
    $ref: "_definitions.yaml#/to_many"
  subjects:
    $ref: "_definitions.yaml#/to_many"