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
| Official URL: http://hl7.org/fhir/uv/genomics-reporting/OperationDefinition/find-population-dx-implications | Version: 3.0.0 | |||
| Active as of 2024-11-19 | Computable Name: FindPopulationDxImplications | |||
Retrieve count or list of patients having diagnostic implications.
Retrieve count or list of patients having diagnostic implications. More specifically, this operation retrieves the count +/- list of patients that have diagnostic implications involving specific conditions, derived from specific variants/haplotypes/genotypes.
A patient meets numerator criteria if they have at least one diagnostic implication matching the query parameters.
As shown in the following picture, this operation can return previously instantiated implications and/or dynamically computed implications. Specific implementations can indicate their capabilities using a FHIR Capability Statement. Rules around the retention of dynamically computed implications are outside the scope of this operation, but a server could potentially instantiate those results based on the Therapeutic Implication, Diagnostic Implication, or Molecular Consequence FHIR profiles.
Population queries are designed to return a count of patients that match each item sought, with or without a list of patients matching the item(s) sought.
Generated Narrative: OperationDefinition find-population-dx-implications
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| IN | variants | 0..* | string (string) | List of variants from which implications are derived. Must be in HGVS or SPDI format. | ||
| IN | haplotypes | 0..* | string (token) | List of haplotypes from which implications are derived. Must be in token or codesystem|code format. | ||
| IN | conditions | 0..* | string (token) | List of conditions for which implications are sought. Must be in token or codesystem|code format. | ||
| IN | genomicSourceClass | 0..1 | string (token) | Enables an App to limit results to those that are 'germline' or 'somatic'. Default is to include variants irrespective of genomic source class. | ||
| IN | includePatientList | 0..1 | boolean | Include list of matching patients if set to true. Default=false. | ||
| OUT | implications | 1..1 | ||||
| OUT | implications.numerator | 1..1 | Quantity | Count of patients having this variant | ||
| OUT | implications.denominator | 0..1 | Quantity | Count of patients in the cohort searched | ||
| OUT | implications.subject | 0..* | string | Patient ID. Include if includePatientList=true |
Valid response codes are shown in the following table. Additional response codes (e.g. 5xx server error) may also be encountered.
| Response Code | Description |
|---|---|
| 200 | Successfully executed request |
| 400 | ERROR: Invalid query parameters |
| 404 | ERROR: Patient not found |
| 422 | ERROR: Failed LiftOver |
Over the course of the past two years, many patients have been tested for variants pathogenic for hereditary breast and ovarian cancer syndrome (HBOC), Lynch syndrome (LS), and familial hypercholesterolemia (FH).
Recent knowledge base updates have added to the list of known pathogenic variants, and have reclassified the pathogenicity of many variants.
We now want to find patients that have pathogenic variants for HBOC, LS, or FH, based on the new knowledge base.
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