Keyword Reference & Scopes#
This document provides the detailed specification for every keyword introduced by the FAIR Data JSON Schema Annotations Vocabulary (https://highvaluedata.net/fair-data-schema/vocab/annotations).
1. Universal Scope (Any Schema Object)#
Keywords providing basic identification and semantic context. Can be applied at the dataset, table, or property level.
Keyword |
Type |
Description & Usage |
|---|---|---|
|
|
The architectural role of the schema object. Standard values: |
|
|
The URI or CURIE pointing to an authoritative semantic definition (e.g. Wikidata, AGROVOC, LOINC). |
|
|
Human-readable literal name of the underlying concept. |
|
|
Short title or label. Supports multilingual i18n objects (e.g., |
|
|
Detailed markdown-formatted description. Supports i18n. |
|
|
List of secondary, historical, or domain-specific identifiers ( |
2. Dataset Scope (Container / Resource Level)#
Keywords describing provenance, temporal/spatial bounds, licensing, and overall dataset structure.
Keyword |
Type |
Description & Usage |
|---|---|---|
|
|
Version descriptor resource ( |
|
|
List of contributor agents (aligned with W3C PROV-O). Each item contains |
|
|
Plain-text license identifier (e.g., |
|
|
Direct URI to the license terms (e.g., |
|
|
Plain text or ISO 8601 interval describing the time window (e.g., |
|
|
URI reference to a geographical region or gazetteer entity (e.g., NUTS or Geonames URI). |
|
|
Target universe or population bounded by time and space (e.g., |
|
|
Structural payload layout aligned with CDIF Data Structure profile: |
|
|
Measured data quality metrics aligned with W3C DQV ( |
|
|
Inter-dataset relationships (e.g., |
3. Property Scope (Variable / Column Level)#
Keywords describing data representation, units, measurement scales, classification schemes, and missing value sentinels.
Keyword |
Type |
Description & Usage |
|---|---|---|
|
|
Plain-text name of the physical unit of measurement (e.g., |
|
|
Authoritative unit URI (e.g. QUDT or Wikidata URI). |
|
|
Statistical measurement scale type: |
|
|
Literal name of the classification scheme or code list (e.g., |
|
|
URIs pointing to the authoritative classification scheme. |
|
|
Flag indicating that the value is a missing data / suppressed sentinel value (must be paired with |
|
|
Observation entity type for 1 row (e.g., |
|
|
Broad population boundary for the variable (e.g., |
Variable Cascade References (DDI & CDIF Alignment)#
fair:variableRef: Generic link to a shared variable definition.fair:instanceVariableRef: Link to a dataset-specific variable implementation.fair:representedVariableRef: Link to a shared representation/value domain.fair:conceptualVariableRef: Link to a high-level conceptual variable.