Natural Resource Common Permitting Data Specifications

lifecycle:maturing Contributions:Welcome Data:Schema

Description

This repository contains common schemas related to permitting in the Natural Resources Sector for the Province of British Columbia. The intent of these are to standardize the way permitting in the Natural Resource Sector is described as data to enable quality and interoperability.

Hosting this specification in the open will encourage collaboration, adoption and enable versioning.

These will be reviewed and updated with relevant partners, data custodians, stewards and sector permitting teams.

Purpose

The common specifications are to

  • create cross sector data governance
  • feed intelligence to the sector
  • moving towards harmonized statuses
  • activity-based permit bundling and application process tracking
  • enable consistent collection of data and metadata
  • leverage for an integrated data schema for reporting and analytics
  • identify opportunities to improve data quality, create data visualizations and identify gaps
  • help develop patterns for data collection, integration and aggregation
  • develop common schema patterns to use as a template for other interests

Overview

Schemas

Subject Description JSON DOC
Core Specification The core permitting content, structure, data types, and expected enums that are consistent across all permitting datasets. json doc
Housing Specification The housing specific schema elements that extend the core schema. json doc
Metadata Specification The metadata elements required and captured while discovering and onboarding into an integrated dataset. json doc
Permit Name Registry Specification This spec is to enable the registry of permit names from source systems/information to be used as enums in the core Core Specification. json doc

Scripts

Subject Description Readme
Validation This package takes a JSON document and validates it against an expected schema structure as defined in a JSON schema definition file. readme
Auto-generation of docs This package converts JSON schema definition files into markdown files. readme

Future

  • Complete data dictionaries
  • Finalize status and states terms

Schemas

  • status and state registries
    • To enable the mapping of source values to a standardized list
  • activity bundling
    • To enable identifying what permits are applicable to an activity on the landbase, e.g., housing, mining, connectivity.
  • client/proponent
  • other permitting initiatives

Design

Along with the data specification will be the design presentation to enable a common look and feel.