Skip to content

Main content

Pharmacogene Reference Version Token

Qualify an explicit pharmacogene reference by version without validating an allele or gene annotation.

Loading tool…

Description

Qualify an explicit pharmacogene reference by version.

Pharmacogenomic records require a gene, reference build, version, assay method and stated allele/phasing convention. A star-allele string is not meaningful independently of its gene and authoritative definition. Syntax, separator and copy-count labels do not establish a genotype, phenotype, assay coverage or appropriate prescribing recommendation.

Qualify an explicit pharmacogene reference by version.

When to use this tool

Use Pharmacogene Reference Version Token when you already have geneLabel, referenceId, version and need to qualify an explicit pharmacogene reference by version.

How to use the tool and how it works

  1. Enter geneLabel, referenceId, version. Use the units and conventions below.
  2. Run the tool. Correct any format, range, or cross-field input error before interpreting the output.
  3. Read token. Use the output convention below.

Enter geneLabel, referenceId, version using the field constraints below. Encode these values, in exactly that order, as a JSON array and return the serialized array as text in token. String values are preserved without trimming or external terminology lookup.1

Input fieldMeaning and unitsAccepted input
geneLabelGene LabelRequired. Text; minimum UTF-16 length 1; maximum UTF-16 length 8192.
referenceIdReference IdRequired. Text; minimum UTF-16 length 1; maximum UTF-16 length 8192.
versionVersionRequired. Text; minimum UTF-16 length 1; maximum UTF-16 length 8192.
Output fieldInterpretationReturned shape
tokenTokenRequired. Text; maximum UTF-16 length 8192.
json
{
  "input": {
    "geneLabel": "GENE-A",
    "referenceId": "REF17",
    "version": "v2"
  },
  "output": {
    "token": "[\"GENE-A\",\"REF17\",\"v2\"]"
  }
}

Limitations and assumptions

  • The result records supplied values without validating an allele or gene annotation. Sources and asserted relationships are not independently authenticated.
  • Inputs must satisfy both the field types and the cross-field conditions above. Invalid input causes an error; a successful false flag or documented placeholder is a different result.

Alternative or Complementary methods

Resolve allele definitions against the correct gene, reference build, assay scope and authoritative version. Treat syntax parsing and no-call/phasing labels as record checks; applying a clinical guideline requires the complete verified genetic and clinical context.

References

  1. Calculation and input contract: pharmacogenomics/pharmacogene-reference-version-token — tool.io

Similar or alternative tools