diff --git a/docs/api-reference/data/activity/get-raw.mdx b/docs/api-reference/data/activity/get-raw.mdx index 34301df4a..d420f5661 100644 --- a/docs/api-reference/data/activity/get-raw.mdx +++ b/docs/api-reference/data/activity/get-raw.mdx @@ -93,24 +93,3 @@ fmt.Printf("Received data %s\n", response) ``` - - - -```json Response -{ - "activity": [ - { - "timestamp": "2022-08-04T12:42:44.847351+00:00", - "data": { - "data": "...provider_specific_data" - }, - "provider_id": "e2b25f37-846e-49a9-bf5b-5bb24d62b289", - "user_id": "8e837eec-0717-41df-b108-43f4f206582a", - "source_id": 1, - "priority_id": 1 - } - ] -} -``` - - diff --git a/docs/api-reference/data/activity/get-summary.mdx b/docs/api-reference/data/activity/get-summary.mdx index 7d2ea55b1..0f3bd35eb 100644 --- a/docs/api-reference/data/activity/get-summary.mdx +++ b/docs/api-reference/data/activity/get-summary.mdx @@ -93,36 +93,3 @@ fmt.Printf("Received data %s\n", response) ``` - - - -```json Response -{ - "activity": [ - { - "calendar_date": "2022-08-04", - "calories_total": 100, - "calories_active": 2000, - "steps": 10000, - "daily_movement": 200, - "low": 6400, - "medium": 6400, - "high": 6000, - "source": { - "name": "Garmin", - "slug": "garmin", - "logo": "https://logo_url.com" - }, - "user_id": "70c64d5a-ff06-4c16-b137-361b2441d86e", - "heart_rate": { - "avg_bpm": 76.4, - "max_bpm": 134, - "min_bpm": 55, - "resting_bpm": 60 - } - } - ] -} -``` - - diff --git a/docs/api-reference/data/body/get-raw.mdx b/docs/api-reference/data/body/get-raw.mdx index 516907f27..de0929d7c 100644 --- a/docs/api-reference/data/body/get-raw.mdx +++ b/docs/api-reference/data/body/get-raw.mdx @@ -93,24 +93,3 @@ fmt.Printf("Received data %s\n", response) ``` - - - -```json Response -{ - "body": [ - { - "timestamp": "2022-08-04T12:42:44.849767+00:00", - "data": { - "data": "...provider_specific_data" - }, - "provider_id": "ed059fb6-3bb4-4c4b-9aae-0fec51224e06", - "user_id": "9d2b6976-3226-40cc-8adc-e8c2b898e0de", - "source_id": 1, - "priority_id": 1 - } - ] -} -``` - - diff --git a/docs/api-reference/data/body/get-summary.mdx b/docs/api-reference/data/body/get-summary.mdx index 9868d7cff..13a19bac6 100644 --- a/docs/api-reference/data/body/get-summary.mdx +++ b/docs/api-reference/data/body/get-summary.mdx @@ -93,27 +93,3 @@ fmt.Printf("Received data %s\n", response) ``` - - - -```json Response -{ - "body": [ - { - "id": "4340a0fa-549c-4a47-bd83-b2af6bbeffa9", - "calendar_date": "2022-08-04", - "weight": "80kg", - "fat": "30%", - "height": 183, - "source": { - "name": "Oura", - "slug": "oura", - "logo": "https://logo_url.com" - }, - "user_id": "7a9ca5ad-2a2c-4a11-a9ee-e7a06c219594" - } - ] -} -``` - - diff --git a/docs/api-reference/data/meal/get-summary.mdx b/docs/api-reference/data/meal/get-summary.mdx index e4f0e4ef3..1fe750717 100644 --- a/docs/api-reference/data/meal/get-summary.mdx +++ b/docs/api-reference/data/meal/get-summary.mdx @@ -90,95 +90,3 @@ fmt.Printf("Received data %s\n", response) ``` - - - -```json Example -{ - "meals": [ - { - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", - "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5", - "priority_id": 42, - "source_id": 10, - "provider_id": "123456", - "timestamp": "2019-08-24T14:15:22Z", - "name": "Dinner", - "data": { - "Chiken coquet starter": { - "energy": { - "unit": "kcal", - "value": 400 - }, - "macros": { - "carbs": 75, - "protein": 10, - "fats": { - "saturated": 98, - "monounsaturated": 1, - "polyunsaturated": 1, - "omega3": 0, - "omega6": 0, - "total": 100 - }, - "sugar": 25 - }, - "micros": { - "minerals": { - "sodium": 500 - } - } - }, - "Coffee, black, 1 tbsp(s)": { - "energy": { - "unit": "kcal", - "value": 0 - }, - "macros": { - "carbs": 0, - "protein": 0, - "fats": { - "total": 0 - }, - "sugar": 0 - }, - "micros": { - "minerals": { - "sodium": 0 - } - } - } - }, - "source": { - "name": "MyFitnessPal", - "slug": "my_fitness_pal", - "logo": "https://logo_url.com" - }, - "created_at": "2019-08-24T14:15:22Z", - "updated_at": "2019-08-24T14:15:22Z" - } - ] -} -``` - - - - -All values in the returned model are supplied in the following units: - - -- `meals[*].data[*].energy.value` in calories `kcal` -- `meals[*].data[*].macros.carbs` in grams `g` -- `meals[*].data[*].macros.protein` in grams `g` -- `meals[*].data[*].macros.fats.saturated` in grams `g` -- `meals[*].data[*].macros.fats.monounsaturated` in grams `g` -- `meals[*].data[*].macros.fats.polyunsaturated` in grams `g` -- `meals[*].data[*].macros.fats.omega3` in grams `g` -- `meals[*].data[*].macros.fats.omega6` in grams `g` -- `meals[*].data[*].macros.alcohol` in litres `lt` -- `meals[*].data[*].macros.water` in litres `lt` -- `meals[*].data[*].macros.fibre` in grams `g` -- `meals[*].data[*].macros.sugar` in grams `g` -- `meals[*].data[*].micros.minerals` key: value pairs in milligrams `mg` -- `meals[*].data[*].micros.trace_elements` key: value pairs in milligrams `mg` -- `meals[*].data[*].micros.vitamins` key: value pairs in milligrams `mg` diff --git a/docs/api-reference/data/profile/get-raw.mdx b/docs/api-reference/data/profile/get-raw.mdx index 128d837ef..095bc5469 100644 --- a/docs/api-reference/data/profile/get-raw.mdx +++ b/docs/api-reference/data/profile/get-raw.mdx @@ -70,22 +70,3 @@ fmt.Printf("Received data %s\n", response) ``` - - - -```json Example -{ - "profile": [ - { - "data": { - "data": "...provider_specific_data" - }, - "provider_id": "d0a7670c-dff8-4026-a188-8f249fb92e13", - "user_id": "c0847403-4b5c-434d-ac32-8f347dcc6c33", - "source_id": 1 - } - ] -} -``` - - diff --git a/docs/api-reference/data/profile/get-summary.mdx b/docs/api-reference/data/profile/get-summary.mdx index fd6e73c2e..7893d2516 100644 --- a/docs/api-reference/data/profile/get-summary.mdx +++ b/docs/api-reference/data/profile/get-summary.mdx @@ -68,21 +68,3 @@ fmt.Printf("Received data %s\n", response) ``` - - - -```json Example -{ - "id": "eadba0c7-4e81-4d17-962c-9ebe0629c08f", - "date": "2022-08-04", - "height": 183, - "source": { - "name": "Oura", - "slug": "oura", - "logo": "https://logo_url.com" - }, - "user_id": "71937dd3-aebe-46b7-ab64-c287bd75b2a6" -} -``` - - diff --git a/docs/api-reference/data/sleep/get-raw.mdx b/docs/api-reference/data/sleep/get-raw.mdx index 8ac17df01..3ae3cc680 100644 --- a/docs/api-reference/data/sleep/get-raw.mdx +++ b/docs/api-reference/data/sleep/get-raw.mdx @@ -91,24 +91,3 @@ fmt.Printf("Received data %s\n", response) ``` - - - -```json Response -{ - "sleep": [ - { - "timestamp": "2022-08-04T12:42:44.853437+00:00", - "data": { - "data": "...provider_specific_data" - }, - "provider_id": "acddfb23-a2fd-417b-82ac-37c060074bef", - "user_id": "8479b190-fff6-44cf-84f2-0e906457b343", - "source_id": 1, - "priority_id": 1 - } - ] -} -``` - - diff --git a/docs/api-reference/data/sleep/get-stream.mdx b/docs/api-reference/data/sleep/get-stream.mdx index db6600f1c..8336a770c 100644 --- a/docs/api-reference/data/sleep/get-stream.mdx +++ b/docs/api-reference/data/sleep/get-stream.mdx @@ -71,170 +71,3 @@ fmt.Printf("Received data %s\n", response) ``` - - - -```json Example -{ - "hrv": [ - { - "id": 0, - "timestamp": "2022-08-04T12:42:45.722013+00:00", - "value": 98, - "type": null, - "unit": "rmssd" - }, - { - "id": 1, - "timestamp": "2022-08-04T12:43:15.722058+00:00", - "value": 44, - "type": null, - "unit": "rmssd" - }, - { - "id": 2, - "timestamp": "2022-08-04T12:43:45.722075+00:00", - "value": 75, - "type": null, - "unit": "rmssd" - }, - { - "id": 3, - "timestamp": "2022-08-04T12:44:15.722089+00:00", - "value": 100, - "type": null, - "unit": "rmssd" - }, - { - "id": 4, - "timestamp": "2022-08-04T12:44:45.722101+00:00", - "value": 59, - "type": null, - "unit": "rmssd" - } - ], - "heartrate": [ - { - "id": 0, - "timestamp": "2022-08-04T12:42:45.722112+00:00", - "value": 29, - "type": null, - "unit": "bpm" - }, - { - "id": 1, - "timestamp": "2022-08-04T12:43:15.722124+00:00", - "value": 162, - "type": null, - "unit": "bpm" - }, - { - "id": 2, - "timestamp": "2022-08-04T12:43:45.722135+00:00", - "value": 75, - "type": null, - "unit": "bpm" - }, - { - "id": 3, - "timestamp": "2022-08-04T12:44:15.722146+00:00", - "value": 11, - "type": null, - "unit": "bpm" - }, - { - "id": 4, - "timestamp": "2022-08-04T12:44:45.722157+00:00", - "value": 41, - "type": null, - "unit": "bpm" - } - ], - "hypnogram": [ - { - "id": 0, - "timestamp": "2022-08-04T12:42:45.722168+00:00", - "start": "2022-08-04T12:42:45.722168+00:00", - "end": "2022-08-04T12:43:15.722179+00:00", - "value": 1, - "type": null, - "unit": "stage" - }, - { - "id": 1, - "timestamp": "2022-08-04T12:43:15.722179+00:00", - "start": "2022-08-04T12:43:15.722179+00:00", - "end": "2022-08-04T12:43:45.722190+00:00", - "value": 0, - "type": null, - "unit": "stage" - }, - { - "id": 2, - "timestamp": "2022-08-04T12:43:45.722190+00:00", - "start": "2022-08-04T12:43:45.722190+00:00", - "end": "2022-08-04T12:44:15.722201+00:00", - "value": 4, - "type": null, - "unit": "stage" - }, - { - "id": 3, - "timestamp": "2022-08-04T12:44:15.722201+00:00", - "start": "2022-08-04T12:44:15.722201+00:00", - "end": "2022-08-04T12:44:45.722212+00:00", - "value": 0, - "type": null, - "unit": "stage" - }, - { - "id": 4, - "timestamp": "2022-08-04T12:44:45.722212+00:00", - "start": "2022-08-04T12:44:45.722212+00:00", - "end": "2022-08-04T12:42:45.722223+00:00", - "value": 4, - "type": null, - "unit": "stage" - } - ], - "respiratory_rate": [ - { - "id": 0, - "timestamp": "2022-08-04T12:42:45.722223+00:00", - "value": 30, - "type": null, - "unit": "bpm" - }, - { - "id": 1, - "timestamp": "2022-08-04T12:43:15.722234+00:00", - "value": 29, - "type": null, - "unit": "bpm" - }, - { - "id": 2, - "timestamp": "2022-08-04T12:43:45.722245+00:00", - "value": 19, - "type": null, - "unit": "bpm" - }, - { - "id": 3, - "timestamp": "2022-08-04T12:44:15.722256+00:00", - "value": 14, - "type": null, - "unit": "bpm" - }, - { - "id": 4, - "timestamp": "2022-08-04T12:44:45.722266+00:00", - "value": 18, - "type": null, - "unit": "bpm" - } - ] -} -``` - - diff --git a/docs/api-reference/data/sleep/get-summary.mdx b/docs/api-reference/data/sleep/get-summary.mdx index 2e744f592..8bce6bc42 100644 --- a/docs/api-reference/data/sleep/get-summary.mdx +++ b/docs/api-reference/data/sleep/get-summary.mdx @@ -90,41 +90,3 @@ fmt.Printf("Received data %s\n", response) ``` - - - -```json Example -{ - "sleep": [ - { - "id": "6f9d156f-a497-47b2-b940-d13771c7c937", - "calendar_date": "2022-08-04", - "bedtime_start": "2022-08-04T12:42:45.724597+00:00", - "bedtime_stop": "2022-08-04T12:42:45.724600+00:00", - "timezone_offset": 2400, - "duration": 28800, - "total": 28800, - "awake": 2400, - "light": 2400, - "rem": 2400, - "deep": 2400, - "hr_lowest": 43, - "hr_average": 50, - "hr_dip": 19.7, - "efficiency": 0.97, - "latency": 1000, - "temperature_delta": -0.2, - "average_hrv": 78, - "respiratory_rate": 14, - "source": { - "name": "Oura", - "slug": "oura", - "logo": "https://logo_url.com" - }, - "user_id": "1ede2505-5ba1-41d2-a1a5-ed6887198fa4" - } - ] -} -``` - - diff --git a/docs/api-reference/data/timeseries/blood-oxygen.mdx b/docs/api-reference/data/timeseries/blood-oxygen.mdx index eaab46786..7e0b95b85 100644 --- a/docs/api-reference/data/timeseries/blood-oxygen.mdx +++ b/docs/api-reference/data/timeseries/blood-oxygen.mdx @@ -103,29 +103,3 @@ fmt.Printf("Received data %s\n", response) ``` - - - -```json Example -{ - "groups": { - "oura": [ - { - "data": [ - { - "timestamp": "2023-02-13T14:30:52+00:00", - "unit": "%", - "value": 98 - } - ], - "source": { - "provider": "oura", - "type": "ring" - } - } - ] - } -} -``` - - diff --git a/docs/api-reference/data/timeseries/blood-pressure.mdx b/docs/api-reference/data/timeseries/blood-pressure.mdx index 99608caf5..55233562b 100644 --- a/docs/api-reference/data/timeseries/blood-pressure.mdx +++ b/docs/api-reference/data/timeseries/blood-pressure.mdx @@ -103,30 +103,3 @@ fmt.Printf("Received data %s\n", response) ``` - - - -```json Example -{ - "groups": { - "oura": [ - { - "data": [ - { - "diastolic": 75, - "systolic": 125, - "timestamp": "2024-08-23T15:32:24+00:00", - "unit": "mmHg" - } - ], - "source": { - "provider": "oura", - "type": "ring" - } - } - ] - } -} -``` - - diff --git a/docs/api-reference/data/timeseries/body-fat.mdx b/docs/api-reference/data/timeseries/body-fat.mdx index f179980f9..0fe8c156a 100644 --- a/docs/api-reference/data/timeseries/body-fat.mdx +++ b/docs/api-reference/data/timeseries/body-fat.mdx @@ -103,29 +103,3 @@ fmt.Printf("Received data %s\n", response) ``` - - - -```json Example -{ - "groups": { - "oura": [ - { - "data": [ - { - "timestamp": "2023-02-13T14:30:52+00:00", - "unit": "%", - "value": 50 - } - ], - "source": { - "provider": "oura", - "type": "ring" - } - } - ] - } -} -``` - - diff --git a/docs/api-reference/data/timeseries/body-temperature-delta.mdx b/docs/api-reference/data/timeseries/body-temperature-delta.mdx index 09bfead70..d7989dc51 100644 --- a/docs/api-reference/data/timeseries/body-temperature-delta.mdx +++ b/docs/api-reference/data/timeseries/body-temperature-delta.mdx @@ -103,31 +103,3 @@ fmt.Printf("Received data %s\n", response) ``` - - - -```json Example -{ - "groups": { - "oura": [ - { - "data": [ - { - "end": "2023-02-13T14:57:24+00:00", - "sensor_location": "wrist", - "start": "2023-02-13T14:30:52+00:00", - "unit": "\u00b0C", - "value": -1.0 - } - ], - "source": { - "provider": "oura", - "type": "ring" - } - } - ] - } -} -``` - - diff --git a/docs/api-reference/data/timeseries/body-temperature.mdx b/docs/api-reference/data/timeseries/body-temperature.mdx index ce08f4def..b637288b7 100644 --- a/docs/api-reference/data/timeseries/body-temperature.mdx +++ b/docs/api-reference/data/timeseries/body-temperature.mdx @@ -103,31 +103,3 @@ fmt.Printf("Received data %s\n", response) ``` - - - -```json Example -{ - "groups": { - "oura": [ - { - "data": [ - { - "end": "2023-02-13T14:30:52+00:00", - "sensor_location": "eardrum", - "start": "2023-02-13T14:30:52+00:00", - "unit": "\u00b0C", - "value": 65 - } - ], - "source": { - "provider": "oura", - "type": "ring" - } - } - ] - } -} -``` - - diff --git a/docs/api-reference/data/timeseries/body-weight.mdx b/docs/api-reference/data/timeseries/body-weight.mdx index 562de1373..5a9d9ebdd 100644 --- a/docs/api-reference/data/timeseries/body-weight.mdx +++ b/docs/api-reference/data/timeseries/body-weight.mdx @@ -103,29 +103,3 @@ fmt.Printf("Received data %s\n", response) ``` - - - -```json Example -{ - "groups": { - "oura": [ - { - "data": [ - { - "timestamp": "2023-02-13T14:30:52+00:00", - "unit": "kg", - "value": 65 - } - ], - "source": { - "provider": "oura", - "type": "ring" - } - } - ] - } -} -``` - - diff --git a/docs/api-reference/data/timeseries/caffeine.mdx b/docs/api-reference/data/timeseries/caffeine.mdx index 1ac0c9c15..2a848b788 100644 --- a/docs/api-reference/data/timeseries/caffeine.mdx +++ b/docs/api-reference/data/timeseries/caffeine.mdx @@ -103,30 +103,3 @@ fmt.Printf("Received data %s\n", response) ``` - - - -```json Example -{ - "groups": { - "oura": [ - { - "data": [ - { - "end": "2023-02-13T14:57:24+00:00", - "start": "2023-02-13T14:30:52+00:00", - "unit": "g", - "value": 42 - } - ], - "source": { - "provider": "oura", - "type": "ring" - } - } - ] - } -} -``` - - diff --git a/docs/api-reference/data/timeseries/calories-active.mdx b/docs/api-reference/data/timeseries/calories-active.mdx index b1350648e..e1b6d6b0a 100644 --- a/docs/api-reference/data/timeseries/calories-active.mdx +++ b/docs/api-reference/data/timeseries/calories-active.mdx @@ -103,30 +103,3 @@ fmt.Printf("Received data %s\n", response) ``` - - - -```json Example -{ - "groups": { - "oura": [ - { - "data": [ - { - "end": "2023-02-13T14:57:24+00:00", - "start": "2023-02-13T14:30:52+00:00", - "unit": "kcal", - "value": 184 - } - ], - "source": { - "provider": "oura", - "type": "ring" - } - } - ] - } -} -``` - - diff --git a/docs/api-reference/data/timeseries/calories-basal.mdx b/docs/api-reference/data/timeseries/calories-basal.mdx index 296b3902a..1966e6469 100644 --- a/docs/api-reference/data/timeseries/calories-basal.mdx +++ b/docs/api-reference/data/timeseries/calories-basal.mdx @@ -103,30 +103,3 @@ fmt.Printf("Received data %s\n", response) ``` - - - -```json Example -{ - "groups": { - "oura": [ - { - "data": [ - { - "end": "2023-02-13T14:57:24+00:00", - "start": "2023-02-13T14:30:52+00:00", - "unit": "kcal", - "value": 22.8 - } - ], - "source": { - "provider": "oura", - "type": "ring" - } - } - ] - } -} -``` - - diff --git a/docs/api-reference/data/timeseries/carbohydrates.mdx b/docs/api-reference/data/timeseries/carbohydrates.mdx index 481ebaea5..4d1bdd220 100644 --- a/docs/api-reference/data/timeseries/carbohydrates.mdx +++ b/docs/api-reference/data/timeseries/carbohydrates.mdx @@ -103,30 +103,3 @@ fmt.Printf("Received data %s\n", response) ``` - - - -```json Example -{ - "groups": { - "oura": [ - { - "data": [ - { - "end": "2023-02-13T14:30:52+00:00", - "start": "2023-02-13T14:30:52+00:00", - "unit": "g", - "value": 30 - } - ], - "source": { - "provider": "oura", - "type": "ring" - } - } - ] - } -} -``` - - diff --git a/docs/api-reference/data/timeseries/cholesterol.mdx b/docs/api-reference/data/timeseries/cholesterol.mdx index 8264d78a1..299858cef 100644 --- a/docs/api-reference/data/timeseries/cholesterol.mdx +++ b/docs/api-reference/data/timeseries/cholesterol.mdx @@ -103,48 +103,3 @@ fmt.Printf("Received data %s\n", response) ``` - - - -```json Example -{ - "groups": { - "oura": [ - { - "data": [ - { - "timestamp": "2023-02-13T14:30:52+00:00", - "type": "cholesterol/ldl", - "unit": "mmol/L", - "value": 0.6 - }, - { - "timestamp": "2023-02-13T14:30:52+00:00", - "type": "cholesterol/hdl", - "unit": "mmol/L", - "value": 0.2 - }, - { - "timestamp": "2023-02-13T14:30:52+00:00", - "type": "cholesterol/total", - "unit": "mmol/L", - "value": 0.7 - }, - { - "timestamp": "2023-02-13T14:30:52+00:00", - "type": "cholesterol/triglycerides", - "unit": "mmol/L", - "value": 0.7 - } - ], - "source": { - "provider": "oura", - "type": "ring" - } - } - ] - } -} -``` - - diff --git a/docs/api-reference/data/timeseries/distance.mdx b/docs/api-reference/data/timeseries/distance.mdx index 4c9de296d..c3b32d2bb 100644 --- a/docs/api-reference/data/timeseries/distance.mdx +++ b/docs/api-reference/data/timeseries/distance.mdx @@ -103,30 +103,3 @@ fmt.Printf("Received data %s\n", response) ``` - - - -```json Example -{ - "groups": { - "oura": [ - { - "data": [ - { - "end": "2023-02-13T14:57:24+00:00", - "start": "2023-02-13T14:30:52+00:00", - "unit": "m", - "value": 5.6 - } - ], - "source": { - "provider": "oura", - "type": "ring" - } - } - ] - } -} -``` - - diff --git a/docs/api-reference/data/timeseries/electrocardiogram-voltage.mdx b/docs/api-reference/data/timeseries/electrocardiogram-voltage.mdx index a9d5b87f5..30665a462 100644 --- a/docs/api-reference/data/timeseries/electrocardiogram-voltage.mdx +++ b/docs/api-reference/data/timeseries/electrocardiogram-voltage.mdx @@ -103,30 +103,3 @@ fmt.Printf("Received data %s\n", response) ``` - - - -```json Example -{ - "groups": { - "oura": [ - { - "data": [ - { - "timestamp": "2023-02-13T14:30:52+00:00", - "type": "lead_1", - "unit": "mV", - "value": -373 - } - ], - "source": { - "provider": "oura", - "type": "ring" - } - } - ] - } -} -``` - - diff --git a/docs/api-reference/data/timeseries/floors-climbed.mdx b/docs/api-reference/data/timeseries/floors-climbed.mdx index f5266f874..17a1f9784 100644 --- a/docs/api-reference/data/timeseries/floors-climbed.mdx +++ b/docs/api-reference/data/timeseries/floors-climbed.mdx @@ -103,30 +103,3 @@ fmt.Printf("Received data %s\n", response) ``` - - - -```json Example -{ - "groups": { - "oura": [ - { - "data": [ - { - "end": "2023-02-13T14:57:24+00:00", - "start": "2023-02-13T14:30:52+00:00", - "unit": "count", - "value": 2 - } - ], - "source": { - "provider": "oura", - "type": "ring" - } - } - ] - } -} -``` - - diff --git a/docs/api-reference/data/timeseries/glucose.mdx b/docs/api-reference/data/timeseries/glucose.mdx index 97b1e8283..b491c667a 100644 --- a/docs/api-reference/data/timeseries/glucose.mdx +++ b/docs/api-reference/data/timeseries/glucose.mdx @@ -103,30 +103,3 @@ fmt.Printf("Received data %s\n", response) ``` - - - -```json Example -{ - "groups": { - "oura": [ - { - "data": [ - { - "timestamp": "2023-02-13T14:30:52+00:00", - "type": "automatic | manual_scan", - "unit": "mmol/L", - "value": 0.5 - } - ], - "source": { - "provider": "oura", - "type": "ring" - } - } - ] - } -} -``` - - diff --git a/docs/api-reference/data/timeseries/heartrate.mdx b/docs/api-reference/data/timeseries/heartrate.mdx index 0359f2718..fb01808e3 100644 --- a/docs/api-reference/data/timeseries/heartrate.mdx +++ b/docs/api-reference/data/timeseries/heartrate.mdx @@ -103,29 +103,3 @@ fmt.Printf("Received data %s\n", response) ``` - - - -```json Example -{ - "groups": { - "oura": [ - { - "data": [ - { - "timestamp": "2023-02-13T14:30:52+00:00", - "unit": "bpm", - "value": 70 - } - ], - "source": { - "provider": "oura", - "type": "ring" - } - } - ] - } -} -``` - - diff --git a/docs/api-reference/data/timeseries/hrv.mdx b/docs/api-reference/data/timeseries/hrv.mdx index fdd14d150..87b5db93c 100644 --- a/docs/api-reference/data/timeseries/hrv.mdx +++ b/docs/api-reference/data/timeseries/hrv.mdx @@ -103,29 +103,3 @@ fmt.Printf("Received data %s\n", response) ``` - - - -```json Example -{ - "groups": { - "oura": [ - { - "data": [ - { - "timestamp": "2023-02-13T14:30:52+00:00", - "unit": "rmssd", - "value": 48 - } - ], - "source": { - "provider": "oura", - "type": "ring" - } - } - ] - } -} -``` - - diff --git a/docs/api-reference/data/timeseries/hypnogram.mdx b/docs/api-reference/data/timeseries/hypnogram.mdx index 4b6f9d6fa..efff6b4ac 100644 --- a/docs/api-reference/data/timeseries/hypnogram.mdx +++ b/docs/api-reference/data/timeseries/hypnogram.mdx @@ -103,30 +103,3 @@ fmt.Printf("Received data %s\n", response) ``` - - - -```json Example -{ - "groups": { - "oura": [ - { - "data": [ - { - "end": "2023-02-13T14:57:24+00:00", - "start": "2023-02-13T14:30:52+00:00", - "unit": "stage", - "value": 1 - } - ], - "source": { - "provider": "oura", - "type": "ring" - } - } - ] - } -} -``` - - diff --git a/docs/api-reference/data/timeseries/ige.mdx b/docs/api-reference/data/timeseries/ige.mdx index bbad9e60a..df24d2c54 100644 --- a/docs/api-reference/data/timeseries/ige.mdx +++ b/docs/api-reference/data/timeseries/ige.mdx @@ -103,30 +103,3 @@ fmt.Printf("Received data %s\n", response) ``` - - - -```json Example -{ - "groups": { - "oura": [ - { - "data": [ - { - "timestamp": "2023-02-13T14:30:52+00:00", - "type": "baha_grass", - "unit": "FSU", - "value": 70 - } - ], - "source": { - "provider": "oura", - "type": "ring" - } - } - ] - } -} -``` - - diff --git a/docs/api-reference/data/timeseries/igg.mdx b/docs/api-reference/data/timeseries/igg.mdx index 68c97f8e9..f7985b157 100644 --- a/docs/api-reference/data/timeseries/igg.mdx +++ b/docs/api-reference/data/timeseries/igg.mdx @@ -103,30 +103,3 @@ fmt.Printf("Received data %s\n", response) ``` - - - -```json Example -{ - "groups": { - "oura": [ - { - "data": [ - { - "timestamp": "2023-02-13T14:30:52+00:00", - "type": "dairy", - "unit": "FSU", - "value": 12.0 - } - ], - "source": { - "provider": "oura", - "type": "ring" - } - } - ] - } -} -``` - - diff --git a/docs/api-reference/data/timeseries/insulin-injection.mdx b/docs/api-reference/data/timeseries/insulin-injection.mdx index ddc96b308..6a8a9ae73 100644 --- a/docs/api-reference/data/timeseries/insulin-injection.mdx +++ b/docs/api-reference/data/timeseries/insulin-injection.mdx @@ -103,31 +103,3 @@ fmt.Printf("Received data %s\n", response) ``` - - - -```json Example -{ - "groups": { - "oura": [ - { - "data": [ - { - "end": "2023-02-13T14:30:52+00:00", - "start": "2023-02-13T14:30:52+00:00", - "type": "long_acting", - "unit": "unit", - "value": 60 - } - ], - "source": { - "provider": "oura", - "type": "ring" - } - } - ] - } -} -``` - - diff --git a/docs/api-reference/data/timeseries/mindfulness-minutes.mdx b/docs/api-reference/data/timeseries/mindfulness-minutes.mdx index c0ea0f3e3..0d54e4013 100644 --- a/docs/api-reference/data/timeseries/mindfulness-minutes.mdx +++ b/docs/api-reference/data/timeseries/mindfulness-minutes.mdx @@ -103,30 +103,3 @@ fmt.Printf("Received data %s\n", response) ``` - - - -```json Example -{ - "groups": { - "oura": [ - { - "data": [ - { - "end": "2024-08-23T15:37:24.453832+00:00", - "start": "2023-02-13T14:57:24+00:00", - "unit": "min", - "value": 42 - } - ], - "source": { - "provider": "oura", - "type": "ring" - } - } - ] - } -} -``` - - diff --git a/docs/api-reference/data/timeseries/note.mdx b/docs/api-reference/data/timeseries/note.mdx index 5324a16dd..44350dbcb 100644 --- a/docs/api-reference/data/timeseries/note.mdx +++ b/docs/api-reference/data/timeseries/note.mdx @@ -103,34 +103,3 @@ fmt.Printf("Received data %s\n", response) ``` - - - -```json Example -{ - "groups": { - "oura": [ - { - "data": [ - { - "end": "2023-02-13T14:30:52+00:00", - "start": "2023-02-13T14:30:52+00:00", - "type": [ - "food", - "exercise" - ], - "unit": "text", - "value": "Lorem ipsum dolor sit amet" - } - ], - "source": { - "provider": "oura", - "type": "ring" - } - } - ] - } -} -``` - - diff --git a/docs/api-reference/data/timeseries/respiratory-rate.mdx b/docs/api-reference/data/timeseries/respiratory-rate.mdx index bf6d79043..4076f4061 100644 --- a/docs/api-reference/data/timeseries/respiratory-rate.mdx +++ b/docs/api-reference/data/timeseries/respiratory-rate.mdx @@ -103,29 +103,3 @@ fmt.Printf("Received data %s\n", response) ``` - - - -```json Example -{ - "groups": { - "oura": [ - { - "data": [ - { - "timestamp": "2023-02-13T14:30:52+00:00", - "unit": "bpm", - "value": 15.5 - } - ], - "source": { - "provider": "oura", - "type": "ring" - } - } - ] - } -} -``` - - diff --git a/docs/api-reference/data/timeseries/steps.mdx b/docs/api-reference/data/timeseries/steps.mdx index 09d1be3a2..caa17841a 100644 --- a/docs/api-reference/data/timeseries/steps.mdx +++ b/docs/api-reference/data/timeseries/steps.mdx @@ -103,30 +103,3 @@ fmt.Printf("Received data %s\n", response) ``` - - - -```json Example -{ - "groups": { - "oura": [ - { - "data": [ - { - "end": "2023-02-13T14:57:24+00:00", - "start": "2023-02-13T14:30:52+00:00", - "unit": "count", - "value": 123 - } - ], - "source": { - "provider": "oura", - "type": "ring" - } - } - ] - } -} -``` - - diff --git a/docs/api-reference/data/timeseries/stress-level.mdx b/docs/api-reference/data/timeseries/stress-level.mdx index 369ba2d45..5497ffed4 100644 --- a/docs/api-reference/data/timeseries/stress-level.mdx +++ b/docs/api-reference/data/timeseries/stress-level.mdx @@ -103,29 +103,3 @@ fmt.Printf("Received data %s\n", response) ``` - - - -```json Example -{ - "groups": { - "oura": [ - { - "data": [ - { - "timestamp": "2023-02-13T14:30:52+00:00", - "unit": "%", - "value": 35 - } - ], - "source": { - "provider": "oura", - "type": "ring" - } - } - ] - } -} -``` - - diff --git a/docs/api-reference/data/timeseries/vo2-max.mdx b/docs/api-reference/data/timeseries/vo2-max.mdx index 20df86943..56aa9bfc3 100644 --- a/docs/api-reference/data/timeseries/vo2-max.mdx +++ b/docs/api-reference/data/timeseries/vo2-max.mdx @@ -103,30 +103,3 @@ fmt.Printf("Received data %s\n", response) ``` - - - -```json Example -{ - "groups": { - "oura": [ - { - "data": [ - { - "end": "2023-02-13T14:57:24+00:00", - "start": "2023-02-13T14:30:52+00:00", - "unit": "mL/kg/min", - "value": 48 - } - ], - "source": { - "provider": "oura", - "type": "ring" - } - } - ] - } -} -``` - - diff --git a/docs/api-reference/data/timeseries/water.mdx b/docs/api-reference/data/timeseries/water.mdx index 66e298f35..819277208 100644 --- a/docs/api-reference/data/timeseries/water.mdx +++ b/docs/api-reference/data/timeseries/water.mdx @@ -103,30 +103,3 @@ fmt.Printf("Received data %s\n", response) ``` - - - -```json Example -{ - "groups": { - "oura": [ - { - "data": [ - { - "end": "2023-02-13T14:57:24+00:00", - "start": "2023-02-13T14:30:52+00:00", - "unit": "ml", - "value": 400 - } - ], - "source": { - "provider": "oura", - "type": "ring" - } - } - ] - } -} -``` - - diff --git a/docs/api-reference/data/timeseries/workout-duration.mdx b/docs/api-reference/data/timeseries/workout-duration.mdx index b43ca507e..953d3c664 100644 --- a/docs/api-reference/data/timeseries/workout-duration.mdx +++ b/docs/api-reference/data/timeseries/workout-duration.mdx @@ -103,31 +103,3 @@ fmt.Printf("Received data %s\n", response) ``` - - - -```json Example -{ - "groups": { - "oura": [ - { - "data": [ - { - "end": "2023-02-13T14:30:52+00:00", - "intensity": "medium", - "start": "2023-02-13T14:30:52+00:00", - "unit": "min", - "value": 48 - } - ], - "source": { - "provider": "oura", - "type": "ring" - } - } - ] - } -} -``` - - diff --git a/docs/api-reference/data/workouts/get-raw.mdx b/docs/api-reference/data/workouts/get-raw.mdx index 671b5ae07..4a13c523b 100644 --- a/docs/api-reference/data/workouts/get-raw.mdx +++ b/docs/api-reference/data/workouts/get-raw.mdx @@ -89,25 +89,3 @@ fmt.Printf("Received data %s\n", response) ``` - - - -```json Example -{ - "workouts": [ - { - "timestamp": "2022-08-04T12:42:44.857707+00:00", - "data": { - "provider_specific": "..._data" - }, - "provider_id": "61709202-ab4d-480a-8cc0-254e64d7c33e", - "user_id": "ba6a785a-b3c3-4bda-ad8c-4571b67f6089", - "source_id": 1, - "priority_id": 1, - "sport_id": 3 - } - ] -} -``` - - diff --git a/docs/api-reference/data/workouts/get-stream.mdx b/docs/api-reference/data/workouts/get-stream.mdx index fd245f729..d15f009a3 100644 --- a/docs/api-reference/data/workouts/get-stream.mdx +++ b/docs/api-reference/data/workouts/get-stream.mdx @@ -71,22 +71,3 @@ fmt.Printf("Received data %s\n", response) ``` - - - -```json Example -{ - "cadence": [10, 12, 12, 11, 10], - "time": [1626625123, 1626625140, 1626625145, 1626625150, 162662560], - "heartrate": [120, 125, 125, 130, 135], - "distance": [12, 15, 18, 20, 25], - "power": [100, 100, 100, 100, 100], - "altitude": [10, 20, 30, 40, 50], - "velocity_smooth": [10, 20, 30, 40, 50], - "lat": [10, 20, 30, 40, 50], - "lng": [10, 20, 30, 40, 50], - "resistance": [10, 20, 30, 40, 50] -} -``` - - diff --git a/docs/api-reference/data/workouts/get-summary.mdx b/docs/api-reference/data/workouts/get-summary.mdx index c3ccf4e05..4d1594dab 100644 --- a/docs/api-reference/data/workouts/get-summary.mdx +++ b/docs/api-reference/data/workouts/get-summary.mdx @@ -93,48 +93,3 @@ fmt.Printf("Received data %s\n", response) ``` - - - -```json Response -{ - "workouts": { - "id": "f09c1083-701f-4030-b43d-e48825377de9", - "average_hr": 100, - "max_hr": 190, - "distance": 1700, - "calendar_date": "2022-08-04", - "time_start": "2022-08-04T11:42:44.864554+00:00", - "time_end": "2022-08-04T12:42:44.864576+00:00", - "timezone_offset": 2400, - "calories": 300, - "sport": { - "id": 1, - "name": "football" - }, - "source": { - "name": "Strava", - "slug": "strava", - "logo": "https://logo_url.com" - }, - "hr_zones": [100, 90, 10, 10, 200], - "user_id": "701830a9-bd50-48d5-91e5-8c7485d95c12", - "moving_time": 100, - "total_elevation_gain": 10, - "elev_high": 20.2, - "elev_low": -10.2, - "average_speed": 4.2, - "max_speed": 7.8, - "average_watts": 100, - "device_watts": 80, - "max_watts": 200, - "weighted_average_watts": 250, - "map": { - "summary_polyline": "agn~Ftb{uOvr@daBunBjdBkHwiD????" - } - }, - "title": "Workout Data" -} -``` - - diff --git a/docs/api-reference/lab-testing/area-info.mdx b/docs/api-reference/lab-testing/area-info.mdx index c804c8c0f..8b6509794 100644 --- a/docs/api-reference/lab-testing/area-info.mdx +++ b/docs/api-reference/lab-testing/area-info.mdx @@ -81,34 +81,3 @@ fmt.Printf("Received data %s\n", response) ``` - - - -```json Response -{ - "zip_code": "85004", - "phlebotomy": { - "is_served": true, - "providers": [ - { - "name": "getlabs", - "tier": ["appointment-ready"] - }, - { - "name": "phlebfinders", - "tier": ["appointment-request"] - } - ] - }, - "central_labs": { - "labcorp": { - "patient_service_centers": { - "within_radius": 5, - "radius": "25" - } - } - } -} -``` - - diff --git a/docs/api-reference/lab-testing/at-home-phlebotomy/appointment-availability.mdx b/docs/api-reference/lab-testing/at-home-phlebotomy/appointment-availability.mdx index 61981db90..8fea4c6dd 100644 --- a/docs/api-reference/lab-testing/at-home-phlebotomy/appointment-availability.mdx +++ b/docs/api-reference/lab-testing/at-home-phlebotomy/appointment-availability.mdx @@ -113,43 +113,3 @@ fmt.Printf("Received data %s\n", response) ``` - - -```json Response -{ - "timezone":"America/Phoenix", - "slots": [ - { - "date":"2023-05-09", - "slots": [ - { - "booking_key": "foo123", - "start": "2023-05-09T17:00:00+00:00", - "end": "2023-05-09T19:00:00+00:00", - "expires_at": "2023-05-09T12:39:57.827000+00:00", - "price": 3500, - "is_priority": true, - "num_appointments_available": 5 - }, - ... - ], - }, - { - "date":"2023-05-10", - "slots": [ - { - "booking_key": "bar456", - "start": "2023-05-10T12:00:00+00:00", - "end": "2023-05-10T14:00:00+00:00", - "expires_at": "2023-05-09T12:39:57.852000+00:00", - "price": 7900, - "is_priority": true, - "num_appointments_available": 5 - }, - ... - ], - }, - ] -} -``` - diff --git a/docs/api-reference/lab-testing/at-home-phlebotomy/appointment-booking.mdx b/docs/api-reference/lab-testing/at-home-phlebotomy/appointment-booking.mdx index 2aa382fce..25797a1de 100644 --- a/docs/api-reference/lab-testing/at-home-phlebotomy/appointment-booking.mdx +++ b/docs/api-reference/lab-testing/at-home-phlebotomy/appointment-booking.mdx @@ -86,32 +86,3 @@ fmt.Printf("Received data %s\n", response) ``` - - -```json Response -{ - "id": "413d7205-f8a9-42ed-aa4a-edb99e481ca0", - "user_id": "202b2c2f-fb4c-44dc-a4f8-621186fde227", - "address": { - "first_line": "West Lincoln Street", - "second_line": "", - "city": "Phoenix", - "state": "AZ", - "zip_code": "85004", - "unit": "14" - }, - "location": { - "lng": -112.0772235, - "lat": 33.4421912 - }, - "start_at": "2023-05-15T16:00:00+00:00", - "end_at": "2023-05-15T18:00:00+00:00", - "iana_timezone": "America/Phoenix", - "type": "phlebotomy", - "provider": "getlabs", - "status": "pending", - "provider_id": "e89eb489-7382-4966-bb14-7ab4763eba6c", - "can_reschedule":true -} -``` - diff --git a/docs/api-reference/lab-testing/at-home-phlebotomy/appointment-cancellation-reasons.mdx b/docs/api-reference/lab-testing/at-home-phlebotomy/appointment-cancellation-reasons.mdx index d982d0a85..5a33f951b 100644 --- a/docs/api-reference/lab-testing/at-home-phlebotomy/appointment-cancellation-reasons.mdx +++ b/docs/api-reference/lab-testing/at-home-phlebotomy/appointment-cancellation-reasons.mdx @@ -68,65 +68,3 @@ fmt.Printf("Received data %s\n", response) ``` - - -```json -[ - { - "id": "5c0257ef-6fea-4a22-b20a-3ddab573d5c9", - "name": "Did not fast for appointment", - "is_refundable": true - }, - { - "id": "448c519c-64b4-4497-ae73-622fa93371b3", - "name": "Do not trust company", - "is_refundable": true - }, - { - "id": "d378e152-12d1-433e-9dd1-e0410f9331dc", - "name": "Getlabs cannot deliver to my preferred lab", - "is_refundable": true - }, - { - "id": "5330c863-ac80-4316-901b-d305d0df74d5", - "name": "No longer interested", - "is_refundable": true - }, - { - "id": "2b9f23fd-163e-4483-bb10-90c74a67e0dc", - "name": "Other", - "is_refundable": true - }, - { - "id": "98f861dd-fe61-4817-a9d6-1b99b19cd0fb", - "name": "Provider asked me to cancel", - "is_refundable": true - }, - { - "id": "7dfd7da5-ed6e-40bb-a7e4-c8003f0c10a9", - "name": "Scheduled for wrong patient", - "is_refundable": true - }, - { - "id": "796da8c8-e654-4347-8ded-1026410c1976", - "name": "Scheduled time no longer works", - "is_refundable": true - }, - { - "id": "ba02af35-a34f-4a7a-abe5-5f766e8f6cd1", - "name": "Unable to get lab order from provider", - "is_refundable": true - }, - { - "id": "0c9425db-f11e-49c5-b976-3c0d1d4a4ea8", - "name": "Wanted to book in-person appointment", - "is_refundable": true - }, - { - "id": "2599a0ea-0b4a-42fe-8df6-d8f7c68182e7", - "name": "Went to lab for appointment", - "is_refundable": true - } -] -``` - diff --git a/docs/api-reference/lab-testing/at-home-phlebotomy/appointment-cancelling.mdx b/docs/api-reference/lab-testing/at-home-phlebotomy/appointment-cancelling.mdx index 90abd167d..e552d0da9 100644 --- a/docs/api-reference/lab-testing/at-home-phlebotomy/appointment-cancelling.mdx +++ b/docs/api-reference/lab-testing/at-home-phlebotomy/appointment-cancelling.mdx @@ -87,32 +87,3 @@ fmt.Printf("Received data %s\n", response) ``` - - -```json Response -{ - "id": "413d7205-f8a9-42ed-aa4a-edb99e481ca0", - "user_id": "202b2c2f-fb4c-44dc-a4f8-621186fde227", - "address": { - "first_line": "West Lincoln Street", - "second_line": "", - "city": "Phoenix", - "state": "AZ", - "zip_code": "85004", - "unit": "14" - }, - "location": { - "lng": -112.0772235, - "lat": 33.4421912 - }, - "start_at": "2023-05-17T20:00:00+00:00", - "end_at": "2023-05-17T22:00:00+00:00", - "iana_timezone": "America/Phoenix", - "type": "phlebotomy", - "provider": "getlabs", - "status": "cancelled", - "provider_id": "e89eb489-7382-4966-bb14-7ab4763eba6c", - "can_reschedule": true -} -``` - diff --git a/docs/api-reference/lab-testing/at-home-phlebotomy/appointment-request.mdx b/docs/api-reference/lab-testing/at-home-phlebotomy/appointment-request.mdx index e69b32e32..e5c9aa888 100644 --- a/docs/api-reference/lab-testing/at-home-phlebotomy/appointment-request.mdx +++ b/docs/api-reference/lab-testing/at-home-phlebotomy/appointment-request.mdx @@ -131,29 +131,3 @@ fmt.Printf("Received data %s\n", response) ``` - - -```json Response -{ - "id": "413d7205-f8a9-42ed-aa4a-edb99e481ca0", - "user_id": "202b2c2f-fb4c-44dc-a4f8-621186fde227", - "address": { - "first_line": "West Lincoln Street", - "second_line": "", - "city": "Phoenix", - "state": "AZ", - "zip_code": "85004", - "unit": "14" - }, - "location": { - "lng": -112.0772235, - "lat": 33.4421912 - }, - "type": "phlebotomy", - "provider": "phlebfinders", - "status": "pending", - "provider_id": "e89eb489-7382-4966-bb14-7ab4763eba6c", - "can_reschedule":false -} -``` - diff --git a/docs/api-reference/lab-testing/at-home-phlebotomy/appointment-rescheduling.mdx b/docs/api-reference/lab-testing/at-home-phlebotomy/appointment-rescheduling.mdx index 007eb7ea8..f0047f495 100644 --- a/docs/api-reference/lab-testing/at-home-phlebotomy/appointment-rescheduling.mdx +++ b/docs/api-reference/lab-testing/at-home-phlebotomy/appointment-rescheduling.mdx @@ -87,32 +87,3 @@ fmt.Printf("Received data %s\n", response) ``` - - -```json Response -{ - "id": "413d7205-f8a9-42ed-aa4a-edb99e481ca0", - "user_id": "202b2c2f-fb4c-44dc-a4f8-621186fde227", - "address": { - "first_line": "West Lincoln Street", - "second_line": "", - "city": "Phoenix", - "state": "AZ", - "zip_code": "85004", - "unit":"14" - }, - "location": { - "lng": -112.0772235, - "lat": 33.4421912 - }, - "start_at": "2023-05-17T20:00:00+00:00", - "end_at": "2023-05-17T22:00:00+00:00", - "iana_timezone": "America/Phoenix", - "type": "phlebotomy", - "provider": "getlabs", - "status": "pending", - "provider_id": "e89eb489-7382-4966-bb14-7ab4763eba6c", - "can_reschedule": true -} -``` - diff --git a/docs/api-reference/lab-testing/at-home-phlebotomy/get-appointment.mdx b/docs/api-reference/lab-testing/at-home-phlebotomy/get-appointment.mdx index 5aaebbf90..f36a4f6c7 100644 --- a/docs/api-reference/lab-testing/at-home-phlebotomy/get-appointment.mdx +++ b/docs/api-reference/lab-testing/at-home-phlebotomy/get-appointment.mdx @@ -67,32 +67,3 @@ fmt.Printf("Received data %s\n", response) ``` - - -```json Response -{ - "id": "413d7205-f8a9-42ed-aa4a-edb99e481ca0", - "user_id": "202b2c2f-fb4c-44dc-a4f8-621186fde227", - "address": { - "first_line": "West Lincoln Street", - "second_line": "", - "city": "Phoenix", - "state": "AZ", - "zip_code": "85004", - "unit": "14" - }, - "location": { - "lng": -112.0772235, - "lat": 33.4421912 - }, - "start_at": "2023-05-17T20:00:00+00:00", - "end_at": "2023-05-17T22:00:00+00:00", - "iana_timezone": "America/Phoenix", - "type": "phlebotomy", - "provider": "getlabs", - "status": "pending", - "provider_id": "e89eb489-7382-4966-bb14-7ab4763eba6c", - "can_reschedule": true -} -``` - diff --git a/docs/api-reference/lab-testing/biomarkers.mdx b/docs/api-reference/lab-testing/biomarkers.mdx index 5d69d08c8..b7c719d2d 100644 --- a/docs/api-reference/lab-testing/biomarkers.mdx +++ b/docs/api-reference/lab-testing/biomarkers.mdx @@ -68,72 +68,3 @@ fmt.Printf("Received data %s\n", response) ``` - - - -```json Response -{ - "markers": [ - { - "id": 202, - "name": "Acetylcholine Receptor (AChR) Antibodies, Complete Profile with Reflex to MuSK Antibodies", - "slug": "acetylcholine-receptor-achr-antibodies-complete-profile-with-reflex-to-musk-antibodies", - "description": "Acetylcholine Receptor (AChR) Antibodies, Complete Profile with Reflex to MuSK Antibodies", - "lab_id": 6, - "provider_id": "165605", - "type": "biomarker", - "unit": null, - "price": "N/A", - "expected_results": [ - { - "id": 2938, - "name": "AChR Blocking Abs, Serum", - "slug": "achr-blocking-abs-serum", - "lab_id": 6, - "provider_id": "085927", - "loinc": { - "id": 3514, - "name": "Acetylcholine receptor blocking Ab Qn (S)", - "slug": "acetylcholine-receptor-blocking-ab-qn-s", - "code": "11561-8", - "unit": "%{inhibition}" - } - }, - { - "id": 2939, - "name": "AChR Binding Abs, Serum", - "slug": "achr-binding-abs-serum", - "lab_id": 6, - "provider_id": "085904", - "loinc": { - "id": 3174, - "name": "Acetylcholine receptor binding Ab (S) [Moles/Vol]", - "slug": "acetylcholine-receptor-binding-ab-s-moles-vol", - "code": "11034-6", - "unit": "nmol/L" - } - }, - { - "id": 2940, - "name": "AChR-modulating Ab", - "slug": "achr-modulating-ab", - "lab_id": 6, - "provider_id": "505199", - "loinc": { - "id": 61121, - "name": "Acetylcholine receptor modulation Ab FC Ql (S)", - "slug": "acetylcholine-receptor-modulation-ab-fc-ql-s", - "code": "99062-2", - "unit": null - } - } - ] - }, - ], - "total": 2, - "page": 1, - "size": 2 -} -``` - - diff --git a/docs/api-reference/lab-testing/cancel-order.mdx b/docs/api-reference/lab-testing/cancel-order.mdx index 49f56d294..4d562592e 100644 --- a/docs/api-reference/lab-testing/cancel-order.mdx +++ b/docs/api-reference/lab-testing/cancel-order.mdx @@ -62,642 +62,3 @@ fmt.Printf("Received data %s\n", response) - - - -```json Response -[ - { - "order": { - "title": "ClientFacingOrder", - "required": [ - "user_id", - "id", - "team_id", - "patient_details", - "patient_address", - "lab_test", - "details", - "created_at", - "updated_at", - "events" - ], - "type": "object", - "properties": { - "user_id": { - "title": "User Id", - "type": "string", - "description": "User id returned by vital create user request. This id should be stored in your database against the user and used for all interactions with the vital api.", - "format": "uuid" - }, - "user_key": { - "title": "User Key", - "type": "string", - "description": "User key returned by vital create user key request. This key should be stored in your database against the user and used for all interactions with the vital api.", - "format": "uuid", - "deprecated": true - }, - "id": { - "title": "Id", - "type": "string", - "description": "The Vital Order ID", - "format": "uuid" - }, - "team_id": { - "title": "Team Id", - "type": "string", - "description": "Your team id.", - "format": "uuid" - }, - "patient_details": { - "title": "Patient Details", - "allOf": [ - { - "title": "PatientDetails", - "required": ["dob", "gender"], - "type": "object", - "properties": { - "dob": { - "title": "Dob", - "type": "string", - "format": "date-time" - }, - "gender": { - "title": "Gender", - "type": "string" - }, - "email": { - "title": "Email", - "type": "string" - } - } - } - ], - "description": "Patient Details" - }, - "patient_address": { - "title": "Patient Address", - "allOf": [ - { - "title": "PatientAddress", - "required": [ - "receiver_name", - "street", - "city", - "state", - "zip", - "country", - "phone_number" - ], - "type": "object", - "properties": { - "receiver_name": { - "title": "Receiver Name", - "type": "string" - }, - "street": { - "title": "Street", - "type": "string" - }, - "street_number": { - "title": "Street Number", - "type": "string" - }, - "city": { - "title": "City", - "type": "string" - }, - "state": { - "title": "State", - "type": "string" - }, - "zip": { - "title": "Zip", - "type": "string" - }, - "country": { - "title": "Country", - "type": "string" - }, - "phone_number": { - "title": "Phone Number", - "type": "string" - } - } - } - ], - "description": "Patient Address" - }, - "lab_test": { - "title": "Lab Test", - "allOf": [ - { - "title": "LabTestInDB", - "required": [ - "slug", - "name", - "sample_type", - "method", - "lab_id", - "price", - "is_active", - "created_at", - "updated_at", - "id" - ], - "type": "object", - "properties": { - "slug": { - "title": "Slug", - "type": "string" - }, - "name": { - "title": "Name", - "type": "string" - }, - "description": { - "title": "Description", - "type": "string" - }, - "sample_type": { - "title": "LabTestSampleType", - "enum": ["dried_blood_spot"], - "type": "string", - "description": "The type of sample used to perform a lab test." - }, - "method": { - "title": "LabTestMethod", - "enum": ["testkit", "walk_in_test"], - "type": "string", - "description": "The method used to perform a lab test." - }, - "lab_id": { - "title": "Lab Id", - "type": "integer" - }, - "skus": { - "title": "Skus", - "type": "array", - "items": { - "type": "object" - } - }, - "price": { - "title": "Price", - "type": "number" - }, - "is_active": { - "title": "Is Active", - "type": "boolean" - }, - "turnaround_time_lower": { - "title": "Turnaround Time Lower", - "type": "integer" - }, - "turnaround_time_upper": { - "title": "Turnaround Time Upper", - "type": "integer" - }, - "created_at": { - "title": "Created At", - "type": "string", - "format": "date-time" - }, - "updated_at": { - "title": "Updated At", - "type": "string", - "format": "date-time" - }, - "id": { - "title": "Id", - "type": "string", - "format": "uuid" - }, - "lab": { - "title": "LabInDB", - "required": [ - "slug", - "name", - "first_line_address", - "city", - "zipcode", - "id" - ], - "type": "object", - "properties": { - "slug": { - "title": "Slug", - "type": "string" - }, - "name": { - "title": "Name", - "type": "string" - }, - "first_line_address": { - "title": "First Line Address", - "type": "string" - }, - "city": { - "title": "City", - "type": "string" - }, - "zipcode": { - "title": "Zipcode", - "type": "string" - }, - "clia": { - "title": "Clia", - "type": "string" - }, - "created_at": { - "title": "Created At", - "type": "string", - "format": "date-time" - }, - "updated_at": { - "title": "Updated At", - "type": "string", - "format": "date-time" - }, - "id": { - "title": "Id", - "type": "integer" - } - } - }, - "markers": { - "title": "Markers", - "type": "array", - "items": { - "title": "MarkerInDB", - "required": ["name", "slug", "description", "id"], - "type": "object", - "properties": { - "name": { - "title": "Name", - "type": "string" - }, - "slug": { - "title": "Slug", - "type": "string" - }, - "description": { - "title": "Description", - "type": "string" - }, - "created_at": { - "title": "Created At", - "type": "string", - "format": "date-time" - }, - "updated_at": { - "title": "Updated At", - "type": "string", - "format": "date-time" - }, - "id": { - "title": "Id", - "type": "integer" - } - } - } - } - }, - "description": "Schema for a LabTest in the database." - } - ], - "description": "The Vital Test associated with the order" - }, - "details": { - "title": "Details", - "anyOf": [ - { - "title": "ClientFacingWalkInOrderDetails", - "required": ["type"], - "type": "object", - "properties": { - "type": { - "title": "Type", - "enum": ["walk_in_test"], - "type": "string" - }, - "data": { - "title": "ClientFacingWalkInTestOrder", - "required": ["id", "created_at", "updated_at"], - "type": "object", - "properties": { - "id": { - "title": "Id", - "type": "string", - "description": "The Vital walk-in test Order ID", - "format": "uuid" - }, - "created_at": { - "title": "Created At", - "type": "string", - "format": "date-time" - }, - "updated_at": { - "title": "Updated At", - "type": "string", - "format": "date-time" - } - }, - "description": "Schema for a walk-in test order in the client facing API.\n\nTo be used as part of a ClientFacingOrder.", - "example": { - "id": "0651ee15-31a1-461b-9c10-86aa960da6c9", - "created_at": "2020-01-01T00:00:00Z", - "updated_at": "2020-01-01T00:00:00Z" - } - } - } - }, - { - "title": "ClientFacingTestKitOrderDetails", - "required": ["type"], - "type": "object", - "properties": { - "type": { - "title": "Type", - "enum": ["testkit"], - "type": "string" - }, - "data": { - "title": "ClientFacingTestkitOrder", - "required": ["id", "created_at", "updated_at"], - "type": "object", - "properties": { - "id": { - "title": "Id", - "type": "string", - "description": "The Vital TestKit Order ID", - "format": "uuid" - }, - "shipment": { - "title": "Shipment", - "allOf": [ - { - "title": "ClientFacingShipment", - "required": [ - "id", - "outbound_tracking_number", - "outbound_tracking_url", - "inbound_tracking_number", - "inbound_tracking_url", - "outbound_courier", - "inbound_courier", - "notes" - ], - "type": "object", - "properties": { - "id": { - "title": "Id", - "type": "string", - "description": "The Vital Shipment ID", - "format": "uuid" - }, - "outbound_tracking_number": { - "title": "Outbound Tracking Number", - "type": "string", - "description": "Tracking number for delivery to customer" - }, - "outbound_tracking_url": { - "title": "Outbound Tracking Url", - "type": "string", - "description": "Tracking url for delivery to customer" - }, - "inbound_tracking_number": { - "title": "Inbound Tracking Number", - "type": "string", - "description": "Tracking number for delivery to lab" - }, - "inbound_tracking_url": { - "title": "Inbound Tracking Url", - "type": "string", - "description": "Tracking url for delivery to lab" - }, - "outbound_courier": { - "title": "Outbound Courier", - "type": "string", - "description": "Courier used for delivery to customer" - }, - "inbound_courier": { - "title": "Inbound Courier", - "type": "string", - "description": "Courier used for delivery to lab" - }, - "notes": { - "title": "Notes", - "type": "string", - "description": "Notes associated to the Vital shipment" - } - }, - "description": "Schema for a Shipment in the client facing API.\n\nTo be used as part of a ClientFacingTestkitOrder.", - "example": { - "id": "dcab86c6-a315-493d-97aa-2fd0fa649130", - "outbound_tracking_number": "", - "outbound_tracking_url": "", - "inbound_tracking_number": "", - "inbound_tracking_url": "", - "outbound_courier": "usps", - "inbound_courier": "usps", - "notes": "" - } - } - ], - "description": "Shipment object" - }, - "created_at": { - "title": "Created At", - "type": "string", - "format": "date-time" - }, - "updated_at": { - "title": "Updated At", - "type": "string", - "format": "date-time" - } - }, - "description": "Schema for a testkit order in the client facing API.\n\nTo be used as part of a ClientFacingOrder.", - "example": { - "id": "43697a79-298f-43db-9703-e4cf16006c66", - "shipment": { - "id": "51caeb91-cc5c-4f82-a4c2-6f23b68e54c5", - "outbound_tracking_number": "", - "outbound_tracking_url": "", - "inbound_tracking_number": "", - "inbound_tracking_url": "", - "outbound_courier": "usps", - "inbound_courier": "usps", - "notes": "", - "created_at": "2020-01-01T00:00:00.000Z", - "updated_at": "2020-01-01T00:00:00.000Z" - }, - "created_at": "2020-01-01T00:00:00Z", - "updated_at": "2020-01-01T00:00:00Z" - } - } - } - } - ] - }, - "sample_id": { - "title": "Sample Id", - "type": "string", - "description": "Sample ID" - }, - "notes": { - "title": "Notes", - "type": "string", - "description": "Notes associated with the order" - }, - "created_at": { - "title": "Created At", - "type": "string", - "description": "When your order was created", - "format": "date-time" - }, - "updated_at": { - "title": "Updated At", - "type": "string", - "description": "When your order was last updated", - "format": "date-time" - }, - "events": { - "title": "Events", - "type": "array", - "items": { - "title": "ClientFacingOrderEvent", - "required": ["id", "created_at", "status"], - "type": "object", - "properties": { - "id": { - "title": "Id", - "type": "integer" - }, - "created_at": { - "title": "Created At", - "type": "string", - "format": "date-time" - }, - "status": { - "title": "OrderV2Status", - "enum": [ - "received.walk_in_test.requisition_created", - "completed.walk_in_test.order_completed", - "failed.walk_in_test.sample_error", - "received.testkit.ordered", - "received.testkit.requisition_created", - "collecting_sample.testkit.transit_customer", - "collecting_sample.testkit.out_for_delivery", - "collecting_sample.testkit.with_customer", - "collecting_sample.testkit.transit_lab", - "sample_with_lab.testkit.delivered_to_lab", - "completed.testkit.completed", - "failed.testkit.failure_to_deliver_to_customer", - "failed.testkit.failure_to_deliver_to_lab", - "failed.testkit.sample_error", - "failed.testkit.lost", - "cancelled.testkit.cancelled", - "cancelled.testkit.do_not_process" - ], - "type": "string", - "description": "An enumeration." - } - } - } - }, - "status": { - "title": "OrderV2TopLevelStatus", - "enum": [ - "received", - "collecting_sample", - "sample_with_lab", - "completed", - "cancelled", - "failed" - ], - "type": "string", - "description": "An enumeration." - } - }, - "example": { - "id": "0ee312e2-6773-4a21-a6e1-506882cd98ed", - "team_id": "cbb64555-af07-46c1-be09-ef89308e9b60", - "user_id": "94e2d9f2-d600-4a23-9f08-536df378e2c7", - "patient_details": { - "dob": "2020-01-01", - "gender": "male" - }, - "patient_address": { - "receiver_name": "John Doe", - "first_line": "123 Main St.", - "second_line": "Apt. 208", - "city": "San Francisco", - "state": "CA", - "zip": "91189", - "country": "United States", - "phone_number": "+1123456789" - }, - "details": { - "type": "testkit", - "data": { - "id": "a655f0e4-6405-4a1d-80b7-66f06c2108a7", - "shipment": { - "id": "d55210cc-3d9f-4115-8262-5013f700c7be", - "outbound_tracking_number": "", - "outbound_tracking_url": "", - "inbound_tracking_number": "", - "inbound_tracking_url": "", - "outbound_courier": "usps", - "inbound_courier": "usps", - "notes": "", - "created_at": "2020-01-01T00:00:00.000Z", - "updated_at": "2020-01-01T00:00:00.000Z" - }, - "created_at": "2020-01-01T00:00:00Z", - "updated_at": "2020-01-01T00:00:00Z" - } - }, - "lab_test": { - "name": "Lipids Panel", - "description": "Cholesterol test", - "method": "testkit" - }, - "sample_id": "123456789", - "notes": "This is a note", - "created_at": "2020-01-01T00:00:00Z", - "updated_at": "2020-01-01T00:00:00Z", - "status": "collecting_sample", - "events": [ - { - "id": 1, - "created_at": "2022-01-01T00:00:00Z", - "status": "received.testkit.ordered" - }, - { - "id": 2, - "created_at": "2022-01-02T00:00:00Z", - "status": "received.testkit.requisition_created" - }, - { - "id": 3, - "created_at": "2022-01-03T00:00:00Z", - "status": "collecting_sample.testkit.transit_customer" - } - ] - } - }, - "status": { - "title": "Status", - "type": "string" - }, - "message": { - "title": "Message", - "type": "string" - } - } -] -``` - - diff --git a/docs/api-reference/lab-testing/create-order.mdx b/docs/api-reference/lab-testing/create-order.mdx index 439e5c849..30da2f960 100644 --- a/docs/api-reference/lab-testing/create-order.mdx +++ b/docs/api-reference/lab-testing/create-order.mdx @@ -165,82 +165,3 @@ fmt.Printf("Received data %s\n", response) ``` - - - -```json Response -{ - "order": { - "id": "ea7eae96-2c25-404f-b043-bfc08584610d", - "team_id": "c26a9cc7-cdff-4f23-a5f6-74d40088c16a", - "user_id": "63661a2b-2bb3-4125-bb1a-b590f64f057f", - "patient_details": { - "dob": "2020-01-01", - "gender": "male" - }, - "patient_address": { - "receiver_name": "John Doe", - "first_line": "123 Main St.", - "second_line": "Apt. 208", - "city": "San Francisco", - "state": "CA", - "zip": "91189", - "country": "United States", - "phone_number": "+1123456789" - }, - "priority": false, - "health_insurance_id": "33ec11aa-d8bf-4f46-950d-c9171be3c22f", - "details": { - "type": "testkit", - "data": { - "id": "a655f0e4-6405-4a1d-80b7-66f06c2108a7", - "shipment": { - "id": "d55210cc-3d9f-4115-8262-5013f700c7be", - "outbound_tracking_number": "", - "outbound_tracking_url": "", - "inbound_tracking_number": "", - "inbound_tracking_url": "", - "outbound_courier": "usps", - "inbound_courier": "usps", - "notes": "", - "created_at": "2020-01-01T00:00:00.000Z", - "updated_at": "2020-01-01T00:00:00.000Z" - }, - "created_at": "2020-01-01T00:00:00Z", - "updated_at": "2020-01-01T00:00:00Z" - } - }, - "lab_test": { - "name": "Lipids Panel", - "description": "Cholesterol test", - "method": "testkit" - }, - "sample_id": "123456789", - "notes": "This is a note", - "created_at": "2020-01-01T00:00:00Z", - "updated_at": "2020-01-01T00:00:00Z", - "status": "collecting_sample", - "events": [ - { - "id": 1, - "created_at": "2022-01-01T00:00:00Z", - "status": "received.testkit.ordered" - }, - { - "id": 2, - "created_at": "2022-01-02T00:00:00Z", - "status": "received.testkit.requisition_created" - }, - { - "id": 3, - "created_at": "2022-01-03T00:00:00Z", - "status": "collecting_sample.testkit.transit_customer" - } - ] - }, - "status": "string", - "message": "string" -} -``` - - diff --git a/docs/api-reference/lab-testing/create-unregistered-order.mdx b/docs/api-reference/lab-testing/create-unregistered-order.mdx index e14ae9306..dbe6366e3 100644 --- a/docs/api-reference/lab-testing/create-unregistered-order.mdx +++ b/docs/api-reference/lab-testing/create-unregistered-order.mdx @@ -109,60 +109,3 @@ curl --request POST \ - - - -```json Response - -"order": { - "id": "96edc6ef-3b2c-412b-b9e5-96f361f93aec", - "team_id": "b080b20c-e162-4cf1-9c7d-8faee72ee08e", - "user_id": "9f1e094e-1641-466b-b668-d4d3300e569f", - "shipping_details": { - "receiver_name": "John Doe", - "first_line": "123 Main St.", - "second_line": "Apt. 208", - "city": "San Francisco", - "state": "CA", - "zip": "91189", - "country": "United States", - "phone_number": "+11234567890" - }, - "details": { - "type": "testkit", - "data": { - "id": "a655f0e4-6405-4a1d-80b7-66f06c2108a7", - "created_at": "2020-01-01T00:00:00Z", - "updated_at": "2020-01-01T00:00:00Z" - } - }, - "lab_test": { - "name": "Lipids Panel", - "description": "Cholesterol test", - "method": "testkit" - }, - "sample_id": "123456789", - "health_insurace_id": "7695cc28-f9e5-400d-95d2-ec7d9ec580df", - "notes": "This is a note", - "created_at": "2020-01-01T00:00:00Z", - "updated_at": "2020-01-01T00:00:00Z", - "status": "received", - "events": [ - { - "id": 1, - "created_at": "2022-01-01T00:00:00Z", - "status": "received.testkit.ordered" - }, - { - "id": 2, - "created_at": "2022-01-02T00:00:00Z", - "status": "received.testkit.awaiting_registration" - }, - ] - }, - "status": "string", - "message": "string" -} -``` - - diff --git a/docs/api-reference/lab-testing/get-order.mdx b/docs/api-reference/lab-testing/get-order.mdx index b04f0082d..647912cdd 100644 --- a/docs/api-reference/lab-testing/get-order.mdx +++ b/docs/api-reference/lab-testing/get-order.mdx @@ -61,77 +61,3 @@ fmt.Printf("Received data %s\n", response) ``` - - - -```json Response -{ - "id": "0ee312e2-6773-4a21-a6e1-506882cd98ed", - "team_id": "cbb64555-af07-46c1-be09-ef89308e9b60", - "user_id": "94e2d9f2-d600-4a23-9f08-536df378e2c7", - "patient_details": { - "dob": "2020-01-01", - "gender": "male" - }, - "priority": false, - "patient_address": { - "receiver_name": "John Doe", - "first_line": "123 Main St.", - "second_line": "Apt. 208", - "city": "San Francisco", - "state": "CA", - "zip": "91189", - "country": "United States", - "phone_number": "+1123456789" - }, - "details": { - "type": "testkit", - "data": { - "id": "a655f0e4-6405-4a1d-80b7-66f06c2108a7", - "shipment": { - "id": "d55210cc-3d9f-4115-8262-5013f700c7be", - "outbound_tracking_number": "", - "outbound_tracking_url": "", - "inbound_tracking_number": "", - "inbound_tracking_url": "", - "outbound_courier": "usps", - "inbound_courier": "usps", - "notes": "", - "created_at": "2020-01-01T00:00:00.000Z", - "updated_at": "2020-01-01T00:00:00.000Z" - }, - "created_at": "2020-01-01T00:00:00Z", - "updated_at": "2020-01-01T00:00:00Z" - } - }, - "lab_test": { - "name": "Lipids Panel", - "description": "Cholesterol test", - "method": "testkit" - }, - "sample_id": "123456789", - "notes": "This is a note", - "created_at": "2020-01-01T00:00:00Z", - "updated_at": "2020-01-01T00:00:00Z", - "status": "collecting_sample", - "events": [ - { - "id": 1, - "created_at": "2022-01-01T00:00:00Z", - "status": "received.testkit.ordered" - }, - { - "id": 2, - "created_at": "2022-01-02T00:00:00Z", - "status": "received.testkit.requisition_created" - }, - { - "id": 3, - "created_at": "2022-01-03T00:00:00Z", - "status": "collecting_sample.testkit.transit_customer" - } - ] -} -``` - - diff --git a/docs/api-reference/lab-testing/get-orders.mdx b/docs/api-reference/lab-testing/get-orders.mdx index d74946ab1..6ef04ddf9 100644 --- a/docs/api-reference/lab-testing/get-orders.mdx +++ b/docs/api-reference/lab-testing/get-orders.mdx @@ -126,84 +126,3 @@ fmt.Printf("Received data %s\n", response) ``` - - - -```json Response -{ - "orders": [ - { - "id": "0ee312e2-6773-4a21-a6e1-506882cd98ed", - "team_id": "cbb64555-af07-46c1-be09-ef89308e9b60", - "user_id": "94e2d9f2-d600-4a23-9f08-536df378e2c7", - "patient_details": { - "dob": "2020-01-01", - "gender": "male" - }, - "priority": false, - "patient_address": { - "receiver_name": "John Doe", - "first_line": "123 Main St.", - "second_line": "Apt. 208", - "city": "San Francisco", - "state": "CA", - "zip": "91189", - "country": "United States", - "phone_number": "+1123456789" - }, - "details": { - "type": "testkit", - "data": { - "id": "a655f0e4-6405-4a1d-80b7-66f06c2108a7", - "shipment": { - "id": "d55210cc-3d9f-4115-8262-5013f700c7be", - "outbound_tracking_number": "", - "outbound_tracking_url": "", - "inbound_tracking_number": "", - "inbound_tracking_url": "", - "outbound_courier": "usps", - "inbound_courier": "usps", - "notes": "", - "created_at": "2020-01-01T00:00:00.000Z", - "updated_at": "2020-01-01T00:00:00.000Z" - }, - "created_at": "2020-01-01T00:00:00Z", - "updated_at": "2020-01-01T00:00:00Z" - } - }, - "lab_test": { - "name": "Lipids Panel", - "description": "Cholesterol test", - "method": "testkit" - }, - "sample_id": "123456789", - "notes": "This is a note", - "created_at": "2020-01-01T00:00:00Z", - "updated_at": "2020-01-01T00:00:00Z", - "status": "collecting_sample", - "events": [ - { - "id": 1, - "created_at": "2022-01-01T00:00:00Z", - "status": "received.testkit.ordered" - }, - { - "id": 2, - "created_at": "2022-01-02T00:00:00Z", - "status": "received.testkit.requisition_created" - }, - { - "id": 3, - "created_at": "2022-01-03T00:00:00Z", - "status": "collecting_sample.testkit.transit_customer" - } - ] - } - ], - "total": 1, - "page": 1, - "size": 50 -} -``` - - \ No newline at end of file diff --git a/docs/api-reference/lab-testing/insurance/search-diagnosis.mdx b/docs/api-reference/lab-testing/insurance/search-diagnosis.mdx index b72b5f70d..2054f33b2 100644 --- a/docs/api-reference/lab-testing/insurance/search-diagnosis.mdx +++ b/docs/api-reference/lab-testing/insurance/search-diagnosis.mdx @@ -84,26 +84,3 @@ fmt.Printf("Received data %s\n", response) ``` - - -```json Response -[ - { - "diagnosis_code": "D55.0", - "description": "ANEMIA DUE TO G6PD DEFICIENCY", - }, - { - "diagnosis_code": "D75.A", - "description": "GLUC-6-PHOS DHYDRGNS DEF W/O ANEMIA", - }, - { - "diagnosis_code": "E74.810", - "description": "GLUC TRANSPORT PROTEIN TYPE 1 DEFIC", - }, - { - "diagnosis_code": "E74.818", - "description": "OTHER DISORDERS GLUCOSE TRANSPORT", - } -] -``` - diff --git a/docs/api-reference/lab-testing/insurance/search-payor.mdx b/docs/api-reference/lab-testing/insurance/search-payor.mdx index a0f553593..0309cd5c3 100644 --- a/docs/api-reference/lab-testing/insurance/search-payor.mdx +++ b/docs/api-reference/lab-testing/insurance/search-payor.mdx @@ -88,26 +88,3 @@ fmt.Printf("Received data %s\n", response) ``` - - -```json Response -[ - { - "code": "AARPA", - "name": "AARP", - "aliases": [ - "AARP", - "AARP" - ], - "org_address": { - "first_line": "PO BOX 740819", - "second_line": null, - "country": "US", - "zip": "30374", - "city": "ATLANTA", - "state": "GA" - } - }, -] -``` - diff --git a/docs/api-reference/lab-testing/lab-test-markers.mdx b/docs/api-reference/lab-testing/lab-test-markers.mdx index be88a543f..faf3c6b41 100644 --- a/docs/api-reference/lab-testing/lab-test-markers.mdx +++ b/docs/api-reference/lab-testing/lab-test-markers.mdx @@ -69,72 +69,3 @@ fmt.Printf("Received data %s\n", response) ``` - - - -```json Response -{ - "markers": [ - { - "id": 202, - "name": "Acetylcholine Receptor (AChR) Antibodies, Complete Profile with Reflex to MuSK Antibodies", - "slug": "acetylcholine-receptor-achr-antibodies-complete-profile-with-reflex-to-musk-antibodies", - "description": "Acetylcholine Receptor (AChR) Antibodies, Complete Profile with Reflex to MuSK Antibodies", - "lab_id": 6, - "provider_id": "165605", - "type": "biomarker", - "unit": null, - "price": "N/A", - "expected_results": [ - { - "id": 2938, - "name": "AChR Blocking Abs, Serum", - "slug": "achr-blocking-abs-serum", - "lab_id": 6, - "provider_id": "085927", - "loinc": { - "id": 3514, - "name": "Acetylcholine receptor blocking Ab Qn (S)", - "slug": "acetylcholine-receptor-blocking-ab-qn-s", - "code": "11561-8", - "unit": "%{inhibition}" - } - }, - { - "id": 2939, - "name": "AChR Binding Abs, Serum", - "slug": "achr-binding-abs-serum", - "lab_id": 6, - "provider_id": "085904", - "loinc": { - "id": 3174, - "name": "Acetylcholine receptor binding Ab (S) [Moles/Vol]", - "slug": "acetylcholine-receptor-binding-ab-s-moles-vol", - "code": "11034-6", - "unit": "nmol/L" - } - }, - { - "id": 2940, - "name": "AChR-modulating Ab", - "slug": "achr-modulating-ab", - "lab_id": 6, - "provider_id": "505199", - "loinc": { - "id": 61121, - "name": "Acetylcholine receptor modulation Ab FC Ql (S)", - "slug": "acetylcholine-receptor-modulation-ab-fc-ql-s", - "code": "99062-2", - "unit": null - } - } - ] - }, - ], - "total": 2, - "page": 1, - "size": 2 -} -``` - - \ No newline at end of file diff --git a/docs/api-reference/lab-testing/labs.mdx b/docs/api-reference/lab-testing/labs.mdx index 9e09b661a..d95e54907 100644 --- a/docs/api-reference/lab-testing/labs.mdx +++ b/docs/api-reference/lab-testing/labs.mdx @@ -69,22 +69,3 @@ fmt.Printf("Received data %s\n", response) ``` - - - -```json Response -[ - { - "id": 1, - "slug": "labcorp", - "name": "LabCorp", - "first_line_address": "123 Main St", - "city": "San Francisco", - "zipcode": "91789", - "collection_methods": ["at_home_phlebotomy", "walk_in_test"], - "sample_types": ["saliva", "serum"] - } -] -``` - - diff --git a/docs/api-reference/lab-testing/order-psc-info.mdx b/docs/api-reference/lab-testing/order-psc-info.mdx index c910d6fc8..96421e695 100644 --- a/docs/api-reference/lab-testing/order-psc-info.mdx +++ b/docs/api-reference/lab-testing/order-psc-info.mdx @@ -69,30 +69,3 @@ fmt.Printf("Received data %s\n", response) ``` - - - -```json Response -{ - "lab_id": 27, - "slug": "labcorp", - "patient_service_centers": [ - { - "metadata": { - "name": "LABCORP", - "state": "AZ", - "city": "Phoenix", - "zip_code": "85006", - "first_line": "1300 N 12th St", - "second_line": "Ste 300", - "phone_number": "480-878-3988", - "fax_number": "844-346-5903", - "hours": null - }, - "distance": "25", - }, - ] -} -``` - - diff --git a/docs/api-reference/lab-testing/order-set-marker.mdx b/docs/api-reference/lab-testing/order-set-marker.mdx index 70e9da3e5..35b3c6bdf 100644 --- a/docs/api-reference/lab-testing/order-set-marker.mdx +++ b/docs/api-reference/lab-testing/order-set-marker.mdx @@ -38,72 +38,3 @@ data = client.lab_tests.get_markers_for_order_set(OrderSetRequest( ``` - - - -```json Response -{ - "markers": [ - { - "id": 202, - "name": "Acetylcholine Receptor (AChR) Antibodies, Complete Profile with Reflex to MuSK Antibodies", - "slug": "acetylcholine-receptor-achr-antibodies-complete-profile-with-reflex-to-musk-antibodies", - "description": "Acetylcholine Receptor (AChR) Antibodies, Complete Profile with Reflex to MuSK Antibodies", - "lab_id": 6, - "provider_id": "165605", - "type": "biomarker", - "unit": null, - "price": "N/A", - "expected_results": [ - { - "id": 2938, - "name": "AChR Blocking Abs, Serum", - "slug": "achr-blocking-abs-serum", - "lab_id": 6, - "provider_id": "085927", - "loinc": { - "id": 3514, - "name": "Acetylcholine receptor blocking Ab Qn (S)", - "slug": "acetylcholine-receptor-blocking-ab-qn-s", - "code": "11561-8", - "unit": "%{inhibition}" - } - }, - { - "id": 2939, - "name": "AChR Binding Abs, Serum", - "slug": "achr-binding-abs-serum", - "lab_id": 6, - "provider_id": "085904", - "loinc": { - "id": 3174, - "name": "Acetylcholine receptor binding Ab (S) [Moles/Vol]", - "slug": "acetylcholine-receptor-binding-ab-s-moles-vol", - "code": "11034-6", - "unit": "nmol/L" - } - }, - { - "id": 2940, - "name": "AChR-modulating Ab", - "slug": "achr-modulating-ab", - "lab_id": 6, - "provider_id": "505199", - "loinc": { - "id": 61121, - "name": "Acetylcholine receptor modulation Ab FC Ql (S)", - "slug": "acetylcholine-receptor-modulation-ab-fc-ql-s", - "code": "99062-2", - "unit": null - } - } - ] - }, - ], - "total": 2, - "page": 1, - "size": 2 -} -``` - - \ No newline at end of file diff --git a/docs/api-reference/lab-testing/post-test.mdx b/docs/api-reference/lab-testing/post-test.mdx index d4ee7df0d..9217f6ce8 100644 --- a/docs/api-reference/lab-testing/post-test.mdx +++ b/docs/api-reference/lab-testing/post-test.mdx @@ -97,35 +97,3 @@ fmt.Printf("Received data %s\n", response) ``` - - - -```json Response -{ - "lab_test": { - "name": "Lipids Panel", - "description": "Cholesterol test", - "sample_type": "dried blood spot", - "method": "testkit", - "price": 10.0, - "is_active": false, - "fasting": false, - "lab": { - "slug": "USSL", - "name": "US Specialty Lab", - "first_line_address": "123 Main St", - "city": "New York", - "zipcode": "10001" - }, - "markers": [ - { - "name": "Thyroid Stimulating Hormone", - "slug": "tsh", - "description": "" - } - ] - } -} -``` - - diff --git a/docs/api-reference/lab-testing/psc-info.mdx b/docs/api-reference/lab-testing/psc-info.mdx index a5c11efe3..29b001282 100644 --- a/docs/api-reference/lab-testing/psc-info.mdx +++ b/docs/api-reference/lab-testing/psc-info.mdx @@ -84,30 +84,3 @@ fmt.Printf("Received data %s\n", response) ``` - - - -```json Response -{ - "lab_id": 27, - "slug": "labcorp", - "patient_service_centers": [ - { - "metadata": { - "name": "LABCORP", - "state": "AZ", - "city": "Phoenix", - "zip_code": "85006", - "first_line": "1300 N 12th St", - "second_line": "Ste 300", - "phone_number": "480-878-3988", - "fax_number": "844-346-5903", - "hours": null - }, - "distance": "25" - }, - ] -} -``` - - diff --git a/docs/api-reference/lab-testing/psc-schedulling/appointment-psc-availability.mdx b/docs/api-reference/lab-testing/psc-schedulling/appointment-psc-availability.mdx index b654f3af2..1ee4209e8 100644 --- a/docs/api-reference/lab-testing/psc-schedulling/appointment-psc-availability.mdx +++ b/docs/api-reference/lab-testing/psc-schedulling/appointment-psc-availability.mdx @@ -18,73 +18,3 @@ curl --request POST \ ' ``` - - -```json Response -{ - "timezone":"America/Phoenix", - "slots": [ - { - "location": { - "location": { - "lng": -112.0568538, - "lat": 33.4631386 - }, - "address": { - "first_line": "1300 N 12th St", - "second_line": "Ste 300", - "city": "Phoenix", - "state": "AZ", - "zip_code": "85006", - }, - "code": "23070", - "name": "QUEST" - }, - "date":"2023-05-09", - "slots": [ - { - "booking_key": "foo123", - "start": "2023-05-09T17:00:00+00:00", - "end": "2023-05-09T19:00:00+00:00", - "expires_at": "2023-05-09T12:39:57.827000+00:00", - "price": 3500, - "is_priority": true, - "num_appointments_available": 5 - }, - ... - ], - }, - { - "location": { - "location": { - "lng": -112.0568538, - "lat": 33.4631386 - }, - "address": { - "first_line": "1300 N 12th St", - "second_line": "Ste 300", - "city": "Phoenix", - "state": "AZ", - "zip_code": "85006", - }, - "code": "23070", - "name": "QUEST" - }, - "date":"2023-05-10", - "slots": [ - { - "booking_key": "bar456", - "start": "2023-05-10T12:00:00+00:00", - "end": "2023-05-10T14:00:00+00:00", - "expires_at": "2023-05-09T12:39:57.852000+00:00", - "price": 7900, - "is_priority": true, - "num_appointments_available": 5 - }, - ... - ], - }, - ] -} -``` - diff --git a/docs/api-reference/lab-testing/psc-schedulling/appointment-psc-booking.mdx b/docs/api-reference/lab-testing/psc-schedulling/appointment-psc-booking.mdx index 749886853..a8f32f1eb 100644 --- a/docs/api-reference/lab-testing/psc-schedulling/appointment-psc-booking.mdx +++ b/docs/api-reference/lab-testing/psc-schedulling/appointment-psc-booking.mdx @@ -86,32 +86,3 @@ fmt.Printf("Received data %s\n", response) ``` - - -```json Response -{ - "id": "413d7205-f8a9-42ed-aa4a-edb99e481ca0", - "user_id": "202b2c2f-fb4c-44dc-a4f8-621186fde227", - "address": { - "first_line": "West Lincoln Street", - "second_line": "", - "city": "Phoenix", - "state": "AZ", - "zip_code": "85004", - "unit": "14" - }, - "location": { - "lng": -112.0772235, - "lat": 33.4421912 - }, - "start_at": "2023-05-15T16:00:00+00:00", - "end_at": "2023-05-15T18:00:00+00:00", - "iana_timezone": "America/Phoenix", - "type": "patient_service_center", - "provider": "quest", - "status": "pending", - "provider_id": "e89eb489-7382-4966-bb14-7ab4763eba6c", - "can_reschedule":true -} -``` - diff --git a/docs/api-reference/lab-testing/psc-schedulling/appointment-psc-cancellation-reasons.mdx b/docs/api-reference/lab-testing/psc-schedulling/appointment-psc-cancellation-reasons.mdx index be8ccfebb..e34f34712 100644 --- a/docs/api-reference/lab-testing/psc-schedulling/appointment-psc-cancellation-reasons.mdx +++ b/docs/api-reference/lab-testing/psc-schedulling/appointment-psc-cancellation-reasons.mdx @@ -68,15 +68,3 @@ fmt.Printf("Received data %s\n", response) ``` - - -```json -[ - { - "id": "5c0257ef-6fea-4a22-b20a-3ddab573d5c9", - "name": "Other", - "is_refundable": true - }, -] -``` - diff --git a/docs/api-reference/lab-testing/psc-schedulling/appointment-psc-cancelling.mdx b/docs/api-reference/lab-testing/psc-schedulling/appointment-psc-cancelling.mdx index c9de7d92d..fc6daa11c 100644 --- a/docs/api-reference/lab-testing/psc-schedulling/appointment-psc-cancelling.mdx +++ b/docs/api-reference/lab-testing/psc-schedulling/appointment-psc-cancelling.mdx @@ -87,32 +87,3 @@ fmt.Printf("Received data %s\n", response) ``` - - -```json Response -{ - "id": "413d7205-f8a9-42ed-aa4a-edb99e481ca0", - "user_id": "202b2c2f-fb4c-44dc-a4f8-621186fde227", - "address": { - "first_line": "West Lincoln Street", - "second_line": "", - "city": "Phoenix", - "state": "AZ", - "zip_code": "85004", - "unit": "14" - }, - "location": { - "lng": -112.0772235, - "lat": 33.4421912 - }, - "start_at": "2023-05-17T20:00:00+00:00", - "end_at": "2023-05-17T22:00:00+00:00", - "iana_timezone": "America/Phoenix", - "type": "patient_service_center", - "provider": "quest", - "status": "cancelled", - "provider_id": "e89eb489-7382-4966-bb14-7ab4763eba6c", - "can_reschedule": true -} -``` - diff --git a/docs/api-reference/lab-testing/psc-schedulling/appointment-psc-rescheduling.mdx b/docs/api-reference/lab-testing/psc-schedulling/appointment-psc-rescheduling.mdx index fed0352e0..f2636d937 100644 --- a/docs/api-reference/lab-testing/psc-schedulling/appointment-psc-rescheduling.mdx +++ b/docs/api-reference/lab-testing/psc-schedulling/appointment-psc-rescheduling.mdx @@ -87,32 +87,3 @@ fmt.Printf("Received data %s\n", response) ``` - - -```json Response -{ - "id": "413d7205-f8a9-42ed-aa4a-edb99e481ca0", - "user_id": "202b2c2f-fb4c-44dc-a4f8-621186fde227", - "address": { - "first_line": "West Lincoln Street", - "second_line": "", - "city": "Phoenix", - "state": "AZ", - "zip_code": "85004", - "unit":"14" - }, - "location": { - "lng": -112.0772235, - "lat": 33.4421912 - }, - "start_at": "2023-05-17T20:00:00+00:00", - "end_at": "2023-05-17T22:00:00+00:00", - "iana_timezone": "America/Phoenix", - "type": "patient_service_center", - "provider": "quest", - "status": "confirmed", - "provider_id": "e89eb489-7382-4966-bb14-7ab4763eba6c", - "can_reschedule": true -} -``` - diff --git a/docs/api-reference/lab-testing/psc-schedulling/get-psc-appointment.mdx b/docs/api-reference/lab-testing/psc-schedulling/get-psc-appointment.mdx index 5ce3bb3f2..0c548f6a6 100644 --- a/docs/api-reference/lab-testing/psc-schedulling/get-psc-appointment.mdx +++ b/docs/api-reference/lab-testing/psc-schedulling/get-psc-appointment.mdx @@ -67,32 +67,3 @@ fmt.Printf("Received data %s\n", response) ``` - - -```json Response -{ - "id": "413d7205-f8a9-42ed-aa4a-edb99e481ca0", - "user_id": "202b2c2f-fb4c-44dc-a4f8-621186fde227", - "address": { - "first_line": "West Lincoln Street", - "second_line": "", - "city": "Phoenix", - "state": "AZ", - "zip_code": "85004", - "unit": "14" - }, - "location": { - "lng": -112.0772235, - "lat": 33.4421912 - }, - "start_at": "2023-05-17T20:00:00+00:00", - "end_at": "2023-05-17T22:00:00+00:00", - "iana_timezone": "America/Phoenix", - "type": "patient_service_center", - "provider": "quest", - "status": "confirmed", - "provider_id": "e89eb489-7382-4966-bb14-7ab4763eba6c", - "can_reschedule": true -} -``` - diff --git a/docs/api-reference/lab-testing/register-order.mdx b/docs/api-reference/lab-testing/register-order.mdx index 980899069..0650b0f0a 100644 --- a/docs/api-reference/lab-testing/register-order.mdx +++ b/docs/api-reference/lab-testing/register-order.mdx @@ -200,100 +200,3 @@ curl --request POST \ ``` - - - -```json Response -{ - "order": { - "id": "96edc6ef-3b2c-412b-b9e5-96f361f93aec", - "team_id": "b080b20c-e162-4cf1-9c7d-8faee72ee08e", - "user_id": "9f1e094e-1641-466b-b668-d4d3300e569f", - "patient_details": { - "first_name": "John", - "last_name": "Doe", - "phone_number": "+11234567890", - "email": "doe@email.com" - "dob": "2020-01-01", - "gender": "male" - }, - "patient_address": { - "receiver_name": "John Doe", - "first_line": "123 Main St.", - "second_line": "Apt. 208", - "city": "San Francisco", - "state": "CA", - "zip": "91189", - "country": "United States", - "phone_number": "+11234567890" - }, - "shipping_details": { - "receiver_name": "John Doe", - "first_line": "123 Main St.", - "second_line": "Apt. 208", - "city": "San Francisco", - "state": "CA", - "zip": "91189", - "country": "United States", - "phone_number": "+11234567890" - }, - "details": { - "type": "testkit", - "data": { - "id": "a655f0e4-6405-4a1d-80b7-66f06c2108a7", - "shipment": { - "id": "d55210cc-3d9f-4115-8262-5013f700c7be", - "outbound_tracking_number": "", - "outbound_tracking_url": "", - "inbound_tracking_number": "", - "inbound_tracking_url": "", - "outbound_courier": "usps", - "inbound_courier": "usps", - "notes": "", - "created_at": "2020-01-01T00:00:00.000Z", - "updated_at": "2020-01-01T00:00:00.000Z" - }, - "created_at": "2020-01-01T00:00:00Z", - "updated_at": "2020-01-01T00:00:00Z" - } - }, - "lab_test": { - "name": "Lipids Panel", - "description": "Cholesterol test", - "method": "testkit" - }, - "sample_id": "123456789", - "health_insurace_id": "7695cc28-f9e5-400d-95d2-ec7d9ec580df", - "notes": "This is a note", - "created_at": "2020-01-01T00:00:00Z", - "updated_at": "2020-01-01T00:00:00Z", - "status": "received", - "events": [ - { - "id": 1, - "created_at": "2022-01-01T00:00:00Z", - "status": "received.testkit.ordered" - }, - { - "id": 2, - "created_at": "2022-01-02T00:00:00Z", - "status": "received.testkit.awaiting_registration" - }, - { - "id": 3, - "created_at": "2022-01-02T00:00:00Z", - "status": "received.testkit.requisition_created" - }, - { - "id": 4, - "created_at": "2022-01-03T00:00:00Z", - "status": "received.testkit.testkit_registered" - } - ] - }, - "status": "string", - "message": "string" -} -``` - - diff --git a/docs/api-reference/lab-testing/results/get-results-metadata.mdx b/docs/api-reference/lab-testing/results/get-results-metadata.mdx index f4c93a8e4..ac1057a74 100644 --- a/docs/api-reference/lab-testing/results/get-results-metadata.mdx +++ b/docs/api-reference/lab-testing/results/get-results-metadata.mdx @@ -69,24 +69,3 @@ fmt.Printf("Received data %s\n", response) ``` - - - -```json Response -{ - "age": 19, - "dob": "18/08/1993", - "clia_number": "12331231", - "patient": "Bob Smith", - "provider": "Dr. Jack Smith", - "laboratory": "Quest Diagnostics", - "date_reported": "2020-01-01", - "date_collected": "2022-02-02", - "specimen_number": "123131", - "date_received": "2022-01-01", - "status": "final", - "interpretation": "normal" -} -``` - - diff --git a/docs/api-reference/lab-testing/results/get-results-pdf.mdx b/docs/api-reference/lab-testing/results/get-results-pdf.mdx index 11a5deb9e..1875bbc2e 100644 --- a/docs/api-reference/lab-testing/results/get-results-pdf.mdx +++ b/docs/api-reference/lab-testing/results/get-results-pdf.mdx @@ -70,11 +70,3 @@ fmt.Printf("Received data %s\n", response) ``` - - - -```json Response -"Returns PDF of test data - .pdf" -``` - - diff --git a/docs/api-reference/lab-testing/results/get-results.mdx b/docs/api-reference/lab-testing/results/get-results.mdx index bb750ad63..0019b3c8b 100644 --- a/docs/api-reference/lab-testing/results/get-results.mdx +++ b/docs/api-reference/lab-testing/results/get-results.mdx @@ -70,54 +70,3 @@ fmt.Printf("Received data %s\n", response) ``` - - - -```json Response -{ - "metadata": { - "age": 19, - "dob": "18/08/1993", - "clia_number": "12331231", - "patient": "Bob Smith", - "provider": "Dr. Jack Smith", - "laboratory": "LabCorp", - "date_reported": "2020-01-01", - "date_collected": "2022-02-02", - "specimen_number": "123131", - "date_received": "2022-01-01" - "status": "final", - "interpretation": "abnormal" - }, - "results": [ - { - "name": "Sex Horm Binding Glob, Serum", - "slug": "sex-horm-binding-glob-serum", - "value": 30.4, - "result": "30.4", - "type": "numeric", - "unit": "nmol/L", - "timestamp": "2024-10-31T09:08:00+00:00", - "notes": "Final", - "min_range_value": 24.6, - "max_range_value": 122, - "is_above_max_range": false, - "is_below_min_range": false, - "interpretation": "normal", - "loinc": "13967-5", - "loinc_slug": "sex-hormone-binding-globulin-moles-vol", - "provider_id": "082016", - "source_markers": [ - { - "marker_id": 229, - "name": "Testosterone Free, Profile I", - "slug": "testosterone-free-profile-i", - "provider_id": "140226" - } - ] - } - ] -} -``` - - diff --git a/docs/api-reference/lab-testing/tests.mdx b/docs/api-reference/lab-testing/tests.mdx index 59fa5a95b..57958b87d 100644 --- a/docs/api-reference/lab-testing/tests.mdx +++ b/docs/api-reference/lab-testing/tests.mdx @@ -63,36 +63,3 @@ fmt.Printf("Received data %s\n", response) - - - -```json Response -[ - { - "lab_test": { - "name": "Lipids Panel", - "description": "Cholesterol test", - "sample_type": "dried blood spot", - "method": "testkit", - "price": 10, - "is_active": true, - "lab": { - "slug": "USSL", - "name": "US Specialty Lab", - "first_line_address": "123 Main St", - "city": "New York", - "zipcode": "10001" - }, - "markers": [ - { - "name": "Thyroid Stimulating Hormone", - "slug": "tsh", - "description": "" - } - ] - } - } -] -``` - - diff --git a/docs/api-reference/legacy/orders/cancel-order.mdx b/docs/api-reference/legacy/orders/cancel-order.mdx index b32f56bad..05d40500c 100644 --- a/docs/api-reference/legacy/orders/cancel-order.mdx +++ b/docs/api-reference/legacy/orders/cancel-order.mdx @@ -14,33 +14,3 @@ data = client.Testkits.cancel(user_id=\*) ``` - - - -```json Response -{ - "order": { - "id": "84da57d1-2b6a-4a19-bacf-88a618160261", - "team_id": "925c4081-c254-48ac-9b12-99e7a15ffeec", - "created_on": "2022-08-04T12:42:45.697072+00:00", - "updated_on": "2022-08-04T12:42:45.697077+00:00", - "status": "ordered", - "user_id": "1381335e-ac3c-4088-bdff-6b840a84a928", - "testkit_id": "8da6c537-0453-46f5-91ee-824357fcd2d9", - "inbound_tracking_number": "", - "outbound_tracking_number": "", - "inbound_tracking_url": "", - "outbound_tracking_url": "", - "outbound_courier": "usps", - "inbound_courier": "usps", - "testkit": { - "name": "CGM", - "description": "Glucose CGM" - } - }, - "status": "Success", - "message": "Order created successfully | Order cancelled successfully " -} -``` - - diff --git a/docs/api-reference/legacy/orders/create-order.mdx b/docs/api-reference/legacy/orders/create-order.mdx index c86b6950c..1af064f8f 100644 --- a/docs/api-reference/legacy/orders/create-order.mdx +++ b/docs/api-reference/legacy/orders/create-order.mdx @@ -32,33 +32,3 @@ patient_address={ ``` - - - -```json Response -{ - "order": { - "id": "84da57d1-2b6a-4a19-bacf-88a618160261", - "team_id": "925c4081-c254-48ac-9b12-99e7a15ffeec", - "created_on": "2022-08-04T12:42:45.697072+00:00", - "updated_on": "2022-08-04T12:42:45.697077+00:00", - "status": "ordered", - "user_id": "1381335e-ac3c-4088-bdff-6b840a84a928", - "testkit_id": "8da6c537-0453-46f5-91ee-824357fcd2d9", - "inbound_tracking_number": "", - "outbound_tracking_number": "", - "inbound_tracking_url": "", - "outbound_tracking_url": "", - "outbound_courier": "usps", - "inbound_courier": "usps", - "testkit": { - "name": "CGM", - "description": "Glucose CGM" - } - }, - "status": "Success", - "message": "Order created successfully | Order cancelled successfully " -} -``` - - diff --git a/docs/api-reference/legacy/results/get-results-metadata.mdx b/docs/api-reference/legacy/results/get-results-metadata.mdx index a4708bcab..3e5407f76 100644 --- a/docs/api-reference/legacy/results/get-results-metadata.mdx +++ b/docs/api-reference/legacy/results/get-results-metadata.mdx @@ -15,22 +15,3 @@ data = client.Testkits.metadata("") ``` - - - -```json Response -{ - "age": 19, - "dob": "18/08/1993", - "clia_number": "12331231", - "patient": "Bob Smith", - "provider": "Dr. Jack Smith", - "laboratory": "Quest Diagnostics", - "date_reported": "2020-01-01", - "date_collected": "2022-02-02", - "specimen_number": "123131", - "date_received": "2022-01-01" -} -``` - - diff --git a/docs/api-reference/legacy/results/get-results-raw.mdx b/docs/api-reference/legacy/results/get-results-raw.mdx index b1d7a4bad..10dec35d3 100644 --- a/docs/api-reference/legacy/results/get-results-raw.mdx +++ b/docs/api-reference/legacy/results/get-results-raw.mdx @@ -15,29 +15,3 @@ data = client.Testkits.result(") ``` - - - -```json Response -{ - "metadata": { - "age": 19, - "dob": "18/08/1993", - "clia_number": "12331231", - "patient": "Bob Smith", - "provider": "Dr. Jack Smith", - "laboratory": "Quest Diagnostics", - "date_reported": "2020-01-01", - "date_collected": "2022-02-02", - "specimen_number": "123131", - "date_received": "2022-01-01" - }, - "results": { - "[marker]": {}, - "ige": {}, - "fsh": {} - } -} -``` - - diff --git a/docs/api-reference/legacy/results/get-results.mdx b/docs/api-reference/legacy/results/get-results.mdx index 1788db918..af508a62c 100644 --- a/docs/api-reference/legacy/results/get-results.mdx +++ b/docs/api-reference/legacy/results/get-results.mdx @@ -15,11 +15,3 @@ data = client.Testkits.result("") ``` - - - -```text Response -"Returns PDF of test data - .pdf" -``` - - diff --git a/docs/api-reference/link/complete-password-provider-mfa.mdx b/docs/api-reference/link/complete-password-provider-mfa.mdx index e3f083bf6..0057fcf69 100644 --- a/docs/api-reference/link/complete-password-provider-mfa.mdx +++ b/docs/api-reference/link/complete-password-provider-mfa.mdx @@ -92,16 +92,3 @@ fmt.Printf("Received data %s\n", response) ``` - - - -```json Example -{ - "state": "success", - "redirect_url": null, - "error_type": null, - "error": null -} -``` - - diff --git a/docs/api-reference/link/create-code.mdx b/docs/api-reference/link/create-code.mdx index aa62bcdc6..d7bb51127 100644 --- a/docs/api-reference/link/create-code.mdx +++ b/docs/api-reference/link/create-code.mdx @@ -87,14 +87,3 @@ fmt.Printf("Received data %s\n", response) ``` - - - -```json Example -{ - "code": "skus17922ffe", - "exchange_url": "tryvital://tryvital?code=skus17922ffe" -} -``` - - diff --git a/docs/api-reference/link/generate-link-token.mdx b/docs/api-reference/link/generate-link-token.mdx index 41f3259a2..5a8ef97b7 100644 --- a/docs/api-reference/link/generate-link-token.mdx +++ b/docs/api-reference/link/generate-link-token.mdx @@ -95,13 +95,3 @@ fmt.Printf("Received data %s\n", response) ``` - - - -```json Example -{ - "link_token": "dGVzdCB0ZXN0IHRlc3Q=" -} -``` - - diff --git a/docs/api-reference/link/link-demo-provider.mdx b/docs/api-reference/link/link-demo-provider.mdx index 759be8883..50bd2ff3d 100644 --- a/docs/api-reference/link/link-demo-provider.mdx +++ b/docs/api-reference/link/link-demo-provider.mdx @@ -93,14 +93,3 @@ fmt.Printf("Received data %s\n", response) ``` - - - -```json Example -{ - "success": true, - "redirect_url": null -} -``` - - diff --git a/docs/api-reference/link/link-email-provider.mdx b/docs/api-reference/link/link-email-provider.mdx index 2b7fba95f..18a9bea9d 100644 --- a/docs/api-reference/link/link-email-provider.mdx +++ b/docs/api-reference/link/link-email-provider.mdx @@ -128,13 +128,3 @@ fmt.Printf("Received data %s\n", emailAuth) ``` - - - -```json Example -{ - "success": true -} -``` - - diff --git a/docs/api-reference/link/link-oauth-provider.mdx b/docs/api-reference/link/link-oauth-provider.mdx index 4eed7137a..5325a8c87 100644 --- a/docs/api-reference/link/link-oauth-provider.mdx +++ b/docs/api-reference/link/link-oauth-provider.mdx @@ -120,19 +120,3 @@ fmt.Printf("Received data %s\n", oauth) ``` - - - -```json Example -{ - "name": "Garmin", - "slug": "hamin", - "logo": "https://garmin.com", - "description": "Garmin Watches", - "oauth_url": "https://garmin_aouth_url.com", - "auth_type": "oauth", - "id": 1 -} -``` - - diff --git a/docs/api-reference/link/link-password-provider.mdx b/docs/api-reference/link/link-password-provider.mdx index d0cdbdfb5..fa480a585 100644 --- a/docs/api-reference/link/link-password-provider.mdx +++ b/docs/api-reference/link/link-password-provider.mdx @@ -97,16 +97,3 @@ fmt.Printf("Received data %s\n", response) ``` - - - -```json Example -{ - "state": "success", - "redirect_url": null, - "error_type": null, - "error": null -} -``` - - diff --git a/docs/api-reference/providers.mdx b/docs/api-reference/providers.mdx index eb62e9a1e..475f38829 100644 --- a/docs/api-reference/providers.mdx +++ b/docs/api-reference/providers.mdx @@ -69,19 +69,3 @@ fmt.Printf("Received data %s\n", response) ``` - - - -```json Response -[ - { - "name": "Oura", - "slug": "oura", - "logo": "https://logo_url.com", - "auth_type": "oauth", - "supported_resources": ["workouts", "sleep"] - } -] -``` - - diff --git a/docs/api-reference/timeseries/blood-pressure.mdx b/docs/api-reference/timeseries/blood-pressure.mdx index be4fac3ea..3cebc0252 100644 --- a/docs/api-reference/timeseries/blood-pressure.mdx +++ b/docs/api-reference/timeseries/blood-pressure.mdx @@ -93,20 +93,3 @@ fmt.Printf("Received data %s\n", response) ``` - - - -```json Example -[ - { - "id": 2, - "timestamp": "2022-08-04T12:42:45.727135+00:00", - "systolic": "125", - "diastolic": "75", - "type": null, - "unit": "mmHg" - } -] -``` - - diff --git a/docs/api-reference/user/create-insurance.mdx b/docs/api-reference/user/create-insurance.mdx index 87c1f1816..f00fb0d4d 100644 --- a/docs/api-reference/user/create-insurance.mdx +++ b/docs/api-reference/user/create-insurance.mdx @@ -37,31 +37,3 @@ curl --request POST \ ``` - - - -```json Response -{ - "payor_code": "UNITE", - "member_id": "test", - "group_id": "123", - "relationship": "Self", - "insured": { - "first_name": "John", - "last_name": "Doe", - "email": "john@email.com", - "phone_number":"+1123123123", - "gender": "Male", - "dob": "1999-01-01", - "address": { - "first_line": "Some Street", - "second_line": null, - "zip_code": "85004", - "state": "AZ", - "city": "Phoenix", - } - } -} -``` - - diff --git a/docs/api-reference/user/create-sign-in-token.mdx b/docs/api-reference/user/create-sign-in-token.mdx index 6a909fa17..5672fafcf 100644 --- a/docs/api-reference/user/create-sign-in-token.mdx +++ b/docs/api-reference/user/create-sign-in-token.mdx @@ -81,14 +81,3 @@ fmt.Printf("Received data %s\n", response) ``` - - - -```json Response -{ - "user_id": "e209947b-323e-4108-8e18-1518b80da0bd", - "sign_in_token": "ZXlKaGJHY2lPaUpTVXpJMU5pSXNJblI1Y0NJNklrcFhWQ0o5LmV5SnpkV0lpT2lJeE1qTTBOVFkzT0Rrd0lpd2lhV0YwSWpveE5URTJNak01TURJeWZRLmFqVXZaWlZrVVFJc3FMbl9uRWotcHkxbjZIV2VrN0tDdXlGbFlNRWU1RDM3WEhJN1lkdWpjczRNQUdLTlZJN3ZDWV9veVFIdEwzMmx4S0RpblRpVC13Z1dMeHdKdFNYQ3hmdTZhT1RGbnBDNEpPR1RGR2hqeldqT1NCNGRqVzJmS3Roa1MweFJfME5FT1dNRjNSanFNc25laVpES1JvYlpoa0gzVkxuTmdVaEFNMU1zeTZsYVB2eHdVZi1xZXFIMExaT2hSSjIxX1RzdElJN3hES3BpbGt3aUJDb0hGb1FUbE5FQ0hxQ2lDOEI2OWZDVmxVbzZSaS0tYTVXaFY2cF90NFNLRXRQMmJWUlhqeUlBOGU2dEcwcXNMOWtpNlVhVDRBZWpLN1V2QTRkSVJ3dTJkUlZGUEpHRGVnY2JCME9TVlNQYlRTSklfLXlnaS1aNkNqMDNmZw==" -} -``` - - diff --git a/docs/api-reference/user/create-user.mdx b/docs/api-reference/user/create-user.mdx index c4cd3ca31..4eed0589d 100644 --- a/docs/api-reference/user/create-user.mdx +++ b/docs/api-reference/user/create-user.mdx @@ -82,14 +82,3 @@ fmt.Printf("Received data %s\n", response) ``` - - - -```json Response -{ - "client_user_id": "5269f80a-fb0b-432a-b311-c3eac1a46260", - "user_id": "e209947b-323e-4108-8e18-1518b80da0bd" -} -``` - - diff --git a/docs/api-reference/user/delete-user.mdx b/docs/api-reference/user/delete-user.mdx index 915f77def..1235f12af 100644 --- a/docs/api-reference/user/delete-user.mdx +++ b/docs/api-reference/user/delete-user.mdx @@ -80,13 +80,3 @@ fmt.Printf("Received data %s\n", response) ``` - - - -```json Example -{ - "success": true -} -``` - - diff --git a/docs/api-reference/user/deregister-a-provider.mdx b/docs/api-reference/user/deregister-a-provider.mdx index 7f9153535..feed776da 100644 --- a/docs/api-reference/user/deregister-a-provider.mdx +++ b/docs/api-reference/user/deregister-a-provider.mdx @@ -97,13 +97,3 @@ fmt.Printf("Received data %s\n", response) - - - -```json Example -{ - "success": true -} -``` - - diff --git a/docs/api-reference/user/get-info-latest.mdx b/docs/api-reference/user/get-info-latest.mdx index 2d023eeda..8cf8d40e5 100644 --- a/docs/api-reference/user/get-info-latest.mdx +++ b/docs/api-reference/user/get-info-latest.mdx @@ -73,25 +73,3 @@ fmt.Printf("Received data %s\n", response) ``` - - - -```json Response -{ - "first_name": "John", - "last_name": "Doe", - "email": "john@email.com", - "phone_number":"+1123123123", - "gender": "Male", - "dob": "1999-01-01", - "address": { - "first_line": "Some Street", - "second_line": null, - "zip_code": "85004", - "state": "AZ", - "city": "Phoenix", - } -} -``` - - diff --git a/docs/api-reference/user/get-latest-insurance.mdx b/docs/api-reference/user/get-latest-insurance.mdx index 36071fc64..28519f271 100644 --- a/docs/api-reference/user/get-latest-insurance.mdx +++ b/docs/api-reference/user/get-latest-insurance.mdx @@ -14,31 +14,3 @@ curl --request GET \ ``` - - - -```json Response -{ - "payor_code": "UNITE", - "member_id": "test", - "group_id": "123", - "relationship": "Self", - "insured": { - "first_name": "John", - "last_name": "Doe", - "email": "john@email.com", - "phone_number":"+1123123123", - "gender": "Male", - "dob": "1999-01-01", - "address": { - "first_line": "Some Street", - "second_line": null, - "zip_code": "85004", - "state": "AZ", - "city": "Phoenix", - } - } -} -``` - - diff --git a/docs/api-reference/user/get-user.mdx b/docs/api-reference/user/get-user.mdx index 49b6c27f1..a590b1741 100644 --- a/docs/api-reference/user/get-user.mdx +++ b/docs/api-reference/user/get-user.mdx @@ -72,35 +72,3 @@ fmt.Printf("Received data %s\n", response) ``` - - - -```json Example -{ - "user_id": "409d9870-21fb-443a-8daa-c5222659f40e", - "team_id": "3aac677c-557f-40b7-9251-0315c1f48e77", - "client_user_id": "d734e32e-dd43-4b77-ab56-692524279531", - "connected_sources": [ - { - "source": { - "name": "Oura", - "slug": "oura", - "logo": "logo_url" - }, - "created_on": "2022-08-04T12:42:45.596792+00:00" - } - ], - "fallback_time_zone": { - "id": "Europe/London", - "source_slug": "manual", - "updated_at": "2022-09-11T13:45:56+00:00" - }, - "fallback_birth_date": { - "value": "1980-03-13", - "source_slug": "manual", - "updated_at": "2022-09-11T13:45:56+00:00" - } -} -``` - - diff --git a/docs/api-reference/user/get-users.mdx b/docs/api-reference/user/get-users.mdx index 0656483a6..fd28dfc95 100644 --- a/docs/api-reference/user/get-users.mdx +++ b/docs/api-reference/user/get-users.mdx @@ -67,32 +67,3 @@ fmt.Printf("Received data %s\n", response) ``` - - - -```json Example -{ - "users": [ - { - "user_id": "409d9870-21fb-443a-8daa-c5222659f40e", - "team_id": "3aac677c-557f-40b7-9251-0315c1f48e77", - "client_user_id": "d734e32e-dd43-4b77-ab56-692524279531", - "connected_sources": [ - { - "source": { - "name": "Oura", - "slug": "oura", - "logo": "logo_url" - }, - "created_on": "2022-08-04T12:42:45.596792+00:00" - } - ] - } - ], - "total": 1, - "offset": 0, - "limit": 100 -} -``` - - diff --git a/docs/api-reference/user/patch-user.mdx b/docs/api-reference/user/patch-user.mdx index 4933ca6b9..41ddef659 100644 --- a/docs/api-reference/user/patch-user.mdx +++ b/docs/api-reference/user/patch-user.mdx @@ -78,11 +78,3 @@ fmt.Printf("Received data %s\n", response) ``` - - - -``` Response -204 No Content -``` - - diff --git a/docs/api-reference/user/refresh-user-data.mdx b/docs/api-reference/user/refresh-user-data.mdx index 5687ef70b..34c6db614 100644 --- a/docs/api-reference/user/refresh-user-data.mdx +++ b/docs/api-reference/user/refresh-user-data.mdx @@ -71,22 +71,3 @@ if err != nil { fmt.Printf("Received data %s\n", response) ``` - - - -```json Example -{ - "success": true, - "user_id": "55c39ede-16b8-438f-bbb9-62591dc2400e", - "refreshed_sources": [ - "Withings/workouts", - "Withings/sleep", - "Withings/body", - "Withings/vitals/blood_pressure", - "Withings/activity" - ], - "failed_sources": ["Oura/sleep"] -} -``` - - diff --git a/docs/api-reference/user/undo-delete-user.mdx b/docs/api-reference/user/undo-delete-user.mdx index 3af121a5c..ae7b3e854 100644 --- a/docs/api-reference/user/undo-delete-user.mdx +++ b/docs/api-reference/user/undo-delete-user.mdx @@ -97,13 +97,3 @@ fmt.Printf("Received data %s\n", response) ``` - - - -```json Example -{ - "success": true -} -``` - - diff --git a/docs/api-reference/user/upsert-info.mdx b/docs/api-reference/user/upsert-info.mdx index baf019fc3..b723b20df 100644 --- a/docs/api-reference/user/upsert-info.mdx +++ b/docs/api-reference/user/upsert-info.mdx @@ -31,25 +31,3 @@ curl --request PATCH \ ``` - - - -```json Response -{ - "first_name": "John", - "last_name": "Doe", - "email": "john@email.com", - "phone_number":"+1123123123", - "gender": "Male", - "dob": "1999-01-01", - "address": { - "first_line": "Some Street", - "second_line": null, - "zip_code": "85004", - "state": "AZ", - "city": "Phoenix", - } -} -``` - - diff --git a/docs/lab/results/result-formats.mdx b/docs/lab/results/result-formats.mdx index c0828b145..df50fd525 100644 --- a/docs/lab/results/result-formats.mdx +++ b/docs/lab/results/result-formats.mdx @@ -19,6 +19,11 @@ curl --request GET \ --header 'x-vital-api-key: ' \ ``` + + +Some laboratories do not issue PDFs for partial results and only provide PDF reports once all results are finalized + + An example result: