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 - JSON Representation
Raw json | Download
{
"resourceType" : "OperationDefinition",
"id" : "find-population-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>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>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>\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>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>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>\n</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>\n</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>\n</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>\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-population-tx-implications",
"version" : "3.0.0-ballot",
"name" : "FindPopulationTxImplications",
"title" : "Find Population 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" : "Retrieve count or list of patients having therapeutic implications.",
"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" : "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" : "haplotypes",
"use" : "in",
"min" : 0,
"max" : "*",
"documentation" : "List of haplotypes 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" : "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"
},
{
"name" : "includePatientList",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "Include list of matching patients if set to true. Default=false.",
"type" : "boolean"
},
{
"name" : "implications",
"use" : "out",
"min" : 1,
"max" : "1",
"part" : [
{
"name" : "numerator",
"use" : "out",
"min" : 1,
"max" : "1",
"documentation" : "Count of patients having this variant",
"type" : "Quantity"
},
{
"name" : "denominator",
"use" : "out",
"min" : 0,
"max" : "1",
"documentation" : "Count of patients in the cohort searched",
"type" : "Quantity"
},
{
"name" : "subject",
"use" : "out",
"min" : 0,
"max" : "*",
"documentation" : "Patient ID. Include if includePatientList=true",
"type" : "string"
}
]
}
]
}
|
Propose a change