Widgets
Biomarker Widget
intro the biomarker widget displays an objective indicator of health captured during a {{facescan}} , such as heart rate or respiratory rate this widget is essential for users who need immediate, real time feedback on specific health parameters itβs designed for quick, actionable insights, making it easy for users to assess their current state and understand individual biomarker values integrate it within your platform to give users a clear, snapshot view of a particular aspect of their health layout small intelliwidgets js sdk docid\ dekcuoaphrmczxe caj5v usage creating the widget the code snippet below creates a biomarker widget and widgets docid\ sxvsw2jfsohr7xbxeyz j it to the dom create and mount widget const intelli = intelliprovewidgets("user action token"); const config = { / config / }; const variation = "default"; const themeoverrides = { / theme overrides / }; intelli mountwidget( "#heart rate tile", "biomarker", config, variation, themeoverrides ); config the biomarker widget requires additional configuration parameters that describe which kind of biomarker should be displayed and which {{facescan}} is referenced to display the value config const config = { face scan id "3db0ca35ba713354bfc2c2c215aba2a9" parameter "heart rate" } property description face scan id optional string unique (internal) reference to a performed face scan set to null to display a placeholder widget parameter string biomarker of choice list of available biomarkers docid\ buhj nt45fuxcpges0qph parameter layout heart rate small respiratory rate small resonant breathing score small heart rate variability small blood pressure small variation two variations of the biomarker widget are available "default" "arc" theme overrides the biomarker widget allows widget appearance the used accent colors are functional primary 500 functional secondary 500 functional tertiary 500 json data retrieve the biomarker widget data in json format using the rest api docid\ biupvixvhltbukklr2ati the data field of the response body describes the widget properties the biomarker widget consists of the following fields (similar to the metric widget) the value is the actual numerical value it can be an integer or a floating point number the unit holds a textual value for the unit of the parameter the range represents the entire span of possible values for that the parameter, indicated by minimum and a maximum the zone indicates where the actual value falls, among three categories related to the health condition "good" ( zone 1 ) "neutral" ( zone 2 ) "bad" ( zone 3 ) the optimum defines how the range should be interpreted and visualized there are three possible values for optimum "low," "high," and "middle " for "low" lower values are categorized as "good" (green color), while higher values are categorized as "bad" (red color) for "high" higher values are categorized as "good" (green color), while lower values are categorized as "bad" (red color) for "middle" the "good" zone (green color) is centered around the middle of the range values lower or higher than this midpoint are categorized as "bad" (red color)