Genomics Reporting Implementation Guide
3.0.0 - release
Genomics Reporting Implementation Guide
3.0.0 - release
Genomics Reporting Implementation Guide, published by HL7 International / Clinical Genomics. This guide is not an authorized publication; it is the continuous build for version 3.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/genomics-reporting/ and changes regularly. See the Directory of published versions
| Active as of 2024-11-19 |
<OperationDefinition xmlns="http://hl7.org/fhir">
<id value="find-study-metadata"/>
<text>
<status value="generated"/>
<div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: OperationDefinition find-study-metadata</b></p><a name="find-study-metadata"> </a><a name="hcfind-study-metadata"> </a><a name="find-study-metadata-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>
</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>List of test identifiers. Metadata for each test is returned.</p>
</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>Metadata for each test performed during the range is returned.</p>
</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>List of specimen identifiers. Metadata for each test based on a supplied specimen identifier is returned.</p>
</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 for which additional study information is sought. If ranges are supplied, then each returned test will include studied and uncallable regions. Must be in zero-based RefSeq:Integer-range format (e.g. 'NC_000007.14:55174721-55174820').</p>
</div></td></tr><tr><td>OUT</td><td>tests</td><td/><td>0..*</td><td></td><td/><td/></tr><tr><td>OUT</td><td>tests.testId</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td/><td><div><p>test identifier</p>
</div></td></tr><tr><td>OUT</td><td>tests.testDate</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#dateTime">dateTime</a></td><td/><td><div><p>test date</p>
</div></td></tr><tr><td>OUT</td><td>tests.specimenId</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td/><td><div><p>specimen identifier</p>
</div></td></tr><tr><td>OUT</td><td>tests.genomicBuild</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#CodeableConcept">CodeableConcept</a></td><td/><td><div><p>preferred codes: https://loinc.org/LL1040-6/</p>
</div></td></tr><tr><td>OUT</td><td>tests.dnaChangeType</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#CodeableConcept">CodeableConcept</a></td><td/><td><div><p>preferred codes: http://www.sequenceontology.org/browser/current_release/term/SO:0002072</p>
</div></td></tr><tr><td>OUT</td><td>tests.regionStudied</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td/><td><div><p>List of non-overlapping regions, each in zero-based RefSeq:Integer-range format; or 'unknown'</p>
</div></td></tr><tr><td>OUT</td><td>tests.uncallableRegions</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td/><td><div><p>List of non-overlapping regions, each in zero-based RefSeq:Integer-range format; or 'unknown'</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-study-metadata"/>
<version value="3.0.0"/>
<name value="FindStudyMetadata"/>
<title value="Find Study Metadata"/>
<status value="active"/>
<kind value="operation"/>
<date value="2024-11-19T22:01:39+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 metadata about sequencing studies performed on a subject."/>
<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="subject"/>
<use value="in"/>
<min value="1"/>
<max value="1"/>
<documentation value="The subject of interest."/>
<type value="string"/>
<searchType value="reference"/>
</parameter>
<parameter>
<name value="testIdentifiers"/>
<use value="in"/>
<min value="0"/>
<max value="*"/>
<documentation
value="List of test identifiers. Metadata for each test is returned."/>
<type value="string"/>
<searchType value="token"/>
</parameter>
<parameter>
<name value="testDateRange"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="Metadata for each test performed during the range is returned."/>
<type value="Period"/>
</parameter>
<parameter>
<name value="specimenIdentifiers"/>
<use value="in"/>
<min value="0"/>
<max value="*"/>
<documentation
value="List of specimen identifiers. Metadata for each test based on a supplied specimen identifier is returned."/>
<type value="string"/>
<searchType value="token"/>
</parameter>
<parameter>
<name value="ranges"/>
<use value="in"/>
<min value="0"/>
<max value="*"/>
<documentation
value="List of regions for which additional study information is sought. If ranges are supplied, then each returned test will include studied and uncallable regions. Must be in zero-based RefSeq:Integer-range format (e.g. 'NC_000007.14:55174721-55174820')."/>
<type value="string"/>
<searchType value="special"/>
</parameter>
<parameter>
<name value="tests"/>
<use value="out"/>
<min value="0"/>
<max value="*"/>
<part>
<name value="testId"/>
<use value="out"/>
<min value="1"/>
<max value="1"/>
<documentation value="test identifier"/>
<type value="string"/>
</part>
<part>
<name value="testDate"/>
<use value="out"/>
<min value="1"/>
<max value="1"/>
<documentation value="test date"/>
<type value="dateTime"/>
</part>
<part>
<name value="specimenId"/>
<use value="out"/>
<min value="0"/>
<max value="1"/>
<documentation value="specimen identifier"/>
<type value="string"/>
</part>
<part>
<name value="genomicBuild"/>
<use value="out"/>
<min value="0"/>
<max value="1"/>
<documentation value="preferred codes: https://loinc.org/LL1040-6/"/>
<type value="CodeableConcept"/>
</part>
<part>
<name value="dnaChangeType"/>
<use value="out"/>
<min value="0"/>
<max value="1"/>
<documentation
value="preferred codes: http://www.sequenceontology.org/browser/current_release/term/SO:0002072"/>
<type value="CodeableConcept"/>
</part>
<part>
<name value="regionStudied"/>
<use value="out"/>
<min value="0"/>
<max value="1"/>
<documentation
value="List of non-overlapping regions, each in zero-based RefSeq:Integer-range format; or 'unknown'"/>
<type value="string"/>
</part>
<part>
<name value="uncallableRegions"/>
<use value="out"/>
<min value="0"/>
<max value="1"/>
<documentation
value="List of non-overlapping regions, each in zero-based RefSeq:Integer-range format; or 'unknown'"/>
<type value="string"/>
</part>
</parameter>
</OperationDefinition>
IG © 2022+ HL7 International / Clinical Genomics. Package hl7.fhir.uv.genomics-reporting#3.0.0 based on FHIR 4.0.1. Generated 2024-11-19
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change