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

Issues a new globally unique External Order Number (EON). The number of issuing EONs is limited to 3 per subject.

POST /orders
Orders api token

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

application/json

Body

  • notificationId string

    Optional notification ID sent from Data4Life that can be used later to notify them that lab results have been uploaded.

Responses

  • • 201

    OK

    Hide response attributes Show response attributes object
    • id string(UUID)

      A unique internal identifier for the order

    • externalOrderNumber string(externalOrderNumber)

      numeric 8-digit-long identifier
  • • 401

    API key invalid or missing

    Hide headers attribute Show headers attribute
  • • 500

    General error response body

    Hide response attribute Show response attribute object
POST /orders 
curl \
 -X POST https://api.labres.dev.healthmetrix.com/v1/orders \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"notificationId":"string"}'
Request example 
{
  "notificationId": "string"
}
Response examples (201) 
{
  "id": "65e524cb-7494-4073-ad16-495fed0d79e4",
  "externalOrderNumber": "X72UN3K8"
}
Response examples (500) 
{
  "message": "string"
}