LabVantage Solutions Tests API

openapi: 3.1.0
info:
  title: LabVantage LIMS Containers Tests API
  description: LabVantage LIMS (Laboratory Information Management System) REST API for sample management, test result recording, instrument integration, and regulatory compliance data exchange. Supports GxP-compliant workflows for pharmaceutical, biotech, and clinical laboratory environments. The LabVantage REST API provides access to samples, tests, results, containers, and laboratory schedules via JSON over HTTPS.
  version: 8.8.0
  contact:
    name: LabVantage Customer Care
    url: https://www.labvantage.com/services/customer-care/
  license:
    name: LabVantage License
    url: https://www.labvantage.com/privacy-policy/
servers:
- url: https://{instance}.labvantage.example.com/labvantage/rest/v1
  description: LabVantage LIMS REST API
  variables:
    instance:
      default: yourlab
      description: LabVantage instance hostname prefix
security:
- BasicAuth: []
- BearerAuth: []
tags:
- name: Tests
  description: Test requests and analytical procedures
paths:
  /samples/{sampleId}/tests:
    get:
      operationId: listSampleTests
      summary: List tests for a sample
      description: Returns all test requests associated with a sample including status, assigned analyst, and results.
      tags:
      - Tests
      parameters:
      - name: sampleId
        in: path
        required: true
        schema:
          type: string
      - name: status
        in: query
        schema:
          type: string
          enum:
          - Pending
          - In Progress
          - Complete
          - Cancelled
      responses:
        '200':
          description: Tests returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestList'
    post:
      operationId: requestTest
      summary: Request a test
      description: Creates a new test request for a sample. The test method must be defined in the LabVantage method library.
      tags:
      - Tests
      parameters:
      - name: sampleId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TestRequest'
      responses:
        '201':
          description: Test request created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Test'
        '400':
          description: Invalid test request
components:
  schemas:
    TestList:
      type: object
      properties:
        tests:
          type: array
          items:
            $ref: '#/components/schemas/Test'
        total:
          type: integer
    Test:
      type: object
      properties:
        testId:
          type: string
        sampleId:
          type: string
        testMethod:
          type: string
          description: Test method code
        testMethodDescription:
          type: string
        status:
          type: string
          enum:
          - Pending
          - Scheduled
          - In Progress
          - Complete
          - Cancelled
          - Failed
        priority:
          type: string
          enum:
          - ROUTINE
          - URGENT
          - STAT
        requestedDate:
          type: string
          format: date-time
        scheduledDate:
          type: string
          format: date-time
        completedDate:
          type: string
          format: date-time
        assignedAnalyst:
          type: string
        instrumentId:
          type: string
        overallResult:
          type: string
          enum:
          - PASS
          - FAIL
          - OOS
          - PENDING
        results:
          type: array
          items:
            $ref: '#/components/schemas/Result'
    Result:
      type: object
      properties:
        resultId:
          type: string
        testId:
          type: string
        parameterName:
          type: string
          description: Test parameter name
        resultValue:
          type: string
          description: Entered result value (stored as string to handle numeric, text, and list values)
        resultNumeric:
          type: number
          description: Numeric interpretation of the result value
        unit:
          type: string
          description: Unit of measure
        specMin:
          type: number
          description: Specification lower limit
        specMax:
          type: number
          description: Specification upper limit
        specText:
          type: string
          description: Text specification (for non-numeric results)
        status:
          type: string
          enum:
          - PASS
          - FAIL
          - OOS
          - INCONCLUSIVE
          - PENDING
        enteredBy:
          type: string
        enteredDate:
          type: string
          format: date-time
        approvedBy:
          type: string
        approvedDate:
          type: string
          format: date-time
    TestRequest:
      type: object
      required:
      - testMethod
      properties:
        testMethod:
          type: string
          description: Test method code from the LabVantage method library
        priority:
          type: string
          enum:
          - ROUTINE
          - URGENT
          - STAT
          default: ROUTINE
        dueDate:
          type: string
          format: date-time
        assignedAnalyst:
          type: string
        instrumentId:
          type: string
        notes:
          type: string
  securitySchemes:
    BasicAuth:
      type: http
      scheme: basic
      description: HTTP Basic Authentication (username:password)
    BearerAuth:
      type: http
      scheme: bearer
      description: Bearer token authentication
externalDocs:
  description: LabVantage Documentation
  url: https://www.labvantage.com/