GA4GH Pedigree FHIR Implementation Guide
0.1.0 - ci-build
GA4GH Pedigree FHIR Implementation Guide - Local Development build (v0.1.0). See the Directory of published versions
Official URL: http://purl.org/ga4gh/pedigree-fhir-ig/ImplementationGuide/ga4gh.fhir.pedigree | Version: 0.1.0 | |||
Draft as of 2022-04-22 | Computable Name: GA4GHPedigreeIG | |||
Copyright/Legal: Global Alliance for Genomics and Health |
Family health history is an important aspect in both genomic research and patient care. The Global Alliance for Genomics and Health is working on a pedigree standard that will allow sharing family history data in a way that is accurate, easy to analyse and transferable between systems. The group has created a conceptual model and a minimal data set document that have been used as the basis for this FHIR implementation guide.
This implementation guide uses terminology, notations and design principles that are specific to FHIR. Before reading this implementation guide, its important to be familiar with some of the basic principles of FHIR as well as general guidance on how to read FHIR specifications. Readers who are unfamiliar with FHIR are encouraged to read (or at least skim) the following prior to reading the rest of this implementation guide.
This implementation guide builds on FHIR v4.0.1: R4.
This section describes how the elements in the conceptual model were mapped to FHIR.
The main classes in the conceptual model are shown in the following diagram:
The FHIR resources that were used to implement the conceptual model are shown in the following diagram:
The following sections describe how each element was mapped to FHIR.
The individual class is mapped to the Patient resource through the PedigreeIndividual profile.
Field | Type | Status | Definition | FHIR Mapping | Comments |
---|---|---|---|---|---|
id | ID | required | logical id | id | All FHIR resources have a logical identifier. |
name | string | optional | Name of the individual | name | |
identifiers | list of string | optional | External identifiers for the individual | identifier | |
sex | Concept | optional | Sex for Clinical Use, values: male , female , other , unknown ; See: https://confluence.hl7.org/display/VOC/Gender+Harmony+Context+Definitions and https://www.hl7.org/fhir/valueset-administrative-gender.html |
gender | This is the administrative gender of the patient. Biological sex can be supported using an Observation. |
gender | Concept | optional | Presumed or reported gender identity, values: male , female , non-binary , non-disclosed , trans , …; See: https://confluence.hl7.org/display/VOC/Gender+Harmony+Context+Definitions |
Gender Identity extension | This is an official HL7 extension used to record gender identity. |
lifeStatus | Concept | recommended | The presumed/accepted life status of the individual as of the pedigree collection date; one of: alive , deceased , unborn |
Unborn extension (boolean) | This is the only extension introduced in the implementation guide. FHIR supports recording if a patient is deceased but not if it is unborn. |
affected | boolean | not recommended | Whether or not the individual is affected by the condition being investigated in this pedigree; included for PED backwards compatibility | AffectedStatus profile | This is supported through an observation. |
The relationship class is mapped to the FamilyMemberHistory resource. This class, along with the official HL7 patient-record extension, can be used as a relationship in a graph model. The main source of confusion when using this class for this purpose is that it includes redundant information about the individuals, which is needed when a proper graph model is not implemented. Therefore, in the PedigreeRelationship profile, the elements that capture redundant information are forbidden, thus making it clear that the intention is for this resource to be used just as a relationship.
Field | Type | Status | Definition | FHIR Mapping | Comments |
---|---|---|---|---|---|
id | ID | required | Logical id | id | All FHIR resources have a logical identifier. |
individual | ID | required | Identifier of the subject Individual; equivalent to the FHIR “Scoping Individual” and the Biolink “Object” | patient | |
relative | ID | required | Identifier of the relative Individual; equivalent to the FHIR “Player” and the Biolink “Subject” | relative extension | Uses the official HL7 patient-record extension. |
relation | Concept | required | The relationship between individual and relative ; if the relationship is directed, it is the relationship that the relative has to the individual (e.g., individual is the child, relative is the mother, then relation is parent); terms should come from the relationship terminology, below |
relationship | A new FHIR code system was created and the binding was set to required. |
The relationship terminology is specified here. A FHIR code system that implements this terminology has been developed as part of the implementation guide and can be browsed here.
There is no resource in FHIR that represents an entire pedigree. Therefore, this class is mapped to the Composition resource, which provides a generic mechanism to package a set of related resources, through the Pedigree profile.
Field | Type | Status | Definition | FHIR Mapping | Comments |
---|---|---|---|---|---|
proband | ID | optional | Id of Individual that is the index case for the family | proband section | The composition has a section where a reference to the proband can be established. |
consultand | ID | optional | Id of Individual that is the focus of the current analysis | consultand section | The composition has a section where a reference to the consultand can be established. |
collectedAt | Date | optional | The date the pedigree was collected, as ISO full or partial date, i.e. YYYY, YYYY-MM, or YYYY-MM-DD | date | |
reason | Concept | optional | The health condition being investigated in the family; if any Individual has the affected property defined, it refers to this condition |
reasonCollected section | The composition has a section where a reference to the condition that is the reason the pedigree was collected can be established. |
Currently, there are two examples in the implementation guide.
This is a simple example that shows how the profiles and other resources can be used to build a simple family history graph. The following figure shows what the model looks like:
The following instances are used to implement this example:
An example trio from the testing suite of the GenoVic system.
The following instances are used to implement this example: