Telehealth Public APIs
  1. General APIs
Telehealth Public APIs
  • Introduction
  • SSO Login
    • Generate SSO token
      POST
    • SSO Login
      GET
  • General APIs
    • Create Patient
      POST
    • Upload Patient File
      POST
    • Submit Patient's Form Response
      POST
    • Lab readings
      POST
    • Assign Service to Patient
      POST
    • Create Patient's Chart Note
      POST
    • Get Provider's Appointment Slots
      POST
    • Provider Sign Up
      POST
    • GraphQL Get Patient(s)
      POST
  1. General APIs

Lab readings

POST
/api/service/v1/patient/lab-reports
Used to take lab readings.
Path Variables: None
Query Parameters: None
Body Parameters:
FieldTypeDescription
patient_idIntegerRequired. Id of patient.
resourceTypeStringRequired.
observationsArrayRequired. Array of observation objects.
observation.idStringRequired.
observation.resourceTypeStringRequired.
observation.bioMarkerStringRequired.
observation.resultStringRequired.
observation.unitStringRequired.
observation.flagStringRequired.
observation.referenceRangeHighDecimalRequired.
observation.referenceRangeLowDecimalRequired.
observation.effectiveDateTimeDateTimeRequired.
Example Request:
{

"patient_id": 201700000004,
"resourceType" : "DiagnosticReport",
"observations" : [
{
"id": "0432826d-b0c0-4293-aadb-6aa683ccae60",
"resourceType": "Observation",
"bioMarker" : "Hemoglobin A1c/Hemoglobin.total in Blood",
"result" : 36.45,
"unit" : "ng/mL",
"flag" : "MEDIUM",
"referenceRangeLow" : 25.00,
"referenceRangeHigh" : 100.00,
"effectiveDateTime": "2021-09-23T03:40:49.021314+00:00"
},
{
"id": "0432826d-b0c0-4293-aadb-6aa683232323",
"resourceType": "Observation",
"bioMarker" : "Vitamin D+Metabolites [Mass/Vol]",
"result" : 45.80,
"unit" : "ng/mL",
"flag" : "HIGH",
"referenceRangeLow" : 25.00,
"referenceRangeHigh" : 100.00,
"effectiveDateTime": "2021-09-23T03:40:49.021314+00:00"
},
{
"id": "0432826d-b0c0-4293-aadb-6aa683fgsdfg",
"resourceType": "Observation",
"bioMarker" : "Cobalamin (Vitamin B12) [Mass/volume] in Blood",
"result" : 26.00,
"unit" : "ng/mL",
"flag" : "LOW",
"referenceRangeLow" : 25.00,
"referenceRangeHigh" : 100.00,
"effectiveDateTime": "2021-09-23T03:40:49.021314+00:00"
},
]
}
Example Success Response:
Status: 200
{

"error": false,
"input_data": true
}
Example Failure Response:
Status: 400 or 500
{

"error": true,
"input_data": {
"error_message": "The selected patient id is invalid. "
}
}

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Header Params

Body Params text/plain
Example
Example:{ "patient_id": 201800014555, "resourceType" : "DiagnosticReport", "observations" : [ { "id": "0432826d-b0c0-4293-aadb-6aa683ccae60", "resourceType": "Observation", "bioMarker" : "Hemoglobin A1c/Hemoglobin.total in Blood", "result" : 36.45, "unit" : "ng/mL", "flag" : "MEDIUM", "referenceRangeLow" : 25.00, "referenceRangeHigh" : 100.00, "effectiveDateTime": "2021-09-23T03:40:49.021314+00:00" }, { "id": "0432826d-b0c0-4293-aadb-6aa683232323", "resourceType": "Observation", "bioMarker" : "Vitamin D+Metabolites [Mass/Vol]", "result" : 45.80, "unit" : "ng/mL", "flag" : "HIGH", "referenceRangeLow" : 25.00, "referenceRangeHigh" : 100.00, "effectiveDateTime": "2021-09-23T03:40:49.021314+00:00" }, { "id": "0432826d-b0c0-4293-aadb-6aa683fgsdfg", "resourceType": "Observation", "bioMarker" : "Cobalamin (Vitamin B12) [Mass/volume] in Blood", "result" : 26.00, "unit" : "ng/mL", "flag" : "LOW", "referenceRangeLow" : 25.00, "referenceRangeHigh" : 100.00, "effectiveDateTime": "2021-09-23T03:40:49.021314+00:00" } ] }

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/api/service/v1/patient/lab-reports' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
	"patient_id": 201800014555,
	"resourceType" : "DiagnosticReport",
	"observations" : [
		{
			"id": "0432826d-b0c0-4293-aadb-6aa683ccae60",
			"resourceType": "Observation",
			"bioMarker" : "Hemoglobin A1c/Hemoglobin.total in Blood",
			"result" : 36.45,
			"unit" : "ng/mL",
			"flag" : "MEDIUM",
            "referenceRangeLow" : 25.00,
			"referenceRangeHigh" : 100.00,
            "effectiveDateTime": "2021-09-23T03:40:49.021314+00:00"
		},
		{
			"id": "0432826d-b0c0-4293-aadb-6aa683232323",
			"resourceType": "Observation",
			"bioMarker" : "Vitamin D+Metabolites [Mass/Vol]",
			"result" : 45.80,
			"unit" : "ng/mL",
			"flag" : "HIGH",
			"referenceRangeLow" : 25.00,
			"referenceRangeHigh" : 100.00,
            "effectiveDateTime": "2021-09-23T03:40:49.021314+00:00"
		},
		{
			"id": "0432826d-b0c0-4293-aadb-6aa683fgsdfg",
			"resourceType": "Observation",
			"bioMarker" : "Cobalamin (Vitamin B12) [Mass/volume] in Blood",
			"result" : 26.00,
			"unit" : "ng/mL",
			"flag" : "LOW",
			"referenceRangeLow" : 25.00,
			"referenceRangeHigh" : 100.00,
            "effectiveDateTime": "2021-09-23T03:40:49.021314+00:00"
		}
	]
}'

Responses

🟢200Lab readings
application/json
Body

Example
{
    "error": false,
    "input_data": true
}
Modified at 2024-10-16 09:00:47
Previous
Submit Patient's Form Response
Next
Assign Service to Patient
Built with