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 Population Treatment Implications - XML Representation

Active as of 2023-12-18

Raw xml | Download



<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="find-population-tx-implications"/>
  <text>
    <status value="extensions"/>
    <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>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>
</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 from which implications are derived. Must be in token or codesystem|code format.</p>
</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>
</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>
</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>
</div></td></tr><tr><td>IN</td><td>includePatientList</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#boolean">boolean</a></td><td/><td><div><p>Include list of matching patients if set to true. Default=false.</p>
</div></td></tr><tr><td>OUT</td><td>implications</td><td/><td>1..1</td><td></td><td/><td/></tr><tr><td>OUT</td><td>implications.numerator</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#Quantity">Quantity</a></td><td/><td><div><p>Count of patients having this variant</p>
</div></td></tr><tr><td>OUT</td><td>implications.denominator</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#Quantity">Quantity</a></td><td/><td><div><p>Count of patients in the cohort searched</p>
</div></td></tr><tr><td>OUT</td><td>implications.subject</td><td/><td>0..*</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td/><td><div><p>Patient ID. Include if includePatientList=true</p>
</div></td></tr></table></div>
  </text>
  <extension
             url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
    <valueCode value="cg"/>
  </extension>
  <url
       value="http://hl7.org/fhir/uv/genomics-reporting/OperationDefinition/find-population-tx-implications"/>
  <version value="3.0.0-ballot"/>
  <name value="FindPopulationTxImplications"/>
  <title value="Find Population Treatment Implications"/>
  <status value="active"/>
  <kind value="operation"/>
  <date value="2023-12-18T22:45:59+00:00"/>
  <publisher value="HL7 International / Clinical Genomics"/>
  <contact>
    <name value="HL7 International / Clinical Genomics"/>
    <telecom>
      <system value="url"/>
      <value value="http://www.hl7.org/Special/committees/clingenomics"/>
    </telecom>
    <telecom>
      <system value="email"/>
      <value value="cg@lists.HL7.org"/>
    </telecom>
  </contact>
  <description
               value="Retrieve count or list of patients having therapeutic implications."/>
  <jurisdiction>
    <coding>
      <system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/>
      <code value="001"/>
      <display value="World"/>
    </coding>
  </jurisdiction>
  <code value="match"/>
  <system value="false"/>
  <type value="true"/>
  <instance value="false"/>
  <parameter>
    <name value="variants"/>
    <use value="in"/>
    <min value="0"/>
    <max value="*"/>
    <documentation
                   value="List of variants from which implications are derived. Must be in HGVS or SPDI format."/>
    <type value="string"/>
    <searchType value="string"/>
  </parameter>
  <parameter>
    <name value="haplotypes"/>
    <use value="in"/>
    <min value="0"/>
    <max value="*"/>
    <documentation
                   value="List of haplotypes from which implications are derived. Must be in token or codesystem|code format."/>
    <type value="string"/>
    <searchType value="token"/>
  </parameter>
  <parameter>
    <name value="treatments"/>
    <use value="in"/>
    <min value="0"/>
    <max value="*"/>
    <documentation
                   value="List of medications and/or other therapeutic interventions for which implications are sought. Must be in token or codesystem|code format."/>
    <type value="string"/>
    <searchType value="token"/>
  </parameter>
  <parameter>
    <name value="conditions"/>
    <use value="in"/>
    <min value="0"/>
    <max value="*"/>
    <documentation
                   value="List of conditions for which implications are sought. Must be in token or codesystem|code format."/>
    <type value="string"/>
    <searchType value="token"/>
  </parameter>
  <parameter>
    <name value="genomicSourceClass"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation
                   value="Enables an App to limit results to those that are 'germline' or 'somatic'. Default is to include variants irrespective of genomic source class."/>
    <type value="string"/>
    <searchType value="token"/>
  </parameter>
  <parameter>
    <name value="includePatientList"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation
                   value="Include list of matching patients if set to true. Default=false."/>
    <type value="boolean"/>
  </parameter>
  <parameter>
    <name value="implications"/>
    <use value="out"/>
    <min value="1"/>
    <max value="1"/>
    <part>
      <name value="numerator"/>
      <use value="out"/>
      <min value="1"/>
      <max value="1"/>
      <documentation value="Count of patients having this variant"/>
      <type value="Quantity"/>
    </part>
    <part>
      <name value="denominator"/>
      <use value="out"/>
      <min value="0"/>
      <max value="1"/>
      <documentation value="Count of patients in the cohort searched"/>
      <type value="Quantity"/>
    </part>
    <part>
      <name value="subject"/>
      <use value="out"/>
      <min value="0"/>
      <max value="*"/>
      <documentation value="Patient ID. Include if includePatientList=true"/>
      <type value="string"/>
    </part>
  </parameter>
</OperationDefinition>