Schema

You can download the release-schema.json file in English.

Planning

The extension defines these fields in the Planning object from OCDS:

Field Title Description Type(s)
forecasts Forecasts

Any forecasts metrics for this results of this contracting process.

 array of Metric objects

Tender

The extension defines these fields in the Tender object from OCDS:

Field Title Description Type(s)
targets Targets

Any target metrics for this results of this contracting process.

 array of Metric objects

Award

The extension defines these fields in the Award object from OCDS:

Field Title Description Type(s)
agreedMetrics Agreed metrics

Any target metrics set out as part of the contract award.

 array of Metric objects

Contract

The extension defines these fields in the Contract object from OCDS:

Field Title Description Type(s)
agreedMetrics Agreed metrics

Any target metrics set out as part of the contract documents.

 array of Metric objects

Implementation

The extension defines these fields in the Implementation object from OCDS:

Field Title Description Type(s)
metrics Metrics

Reported results from the delivery of the contracted goods, works or services.

 array of Metric objects

Metric

The extension defines a new Metric object with these fields:

Field Title Description Type(s)
id Identifier

An identifier for this metric. In some cases this may be drawn from a codelist of metrics required for this type of contracting process, or in other instances may be an arbitrary identifier.

 string
title Title

The title of this metric

 string
description Description

A short description of the metric. This may include short details of measurement methods.

 string
observations Observations

An array of target or actual values for this metric.

 array of Observation objects

Observation

The extension defines a new Observation object with these fields:

Field Title Description Type(s)
id Identifier

A local identifier for this specific observation. This may be an arbitrary identifier, or could be a composite of the metric identifier, and the date and other dimensions of this observation.

 string
period Period object
value Value object
measure Observation measure

For non-financial metrics, the measure of this forecast, target or actual observation. Measures may be provided as free text or numerical values.

 string or number
unit Unit

Unit

 object
unit.name Unit name

The name of the unit.

 string
unit.scheme Scheme

The list from which units of measure identifiers are taken. This should be an entry in the unitClassificationScheme codelist. Use of the scheme 'UNCEFACT' for the UN/CEFACT Recommendation 20 list of 'Codes for Units of Measure Used in International Trade' is recommended.

 string from open unitClassificationScheme codelist
unit.id ID

The identifier from the codelist referenced in the schema property. For example, with UNCEFACT, this is the value of the 'Common Code' column. From this identifier, applications can look-up the human readable name or symbol for this unit of measure.

 string
unit.uri URI

If the scheme used provide a machine-readable URI for this unit of measure, this can be given.

 string
dimensions Dimensions

Any number of dimensions can be recorded within this object. Dimensions names should follow the camelCase conventions of OCDS.

 object
dimensions.(^.*) string
notes Notes

Any notes on this observation. This may include clarifying information.

 string
relatedImplementationMilestone Related implementation milestone

A link to the milestone in the implementation section of OCDS to which this forecast, target or actual observation relates.

 MilestoneReference object

MilestoneReference

The extension defines a new MilestoneReference object with these fields:

Field Title Description Type(s)
id Milestone ID

The ID of the milestone being referenced, this must match the ID of a milestone described elsewhere in a release about this contracting process.

 string
title Milestone title

The title of the milestone being referenced, this must match the title of a milestone described elsewhere in a release about this contracting process.

 string