Schema reference¶
This page presents the fields in the OC4IDS schema in tables with additional information in paragraphs. Required fields are indicated in the Required column.
For fields that reference a sub-schema, a link is provided to a table with details of the sub-schema. To see how the fields and sub-schemas fit together, consult the schema browser.
Examples are provided for each table, showing how to represent the fields in the table in JSON format. For more information on the examples, see examples.
Project¶
The top-level object in OC4IDS is a project.
A project is defined as:
The development of a set of infrastructure assets in a specified location, generally the responsibility of a single procuring entity and budget authority: for example, a highway overpass or a university campus.
A project's fields include:
Metadata, such as the project's
title
,description
andstatus
.Budget data, which describes the projected costs or allocated budget for the project.
Data about the parties (organizations and other participants) involved in the project.
Links to documents relating to the project, such as needs assessments and project evaluations.
Data about contracting processes for different aspects of the project, such as design, construction and supervision.
Completion data, such as the final scope, duration and costs for the project.
Each project has the following fields.
Title |
Description |
Type |
Format |
Required |
---|---|---|---|---|
id |
string |
Required |
||
Identifier or Reference |
An identifier for this infrastructure project. The identifier must be globally unique and must begin with a registered project identifier prefix. For more information, see the project identifier guidance. |
|||
updated |
string |
date-time |
||
Last updated |
The date on which project-level information was last updated. This should not be changed when constituent contracting processes information changes, unless this project-level data has been updated as a result, or to provide explanations or justifications for those changes. |
|||
title |
string |
|||
Project title |
The title of the project. |
|||
description |
string |
|||
Project description |
A description of this project. This should usually be no longer than a single paragraph. |
|||
status |
string |
|||
Status |
The current phase or status of this project, from the projectStatus codelist. |
|||
period |
object |
|||
Project period |
The period over which this project is planned to run. This may be updated during the preparation phase as information becomes available to more accurately specify anticipated start and end dates, but should not be updated during the implementation or completion phases. The planned completion date of the project should be provided in See Period |
|||
sector |
array[string] |
|||
Project sector |
One or more values from the projectSector codelist representing the sector(s) this project relates to. More detailed sector breakdown information can be provided using the pattern [sector].[subsector]. Where subsector codes are used the parent code should also be included, e.g. |
|||
purpose |
string |
|||
Project purpose |
The socioeconomic purpose of this project. |
|||
additionalClassifications |
array[Classification] |
|||
Additional classifications |
One or more additional project classifications may be provided to describe the social or economic focus of the project. This classification may take place against a locally developed codelist, or a globally established codelist. See Classification |
|||
type |
string |
|||
Project type |
Whether the primary focus of this project is the construction of a new asset or the rehabilitation or replacement of an existing asset, from the projectType codelist. |
|||
relatedProjects |
array[Related project] |
|||
Related projects |
References to projects related to the same set of infrastructure assets as this project. For example, a project for the replacement of a bridge might reference the earlier project for its initial construction. See RelatedProject |
|||
assetLifetime |
object |
|||
Asset lifetime |
The anticipated lifetime of the asset after this project is completed. This may be provided as either explicit dates or an estimated duration. See Period |
|||
locations |
array[Delivery Location] |
|||
Project locations |
Information about the location where a project is taking place. One or more locations may be provided, or the location may be described in a number of different ways, such as a point location for the central location of construction, and a gazetteer entry to describe the region where the project is taking place. See Location |
|||
budget |
object |
|||
Total project value |
Specify the projected costs or allocated budget for the infrastructure project (currency and amount). This cost should include land and property acquisition, environmental mitigation measures, health and safety provisions, client, consultant and contractor costs, as well as applicable taxes. Where this value includes costs incurred directly by the project owner or other agencies, which are not subject to procurement, then this value is likely to be higher than the sum of all the linked contracting processes. To indicate the profile of a budget over time, or the budget coming from different sources, the extended budgetBreakdown section may be used. |
|||
budget/description |
string |
|||
Description |
A short free-text description of the budget that will fund the project. This may be used to provide human-readable information on: the budget category for the project and/or the nature and source of the budget allocation (e.g. conditional, confirmed, or any official authorizations given to the budget allocation). |
|||
budget/amount |
object |
|||
Amount |
The projected costs or allocated budget for the project. See Value |
|||
budget/requestDate |
string |
date-time |
||
Request date |
The date on which the project budget was requested. |
|||
budget/approvalDate |
string |
date-time |
||
Approval date |
The date on which the project budget was approved. Where documentary evidence for this exists, it may be included among the project documents with the documentType set to 'budgetApproval'. |
|||
budget/budgetBreakdown |
array[Detailed budget breakdown] |
|||
Budget breakdown |
A detailed breakdown of the budget by period and/or participating funders. See BudgetBreakdown |
|||
forecasts |
array[Metric] |
|||
Forecasts |
Forecast metrics for this project, such as planned physical or financial progress over time. See Metric |
|||
parties |
array[Organization] |
|||
Parties |
Information on the parties (organizations, economic operators and other participants) who are involved in the project and their roles, e.g. buyer, procuring entity, supplier etc. Organization references elsewhere in the schema are used to refer back to this entries in this list. See Organization |
|||
publicAuthority |
object |
|||
Public authority |
The name and identifier of the public authority that is tendering and contracting the project. The full details of the entity should be added to the project-level |
|||
documents |
array[Document] |
|||
Documents |
Documentation related to this project. Entries may include a short text summary (plain text, HTML or Markdown), and/or a link to a specific document accessible on the web. At the identification phase, a project scope (documentType: projectScope) is expected. At the preparation phase, environmental impact (documentType: environmentalImpact) and land and settlement impact (documentType: landAndSettlementImpact) documentation is expected. During implementation, procurement documents should be shared at the contracting process level, but key documents may also be provided here. At the completion phase, final audit (documentType: finalAudit) and evaluation (documentType: projectEvaluation) reports and documents are expected. See Document |
|||
contractingProcesses |
array[Contracting process] |
|||
Contracting processes |
A single project may have a number of related contracting processes (design, construction, monitoring etc.). Project-level data should contain (a) an index of those contracting process; (b) the latest summary information about them; (c) a change history with explanations for any major modifications to contract duration, price or scope. Where OCDS data is published on each contracting process, a link should be provided to each available release of OCDS data (e.g. to each notice or updated notice), and this OCDS data may be used to automatically populate the summary information. |
|||
metrics |
array[Metric] |
|||
Metrics |
Actual metrics for this project, such as the actual physical or financial progress over time. See Metric |
|||
completion |
object |
|||
Completion |
This information is provided at project completion, and reflects the final timing and values relating to the project. The reason for any variation (not already explained) between the anticipated project scope, period and value should be detailed. |
|||
completion/endDate |
string |
date-time |
||
End date |
The actual completion date for the project (compare with the endDate in project period). |
|||
completion/endDateDetails |
string |
|||
End date details |
Details related to the endDate. This may be a justification for the project's completion date being different than in the original project. |
|||
completion/finalValue |
object |
|||
Final value |
The total cost of this project at completion (compare with project budget). See Value |
|||
completion/finalScope |
string |
|||
Final scope |
A short description of the final scope of the project at completion. |
|||
completion/finalScopeDetails |
string |
|||
Final scope details |
A reason, explanation or justification for any variation between the anticipated scope (compare to the projectScope document) and the final scope at completion. If appropriate, additional details may be included in the documents section, with a title indicating that these documents will describe and differences between the planned and completed scope of work. |
|||
language |
[string] |
|||
Language |
The default language of the data using either two-letter ISO639-1, or extended BCP47 language tags. The use of lowercase two-letter codes from ISO639-1 is recommended. |
Sub-schemas¶
This section lists each sub-schema in the OC4IDS schema. Sub-schemas are parts of the schema that are represented as objects in OC4IDS data. Some sub-schemas are referenced from multiple places in the schema.
ContractingProcess¶
ContractingProcess
is defined as:
Within OC4IDS, a contracting process provides both summary information, and a log of changes over time, either manually curated, or automatically generated through linked OCDS releases.
This sub-schema is referenced by the following properties:
Each ContractingProcess
has the following fields:
Title |
Description |
Type |
Format |
Required |
---|---|---|---|---|
id |
string |
Required |
||
Identifier |
An identifier for this contracting process. If this contracting process has been assigned an Open Contracting Identifier (OCID) by an external platform (e.g. national procurement system), that OCID must be recorded here. If information about this contracting process has been entered manually, or from a non-OCDS system, then an identifier may be created by the system data is entered into. |
|||
summary |
object |
|||
Summary |
Summary information about a contracting process, including a log of changes over time. |
|||
releases |
array[Release] |
|||
Linked releases |
The information known about a contracting process changes over time, both as new information becomes available, and as changes are made (such as amendments to scope and value). In the OCDS, each new update of information is known as a 'release'. This section provides space to record a link to each available release. See LinkedRelease |
ContractingProcessSummary¶
ContractingProcessSummary
is defined as:
Summary information about a contracting process and any modifications to it.
Summary information can be manually entered and the
modifications
list can be used to manually record a log of changes, with the date and details of each modification.Where OCDS data is available, most summary fields can be derived from OCDS releases, although the exact method to derive data might vary between implementations; and modifications can be identified by comparing a new release to previous releases to check for relevant changes, with the release identifier recorded in
modifications
.
This sub-schema is referenced by the following properties:
Each ContractingProcessSummary
has the following fields:
Title |
Description |
Type |
Format |
Required |
---|---|---|---|---|
ocid |
string |
|||
Open Contracting Identifier |
If this contracting process has been assigned an Open Contracting Identifier (OCID) by an external platform (e.g. national procurement system), that OCID must be recorded here. Otherwise this field should be omitted. |
|||
externalReference |
string |
|||
External reference |
If this contracting process is identified by some external reference number it may be recorded here. |
|||
nature |
array[[string]] |
|||
Nature |
Whether this contracting process relates to the design, construction and/or supervision of the project, from the contractNature codelist. More than one value may be provided if the contract is for both design and construction, or both design and supervision, etc. |
|||
title |
string |
|||
Title |
The formal name of this contracting process. Once set, this should not normally by changed. |
|||
description |
string |
|||
Description |
The description should summarize the purpose of this contract and the initial scope of the work to be carried out under the contract. |
|||
status |
string |
|||
Status |
The status of this contracting process. Drawn from the contractingProcessStatus codelist. |
|||
tender |
object |
|||
Tender |
The activities undertaken in order to enter into a contract. |
|||
tender/procurementMethod |
string |
|||
Procurement method |
Specify tendering method using the method codelist (open, selective, limited, direct). |
|||
tender/procurementMethodDetails |
string |
|||
Procurement method details |
Additional detail on the procurement method used. This field should be used to record an agreed list of procurement process types, such as: International Competitive Bidding, National Competitive Bidding, Donor Procurement Rules, Framework or Direct Award. |
|||
tender/costEstimate |
object |
|||
Cost estimate |
The pre-tender estimated value of the contracting process. See Value |
|||
tender/costEstimate/amount |
[number] |
|||
Amount |
Amount as a number. |
|||
tender/costEstimate/currency |
[string] |
|||
Currency |
The currency of the amount, from the closed currency codelist. |
|||
tender/numberOfTenderers |
number |
|||
Number of tenderers |
The number of parties who placed a bid during this contracting process. |
|||
tender/tenderers |
array[Organization reference] |
|||
Tenderers |
All parties who submit a bid on a tender. More detailed information on bids and the bidding organization can be provided using the bid extension in a linked OCDS release. |
|||
tender/tenderers/0/name |
[string] |
|||
Organization name |
The name of the party being referenced. This must match the name of an entry in the parties section. |
|||
tender/tenderers/0/id |
string |
|||
Organization ID |
The id of the party being referenced. This must match the id of an entry in the parties section. |
|||
tender/procuringEntity |
object |
|||
Procuring entity |
The name and identifier of the procuring entity responsible for this contracting process. The full details of the entity should be added to the project-level |
|||
tender/procuringEntity/name |
[string] |
|||
Organization name |
The name of the party being referenced. This must match the name of an entry in the parties section. |
|||
tender/procuringEntity/id |
string |
|||
Organization ID |
The id of the party being referenced. This must match the id of an entry in the parties section. |
|||
tender/administrativeEntity |
object |
|||
Administrative entity |
The name and identifier of the entity responsible for contract administration if this is different from the procuring entity. The full details of the entity should be added to the project-level |
|||
tender/administrativeEntity/name |
[string] |
|||
Organization name |
The name of the party being referenced. This must match the name of an entry in the parties section. |
|||
tender/administrativeEntity/id |
string |
|||
Organization ID |
The id of the party being referenced. This must match the id of an entry in the parties section. |
|||
suppliers |
array[Organization reference] |
|||
Suppliers |
The name and identifier for each supplier for this contracting process. The full details of each supplier should be added to the project-level |
|||
contractValue |
object |
|||
Contract value |
The initial value of the contract. Changes to the initial value of the contract should be recorded in See Value |
|||
contractPeriod |
object |
|||
Contract period |
The initial duration of the contract. Changes to the initial duration of the contract should be recorded in See Period |
|||
finalValue |
object |
|||
Final value |
This should be provided when the contracting process is complete. This can be derived from the sum of See Value |
|||
documents |
array[Document] |
|||
Documents |
Additional documentation about this contracting process may be provided here, including reports and evaluations produced through a monitoring process, or links to web pages where further information about this process can be found. Where OCDS releases are published, further documents can be found by looking at the published releases. See Document |
|||
modifications |
array[Modification] |
|||
Modifications |
Details of changes to the duration, price, scope or other significant features of the contracting process should be logged here. See Modification |
|||
transactions |
array[Transaction information] |
|||
Transactions |
The spending transactions made against this contracting process. See Transaction |
LinkedRelease¶
LinkedRelease
is defined as:
A release of data represents the information known or updated at a particular point in time.
This sub-schema is referenced by the following properties:
Each LinkedRelease
has the following fields:
Title |
Description |
Type |
Format |
Required |
---|---|---|---|---|
id |
string |
Required |
||
ID |
A unique identifier for this update of information. This should be taken from the OCDS |
|||
tag |
array[string] |
Required |
||
Release tag |
One or more values from the releaseTag codelist used to indicate the information contained in this release, and the stage of the contracting process it represents. This should be filled from the OCDS |
|||
date |
string |
date-time |
Required |
|
Date |
The effective date of this release/update. This should be filled from the OCDS |
|||
url |
string |
uri |
Required |
|
URL |
A URL (web link) to a release package containing the OCDS release, if available. |
Modification¶
Modification
is defined as:
Contains a structured description of any changes, along with a free text justification.
This sub-schema is referenced by the following properties:
Each Modification
has the following fields:
Title |
Description |
Type |
Format |
Required |
---|---|---|---|---|
id |
string |
Required |
||
Identifier |
A local identifier for this modification. |
|||
date |
[string] |
date-time |
||
Date |
The date this modification was recorded. |
|||
description |
[string] |
|||
Description |
Details of the modification. This may be free text, or may be generated automatically and provide a structured description of the change. |
|||
rationale |
[string] |
|||
Rationale |
A summary of the reasons which have led to this modification to the originally planned scope, period or value. |
|||
type |
[string] |
|||
Type |
A value from the modificationType codelist, indicating whether the modification relates to the duration, value, scope or other aspect of the contract. |
|||
releaseID |
[string] |
|||
Release ID |
The identifier for the OCDS release this modification relates to. The referenced release should appear in the list of linked releases for this contracting process. |
|||
oldContractValue |
object |
|||
Old contract value |
Contract value before the modification, taking into account any prior modifications. See Value |
|||
newContractValue |
object |
|||
New contract value |
Contract value after the modification. See Value |
|||
oldContractPeriod |
object |
|||
Old contract period |
Contract period before the modification, taking into account any prior modifications. See Period |
|||
newContractPeriod |
object |
|||
New contract period |
Contract period after the modification. See Period |
Period¶
Dates MUST be expressed using a full ISO 8601 date-time including a timezone. E.g.:
2018-09-18T11:26:04+01:00
Where the source system does not contain time information, a judgment ought to be made as to the relevant time to attach (e.g. start of the day; end of the working day etc.).
Period
is defined as:
Key events during a project or contracting process may have a known start date, end date, duration, or maximum extent (the latest date the period can extend to). In some cases, not all of these fields will have known or relevant values.
This sub-schema is referenced by the following properties:
Each Period
has the following fields:
Title |
Description |
Type |
Format |
Required |
---|---|---|---|---|
startDate |
[string] |
date-time |
||
Start date |
The start date for the period. When known, a precise start date must be provided. |
|||
endDate |
[string] |
date-time |
||
End date |
The end date for the period. When known, a precise end date must be provided. |
|||
maxExtentDate |
[string] |
date-time |
||
Maximum extent |
The period cannot be extended beyond this date. This field can be used to express the maximum available date for extension or renewal of this period. |
|||
durationInDays |
[integer] |
|||
Duration (days) |
The maximum duration of this period in days. A user interface can collect or display this data in months or years as appropriate, and then convert it into days when storing this field. This field can be used when exact dates are not known. If a startDate and endDate are set, this field, if used, should be equal to the difference between startDate and endDate. Otherwise, if a startDate and maxExtentDate are set, this field, if used, should be equal to the difference between startDate and maxExtentDate. |
Classification¶
Classification
is defined as:
A classification consists of at least two parts: an identifier for the list (scheme) from which the classification is taken, and an identifier for the category from that list being applied. It is useful to also publish a text label and/or URI that users can draw on to interpret the classification.
This sub-schema is referenced by the following properties:
Each Classification
has the following fields:
Title |
Description |
Type |
Format |
Required |
---|---|---|---|---|
scheme |
string |
|||
Scheme |
The scheme or codelist from which the classification code is taken, using the open classificationScheme codelist. |
|||
id |
string |
|||
ID |
The classification code taken from the scheme. |
|||
description |
[string] |
|||
Description |
A textual description or title for the classification code. |
|||
uri |
[string] |
uri |
||
URI |
A URI to uniquely identify the classification code. |
Location¶
Location
is defined as:
The location where activity related to this project will be delivered, or will take place. A location may be described using a geometry (point location, line or polygon), a gazetteer entry, an address, or a combination of these.
This sub-schema is referenced by the following properties:
Each Location
has the following fields:
Title |
Description |
Type |
Format |
Required |
---|---|---|---|---|
id |
string |
Required |
||
Identifier |
A local identifier for this location, unique within the array this location appears in. |
|||
description |
[string] |
|||
Description |
A name or description of this location. This might include the name(s) of the location(s), or might provide a human-readable description of the location to be covered. |
|||
geometry |
object |
|||
Geometry |
We follow the GeoJSON standard to express basic location information, using longitude, latitude, and optional elevation values in the WGS84 (EPSG:4326) projection. A point location can be identified by geocoding a delivery address. For concession licenses, or other contracts covering a polygon location which is not contained in a known gazetteer, polygon and multi-polygon can be used. |
|||
geometry/type |
[string] |
|||
Type |
The type of GeoJSON Geometry Objects being provided. To provide longitude, latitude, and optional elevation, use 'Point', and enter an array of [longitude, latitude] or [longitude, latitude, elevation] as the value of the coordinates field: e.g. [-122.085, 37.42]. |
|||
geometry/coordinates |
array[[number, array]] |
|||
Coordinates |
The relevant array of points, e.g. [longitude, latitude] or [longitude, latitude, elevation], or a nested array of points, for the GeoJSON geometry being described. The longitude and latitude must be expressed in decimal degrees in the WGS84 (EPSG:4326) projection. |
|||
gazetteer |
object |
|||
Gazetteer |
Identifiers from a gazetteer (a geographical index or directory) for the location. |
|||
gazetteer/scheme |
[string] |
|||
Gazetteer scheme |
The identifier of the gazetteer. The |
|||
gazetteer/identifiers |
array[[string]] |
|||
Identifiers |
An array of one or more codes drawn from the gazetteer indicated by the |
|||
uri |
[string] |
|||
URI |
A URI to a further description of the activity location. This might be a human-readable document with information on the location, or a machine-readable description of the location. |
|||
address |
object |
|||
Address |
A physical address where works will take place. See Address |
Value¶
Value
is defined as:
Financial values should be published with a currency attached.
This sub-schema is referenced by the following properties:
Each Value
has the following fields:
Title |
Description |
Type |
Format |
Required |
---|---|---|---|---|
amount |
[number] |
|||
Amount |
Amount as a number. |
|||
currency |
[string] |
|||
Currency |
The currency of the amount, from the closed currency codelist. |
Organization¶
Organization
is defined as:
A party (organization)
This sub-schema is referenced by the following properties:
Each Organization
has the following fields:
Title |
Description |
Type |
Format |
Required |
---|---|---|---|---|
name |
[string] |
|||
Common name |
A common name for this organization or other participant in the contracting process. The identifier object provides a space for the formal legal name, and so this may either repeat that value, or may provide the common name by which this organization or entity is known. This field may also include details of the department or sub-unit involved in this contracting process. |
|||
id |
string |
|||
Entity ID |
The ID used for cross-referencing to this party from other sections of the release. This field may be built with the following structure {identifier.scheme}-{identifier.id}(-{department-identifier}). |
|||
identifier |
object |
|||
Primary identifier |
The primary identifier for this organization or participant. Identifiers that uniquely pick out a legal entity should be preferred. Consult the organization identifier guidance for the preferred scheme and identifier to use. See Identifier |
|||
additionalIdentifiers |
array[Identifier] |
|||
Additional identifiers |
A list of additional / supplemental identifiers for the organization or participant, using the organization identifier guidance. This can be used to provide an internally used identifier for this organization in addition to the primary legal entity identifier. See Identifier |
|||
address |
object |
|||
Address |
An address. This may be the legally registered address of the organization, or may be a correspondence address for this particular contracting process. See Address |
|||
contactPoint |
object |
|||
Contact point |
Contact details that can be used for this party. See ContactPoint |
|||
roles |
array[string] |
|||
Party roles |
The party's role(s) in the project, using the open partyRole codelist. |
|||
people |
array[Person] |
|||
People |
People associated with, representing, or working on behalf of this organization in respect of this project. See Person |
OrganizationReference¶
OrganizationReference
is defined as:
The id and name of the party being referenced. Used to cross-reference to the parties section
This sub-schema is referenced by the following properties:
Each OrganizationReference
has the following fields:
Title |
Description |
Type |
Format |
Required |
---|---|---|---|---|
name |
[string] |
|||
Organization name |
The name of the party being referenced. This must match the name of an entry in the parties section. |
|||
id |
string |
|||
Organization ID |
The id of the party being referenced. This must match the id of an entry in the parties section. |
Address¶
The address sub-schema re-uses fields from schema.org and vCard. In the event source data cannot be broken down into these parts, data should contain at least a streetAddress
and postalCode
.
When working with data, users ought to be aware that addresses might not always be broken down using all the fields the schema provides.
Address
is defined as:
An address.
This sub-schema is referenced by the following properties:
Each Address
has the following fields:
Title |
Description |
Type |
Format |
Required |
---|---|---|---|---|
streetAddress |
[string] |
|||
Street address |
The street address. For example, 1600 Amphitheatre Pkwy. |
|||
locality |
[string] |
|||
Locality |
The locality. For example, Mountain View. |
|||
region |
[string] |
|||
Region |
The region. For example, CA. |
|||
postalCode |
[string] |
|||
Postal code |
The postal code. For example, 94043. |
|||
countryName |
[string] |
|||
Country name |
The country name. For example, United States. |
ContactPoint¶
ContactPoint
is defined as:
A person, contact point or department to contact in relation to this contracting process.
This sub-schema is referenced by the following properties:
Each ContactPoint
has the following fields:
Title |
Description |
Type |
Format |
Required |
---|---|---|---|---|
name |
[string] |
|||
Name |
The name of the contact person, department, or contact point, for correspondence relating to this project. |
|||
email |
[string] |
|||
The e-mail address of the contact point/person. |
||||
telephone |
[string] |
|||
Telephone |
The telephone number of the contact point/person. This should include the international dialing code. |
|||
faxNumber |
[string] |
|||
Fax number |
The fax number of the contact point/person. This should include the international dialing code. |
|||
url |
[string] |
uri |
||
URL |
A web address for the contact point/person. |
BudgetBreakdown¶
For more information about this sub-schema, see the OCDS Budget Breakdown extension documentation. BudgetBreakdown
can also be extended further to include budget classifications data following the pattern described in the OCDS Budgets and Spend extension.
BudgetBreakdown
is defined as:
This section allows a detailed budget breakdown to be expressed, covering multiple budget sources and multiple periods
This sub-schema is referenced by the following properties:
Each BudgetBreakdown
has the following fields:
Title |
Description |
Type |
Format |
Required |
---|---|---|---|---|
id |
string |
Required |
||
Identifier |
An identifier for this particular budget entry. |
|||
description |
[string] |
|||
Description |
A short free text description of this budget entry. |
|||
amount |
object |
|||
Amount |
The value of the budget line item. See Value |
|||
approvalDate |
string |
date-time |
||
Approval date |
The date on which this budget entry was approved. Where documentary evidence for this exists, it may be included among the project documents with |
|||
uri |
[string] |
uri |
||
Linked budget information |
A URI pointing directly to a machine-readable information about this budget entry. |
|||
period |
object |
|||
Budget period |
The period covered by this budget entry. See Period |
|||
sourceParty |
object |
|||
Source party |
An organization reference, linking to the entry in the |
Document¶
Document
is defined as:
Links to, or descriptions of, external documents can be attached at various locations within the standard. Documents can be supporting information, formal notices, downloadable forms, or any other kind of resource that ought to be made public as part of full open contracting.
This sub-schema is referenced by the following properties:
Each Document
has the following fields:
Title |
Description |
Type |
Format |
Required |
---|---|---|---|---|
id |
string |
Required |
||
ID |
A local, unique identifier for this document. This field is used to keep track of multiple revisions of a document through the compilation from release to record mechanism. |
|||
documentType |
[string] |
|||
Document type |
A classification of the document described, using the open documentType codelist. |
|||
title |
[string] |
|||
Title |
The document title. |
|||
description |
[string] |
|||
Description |
Where a link to a full document is provided, the description should provide a 1 - 3 paragraph summary of the information the document contains, and the Line breaks in text (represented in JSON using |
|||
url |
[string] |
uri |
||
URL |
This should be a direct link to the document or web page where the information described by the current documentType exists. |
|||
datePublished |
[string] |
date-time |
||
Date published |
The date on which the document was first published. This is particularly important for legally important documents such as notices of a tender. |
|||
dateModified |
[string] |
date-time |
||
Date modified |
Date that the document was last modified |
|||
format |
[string] |
|||
Format |
The format of the document, using the open IANA Media Types codelist (see the values in the 'Template' column), or using the 'offline/print' code if the described document is published offline. For example, web pages have a format of 'text/html'. |
|||
language |
[string] |
|||
Language |
The language of the linked document using either two-letter ISO639-1, or extended BCP47 language tags. The use of lowercase two-letter codes from ISO639-1 is recommended unless there is a clear user need for distinguishing the language subtype. |
|||
pageStart |
[string] |
|||
Page start |
When the information referenced exists within a large document, indicate the first page on which it can be found. This should refer to the printed page number, not the page number reported by software applications. |
|||
pageEnd |
[string] |
|||
Page end |
When the information referenced exists within a large document, indicate the last page on which it can be found. This should refer to the printed page number, not the page number reported by software applications. |
|||
accessDetails |
[string] |
|||
Access details |
A description of any special arrangements needed to access this document, for example: registering for access, paying a fee, or visiting a location to inspect the document. |
|||
author |
[string] |
|||
Author |
The names of the authors of the document. |
Identifier¶
Use of stable official organization identifiers can help join up data between systems.
Organization identifiers should be constructed by collecting an official company (or government body) registration number for the organization, and then finding the org-id.guide list code for the list this identifier is taken from to use in the scheme
field.
For example, if identifying a company in Colombia, look up its identifier in the Unified Commercial and Social Registry and use the list code CO-RUE
.
Identifier
is defined as:
A unique identifier for a party (organization).
This sub-schema is referenced by the following properties:
Each Identifier
has the following fields:
Title |
Description |
Type |
Format |
Required |
---|---|---|---|---|
scheme |
[string] |
|||
Scheme |
Organization identifiers should be taken from an existing organization identifier list. The scheme field is used to indicate the list or register from which the identifier is taken. This value should be taken from the Organization Identifier Scheme codelist. |
|||
id |
string |
|||
ID |
The identifier of the organization in the selected scheme. |
|||
legalName |
[string] |
|||
Legal Name |
The legally registered name of the organization. |
|||
uri |
[string] |
uri |
||
URI |
A URI to identify the organization, such as those provided by Open Corporates or some other relevant URI provider. This is not for listing the website of the organization: that can be done through the URL field of the Organization contact point. |
Metric¶
Metric
is defined as:
Metrics are used to set out forecast and actual metrics targets for a project: for example, planned and actual physical and financial progress over time.
This sub-schema is referenced by the following properties:
Each Metric
has the following fields:
Title |
Description |
Type |
Format |
Required |
---|---|---|---|---|
id |
string |
Required |
||
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 project, or in other instances may be an arbitrary identifier. |
|||
title |
[string] |
|||
Title |
The title of this metric |
|||
description |
[string] |
|||
Description |
A short description of the metric. This may include short details of measurement methods. |
|||
observations |
array[Observation] |
|||
Observations |
An array of target or actual values for this metric. See Observation |
Observation¶
Observation
is defined as:
An actual or target observation. Observations should include either a value (for financial metrics) or measure (for other metrics).
This sub-schema is referenced by the following properties:
Each Observation
has the following fields:
Title |
Description |
Type |
Format |
Required |
---|---|---|---|---|
id |
string |
Required |
||
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. |
|||
period |
object |
|||
Period |
The period over which this observation is measured. See Period |
|||
value |
object |
|||
Value |
For financial metrics, the value of this forecast, target or actual observation. See Value |
|||
measure |
[string, number] |
|||
Measure |
For non-financial metrics, the measure of this forecast, target or actual observation. Measures may be provided as free text or numerical values. |
|||
unit |
object |
|||
Unit |
Unit |
|||
unit/name |
[string] |
|||
Unit name |
The name of the unit. |
|||
unit/scheme |
[string] |
|||
Scheme |
The list from which units of measure identifiers are taken. Use of the scheme 'UNCEFACT' for the UN/CEFACT Recommendation 20 list of "Codes for Units of Measure Used in International Trade" is recommended. |
|||
unit/id |
string |
|||
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. |
|||
unit/uri |
[string] |
uri |
||
URI |
If the scheme used provide a machine-readable URI for this unit of measure, this can be given. |
|||
dimensions |
object |
|||
Dimensions |
Any number of dimensions can be recorded within this object. Dimensions names should follow the camelCase conventions of OCDS. |
|||
notes |
[string] |
|||
Notes |
Any notes on this observation. This may include clarifying information. |
Person¶
Use this object when you need to disclose the details of people associated with, representing or working on behalf of an organization involved in the project.
Person
is defined as:
A natural person.
This sub-schema is referenced by the following properties:
Each Person
has the following fields:
Title |
Description |
Type |
Format |
Required |
---|---|---|---|---|
id |
string |
Required |
||
Identifier |
A local identifier for this person. |
|||
name |
string |
|||
Name |
The full name of the person. |
|||
jobTitle |
string |
|||
Job title |
The job title of the person (for example, Financial Manager). |
Transaction¶
A spending transaction related to a contracting process.
Transaction
is defined as:
A spending transaction related to the contracting process. Draws upon the data models of the Fiscal Data Package and the International Aid Transparency Initiative and should be used to cross-reference to more detailed information held using a Fiscal Data Package, IATI file, or to provide enough information to allow a user to manually or automatically cross-reference with some other published source of transactional spending data.
This sub-schema is referenced by the following properties:
Each Transaction
has the following fields:
Title |
Description |
Type |
Format |
Required |
---|---|---|---|---|
id |
string |
Required |
||
ID |
A unique identifier for this transaction. This identifier should be possible to cross-reference against the provided data source. For IATI this is the transaction reference. |
|||
source |
[string] |
uri |
||
Data source |
Used to point either to a corresponding Fiscal Data Package, IATI file, or machine or human-readable source where users can find further information on the budget line item identifiers, or project identifiers, provided here. |
|||
date |
[string] |
date-time |
||
Date |
The date of the transaction |
|||
value |
object |
|||
Value |
The value of the transaction. See Value |
|||
payer |
object |
|||
Payer |
An organization reference for the organization from which the funds in this transaction originate. |
|||
payee |
object |
|||
Payee |
An organization reference for the organization which receives the funds in this transaction. |
|||
uri |
[string] |
uri |
||
Linked spending information |
A URI pointing directly to a machine-readable record about this spending transaction. |