Extension
Trial Use
May change in future releases. See Maturity Model.
Computational Definition
The Extension class provides entities with a means to include additional attributes that are outside of the specified standard but needed by a given content provider or system implementer. These extensions are not expected to be natively understood, but may be used for pre-negotiated exchange of message attributes between systems.
Information Model
Some Extension attributes are inherited from Element.
Field |
Flags |
Type |
Limits |
Description |
|---|---|---|---|---|
id |
string |
0..1 |
The ‘logical’ identifier of the data element in the system of record, e.g. a UUID. This ‘id’ is unique within a given system, but may or may not be globally unique outside the system. It is used within a system to reference an object from another. |
|
extensions |
⋮ | 0..m |
A list of extensions to the Entity, that allow for capture of information not directly supported by elements defined in the model. |
|
name |
string |
1..1 |
A name for the Extension. Should be indicative of its meaning and/or the type of information it value represents. |
|
value |
[‘number’, ‘string’, ‘boolean’, ‘object’, ‘array’, ‘null’] |
1..1 |
The value of the Extension - can be any primitive or structured object |
|
description |
string |
0..1 |
A description of the meaning or utility of the Extension, to explain the type of information it is meant to hold. |
Inherits: Element
Used in: Adjacency, Agent, Allele, CategoricalVariant, Cis Phased Block, Coding, Cohort Allele Frequency Study Result, Computational Variant Functional Impact Analysis Result, Concept Mapping, Concept Set, Contribution, Copy Number Change, Copy Number Count, Data Item, Data Set, Derivative Molecule, Document, Entity, Evidence Line, Experimental Variant Functional Impact Proposition, Experimental Variant Functional Impact Study Result, Expression, Functional Domain, Ga4ghIdentifiableObject, Gene Disease Validity Proposition, Genetic Context Variant Proposition, Information Entity, Length Expression, Literal Sequence Expression, Location, Mappable Concept, Method, MolecularVariation, Proposition, Reference Length Expression, Relative Allele, Relative Sequence Location, SequenceExpression, SequenceLocation, Sequence Offset Location, SequenceReference, Statement, Study Group, Study Result, Subject Variant Proposition, Systemic Variation, Terminus, Traversal Block, Tumor Variant Frequency Study Result, Unspecified Element, Variant Clinical Significance Proposition, Variant Diagnostic Proposition, Variant Molecular Consequence Proposition, Variant Oncogenicity Proposition, Variant Pathogenicity Proposition, Variant Prognostic Proposition, Variant Therapeutic Response Proposition, Variation