/** * Modus document for submission of lab results to FMIS * @example * ```json * { * "_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": 28051 * }, * "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": 28052 * }, * "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": "%" * } * } * } * ] * } * ] * } * } * } * ] * } * } * ``` * * * File automatically generated using json-schema-to-typescript. * ! DO NOT MODIFY IT BY HAND ! * Instead, modify the source file ./modus/v1/modus-result.schema.json of @oada/formats * and run `$ yarn build` to regenerate this file. * * @packageDocumentation */ /** * `$id` of the source schema * @see {@link https://formats.openag.io/modus/v1/modus-result.schema.json} */ export declare const $id = "https://formats.openag.io/modus/v1/modus-result.schema.json"; /** * JSON Schema used to generate this type * @see {@link https://formats.openag.io/modus/v1/modus-result.schema.json} */ export declare const schema: { readonly $id: "https://formats.openag.io/modus/v1/modus-result.schema.json"; readonly $schema: "http://json-schema.org/draft-07/schema#"; readonly description: "Modus document for submission of lab results to FMIS"; readonly $comment: "The main lab result format for Modus V1, converted from the XSD"; readonly type: "object"; readonly properties: { readonly _type: { readonly $comment: "content type for API responses"; readonly const: "application/vnd.modus.v1.modus-result+json"; }; readonly Events: { readonly type: "array"; readonly items: { readonly $comment: "this is an \"Event\""; readonly type: "object"; readonly properties: { readonly EventMetaData: { readonly type: "object"; readonly properties: { readonly EventCode: { readonly description: "Unique human readable code for the sample event. Often referred to a Layer ID"; readonly type: "string"; }; readonly EventType: { readonly $ref: "./global.schema.json#/$defs/EventType"; }; readonly EventExpirationDate: { readonly type: "string"; readonly format: "date"; readonly description: "The date the data in event is to expire for use in a recommendation"; }; }; }; readonly LabMetaData: { readonly $ref: "./global.schema.json#/$defs/LabMetaData"; }; readonly FMISMetadata: { readonly $ref: "./global.schema.json#/$defs/FMISMetadata"; }; readonly EventSamples: { readonly description: "Element contains the field sample points and data"; readonly type: "object"; readonly properties: { readonly Soil: { readonly description: "Element to place samples and results from a soil sample event"; readonly type: "object"; readonly properties: { readonly DepthRefs: { readonly $ref: "./global.schema.json#/$defs/DepthRefs"; }; readonly RecommendationRefs: { readonly $ref: "./global.schema.json#/$defs/RecommendationRefs"; }; readonly SoilSamples: { readonly type: "array"; readonly items: { readonly $comment: "A \"SoilSample\""; readonly description: "Element that contains the soil sample event data under the soil event"; readonly type: "object"; readonly properties: { readonly SampleMetaData: { readonly $ref: "./global.schema.json#/$defs/SampleMetaData"; }; readonly Depths: { readonly description: "A container for the different depths being reported"; readonly type: "array"; readonly items: { readonly description: "Container for results at a defined depth. The Depth ID is defined in DepthRefs"; readonly type: "object"; readonly properties: { readonly NutrientResults: { readonly $ref: "./global.schema.json#/$defs/NutrientResults"; }; readonly TextureResults: { readonly $ref: "./global.schema.json#/$defs/TextureResults"; }; readonly DepthID: { readonly description: "Depth ID from the Depth Reference"; readonly type: readonly ["number", "string"]; }; }; }; }; readonly NutrientRecommendations: { readonly $ref: "./global.schema.json#/$defs/NutrientRecommendations"; }; readonly Comments: { readonly $ref: "./global.schema.json#/$defs/Comments"; }; }; }; }; }; }; readonly Plant: { readonly description: "Element to place samples and results from a plant tissue sample event"; readonly type: "object"; readonly properties: { readonly RecommendationRefs: { readonly $ref: "./global.schema.json#/$defs/RecommendationRefs"; }; readonly PlantSamples: { readonly type: "array"; readonly items: { readonly type: "object"; readonly properties: { readonly SampleMetaData: { readonly $ref: "./global.schema.json#/$defs/SampleMetaData"; }; readonly NutrientResults: { readonly $ref: "./global.schema.json#/$defs/NutrientResults"; }; readonly NutrientRecommendations: { readonly $ref: "./global.schema.json#/$defs/NutrientRecommendations"; }; readonly Comments: { readonly $ref: "./global.schema.json#/$defs/Comments"; }; }; }; }; }; }; readonly Nematode: { readonly description: "Element to place samples and results from a nematode sample event"; readonly type: "object"; readonly properties: { readonly DepthRefs: { readonly $ref: "./global.schema.json#/$defs/DepthRefs"; }; readonly NematodeSamples: { readonly type: "array"; readonly items: { readonly type: "object"; readonly properties: { readonly SampleMetaData: { readonly $ref: "./global.schema.json#/$defs/SampleMetaData"; }; readonly Depths: { readonly type: "array"; readonly items: { readonly type: "object"; readonly properties: { readonly NematodeResults: { readonly $ref: "./global.schema.json#/$defs/NematodeResults"; }; readonly DepthID: { readonly type: "integer"; readonly minimum: 1; }; }; }; }; readonly Comments: { readonly $ref: "./global.schema.json#/$defs/Comments"; }; }; }; }; }; }; readonly Water: { readonly type: "object"; readonly properties: { readonly WaterSamples: { readonly type: "array"; readonly items: { readonly type: "object"; readonly properties: { readonly SampleMetaData: { readonly $ref: "./global.schema.json#/$defs/SampleMetaData"; }; readonly Source: { readonly type: "string"; }; readonly NutrientResults: { readonly $ref: "./global.schema.json#/$defs/NutrientResults"; }; readonly Comments: { readonly $ref: "./global.schema.json#/$defs/Comments"; }; }; }; }; }; }; readonly Residue: { readonly type: "object"; readonly properties: { readonly ResidueSamples: { readonly type: "array"; readonly items: { readonly type: "object"; readonly properties: { readonly SampleMetaData: { readonly $ref: "./global.schema.json#/$defs/SampleMetaData"; }; readonly ResidueResults: { readonly $ref: "./global.schema.json#/$defs/ResidueResults"; }; readonly Comments: { readonly $ref: "./global.schema.json#/$defs/Comments"; }; }; }; }; }; }; }; }; readonly Comments: { readonly $ref: "./global.schema.json#/$defs/Comments"; }; readonly ModusSubmit: { readonly $comment: "can hold an entire ModusSubmit document?"; readonly $ref: "./modus-submit.schema.json"; }; }; }; }; readonly Version: { readonly type: "string"; readonly default: "1.0"; }; }; readonly examples: readonly [{ readonly _type: "application/vnd.modus.v1.modus-result+json"; readonly ModusResult: { readonly Events: readonly [{ readonly EventMetaData: { readonly EventCode: "ece3a2a8-4340-48b1-ae1f-d48d1f1e1692"; readonly EventDate: "2021-09-24"; readonly EventType: { readonly Soil: true; }; }; readonly LabMetaData: { readonly LabName: "A & L Great Lakes Laboratories"; readonly LabEventID: "F21267-0039"; readonly Contact: { readonly Name: "A & L Great Lakes Laboratories"; readonly Phone: "260.483.4759"; readonly Address: "3505 Conestoga Dr.\nFort Wayne, IN 46808"; }; readonly ReceivedDate: "2021-09-24T00:00:00.000"; readonly ProcessedDate: "2021-09-28T00:00:00.000"; readonly ClientAccount: { readonly AccountNumber: "30039"; readonly Company: "THE ANDERSONS FARM CTR - GPS"; readonly City: "N MANCHESTER"; readonly State: "IN"; }; readonly Reports: { readonly '1': { readonly LabReportID: "F21271-0035"; }; }; }; readonly FMISMetaData: { readonly FMISEventID: "ece3a2a8-4340-48b1-ae1f-d48d1f1e1692"; readonly FMISProfile: { readonly Grower: "CARL AULT"; readonly Farm: "ENYART EAST 50"; readonly Field: "50.1 AC"; readonly 'Sub-Field': ""; }; }; readonly EventSamples: { readonly Soil: { readonly DepthRefs: { readonly '1': { readonly Name: "Unknown Depth"; readonly StartingDepth: 0; readonly EndingDepth: 8; readonly ColumnDepth: 8; readonly DepthUnit: "in"; }; }; readonly SoilSamples: readonly [{ readonly SampleMetaData: { readonly SampleNumber: 1; readonly ReportID: 28051; }; readonly Depths: readonly [{ readonly DepthID: "1"; readonly NutrientResults: { readonly pH: { readonly Value: 7; readonly ValueUnit: "none"; }; readonly OM: { readonly Value: 2.4; readonly ValueUnit: "%"; }; readonly P: { readonly Value: 34; readonly ValueUnit: "ppm"; }; readonly K: { readonly Value: 161; readonly ValueUnit: "ppm"; }; readonly Ca: { readonly Value: 1150; readonly ValueUnit: "ppm"; }; readonly Mg: { readonly Value: 240; readonly ValueUnit: "ppm"; }; readonly CEC: { readonly Value: 8.2; readonly ValueUnit: "meq/100g"; }; readonly 'BS-Ca': { readonly Value: 70.4; readonly ValueUnit: "%"; }; readonly 'BS-Mg': { readonly Value: 24.5; readonly ValueUnit: "%"; }; readonly 'BS-K': { readonly Value: 5.1; readonly ValueUnit: "%"; }; readonly 'SO4-S': { readonly Value: 7; readonly ValueUnit: "ppm"; }; readonly Zn: { readonly Value: 3.3; readonly ValueUnit: "ppm"; }; readonly Mn: { readonly Value: 46; readonly ValueUnit: "ppm"; }; readonly B: { readonly Value: 0.7; readonly ValueUnit: "ppm"; }; }; }]; }, { readonly SampleMetaData: { readonly SampleNumber: 2; readonly ReportID: 28052; }; readonly Depths: readonly [{ readonly DepthID: "1"; readonly NutrientResults: { readonly pH: { readonly Value: 7.6; readonly ValueUnit: "none"; }; readonly OM: { readonly Value: 2.7; readonly ValueUnit: "%"; }; readonly P: { readonly Value: 30; readonly ValueUnit: "ppm"; }; readonly K: { readonly Value: 190; readonly ValueUnit: "ppm"; }; readonly Ca: { readonly Value: 1950; readonly ValueUnit: "ppm"; }; readonly Mg: { readonly Value: 265; readonly ValueUnit: "ppm"; }; readonly CEC: { readonly Value: 12.4; readonly ValueUnit: "meq/100g"; }; readonly 'BS-Ca': { readonly Value: 78.3; readonly ValueUnit: "%"; }; readonly 'BS-Mg': { readonly Value: 17.7; readonly ValueUnit: "%"; }; readonly 'BS-K': { readonly Value: 3.9; readonly ValueUnit: "%"; }; }; }]; }]; }; }; }]; }; }]; }; /** * Returns true if `val` is a @type `ModusResultSchema`, false otherwise */ export declare function is(val: unknown): val is ModusResultSchema; /** * Asserts that `val` is a @type `ModusResultSchema` */ export declare function assert(val: unknown): asserts val is ModusResultSchema; /** * Modus document for submission of lab results to FMIS * @example * ```json * { * "_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": 28051 * }, * "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": 28052 * }, * "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": "%" * } * } * } * ] * } * ] * } * } * } * ] * } * } * ``` * */ export default ModusResultSchema; export type TestPackageRefs = { TestPackageID?: string; Name?: string; LabBillingCode?: string; [k: string]: unknown; }[]; /** * Place to define a reference list for the depths used in the sample event */ export type DepthRefs = { /** * Name given to the depth to be used for display by FMIS systems. ex Depth 1, 6" */ Name?: string; /** * Depth at the start of the column depth in the DepthUnit */ StartingDepth?: number; /** * Depth at the end of the column depth in the DepthUnit */ EndingDepth?: number; /** * Total column depth (End - Start) in the DepthUnit */ ColumnDepth?: number; /** * Unit the depth is reported in. */ DepthUnit?: string; /** * Unique Sequential ID */ DepthID: number; [k: string]: unknown; }[]; /** * Reference documentation to a lab recommendation */ export type RecommendationRefs = Recommendation[]; /** * Nutrient results of a sample */ export type NutrientResults = { /** * Nutrient Element. See "Element List for Modus.xlsx" for supported elements */ Element?: string; /** * The value of the element */ Value?: number; /** * Unit of measure for the value */ ValueUnit?: string; /** * Analysis Name from "Soil Analysis Nomenclature Modus.xlsx" or "Botanical Analysis Nomenclature Modus.xlsx" */ ModusTestID?: string; /** * Type definition of the value */ ValueType?: 'Measured' | 'Percent' | 'Calculated' | 'Index'; /** * Value description assigned by the lab. */ ValueDesc?: 'Very Low' | 'Low' | 'Medium' | 'Optimum' | 'Very High' | 'VL' | 'L' | 'M' | 'O' | 'VH' | 'High' | 'H'; [k: string]: unknown; }[]; export type TextureResults = { SoilClassification?: string; PercentClay?: string; PercentSilt?: string; PercentSand?: string; Density?: { Value?: number; Unit?: string; [k: string]: unknown; }; [k: string]: unknown; }[]; export type NutrientRecommendations = { RecID?: string; /** * Name of the recommendation element */ Element?: string; /** * Value of the recommendation */ Value?: number; /** * Unit of the recommendation */ ValueUnit?: string; [k: string]: unknown; }[][]; export type NematodeResults = { /** * Name of the pest being reported */ Pest?: string; /** * ModusTestID found in "Nematode Analysis Nomenclature.xlsx" */ ModusTestID?: string; /** * Value/count of the pest */ Value?: number; /** * Unit of the pest value/count */ ValueUnit?: string; /** * Measured, Percent, Calculated, Index */ ValueType?: 'Measured' | 'Percent' | 'Calculated' | 'Index'; ValueDesc?: 'Very Low' | 'Low' | 'Medium' | 'Optimum' | 'Very High' | 'VL' | 'L' | 'M' | 'O' | 'VH'; /** * Place to report the counts of the different life stages */ LifeStageValues?: { /** * Life stage */ LifeStage?: 'Egg' | 'Juvenile' | 'Adult' | 'Dead' | ''; /** * Value/Count of the pest lifestage */ Value?: string; /** * Unit of the value/count */ ValueUnit?: string; /** * Measured, Percent, Calculated, Index */ ValueType?: 'Measured' | 'Percent' | 'Calculated' | 'Index'; ValueDesc?: 'Very Low' | 'Low' | 'Medium' | 'Optimum' | 'Very High' | 'VL' | 'L' | 'M' | 'O' | 'VH'; [k: string]: unknown; }[]; [k: string]: unknown; }[]; export type ResidueResults = { CASRN?: string; Value?: number; ValueUnit?: string; ValueType?: string; ValueDesc?: string; [k: string]: unknown; }[]; /** * Reference documentation for a lab recommendation */ export type RecommendationRequests = Recommendation[]; /** * Modus document for submission of lab results to FMIS */ export interface ModusResultSchema { _type?: 'application/vnd.modus.v1.modus-result+json'; Events?: { EventMetaData?: { /** * Unique human readable code for the sample event. Often referred to a Layer ID */ EventCode?: string; EventType?: EventType; /** * The date the data in event is to expire for use in a recommendation */ EventExpirationDate?: string; [k: string]: unknown; }; LabMetaData?: LabMetaData; FMISMetadata?: FMISMetadata; /** * Element contains the field sample points and data */ EventSamples?: { /** * Element to place samples and results from a soil sample event */ Soil?: { DepthRefs?: DepthRefs; RecommendationRefs?: RecommendationRefs; SoilSamples?: { SampleMetaData?: SampleMetaData; /** * A container for the different depths being reported */ Depths?: { NutrientResults?: NutrientResults; TextureResults?: TextureResults; /** * Depth ID from the Depth Reference */ DepthID?: number | string; [k: string]: unknown; }[]; NutrientRecommendations?: NutrientRecommendations; Comments?: string; [k: string]: unknown; }[]; [k: string]: unknown; }; /** * Element to place samples and results from a plant tissue sample event */ Plant?: { RecommendationRefs?: RecommendationRefs; PlantSamples?: { SampleMetaData?: SampleMetaData; NutrientResults?: NutrientResults; NutrientRecommendations?: NutrientRecommendations; Comments?: string; [k: string]: unknown; }[]; [k: string]: unknown; }; /** * Element to place samples and results from a nematode sample event */ Nematode?: { DepthRefs?: DepthRefs; NematodeSamples?: { SampleMetaData?: SampleMetaData; Depths?: { NematodeResults?: NematodeResults; DepthID?: number; [k: string]: unknown; }[]; Comments?: string; [k: string]: unknown; }[]; [k: string]: unknown; }; Water?: { WaterSamples?: { SampleMetaData?: SampleMetaData; Source?: string; NutrientResults?: NutrientResults; Comments?: string; [k: string]: unknown; }[]; [k: string]: unknown; }; Residue?: { ResidueSamples?: { SampleMetaData?: SampleMetaData; ResidueResults?: ResidueResults; Comments?: string; [k: string]: unknown; }[]; [k: string]: unknown; }; [k: string]: unknown; }; Comments?: string; ModusSubmit?: HttpsFormatsOpenagIoModusV1ModusSubmitSchemaJson; [k: string]: unknown; }[]; Version?: string; [k: string]: unknown; } export interface EventType { Soil?: true; Plant?: { PlantPart?: string; Crop?: Crop; [k: string]: unknown; }; Nematode?: true; Water?: true; Residue?: true; [k: string]: unknown; } export interface Crop { Name?: string; ClientID?: string; GrowthStage?: { Name?: string; ClientID?: string; [k: string]: unknown; }; SubGrowthStage?: { Name?: string; ClientID?: string; [k: string]: unknown; }; [k: string]: unknown; } /** * Metadata related to the testing lab */ export interface LabMetaData { /** * The name of the lab that ran the results */ LabName?: string; /** * ID for the lab that ran the results */ LabID?: string; /** * Internal Lab ID for the event */ LabEventID?: string; /** * Contact information at the lab */ Contact?: { Name?: string; PhoneNumber?: string; Address?: string; [k: string]: unknown; }; TestPackageRefs?: TestPackageRefs; /** * The date/time the sample where received at the lab */ ReceivedDate?: string; /** * The date/time the sample was processed by the lab */ ProcessedDate?: string; /** * List of lab reports */ Reports?: { /** * Incrementing reference number to associate this report data to individual samples */ ReportID?: number | string; /** * ID the lab has assigned to the report */ LabReportID?: string; /** * Description of the report file */ FileDescription?: string; /** * The file data for the report. The lab has the choice to pass a URL or embed the file data. */ File?: { /** * The url path to the report file */ URL?: { /** * The name for the file */ FileName?: string; /** * The path to the file */ Path: string; [k: string]: unknown; }; [k: string]: unknown; } | { /** * The file data */ FileData?: { /** * The name for the file */ FileName?: string; /** * File data base64 encoded */ FileData: string; [k: string]: unknown; }; [k: string]: unknown; }; [k: string]: unknown; }[]; /** * End user lab account information */ ClientAccount?: { AccountNumber?: string; Name?: string; Company?: string; City?: string; State?: string; [k: string]: unknown; }; [k: string]: unknown; } /** * Element that contains data needed for FMIS "Field Management Information Systems" */ export interface FMISMetadata { /** * Unique code for the sample event. Often an internal UUID from an FMIS */ FMISEventID?: string; FMISProfile?: FMISProfile; /** * Lab defined equations that are allowed by the lab to be used in the FMIS */ FMISAllowedLabEquations?: Equation[]; [k: string]: unknown; } /** * Grower/Farm/Field Name and ID's for FMIS */ export interface FMISProfile { 'Grower'?: { name?: string; ID?: string; [k: string]: unknown; }; 'Farm'?: { name?: string; ID?: string; [k: string]: unknown; }; 'Field'?: { name?: string; ID?: string; [k: string]: unknown; }; 'Sub-Field'?: { name?: string; ID?: string; [k: string]: unknown; }; [k: string]: unknown; } /** * Lab equation that is perminited to be used on this data set */ export interface Equation { /** * Name of the equation */ Name?: string; /** * Version of the lab equation */ Version?: string; /** * Set if an equation is to be the default equation */ Default?: boolean; /** * ID of the equation given by the lab */ ID?: string; [k: string]: unknown; } export interface Recommendation { /** * Name for the recommendation */ Name?: string; /** * List of the variables used in the recommendation */ Variables?: { /** * Name of variable used in the recommendation */ Name?: string; /** * Value of the variable used in the recommendation */ Value?: string; /** * Unit of the variable */ Unit?: string; [k: string]: unknown; }[]; Equation?: Equation; /** * Order the FMIS should display the rec in. */ DisplayOrder?: number; /** * The date the rec expires and should no longer be used. */ ExpirationDate?: string; /** * Id to be referenced in the sample */ RecID?: number; [k: string]: unknown; } /** * Metadata for a sample in the sample event */ export interface SampleMetaData { /** * Sample Number give the sample by during sample collection */ SampleNumber?: string; /** * Unique ID assigned by an FMIS for the sample */ FMISSampleID?: string; /** * Unique ID for the sample bag or container. i.e. Bar code */ SampleContainerID?: string; /** * ID number to reference different samples as one group */ SampleGroupID?: number; /** * ID number indicating lab report to which this sample belongs. */ ReportID?: number | string; /** * Flag to indicate if this result is to overwrite any previous results. e.g. for correcting a mistake. */ OverwriteResult?: boolean; /** * WKT Geometry Source: http://en.wikipedia.org/wiki/Well-known_text Limit types to Point, Polygon and MultiPolygon */ Geometry?: { /** * Projection ID of the Geometry Source: http://spatialreference.org/ref/?page=1 Default is WGS84 - Lat,Lon epsg: 4326 */ epsg?: number; [k: string]: unknown; }; /** * Sub Samples is where the location of the cores within a sample can be recorded */ SubSamples?: { /** * ID number assigned during collection. */ SubSampleNumber?: number; /** * Unique ID for the sub-sample assigned by an FMIS */ SubSampleID?: string; /** * WKT Geometry Source: http://en.wikipedia.org/wiki/Well-known_text Limit types to Point, Polygon and MultiPolygon */ Geometry?: { /** * Projection ID of the Geometry Source: http://spatialreference.org/ref/?page=1 Default is WGS84 - Lat,Lon epsg: 4326 */ epsg?: number; [k: string]: unknown; }; [k: string]: unknown; }[]; /** * The lab test packages used for the sample. */ TestPackages?: string[]; [k: string]: unknown; } /** * Modus document for submitting sample events to FMIS */ export interface HttpsFormatsOpenagIoModusV1ModusSubmitSchemaJson { _type?: 'application/vnd.modus.v1.modus-submit+json'; Events?: { EventMetaData?: EventMetaData; LabMetaData?: LabMetaData; FMISMetadata?: FMISMetadata; SubmissionAttributes?: SubmissionAttributes; EventSamples?: { Soil?: { DepthRefs?: DepthRefs; RecommendationRefs?: RecommendationRefs; SoilSamples?: { SampleMetaData?: SampleMetaData; Depths?: { /** * Depth ID from the Depth Reference */ DepthID?: string; [k: string]: unknown; }[]; Comments?: string; [k: string]: unknown; }[]; [k: string]: unknown; }; /** * Element to place samples and results from a plant tissue sample event */ Plant?: { RecommendationRefs?: RecommendationRefs; PlantSamples?: { SampleMetaData?: SampleMetaData; Comments?: string; [k: string]: unknown; }[]; [k: string]: unknown; }; /** * Element to place samples and results from a nematode sample event */ Nematode?: { DepthRefs?: DepthRefs; NematodeSamples?: { SampleMetaData?: SampleMetaData; Depths?: { DepthID?: number; [k: string]: unknown; }[]; Comments?: string; [k: string]: unknown; }[]; [k: string]: unknown; }; Water?: { WaterSamples?: { SampleMetaData?: SampleMetaData; Source?: string; NutrientResults?: NutrientResults; Comments?: string; [k: string]: unknown; }[]; [k: string]: unknown; }; Residue?: { ResidueSamples?: { SampleMetaData?: SampleMetaData; ResidueResults?: ResidueResults; Comments?: string; [k: string]: unknown; }[]; [k: string]: unknown; }; [k: string]: unknown; }; Comments?: string; ModusSubmit?: HttpsFormatsOpenagIoModusV1ModusSubmitSchemaJson1; [k: string]: unknown; }[]; Version?: string; [k: string]: unknown; } export interface EventMetaData { /** * Unique human readable code for the sample event. Often referred to a Layer ID */ EventCode?: string; /** * Date the sample event was collected in the field */ EventDate?: string; EventType?: EventType; /** * The date the data in the even is to expire for use in a recommendation */ EventExpirationDate?: string; [k: string]: unknown; } /** * Attributes that needed to be passed through for reference and recommendation. */ export interface SubmissionAttributes { /** * Person submiting the sample */ SubmittedBy?: string; /** * Person or company the sample is being submitted for. */ SubmittedFor?: string; SiteAttributes?: SiteAttributes; RecommendationRequests?: RecommendationRequests; [k: string]: unknown; } /** * Attributes that are collected for the site the sample are collected from. */ export interface SiteAttributes { Tillage?: string; Irrigated?: boolean; Tilled?: boolean; PrevCrop?: string; /** * Used to store additional variables to be passed through */ Variables?: { Name?: string; Value?: string; Unit?: string; [k: string]: unknown; }[]; [k: string]: unknown; } /** * Modus document for submitting sample events to FMIS */ export interface HttpsFormatsOpenagIoModusV1ModusSubmitSchemaJson1 { _type?: 'application/vnd.modus.v1.modus-submit+json'; Events?: { EventMetaData?: EventMetaData; LabMetaData?: LabMetaData; FMISMetadata?: FMISMetadata; SubmissionAttributes?: SubmissionAttributes; EventSamples?: { Soil?: { DepthRefs?: DepthRefs; RecommendationRefs?: RecommendationRefs; SoilSamples?: { SampleMetaData?: SampleMetaData; Depths?: { /** * Depth ID from the Depth Reference */ DepthID?: string; [k: string]: unknown; }[]; Comments?: string; [k: string]: unknown; }[]; [k: string]: unknown; }; /** * Element to place samples and results from a plant tissue sample event */ Plant?: { RecommendationRefs?: RecommendationRefs; PlantSamples?: { SampleMetaData?: SampleMetaData; Comments?: string; [k: string]: unknown; }[]; [k: string]: unknown; }; /** * Element to place samples and results from a nematode sample event */ Nematode?: { DepthRefs?: DepthRefs; NematodeSamples?: { SampleMetaData?: SampleMetaData; Depths?: { DepthID?: number; [k: string]: unknown; }[]; Comments?: string; [k: string]: unknown; }[]; [k: string]: unknown; }; Water?: { WaterSamples?: { SampleMetaData?: SampleMetaData; Source?: string; NutrientResults?: NutrientResults; Comments?: string; [k: string]: unknown; }[]; [k: string]: unknown; }; Residue?: { ResidueSamples?: { SampleMetaData?: SampleMetaData; ResidueResults?: ResidueResults; Comments?: string; [k: string]: unknown; }[]; [k: string]: unknown; }; [k: string]: unknown; }; Comments?: string; ModusSubmit?: HttpsFormatsOpenagIoModusV1ModusSubmitSchemaJson1; [k: string]: unknown; }[]; Version?: string; [k: string]: unknown; }