Extension

Note

This data class is at a trial use maturity level and may change in future releases. Maturity levels are described in the GKS 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	⋮	Extension	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.