Genomics Reporting Implementation Guide
3.0.0-ballot - Ballot International flag

This page is part of the Genetic Reporting Implementation Guide (v3.0.0-ballot: STU 3 Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 2.0.0. For a full list of available versions, see the Directory of published versions

: Find Subject Treatment Implications - JSON Representation

Active as of 2023-12-18

Raw json | Download


{
  "resourceType" : "OperationDefinition",
  "id" : "find-subject-tx-implications",
  "text" : {
    "status" : "extensions",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p>Parameters</p><table class=\"grid\"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Scope</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>IN</td><td>subject</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a><br/>(<a href=\"http://hl7.org/fhir/R4/search.html#reference\">reference</a>)</td><td/><td><div><p>The subject of interest.</p>\n</div></td></tr><tr><td>IN</td><td>variants</td><td/><td>0..*</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a><br/>(<a href=\"http://hl7.org/fhir/R4/search.html#string\">string</a>)</td><td/><td><div><p>List of variants from which implications are derived. Must be in HGVS or SPDI format.</p>\n</div></td></tr><tr><td>IN</td><td>ranges</td><td/><td>0..*</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a><br/>(<a href=\"http://hl7.org/fhir/R4/search.html#special\">special</a>)</td><td/><td><div><p>List of regions to be searched for variants. Must be in zero-based RefSeq:Integer-range format (e.g. 'NC_000007.14:55174721-55174820').</p>\n</div></td></tr><tr><td>IN</td><td>haplotypes</td><td/><td>0..*</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a><br/>(<a href=\"http://hl7.org/fhir/R4/search.html#token\">token</a>)</td><td/><td><div><p>List of haplotypes and/or genotypes from which implications are derived. Must be in token or codesystem|code format.</p>\n</div></td></tr><tr><td>IN</td><td>treatments</td><td/><td>0..*</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a><br/>(<a href=\"http://hl7.org/fhir/R4/search.html#token\">token</a>)</td><td/><td><div><p>List of medications and/or other therapeutic interventions for which implications are sought. Must be in token or codesystem|code format.</p>\n</div></td></tr><tr><td>IN</td><td>conditions</td><td/><td>0..*</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a><br/>(<a href=\"http://hl7.org/fhir/R4/search.html#token\">token</a>)</td><td/><td><div><p>List of conditions for which implications are sought. Must be in token or codesystem|code format.</p>\n</div></td></tr><tr><td>IN</td><td>testIdentifiers</td><td/><td>0..*</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a><br/>(<a href=\"http://hl7.org/fhir/R4/search.html#token\">token</a>)</td><td/><td><div><p>Supply a list of test identifiers. Only results originating from one of these tests will be returned.</p>\n</div></td></tr><tr><td>IN</td><td>testDateRange</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#Period\">Period</a></td><td/><td><div><p>Supply a date range. Only results generated during this range will be returned.</p>\n</div></td></tr><tr><td>IN</td><td>specimenIdentifiers</td><td/><td>0..*</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a><br/>(<a href=\"http://hl7.org/fhir/R4/search.html#token\">token</a>)</td><td/><td><div><p>Supply a list of specimen identifiers. Only results derived from one of these specimens will be returned.</p>\n</div></td></tr><tr><td>IN</td><td>genomicSourceClass</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a><br/>(<a href=\"http://hl7.org/fhir/R4/search.html#token\">token</a>)</td><td/><td><div><p>Enables an App to limit results to those that are 'germline' or 'somatic'. Default is to include variants irrespective of genomic source class.</p>\n</div></td></tr><tr><td>OUT</td><td>implication</td><td/><td>0..*</td><td><a href=\"http://hl7.org/fhir/R4/observation.html\">Observation</a></td><td/><td><div><p>Implications must conform to [Profile: http://hl7.org/fhir/uv/genomics-reporting/StructureDefinition/therapeutic-implication]. The target(s) of the implication's derivedFrom shall also be included in the response.</p>\n</div></td></tr><tr><td>OUT</td><td>variant</td><td/><td>0..*</td><td><a href=\"http://hl7.org/fhir/R4/observation.html\">Observation</a></td><td/><td><div><p>Variants must conform to [Profile: http://hl7.org/fhir/uv/genomics-reporting/StructureDefinition/variant].</p>\n</div></td></tr><tr><td>OUT</td><td>haplotype</td><td/><td>0..*</td><td><a href=\"http://hl7.org/fhir/R4/observation.html\">Observation</a></td><td/><td><div><p>Haplotypes must conform to [Profile: http://hl7.org/fhir/uv/genomics-reporting/StructureDefinition/haplotype].</p>\n</div></td></tr><tr><td>OUT</td><td>genotype</td><td/><td>0..*</td><td><a href=\"http://hl7.org/fhir/R4/observation.html\">Observation</a></td><td/><td><div><p>Genotypes must conform to [Profile: http://hl7.org/fhir/uv/genomics-reporting/StructureDefinition/genotype].</p>\n</div></td></tr></table></div>"
  },
  "extension" : [
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode" : "cg"
    }
  ],
  "url" : "http://hl7.org/fhir/uv/genomics-reporting/OperationDefinition/find-subject-tx-implications",
  "version" : "3.0.0-ballot",
  "name" : "FindSubjectTxImplications",
  "title" : "Find Subject Treatment Implications",
  "status" : "active",
  "kind" : "operation",
  "date" : "2023-12-18T22:45:59+00:00",
  "publisher" : "HL7 International / Clinical Genomics",
  "contact" : [
    {
      "name" : "HL7 International / Clinical Genomics",
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://www.hl7.org/Special/committees/clingenomics"
        },
        {
          "system" : "email",
          "value" : "cg@lists.HL7.org"
        }
      ]
    }
  ],
  "description" : "Retrieves genetic therapeutic implications for variants/haplotypes/genotypes.",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code" : "001",
          "display" : "World"
        }
      ]
    }
  ],
  "code" : "match",
  "system" : false,
  "type" : true,
  "instance" : false,
  "parameter" : [
    {
      "name" : "subject",
      "use" : "in",
      "min" : 1,
      "max" : "1",
      "documentation" : "The subject of interest.",
      "type" : "string",
      "searchType" : "reference"
    },
    {
      "name" : "variants",
      "use" : "in",
      "min" : 0,
      "max" : "*",
      "documentation" : "List of variants from which implications are derived. Must be in HGVS or SPDI format.",
      "type" : "string",
      "searchType" : "string"
    },
    {
      "name" : "ranges",
      "use" : "in",
      "min" : 0,
      "max" : "*",
      "documentation" : "List of regions to be searched for variants. Must be in zero-based RefSeq:Integer-range format (e.g. 'NC_000007.14:55174721-55174820').",
      "type" : "string",
      "searchType" : "special"
    },
    {
      "name" : "haplotypes",
      "use" : "in",
      "min" : 0,
      "max" : "*",
      "documentation" : "List of haplotypes and/or genotypes from which implications are derived. Must be in token or codesystem|code format.",
      "type" : "string",
      "searchType" : "token"
    },
    {
      "name" : "treatments",
      "use" : "in",
      "min" : 0,
      "max" : "*",
      "documentation" : "List of medications and/or other therapeutic interventions for which implications are sought. Must be in token or codesystem|code format.",
      "type" : "string",
      "searchType" : "token"
    },
    {
      "name" : "conditions",
      "use" : "in",
      "min" : 0,
      "max" : "*",
      "documentation" : "List of conditions for which implications are sought. Must be in token or codesystem|code format.",
      "type" : "string",
      "searchType" : "token"
    },
    {
      "name" : "testIdentifiers",
      "use" : "in",
      "min" : 0,
      "max" : "*",
      "documentation" : "Supply a list of test identifiers. Only results originating from one of these tests will be returned.",
      "type" : "string",
      "searchType" : "token"
    },
    {
      "name" : "testDateRange",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "Supply a date range. Only results generated during this range will be returned.",
      "type" : "Period"
    },
    {
      "name" : "specimenIdentifiers",
      "use" : "in",
      "min" : 0,
      "max" : "*",
      "documentation" : "Supply a list of specimen identifiers. Only results derived from one of these specimens will be returned.",
      "type" : "string",
      "searchType" : "token"
    },
    {
      "name" : "genomicSourceClass",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "Enables an App to limit results to those that are 'germline' or 'somatic'. Default is to include variants irrespective of genomic source class.",
      "type" : "string",
      "searchType" : "token"
    },
    {
      "extension" : [
        {
          "url" : "http://hl7.org/fhir/StructureDefinition/operationdefinition-profile",
          "valueUri" : "http://hl7.org/fhir/uv/genomics-reporting/StructureDefinition/therapeutic-implication"
        }
      ],
      "name" : "implication",
      "use" : "out",
      "min" : 0,
      "max" : "*",
      "documentation" : "Implications must conform to [Profile: http://hl7.org/fhir/uv/genomics-reporting/StructureDefinition/therapeutic-implication]. The target(s) of the implication's derivedFrom shall also be included in the response.",
      "type" : "Observation"
    },
    {
      "extension" : [
        {
          "url" : "http://hl7.org/fhir/StructureDefinition/operationdefinition-profile",
          "valueUri" : "http://hl7.org/fhir/uv/genomics-reporting/StructureDefinition/variant"
        }
      ],
      "name" : "variant",
      "use" : "out",
      "min" : 0,
      "max" : "*",
      "documentation" : "Variants must conform to [Profile: http://hl7.org/fhir/uv/genomics-reporting/StructureDefinition/variant].",
      "type" : "Observation"
    },
    {
      "extension" : [
        {
          "url" : "http://hl7.org/fhir/StructureDefinition/operationdefinition-profile",
          "valueUri" : "http://hl7.org/fhir/uv/genomics-reporting/StructureDefinition/haplotype"
        }
      ],
      "name" : "haplotype",
      "use" : "out",
      "min" : 0,
      "max" : "*",
      "documentation" : "Haplotypes must conform to [Profile: http://hl7.org/fhir/uv/genomics-reporting/StructureDefinition/haplotype].",
      "type" : "Observation"
    },
    {
      "extension" : [
        {
          "url" : "http://hl7.org/fhir/StructureDefinition/operationdefinition-profile",
          "valueUri" : "http://hl7.org/fhir/uv/genomics-reporting/StructureDefinition/genotype"
        }
      ],
      "name" : "genotype",
      "use" : "out",
      "min" : 0,
      "max" : "*",
      "documentation" : "Genotypes must conform to [Profile: http://hl7.org/fhir/uv/genomics-reporting/StructureDefinition/genotype].",
      "type" : "Observation"
    }
  ]
}