JSON Schema Index
This page provides a complete index of all JSON Schema definitions in the Orthogramic Metamodel. Use these schemas for validation, code generation, and API integration.
Schema Specifications
| Aspect | Value |
|---|---|
| Schema Version | 2.1 |
| JSON Schema Draft | Draft-07 |
| Base URI | https://orthogramic.com/schemas/ |
| License | CC BY-SA 4.0 |
Core Domain Schemas
Primary Domains
| Domain | Schema Location | Description |
|---|---|---|
| Organization | /schemas/domains/organization.schema.json | Organizational units and structure |
| Stakeholder | /schemas/domains/stakeholder.schema.json | People, groups, and roles |
| Capabilities | /schemas/domains/capabilities.schema.json | Business capabilities |
| Value Stream | /schemas/domains/value-stream.schema.json | End-to-end value delivery |
| Information | /schemas/domains/information.schema.json | Information assets and data |
| Strategy | /schemas/domains/strategy.schema.json | Strategic objectives |
| Performance | /schemas/domains/performance.schema.json | KPIs and metrics |
| Initiatives | /schemas/domains/initiatives.schema.json | Programs and projects |
| Products | /schemas/domains/products.schema.json | Product offerings |
| Services | /schemas/domains/services.schema.json | Service offerings |
| Policy | /schemas/domains/policy.schema.json | Policies and governance |
Extended Domains
| Domain | Schema Location | Description |
|---|---|---|
| Customer | /schemas/domains/customer.schema.json | Customer segments |
| Market | /schemas/domains/market.schema.json | Markets and competition |
| Finance | /schemas/domains/finance.schema.json | Financial modeling |
| Risk Management | /schemas/domains/risk-management.schema.json | Risks and controls |
| Technology | /schemas/domains/technology.schema.json | Technology components |
| Supply Chain | /schemas/domains/supply-chain.schema.json | Suppliers and logistics |
| People | /schemas/domains/people.schema.json | Workforce and skills |
| Channel | /schemas/domains/channel.schema.json | Distribution channels |
| Innovation | /schemas/domains/innovation.schema.json | Innovation pipeline |
| Sustainability | /schemas/domains/sustainability.schema.json | ESG and environment |
| Intelligence | /schemas/domains/intelligence.schema.json | BI and analytics |
| Manufacturing | /schemas/domains/manufacturing.schema.json | Production processes |
| Social Change | /schemas/domains/social-change.schema.json | Social impact |
Extension Schemas
Domain Relationships
| Schema | Location | Description |
|---|---|---|
| Cross-Domain Relationships | /schemas/extensions/cross-relationships/cross-domain.schema.json | How domains connect |
| Inter-Unit Relationships | /schemas/extensions/inter-unit-relationships.schema.json | Unit-to-unit connections |
| Relationship Directionality | /schemas/extensions/relationship-directionality.schema.json | Directional semantics |
Strategic Response Model
| Schema | Location | Description |
|---|---|---|
| Trigger | /schemas/extensions/srm/trigger.schema.json | Events prompting response |
| Rationale | /schemas/extensions/srm/rationale.schema.json | Decision reasoning |
| Response | /schemas/extensions/srm/response.schema.json | Actions taken |
| Performance Indicators | /schemas/extensions/srm/performance-indicators.schema.json | SRM-specific KPIs |
| SRM Complete | /schemas/extensions/srm/srm-complete.schema.json | Full SRM bundle |
Coverage Extensions
| Schema | Location | Description |
|---|---|---|
| Coverage Template | /schemas/extensions/coverage-template.schema.json | Domain requirements |
| Organization Goal | /schemas/extensions/organization-goal.schema.json | Adoption targets |
| Coverage Status | /schemas/extensions/coverage-status.schema.json | Current state |
| Coverage Expectation | /schemas/extensions/coverage-expectation.schema.json | Milestones |
Interoperability
| Schema | Location | Description |
|---|---|---|
| BIAN Mapping | /schemas/extensions/bian-mapping.schema.json | Banking standard |
| SAP EAF Mapping | /schemas/extensions/sap-eaf-mapping.schema.json | SAP alignment |
| FIBO Mapping | /schemas/extensions/fibo-mapping.schema.json | Financial ontology |
| External Organizations | /schemas/extensions/external-organizations.schema.json | Cross-enterprise |
| Well-Architected | /schemas/extensions/well-architected.schema.json | Cloud frameworks |
Business Analysis
| Schema | Location | Description |
|---|---|---|
| Requirements | /schemas/extensions/business-analysis/requirements.schema.json | Formal requirements |
| Artifacts | /schemas/extensions/business-analysis/artifacts.schema.json | BA deliverables |
| Elicitation Activities | /schemas/extensions/business-analysis/elicitation.schema.json | Gathering methods |
| Analysis & Design | /schemas/extensions/business-analysis/analysis-design.schema.json | Solution options |
| Solution Evaluation | /schemas/extensions/business-analysis/evaluation.schema.json | Assessment |
| Business Analysis Complete | /schemas/extensions/business-analysis.schema.json | Full BA bundle |
Common Definitions
Reusable schema definitions referenced across multiple schemas:
| Definition | Location | Used By |
|---|---|---|
identifier | /schemas/common/identifier.schema.json | All domains |
reference | /schemas/common/reference.schema.json | Cross-domain links |
dateRange | /schemas/common/date-range.schema.json | Temporal attributes |
contact | /schemas/common/contact.schema.json | Stakeholder, People |
monetaryAmount | /schemas/common/monetary-amount.schema.json | Finance, Initiatives |
metric | /schemas/common/metric.schema.json | Performance, KPIs |
enumeration | /schemas/common/enumerations.schema.json | All enumerated types |
Schema Structure
Standard Domain Schema Structure
Each domain schema follows a consistent structure:
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "https://orthogramic.com/schemas/domains/{domain}.schema.json",
"title": "{Domain Name}",
"description": "{Domain description}",
"type": "object",
"required": ["title", "description"],
"properties": {
"title": {
"type": "string",
"description": "Entity name"
},
"description": {
"type": "string",
"description": "Entity description"
}
},
"definitions": {
// Reusable sub-schemas
}
}
Extension Schema Structure
Extension schemas typically include references to domain schemas:
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "https://orthogramic.com/schemas/extensions/{extension}.schema.json",
"title": "{Extension Name}",
"allOf": [
{"$ref": "../common/base-extension.schema.json"},
{
"type": "object",
"properties": {
// Extension-specific properties
}
}
]
}
Using the Schemas
Validation Example (JavaScript)
const Ajv = require('ajv');
const ajv = new Ajv({ allErrors: true });
// Load schema
const capabilitySchema = require('./schemas/domains/capabilities.schema.json');
// Compile validator
const validate = ajv.compile(capabilitySchema);
// Validate data
const capability = {
title: "Customer Onboarding",
description: "Capability to register new customers",
owner: "Retail Banking"
};
const valid = validate(capability);
if (!valid) {
console.log(validate.errors);
}
Validation Example (Python)
import json
from jsonschema import validate, ValidationError
# Load schema
with open('schemas/domains/capabilities.schema.json') as f:
schema = json.load(f)
# Validate data
capability = {
"title": "Customer Onboarding",
"description": "Capability to register new customers",
"owner": "Retail Banking"
}
try:
validate(instance=capability, schema=schema)
print("Valid!")
except ValidationError as e:
print(f"Invalid: {e.message}")
Code Generation Example (TypeScript)
Using json-schema-to-typescript:
npx json-schema-to-typescript schemas/domains/capabilities.schema.json > types/capabilities.d.ts
Generated TypeScript:
export interface Capability {
title: string;
description: string;
owner: string;
capabilityLevel?: number;
maturityLevel?: 'initial' | 'developing' | 'defined' | 'managed' | 'optimizing';
// ...
}
Schema Versioning
Version History
| Version | Date | Changes |
|---|---|---|
| 2.1 | 2025-01 | Added Business Analysis extension |
| 2.0 | 2024-10 | Added SRM, Coverage, Interoperability |
| 1.5 | 2024-06 | Added extended domains |
| 1.0 | 2024-01 | Initial core domains |
Version Compatibility
- Major versions (1.x → 2.x): May include breaking changes
- Minor versions (2.0 → 2.1): Additive, backward compatible
- Schema $id includes version when breaking changes occur
Schema Downloads
Individual Downloads
Download schemas individually from the schema locations listed above.
Bundle Downloads
| Bundle | Contents | Download |
|---|---|---|
| Core Domains | 11 core domain schemas | orthogramic-core-schemas.zip |
| Extended Domains | 13 extended domain schemas | orthogramic-extended-schemas.zip |
| All Extensions | All extension schemas | orthogramic-extensions-schemas.zip |
| Complete Bundle | All schemas | orthogramic-all-schemas.zip |
NPM Package
npm install @orthogramic/schemas
const { CapabilitySchema, ValueStreamSchema } = require('@orthogramic/schemas');
GitHub Repository
All schemas are maintained in the Orthogramic GitHub repository:
https://github.com/orthogramic/metamodel
Schema Validation Tools
Online Validators
- JSON Schema Validator — Paste schema and data
- Hyperjump — Advanced validation
CLI Tools
| Tool | Language | Installation |
|---|---|---|
| ajv-cli | Node.js | npm install -g ajv-cli |
| jsonschema | Python | pip install jsonschema |
| check-jsonschema | Python | pip install check-jsonschema |
IDE Extensions
| IDE | Extension |
|---|---|
| VS Code | JSON Schema Validator |
| IntelliJ | Built-in JSON Schema support |
| Sublime | SublimeLinter-json |
Related Documentation
- Domain Attributes Summary — Quick attribute reference
- Contribution Guidelines — How to contribute schemas
- API Patterns — Using schemas in integrations