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

Updates an order with the notification id

PUT /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

application/json

Body Required

  • notificationId string Required

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

Responses

  • • 200

    Successful update

  • • 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
PUT /orders/{orderId} 
curl \
 -X PUT https://api.labres.dev.healthmetrix.com/v1/orders/{orderId} \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"notificationId":"string"}'
Request example 
{
  "notificationId": "string"
}
Response examples (500) 
{
  "message": "string"
}