Technical Docs
  • Introduction
  • Guides
    • Getting Started
    • Attribution Guidelines
    • Core Concepts
      • Adherence Score
      • Programs, Diets, and Rulesets
      • User Profile
      • Datasets
    • Tutorials and Walkthroughs
      • Creating a Meal Plan
      • Food Log Guide
      • Pagination
      • Executing Multiple Mutations
  • Knowledge Base
    • How-to guides
      • How to add desserts to your meal plan
      • How to log your custom recipe
      • How to generate a Meal Plan based on a template
    • Common errors
      • Meal Plan generation
    • FAQs
      • Getting Started on Suggestic
      • API and Authentication
      • Device Compatibility
      • Meal Plan
      • Nutrition
      • Programs
      • Recipes
  • HELPFUL RESOURCES
    • Deprecated Features
    • Glossary
    • Integrations
      • Building a No-code Meal Planning Application
        • Step 1: Creating the Integromat Scenario and Google Forms Connection
        • Step 2: Creating a User, Generating a Meal Plan, and Retrieving It
        • Step 3: Crafting Our PDF and Connecting PDFMonkey
        • Step 4: Sending The Document to Our User
  • Packages and SDKs
    • Node Package (NPM)
  • GraphQL
    • GraphQL Overview
    • Authentication
    • Calling GraphQL
    • GraphQL Playground
  • Changelog
    • 2025
      • March
  • Suggestic API Reference
    • Search
      • Food Log
        • Branded Foods Search
        • Common Foods Search
        • My Branded Food Search
        • My Common Foods Search
        • Food Search
        • Legacy
          • Autocomplete
          • Barcode Search
      • Recipe Search
        • Recipe Search
        • Recipe Search by Name or Ingredients
        • Recipe Search by Ingredients
      • Meal Plan Template Search
      • Profile Search
      • Restaurant Search
        • Restaurant Search by Location
        • Restaurant Search
    • Queries
      • Appointments
        • Upcoming Appointments
        • Past Appointments
        • Appointments Types
      • Assessments
        • Assessment Answers
        • Display Assessments
        • Supplement Recommendations
        • User Assessments
      • Content
        • Content Library
        • Content Categories
        • Content Tags
        • Journey
      • Food Log
        • Frequently Logged
        • Food Log Entries
        • Macros Aggregation
        • Micronutrients Aggregation
        • Macro Goals
        • Recently Logged
        • User's Foods and Recipes
          • User's Recipes
        • Legacy
          • Food Log Entries (Legacy)
          • Own Food Items
          • Own Food Item
          • Own Food Item by Id
          • Own Items
          • Own Recipe
          • Own Recipes
      • Lab Tests
        • Biomarker Categories
        • Biomarker Units
        • Biomarker Catalog
        • Biomarkers
        • Biomarker Results
        • Historical Biomarker Results
        • Historical Results by Biomarker
        • Lab Test Reports
        • Recommended Supplements
        • Recommended Articles
      • Meal Plan
        • Meal Plan
        • Custom Meal Plan
        • Simplified Meal Tracking
          • Meal Tracker
        • Meal Plan Config
        • Meal Planner (deprecated)
      • Program
        • All Programs
        • Program Details
      • Recipes
        • Equivalent Recipes (Macros)
        • Equivalent Recipes (Calories)
        • Recipe by Id
        • Recipes By MealTime
        • Recipes By Tag
        • Recipe Swap Options
        • Popular Recipes
        • Favorite Recipes
        • Premium Program Recipes
      • Restaurants
        • Restaurant By Id
        • Menu Items
        • Menu Item By Id
        • Menu Item by Program
        • Recommend Menu Items
      • Restrictions
        • Restrictions
        • Restriction by ID
      • Shopping List
        • Shopping List by Aisle
        • Shopping List by Recipes
      • Subscriptions
        • Subscription List
      • Supplement Plans
        • Supplement plan list
        • Supplement list
      • Tracking
        • Activity and Exercise
        • Checklists
          • Intake Checklist
        • Daily Recap
          • Get Daily Recap
          • Get Daily Recaps
          • Get Daily Recap Questions
          • Get Daily Mood Summary
        • Inisghts
        • Wellness Score
        • Sleep
          • Sleep Time
          • Sleep Quality Score
        • Steps
        • Water and Hydration
        • Heart Rate
        • HRV
        • Weight Tracker
      • USDA Food
      • Users
        • Users
        • User Profile
      • WGPT
        • Assistants
        • Journey
        • Guardrails
    • Mutations
      • Appointments
        • Update Appointment Credits
      • Assessments
        • New User Assessments
        • Set User Answers
      • Content
        • Mark Content as Read
      • Feedback
      • Food Log
        • Log Entries
          • Food Log
            • Add a Food Log Entry
            • Delete a Food Log Entry
          • Meal Log (Legacy)
            • Create Log Entry
            • Update Log Entry
            • Remove Log Entry
        • User's Foods and Recipes
          • Create a User Recipe
          • Create my Branded Food
          • Create my Common Foods
          • Update a User Recipe
          • Delete a User Recipe
          • Legacy: "Own" Recipe
            • Create "Own" Recipe
            • Update "Own" Recipe
            • Remove "Own" Recipe
        • AI Food Log
          • Process Ai Food
        • Legacy (ownFoods and ownRecipes)
          • Create "own" Food Item
          • Update "own Food"
          • Remove "own" Food Item
      • Journey Status
        • Start Journeys
        • Journey Status
        • Toggle Task Completed
      • Lab Tests
        • Add Biomarker
        • Update Biomarker
        • Add Biomarker Result
        • Add Biomarker Category
        • Update Biomarker Category
        • Remove Biomarker Category
        • Add Lab Test Report
        • Delete Lab Test Report
        • Update Lab Test Report
        • Create Recommended Supplement
        • Update Recommended Supplement
        • Remove Recommended Supplement
        • Create Recommended Article
        • Update Recommended Article
        • Remove Recommended Supplement
      • Meal Plan
        • Create Meal Plan Template
          • Custom Options
          • From Days
          • From Scratch
        • Assign a Meal Plan Template to a User
        • Generate Simple Meal Plan
        • Generate Meal Plan
        • Start Over Meal Plan
        • Swap Meals
        • Simplified Meal Tracking
          • Create a Meal Tracker Entry
        • Remove Meal Plan
        • Remove Meal Plan Recipe
      • Recipes
        • Add new recipe
        • Add Favorite Recipe
      • Shopping List
        • Add Multiple Recipes to the Shopping List
        • Add a Recipe to the Shopping List
        • Bulk Check/Uncheck Items
        • Check/Uncheck an Item
        • Clear Checked Items
        • Clear Shopping List
        • Remove Recipe
        • Update Serving Number
      • Subscriptions
        • Update Subscription
      • Supplement Plans
        • Create supplement plan for user
        • Update user supplement plan
        • Add Supplement
        • Update Supplement
      • Tracking
        • Activity and Exercise
          • Add Exercise Entry
          • Delete Exercise Entry
        • Checklists
          • Create my Checklist Item
          • Delete my Checklist Item
        • Daily Recap
          • Create a daily recap question
          • Select Daily Recap Questions
          • Delete a Daily Recap Question
        • Sleep
          • Add Sleep Time
          • Add Sleep Quality Score
        • Steps
          • Add Steps Count
          • Delete Steps Count
        • Heart Rate
          • Add Heart Rate
          • Delete Heart Rate
        • HRV
          • Add HRV
          • Delete HRV
        • Water and Hydration
        • Weight
          • Add Weight Entry
          • Remove Weight Entry
        • User Tracker Goals
          • Create User Goal
          • Update User Goal
          • Remove User Goal
      • Users
        • Authenticate using a Magic Link
        • Create User
        • Custom Attributes
        • Delete a User Account
        • Login User
        • Merge User Accounts
        • Request Reset Password
        • Reset Password
        • Request Password Reset email
        • Sensitive Profile Attributes
        • Update Profile
        • Update User's Program
        • User's Restrictions
        • Update Meal Plan Settings
        • User's Goals
        • Legacy User Mutations
          • Legacy | User's Biomarkers
          • User's Meal Plan Settings (deprecated)
      • WGPT
        • Add user to journey
  • Objects
    • Appointments
      • Appointment
      • Appointment Type
      • Appointment Credit
      • Attendee
      • Coach
    • Common
      • User
      • Adherence
      • Aisle Name
      • CPC
      • CPCIngredientGroup
      • Meal Times
      • Menu Item
      • Own Serving
      • Own Nutrients
      • MacroNutrientsRangeInput
      • Range
      • Tracker
      • Restaurant
    • Food Logs
      • Food Filter
      • Ingredient Amount
      • Ingredients
      • Own Recipe Ingredient
      • Meal Type
      • Nutrients
        • Nutrient Enum
      • Portions
      • Servings
      • AI Food Log
        • Food Analysis
    • Meal Plan
      • Debug Meal Plan Conditions
      • Meal
      • Meal Plan Day
      • Maximum Time per Meal
      • Maximum Ingredient Count
      • Meal Plan Template
      • Simple Meal Plan Filters
    • Recipe
      • Recipe
        • Tags
        • Cuisines
      • Recipe Swap Options
      • Parsed Ingredient Lines
      • Nutritional Info
      • Nutrients Per Serving
      • Calories Per Serving
      • Relative Calories
      • Source
      • Ingredients
      • Units of Measurement
    • Lab Tests
      • Article
      • Biomarker
    • Supplement
    • Assessments
      • Question
      • Answer
    • Content
      • Content Library
      • Content Categories
      • Content Tag
    • WGPT
      • Journey
      • dayJourney
      • Interaction
  • Case Studies
    • Reverse Health Case Study
Powered by GitBook
On this page
  • Arguments
  • Available fields
  • Examples

Was this helpful?

  1. Suggestic API Reference
  2. Mutations
  3. Lab Tests

Add Lab Test Report

Use the createLabTestReport mutation to create a lab test report.

Arguments

Argument Name

Type

Required?

Description

testName

String

Yes

Lab test report name.

title

String

Yes

Lab test report title. Not used on the app.

labName

String

Yes

Laboratory or processor name.

description

String

No

Description of the lab test.

testDate

DateTime

No

Date and time when the lab test report is created.

sampleCollectionDate

DateTime

No

Date and time of sample collection.

isVisible

Boolean

Yes

True if the lab test report should be displayed to end-users.

status

LabTestReportStatus

No

CREATED

ORDERED

FULFILLED

ERROR

RETURNED_TO_LAB

RESULTS_READY

PROCESS_COMPLETE

RESULTS_DELIVERED

orderingPhysician

String

No

Name or ID of the ordering provider.

externalId

String

No

External ID

orderId

String

No

Order ID

requisitionId

String

No

Requisition ID

reportPDF

Upload

No

Lab report file

imageUrl

String

No

URL of an image representative of the lab test. Will be used as video thumbnail if video is available.

videoUrl

String

No

Video URL to show in the report.

alert

Boolean

No

True if alert is active otherwise False.

alertText

String

No

Text shown in the alert.

alertAction

AlertAction

No

  • ATTEMPTED_FAILED: Unable to contact.

  • CONTACTED: Member Contacted and resolved.

alertStatus

AlertStatus

No

  • IN_REVIEW: In Review.

  • REVIEWED: Lab Reviewed - No Alerts.

  • OUT_OF_RANGE: Biomarker(s) Out of Range.

  • OTHER: Other.

  • FOLLOW_UP: Follow-up Required.

  • NO_FOLLOW_UP: No Follow-up Required.

  • COMPLETED: Lab Alert Completed.

Available fields

The following fields will be displayed in the response:

Field Name

Type

Description

success

Boolean

True if the lab test report has been created successfully. Otherwise, Flase

message

String

Description of the result

report

Object

Examples

Because it is not possible to upload files in the GraphQL playground, the following example creates a lab test report using the Postman tool.

Example 1

{
    "query": "mutation CreateLabTest($testName: String!, $testDate: DateTime!, $labName: String!, $title: String!, $reportPdf: Upload!) {createLabTestReport(testName: $testName testDate: $testDate labName: $labName title: $title reportPdf: $reportPdf) {success message }}",
    "variables": {
        "title":"Hormone Testing",
        "testName": "Hormone Testing",
        "testDate": "2022-02-03T10:01:01",
        "labName": "Lab Test",
        "reportPdf": null
    }
}

Example 2 with Lab Alerts

{
    "query": "mutation CreateLabTest($testName: String!, $testDate: DateTime!, $labName: String!, $title: String!, $reportPdf: Upload!, $alert: Boolean, $alertText: String, $alertStatus: AlertStatus, $alertStatus: AlertStatus) {createLabTestReport(testName: $testName testDate: $testDate labName: $labName title: $title reportPdf: $reportPdf alert: $alert alertText: $alertText alertStatus: $alertStatus alertAction: $alertAction) {success message }}",
    "variables": {
        "testName": "Hormone Testing",
        "testDate": "2022-02-03T10:01:01",
        "labName": "Lab Test",
        "reportPdf": null,
        "alert": true,
        "alertText":"Validation Error",
        "alertStatus":"REVIEWED",
        "alertAction":"CONTACTED"

    }
}

Example 3 with video and image

{
    "query": "mutation CreateLabTest($testName: String!, $testDate: DateTime!, $labName: String!, $title: String!, $reportPdf: Upload!, $status: LabTestReportStatus $videoUrl:String) {createLabTestReport( testName: $testName testDate: $testDate labName: $labName title: $title reportPdf: $reportPdf, status: $status, videoUrl: $videoUrl) {success message }}",
    "variables": {
        "testName": "Test with video",
        "testDate": "2023-04-12T14:44:19",
        "labName": "Test V",
        "reportPdf": null,
        "status": "RESULTS_READY",
        "videoUrl":"https://www.samplevideo.com/file.mp4"
        "imageUrl":"https://www.image.com/image.jpg"
    }
}

SET UP POSTMAN

Step 2: Add the URL server, select the POST method and add the Header

POST https://production.suggestic.com/graphql

Headers

Name
Type
Description

Authorization*

Bearer <JSON Token>

JSON Token

Step 3: Add the Body information

Click on the form-data option within the Body option and add the following 3 Key values:

  • operations: Add the mutation defined in step 1.

  • map: Map the files to your mutation.

  • 0: Choose the file type to upload your PDF file.

POST https:production.suggestic.com/graphql

Request Body

Name
Type
Description

*

{"query": "mutation CreateLabTest($memberId: ID!, $testName: String!, $testDate: DateTime!, $labName: String!, $title: String!, $reportPdf: Upload!) {createLabTestReport(memberId:$memberId testName: $testName testDate: $testDate labName: $labName title: $title reportPdf: $reportPdf) {success message }}","variables": {"memberId": "TWVtYmVyOjVlZDk5MjMyLWNhMTMtNGE2NS05MmIyLWZjMDk4ZjgyOWUwNA==", "testName": "Tester", "testDate": "2021-09-01T10:01:01", "labName": "Lab Test", "title": "Report Test", "reportPdf": null}}

Mutation Request

map*

{"0":["variables.reportPdf"]}

Map the files

0*

lab-test-report.pdf

Upload the PDF File

{
    // Response
}
{
    // Response
}

Step 4: Adding the Headers

  • Suggestic-partner: Partner Id

  • Authorization: Partner token

  • sg-user: Target userId

The response will be:

{
 "data": {
    "createLabTestReport": {
        "success": true,
        "message": "Lab Test Report was successfully created"
    }
 }

Within the TeleWellness Portal, the created lab test is displayed as follows:

PreviousRemove Biomarker CategoryNextDelete Lab Test Report

Last updated 1 year ago

Was this helpful?

Object that returns the information of the

lab test report