Schemas
Every ODS schema, by kind: the document, its four pillars, the entities they hold, the parts entities own and the datatypes they all use. Each schema is a JSON Schema 2020-12 file. The conventions say how they are named and built, and the glossary defines each word.
Document and pillars
The root of an ODS file, and the four groups it holds. Each pillar answers one question.
Entities
Records that other records point at by id. Each sits under the pillar whose lists hold it, with those lists.
RiskWhat risks must the development manage, and which rules manage them?
- FrameworkframeworksA set of rules for one domain, issued by a regulator, an industry body or an organization, such as AER Directive 038. It holds its policies, controls, periods and variables.
- RegulatorProfileprofilesA framework written so that a program can run it. It names the framework, the flows that check it, who publishes it and its version. Its flows have no sealed steps, so any reader can run every rule.
ContextWhat is being assessed?
- StakeholderstakeholdersA person or organization involved in a development, such as an operator, a consultant, a regulator or a resident.
- JurisdictionjurisdictionsAn area under one legal authority, such as a country, a province or a municipality. It decides which frameworks apply to the features in it.
- PermitpermitsA licence or approval that a regulator gives for a development, with its holder, its dates, its status and its own criteria, such as a site's own noise limit.
- ProjectprojectsA piece of work on one or more features, with its activities and groups. It refers to its features by id; the features themselves live in context.
- FeaturefeaturesA natural or built object with a place and properties, such as a wellsite, a dwelling or a road. As in ISO 19101. A feature where a framework judges effects is a receptor and has a receptor class.
- InstrumentinstrumentsA device that measures, such as a sound level meter, a microphone or a weather station, with its calibrations.
EnvironmentWhat conditions surround it?
MethodologyHow is it assessed, and what was found?
- AlgorithmalgorithmsA published or versioned computation, such as ISO 9613-2:2024, or a model trained on data. Sealed steps and runs refer to it by id, as the method they claim to follow.
- FlowflowsThe steps of an evaluation and the edges between them. A flow can run another flow as one of its steps.
- AssumptionassumptionsA fact that an evaluation takes as true without evidence, such as an operating state or the weather, with the reason for it.
- EvidenceevidenceOne observation, measured or calculated: what was observed, of which record, by which instrument or algorithm, over which interval, and the result. As in ISO 19156 (Observations and measurements).
- TracetracesWhat one run of a flow or an algorithm did: what it used, each step, what it made, and the verdict. Its terms follow W3C PROV where they map: agents (prov:wasAssociatedWith), inputs (prov:used), outputs (prov:generated).
- AssessmentassessmentsAn evaluation of a development and its result, such as a noise impact assessment. It names its authors, scope and framework, the traces and evidence it rests on, and its conclusions. A trace is one run; an assessment can rest on many.
Parts
Records that a parent owns and embeds.
- ActivityWork that happens over time, such as construction, drilling or operation. Its allocations say where and when it happens and which operating states it uses.
- AllocationWhere and when an activity happens, and the operating states its sources run in there.
- CalibrationA check of an instrument against a reference, with its date, its result and its certificate.
- ComparisonTwo results for the same thing, their difference, the tolerance that judges it and the verdict. Validation runs, monitoring against prediction and conformance tests use it.
- ControlA check on how an evaluation is done, which a framework sets, such as "a person approves each decision" or "measurements use a Class 1 meter". A mitigation is not a control: a barrier is a Structure, and a site's own limit is a criterion of its Permit.
- CriterionOne rule that must be checked. It compares a metric, summed up by a statistic over a period, with a limit, for the features it applies to.
- EdgeA link from one step of a flow to the next. Its
whensays when the flow takes it. - EmissionWhat a source gives off in one operating state, such as sound power, a pollutant rate or a discharge. A module schema can require more of it for its domain.
- FindingSomething a check, an agent or a person found about a record: a problem, a risk or a note. Traces, conformance checks and report imports all report findings.
- GroupFeatures that a project evaluates together as one unit, such as wellsites close to each other. A group has no sources of its own: its members carry them.
- Operating stateA named way that a source runs, set by its operating properties, such as speed, load, flow rate or mode. Off is an operating state. Each emission names the state it holds for.
- PathA route from one place to another, with its line and the ordered events along it, such as a sound path from a source to a receptor or a plume's trajectory.
- PeriodA recurring window in local time that a rule judges by, such as night-time from 22:00 to 07:00. A window whose end is not after its start runs past midnight.
- PolicyOne risk that a framework manages, and the criteria that manage it.
- PropertyOne fact about a record, such as a source's rotational speed, a terrain's ground type or the air temperature of a weather condition. Its
typecomes from a quantities vocabulary, which gives the unit and the valid range. - SourceA part of a feature that emits, such as a compressor, an engine, a stack or an outfall. As in ISO 14224:2016, levels 6 to 8. A source can hold smaller sources, such as a compressor's engine and cooler.
- StepOne unit of work in a flow, such as a calculation, a question, a decision or a run of an algorithm. A sealed step names its inputs, its outputs and the algorithm it claims to follow, but not how it works.
- StructureA built form, such as a building, a wall or a barrier. As in IFC (ISO 16739).
- VariableA named Value or formula that criteria and steps refer to, such as a framework's limit or a method's parameter.
Datatypes
Data with no identity, such as a Value or a Location.
Amounts
- ValueAn amount with its unit and uncertainty. A list amount can lie along axes (a spectrum, a time series, a profile, a grid), and a large amount can sit in a File. Measured, calculated and set values all use it.
- AxisOne dimension of a Value's amount, such as frequency, time, height or wind speed. It gives the coordinate of each element along it.
- StatisticHow an amount sums up data, such as a mean, a maximum or an exceedance level.
Place
- LocationOne place, as a point with the heights that matter for it. A location can also state the place in other ways, such as a legal land description or a distance along a line, and a place that has no coordinates has only those. Coordinates are in GeoJSON order (x, y): longitude then latitude…
- GeometryA point, a line, an area, or several of one kind. The first and last positions of a polygon ring are the same. GeoJSON has no curves, surfaces or solids: a shape that has them keeps its original.
- Coordinate reference systemHow to read coordinates and heights (ISO 19111): the horizontal system, the vertical system that heights refer to and the epoch of the coordinates. A crs names its system by a registry code, or holds the full definition of the system. Coordinates are in GeoJSON order (x, y) for every system:…
- PositioningHow a position was obtained and how accurate it is. It holds the method, the time, the accuracy in metres and what the position rests on. The accuracy is absolute positional accuracy, as in ISO 19157.
- Geographic identifierA place stated by a name or an id, not by coordinates, such as a legal land description, a parcel id, a civic address or a feature of a named dataset. As in ISO 19112.
- Linear referenceA place stated as a distance along a line, such as a kilometre post on a pipeline. As in ISO 19148.
- OriginalThe dataset that a GeoJSON shape was converted from, with the layer and the feature in it, and what the conversion changed. GeoJSON cannot hold curves, surfaces or solids, so the original stays the exact shape and the GeoJSON is the shape that every reader can read.
Identity and links
- IdentifierA licence number, a register id or a producer's own key. The record's own
idstays the one that references use. - LinkAn open-ended link from the record that holds it to another record. When a field names its target, such as a trace's
flow, that field is used instead. - CitationA published work that a record rests on, such as a regulation, a standard, a paper or a procedure.
Facts and logic
Base
Fields that every entity shares.
ODS Acoustics
Module schemas of ODS Acoustics: stricter forms of Core schemas. They add no fields.