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/obx
Lab credential
text/plain

Body

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

string(OBX) string(OBX)

An OBX Segment of an HL7 ORU R1 message (see https://wiki.hl7.de/index.php?title=Segment_OBX for details), or an LDT message

Responses

  • • 200

    Result uploaded successfully

  • • 400

    Invalid OBX message

  • • 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/obx 
curl \
 -X PUT https://api.labres.dev.healthmetrix.com/v1/results/obx \
 -H "Authorization: $API_KEY" \
 -H "Content-Type: text/plain" \
 -d '"string"'
Request example 
"string"
Response examples (500) 
{
  "message": "string"
}