ORE Studio 0.0.4
Loading...
Searching...
No Matches
Public Attributes | List of all members
coding_scheme Struct Referencefinal

Defines a coding or identification standard used to identify entities. More...

#include <coding_scheme.hpp>

Collaboration diagram for coding_scheme:
Collaboration graph

Public Attributes

int version = 0
 Version number for optimistic locking and change tracking.
 
std::string code
 Unique code identifying this coding scheme.
 
std::string name
 Human-readable name for the coding scheme.
 
std::string authority_type
 Type of authority that maintains this scheme.
 
std::string subject_area_name
 Subject area this scheme belongs to.
 
std::string domain_name
 Data domain this scheme applies to.
 
std::optional< std::string > uri
 Optional URI pointing to the official scheme definition.
 
std::string description
 Human-readable description of the coding scheme's purpose.
 
std::string recorded_by
 Username of the person who last modified this scheme.
 
std::string change_commentary
 Free-text commentary explaining the change.
 
std::chrono::system_clock::time_point recorded_at
 Timestamp when this version of the record was recorded.
 

Detailed Description

Defines a coding or identification standard used to identify entities.

A scheme defines a coding or identification standard used to identify entities such as parties, currencies, or other domain objects. Based on the FPML coding-scheme concept.

Member Data Documentation

◆ code

std::string code

Unique code identifying this coding scheme.

This is the natural key for the scheme. Examples: "ISO_4217", "SWIFT_BIC", "LEI".

◆ authority_type

std::string authority_type

Type of authority that maintains this scheme.

Links to coding_scheme_authority_type for categorization.

◆ subject_area_name

std::string subject_area_name

Subject area this scheme belongs to.

Links to subject_area for organizational structure.

◆ domain_name

std::string domain_name

Data domain this scheme applies to.

Links to data_domain for domain categorization.