FaceScan Schema

Summary
Schemas to specify the data format for FaceScan.

The following schemas specify the data format for FaceScan. Please note that:

  • _ent_ are "entered" values from the App.
  • _raw_ are raw measurement values from the scan technology and have not been "smoothed" to remove outliers.
  • _adj_ are the adjusted values by running a "smoothing" filter to enhance repeatability of results (use where possible).
  • _gen_ values which have no meaningful value, but might be used for retrieving extra scan data, such as 3D mesh generation.

Input

The following schema specifies the expected parameters that the App must pass to MultiScan initiateScan() method:

  	 
{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "type": "object",
    "description": "Schema for FaceScan options parameter, as passed to setup().",
    "properties": {
        "miscData": {
            "description": "Optional misc data as provided by the app when scan is initiated. For example, can be used for expense tracking.",
            "type": "object"
        },
        "kg_ent_weight": {
            "description": "Weight entered at the time of scan, in kilograms. Minimum = 30kg; Maximum = 300kg.",
            "type": "number",
            "minimum": 30,
            "maximum": 300
        },
        "cm_ent_height": {
            "description": "Height entered at the time of scan, in centimeters. Minimum = 120cm; Maximum = 220cm.",
            "type": "number",
            "minimum": 120,
            "maximum": 220
        },
        "enum_ent_sex": {
            "description": "The biological sex of the user, as they have entered.",
            "type": "string",
            "enum": [
                "male",
                "female"
            ]
        },
        "yr_ent_age": {
            "description": "The age of the user, in years, as they have entered or calculated from birth date. Minimum = 13 years; Maximum = 120 years.",
            "type":"integer",
            "minimum": 13,
            "maximum": 120
        },
        "bool_ent_smoker": {
            "description": "Whether the user is a smoker or not.",
            "type": "boolean"
        },
        "bool_ent_hypertension": {
            "description": "Whether the user is diagnosed with hypertension or not.",
            "type": "boolean"
        },
        "bool_ent_bloodPressureMedication": {
            "description": "Whether the user is taking blood pressure medication or not, such as to treat hypertension or hypotension.",
            "type": "boolean"
        },
        "enum_ent_diabetic": {
            "description": "If the user is diabetic, what diabetes type they are diagnosed with.",
            "type": "string",
            "enum": [
                "none",
                "type1",
                "type2"
            ]
        }
    },
    "required": [
        "kg_ent_weight",
        "cm_ent_height",
        "enum_ent_sex",
        "yr_ent_age",
        "bool_ent_smoker",
        "bool_ent_hypertension",
        "bool_ent_bloodPressureMedication",
        "enum_ent_diabetic"
    ]
}
	
  
Copied!

Output (Scan Result)

The following schema specifies the result from successful scan. FaceScan in particular is an instantaneous measurement, so "smoothing" of data is not run on results.

Note: Not all measurements may be available, depending on the contract agreement with AHI and the client: