erblue Logo
API docs by Redocly

LOMS Integration API (2.0.0)

Download OpenAPI specification:

erblue Support: support@erblue.com License: proprietary Terms of Service

Overview and key workflows

Lab Order Management System API Documentation. This API provides endpoints to manage laboratory orders and their results.

1. Get Latest Updates & Retrieve Orders

  • Fetch Updates:
    • Periodically poll for changes using GET /labs/{labId}/lab-orders/updates?since={timestamp}
    • Returns a list of reservation codes for orders that have been created or modified
  • List Orders:
    • When updates are found, retrieve full order details using GET /labs/{labId}/lab-orders?reservationCodes=code1,code2
    • Returns complete order information including samples, documents, and results for the specified orders
  • Update Order Status:
    • Update the status to In Progress of an order using PUT /labs/{labId}/lab-orders/{reservationCode}/status

2. Upload Sample Results Document

  • Get a pre-signed URL for results PDF (GET /labs/{labId}/lab-orders/{reservationCode}/documents/upload-sample-results-url)
  • Upload the document to the pre-signed URL
  • Confirm the upload (POST /labs/{labId}/lab-orders/{reservationCode}/documents/upload-sample-results-url)

3. Update Order Sample Results

  • Upload sample results for an existing order POST /v1/labs/{labId}/lab-orders/{reservationCode}/samples/results

Lab Orders

API endpoints for managing lab orders and their samples and results

Get lab orders

Retrieves a list of lab orders by reservation codes

Authorizations:
BearerAuth
path Parameters
labId
required
string

Your lab organization id

query Parameters
reservationCode
required
Array of strings

Filter orders by reservation code(s). Can be a single code or comma-separated list

Responses

Request samples 

curl --request GET \
  --url 'https://loms-api.erblue.com/v1/labs/%7BlabId%7D/lab-orders?reservationCode=SOME_ARRAY_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
[
  • {
    }
]

Get a specific lab order

Retrieves a lab order by reservation code

Authorizations:
BearerAuth
path Parameters
labId
required
string

Your lab organization id

reservationCode
required
string

Reservation code for the lab order

Responses

Request samples 

curl --request GET \
  --url https://loms-api.erblue.com/v1/labs/%7BlabId%7D/lab-orders/%7BreservationCode%7D \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "billing_id": "string",
  • "lab_location_id": "string",
  • "billing_to_id": "string",
  • "reservation_code": "string",
  • "status": "Submitted",
  • "project_name": "string",
  • "lab_order_id": "string",
  • "inspector_name": "string",
  • "inspector_email": "string",
  • "po_number": "string",
  • "project_id": "string",
  • "special_instructions": "string",
  • "address1": "string",
  • "address2": "string",
  • "city": "string",
  • "state_province": "string",
  • "zip_postal": "string",
  • "country": "string",
  • "submitted_at": "2019-08-24T14:15:22Z",
  • "samples": [
    ],
  • "results": [
    ]
}

Update lab order status

Updates a lab order status by reservation code

Authorizations:
BearerAuth
path Parameters
labId
required
string

Your lab organization id

reservationCode
required
string

Reservation code for the lab order

Request Body schema: application/json
required
status
required
string
Enum: "Submitted" "In Progress" "Completed" "Cancelled"

The current status of the order

Responses

Request samples

Content type
application/json
{
  • "status": "Submitted"
}

Lab Order Updates

API endpoints for fetching lab order updates

Get lab order updates

Retrieves a list of lab orders updates since timestamp

Authorizations:
BearerAuth
path Parameters
labId
required
string

Your lab organization id

query Parameters
since
required
string <date-time>

Filter orders updated after this timestamp (ISO 8601 format)

locationId
string

Filter orders updates by location id

Responses

Request samples 

curl --request GET \
  --url 'https://loms-api.erblue.com/v1/labs/%7BlabId%7D/lab-orders/updates?since=SOME_STRING_VALUE&locationId=SOME_STRING_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
[
  • {
    }
]

Lab Order Documents

API endpoints for managing lab order documents

Get URL to download Chain of Custody document

Retrieves a lab order coc download url by reservation code

Authorizations:
BearerAuth
path Parameters
labId
required
string

Your lab organization id

reservationCode
required
string

Reservation code for the lab order

Responses

Request samples 

curl --request GET \
  --url https://loms-api.erblue.com/v1/labs/%7BlabId%7D/lab-orders/%7BreservationCode%7D/documents/download-coc-url \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "url": "string"
}

Get URL to upload sample results document

Retrieves a lab order sample results upload url by reservation code

Authorizations:
BearerAuth
path Parameters
labId
required
string

Your lab organization id

reservationCode
required
string

Reservation code for the lab order

Responses

Request samples 

curl --request GET \
  --url https://loms-api.erblue.com/v1/labs/%7BlabId%7D/lab-orders/%7BreservationCode%7D/documents/upload-sample-results-url \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "url": "string",
  • "identifier": "string"
}

Confirm sample results document upload

Completes a lab order sample results upload by reservation code

Authorizations:
BearerAuth
path Parameters
labId
required
string

Your lab organization id

reservationCode
required
string

Reservation code for the lab order

Request Body schema: application/json
required
identifier
required
string

Lab order sample results upload identifier

Responses

Request samples

Content type
application/json
{
  • "identifier": "string"
}

Lab Order Sample Results

API endpoints for managing lab order sample results

Get lab order sample results

Retrieves a lab order samples results by reservation code

Authorizations:
BearerAuth
path Parameters
labId
required
string

Your lab organization id

reservationCode
required
string

Reservation code for the lab order

Responses

Request samples 

curl --request GET \
  --url https://loms-api.erblue.com/v1/labs/%7BlabId%7D/lab-orders/%7BreservationCode%7D/samples/results \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
[
  • {
    }
]

Update a lab order samples results

Updates a lab order samples results for a given reservation code

Authorizations:
BearerAuth
path Parameters
labId
required
string

Your lab organization id

reservationCode
required
string

Reservation code for the lab order

Request Body schema: application/json
required
Array
lab_sample_id
required
string

A unique identifier assigned to the sample by the laboratory.

lab_test_method
required
string

The specific laboratory method or protocol used to analyze the sample.

aliquot_id
required
string

A unique identifier for an aliquot of the sample.

result_qualifier
string
Enum: "<" ">"

Indicates additional information or qualifiers about the result value.

result_value
required
number

The numerical result of the analysis.

result_type
required
string

Classification of the type of result being reported.

unit
required
string

The unit of measurement for the result value.

mrl_value
required
number

The minimum reporting limit (MRL) for the analysis.

identifier
required
string

A unique identifier representing the type of analysis or target.

analysis_date
required
string <date-time>

The date and time when the analysis was completed.

comment
string

Any additional notes or observations about the result or analysis.

result_status
required
string
Enum: "Analyzed" "Not Analyzed"

The current sample result status of the sample.

customer_sample_id
required
string

The unique identifier for the sample as provided by the customer.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]