Log check-in
curl --request POST \
--url https://vitalog-api.example.com/v1/checkins \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"occurred_on": "2026-09-10",
"timezone": "Asia/Kolkata",
"provenance": {
"source_type": "manual",
"value_kind": "reported"
},
"data": {
"mood": "good",
"ratings": {
"energy": {
"value": 7,
"scale": "reported_energy",
"lower": 0,
"upper": 10,
"meaning": "Higher means more energy"
}
}
}
}
'import requests
url = "https://vitalog-api.example.com/v1/checkins"
payload = {
"occurred_on": "2026-09-10",
"timezone": "Asia/Kolkata",
"provenance": {
"source_type": "manual",
"value_kind": "reported"
},
"data": {
"mood": "good",
"ratings": { "energy": {
"value": 7,
"scale": "reported_energy",
"lower": 0,
"upper": 10,
"meaning": "Higher means more energy"
} }
}
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
occurred_on: '2026-09-10',
timezone: 'Asia/Kolkata',
provenance: {source_type: 'manual', value_kind: 'reported'},
data: {
mood: 'good',
ratings: {
energy: {
value: 7,
scale: 'reported_energy',
lower: 0,
upper: 10,
meaning: 'Higher means more energy'
}
}
}
})
};
fetch('https://vitalog-api.example.com/v1/checkins', 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/checkins",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'occurred_on' => '2026-09-10',
'timezone' => 'Asia/Kolkata',
'provenance' => [
'source_type' => 'manual',
'value_kind' => 'reported'
],
'data' => [
'mood' => 'good',
'ratings' => [
'energy' => [
'value' => 7,
'scale' => 'reported_energy',
'lower' => 0,
'upper' => 10,
'meaning' => 'Higher means more energy'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://vitalog-api.example.com/v1/checkins"
payload := strings.NewReader("{\n \"occurred_on\": \"2026-09-10\",\n \"timezone\": \"Asia/Kolkata\",\n \"provenance\": {\n \"source_type\": \"manual\",\n \"value_kind\": \"reported\"\n },\n \"data\": {\n \"mood\": \"good\",\n \"ratings\": {\n \"energy\": {\n \"value\": 7,\n \"scale\": \"reported_energy\",\n \"lower\": 0,\n \"upper\": 10,\n \"meaning\": \"Higher means more energy\"\n }\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://vitalog-api.example.com/v1/checkins")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"occurred_on\": \"2026-09-10\",\n \"timezone\": \"Asia/Kolkata\",\n \"provenance\": {\n \"source_type\": \"manual\",\n \"value_kind\": \"reported\"\n },\n \"data\": {\n \"mood\": \"good\",\n \"ratings\": {\n \"energy\": {\n \"value\": 7,\n \"scale\": \"reported_energy\",\n \"lower\": 0,\n \"upper\": 10,\n \"meaning\": \"Higher means more energy\"\n }\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://vitalog-api.example.com/v1/checkins")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"occurred_on\": \"2026-09-10\",\n \"timezone\": \"Asia/Kolkata\",\n \"provenance\": {\n \"source_type\": \"manual\",\n \"value_kind\": \"reported\"\n },\n \"data\": {\n \"mood\": \"good\",\n \"ratings\": {\n \"energy\": {\n \"value\": 7,\n \"scale\": \"reported_energy\",\n \"lower\": 0,\n \"upper\": 10,\n \"meaning\": \"Higher means more energy\"\n }\n }\n }\n}"
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"
]
},
"warnings": [
"<string>"
],
"idempotent_replay": true,
"committed_version": 123
}{
"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>"
}Log check-in
Save one supplied check-in, including optional data.mood (very_low, low, neutral, good, great). Actual recorded events only. Numeric ratings remain separate. Use health_get_catalog for exact fields; do not infer missing values.
POST
/
v1
/
checkins
Log check-in
curl --request POST \
--url https://vitalog-api.example.com/v1/checkins \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"occurred_on": "2026-09-10",
"timezone": "Asia/Kolkata",
"provenance": {
"source_type": "manual",
"value_kind": "reported"
},
"data": {
"mood": "good",
"ratings": {
"energy": {
"value": 7,
"scale": "reported_energy",
"lower": 0,
"upper": 10,
"meaning": "Higher means more energy"
}
}
}
}
'import requests
url = "https://vitalog-api.example.com/v1/checkins"
payload = {
"occurred_on": "2026-09-10",
"timezone": "Asia/Kolkata",
"provenance": {
"source_type": "manual",
"value_kind": "reported"
},
"data": {
"mood": "good",
"ratings": { "energy": {
"value": 7,
"scale": "reported_energy",
"lower": 0,
"upper": 10,
"meaning": "Higher means more energy"
} }
}
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
occurred_on: '2026-09-10',
timezone: 'Asia/Kolkata',
provenance: {source_type: 'manual', value_kind: 'reported'},
data: {
mood: 'good',
ratings: {
energy: {
value: 7,
scale: 'reported_energy',
lower: 0,
upper: 10,
meaning: 'Higher means more energy'
}
}
}
})
};
fetch('https://vitalog-api.example.com/v1/checkins', 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/checkins",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'occurred_on' => '2026-09-10',
'timezone' => 'Asia/Kolkata',
'provenance' => [
'source_type' => 'manual',
'value_kind' => 'reported'
],
'data' => [
'mood' => 'good',
'ratings' => [
'energy' => [
'value' => 7,
'scale' => 'reported_energy',
'lower' => 0,
'upper' => 10,
'meaning' => 'Higher means more energy'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://vitalog-api.example.com/v1/checkins"
payload := strings.NewReader("{\n \"occurred_on\": \"2026-09-10\",\n \"timezone\": \"Asia/Kolkata\",\n \"provenance\": {\n \"source_type\": \"manual\",\n \"value_kind\": \"reported\"\n },\n \"data\": {\n \"mood\": \"good\",\n \"ratings\": {\n \"energy\": {\n \"value\": 7,\n \"scale\": \"reported_energy\",\n \"lower\": 0,\n \"upper\": 10,\n \"meaning\": \"Higher means more energy\"\n }\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://vitalog-api.example.com/v1/checkins")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"occurred_on\": \"2026-09-10\",\n \"timezone\": \"Asia/Kolkata\",\n \"provenance\": {\n \"source_type\": \"manual\",\n \"value_kind\": \"reported\"\n },\n \"data\": {\n \"mood\": \"good\",\n \"ratings\": {\n \"energy\": {\n \"value\": 7,\n \"scale\": \"reported_energy\",\n \"lower\": 0,\n \"upper\": 10,\n \"meaning\": \"Higher means more energy\"\n }\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://vitalog-api.example.com/v1/checkins")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"occurred_on\": \"2026-09-10\",\n \"timezone\": \"Asia/Kolkata\",\n \"provenance\": {\n \"source_type\": \"manual\",\n \"value_kind\": \"reported\"\n },\n \"data\": {\n \"mood\": \"good\",\n \"ratings\": {\n \"energy\": {\n \"value\": 7,\n \"scale\": \"reported_energy\",\n \"lower\": 0,\n \"upper\": 10,\n \"meaning\": \"Higher means more energy\"\n }\n }\n }\n}"
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"
]
},
"warnings": [
"<string>"
],
"idempotent_replay": true,
"committed_version": 123
}{
"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
staticKeyapiKey
Environment AUTH_KEY. Full ledger access and primary API-key administration. Not OAuth or JWT.
Headers
Required string length:
1 - 128Pattern:
^[A-Za-z0-9][A-Za-z0-9._:-]*$Body
application/json
Pattern:
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$Show child attributes
Show child attributes
Show child attributes
Show child attributes
Maximum array length:
20Pattern:
^([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)$Pattern:
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$Pattern:
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$Required string length:
1 - 100Available options:
date, instant, period, unknown Available options:
reported_date, event_date, wake_date, specimen_date, report_date, unknown Available options:
valid, suspect, invalid Response
Committed mutation or durable idempotent replay
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
Required string length:
1 - 200Required range:
x <= 9007199254740991Was this page helpful?
