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

Allows for uploading a result of a lab order

PUT /results/json
Lab credential
application/json

Body

Lab result as JSON object. Body must include either external or internal order numbers. In the case of internal, lab ID is taken from authorization headers.

  • result string Required

    The lab result.

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

Responses

  • • 200

    Result uploaded successfully

  • • 401

    API key invalid or missing

    Hide headers attribute Show headers attribute
  • • 404

    no order for external order number found

  • • 500

    General error response body

    Hide response attribute Show response attribute object
PUT /results/json 
curl \
 -X PUT https://api.labres.dev.healthmetrix.com/v1/results/json \
 -H "Authorization: $API_KEY" \
 -H "Content-Type: application/json" \
 -d '{"result":"POSITIVE"}'
Request example 
{
  "result": "POSITIVE"
}
Response examples (500) 
{
  "message": "string"
}