Site bore reference

Borehole records referenced for a site.

Part of Projects in the register catalog.

Register ID

site_bore_referenceUse this name to ask for the register. The API calls it a shelf ID.

Each record is

A stateThe current value of something, replaced when it changes.

Status

DeclaredDefined, and fills when a source produces its first record.

Data

OrganisationPrivate to each organisation's own workspace.

Version

v1Current version.

Download JSON SchemaSee an example record

Connectors

Connected today

Demiton keeps this register current from these systems now.

No system fills this register yet.

On the roadmap

Systems in the planned connector rollout that can fill this register. Partial means the system holds only some of its fields.

None planned yet.

Fields

18 fields: 9 required, 9 optional.

Required

Every record carries these fields.

projectText

The tenant project whose site coordinate the answer is about.

Example: BWG-2025-003

radius_mWhole numberUnit: m

The search radius the counts and distances were computed at.

Example: 500

bores_within_radiusWhole numberUnit: dimensionless (named absence, not "count")

Number of registered bores inside radius_m

Example: 3

logged_bores_within_radiusWhole number

How many of those carry a lithology log.

Example: 1

nearest_bore_distance_mDecimal numberUnit: m

Distance from the project site coordinate to the nearest registered bore within the radius.

Example: 210.5

nearest_bore_rock_depth_mDecimal numberUnit: m (below ground level)

Shallowest depth_top_m of an interval whose MajorLithCode is in the rock allowlist, in the nearest logged bore; null means no rock evidenced, and null is a first-class answer.

Example: 18.2

sourceText

The register and vintage the answer was resolved from (e.g. the NGIS NSW extract)

Example: Queensland Groundwater Database

horizontal_datumText

The horizontal datum (and, where frame-based, the realisation) the site coordinate was expressed in.

Example: GDA2020

contentText

One sentence stating the resolved answer.

Example: 3 registered bores within 500 m of the Cherbourg Water Tr…

Optional

Present when the source system records them.

nearest_logged_bore_distance_mDecimal numberUnit: m

Distance to the nearest bore that carries a log.

nearest_logged_bore_idWhole number

The source register's bore_id for the nearest logged bore.

Example: 142207

nearest_bore_drilled_depth_mDecimal numberUnit: m

Total drilled depth of the nearest logged bore.

rock_lith_codeText

The MajorLithCode that evidenced rock.

rock_lith_schemeText

The code list/edition the lithology code belongs to (NGIS MajorLithCode; AS 1726:2017 / AGS 4.2 / DIGGS for other sources)

register_stateText

The state register the answer came from.

Example: QLD

resolved_atDate and timeISO 8601, with time zone

When the answer was resolved.

Example: 2026-06-10T09:00:00+10:00

resolver_versionText

Which resolver/method version produced the answer.

Example: geo-resolver-v2

datum_epochText

The epoch where the horizontal datum is frame-based.

Example record

A sample from Bridgeworks Group, Demiton's demonstration company. The values are illustrative; the shape is exactly what the contract describes.

site_bore_reference.example.json

{
  "bores_within_radius": 3,
  "content": "3 registered bores within 500 m of the Cherbourg Water Treatment Plant site; nearest logged bore RN142207 at 210.5 m, rock at 18.2 m depth.",
  "horizontal_datum": "GDA2020",
  "logged_bores_within_radius": 1,
  "nearest_bore_distance_m": 210.5,
  "nearest_bore_rock_depth_m": 18.2,
  "nearest_logged_bore_id": 142207,
  "project": "BWG-2025-003",
  "radius_m": 500,
  "register_state": "QLD",
  "resolved_at": "2026-06-10T09:00:00+10:00",
  "resolver_version": "geo-resolver-v2",
  "source": "Queensland Groundwater Database"
}

Use this contract

The contract is a standard JSON Schema (draft 2020-12) document, so any JSON Schema validator can check a record against it. Keywords starting with x-demiton- add Demiton's own meaning, such as units and requiredness, and validators ignore them.

Schema URL

https://docs.demiton.io/registers/site_bore_reference/v1.json

Show the full JSON Schema

Loading the schema…