Skip to main content

LabTestBasePostfix

Base Lab Test properties, declared after the Product list

sampleReceiptDatestring<date>nullable

Date when sample was received (required for creating a completed lab test)

reportIssueDatestring<date>nullable

Date when report was issued (required for creating a completed lab test)

reportNumberstringnullable

Report number (required for creating a completed lab test)

originalReportNumberstringnullable

Original report number (required for creating a completed lab test)

revisionNumberintegernullable

Revision number (required for creating a completed lab test)

Possible values: >= 0

Default value: 0
testPackages object[]nullable

Test packages

  • Array [
    • idstringrequired

    Possible values: <= 255 characters

    namestringnullable

    Possible values: <= 255 characters

    Default value:
  • ]
    • testProperties object[]nullable

    Test properties (required for creating a completed lab test)

  • Array [
    • oneOf
    idstringrequired
    namestringrequired
    testPackageIdstringnullable
    testCategoryIdstringnullable
    testSubcategoryIdstringnullable
    testMethodstringnullable
    resultstringnullable

    Possible values: [pass, fail, data, na]

    reviewResultstringnullable

    Possible values: <= 255 characters

    items object[]nullable
  • Array [
    • itemIdstringnullable
    testConditions object[]nullable
  • Array [
    • idstringnullable
    namestringnullable
    resultResultEnumnullable

    Possible values: [pass, fail, data, na]

    samples object[]nullable

    Test condition readings and the samples each one applies to.

    Send only one of these two fields, never both:

    • sampleNames when the Lab Test Form includes the Sample Information component.
    • sampleNumbers when it does not.
  • Array [
    • datastringnullable

    The reading recorded for these samples.

    Example: Grade 4-5
    resultstringrequired

    The outcome recorded for these samples.

    Possible values: [pass, fail, data]

    Example: pass
    sampleNumbersinteger[]

    Samples identified by position in the Product's sample list, counting from 1. A number greater than the Product's sample size is rejected.

    Example: [1,2]
    sampleNamesstring[]

    Samples identified by their sampleName on the Product. Each name must match one of the Product's samples: names are checked against the samples sent in the same request when the request carries the Product, and against the Product's stored samples otherwise.

    Example: ["Lot A","Lot B"]
  • ]
    • followUpAction objectnullable
    commentstringnullable
    attachments object[]nullable
  • Array [
    • fileIdstring<uuid>required
    labelstringnullable
  • ]
    • failureCategoryIdstringnullable
    failureCategoryNamestringnullable
    failureIdstringnullable
    failureNamestringnullable
    failureSeveritystringnullable

    Possible values: [critical, major, minor]

  • ]
  • ]
  • ]
    • overallResult objectnullable

    Overall test result (required for creating a completed lab test)

    resultResultEnumrequired

    Possible values: [pass, fail, data, na]

    reviewResultstringnullable

    Possible values: <= 255 characters

    attachments object[]nullable

    Attached files for Test Report (type "testReport") or General Lab Test Information (type "others").

  • Array [
    • fileIdstringrequired

    Possible values: <= 64 characters

    typeTypeEnumrequired

    Possible values: [testReport, others]

    labelstringnullable

    Possible values: <= 255 characters

    Default value:
  • ]
    • LabTestBasePostfix
    {
      "sampleReceiptDate": "2024-07-29",
      "reportIssueDate": "2024-07-29",
      "reportNumber": "string",
      "originalReportNumber": "string",
      "revisionNumber": 0,
      "testPackages": [
        {
          "id": "string",
          "name": ""
        }
      ],
      "testProperties": [
        {
          "id": "string",
          "name": "string",
          "testPackageId": "string",
          "testCategoryId": "string",
          "testSubcategoryId": "string",
          "testMethod": "string",
          "result": "pass",
          "reviewResult": "string",
          "items": [
            {
              "itemId": "string",
              "testConditions": [
                {
                  "id": "string",
                  "name": "string",
                  "result": "pass",
                  "samples": [
                    {
                      "data": "Grade 4-5",
                      "result": "pass",
                      "sampleNumbers": [
                        1,
                        2
                      ],
                      "sampleNames": [
                        "Lot A",
                        "Lot B"
                      ]
                    }
                  ],
                  "followUpAction": {
                    "comment": "string",
                    "attachments": [
                      {
                        "fileId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                        "label": "string"
                      }
                    ],
                    "failureCategoryId": "string",
                    "failureCategoryName": "string",
                    "failureId": "string",
                    "failureName": "string",
                    "failureSeverity": "critical"
                  }
                }
              ]
            }
          ]
        },
        {
          "id": "string",
          "name": "string",
          "testPackageId": "string",
          "testCategoryId": "string",
          "testSubcategoryId": "string",
          "testMethod": "string",
          "result": "pass",
          "reviewResult": "string",
          "materials": [
            {
              "materialId": "string",
              "testConditions": [
                {
                  "id": "string",
                  "name": "string",
                  "result": "pass",
                  "samples": [
                    {
                      "data": "Grade 4-5",
                      "result": "pass",
                      "sampleNumbers": [
                        1,
                        2
                      ],
                      "sampleNames": [
                        "Lot A",
                        "Lot B"
                      ]
                    }
                  ],
                  "followUpAction": {
                    "comment": "string",
                    "attachments": [
                      {
                        "fileId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                        "label": "string"
                      }
                    ],
                    "failureCategoryId": "string",
                    "failureCategoryName": "string",
                    "failureId": "string",
                    "failureName": "string",
                    "failureSeverity": "critical"
                  }
                }
              ]
            }
          ]
        },
        {
          "id": "string",
          "name": "string",
          "testPackageId": "string",
          "testCategoryId": "string",
          "testSubcategoryId": "string",
          "testMethod": "string",
          "result": "pass",
          "reviewResult": "string",
          "styles": [
            {
              "styleId": "string",
              "testConditions": [
                {
                  "id": "string",
                  "name": "string",
                  "result": "pass",
                  "samples": [
                    {
                      "data": "Grade 4-5",
                      "result": "pass",
                      "sampleNumbers": [
                        1,
                        2
                      ],
                      "sampleNames": [
                        "Lot A",
                        "Lot B"
                      ]
                    }
                  ],
                  "followUpAction": {
                    "comment": "string",
                    "attachments": [
                      {
                        "fileId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                        "label": "string"
                      }
                    ],
                    "failureCategoryId": "string",
                    "failureCategoryName": "string",
                    "failureId": "string",
                    "failureName": "string",
                    "failureSeverity": "critical"
                  }
                }
              ]
            }
          ]
        }
      ],
      "overallResult": {
        "result": "pass",
        "reviewResult": "string"
      },
      "attachments": [
        {
          "fileId": "string",
          "type": "testReport",
          "label": ""
        }
      ]
    }