lab-res API - Beta
1

LabRes provides an API to establish a direct connection between laboratory results and citizens.

This is the documentation for version 1 of the API. Last update on Apr 21, 2020.

Base URL 
https://api.labres.dev.healthmetrix.com/v1

Returns the current status of a given lab order

GET /orders/{orderId}
Orders api token

Should only be invoked for verified users (logged into account or verified email address)

Path parameters

  • orderId string(uuid) Required

    UUID of an order that has been sent to a lab

Responses

  • • 200

    returns current status of the lab order

    Hide response attribute Show response attribute object
    • status string

      Status enum to indicate if the lab result is in progress, sample material has been found invalid, or if it has a positive or negative result

      Values are POSITIVE, WEAK_POSITIVE, NEGATIVE, INVALID, or IN_PROGRESS.
  • • 401

    API key invalid or missing

    Hide headers attribute Show headers attribute
  • • 404

    no order for the given id found

  • • 500

    General error response body

    Hide response attribute Show response attribute object
GET /orders/{orderId} 
curl \
 -X GET https://api.labres.dev.healthmetrix.com/v1/orders/{orderId} \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "status": "POSITIVE"
}
Response examples (500) 
{
  "message": "string"
}