Categorical Variant

The Categorical Variant class is the primary class in Cat-VRS. It depends on one or more Constraint elements to create a complete description of a categorical variant.

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

A representation of a categorically-defined domain for variation, in which individual Constraintual variation instances may be members of the domain.

Information Model

Some CategoricalVariant attributes are inherited from Entity.

Field	Flags	Type	Limits	Description
id		string	0..1	The ‘logical’ identifier of the Entity 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.
name		string	1..1	A primary name for the entity.
description		string	0..1	A free-text description of the Entity.
aliases	⋮	string	0..m	Alternative name(s) for the Entity.
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.
type		string	1..1	MUST be “CategoricalVariant”
members	⋮	Variation | iriReference	0..m	A non-exhaustive list of VRS Variations that satisfy the constraints of this categorical variant.
constraints	⋮	Constraint	0..m
mappings	⋮	ConceptMapping	0..m	A list of mappings to concepts in terminologies or code systems. Each mapping should include a coding and a relation.

Examples

This documentation contains several Examples, organized by Constraint . Each Constraint and Recipe also include representative examples inline with their documentation.

Implementation Guidance

We recommend referring to specific Recipes of interest to your implementation when starting to represent concepts with Cat-VRS. Our Quick Start guide also references software that may be helpful to both consume and produce Cat-VRS objects.