-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathmodus-result.schema.cts
353 lines (339 loc) · 12.9 KB
/
modus-result.schema.cts
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
/**
* @license
* Copyright 2022 Open Ag Data Alliance
*
* Use of this source code is governed by an MIT-style
* license that can be found in the LICENSE file or at
* https://opensource.org/licenses/MIT.
*/
import type { JSONSchema8 as Schema } from 'jsonschema8';
const schema = {
$id: 'https://formats.openag.io/modus/v1/modus-result.schema.json',
$schema: 'http://json-schema.org/draft-07/schema#',
description: 'Modus document for submission of lab results to FMIS',
$comment: 'The main lab result format for Modus V1, converted from the XSD',
type: 'object',
properties: {
_type: {
$comment: 'content type for API responses',
const: 'application/vnd.modus.v1.modus-result+json',
},
Events: {
type: 'array',
items: {
$comment: 'this is an "Event"',
type: 'object',
properties: {
EventMetaData: {
type: 'object',
properties: {
EventCode: {
description:
'Unique human readable code for the sample event. Often referred to a Layer ID',
type: 'string',
},
EventType: { $ref: './global.schema.json#/$defs/EventType' },
EventExpirationDate: {
type: 'string',
format: 'date',
description:
'The date the data in event is to expire for use in a recommendation',
},
},
},
LabMetaData: { $ref: './global.schema.json#/$defs/LabMetaData' },
FMISMetadata: { $ref: './global.schema.json#/$defs/FMISMetadata' },
EventSamples: {
description: 'Element contains the field sample points and data',
type: 'object',
properties: {
Soil: {
description:
'Element to place samples and results from a soil sample event',
type: 'object',
properties: {
DepthRefs: { $ref: './global.schema.json#/$defs/DepthRefs' },
RecommendationRefs: {
$ref: './global.schema.json#/$defs/RecommendationRefs',
},
SoilSamples: {
type: 'array',
items: {
$comment: 'A "SoilSample"',
description:
'Element that contains the soil sample event data under the soil event',
type: 'object',
properties: {
SampleMetaData: {
$ref: './global.schema.json#/$defs/SampleMetaData',
},
Depths: {
description:
'A container for the different depths being reported',
type: 'array',
items: {
description:
'Container for results at a defined depth. The Depth ID is defined in DepthRefs',
type: 'object',
properties: {
NutrientResults: {
$ref: './global.schema.json#/$defs/NutrientResults',
},
TextureResults: {
$ref: './global.schema.json#/$defs/TextureResults',
},
DepthID: {
description:
'Depth ID from the Depth Reference',
type: ['number', 'string'],
},
},
},
},
NutrientRecommendations: {
$ref: './global.schema.json#/$defs/NutrientRecommendations',
},
Comments: {
$ref: './global.schema.json#/$defs/Comments',
},
},
},
},
},
},
Plant: {
description:
'Element to place samples and results from a plant tissue sample event',
type: 'object',
properties: {
RecommendationRefs: {
$ref: './global.schema.json#/$defs/RecommendationRefs',
},
PlantSamples: {
type: 'array',
items: {
type: 'object',
properties: {
SampleMetaData: {
$ref: './global.schema.json#/$defs/SampleMetaData',
},
NutrientResults: {
$ref: './global.schema.json#/$defs/NutrientResults',
},
NutrientRecommendations: {
$ref: './global.schema.json#/$defs/NutrientRecommendations',
},
Comments: {
$ref: './global.schema.json#/$defs/Comments',
},
},
},
},
},
},
Nematode: {
description:
'Element to place samples and results from a nematode sample event',
type: 'object',
properties: {
DepthRefs: { $ref: './global.schema.json#/$defs/DepthRefs' },
NematodeSamples: {
type: 'array',
items: {
type: 'object',
properties: {
SampleMetaData: {
$ref: './global.schema.json#/$defs/SampleMetaData',
},
Depths: {
type: 'array',
items: {
type: 'object',
properties: {
NematodeResults: {
$ref: './global.schema.json#/$defs/NematodeResults',
},
DepthID: { type: 'integer', minimum: 1 },
},
},
},
Comments: {
$ref: './global.schema.json#/$defs/Comments',
},
},
},
},
},
},
Water: {
type: 'object',
properties: {
WaterSamples: {
type: 'array',
items: {
type: 'object',
properties: {
SampleMetaData: {
$ref: './global.schema.json#/$defs/SampleMetaData',
},
Source: { type: 'string' },
NutrientResults: {
$ref: './global.schema.json#/$defs/NutrientResults',
},
Comments: {
$ref: './global.schema.json#/$defs/Comments',
},
},
},
},
},
},
Residue: {
type: 'object',
properties: {
ResidueSamples: {
type: 'array',
items: {
type: 'object',
properties: {
SampleMetaData: {
$ref: './global.schema.json#/$defs/SampleMetaData',
},
ResidueResults: {
$ref: './global.schema.json#/$defs/ResidueResults',
},
Comments: {
$ref: './global.schema.json#/$defs/Comments',
},
},
},
},
},
},
},
},
Comments: { $ref: './global.schema.json#/$defs/Comments' },
ModusSubmit: {
$comment: 'can hold an entire ModusSubmit document?',
$ref: './modus-submit.schema.json',
},
},
},
},
Version: { type: 'string', default: '1.0' },
},
// More examples can be found at https://github.com/oats-center/modus/examples
examples: [
{
_type: 'application/vnd.modus.v1.modus-result+json',
ModusResult: {
Events: [
{
EventMetaData: {
EventCode: 'ece3a2a8-4340-48b1-ae1f-d48d1f1e1692',
EventDate: '2021-09-24',
EventType: { Soil: true },
},
LabMetaData: {
LabName: 'A & L Great Lakes Laboratories',
LabEventID: 'F21267-0039',
Contact: {
Name: 'A & L Great Lakes Laboratories',
Phone: '260.483.4759',
Address: '3505 Conestoga Dr.\nFort Wayne, IN 46808',
},
ReceivedDate: '2021-09-24T00:00:00.000',
ProcessedDate: '2021-09-28T00:00:00.000',
ClientAccount: {
AccountNumber: '30039',
Company: 'THE ANDERSONS FARM CTR - GPS',
City: 'N MANCHESTER',
State: 'IN',
},
Reports: {
'1': {
LabReportID: 'F21271-0035',
},
},
},
FMISMetaData: {
FMISEventID: 'ece3a2a8-4340-48b1-ae1f-d48d1f1e1692',
FMISProfile: {
'Grower': 'CARL AULT',
'Farm': 'ENYART EAST 50',
'Field': '50.1 AC',
'Sub-Field': '',
},
},
EventSamples: {
Soil: {
DepthRefs: {
'1': {
Name: 'Unknown Depth',
StartingDepth: 0,
EndingDepth: 8,
ColumnDepth: 8,
DepthUnit: 'in',
},
},
SoilSamples: [
{
SampleMetaData: {
SampleNumber: 1,
ReportID: 28_051,
},
Depths: [
{
DepthID: '1',
NutrientResults: {
'pH': { Value: 7, ValueUnit: 'none' },
'OM': { Value: 2.4, ValueUnit: '%' },
'P': { Value: 34, ValueUnit: 'ppm' },
'K': { Value: 161, ValueUnit: 'ppm' },
'Ca': { Value: 1150, ValueUnit: 'ppm' },
'Mg': { Value: 240, ValueUnit: 'ppm' },
'CEC': { Value: 8.2, ValueUnit: 'meq/100g' },
'BS-Ca': { Value: 70.4, ValueUnit: '%' },
'BS-Mg': { Value: 24.5, ValueUnit: '%' },
'BS-K': { Value: 5.1, ValueUnit: '%' },
'SO4-S': { Value: 7, ValueUnit: 'ppm' },
'Zn': { Value: 3.3, ValueUnit: 'ppm' },
'Mn': { Value: 46, ValueUnit: 'ppm' },
'B': { Value: 0.7, ValueUnit: 'ppm' },
},
},
],
},
{
SampleMetaData: {
SampleNumber: 2,
ReportID: 28_052,
},
Depths: [
{
DepthID: '1',
NutrientResults: {
'pH': { Value: 7.6, ValueUnit: 'none' },
'OM': { Value: 2.7, ValueUnit: '%' },
'P': { Value: 30, ValueUnit: 'ppm' },
'K': { Value: 190, ValueUnit: 'ppm' },
'Ca': { Value: 1950, ValueUnit: 'ppm' },
'Mg': { Value: 265, ValueUnit: 'ppm' },
'CEC': { Value: 12.4, ValueUnit: 'meq/100g' },
'BS-Ca': { Value: 78.3, ValueUnit: '%' },
'BS-Mg': { Value: 17.7, ValueUnit: '%' },
'BS-K': { Value: 3.9, ValueUnit: '%' },
},
},
],
},
],
},
},
},
],
},
},
],
} as const satisfies Schema;
export = schema;