This page is part of the Genetic Reporting Implementation Guide (v3.0.0: STU3) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
Active as of 2024-12-12 |
@prefix fhir: <http://hl7.org/fhir/> .
@prefix owl: <http://www.w3.org/2002/07/owl#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
# - resource -------------------------------------------------------------------
a fhir:OperationDefinition ;
fhir:nodeRole fhir:treeRoot ;
fhir:id [ fhir:v "find-subject-molecular-consequences"] ; #
fhir:text [
fhir:status [ fhir:v "generated" ] ;
fhir:div "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition find-subject-molecular-consequences</b></p><a name=\"find-subject-molecular-consequences\"> </a><a name=\"hcfind-subject-molecular-consequences\"> </a><a name=\"find-subject-molecular-consequences-en-US\"> </a><h3>Parameters</h3><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 consequences 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>featureConsequences</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 consequences sought. Must be in token or codesystem|code format. (These will generally be coded with Sequence Ontology codes under SO:0001537)</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>consequence</td><td/><td>0..*</td><td><a href=\"http://hl7.org/fhir/R4/observation.html\">Observation</a></td><td/><td><div><p>Consequences must conform to [Profile: http://hl7.org/fhir/uv/genomics-reporting/StructureDefinition/molecular-consequence]. The target(s) of the consequence'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></table></div>"
] ; #
fhir:extension ( [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg"^^xsd:anyURI ] ;
fhir:value [ fhir:v "cg" ]
] ) ; #
fhir:url [ fhir:v "http://hl7.org/fhir/uv/genomics-reporting/OperationDefinition/find-subject-molecular-consequences"^^xsd:anyURI] ; #
fhir:version [ fhir:v "3.0.0"] ; #
fhir:name [ fhir:v "FindSubjectMolecularConsequences"] ; #
fhir:title [ fhir:v "Find Subject Molecular Consequences"] ; #
fhir:status [ fhir:v "active"] ; #
fhir:kind [ fhir:v "operation"] ; #
fhir:date [ fhir:v "2024-12-12T20:43:36+00:00"^^xsd:dateTime] ; #
fhir:publisher [ fhir:v "HL7 International / Clinical Genomics"] ; #
fhir:contact ( [
fhir:name [ fhir:v "HL7 International / Clinical Genomics" ] ;
( fhir:telecom [
fhir:system [ fhir:v "url" ] ;
fhir:value [ fhir:v "http://www.hl7.org/Special/committees/clingenomics" ] ] [
fhir:system [ fhir:v "email" ] ;
fhir:value [ fhir:v "cg@lists.HL7.org" ] ] )
] ) ; #
fhir:description [ fhir:v "Retrieves molecular consequences of a DNA variant."] ; #
fhir:jurisdiction ( [
( fhir:coding [
fhir:system [ fhir:v "http://unstats.un.org/unsd/methods/m49/m49.htm"^^xsd:anyURI ] ;
fhir:code [ fhir:v "001" ] ;
fhir:display [ fhir:v "World" ] ] )
] ) ; #
fhir:code [ fhir:v "match"] ; #
fhir:system [ fhir:v "false"^^xsd:boolean] ; #
fhir:type [ fhir:v "true"^^xsd:boolean] ; #
fhir:instance [ fhir:v "false"^^xsd:boolean] ; #
fhir:parameter ( [
fhir:name [ fhir:v "subject" ] ;
fhir:use [ fhir:v "in" ] ;
fhir:min [ fhir:v "1"^^xsd:integer ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "The subject of interest." ] ;
fhir:type [ fhir:v "string" ] ;
fhir:searchType [ fhir:v "reference" ]
] [
fhir:name [ fhir:v "variants" ] ;
fhir:use [ fhir:v "in" ] ;
fhir:min [ fhir:v "0"^^xsd:integer ] ;
fhir:max [ fhir:v "*" ] ;
fhir:documentation [ fhir:v "List of variants from which consequences are derived. Must be in HGVS or SPDI format." ] ;
fhir:type [ fhir:v "string" ] ;
fhir:searchType [ fhir:v "string" ]
] [
fhir:name [ fhir:v "ranges" ] ;
fhir:use [ fhir:v "in" ] ;
fhir:min [ fhir:v "0"^^xsd:integer ] ;
fhir:max [ fhir:v "*" ] ;
fhir:documentation [ fhir:v "List of regions to be searched for variants. Must be in zero-based RefSeq:Integer-range format (e.g. 'NC_000007.14:55174721-55174820')." ] ;
fhir:type [ fhir:v "string" ] ;
fhir:searchType [ fhir:v "special" ]
] [
fhir:name [ fhir:v "featureConsequences" ] ;
fhir:use [ fhir:v "in" ] ;
fhir:min [ fhir:v "0"^^xsd:integer ] ;
fhir:max [ fhir:v "*" ] ;
fhir:documentation [ fhir:v "List of consequences sought. Must be in token or codesystem|code format. (These will generally be coded with Sequence Ontology codes under SO:0001537)" ] ;
fhir:type [ fhir:v "string" ] ;
fhir:searchType [ fhir:v "token" ]
] [
fhir:name [ fhir:v "testIdentifiers" ] ;
fhir:use [ fhir:v "in" ] ;
fhir:min [ fhir:v "0"^^xsd:integer ] ;
fhir:max [ fhir:v "*" ] ;
fhir:documentation [ fhir:v "Supply a list of test identifiers. Only results originating from one of these tests will be returned." ] ;
fhir:type [ fhir:v "string" ] ;
fhir:searchType [ fhir:v "token" ]
] [
fhir:name [ fhir:v "testDateRange" ] ;
fhir:use [ fhir:v "in" ] ;
fhir:min [ fhir:v "0"^^xsd:integer ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "Supply a date range. Only results generated during this range will be returned." ] ;
fhir:type [ fhir:v "Period" ]
] [
fhir:name [ fhir:v "specimenIdentifiers" ] ;
fhir:use [ fhir:v "in" ] ;
fhir:min [ fhir:v "0"^^xsd:integer ] ;
fhir:max [ fhir:v "*" ] ;
fhir:documentation [ fhir:v "Supply a list of specimen identifiers. Only results derived from one of these specimens will be returned." ] ;
fhir:type [ fhir:v "string" ] ;
fhir:searchType [ fhir:v "token" ]
] [
fhir:name [ fhir:v "genomicSourceClass" ] ;
fhir:use [ fhir:v "in" ] ;
fhir:min [ fhir:v "0"^^xsd:integer ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "Enables an App to limit results to those that are 'germline' or 'somatic'. Default is to include variants irrespective of genomic source class." ] ;
fhir:type [ fhir:v "string" ] ;
fhir:searchType [ fhir:v "token" ]
] [
( fhir:extension [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/operationdefinition-profile"^^xsd:anyURI ] ;
fhir:value [ fhir:v "http://hl7.org/fhir/uv/genomics-reporting/StructureDefinition/molecular-consequence"^^xsd:anyURI ] ] ) ;
fhir:name [ fhir:v "consequence" ] ;
fhir:use [ fhir:v "out" ] ;
fhir:min [ fhir:v "0"^^xsd:integer ] ;
fhir:max [ fhir:v "*" ] ;
fhir:documentation [ fhir:v "Consequences must conform to [Profile: http://hl7.org/fhir/uv/genomics-reporting/StructureDefinition/molecular-consequence]. The target(s) of the consequence's derivedFrom shall also be included in the response." ] ;
fhir:type [ fhir:v "Observation" ]
] [
( fhir:extension [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/operationdefinition-profile"^^xsd:anyURI ] ;
fhir:value [ fhir:v "http://hl7.org/fhir/uv/genomics-reporting/StructureDefinition/variant"^^xsd:anyURI ] ] ) ;
fhir:name [ fhir:v "variant" ] ;
fhir:use [ fhir:v "out" ] ;
fhir:min [ fhir:v "0"^^xsd:integer ] ;
fhir:max [ fhir:v "*" ] ;
fhir:documentation [ fhir:v "Variants must conform to [Profile: http://hl7.org/fhir/uv/genomics-reporting/StructureDefinition/variant]." ] ;
fhir:type [ fhir:v "Observation" ]
] ) . #
IG © 2022+ HL7 International / Clinical Genomics. Package hl7.fhir.uv.genomics-reporting#3.0.0 based on FHIR 4.0.1. Generated 2024-12-12
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change