Genomics Reporting Implementation Guide
3.0.1-SNAPSHOT - Ballot International flag

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.1-SNAPSHOT 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

General Genomic Reporting

This page defines the core profiles and concepts that would be expected to be present in most genomic reports, regardless of type, and how those profiles relate to each other. Concepts covered include the genomic report itself and the high-level categories of observations and other elements that make up the report, such as patient, specimen, variants, haplotypes, genotypes, etc.

This table describes the categories of data contained in this implementation guide.

Genomic Report Groups together all the structured data being reported for a genomic testing.
Genomic Study Delineates relevant information of a performed genomic study. A genomic study might comprise one or more analyses, each serving a specific purpose.
Overall Interpretations Reported when variant analysis (sequencing or targeted variants) is done. Provides a coarse overall interpretation of the results reported.
Genomic Findings These are observations about the specimen's genomic characteristics. For example, a chromosomal abnormality, genotype, haplotype, or variant that was detected.
Genomic Implications These represent observations where the Observation.subject is typically the Patient and the Observation.derivedFrom should refer to Genomic Findings or Molecular Biomarkers. For example, "Patient may have increased susceptibility to heart attacks"
Molecular Biomarkers These are observations describing Molecular Biomarkers, which encompasses laboratory measurements of human inherent substances such as gene products, antigens and antibodies, or complex chemicals that result from post-translational processing of multi-gene products.
Recommended Actions Specific actions be taken, such as genomic counseling, re-testing, adjusting drug dosages, etc. - driven by the results found.
Contextual Resources Other resources that provide contextual details.

Genomic Report

The genomic report is the focus of all genomic reporting. It conveys metadata about the overall report (what kind of report it was, when it was written, who wrote it, final vs. draft, etc.). It also typically includes a rendered version for review by a clinician. It also groups together all relevant information found as part of the genomic analysis (Rules for relevancy will depend on the type of testing ordered, the reason for testing and the policies of the lab). Most of the structured genomic information is expressed as FHIR Observations. Any recommendations that come with the report are expressed as FHIR Tasks. The report can be organized into sub-reports using core DiagnosticReport extensions like extends or summaryOf, which is especially useful for later analysis steps. Additionally, an observation can be used to group content for viewing purposes or to indicate a higher-level panel (with a specific LOINC panel code in the Observation.code for example).

Class diagram showing the high-level categories of the component parts in a genomic diagnostic report

Genomic Report Overview

Genomic Report, Overall Interpretation, Genomic Findings, Genomic Implications, Genomic Study, Recommended Actions

Again, if needed, large or complex genomic reports may be broken down into sub-reports using core DiagnosticReport extensions like extends or summaryOf. This approach is particularly useful when different labs or services are performing later steps in the analysis, for example. Or a panel Observation.code can be used.

In some cases, the lab or other reporting organization may generate risk assessments as part of their reports. These are referenced from a report or an observation from the Genomic Risk extension.

Results observation profiles, like genomic observations, are typically referenced directly by a Diagnostic Report. For genomics this would be in the genomic report. The genetic findings and implication profiles all contain links to computably define their composite relationships (e.g., the variant observation is referenced within the implication profile using derivedFrom). However, observations could be organized into groups by other observations. See this grouping guidance for an overview with examples and considerations for processing reports. Be aware that consumers of Genomic Diagnostic Report MUST navigate through all hasMember relations and navigate through derivedFrom relationships to ensure processing of all clinically relevant information.

When sending a copy of the report (e.g., PDF or other document containing the written report), use DiagnosticReport.presentedForm. Note this is different from the Related Artifact extension, which is used to reference citations, evidence and other supporting documentation for the observation or report. Another approach which should be avoided (at least for this current release) is the DiagnosticReport.media attribute. Its definition focuses on "Key images associated with this report" which does not align well with this use case.

Genomic Study

In the R5 release, the GenomicStudy resource was introduced. This resource is intended at capturing relevant information about the reasons, purpose, and performers of the study. It also provides technical endpoints to access the data. It could be a logical aggregator for complex analyses.

These features are important to appropriately manage and structure the metadata about a genomic study. As such, this guide has introduced new profiles to 'backport' these features for this R4 based implementation guide. Refer to these profiles for additional details:

GenomicStudy profile to represent the study level metadata.

GenomicStudyAnalysis profile to represent the analysis level metadata.

The GenomicStudy instance SHOULD be referenced from a report and CAN be referenced by various observations.

Attaching Genomic Files

The guidance below for file attachments needs to be carefully reviewed and considered. There are potential issues, and the Work Group welcomes feedback.

While this implementation guide strives to provide structured genomic data via a variety of observations, there are use cases that warrant a deeper level of data than this guide allows. These use cases might be best served by sending commonly used files (VCF, BAM, CRAM, MAF, BED to name a few) with the genomic study. To promote a consistent approach to sharing these files, we provide the guidance in this section. Even with this guidance, note that best practices in exchanging these files along with the metadata necessary to make use of them through a FHIR API, remains a complicated and open issue. See operations for a description of an experimental alternative workflow.

When sending these genomic files, implementers should first utilize the Genomic Study profiles. Each study has one or more analyses, each of which can define input and output elements. From there, the GenomicDataFile can be used to send the file content along with meaningful metadata. This approach allows the files to have their own existence and enables queries to find them via the DocumentReference resource. To enable linking from the report to files, the Genomic Study Reference extension can be used to reference the study, corresponding analyses, and then the files. This can be helpful for those processing the report to easily identify the files that were sent along with the report.

When sending genomic files there are many considerations. For example, it is not unusual for files to be gigabytes in size. The DocumentReference resource has different options to evaluate for your use case. If embedded directly using DocumentReference.content.attachment.data, servers receiving the files may have size constraints per resource or per transaction which may limit your options. Instead of sending a large data file, the file can be referenced by a URL and title using the DocumentReference.content.attachment.url element. This can point to an online resource that hosts the file or from where the file can be accessed. For genomic files, the host is likely not the FHIR server providing the DocumentReference data instance. Be aware that use of DocumentReference to provide access to files through URLs introduces authorization requirements that are out of scope of this Implementation Guide. With either of these approaches, it is important to note the files might be compressed. Also, the mime types for these genomic files will vary, or possibly be missing. The senders of the data should include as much metadata as possible to enable the receiver to appropriately handle the files.

For receivers to make use of these files, many facets of the generation of the files will be needed, such as what pipelines, tools, and settings were used. The intended downstream use cases must be carefully evaluated to ensure appropriate file preparation. The Genomic Study Analysis defines a number of attributes that can be used to better understand the file. Also, the DocumentReference.description might be helpful for a sending system to provide guidance on how the file was generated. A fully computable approach for this issue has yet to be defined.

It should be noted that this Genomic Study approach is not an appropriate way to send a copy of the report (e.g., PDF or other document containing the written report). Instead, use DiagnosticReport.presentedForm.

A full, detailed implementation discussion is outside the scope of this IG. In a future release, this IG may include other profiles or artifacts along with more specific guidance.

Genomic Observations

Observations are the core representation of structured genomic information. This guide defines a number of Observation profiles, with common underlying components and constraints being inherited from abstract profiles as shown in the following diagram. The profiles and their specific usage will be defined in more detail below and on the other pages of this guide.

All genomic observations are derived from a common abstract profile that asserts they should have a category, effective date, issued date and status.

Class diagram showing the inheritance structure for genomic observations.

Genomic Observations

Genomic Base, Overall Interpretation, Genomic Finding (abstract), Variant, Haplotype, Genotype, Sequence Phase Relationship, Genomic Implication (abstract), Therapeutic Implication, Diagnostic Implication, Molecular Consequence

Overall Interpretation

Overall interpretation is a high-level summary observation that applies to the whole report. Their purpose is to answer the question "Did you find anything when you did the test I asked you to do?"

Overall Interpretation is what the laboratory declares as the summary result of the test (e.g., Positive, Negative, Unknown) and is typically used when the genomic test was looking for a particular genomically-based disease. It allows indication of whether genomic results known to be associated with the disease were found or not.

Genomic Findings

The primary focus of genomic testing is making Genomic Findings. These are the fine and/or coarse-grained descriptions of a specimen's genomic characteristics. It is this information that leads to the Overall Interpretations for the report, as well as Genomic Implications that are used to convey the potential impact of the genomic findings for the subject of the test.

Class diagram showing relationship of genomic findings as well as genotypes, haplotypes, variants and sequences.

Genomic Findings

Genomic Finding, Genotype, Haplotype, Variant (or see Variant Reporting), Sequence Phase Relationship

Genomic Findings can be subdivided into types of findings:

  • Genotypes describe combinations of genomic variations that together are associated with a particular phenotype - i.e., a specific physical, behavioral, or risk-associated difference associated with the organism whose specimen was tested.
  • Haplotypes describe a set of genomic variations that appear on a single strand of DNA - and which are therefore typically inherited together
  • Variants are specific differences or combinations of differences between parts of one or more specimen sequences and the equivalent portions of the reference sequence(s) for that organism. The Variant Reporting section deals with all types of variants detected by formal sequencing, including simple/discrete variants, structural variants and complex variants detected by direct sequencing, shotgun-based sequencing, and array-based testing for specific variants.
  • Sequence Phase Relationships describe the CIS or TRANS relationship of findings.

These categories of observations have relationships. Haplotypes can be identified based on the presence of variants. Genotypes can be identified based on the presence of haplotypes and/or variants. All three can be expressed as a combination of one or more sequences.

Genomic Implications

At present, implications are noted as explicit observations about the patient/subject. However, it's not clear this is the correct approach. The work group is evaluating introducing a new resource that allows conveying "knowledge" about a variant in a patient-independent way. This would allow saying "this variant is associated with an increased risk of cardiovascular disease" rather than "based on this variant, the patient is at an increased risk of cardiovascular disease", which isn't necessarily a determination the reporting organization may wish to assert. Feedback is welcome.

Class diagram showing relationship of genomic implications.

Genomic Implications

Genomic Implication, Therapeutic Implication, Diagnostic Implication, Molecular Consequence

Genomic Implications are assertions of likely effects of genomic results on the patient, tumor, or other subject. Implications are relevant for areas of genomic testing including inherited disease, pharmacogenomics and somatic. For inherited diseases, a diagnostic implication indicates the likelihood of inheritance of a particular disease (the associated-phenotype) as well as how inheritance is likely to occur (mode-of-inheritance). For other more specific guidance, see the pharmacogenomics and somatics pages.

Molecular Biomarkers

The term 'biomarker' is broad, encompassing observable characteristics that indicate normal or abnormal biological processes and that are often used to assess prognosis or guide therapy. In the broad sense, many clinical and laboratory observations might be considered a 'biomarker'. 'Molecular biomarker' is likewise broad, primarily encompassing laboratory measurements of human inherent substances such as gene products, antigens and antibodies, complex chemicals that result from post-translational processing of multi-gene products, etc. Molecular biomarkers include many different types of measurements, such as presence or absence of a chemical, or the level of a chemical. Here, we are primarily interested in those molecular biomarkers that have associated therapeutic implications, particularly in precision cancer care, including but not limited to: cell receptor levels (e.g. ER, PR, HER2); molecular sequence adjacent observations (e.g. microsatellite instability, tumor mutation burden, gene promoter methylation); cell receptor ligands (e.g. PD-L1); proteins, antigens, and antibodies (e.g. HLA type). These sorts of observations may be represented by the Molecular Biomarker profile.

Recommended Actions

These actions can be specific recommendations be taken and are driven by the results found. These can be a Follow-up Recommendation which can be used to indicate when some sort of follow-up (additional testing, genetic counseling) is required, or a Medication Recommendation which can be used to propose medication recommendations based on the results of the test.

Contextual Resources

There are a number of resources that are used within this guide to provide additional data as both input and output of the test.

The ServiceRequest resource typically represents a clinician order. It can also represent a lab-side filler order, a reflex order or even a plan or recommendation. These uses are distinguished via the intent element. The primary test to perform is captured in ServiceRequest.code. However, qualifications on what variants, medications, diseases, and other aspects to search on can be conveyed using the orderDetail element. The service requests and the reports resulting from them can be associated to patients, to specimens or both.

Orders can point to other sources of information used to support the analysis performed as part of genomic testing. Genomic reports can refer to information that was considered as part of the report - whether provided as part of the order or made available subsequently by the patient or clinicians or otherwise retrieved. The figure above shows these relationships through the extension SupportingInformation, which can be to any resource but would typically reference Observations, FamilyMemberHistory records (including records that comply with Family member history for genomics analysis and RiskAssessments.

Relationships Between Resources

To allow searching and appropriate navigation, the diagnostic report, observations, and tasks must be able to stand on their own. They need to be related to the associated patient and/or specimen, the order that initiated the testing, the lab that performed the testing, etc. FHIR design principles dictate that these associations be present on every resource instance. That's because each resource could be accessed on its own as part of a query response, embedded in a document or message, passed to a decision support engine, etc. However, this is still relatively lightweight because the information is included by reference only.

The following diagram shows the relationships between the diagnostic report, observations, and other elements used in the profile. Note that there is no expectation that all relationships will point to the same instances. In special cases, a genomic report may involve multiple patients or multiple specimens. As mentioned, the extends, summaryOf can be used well to provide additional organization.

Class diagram showing the interrelationships between DiagnosticReport, Observation, Task, Patient, Specimen, etc.

Key points to take from this diagram:

  • Of the different types of observations, Genomic Findings are expected to have one specimen. The remainder might be associated with a specimen, but might not. Observations may also be associated with a particular BodyStructure, such as a fetus, tumor, or lesion.
  • Genomic reports and observations can be tied to multiple "orders" - this is because each test requested is handled as a separate request. All tests ordered as part of a single requisition are linked by the requisition identifier.
  • Genomic Study SHOULD be linked from GenomicReport and CAN be linked from Observations. Genomic Study can reference multiple Genomic Study Analysis instances, which can reference input and output files.
  • Overall Interpretations observations should be linked to Genomic Findings observations using the Observation.derivedFrom attribute. For example, an interpretation that "deletions or duplication were found" might be supported by observations of variants that contain deletions and/or duplication.
  • Genomic Implications observations should be linked to Genomic Findings observations using the Observation.derivedFrom attribute. For example, in a genomic report, it's not acceptable to imply "patient is an increased metabolizer of drug X" without also indicating the variant, haplotype or genotype found that supports that implication.
  • Recommended Actions are referenced from the Recommended Action extension. These Task resources will also have relationships to Genomic Implications or other observations.

Referencing Observations from GenomicReport

The following is derived from the CORE FHIR guidance on Diagnostic Report Resource and Observation Resource

For receivers of genetic reports, to ensure all clinically relevant information is processed, consumers of Genomic Diagnostic reports MUST navigate through all hasMember relations, and navigate through derivedFrom when processing Genomic Diagnostic reports.

For senders of Genomic Diagnostic reports, it is up to receiving systems to arrange/use the genomic observations appropriately. However, some systems may only process just the first layer of a DiagnosticReport.results. Thus, when sending the report and results, we recommend including result links to all the genomic observation results being returned. For more complex reporting use cases, consider using the summaryOf extension on DiagnosticReport for creating meaningful subsets of observations.

Querying

As a note on querying, the relationships indicated by hasMember, derivedFrom and the computable meaning conveyed by observation.code and component.code are critical for specificity in querying and getting comprehensive search results. Additionally, values found in elements like component.value and observation.value are useful as well. However, the meanings of the values are predicated on by the component.code or observation.code to which they associate. There is a page in this IG with query guidance that shows how to use components, relationships (references) and the iterative hasMember to find results. The use of a grouping observation does not influence the ability to query. For example, the profile of a variant contains a value for the gene name component. Querying for all variants for the patient in a given gene can be done through the gene name component.

Additional Attributes

This Implementation Guide uses FHIR profiling to define constraints on base resources to provide an interoperable structure for genomic concepts. For example, the Variant profile defines the structure for delivering variant attributes. While these profiles seek to fully describe each concept, there might be other attributes that need to be delivered. While we suggest some caution in doing this, as it makes implementations less consistent and therefore less interoperable, there are at least two ways this can be accomplished:

Custom extensions Implementers can use the extensibility features built into FHIR. This guide introduces a number of extensions, but other use case specific extensions can be introduced when needed.
Open slicing When constraining attributes that can contain multiple values, the FHIR concept of slicing is used. The slices we define are all 'open' which means that while the specific rules should be used when possible, implementers are free to send additional data. For example, in Observation.code, our profiles require a specific code be sent, but still allow other codes to be delivered. Another example is in Observation.component where additional attributes can be described in Observation.component.code and their value delivered in Observation.component.value[x].

The work group is actively requesting feedback from the community on additional codes, values, and extensions that stakeholders have found helpful when implementing the structures and use cases defined in this guide.