-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathdefinitions.json
More file actions
6465 lines (6464 loc) · 232 KB
/
definitions.json
File metadata and controls
6465 lines (6464 loc) · 232 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Definitions of OCDS elements",
"type": "object",
"definitions": {
"Implementation": {
"type": "object",
"title": "Implementation",
"description": "Information during the performance / implementation stage of the contract.",
"properties": {
"transactions": {
"title": "Transactions",
"description": "A list of the spending transactions made against this contract as an array of [Transaction]",
"type": "array",
"items": {
"$ref": "#/definitions/Transaction"
},
"uniqueItems": true
},
"milestones": {
"title": "Milestones",
"description": "A list of milestones associated with the implementation as an array of [Milestone]",
"type": "array",
"items": {
"$ref": "#/definitions/Milestone"
},
"uniqueItems": true
},
"documents": {
"title": "Documents",
"description": "Documents and reports that are part of the implementation as an array on [Document]",
"type": "array",
"items": {
"$ref": "#/definitions/Document"
},
"uniqueItems": true
},
"financialProgress": {
"title": "Financial progress",
"description": "The financial progress section allows high-level and detailed information on amounts committed or spent to date for this particular contract. This may be used alongside the transactions section, which allows for details of each individual payment to be recorded.",
"type": "object",
"properties": {
"totalSpend": {
"title": "Total spend",
"description": "The total spend on this contract at the date of last update published as [Value]",
"$ref": "#/definitions/Value"
},
"measures": {
"title": "Measures",
"description": "An aggregated financial progress figures for this contract. Measures must be provided as a set of key-value pairs, where the key should be the name of the measure used within a related Fiscal Data Package dataset or other budget and spending dataset. The value is the value of this measure when last updated, and must be provided as a number in the same default currency as any aggregate reported budget or spending figures.",
"type": "object"
},
"breakdown": {
"title": "Financial progress breakdown",
"description": "This section contains a breakdown of financial progress, allowing various measures (amount invoiced, amount accrued, amount paid etc.) to be disaggregated by source, period and budget classification. Publishes as an array of [FinancialProgressBreakdown]",
"type": "array",
"items": {
"$ref": "#/definitions/FinancialProgressBreakdown"
}
}
}
},
"endDate": {
"title": "End date",
"description": "The date when contract implementation ended. This must only be provided when contract implementation is complete. Where `implementation/endDate` varies from the anticipated `contract/period/endDate` an explanation of the variance should be provided in `implementation/endDateDetails`.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"endDateDetails": {
"title": "End date details",
"description": "Details related to the endDate. This may be a justification for the contract's completion date being different than in the original contract.",
"type": [
"string",
"null"
]
},
"finalValue": {
"$ref": "#/definitions/Value",
"title": "Final value",
"description": "The total value of all payments for a completed contract. This should only be provided when the final payment has been recorded. If `implementation/transactions` are used for this contract, this field should equal the sum of the `transaction/value/amount` fields. Where `finalValue/amount` varies from `contract/value/amount` an explanation of the variance should be provided in `finalValueDetails`. Publishes as [Value]"
},
"finalValueDetails": {
"title": "Final value details",
"description": "Details related to the final value. This may be a justification for the completed contract's value being different than in the original contract.",
"type": [
"string",
"null"
]
},
"performanceFailures": {
"title": "Performance failure disclosures",
"description": "An array of [PerformanceFailure] disclosures, detailing performance failures for different periods and categories.",
"type": "array",
"items": {
"$ref": "#/definitions/PerformanceFailure"
},
"uniqueItems": true
},
"metrics": {
"type": "array",
"title": "Metrics",
"description": "Reported results from the delivery of the contracted goods, works or services described with an array of [Metrics]",
"items": {
"$ref": "#/definitions/Metric"
},
"uniqueItems": true
},
"status":{
"title":"Implementation status",
"descrition":"The current status of the contract implementation based on the implementationStatuscodelist.",
"type":"string",
"codelist":"https://extensions.open-contracting.org/en/extensions/implementationStatus/master/codelists/"
}
}
},
"Enquiry": {
"type": "object",
"title": "Enquiry",
"description": "Question related to this contracting process, generally sent during the enquiry period.",
"properties": {
"id": {
"title": "Identifier",
"description": "A unique identifier for the enquiry.",
"type": [
"string",
"null"
]
},
"date": {
"type": [
"string",
"null"
],
"title": "Date",
"description": "The date the enquiry was received or processed.",
"format": "date-time"
},
"author": {
"title": "Question author",
"description": "The [OrganizationReference] of the party asking this question.",
"$ref": "#/definitions/OrganizationReference"
},
"title": {
"title": "Question title",
"description": "The subject line of the question.",
"type": [
"string",
"null"
]
},
"description": {
"title": "Description",
"description": "The body of the question.",
"type": [
"string",
"null"
]
},
"answer": {
"title": "Answer",
"description": "The answer to this question, when available.",
"type": [
"string",
"null"
]
},
"dateAnswered": {
"title": "Date answered",
"description": "The date the answer to the question was provided.",
"type": [
"string",
"null"
],
"format": "date-time"
},
"relatedItem": {
"title": "Related item",
"description": "If this question relates to a specific line-item, this field contains the line-item identifier.",
"type": [
"string",
"null"
]
},
"relatedLot": {
"title": "Related lot",
"description": "Where lots are used, if this question relates to a specific lot, this field contains the lot identifier.",
"type": [
"string",
"null"
]
},
"threadID": {
"title": "Thread identifier",
"description": "If this question and answer forms part of a discussion thread (e.g. the question is a follow up to a previous answer) an optional thread identifier can be used to associate together multiple enquiries.",
"type": [
"string",
"null"
]
}
}
},
"Metric": {
"type": "object",
"title": "Metric",
"description": "Metrics are used to set out targets and results from a contracting process. During the planning and tender sections, a metric indicates the anticipated results. In award and contract sections it indicates the awarded/contracted results. In the implementation section it is used to provide updates on actually delivered results, also known as outputs.",
"required": [
"id"
],
"doc":{
"inheritance": {
"fe-forecasts": {
"description": "",
"validationRules":{
"VR-Metric.FE-Forecasts-001":{
"relatesTo":"relatedItem",
"rule":"Specified value found in an array of relevant schema-elements (lots/items)"
},
"VR-Metric.FE-Forecasts-002":{
"relatesTo":"observations",
"rule":"At least one observation described for this metric"
},
"VR-Metric.FE-Forecasts-003":{
"relatesTo":"relatesTo",
"rule":"Specified value is either 'lot' or 'item'"
}
},
"properties": {
"id":{
"description": "An identifier for this metric drawn from a codelist",
"mandatory": true,
"source": "System"
},
"description": {
"description": "Any free-text description from PE while preparing this metric of forecast",
"mandatory": false,
"source": "Procuring Entity"
},
"relatesTo": {
"mandatory": false,
"source": "Procuring Entity",
"description": "The schema element that the metric relates. For example observation may be defined against items or against lot."
},
"relatedItem": {
"description": "This field must be populated with the id of the item in this tender section which the metric relates to",
"mandatory": false,
"source": "Procuring Entity"
},
"observations": {
"description": "An array of [Observation] for this metric",
"mandatory": true,
"source": "Procuring Entity"
}
}
},
"position": {
"description": "",
"validationRules":{
"VR-Metric.Position-001":{
"relatesTo":"relatedItem",
"rule":"Specified value found in an array of items from this initiation"
},
"VR-Metric.Position-002":{
"relatesTo":"observations",
"rule":"At least one observation described for this metric"
},
"VR-Metric.Position-003":{
"relatesTo":"relatesTo",
"rule":"Specified value is 'item'"
}
},
"properties": {
"id":{
"description": "An identifier for this metric drawn from a codelist",
"mandatory": true,
"source": "System"
},
"description": {
"description": "Any free-text description from PE while preparing this target for the item",
"mandatory": false,
"source": "Procuring Entity"
},
"relatesTo": {
"mandatory": false,
"source": "Procuring Entity",
"description": "The schema element that the target relates. For this class - 'item' by default"
},
"relatedItem": {
"description": "This field must be populated with the id of the item in this tender section which the target relates to",
"mandatory": false,
"source": "Procuring Entity"
},
"observations": {
"description": "An array of [Observation] for this target",
"mandatory": true,
"source": "Procuring Entity"
}
}
}
}
},
"properties": {
"id": {
"title": "Identifier",
"description": "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.",
"type": [
"string"
],
"minLength": 1
},
"title": {
"title": "Title",
"description": "The title of this metric",
"type": [
"string",
"null"
]
},
"description": {
"title": "Description",
"description": "A short description of the metric. This may include short details of measurement methods.",
"type": [
"string",
"null"
]
},
"relatesTo": {
"description": "The schema element that the metric relates. For example observation may be defined against items or against lot.",
"type": "string",
"enum": [
"item",
"tenderer"
],
"mergeStrategy": "ocdsVersion"
},
"relatedItem": {
"description": "This field must be populated with the id of the item in this tender section which the metric relates to",
"type": [
"string",
"null"
],
"mergeStrategy": "ocdsVersion"
},
"observations": {
"type": "array",
"title": "Observations",
"description": "An array of [Observation]: target or actual values for this metric.",
"items": {
"$ref": "#/definitions/Observation"
},
"uniqueItems": true
}
}
},
"Observation": {
"type": "object",
"title": "Observation",
"description": "An actual or target observation. Observations should include either a value (for financial metrics) or measure (for other metrics). ",
"required": [
"id"
],
"doc":{
"inheritance": {
"@": {
"description": "",
"validationRules":{
"VR-Observation.@-001":{
"relatesTo":"relatedRequirementID",
"rule":"Specified value found in an array of relevant schema-elements ('requirements') of this initiation"
}
},
"properties": {
"id":{
"description": "An identifier for this observation",
"mandatory": true,
"source": "System"
},
"period":{
"description": "The [Period] over which this observation is measured",
"mandatory": false,
"source": "Procuring Entity"
},
"value":{
"description": "For financial metrics, the [Value] of this forecast, target or actual observation.",
"mandatory": false,
"source": "Procuring Entity"
},
"measure":{
"description": "For non-financial metrics, the measure of this forecast, target or actual observation. Measures may be provided as free text or numerical values.",
"mandatory": false,
"source": "Procuring Entity"
},
"unit":{
"description": "Unit of measure for this observation",
"mandatory": false,
"source": "Procuring Entity"
},
"dimensions":{
"description": "Any number of dimensions can be recorded within this object. Dimensions names should follow the camelCase conventions of OCDS",
"mandatory": false,
"source": "Procuring Entity"
},
"notes":{
"description": "Any notes on this observation",
"mandatory": false,
"source": "Procuring Entity"
},
"relatedRequirementID":{
"description": "The [RequirementReference] of the requirement which the observation is applicable to",
"mandatory": false,
"source": "Procuring Entity"
}
}
}
}
},
"properties": {
"id": {
"title": "Identifier",
"description": "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.",
"type": "string",
"minLength": 1
},
"period": {
"title": "Period",
"description": "The [Period] over which this observation is measured.",
"$ref": "#/definitions/Period"
},
"value": {
"title": "Value",
"description": "For financial metrics, the [Value] of this forecast, target or actual observation.",
"$ref": "#/definitions/Value"
},
"measure": {
"title": "Measure",
"description": "For non-financial metrics, the measure of this forecast, target or actual observation. Measures may be provided as free text or numerical values.",
"type": [
"string",
"number",
"null"
]
},
"unit": {
"type": "object",
"title": "Unit",
"description": "Unit",
"properties": {
"name": {
"type": [
"string",
"null"
],
"title": "Unit name",
"description": "The name of the unit."
},
"scheme": {
"title": "Scheme",
"description": "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. ",
"type": [
"string",
"null"
],
"codelist": "unitClassificationScheme.csv",
"openCodelist": true
},
"id": {
"title": "ID",
"description": "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. ",
"type": [
"string",
"null"
]
},
"uri": {
"title": "URI",
"description": "If the scheme used provide a machine-readable URI for this unit of measure, this can be given.",
"type": [
"string",
"null"
],
"format": "uri"
}
}
},
"dimensions": {
"type": "object",
"title": "Dimensions",
"description": "Any number of dimensions can be recorded within this object. Dimensions names should follow the camelCase conventions of OCDS."
},
"notes": {
"title": "Notes",
"description": "Any notes on this observation. This may include clarifying information.",
"type": [
"string",
"null"
]
},
"relatedImplementationMilestone": {
"title": "Related implementation milestone",
"description": "A [MilestoneReference] to the milestone in the implementation section of OCDS to which this forecast, target or actual observation relates.",
"$ref": "#/definitions/MilestoneReference"
},
"relatedRequirementID": {
"title": "Related requirement",
"description": "The [RequirementReference] of the requirement which the observation is applicable to",
"$ref": "#/definitions/RequirementReference"
}
}
},
"MilestoneReference": {
"type": "object",
"title": "Milestone Reference",
"description": "A block used to reference a milestone, including the ID and title of the milestone being referenced.",
"required": [
"id"
],
"properties": {
"id": {
"title": "Milestone ID",
"description": "The ID of the milestone being referenced, this must match the ID of a milestone described elsewhere in a release about this contracting process.",
"type": "string",
"minLength": 1
},
"title": {
"title": "Milestone title",
"description": "The title of the milestone being referenced, this must match the title of a milestone described elsewhere in a release about this contracting process.",
"type": [
"string",
"null"
]
}
}
},
"FinancialProgressBreakdown": {
"type": "object",
"title": "Financial progress breakdown",
"description": "This section allows a detailed breakdown of financial progress to be provided, each covering a particular periods, or allocating financial progress against particular funding sources and fiscal classifications.",
"properties": {
"id": {
"title": "Identifier",
"description": "An identifier for this particular financial progress breakdown entry.",
"type": [
"string",
"integer"
]
},
"description": {
"title": "Description",
"description": "A short free text description of this financial progress breakdown. This may be displayed in user interfaces to help users interpret this entry. This may be automatically generated from structured data or may be manually entered.",
"type": [
"string",
"null"
]
},
"period": {
"$ref": "#/definitions/Period",
"title": "Budget period",
"description": "The [Period] covered by this financial progress breakdown entry. This information may also be duplicated using classifications where relevant."
},
"classifications": {
"title": "Budget classifications",
"description": "Budget [Classification] must be provided as a set of key-value pairs, where the key is a dimension (or the label of a dimension) used in budget classification, and the value is the value of that dimension for this contracting process or specific contract (depending on the point within an OCDS file at which the classification is provided).",
"type": "object",
"$ref": "#/definitions/Classification"
},
"measures": {
"title": "measures",
"description": "Measures must be provided as a set of key-value pairs, where the key should be the name of the measure used within a related Fiscal Data Package dataset or other budget and spending dataset. The value is the value of this measure when last updated, and must be provided as a number in the same default currency as any aggregate reported budget or spending figures.",
"type": "object"
}
}
},
"BudgetBreakdown": {
"properties": {
"id": {
"title": "Identifier",
"description": "An identifier for this particular budget entry.",
"mergeStrategy": "ocdsVersion",
"type": [
"string",
"integer"
]
},
"description": {
"title": "Description",
"description": "A short free text description of this budget entry.",
"mergeStrategy": "ocdsVersion",
"type": [
"string",
"null"
]
},
"amount": {
"title": "Amount",
"description": "The [Value] of the budget line item.",
"$ref": "#/definitions/Value"
},
"uri": {
"title": "Linked budget information",
"description": "A URI pointing directly to a machine-readable information about this budget entry.",
"mergeStrategy": "ocdsVersion",
"type": [
"string",
"null"
],
"format": "uri"
},
"period": {
"$ref": "#/definitions/Period",
"title": "Budget period",
"description": "The [Period] covered by this budget entry."
},
"sourceParty": {
"$ref": "#/definitions/OrganizationReference",
"title": "Source party",
"description": "The [OrganizationReference] for Organization or other party related to this budget entry. If the budget amount is positive, this indicates a flow of resources from the party to the contracting process. If the budget amount is negative, it indicates a payment from the contracting process to this party."
},
"classifications": {
"title": "Budget classifications",
"description": "Budget [Classification] must be provided as a set of key-value pairs, where the key is a dimension (or the label of a dimension) used in budget classification, and the value is the value of that dimension for this contracting process or specific contract (depending on the point within an OCDS file at which the classification is provided).",
"type": "object",
"$ref": "#/definitions/Classification"
},
"measures": {
"title": "measures",
"description": "Measures must be provided as a set of key-value pairs, where the key should be the name of the measure used within a related Fiscal Data Package dataset or other budget and spending dataset. The value is the value of this measure when last updated, and must be provided as a number in the same default currency as any aggregate reported budget or spending figures.",
"type": "object"
}
}
},
"BudgetAllocation": {
"properties": {
"budgetBreakdownID": {
"title": "Budget Breakdown Identifier",
"description": "An identifier for particular budget entry.",
"mergeStrategy": "ocdsVersion",
"type": [
"string",
"integer"
]
},
"period": {
"$ref": "#/definitions/Period",
"title": "Budget period",
"description": "The [Period] covered by this budget entry."
},
"relatedItem": {
"title": "Related Item",
"description": "",
"type": "string"
}
},
"doc":{
"inheritance":{
"@":{
"description": "",
"validationRules":{
"VR-BudgetAllocation.@-001":{
"relatesTo":"relatedItem",
"rule":"Specified value found in an array of relevant schema-element (lots/items) of the containing parent component tender/contract"
},
"VR-BudgetAllocation.@-002":{
"relatesTo":"budgetBreakdownID",
"rule":"Specified value found in an array of identifiers of related/included BudgetBreakdown elements"
},
"VR-BudgetAllocation.@-003":{
"relatesTo":"period",
"rule":"Specified range is included into period of validity of related BudgetBreakdown element"
}
}
}
}
}
},
"BudgetSource": {
"properties": {
"budgetBreakdownID": {
"title": "Budget Breakdown Identifier",
"description": "An identifier for particular budget entry.",
"mergeStrategy": "ocdsVersion",
"type": [
"string",
"integer"
]
},
"amount": {
"title": "Amount",
"description": "",
"type": "number"
},
"currency": {
"title": "Currency",
"description": "",
"type": "string"
}
}
},
"PerformanceFailure": {
"type": "object",
"title": "Performance failure disclosure",
"description": "Details of the performance failures for a given period and category. Details of the associated penalties and abatements provided for in the contract, imposed and paid can also be provided.",
"required": [
"id"
],
"properties": {
"id": {
"title": "Identifier",
"description": "A local identifier for this specific category and period of performance failure. This field is used to keep track of revisions of a charge across multiple OCDS releases.",
"type": "string"
},
"period": {
"title": "Performance failure [Period]",
"description": "The reporting period for these performance failures.",
"type": [
"object",
"null"
],
"$ref": "#/definitions/Period"
},
"category": {
"title": "Performance failure category",
"description": "The category into which these performance failures fall.",
"type": [
"string",
"null"
]
},
"events": {
"title": "Number of events",
"description": "The number of performance failures for the given period and category.",
"type": [
"number",
"null"
]
},
"penaltyContracted": {
"title": "Contracted penalty",
"description": "A free text description of the penalty or abatement provided for in the contract for this period, category and number of performance failures.",
"type": [
"string",
"null"
]
},
"penaltyImposed": {
"title": "Penalty imposed",
"description": "A free text description of the penalty or abatement imposed for this period, category and number of performance failures.",
"type": [
"string",
"null"
]
},
"penaltyPaid": {
"title": "Penalty paid",
"description": "A yes/no field indicating whether the penalty imposed for this period, category and number of performance failures has been paid.",
"type": [
"boolean",
"null"
]
}
}
},
"Milestone": {
"title": "Milestone",
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"title": "ID",
"description": "A local identifier for this milestone, unique within this block. This field is used to keep track of multiple revisions of a milestone through the compilation from release to record mechanism.",
"type": [
"string",
"integer"
]
},
"title": {
"title": "Title",
"description": "Milestone title",
"type": [
"string",
"null"
]
},
"type": {
"title": "Milestone type",
"description": "The type of milestone, drawn from an extended [Codelists#Milestone types].",
"type": [
"string",
"null"
],
"codelist": "(http://standard.open-contracting.org/1.1-dev/en/schema/codelists/#milestone-type)",
"opencodelist": true
},
"description": {
"title": "Description",
"description": "A description of the milestone.",
"type": [
"string",
"null"
]
},
"code": {
"title": "Milestone code",
"description": "Milestone codes can be used to track specific events that take place for a particular kind of contracting process. For example, a code of 'approvalLetter' could be used to allow applications to understand this milestone represents the date an approvalLetter is due or signed. Milestone codes is an open codelist, and codes should be agreed amoungst data producers and the applications using that data.",
"type": [
"string",
"null"
]
},
"dueDate": {
"title": "Due date",
"description": "The date the milestone is due.",
"type": [
"string",
"null"
],
"format": "date-time"
},
"dateMet": {
"format": "date-time",
"title": "Date met",
"description": "The date on which the milestone was met.",
"type": [
"string",
"null"
]
},
"dateModified": {
"title": "Date modified",
"description": "The date the milestone was last reviewed or modified and the status was altered or confirmed to still be correct.",
"type": [
"string",
"null"
],
"format": "date-time"
},
"status": {
"title": "Status",
"description": "The status that was realized on the date provided in dateModified, drawn from the [Codelists#Milestone statuses].",
"type": [
"string",
"null"
],
"codelist": "http://standard.open-contracting.org/1.1-dev/en/schema/codelists/#milestone-status",
"openCodelist": false
},
"relatedLots": {
"title": "Related lot(s)",
"description": "If this milestone relates to a particular lot, provide the identifier(s) of the related lot(s) here.",
"type": [
"array"
],
"items": {
"type": [
"string",
"null"
]
}
},
"relatedParties": {
"title": "Related Parties",
"description": "Parties that have a relationship with the milestone as an array of [OrganizationReference]",
"type": "array",
"items": {
"$ref": "#/definitions/OrganizationReference"
}
},
"additionalInformation": {
"title": "Additional information",
"description": "Additional information about the milestone",
"type": [
"string",
"integer"
]
}
}
},
"Document": {
"type": "object",
"title": "Document",
"description": "Links to, or descriptions of, external documents can be attached at various locations within the standard. Documents may be supporting information, formal notices, downloadable forms, or any other kind of resource that should be made public as part of full open contracting.",
"required": [
"id"
],
"properties": {
"id": {
"title": "ID",
"description": "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.",
"type": [
"string",
"integer"
]
},
"documentType": {
"title": "Document type",
"description": "A classification of the document described taken from the [Codelists#Document types]. Values from the provided codelist should be used wherever possible, though extended values can be provided if the codelist does not have a relevant code.",
"type": [
"string",
"null"
],
"codelist": "http://standard.open-contracting.org/1.1-dev/en/schema/codelists/#document-type",
"openCodelist": true
},
"title": {
"title": "Title",
"description": "The document title.",
"type": [
"string",
"null"
]
},
"description": {
"title": "Description",
"description": "A short description of the document. We recommend descriptions do not exceed 250 words. In the event the document is not accessible online, the description field can be used to describe arrangements for obtaining a copy of the document.",
"type": [
"string",
"null"
]
},
"url": {
"title": "URL",
"description": " direct link to the document or attachment. The server providing access to this document should be configured to correctly report the document mime type.",
"type": [
"string",
"null"
],
"format": "uri"
},
"datePublished": {
"title": "Date published",
"description": "The date on which the document was first published. This is particularly important for legally important documents such as notices of a tender.",
"type": [
"string",
"null"
],
"format": "date-time"
},
"dateModified": {
"title": "Date modified",
"description": "Date that the document was last modified",
"type": [
"string",
"null"
],
"format": "date-time"
},
"format": {
"title": "Format",
"description": "The format of the document taken from the [IANA Media Types code list](http://www.iana.org/assignments/media-types/), with the addition of one extra value for 'offline/print', used when this document entry is being used to describe the offline publication of a document. Use values from the template column. Links to web pages should be tagged 'text/html'.",
"type": [
"string",
"null"
]
},
"language": {
"title": "Language",
"description": "Specifies the language of the linked document using either two-digit ISO 639-1 or extended BCP47 language tags.",
"type": [
"string",
"null"
]
},
"relatedLots": {
"title": "Related lot(s)",
"description": "If this document relates to a particular lot, provide the identifier(s) of the related lot(s) here.",
"type": [
"array"
],
"items": {
"type": [
"string",
"null"
]
}
},
"pageStart": {
"title": "Page start",
"description": "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. ",
"type": [
"string",
"null"
],
"mergeStrategy": "ocdsVersion"
},
"pageEnd": {
"title": "Page end",
"description": "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. ",
"type": [
"string",
"null"
],
"mergeStrategy": "ocdsVersion"
},
"accessDetails": {
"title": "Access details",
"description": "A description of any special arrangements required to access this document. This may include a requirement to register for document access, a fee to be paid, or the location where documents can be inspected. ",
"type": [