Get record
curl --request GET \
--url https://vitalog-api.example.com/v1/records/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://vitalog-api.example.com/v1/records/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://vitalog-api.example.com/v1/records/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://vitalog-api.example.com/v1/records/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://vitalog-api.example.com/v1/records/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://vitalog-api.example.com/v1/records/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://vitalog-api.example.com/v1/records/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"catalog_version": "1.0.4",
"record": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"record_type": "measurement",
"version": 123,
"occurred_on": "2023-12-25",
"occurred_at": "2023-11-07T05:31:56Z",
"ended_at": "2023-11-07T05:31:56Z",
"timezone": "<string>",
"time_precision": "date",
"date_basis": "reported_date",
"recorded_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"status": "active",
"validity": "valid",
"provenance": {
"source_type": "manual",
"value_kind": "measured",
"source_description": "<string>",
"source_locator": "<string>",
"assumptions": [
"<string>"
],
"field_overrides": {}
},
"schema_version": 2,
"data": {
"kind": "scalar",
"metric_key": "weight",
"value": 123,
"unit": "<string>",
"original_value": "<string>",
"original_unit": "<string>",
"comparator": "eq",
"uncertainty": {
"note": "<string>",
"confidence_label": "<string>",
"lower": 123,
"upper": 123,
"original_value_text": "<string>"
},
"specimen": "whole_blood",
"specimen_context": {
"type": "whole_blood",
"site": "<string>",
"collection_method": "<string>",
"collection_context": "spot",
"container": "<string>",
"additive": "<string>",
"quality_flags": [
"<string>"
],
"duration_seconds": 1,
"volume": {
"kind": "quantity",
"value": 123,
"unit": "<string>",
"original_unit": "<string>",
"original_value": "<string>",
"comparator": "eq",
"reported_precision": 7
}
},
"measurement_site": "<string>",
"body_region": "<string>",
"laterality": "left",
"body_position": "seated",
"method": {
"name": "<string>",
"assay": "<string>",
"assay_version": "<string>",
"instrument": "<string>",
"model": "<string>",
"firmware_version": "<string>",
"software_version": "<string>",
"equation": "<string>",
"reference_basis": "<string>",
"calibration": "<string>"
},
"device_context": {
"name": "<string>",
"assay": "<string>",
"assay_version": "<string>",
"instrument": "<string>",
"model": "<string>",
"firmware_version": "<string>",
"software_version": "<string>",
"equation": "<string>",
"reference_basis": "<string>",
"calibration": "<string>"
},
"resting_state": "resting",
"fasting_state": "fasting",
"meal_state": "fasting",
"time_since_meal_minutes": 1,
"challenge_context": {
"label": "<string>",
"dose": {
"kind": "quantity",
"value": 123,
"unit": "<string>",
"original_unit": "<string>",
"original_value": "<string>",
"comparator": "eq",
"reported_precision": 7
},
"elapsed_seconds": 1,
"procedure": "<string>"
},
"hydration_context": "<string>",
"exercise_context": "<string>",
"oxygen_context": {
"support": "room_air",
"flow": {
"kind": "quantity",
"value": 123,
"unit": "<string>",
"original_unit": "<string>",
"original_value": "<string>",
"comparator": "eq",
"reported_precision": 7
},
"fio2": {
"kind": "quantity",
"value": 123,
"unit": "<string>",
"original_unit": "<string>",
"original_value": "<string>",
"comparator": "eq",
"reported_precision": 7
}
},
"temperature_site": "<string>",
"source_reference_range": {
"lower": 123,
"upper": 123,
"lower_inclusive": true,
"upper_inclusive": true,
"unit": "<string>",
"text": "<string>",
"age_band": {
"unit": "years",
"lower": 1,
"upper": 1
},
"sex_context": "<string>",
"specimen": "whole_blood",
"method": "<string>",
"fasting_state": "<string>",
"pregnancy_context": "<string>",
"gestational_context": "<string>",
"source_version": "<string>"
},
"reported_predicted_value": {
"kind": "quantity",
"value": 123,
"unit": "<string>",
"original_unit": "<string>",
"original_value": "<string>",
"comparator": "eq",
"reported_precision": 7
},
"reported_percent_predicted": 1,
"reported_lower_limit_normal": {
"kind": "quantity",
"value": 123,
"unit": "<string>",
"original_unit": "<string>",
"original_value": "<string>",
"comparator": "eq",
"reported_precision": 7
},
"reported_z_score": 123,
"reference_equation": {
"name": "<string>",
"assay": "<string>",
"assay_version": "<string>",
"instrument": "<string>",
"model": "<string>",
"firmware_version": "<string>",
"software_version": "<string>",
"equation": "<string>",
"reference_basis": "<string>",
"calibration": "<string>"
},
"classification_metadata": {
"frequency_hz": 1,
"conduction": "air",
"masking": true,
"corrected_vision": true,
"viewing_distance": {
"kind": "quantity",
"value": 123,
"unit": "<string>",
"original_unit": "<string>",
"original_value": "<string>",
"comparator": "eq",
"reported_precision": 7
},
"qt_correction_formula": "<string>",
"lead": "<string>",
"rhythm_context": "<string>",
"beat_context": "<string>",
"view": "<string>",
"chamber": "<string>",
"strain_convention": "<string>",
"vertebral_levels_included": [
"<string>"
],
"vertebral_levels_excluded": [
"<string>"
],
"reference_database": "<string>",
"comparison_information": "<string>",
"precision_information": "<string>",
"relaxed_flexed": "relaxed",
"landmark": "<string>",
"reading_sequence": 500000000,
"cuff_size": "<string>",
"rest_seconds": 1,
"medication_timing": "<string>",
"observation_window_seconds": 1,
"recovery_kind": "actual_heart_rate",
"recovery_interval_seconds": 1,
"recovery_mode": "active",
"bronchodilator_state": "pre",
"bronchodilator_agent": "<string>",
"bronchodilator_dose": {
"kind": "quantity",
"value": 123,
"unit": "<string>",
"original_unit": "<string>",
"original_value": "<string>",
"comparator": "eq",
"reported_precision": 7
},
"bronchodilator_elapsed_seconds": 1,
"quality_grade": "<string>",
"repeatability": "<string>",
"dlco_corrections": [
"<string>"
],
"inspired_volume": {
"kind": "quantity",
"value": 123,
"unit": "<string>",
"original_unit": "<string>",
"original_value": "<string>",
"comparator": "eq",
"reported_precision": 7
},
"protocol": "<string>",
"test_duration_seconds": 1,
"assistance": "<string>",
"walking_aid": "<string>",
"attempt_number": 500000000
},
"source_status": "preliminary",
"related_record_ids": [
{
"record_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"relationship": "same_event"
}
],
"notes": "<string>"
},
"time_context": {
"original_occurred_at": "2023-11-07T05:31:56Z",
"original_ended_at": "2023-11-07T05:31:56Z",
"supplied_timezone": "<string>"
},
"attachment_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
},
"history": [
{
"version": 123,
"snapshot": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"record_type": "measurement",
"version": 123,
"occurred_on": "2023-12-25",
"occurred_at": "2023-11-07T05:31:56Z",
"ended_at": "2023-11-07T05:31:56Z",
"timezone": "<string>",
"time_precision": "date",
"date_basis": "reported_date",
"recorded_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"status": "active",
"validity": "valid",
"provenance": {
"source_type": "manual",
"value_kind": "measured",
"source_description": "<string>",
"source_locator": "<string>",
"assumptions": [
"<string>"
],
"field_overrides": {}
},
"schema_version": 2,
"data": {
"kind": "scalar",
"metric_key": "weight",
"value": 123,
"unit": "<string>",
"original_value": "<string>",
"original_unit": "<string>",
"comparator": "eq",
"uncertainty": {
"note": "<string>",
"confidence_label": "<string>",
"lower": 123,
"upper": 123,
"original_value_text": "<string>"
},
"specimen": "whole_blood",
"specimen_context": {
"type": "whole_blood",
"site": "<string>",
"collection_method": "<string>",
"collection_context": "spot",
"container": "<string>",
"additive": "<string>",
"quality_flags": [
"<string>"
],
"duration_seconds": 1,
"volume": {
"kind": "quantity",
"value": 123,
"unit": "<string>",
"original_unit": "<string>",
"original_value": "<string>",
"comparator": "eq",
"reported_precision": 7
}
},
"measurement_site": "<string>",
"body_region": "<string>",
"laterality": "left",
"body_position": "seated",
"method": {
"name": "<string>",
"assay": "<string>",
"assay_version": "<string>",
"instrument": "<string>",
"model": "<string>",
"firmware_version": "<string>",
"software_version": "<string>",
"equation": "<string>",
"reference_basis": "<string>",
"calibration": "<string>"
},
"device_context": {
"name": "<string>",
"assay": "<string>",
"assay_version": "<string>",
"instrument": "<string>",
"model": "<string>",
"firmware_version": "<string>",
"software_version": "<string>",
"equation": "<string>",
"reference_basis": "<string>",
"calibration": "<string>"
},
"resting_state": "resting",
"fasting_state": "fasting",
"meal_state": "fasting",
"time_since_meal_minutes": 1,
"challenge_context": {
"label": "<string>",
"dose": {
"kind": "quantity",
"value": 123,
"unit": "<string>",
"original_unit": "<string>",
"original_value": "<string>",
"comparator": "eq",
"reported_precision": 7
},
"elapsed_seconds": 1,
"procedure": "<string>"
},
"hydration_context": "<string>",
"exercise_context": "<string>",
"oxygen_context": {
"support": "room_air",
"flow": {
"kind": "quantity",
"value": 123,
"unit": "<string>",
"original_unit": "<string>",
"original_value": "<string>",
"comparator": "eq",
"reported_precision": 7
},
"fio2": {
"kind": "quantity",
"value": 123,
"unit": "<string>",
"original_unit": "<string>",
"original_value": "<string>",
"comparator": "eq",
"reported_precision": 7
}
},
"temperature_site": "<string>",
"source_reference_range": {
"lower": 123,
"upper": 123,
"lower_inclusive": true,
"upper_inclusive": true,
"unit": "<string>",
"text": "<string>",
"age_band": {
"unit": "years",
"lower": 1,
"upper": 1
},
"sex_context": "<string>",
"specimen": "whole_blood",
"method": "<string>",
"fasting_state": "<string>",
"pregnancy_context": "<string>",
"gestational_context": "<string>",
"source_version": "<string>"
},
"reported_predicted_value": {
"kind": "quantity",
"value": 123,
"unit": "<string>",
"original_unit": "<string>",
"original_value": "<string>",
"comparator": "eq",
"reported_precision": 7
},
"reported_percent_predicted": 1,
"reported_lower_limit_normal": {
"kind": "quantity",
"value": 123,
"unit": "<string>",
"original_unit": "<string>",
"original_value": "<string>",
"comparator": "eq",
"reported_precision": 7
},
"reported_z_score": 123,
"reference_equation": {
"name": "<string>",
"assay": "<string>",
"assay_version": "<string>",
"instrument": "<string>",
"model": "<string>",
"firmware_version": "<string>",
"software_version": "<string>",
"equation": "<string>",
"reference_basis": "<string>",
"calibration": "<string>"
},
"classification_metadata": {
"frequency_hz": 1,
"conduction": "air",
"masking": true,
"corrected_vision": true,
"viewing_distance": {
"kind": "quantity",
"value": 123,
"unit": "<string>",
"original_unit": "<string>",
"original_value": "<string>",
"comparator": "eq",
"reported_precision": 7
},
"qt_correction_formula": "<string>",
"lead": "<string>",
"rhythm_context": "<string>",
"beat_context": "<string>",
"view": "<string>",
"chamber": "<string>",
"strain_convention": "<string>",
"vertebral_levels_included": [
"<string>"
],
"vertebral_levels_excluded": [
"<string>"
],
"reference_database": "<string>",
"comparison_information": "<string>",
"precision_information": "<string>",
"relaxed_flexed": "relaxed",
"landmark": "<string>",
"reading_sequence": 500000000,
"cuff_size": "<string>",
"rest_seconds": 1,
"medication_timing": "<string>",
"observation_window_seconds": 1,
"recovery_kind": "actual_heart_rate",
"recovery_interval_seconds": 1,
"recovery_mode": "active",
"bronchodilator_state": "pre",
"bronchodilator_agent": "<string>",
"bronchodilator_dose": {
"kind": "quantity",
"value": 123,
"unit": "<string>",
"original_unit": "<string>",
"original_value": "<string>",
"comparator": "eq",
"reported_precision": 7
},
"bronchodilator_elapsed_seconds": 1,
"quality_grade": "<string>",
"repeatability": "<string>",
"dlco_corrections": [
"<string>"
],
"inspired_volume": {
"kind": "quantity",
"value": 123,
"unit": "<string>",
"original_unit": "<string>",
"original_value": "<string>",
"comparator": "eq",
"reported_precision": 7
},
"protocol": "<string>",
"test_duration_seconds": 1,
"assistance": "<string>",
"walking_aid": "<string>",
"attempt_number": 500000000
},
"source_status": "preliminary",
"related_record_ids": [
{
"record_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"relationship": "same_event"
}
],
"notes": "<string>"
},
"time_context": {
"original_occurred_at": "2023-11-07T05:31:56Z",
"original_ended_at": "2023-11-07T05:31:56Z",
"supplied_timezone": "<string>"
},
"attachment_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
},
"changed_at": "2023-11-07T05:31:56Z",
"reason": "<string>"
}
],
"history_has_more": true,
"history_next_version": 500000000
}{
"code": "VALIDATION_ERROR",
"message": "<string>",
"catalog_version": "<string>",
"issues": [
{
"path": "<string>",
"reason": "<string>",
"message": "<string>",
"suggested_keys": [
"<string>"
],
"discovery": {}
}
],
"existing_id": "<string>",
"current_version": 123,
"current_catalog_version": "<string>"
}{
"code": "VALIDATION_ERROR",
"message": "<string>",
"catalog_version": "<string>",
"issues": [
{
"path": "<string>",
"reason": "<string>",
"message": "<string>",
"suggested_keys": [
"<string>"
],
"discovery": {}
}
],
"existing_id": "<string>",
"current_version": 123,
"current_catalog_version": "<string>"
}{
"code": "VALIDATION_ERROR",
"message": "<string>",
"catalog_version": "<string>",
"issues": [
{
"path": "<string>",
"reason": "<string>",
"message": "<string>",
"suggested_keys": [
"<string>"
],
"discovery": {}
}
],
"existing_id": "<string>",
"current_version": 123,
"current_catalog_version": "<string>"
}{
"code": "VALIDATION_ERROR",
"message": "<string>",
"catalog_version": "<string>",
"issues": [
{
"path": "<string>",
"reason": "<string>",
"message": "<string>",
"suggested_keys": [
"<string>"
],
"discovery": {}
}
],
"existing_id": "<string>",
"current_version": 123,
"current_catalog_version": "<string>"
}{
"code": "VALIDATION_ERROR",
"message": "<string>",
"catalog_version": "<string>",
"issues": [
{
"path": "<string>",
"reason": "<string>",
"message": "<string>",
"suggested_keys": [
"<string>"
],
"discovery": {}
}
],
"existing_id": "<string>",
"current_version": 123,
"current_catalog_version": "<string>"
}{
"code": "VALIDATION_ERROR",
"message": "<string>",
"catalog_version": "<string>",
"issues": [
{
"path": "<string>",
"reason": "<string>",
"message": "<string>",
"suggested_keys": [
"<string>"
],
"discovery": {}
}
],
"existing_id": "<string>",
"current_version": 123,
"current_catalog_version": "<string>"
}{
"code": "VALIDATION_ERROR",
"message": "<string>",
"catalog_version": "<string>",
"issues": [
{
"path": "<string>",
"reason": "<string>",
"message": "<string>",
"suggested_keys": [
"<string>"
],
"discovery": {}
}
],
"existing_id": "<string>",
"current_version": 123,
"current_catalog_version": "<string>"
}{
"code": "VALIDATION_ERROR",
"message": "<string>",
"catalog_version": "<string>",
"issues": [
{
"path": "<string>",
"reason": "<string>",
"message": "<string>",
"suggested_keys": [
"<string>"
],
"discovery": {}
}
],
"existing_id": "<string>",
"current_version": 123,
"current_catalog_version": "<string>"
}{
"code": "VALIDATION_ERROR",
"message": "<string>",
"catalog_version": "<string>",
"issues": [
{
"path": "<string>",
"reason": "<string>",
"message": "<string>",
"suggested_keys": [
"<string>"
],
"discovery": {}
}
],
"existing_id": "<string>",
"current_version": 123,
"current_catalog_version": "<string>"
}{
"code": "VALIDATION_ERROR",
"message": "<string>",
"catalog_version": "<string>",
"issues": [
{
"path": "<string>",
"reason": "<string>",
"message": "<string>",
"suggested_keys": [
"<string>"
],
"discovery": {}
}
],
"existing_id": "<string>",
"current_version": 123,
"current_catalog_version": "<string>"
}Get record
Retrieve one recorded observation and optionally a bounded page of immutable revisions.
GET
/
v1
/
records
/
{id}
Get record
curl --request GET \
--url https://vitalog-api.example.com/v1/records/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://vitalog-api.example.com/v1/records/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://vitalog-api.example.com/v1/records/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://vitalog-api.example.com/v1/records/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://vitalog-api.example.com/v1/records/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://vitalog-api.example.com/v1/records/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://vitalog-api.example.com/v1/records/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"catalog_version": "1.0.4",
"record": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"record_type": "measurement",
"version": 123,
"occurred_on": "2023-12-25",
"occurred_at": "2023-11-07T05:31:56Z",
"ended_at": "2023-11-07T05:31:56Z",
"timezone": "<string>",
"time_precision": "date",
"date_basis": "reported_date",
"recorded_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"status": "active",
"validity": "valid",
"provenance": {
"source_type": "manual",
"value_kind": "measured",
"source_description": "<string>",
"source_locator": "<string>",
"assumptions": [
"<string>"
],
"field_overrides": {}
},
"schema_version": 2,
"data": {
"kind": "scalar",
"metric_key": "weight",
"value": 123,
"unit": "<string>",
"original_value": "<string>",
"original_unit": "<string>",
"comparator": "eq",
"uncertainty": {
"note": "<string>",
"confidence_label": "<string>",
"lower": 123,
"upper": 123,
"original_value_text": "<string>"
},
"specimen": "whole_blood",
"specimen_context": {
"type": "whole_blood",
"site": "<string>",
"collection_method": "<string>",
"collection_context": "spot",
"container": "<string>",
"additive": "<string>",
"quality_flags": [
"<string>"
],
"duration_seconds": 1,
"volume": {
"kind": "quantity",
"value": 123,
"unit": "<string>",
"original_unit": "<string>",
"original_value": "<string>",
"comparator": "eq",
"reported_precision": 7
}
},
"measurement_site": "<string>",
"body_region": "<string>",
"laterality": "left",
"body_position": "seated",
"method": {
"name": "<string>",
"assay": "<string>",
"assay_version": "<string>",
"instrument": "<string>",
"model": "<string>",
"firmware_version": "<string>",
"software_version": "<string>",
"equation": "<string>",
"reference_basis": "<string>",
"calibration": "<string>"
},
"device_context": {
"name": "<string>",
"assay": "<string>",
"assay_version": "<string>",
"instrument": "<string>",
"model": "<string>",
"firmware_version": "<string>",
"software_version": "<string>",
"equation": "<string>",
"reference_basis": "<string>",
"calibration": "<string>"
},
"resting_state": "resting",
"fasting_state": "fasting",
"meal_state": "fasting",
"time_since_meal_minutes": 1,
"challenge_context": {
"label": "<string>",
"dose": {
"kind": "quantity",
"value": 123,
"unit": "<string>",
"original_unit": "<string>",
"original_value": "<string>",
"comparator": "eq",
"reported_precision": 7
},
"elapsed_seconds": 1,
"procedure": "<string>"
},
"hydration_context": "<string>",
"exercise_context": "<string>",
"oxygen_context": {
"support": "room_air",
"flow": {
"kind": "quantity",
"value": 123,
"unit": "<string>",
"original_unit": "<string>",
"original_value": "<string>",
"comparator": "eq",
"reported_precision": 7
},
"fio2": {
"kind": "quantity",
"value": 123,
"unit": "<string>",
"original_unit": "<string>",
"original_value": "<string>",
"comparator": "eq",
"reported_precision": 7
}
},
"temperature_site": "<string>",
"source_reference_range": {
"lower": 123,
"upper": 123,
"lower_inclusive": true,
"upper_inclusive": true,
"unit": "<string>",
"text": "<string>",
"age_band": {
"unit": "years",
"lower": 1,
"upper": 1
},
"sex_context": "<string>",
"specimen": "whole_blood",
"method": "<string>",
"fasting_state": "<string>",
"pregnancy_context": "<string>",
"gestational_context": "<string>",
"source_version": "<string>"
},
"reported_predicted_value": {
"kind": "quantity",
"value": 123,
"unit": "<string>",
"original_unit": "<string>",
"original_value": "<string>",
"comparator": "eq",
"reported_precision": 7
},
"reported_percent_predicted": 1,
"reported_lower_limit_normal": {
"kind": "quantity",
"value": 123,
"unit": "<string>",
"original_unit": "<string>",
"original_value": "<string>",
"comparator": "eq",
"reported_precision": 7
},
"reported_z_score": 123,
"reference_equation": {
"name": "<string>",
"assay": "<string>",
"assay_version": "<string>",
"instrument": "<string>",
"model": "<string>",
"firmware_version": "<string>",
"software_version": "<string>",
"equation": "<string>",
"reference_basis": "<string>",
"calibration": "<string>"
},
"classification_metadata": {
"frequency_hz": 1,
"conduction": "air",
"masking": true,
"corrected_vision": true,
"viewing_distance": {
"kind": "quantity",
"value": 123,
"unit": "<string>",
"original_unit": "<string>",
"original_value": "<string>",
"comparator": "eq",
"reported_precision": 7
},
"qt_correction_formula": "<string>",
"lead": "<string>",
"rhythm_context": "<string>",
"beat_context": "<string>",
"view": "<string>",
"chamber": "<string>",
"strain_convention": "<string>",
"vertebral_levels_included": [
"<string>"
],
"vertebral_levels_excluded": [
"<string>"
],
"reference_database": "<string>",
"comparison_information": "<string>",
"precision_information": "<string>",
"relaxed_flexed": "relaxed",
"landmark": "<string>",
"reading_sequence": 500000000,
"cuff_size": "<string>",
"rest_seconds": 1,
"medication_timing": "<string>",
"observation_window_seconds": 1,
"recovery_kind": "actual_heart_rate",
"recovery_interval_seconds": 1,
"recovery_mode": "active",
"bronchodilator_state": "pre",
"bronchodilator_agent": "<string>",
"bronchodilator_dose": {
"kind": "quantity",
"value": 123,
"unit": "<string>",
"original_unit": "<string>",
"original_value": "<string>",
"comparator": "eq",
"reported_precision": 7
},
"bronchodilator_elapsed_seconds": 1,
"quality_grade": "<string>",
"repeatability": "<string>",
"dlco_corrections": [
"<string>"
],
"inspired_volume": {
"kind": "quantity",
"value": 123,
"unit": "<string>",
"original_unit": "<string>",
"original_value": "<string>",
"comparator": "eq",
"reported_precision": 7
},
"protocol": "<string>",
"test_duration_seconds": 1,
"assistance": "<string>",
"walking_aid": "<string>",
"attempt_number": 500000000
},
"source_status": "preliminary",
"related_record_ids": [
{
"record_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"relationship": "same_event"
}
],
"notes": "<string>"
},
"time_context": {
"original_occurred_at": "2023-11-07T05:31:56Z",
"original_ended_at": "2023-11-07T05:31:56Z",
"supplied_timezone": "<string>"
},
"attachment_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
},
"history": [
{
"version": 123,
"snapshot": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"record_type": "measurement",
"version": 123,
"occurred_on": "2023-12-25",
"occurred_at": "2023-11-07T05:31:56Z",
"ended_at": "2023-11-07T05:31:56Z",
"timezone": "<string>",
"time_precision": "date",
"date_basis": "reported_date",
"recorded_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"status": "active",
"validity": "valid",
"provenance": {
"source_type": "manual",
"value_kind": "measured",
"source_description": "<string>",
"source_locator": "<string>",
"assumptions": [
"<string>"
],
"field_overrides": {}
},
"schema_version": 2,
"data": {
"kind": "scalar",
"metric_key": "weight",
"value": 123,
"unit": "<string>",
"original_value": "<string>",
"original_unit": "<string>",
"comparator": "eq",
"uncertainty": {
"note": "<string>",
"confidence_label": "<string>",
"lower": 123,
"upper": 123,
"original_value_text": "<string>"
},
"specimen": "whole_blood",
"specimen_context": {
"type": "whole_blood",
"site": "<string>",
"collection_method": "<string>",
"collection_context": "spot",
"container": "<string>",
"additive": "<string>",
"quality_flags": [
"<string>"
],
"duration_seconds": 1,
"volume": {
"kind": "quantity",
"value": 123,
"unit": "<string>",
"original_unit": "<string>",
"original_value": "<string>",
"comparator": "eq",
"reported_precision": 7
}
},
"measurement_site": "<string>",
"body_region": "<string>",
"laterality": "left",
"body_position": "seated",
"method": {
"name": "<string>",
"assay": "<string>",
"assay_version": "<string>",
"instrument": "<string>",
"model": "<string>",
"firmware_version": "<string>",
"software_version": "<string>",
"equation": "<string>",
"reference_basis": "<string>",
"calibration": "<string>"
},
"device_context": {
"name": "<string>",
"assay": "<string>",
"assay_version": "<string>",
"instrument": "<string>",
"model": "<string>",
"firmware_version": "<string>",
"software_version": "<string>",
"equation": "<string>",
"reference_basis": "<string>",
"calibration": "<string>"
},
"resting_state": "resting",
"fasting_state": "fasting",
"meal_state": "fasting",
"time_since_meal_minutes": 1,
"challenge_context": {
"label": "<string>",
"dose": {
"kind": "quantity",
"value": 123,
"unit": "<string>",
"original_unit": "<string>",
"original_value": "<string>",
"comparator": "eq",
"reported_precision": 7
},
"elapsed_seconds": 1,
"procedure": "<string>"
},
"hydration_context": "<string>",
"exercise_context": "<string>",
"oxygen_context": {
"support": "room_air",
"flow": {
"kind": "quantity",
"value": 123,
"unit": "<string>",
"original_unit": "<string>",
"original_value": "<string>",
"comparator": "eq",
"reported_precision": 7
},
"fio2": {
"kind": "quantity",
"value": 123,
"unit": "<string>",
"original_unit": "<string>",
"original_value": "<string>",
"comparator": "eq",
"reported_precision": 7
}
},
"temperature_site": "<string>",
"source_reference_range": {
"lower": 123,
"upper": 123,
"lower_inclusive": true,
"upper_inclusive": true,
"unit": "<string>",
"text": "<string>",
"age_band": {
"unit": "years",
"lower": 1,
"upper": 1
},
"sex_context": "<string>",
"specimen": "whole_blood",
"method": "<string>",
"fasting_state": "<string>",
"pregnancy_context": "<string>",
"gestational_context": "<string>",
"source_version": "<string>"
},
"reported_predicted_value": {
"kind": "quantity",
"value": 123,
"unit": "<string>",
"original_unit": "<string>",
"original_value": "<string>",
"comparator": "eq",
"reported_precision": 7
},
"reported_percent_predicted": 1,
"reported_lower_limit_normal": {
"kind": "quantity",
"value": 123,
"unit": "<string>",
"original_unit": "<string>",
"original_value": "<string>",
"comparator": "eq",
"reported_precision": 7
},
"reported_z_score": 123,
"reference_equation": {
"name": "<string>",
"assay": "<string>",
"assay_version": "<string>",
"instrument": "<string>",
"model": "<string>",
"firmware_version": "<string>",
"software_version": "<string>",
"equation": "<string>",
"reference_basis": "<string>",
"calibration": "<string>"
},
"classification_metadata": {
"frequency_hz": 1,
"conduction": "air",
"masking": true,
"corrected_vision": true,
"viewing_distance": {
"kind": "quantity",
"value": 123,
"unit": "<string>",
"original_unit": "<string>",
"original_value": "<string>",
"comparator": "eq",
"reported_precision": 7
},
"qt_correction_formula": "<string>",
"lead": "<string>",
"rhythm_context": "<string>",
"beat_context": "<string>",
"view": "<string>",
"chamber": "<string>",
"strain_convention": "<string>",
"vertebral_levels_included": [
"<string>"
],
"vertebral_levels_excluded": [
"<string>"
],
"reference_database": "<string>",
"comparison_information": "<string>",
"precision_information": "<string>",
"relaxed_flexed": "relaxed",
"landmark": "<string>",
"reading_sequence": 500000000,
"cuff_size": "<string>",
"rest_seconds": 1,
"medication_timing": "<string>",
"observation_window_seconds": 1,
"recovery_kind": "actual_heart_rate",
"recovery_interval_seconds": 1,
"recovery_mode": "active",
"bronchodilator_state": "pre",
"bronchodilator_agent": "<string>",
"bronchodilator_dose": {
"kind": "quantity",
"value": 123,
"unit": "<string>",
"original_unit": "<string>",
"original_value": "<string>",
"comparator": "eq",
"reported_precision": 7
},
"bronchodilator_elapsed_seconds": 1,
"quality_grade": "<string>",
"repeatability": "<string>",
"dlco_corrections": [
"<string>"
],
"inspired_volume": {
"kind": "quantity",
"value": 123,
"unit": "<string>",
"original_unit": "<string>",
"original_value": "<string>",
"comparator": "eq",
"reported_precision": 7
},
"protocol": "<string>",
"test_duration_seconds": 1,
"assistance": "<string>",
"walking_aid": "<string>",
"attempt_number": 500000000
},
"source_status": "preliminary",
"related_record_ids": [
{
"record_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"relationship": "same_event"
}
],
"notes": "<string>"
},
"time_context": {
"original_occurred_at": "2023-11-07T05:31:56Z",
"original_ended_at": "2023-11-07T05:31:56Z",
"supplied_timezone": "<string>"
},
"attachment_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
},
"changed_at": "2023-11-07T05:31:56Z",
"reason": "<string>"
}
],
"history_has_more": true,
"history_next_version": 500000000
}{
"code": "VALIDATION_ERROR",
"message": "<string>",
"catalog_version": "<string>",
"issues": [
{
"path": "<string>",
"reason": "<string>",
"message": "<string>",
"suggested_keys": [
"<string>"
],
"discovery": {}
}
],
"existing_id": "<string>",
"current_version": 123,
"current_catalog_version": "<string>"
}{
"code": "VALIDATION_ERROR",
"message": "<string>",
"catalog_version": "<string>",
"issues": [
{
"path": "<string>",
"reason": "<string>",
"message": "<string>",
"suggested_keys": [
"<string>"
],
"discovery": {}
}
],
"existing_id": "<string>",
"current_version": 123,
"current_catalog_version": "<string>"
}{
"code": "VALIDATION_ERROR",
"message": "<string>",
"catalog_version": "<string>",
"issues": [
{
"path": "<string>",
"reason": "<string>",
"message": "<string>",
"suggested_keys": [
"<string>"
],
"discovery": {}
}
],
"existing_id": "<string>",
"current_version": 123,
"current_catalog_version": "<string>"
}{
"code": "VALIDATION_ERROR",
"message": "<string>",
"catalog_version": "<string>",
"issues": [
{
"path": "<string>",
"reason": "<string>",
"message": "<string>",
"suggested_keys": [
"<string>"
],
"discovery": {}
}
],
"existing_id": "<string>",
"current_version": 123,
"current_catalog_version": "<string>"
}{
"code": "VALIDATION_ERROR",
"message": "<string>",
"catalog_version": "<string>",
"issues": [
{
"path": "<string>",
"reason": "<string>",
"message": "<string>",
"suggested_keys": [
"<string>"
],
"discovery": {}
}
],
"existing_id": "<string>",
"current_version": 123,
"current_catalog_version": "<string>"
}{
"code": "VALIDATION_ERROR",
"message": "<string>",
"catalog_version": "<string>",
"issues": [
{
"path": "<string>",
"reason": "<string>",
"message": "<string>",
"suggested_keys": [
"<string>"
],
"discovery": {}
}
],
"existing_id": "<string>",
"current_version": 123,
"current_catalog_version": "<string>"
}{
"code": "VALIDATION_ERROR",
"message": "<string>",
"catalog_version": "<string>",
"issues": [
{
"path": "<string>",
"reason": "<string>",
"message": "<string>",
"suggested_keys": [
"<string>"
],
"discovery": {}
}
],
"existing_id": "<string>",
"current_version": 123,
"current_catalog_version": "<string>"
}{
"code": "VALIDATION_ERROR",
"message": "<string>",
"catalog_version": "<string>",
"issues": [
{
"path": "<string>",
"reason": "<string>",
"message": "<string>",
"suggested_keys": [
"<string>"
],
"discovery": {}
}
],
"existing_id": "<string>",
"current_version": 123,
"current_catalog_version": "<string>"
}{
"code": "VALIDATION_ERROR",
"message": "<string>",
"catalog_version": "<string>",
"issues": [
{
"path": "<string>",
"reason": "<string>",
"message": "<string>",
"suggested_keys": [
"<string>"
],
"discovery": {}
}
],
"existing_id": "<string>",
"current_version": 123,
"current_catalog_version": "<string>"
}{
"code": "VALIDATION_ERROR",
"message": "<string>",
"catalog_version": "<string>",
"issues": [
{
"path": "<string>",
"reason": "<string>",
"message": "<string>",
"suggested_keys": [
"<string>"
],
"discovery": {}
}
],
"existing_id": "<string>",
"current_version": 123,
"current_catalog_version": "<string>"
}Authorizations
staticKeyapiKeybrowserSession
Environment AUTH_KEY. Full ledger access and primary API-key administration. Not OAuth or JWT.
Path Parameters
Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Query Parameters
Exactly one parameter; booleans are true/false, arrays are comma-separated. Empty values are rejected.
Exactly one parameter; booleans are true/false, arrays are comma-separated. Empty values are rejected.
Required range:
1 <= x <= 100Exactly one parameter; booleans are true/false, arrays are comma-separated. Empty values are rejected.
Required range:
0 <= x <= 1000000000Response
Successful domain response
Allowed value:
"1.0.4"- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
- Option 8
- Option 9
Show child attributes
Show child attributes
Maximum array length:
100Show child attributes
Show child attributes
Required range:
0 <= x <= 1000000000Was this page helpful?
