diff --git a/docs/schema/codelists.md b/docs/schema/codelists.md index bd3dc7bc6..5aacb6a7c 100644 --- a/docs/schema/codelists.md +++ b/docs/schema/codelists.md @@ -2,7 +2,10 @@ Some schema fields refer to codelists, to limit and standardize the possible values of the fields, in order to promote data interoperability. -Codelists can either be open or closed. **Closed codelists** are intended to be comprehensive; for example, the [currency](#currency) codelist covers all currencies in the world. **Open codelists** are intended to be representative, but not comprehensive. +Codelists can either be open or closed; + +* **Closed codelists** are intended to be comprehensive; for example, the [currency](codelists/currency.md) codelist covers all currencies in the world. +* **Open codelists** are intended to be representative, but not comprehensive. Publishers must use the codes in the codelists, unless no code is appropriate. If no code is appropriate and the codelist is **open**, then a publisher may use a new code outside those in the codelist. If no code is appropriate and the codelist is **closed**, then a publisher is encouraged to create an issue in the [OCDS GitHub repository](https://github.com/open-contracting/standard/issues) about adding a new code. @@ -16,355 +19,101 @@ The release schema, in [JSON Schema](../../build/current_lang/release-schema.jso 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. -## Open Codelists - -### Release Tag - -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. - -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. - -```{versionchanged} 1.1 -Added the 'planningUpdate' code. -``` - -```{csv-table-no-translate} -:header-rows: 1 -:file: ../../build/current_lang/codelists/releaseTag.csv -``` - -### Organization Role - -```{versionadded} 1.1 -``` - -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. - -```{csv-table-no-translate} -:header-rows: 1 -:file: ../../build/current_lang/codelists/partyRole.csv -``` - -### Classification Scheme - -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. - -```{csv-table-no-translate} -:header-rows: 1 -:file: ../../build/current_lang/codelists/classificationScheme.csv -``` - -### Unit Classification Scheme - -```{versionadded} 1.1 -``` - -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. - -```{csv-table-no-translate} -:header-rows: 1 -:file: ../../build/current_lang/codelists/unitClassificationScheme.csv -``` - -### Organization Identifier Scheme - -![org-id.guide](../_static/png/org-id_logo.png) - -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. - -To add new codes to the codelist, contact the [Data Support Team](../../support/index). - -```{versionchanged} 1.1 -The `organizationIdentifierRegistrationAgency_iati.csv` file was removed. This list was formerly maintained by the International Aid Transparency Initiative. -``` - -### Document Type - -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. - -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. - -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. - -```{csv-table-no-translate} -:header-rows: 1 -:file: ../../build/current_lang/codelists/documentType.csv -``` - -### Award Criteria - -The award criteria codelist describes the basis on which contract awards will be made. - -```{versionchanged} 1.1 -Added all new codes. Deprecated all old codes, which were undefined. -``` - -```{csv-table-no-translate} -:header-rows: 1 -:file: ../../build/current_lang/codelists/awardCriteria.csv -``` - -### Submission Method - -```{deprecated} 1.2 -``` - -The submission method codelist is used to identify the mechanism through which a submission can be made. - -```{csv-table-no-translate} -:header-rows: 1 -:file: ../../build/current_lang/codelists/submissionMethod.csv -``` - -### Related Process - -```{versionadded} 1.1 -``` - -```{versionchanged} 1.2 -Added 'parent'. Deprecated 'subContract', 'replacementProcess' and 'renewalProcess'. -``` - -```{field-description} ../../build/current_lang/release-schema.json /definitions/RelatedProcess -``` - -```{seealso} -* [Map: Contracting processes and planning processes](../guidance/map/contracting_planning_processes.md) -* [Map: Framework agreements](../guidance/map/framework_agreements.md) -``` - -```{csv-table-no-translate} -:header-rows: 1 -:file: ../../build/current_lang/codelists/relatedProcess.csv -``` - -### Related Process Scheme - -```{versionadded} 1.1 -``` - -The related process scheme describes the kind of identifier used to cross-reference another process. - -```{csv-table-no-translate} -:header-rows: 1 -:file: ../../build/current_lang/codelists/relatedProcessScheme.csv -``` - -### Milestone Type - -```{versionadded} 1.1 -``` - -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. +```{toctree} +:hidden: -```{csv-table-no-translate} -:header-rows: 1 -:file: ../../build/current_lang/codelists/milestoneType.csv +codelists/awardCriteria +codelists/awardFinalStatus +codelists/awardStatus +codelists/classificationScheme +codelists/contractFinalStatus +codelists/contractStatus +codelists/country +codelists/currency +codelists/documentType +codelists/extendedProcurementCategory +codelists/initiationType +codelists/language +codelists/linkRelationType +codelists/mediaType +codelists/method +codelists/milestoneStatus +codelists/milestoneType +codelists/organizationIdentifierScheme +codelists/partyRole +codelists/partyScale +codelists/procurementCategory +codelists/relatedProcess +codelists/relatedProcessScheme +codelists/releaseTag +codelists/submissionMethod +codelists/tenderFinalStatus +codelists/tenderStatus +codelists/unitClassificationScheme ``` -### Extended Procurement Category +## Uncategorized -```{versionadded} 1.1 -``` +[Release Tag](codelists/releaseTag.md) -The extended procurement category codelist is used to provide additional detail about the focus of a contracting (or planning) process. +[Classification Scheme](codelists/classificationScheme.md) -```{csv-table-no-translate} -:header-rows: 1 -:file: ../../build/current_lang/codelists/extendedProcurementCategory.csv -``` +[Document Type](codelists/documentType.md) -### Language +[Milestone Type](codelists/milestoneType.md) -```{versionadded} 1.2 -``` +[Initiation Type](codelists/initiationType.md) {bdg-danger}`deprecated` -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). +## Status -```{csv-table-no-translate} -:header-rows: 1 -:file: ../../build/current_lang/codelists/language.csv -``` +[Tender Final Status](codelists/tenderFinalStatus.md) -### Media Type +[Award Final Status](codelists/awardFinalStatus.md) -```{versionadded} 1.2 -``` +[Contract Final Status](codelists/contractFinalStatus.md) -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. +[Milestone Status](codelists/milestoneStatus.md) -```{csv-table-no-translate} -:header-rows: 1 -:file: ../../build/current_lang/codelists/mediaType.csv -``` - -### Link Relation Type +[Tender Status](codelists/tenderStatus.md) {bdg-danger}`deprecated` -```{versionadded} 1.2 -``` +[Award Status](codelists/awardStatus.md) {bdg-danger}`deprecated` -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. +[Contract Status](codelists/contractStatus.md) {bdg-danger}`deprecated` -```{csv-table-no-translate} -:header-rows: 1 -:file: ../../build/current_lang/codelists/linkRelationType.csv -``` +## Organization -## Closed Codelists +[Organization Role](codelists/partyRole.md) -### Country +[Organization Identifier Scheme](codelists/organizationIdentifierScheme.md) -```{versionadded} 1.2 -``` +[Party Scale](codelists/partyScale.md) -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'). +## Tender -```{csv-table-no-translate} -:header-rows: 1 -:file: ../../build/current_lang/codelists/country.csv -``` +[Method](codelists/method.md) -### Initiation Type +[Procurement Category](codelists/procurementCategory.md) -```{deprecated} 1.2 -``` +[Extended Procurement Category](codelists/extendedProcurementCategory.md) -```{csv-table-no-translate} -:header-rows: 1 -:file: ../../build/current_lang/codelists/initiationType.csv -``` +[Award Criteria](codelists/awardCriteria.md) -### Tender Status +[Submission Method](codelists/submissionMethod.md) {bdg-danger}`deprecated` -```{deprecated} 1.2 -``` +## Related process -```{versionchanged} 1.1 -Added the 'planning' and 'withdrawn' codes. -``` +[Related Process](codelists/relatedProcess.md) -```{csv-table-no-translate} -:header-rows: 1 -:file: ../../build/current_lang/codelists/tenderStatus.csv -``` +[Related Process](codelists/relatedProcessScheme.md) -### Method +## External -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. +[Country](codelists/country.md) ([ISO 3166-1 alpha-2](https://www.iso.org/iso-3166-country-codes.html)) -```{versionchanged} 1.1 -Added the 'direct' code. -``` +[Currency](codelists/currency.md) ([ISO4217](https://www.iso.org/iso-4217-currency-codes.html)) -```{csv-table-no-translate} -:header-rows: 1 -:file: ../../build/current_lang/codelists/method.csv -``` +[Language](codelists/language.md) ([ISO639-1](https://id.loc.gov/vocabulary/iso639-1.html)) -### Procurement Category +[Link Relation Type](codelists/linkRelationType.md) ([IANA Link Relation Types](https://www.iana.org/assignments/link-relations/link-relations.xhtml)) -```{versionadded} 1.1 -``` - -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. - -```{csv-table-no-translate} -:header-rows: 1 -:file: ../../build/current_lang/codelists/procurementCategory.csv -``` - -### Award Status - -```{deprecated} 1.2 -``` - -```{csv-table-no-translate} -:header-rows: 1 -:file: ../../build/current_lang/codelists/awardStatus.csv -``` - -### Contract Status - -```{deprecated} 1.2 -``` - -```{csv-table-no-translate} -:header-rows: 1 -:file: ../../build/current_lang/codelists/contractStatus.csv -``` - -### Milestone Status - -```{versionchanged} 1.1 -Added the 'scheduled' code. -``` - -```{csv-table-no-translate} -:header-rows: 1 -:file: ../../build/current_lang/codelists/milestoneStatus.csv -``` - -### Currency - -```{versionadded} 1.1 -``` - -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). - -```{csv-table-no-translate} -:header-rows: 1 -:file: ../../build/current_lang/codelists/currency.csv -``` - -### Party Scale - -```{versionadded} 1.2 -``` - -The party scale codelist is used to indicate the size or scale of an organization, in particular commercial enterprises or economic operators. - -The codes in the codelist do not have precise definitions. Instead, they defer to local laws and regulations, for example: - -* [OECD: Small and Medium-Sized Enterprises (SMEs) definition](https://stats.oecd.org/glossary/detail.asp?ID=3123) -* [European Commission: What is an SME?](https://ec.europa.eu/growth/smes/sme-definition_en) - -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. - -For self-employed individuals and sole traders, if you can distinguish them from micro enterprises, use the 'selfEmployed' code. Otherwise, use the 'micro' code. - -For enterprises without employees, use the 'micro' code. - -```{csv-table-no-translate} -:header-rows: 1 -:file: ../../build/current_lang/codelists/partyScale.csv -``` - -### Tender Final Status - -```{versionadded} 1.2 -``` - -```{csv-table-no-translate} -:header-rows: 1 -:file: ../../build/current_lang/codelists/tenderFinalStatus.csv -``` - -### Award Final Status - -```{versionadded} 1.2 -``` - -```{csv-table-no-translate} -:header-rows: 1 -:file: ../../build/current_lang/codelists/awardFinalStatus.csv -``` - -### Contract Final Status - -```{versionadded} 1.2 -``` - -```{csv-table-no-translate} -:header-rows: 1 -:file: ../../build/current_lang/codelists/contractFinalStatus.csv -``` +[Media Type](codelists/mediaType.md) ([IANA Media Types](https://www.iana.org/assignments/media-types/media-types.xhtml)) diff --git a/docs/schema/codelists/awardCriteria.md b/docs/schema/codelists/awardCriteria.md new file mode 100644 index 000000000..35ea9568e --- /dev/null +++ b/docs/schema/codelists/awardCriteria.md @@ -0,0 +1,14 @@ +# Award Criteria + +{bdg-link-secondary}`open<../../codelists/#codelists>` + +The award criteria codelist describes the basis on which contract awards will be made. + +```{versionchanged} 1.1 +Added all new codes. Deprecated all old codes, which were undefined. +``` + +```{csv-table-no-translate} +:header-rows: 1 +:file: ../../../build/current_lang/codelists/awardCriteria.csv +``` diff --git a/docs/schema/codelists/awardFinalStatus.md b/docs/schema/codelists/awardFinalStatus.md new file mode 100644 index 000000000..3b570f024 --- /dev/null +++ b/docs/schema/codelists/awardFinalStatus.md @@ -0,0 +1,11 @@ +# Award Final Status + +{bdg-link-primary}`closed<../../codelists/#codelists>` + +```{versionadded} 1.2 +``` + +```{csv-table-no-translate} +:header-rows: 1 +:file: ../../../build/current_lang/codelists/awardFinalStatus.csv +``` diff --git a/docs/schema/codelists/awardStatus.md b/docs/schema/codelists/awardStatus.md new file mode 100644 index 000000000..ca42f75f5 --- /dev/null +++ b/docs/schema/codelists/awardStatus.md @@ -0,0 +1,11 @@ +# Award Status + +{bdg-link-primary}`closed<../../codelists/#codelists>` + +```{deprecated} 1.2 +``` + +```{csv-table-no-translate} +:header-rows: 1 +:file: ../../../build/current_lang/codelists/awardStatus.csv +``` diff --git a/docs/schema/codelists/classificationScheme.md b/docs/schema/codelists/classificationScheme.md new file mode 100644 index 000000000..2f44fa0ad --- /dev/null +++ b/docs/schema/codelists/classificationScheme.md @@ -0,0 +1,10 @@ +# Classification Scheme + +{bdg-link-secondary}`open<../../codelists/#codelists>` + +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. + +```{csv-table-no-translate} +:header-rows: 1 +:file: ../../../build/current_lang/codelists/classificationScheme.csv +``` diff --git a/docs/schema/codelists/contractFinalStatus.md b/docs/schema/codelists/contractFinalStatus.md new file mode 100644 index 000000000..7c8e33d51 --- /dev/null +++ b/docs/schema/codelists/contractFinalStatus.md @@ -0,0 +1,11 @@ +# Contract Final Status + +{bdg-link-primary}`closed<../../codelists/#codelists>` + +```{versionadded} 1.2 +``` + +```{csv-table-no-translate} +:header-rows: 1 +:file: ../../../build/current_lang/codelists/contractFinalStatus.csv +``` diff --git a/docs/schema/codelists/contractStatus.md b/docs/schema/codelists/contractStatus.md new file mode 100644 index 000000000..6a580d36b --- /dev/null +++ b/docs/schema/codelists/contractStatus.md @@ -0,0 +1,11 @@ +# Contract Status + +{bdg-link-primary}`closed<../../codelists/#codelists>` + +```{deprecated} 1.2 +``` + +```{csv-table-no-translate} +:header-rows: 1 +:file: ../../../build/current_lang/codelists/contractStatus.csv +``` diff --git a/docs/schema/codelists/country.md b/docs/schema/codelists/country.md new file mode 100644 index 000000000..001a43881 --- /dev/null +++ b/docs/schema/codelists/country.md @@ -0,0 +1,13 @@ +# Country + +{bdg-link-primary}`closed<../../codelists/#codelists>` + +```{versionadded} 1.2 +``` + +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'). + +```{csv-table-no-translate} +:header-rows: 1 +:file: ../../../build/current_lang/codelists/country.csv +``` diff --git a/docs/schema/codelists/currency.md b/docs/schema/codelists/currency.md new file mode 100644 index 000000000..6d04847b4 --- /dev/null +++ b/docs/schema/codelists/currency.md @@ -0,0 +1,13 @@ +# Currency + +{bdg-link-primary}`closed<../../codelists/#codelists>` + +```{versionadded} 1.1 +``` + +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). + +```{csv-table-no-translate} +:header-rows: 1 +:file: ../../../build/current_lang/codelists/currency.csv +``` diff --git a/docs/schema/codelists/documentType.md b/docs/schema/codelists/documentType.md new file mode 100644 index 000000000..1cc7ae314 --- /dev/null +++ b/docs/schema/codelists/documentType.md @@ -0,0 +1,14 @@ +# Document Type + +{bdg-link-secondary}`open<../../codelists/#codelists>` + +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. + +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. + +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. + +```{csv-table-no-translate} +:header-rows: 1 +:file: ../../../build/current_lang/codelists/documentType.csv +``` diff --git a/docs/schema/codelists/extendedProcurementCategory.md b/docs/schema/codelists/extendedProcurementCategory.md new file mode 100644 index 000000000..c441ffc58 --- /dev/null +++ b/docs/schema/codelists/extendedProcurementCategory.md @@ -0,0 +1,13 @@ +# Extended Procurement Category + +{bdg-link-secondary}`open<../../codelists/#codelists>` + +```{versionadded} 1.1 +``` + +The extended procurement category codelist is used to provide additional detail about the focus of a contracting (or planning) process. + +```{csv-table-no-translate} +:header-rows: 1 +:file: ../../../build/current_lang/codelists/extendedProcurementCategory.csv +``` diff --git a/docs/schema/codelists/initiationType.md b/docs/schema/codelists/initiationType.md new file mode 100644 index 000000000..fb93235cb --- /dev/null +++ b/docs/schema/codelists/initiationType.md @@ -0,0 +1,11 @@ +# Initiation Type + +{bdg-link-primary}`closed<../../codelists/#codelists>` + +```{deprecated} 1.2 +``` + +```{csv-table-no-translate} +:header-rows: 1 +:file: ../../../build/current_lang/codelists/initiationType.csv +``` diff --git a/docs/schema/codelists/language.md b/docs/schema/codelists/language.md new file mode 100644 index 000000000..2d6f48615 --- /dev/null +++ b/docs/schema/codelists/language.md @@ -0,0 +1,13 @@ +# Language + +{bdg-link-secondary}`open<../../codelists/#codelists>` + +```{versionadded} 1.2 +``` + +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). + +```{csv-table-no-translate} +:header-rows: 1 +:file: ../../../build/current_lang/codelists/language.csv +``` diff --git a/docs/schema/codelists/linkRelationType.md b/docs/schema/codelists/linkRelationType.md new file mode 100644 index 000000000..ceca2ff50 --- /dev/null +++ b/docs/schema/codelists/linkRelationType.md @@ -0,0 +1,13 @@ +# Link Relation Type + +{bdg-link-secondary}`open<../../codelists/#codelists>` + +```{versionadded} 1.2 +``` + +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. + +```{csv-table-no-translate} +:header-rows: 1 +:file: ../../../build/current_lang/codelists/linkRelationType.csv +``` diff --git a/docs/schema/codelists/mediaType.md b/docs/schema/codelists/mediaType.md new file mode 100644 index 000000000..db5b8e62b --- /dev/null +++ b/docs/schema/codelists/mediaType.md @@ -0,0 +1,13 @@ +# Media Type + +{bdg-link-secondary}`open<../../codelists/#codelists>` + +```{versionadded} 1.2 +``` + +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. + +```{csv-table-no-translate} +:header-rows: 1 +:file: ../../../build/current_lang/codelists/mediaType.csv +``` diff --git a/docs/schema/codelists/method.md b/docs/schema/codelists/method.md new file mode 100644 index 000000000..06cff351e --- /dev/null +++ b/docs/schema/codelists/method.md @@ -0,0 +1,14 @@ +# Method + +{bdg-link-primary}`closed<../../codelists/#codelists>` + +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. + +```{versionchanged} 1.1 +Added the 'direct' code. +``` + +```{csv-table-no-translate} +:header-rows: 1 +:file: ../../../build/current_lang/codelists/method.csv +``` diff --git a/docs/schema/codelists/milestoneStatus.md b/docs/schema/codelists/milestoneStatus.md new file mode 100644 index 000000000..623fa79ef --- /dev/null +++ b/docs/schema/codelists/milestoneStatus.md @@ -0,0 +1,12 @@ +# Milestone Status + +{bdg-link-primary}`closed<../../codelists/#codelists>` + +```{versionchanged} 1.1 +Added the 'scheduled' code. +``` + +```{csv-table-no-translate} +:header-rows: 1 +:file: ../../../build/current_lang/codelists/milestoneStatus.csv +``` diff --git a/docs/schema/codelists/milestoneType.md b/docs/schema/codelists/milestoneType.md new file mode 100644 index 000000000..7bbc4dfe6 --- /dev/null +++ b/docs/schema/codelists/milestoneType.md @@ -0,0 +1,13 @@ +# Milestone Type + +{bdg-link-secondary}`open<../../codelists/#codelists>` + +```{versionadded} 1.1 +``` + +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. + +```{csv-table-no-translate} +:header-rows: 1 +:file: ../../../build/current_lang/codelists/milestoneType.csv +``` diff --git a/docs/schema/codelists/organizationIdentifierScheme.md b/docs/schema/codelists/organizationIdentifierScheme.md new file mode 100644 index 000000000..acf93c0ea --- /dev/null +++ b/docs/schema/codelists/organizationIdentifierScheme.md @@ -0,0 +1,13 @@ +# Organization Identifier Scheme + +{bdg-link-secondary}`open<../../codelists/#codelists>` + +![org-id.guide](../../_static/png/org-id_logo.png) + +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. + +To add new codes to the codelist, contact the [Data Support Team](../../support/index). + +```{versionchanged} 1.1 +The `organizationIdentifierRegistrationAgency_iati.csv` file was removed. This list was formerly maintained by the International Aid Transparency Initiative. +``` diff --git a/docs/schema/codelists/partyRole.md b/docs/schema/codelists/partyRole.md new file mode 100644 index 000000000..3afc15e80 --- /dev/null +++ b/docs/schema/codelists/partyRole.md @@ -0,0 +1,13 @@ +# Organization Role + +{bdg-link-secondary}`open<../../codelists/#codelists>` + +```{versionadded} 1.1 +``` + +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. + +```{csv-table-no-translate} +:header-rows: 1 +:file: ../../../build/current_lang/codelists/partyRole.csv +``` diff --git a/docs/schema/codelists/partyScale.md b/docs/schema/codelists/partyScale.md new file mode 100644 index 000000000..4574bd4e1 --- /dev/null +++ b/docs/schema/codelists/partyScale.md @@ -0,0 +1,24 @@ +# Party Scale + +{bdg-link-primary}`closed<../../codelists/#codelists>` + +```{versionadded} 1.2 +``` + +The party scale codelist is used to indicate the size or scale of an organization, in particular commercial enterprises or economic operators. + +The codes in the codelist do not have precise definitions. Instead, they defer to local laws and regulations, for example: + +* [OECD: Small and Medium-Sized Enterprises (SMEs) definition](https://stats.oecd.org/glossary/detail.asp?ID=3123) +* [European Commission: What is an SME?](https://ec.europa.eu/growth/smes/sme-definition_en) + +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. + +For self-employed individuals and sole traders, if you can distinguish them from micro enterprises, use the 'selfEmployed' code. Otherwise, use the 'micro' code. + +For enterprises without employees, use the 'micro' code. + +```{csv-table-no-translate} +:header-rows: 1 +:file: ../../../build/current_lang/codelists/partyScale.csv +``` diff --git a/docs/schema/codelists/procurementCategory.md b/docs/schema/codelists/procurementCategory.md new file mode 100644 index 000000000..7373c571f --- /dev/null +++ b/docs/schema/codelists/procurementCategory.md @@ -0,0 +1,13 @@ +# Procurement Category + +{bdg-link-primary}`closed<../../codelists/#codelists>` + +```{versionadded} 1.1 +``` + +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](extendedProcurementCategory.md) codelist. + +```{csv-table-no-translate} +:header-rows: 1 +:file: ../../../build/current_lang/codelists/procurementCategory.csv +``` diff --git a/docs/schema/codelists/relatedProcess.md b/docs/schema/codelists/relatedProcess.md new file mode 100644 index 000000000..891aae7c1 --- /dev/null +++ b/docs/schema/codelists/relatedProcess.md @@ -0,0 +1,23 @@ +# Related Process + +{bdg-link-secondary}`open<../../codelists/#codelists>` + +```{versionadded} 1.1 +``` + +```{versionchanged} 1.2 +Added 'parent'. Deprecated 'subContract', 'replacementProcess' and 'renewalProcess'. +``` + +```{field-description} ../../../build/current_lang/release-schema.json /definitions/RelatedProcess +``` + +```{seealso} +* [Map: Contracting processes and planning processes](../../guidance/map/contracting_planning_processes.md) +* [Map: Framework agreements](../../guidance/map/framework_agreements.md) +``` + +```{csv-table-no-translate} +:header-rows: 1 +:file: ../../../build/current_lang/codelists/relatedProcess.csv +``` diff --git a/docs/schema/codelists/relatedProcessScheme.md b/docs/schema/codelists/relatedProcessScheme.md new file mode 100644 index 000000000..40a2f752f --- /dev/null +++ b/docs/schema/codelists/relatedProcessScheme.md @@ -0,0 +1,13 @@ +# Related Process Scheme + +{bdg-link-secondary}`open<../../codelists/#codelists>` + +```{versionadded} 1.1 +``` + +The related process scheme describes the kind of identifier used to cross-reference another process. + +```{csv-table-no-translate} +:header-rows: 1 +:file: ../../../build/current_lang/codelists/relatedProcessScheme.csv +``` diff --git a/docs/schema/codelists/releaseTag.md b/docs/schema/codelists/releaseTag.md new file mode 100644 index 000000000..c68189041 --- /dev/null +++ b/docs/schema/codelists/releaseTag.md @@ -0,0 +1,16 @@ +# Release Tag + +{bdg-link-secondary}`open<../../codelists/#open-codelists>` + +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. + +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. + +```{versionchanged} 1.1 +Added the 'planningUpdate' code. +``` + +```{csv-table-no-translate} +:header-rows: 1 +:file: ../../../build/current_lang/codelists/releaseTag.csv +``` diff --git a/docs/schema/codelists/submissionMethod.md b/docs/schema/codelists/submissionMethod.md new file mode 100644 index 000000000..98d9ee768 --- /dev/null +++ b/docs/schema/codelists/submissionMethod.md @@ -0,0 +1,13 @@ +# Submission Method + +{bdg-link-secondary}`open<../../codelists/#codelists>` + +```{deprecated} 1.2 +``` + +The submission method codelist is used to identify the mechanism through which a submission can be made. + +```{csv-table-no-translate} +:header-rows: 1 +:file: ../../../build/current_lang/codelists/submissionMethod.csv +``` diff --git a/docs/schema/codelists/tenderFinalStatus.md b/docs/schema/codelists/tenderFinalStatus.md new file mode 100644 index 000000000..71cc46682 --- /dev/null +++ b/docs/schema/codelists/tenderFinalStatus.md @@ -0,0 +1,11 @@ +# Tender Final Status + +{bdg-link-primary}`closed<../../codelists/#codelists>` + +```{versionadded} 1.2 +``` + +```{csv-table-no-translate} +:header-rows: 1 +:file: ../../../build/current_lang/codelists/tenderFinalStatus.csv +``` diff --git a/docs/schema/codelists/tenderStatus.md b/docs/schema/codelists/tenderStatus.md new file mode 100644 index 000000000..e6f63ac5c --- /dev/null +++ b/docs/schema/codelists/tenderStatus.md @@ -0,0 +1,15 @@ +# Tender Status + +{bdg-link-primary}`closed<../../codelists/#codelists>` + +```{deprecated} 1.2 +``` + +```{versionchanged} 1.1 +Added the 'planning' and 'withdrawn' codes. +``` + +```{csv-table-no-translate} +:header-rows: 1 +:file: ../../../build/current_lang/codelists/tenderStatus.csv +``` diff --git a/docs/schema/codelists/unitClassificationScheme.md b/docs/schema/codelists/unitClassificationScheme.md new file mode 100644 index 000000000..661750389 --- /dev/null +++ b/docs/schema/codelists/unitClassificationScheme.md @@ -0,0 +1,13 @@ +# Unit Classification Scheme + +{bdg-link-secondary}`open<../../codelists/#codelists>` + +```{versionadded} 1.1 +``` + +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. + +```{csv-table-no-translate} +:header-rows: 1 +:file: ../../../build/current_lang/codelists/unitClassificationScheme.csv +```