Skip to content

Commit 21a3ae7

Browse files
committed
docs/schema/: create individual pages for all codelists
1 parent 0871878 commit 21a3ae7

29 files changed

+405
-325
lines changed

docs/schema/codelists.md

Lines changed: 28 additions & 325 deletions
Original file line numberDiff line numberDiff line change
@@ -16,355 +16,58 @@ The release schema, in [JSON Schema](../../build/current_lang/release-schema.jso
1616

1717
Codes are case-sensitive, and are generally provided as English language camelCase. Codes must not be translated, though the OCDS team will work with publishers to translate code titles and definitions.
1818

19-
## Open Codelists
19+
## All Codelists
2020

21-
### Release Tag
21+
### [Award Criteria](codelists/awardCriteria.md)
2222

23-
A contracting (or planning) process can result in a number of releases of information over time. A release must be tagged to indicate whether it is about a planning process or a contracting process and, if it is about the latter, to indicate the stage of the contracting process to which it relates.
23+
### [Award Final Status](codelists/awardFinalStatus.md)
2424

25-
Additional codes may be used to label releases, based on user needs: for example, to indicate the notice or form to which a release corresponds.
25+
### [Award Status](codelists/awardStatus.md)
2626

27-
```{versionchanged} 1.1
28-
Added the 'planningUpdate' code.
29-
```
30-
31-
```{csv-table-no-translate}
32-
:header-rows: 1
33-
:file: ../../build/current_lang/codelists/releaseTag.csv
34-
```
27+
### [Classification Scheme](codelists/classificationScheme.md)
3528

36-
### Organization Role
37-
38-
```{versionadded} 1.1
39-
```
29+
### [Contract Final Status](codelists/contractFinalStatus.md)
4030

41-
The organizations participating in a contracting (or planning) process are listed in the [parties section](reference.md#parties). In a given process, a single organization can have one or more roles.
31+
### [Contract Status](codelists/contractStatus.md)
4232

43-
```{csv-table-no-translate}
44-
:header-rows: 1
45-
:file: ../../build/current_lang/codelists/partyRole.csv
46-
```
33+
### [Country](codelists/country.md)
4734

48-
### Classification Scheme
35+
### [Currency](codelists/currency.md)
4936

50-
The `classificationScheme` codelist is referenced by the `scheme` field of the `Classification` object, which can be used in multiple contexts. You can find the codes relevant to a given context by filtering the codelist by its `Category` column.
37+
### [Document Type](codelists/documentType.md)
5138

52-
```{csv-table-no-translate}
53-
:header-rows: 1
54-
:file: ../../build/current_lang/codelists/classificationScheme.csv
55-
```
39+
### [Extended Procurement Category](codelists/extendedProcurementCategory.md)
5640

57-
### Unit Classification Scheme
41+
### [Initiation Type](codelists/initiationType.md)
5842

59-
```{versionadded} 1.1
60-
```
43+
### [Language](codelists/language.md)
6144

62-
Item quantities can be provided using an established codelist for units of measurement. Codelists might provide human-readable descriptions of units, or symbols for use in input and display interfaces.
45+
### [Link Relation Type](codelists/linkRelationType.md)
6346

64-
```{csv-table-no-translate}
65-
:header-rows: 1
66-
:file: ../../build/current_lang/codelists/unitClassificationScheme.csv
67-
```
47+
### [Media Type](codelists/mediaType.md)
6848

69-
### Organization Identifier Scheme
49+
### [Method](codelists/method.md)
7050

71-
![org-id.guide](../_static/png/org-id_logo.png)
51+
### [Milestone Status](codelists/milestoneStatus.md)
7252

73-
The Organization Identifier Scheme uses the codes from [org-id.guide](http://org-id.guide). The latest version of the codelist can be [downloaded](http://org-id.guide/download.csv) or [browsed](http://org-id.guide) from its website.
53+
### [Milestone Type](codelists/milestoneType.md)
7454

75-
To add new codes to the codelist, contact the [Data Support Team](../../support/index).
55+
### [Organization Identifier Scheme](codelists/organizationIdentifierScheme.md)
7656

77-
```{versionchanged} 1.1
78-
The `organizationIdentifierRegistrationAgency_iati.csv` file was removed. This list was formerly maintained by the International Aid Transparency Initiative.
79-
```
57+
### [Organization Role](codelists/partyRole.md)
8058

81-
### Document Type
59+
### [Party Scale](codelists/partyScale.md)
8260

83-
The following list describes documents and documentation recommended for publication as part of an open contracting implementation. The codelist indicates the section of an OCDS release they are most likely to be applicable within.
61+
### [Procurement Category](codelists/procurementCategory.md)
8462

85-
The code descriptions are necessarily broad, to cover their usage in a range of contracting (or planning) processes, including for goods, services and works, and in other contexts, such as public private partnerships, infrastructure or concession contracts.
86-
87-
Publishers must map their existing document codes to this list, where possible. If using this list within a user interface, publishers can re-write the codelist titles and descriptions appropriately for the context they are being used in.
88-
89-
```{csv-table-no-translate}
90-
:header-rows: 1
91-
:file: ../../build/current_lang/codelists/documentType.csv
92-
```
93-
94-
### Award Criteria
95-
96-
The award criteria codelist describes the basis on which contract awards will be made.
97-
98-
```{versionchanged} 1.1
99-
Added all new codes. Deprecated all old codes, which were undefined.
100-
```
101-
102-
```{csv-table-no-translate}
103-
:header-rows: 1
104-
:file: ../../build/current_lang/codelists/awardCriteria.csv
105-
```
63+
### [Release Tag](codelists/releaseTag.md)
10664

107-
### Submission Method
65+
### [Related Process](codelists/relatedProcess.md)
10866

109-
```{deprecated} 1.2
110-
```
111-
112-
The submission method codelist is used to identify the mechanism through which a submission can be made.
113-
114-
```{csv-table-no-translate}
115-
:header-rows: 1
116-
:file: ../../build/current_lang/codelists/submissionMethod.csv
117-
```
118-
119-
### Related Process
120-
121-
```{versionadded} 1.1
122-
```
123-
124-
```{versionchanged} 1.2
125-
Added 'parent'. Deprecated 'subContract', 'replacementProcess' and 'renewalProcess'.
126-
```
127-
128-
```{field-description} ../../build/current_lang/release-schema.json /definitions/RelatedProcess
129-
```
130-
131-
```{seealso}
132-
* [Map: Contracting processes and planning processes](../guidance/map/contracting_planning_processes.md)
133-
* [Map: Framework agreements](../guidance/map/framework_agreements.md)
134-
```
135-
136-
```{csv-table-no-translate}
137-
:header-rows: 1
138-
:file: ../../build/current_lang/codelists/relatedProcess.csv
139-
```
140-
141-
### Related Process Scheme
142-
143-
```{versionadded} 1.1
144-
```
67+
### [Related Process](codelists/relatedProcessScheme.md)
14568

146-
The related process scheme describes the kind of identifier used to cross-reference another process.
147-
148-
```{csv-table-no-translate}
149-
:header-rows: 1
150-
:file: ../../build/current_lang/codelists/relatedProcessScheme.csv
151-
```
152-
153-
### Milestone Type
154-
155-
```{versionadded} 1.1
156-
```
157-
158-
The milestone block can be used to represent a wide variety of events in the lifetime of a contracting (or planning) process. The milestone type codelist is used to indicate the nature of each milestone.
159-
160-
```{csv-table-no-translate}
161-
:header-rows: 1
162-
:file: ../../build/current_lang/codelists/milestoneType.csv
163-
```
164-
165-
### Extended Procurement Category
166-
167-
```{versionadded} 1.1
168-
```
169-
170-
The extended procurement category codelist is used to provide additional detail about the focus of a contracting (or planning) process.
171-
172-
```{csv-table-no-translate}
173-
:header-rows: 1
174-
:file: ../../build/current_lang/codelists/extendedProcurementCategory.csv
175-
```
176-
177-
### Language
178-
179-
```{versionadded} 1.2
180-
```
181-
182-
The language codelist is used to provide the default language used in text fields and the language of linked documents, using two-letter codes from [ISO639-1](https://id.loc.gov/vocabulary/iso639-1.html).
183-
184-
```{csv-table-no-translate}
185-
:header-rows: 1
186-
:file: ../../build/current_lang/codelists/language.csv
187-
```
188-
189-
### Media Type
190-
191-
```{versionadded} 1.2
192-
```
193-
194-
The media type codelist is based on the [IANA Media Types](https://www.iana.org/assignments/media-types/media-types.xhtml) list. The media type codelist adds an exceptional code for printed documents ('offline/print'), and omits any media type that is marked as deprecated or obsolete by IANA.
195-
196-
```{csv-table-no-translate}
197-
:header-rows: 1
198-
:file: ../../build/current_lang/codelists/mediaType.csv
199-
```
200-
201-
### Link Relation Type
202-
203-
```{versionadded} 1.2
204-
```
205-
206-
The link relation type codelist is based on a subset of the [IANA Link Relation Types](https://www.iana.org/assignments/link-relations/link-relations.xhtml) list.
207-
208-
```{csv-table-no-translate}
209-
:header-rows: 1
210-
:file: ../../build/current_lang/codelists/linkRelationType.csv
211-
```
212-
213-
## Closed Codelists
214-
215-
### Country
216-
217-
```{versionadded} 1.2
218-
```
69+
### [Submission Method](codelists/submissionMethod.md)
21970

220-
The country codelist is used to provide the country component of an address, using uppercase two-letter codes from [ISO3166-1](https://www.iso.org/iso-3166-country-codes.html). The country codelist adds a user-assigned code for Kosovo ('XK').
71+
### [Tender Final Status](codelists/tenderFinalStatus.md)
22172

222-
```{csv-table-no-translate}
223-
:header-rows: 1
224-
:file: ../../build/current_lang/codelists/country.csv
225-
```
226-
227-
### Initiation Type
228-
229-
```{deprecated} 1.2
230-
```
231-
232-
```{csv-table-no-translate}
233-
:header-rows: 1
234-
:file: ../../build/current_lang/codelists/initiationType.csv
235-
```
236-
237-
### Tender Status
238-
239-
```{deprecated} 1.2
240-
```
241-
242-
```{versionchanged} 1.1
243-
Added the 'planning' and 'withdrawn' codes.
244-
```
245-
246-
```{csv-table-no-translate}
247-
:header-rows: 1
248-
:file: ../../build/current_lang/codelists/tenderStatus.csv
249-
```
250-
251-
### Method
252-
253-
The procurement method describes which organizations can submit a bid. The method codelist draws upon [the definitions of open, selective and limited provided by the WTO Government Procurement Agreement](https://www.wto.org/english/docs_e/legal_e/rev-gpr-94_01_e.htm), and adds an additional 'direct' code for awards without competition.
254-
255-
```{versionchanged} 1.1
256-
Added the 'direct' code.
257-
```
258-
259-
```{csv-table-no-translate}
260-
:header-rows: 1
261-
:file: ../../build/current_lang/codelists/method.csv
262-
```
263-
264-
### Procurement Category
265-
266-
```{versionadded} 1.1
267-
```
268-
269-
The procurement category codelist is used to indicate the **primary** focus of a contracting (or planning) process. Where a contracting (or planning) process covers more than one of the options below, publishers should use the `additionalProcurementCategories` field with an array of entries from the open [extendedProcurementCategory](#extended-procurement-category) codelist.
270-
271-
```{csv-table-no-translate}
272-
:header-rows: 1
273-
:file: ../../build/current_lang/codelists/procurementCategory.csv
274-
```
275-
276-
### Award Status
277-
278-
```{deprecated} 1.2
279-
```
280-
281-
```{csv-table-no-translate}
282-
:header-rows: 1
283-
:file: ../../build/current_lang/codelists/awardStatus.csv
284-
```
285-
286-
### Contract Status
287-
288-
```{deprecated} 1.2
289-
```
290-
291-
```{csv-table-no-translate}
292-
:header-rows: 1
293-
:file: ../../build/current_lang/codelists/contractStatus.csv
294-
```
295-
296-
### Milestone Status
297-
298-
```{versionchanged} 1.1
299-
Added the 'scheduled' code.
300-
```
301-
302-
```{csv-table-no-translate}
303-
:header-rows: 1
304-
:file: ../../build/current_lang/codelists/milestoneStatus.csv
305-
```
306-
307-
### Currency
308-
309-
```{versionadded} 1.1
310-
```
311-
312-
The currency for each amount must be specified using the uppercase 3-letter currency code from [ISO4217](https://www.iso.org/iso-4217-currency-codes.html).
313-
314-
```{csv-table-no-translate}
315-
:header-rows: 1
316-
:file: ../../build/current_lang/codelists/currency.csv
317-
```
318-
319-
### Party Scale
320-
321-
```{versionadded} 1.2
322-
```
323-
324-
The party scale codelist is used to indicate the size or scale of an organization, in particular commercial enterprises or economic operators.
325-
326-
The codes in the codelist do not have precise definitions. Instead, they defer to local laws and regulations, for example:
327-
328-
* [OECD: Small and Medium-Sized Enterprises (SMEs) definition](https://stats.oecd.org/glossary/detail.asp?ID=3123)
329-
* [European Commission: What is an SME?](https://ec.europa.eu/growth/smes/sme-definition_en)
330-
331-
For small and medium-sized enterprises, if you can distinguish between the two sizes, use the 'small' and 'medium' codes. Otherwise, use the 'sme' code.
332-
333-
For self-employed individuals and sole traders, if you can distinguish them from micro enterprises, use the 'selfEmployed' code. Otherwise, use the 'micro' code.
334-
335-
For enterprises without employees, use the 'micro' code.
336-
337-
```{csv-table-no-translate}
338-
:header-rows: 1
339-
:file: ../../build/current_lang/codelists/partyScale.csv
340-
```
341-
342-
### Tender Final Status
343-
344-
```{versionadded} 1.2
345-
```
346-
347-
```{csv-table-no-translate}
348-
:header-rows: 1
349-
:file: ../../build/current_lang/codelists/tenderFinalStatus.csv
350-
```
351-
352-
### Award Final Status
353-
354-
```{versionadded} 1.2
355-
```
356-
357-
```{csv-table-no-translate}
358-
:header-rows: 1
359-
:file: ../../build/current_lang/codelists/awardFinalStatus.csv
360-
```
361-
362-
### Contract Final Status
363-
364-
```{versionadded} 1.2
365-
```
366-
367-
```{csv-table-no-translate}
368-
:header-rows: 1
369-
:file: ../../build/current_lang/codelists/contractFinalStatus.csv
370-
```
73+
### [Tender Status](codelists/tenderStatus.md)
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Award Criteria
2+
3+
{bdg-link-secondary}`Open<../../codelists/#codelists>`
4+
5+
The award criteria codelist describes the basis on which contract awards will be made.
6+
7+
```{versionchanged} 1.1
8+
Added all new codes. Deprecated all old codes, which were undefined.
9+
```
10+
11+
```{csv-table-no-translate}
12+
:header-rows: 1
13+
:file: ../../../build/current_lang/codelists/awardCriteria.csv
14+
```

0 commit comments

Comments
 (0)