Phenomics Exchange for Research and Diagnostics
0.1.0 - ci-build International flag

Phenomics Exchange for Research and Diagnostics, published by HL7 International / Clinical Interoperability Council. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/phenomics-exchange-ig/ and changes regularly. See the Directory of published versions

Artifacts Summary

This page provides a list of the FHIR artifacts defined as part of this implementation guide.

Behavior: Search Parameters

These define the properties by which a RESTful server can be searched. They can also be used for sorting and including related resources.

service-request-supporting-info

Search ServiceRequest by supporting resource parameters

Structures: Resource Profiles

These define constraints on FHIR resources for systems conforming to this implementation guide.

Biosample

A unit of biological material from which the substrate molecules (e.g. genomic DNA, RNA, proteins) for molecular analyses (e.g. sequencing, array hybridisation, mass-spectrometry) are extracted.

Disease profile

This profile stipulates that a FHIR Condition must have a codeable concept that represents the disease. The concepts can be taken from various ontologies, but for rare-disease concepts, we recommend MONDO.

Individual

The subject of the Phenopacket is represented by an Individual element. This element intends to represent an individual human or other organism.

Measurement

This profile defines the GA4GH Measurement element in terms of the FHIR Observation

Phenopacket profile

This is the main element that represents the Phenopacket in FHIR.

Phenopackets Genomic Interpretation

A profile of Genomics Reporting Genomics Report profile that represents relevant phenopackets building blocks.

Phenopackets Variant

A profile of Genomics Reporting Variant profile that represents relevant phenopackets building blocks.

Phenotypic Feature

This profile defines the GA4GH PhenotypicFeature element in terms of the FHIR Observation

Treatment

This profile defines the GA4GH Treatment element in terms of the FHIR MedicationAdministration

Structures: Extension Definitions

These define constraints on FHIR data types for systems conforming to this implementation guide.

ACMG Pathogenicity Classification

One of the five ACMG pathogenicity categories, default is UNCERTAIN_SIGNIFICANCE.

Additional Variant Identifier

Used to list of unique identifiers where available. If this is a dbSNP variant, component[dbSNP-id] should be used instead.

Coded Onset

The onset of a disease using an ontology class.

Diagnostic Marker

Clinically relevant biomarkers. Most of the assays such as immunohistochemistry (IHC) are covered by the NCIT under the sub-hierarchy NCIT:C36292 (Laboratory Test Result), e.g. NCIT:C68748 (HER2/Neu Positive), NCIT:C131711 (Human Papillomavirus-18 Positive).

Filter Status

Filter status: PASS if this position has passed all filters.

Histological Diagnosis

This is the pathologist’s diagnosis and may often represent a refinement of the clinical diagnosis (which could be reported in the Phenopacket that contains this Biosample). Normal samples would be tagged with the term “NCIT:C38757”, “Negative Finding”.

Interpretation Status

Describes the conclusion made about the genomic interpretation.

Karyotypic Sex

Karyotypic sex of an individual (also known as chromosomal sex).

Material Sample

Type of sample (diseases, control, etc.)

Measurement (Biosample)

Term representing a measurement made on a Biosample

Molecule Context

The molecular context of the vrs variation.

Onset

Describes the age at which a phenotypic feature was first noticed or diagnosed.

Pathological TNM Finding

Pathological TNM findings, if applicable. Corresponds to pathological_tnm_finding (GA4GH)

Pathological Tumor Stage

This element can be used if the phenopacket describes cancer. Tumor staging describes the extent of growth of cancer, including the tumor and, if applicable, affected lymph nodes and distant metastases. This element should not be confused with clinical stage.

Phenotypic Feature (Biosample)

Term representing phenotypic features of a Biosample

Phred Quality Score

Used to include Phred-scaled quality score for the assertion made in ALT.

Related Concept ID

Used to provide identifiers to alternative resources representing related, but not equivalent concepts, for example gene ortholog ids

Taxonomy

Corresponds to taxonomy (GA4GH). For resources where there may be more than one organism being studied it is advisable to indicate the taxonomic identifier of that organism, to its most specific level.

Therapeutic Actionability

one of the five ACMG pathogenicity categories, or NOT_PROVIDED. The default is NOT_PROVIDED.

Tumor Grade

List of terms representing the tumor grade.

Tumor Progression

This field can be used to indicate if a specimen is from the primary tumor, a metastasis or a recurrence. There are multiple ways of representing this using ontology terms, and the terms chosen should have a specific meaning that is application specific.

VCF Info

Additional information: Semicolon-separated series of additional information fields from VCF info field.

VRS Object

The VRS Variation object (Link: https://vrs.ga4gh.org/en/stable/)

Terminology: Value Sets

These define sets of codes used by systems conforming to this implementation guide.

ACMG Pathogenicity Classification Value Set

Describes the ACMG five-tier pathogenicity classification system (Richards et al., 2015, https://www.ncbi.nlm.nih.gov/pmc/articles/PMC4544753/).

Diagnostic Marker

Codes to indicate clinically relevant bio markers.

GENO Ontology Allelic State Value Set

Descendent terms of GENO_0000875

HistologicalDiagnosis

Histological diagnosis codes from NCIT.

Hpo Severity Value Set

The HPO codes for phenotypic feature severity

Interpretation Status Value Set

Describes the conclusion made about the genomic interpretation.

Karyotypic sex value set

The karyotypic (chromosomal) sex of an individual

Molecule Context Value Set

Describes The molecular context of the variant. Default is unspecified_molecule_context.

Observation Codes for status of a PhenotypicFeature

The LOINC codes for present if a feature is observed and absent if a feature was excluded.

Observation categories

ValueSet description here

Onset ValueSet

Set of HPO codes that denote the onset of a disease or phenotypic feature. The codes are descendants of Onset (HP:0003674) or from SNOMED_CT (282032007).

Phenotypic abnormality ValueSet

ValueSet description here

Phenotypic component ValueSet

ValueSet description here

Phenotypic modifier ValueSet

Human Phenotype Ontology (HPO) Clinical Modifier terms

Sequence Ontology Structural Variant Value Set

Descendent terms of SO:0001537.

Taxonomy

Taxonomic identifiers of an organism.

Therapeutic Actionability Value Set

Describes the therapeutic actionability of the variant.

Tumor Grade

Codes to indicate the grade of a tumor.

Tumor Progression

Codes to indicate if a specimen is from the primary tumor, a metastasis or a recurrence.

Tumor Stage

Codes to represent the stage of a tumor.

Terminology: Code Systems

These define new code systems used by systems conforming to this implementation guide.

Categories

Various categories or tags

Categories

Various categories or tags

HTS Format

An enumeration used to represent different high-throughput sequencing file formats.

Karyotypic sex code system

karyotypic sex of an individual (also known as chromosomal sex)

Section Type

Section Type

Example: Example Instances

These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.

A VALID karyotypic sex Observation instance.

A VALID karyotypic sex Observation instance.

A valid phenotypic abnormality Observation example.

A valid phenotypic abnormality Observation example.

An INVALID karyotypic sex Observation instance.

An INVALID karyotypic sex Observation instance.

An INVALID phenotypic abnormality Observation example.

An INVALID phenotypic abnormality Observation example.

CHF-stageIII

Congestive heart failure, New York Heart Association stage III

CHF-with-severity

PhenotypicFeature Example for severe Low-output congestive heart failure

MVP-with-onset

PhenotypicFeature Example for mitral value prolapse with onset

PeterGeneticist

Extended example: example practitioner

Phenopacket (static snapshot of clinical findings to support differential diagnosis of a child with developmental delay).

Example use case for a child with undiagnosed developmental delay

Phenopackets Genomic Interpretation Example-1

This is an example of phenopackets-variant which is a phenopackets profile of the genomics reporting Genomics Report profile. It represents phenopackets GenomicInterpretation building block, i.e., the interpretation for an individual variant or gene.

Phenopackets Genomic Interpretation Example-2

This is an example of phenopackets-variant which is a phenopackets profile of the genomics reporting Genomics Report profile. It represents phenopackets GenomicInterpretation building block, i.e., the interpretation for an individual variant or gene.

Phenopackets Variant Example-1

This is an example of phenopackets-genomic-interpretation which is a phenopackets profile of the genomics reporting Variant profile. It represents phenopackets GeneDescriptor, VariationDescriptor, VcfRecord, and VariantInterpretation building blocks.

PhenopacketsBundleExample01

Example Phenopacket Bundle instance

Polydactyly-with-modifier

Bilateral postaxial Polydactyly, example to demonstrate use of Clinical Modifier

Proband1

Example child with developmental delay

This is an example of a composition resource that represents some of the Phenopackets data elements

Example Phenopacket Composition instance

amyotrophy

Skeletal muscle atrophy (HP:0003202)

arachnodactyly

PhenotypicFeature Example for arachnodactyly

bladderCarcinoma

Biosample Example for bladder carcinoma

example-patient

Example of Patient

excluded-disease

Phenopacket Example for an excluded disease

fiberSizeVariability

Increased variability in muscle fiber diameter (HP:0003557)

globalDevelopmentalDelay

Global developmental delay (HP:0001263)

hypotonia

Hypotonia (HP:0001252)

intellectualDisabilityDisease

Intellectual disability (disease)

longPhiltrum

Long philtrum (HP:0000343)

losartan

Treatment Example (Losartan))

lowSetEars

Low-set ears (HP:0000369)

lvdysfunction-excluded

PhenotypicFeature Example for exclusion of LV dysfunction

microphthalmia

Long philtrum (HP:0000568)

muscleBiopsy

Biosample Example – muscle biopsy

muscleWeakness

Muscle weakness (HP:0001324)

phenopacket Patient Example01

This is an example of a patient resource to be used in the assocaited patient examples. It is not representative of phenopackets patient’s data representation

phenopacket Practitioner Example01

This is an incomplete example that used as a placeholder for a curated Practitioner example

phenopacket Specimen Example01

This is an incomplete example that used as a placeholder for a curated specimen example

reducedVisualAcuity

Reduced visual acuity (HP:0007663)

retinalDetachment

Retinal detachment (HP:0000541)

tga

Transposition of the great arteries (HP:0001669)

thrombocytopenia

Measurement Example for thrombocytopenia

vitreoretinochoroidopathy

Phenopacket Example for autosomal dominant vitreoretinochoroidopathy