Skip to main content

Huma API Documentation (1.33.0)

Module

Retrieve Unseen Module Results

get
URL: /api/extensions/v1/user/{user_id}/flagged-modules
path Parameters
user_id
required
string

Responses

Response samples

Content type
application/json
{
  • "flags": null,
  • "lastManagerNote": null
}

Retrieve Unseen Module Results

post
URL: /api/extensions/v1/user/{user_id}/flagged-modules
path Parameters
user_id
required
string

Responses

Response samples

Content type
application/json
{
  • "flags": null,
  • "lastManagerNote": null
}

Retrieve Aggregated

post
URL: /api/extensions/v1/user/{user_id}/module-result/aggregate
path Parameters
user_id
required
string
Request Body schema: application/json
function
required
any
Enum: "SUM" "AVG" "MAX" "MIN" "MIN_MAX" "MIN_MAX_AVG"
primitiveName
required
string
mode
required
any
Enum: "NONE" "DAILY" "WEEKLY" "MONTHLY" "SIX_HOURS"
fromDateTime
string or null <date-time>
Default: null
toDateTime
string or null <date-time>
Default: null
skip
integer or null
Default: null
limit
integer or null
Default: null
timezone
string or null
Default: null
moduleConfigId
string or null
Default: null
includeMaxRecord
boolean or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "function": "SUM",
  • "primitiveName": "string",
  • "mode": "NONE",
  • "fromDateTime": null,
  • "toDateTime": null,
  • "skip": null,
  • "limit": null,
  • "timezone": "Europe/London",
  • "moduleConfigId": "66b4c83c71724e3c3a574b6a",
  • "includeMaxRecord": null
}

Response samples

Content type
application/json
[
  • {
    }
]

Update Module Result Status Sign

post
URL: /api/extensions/v1/user/{user_id}/module-result/{module_id}/sign
path Parameters
user_id
required
string
module_id
required
string
Request Body schema: application/json
type
required
string
ids
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "type": "Questionnaire",
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "modifiedFormsCount": 0
}

Update Module Result Unsign

post
URL: /api/extensions/v1/user/{user_id}/module-result/{module_id}/unsign
path Parameters
user_id
required
string
module_id
required
string
Request Body schema: application/json
type
required
string
ids
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "type": "Questionnaire",
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "modifiedFormsCount": 0
}

Submit_Module

Create AHQ

post
URL: /api/extensions/v1/user/{user_id}/module-result/AHQ
path Parameters
user_id
required
string
query Parameters
moduleConfigId
string or null
Default: null
Request Body schema: application/json
Array
type
required
string
moduleConfigId
string or null
Default: null
deploymentId
required
string
version
integer
Default: 0
deviceName
required
string
isAggregated
boolean
Default: false
startDateTime
string <date-time>
endDateTime
string or null <date-time>
Default: null
correlationStartDateTime
string or null <date-time>
Default: null
object or null
Default: null
source
string or null
Default: null
required
Array of objects (QuestionnaireAnswer)
object or null
Default: null
isForManager
boolean or null
Default: null
questionnaireId
required
string
questionnaireName
required
string
Array of objects or null (QuestionnaireAnswer)
Default: null
signOffDateTime
string or null <date-time>
Default: null
status
string or null
Default: null
Enum: "SUBMITTED" "DRAFT" "SIGNED" null
revision
integer or null
Default: null

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "ids": null,
  • "moduleResultId": null,
  • "errors": null
}

Create NDI

post
URL: /api/extensions/v1/user/{user_id}/module-result/NDI
path Parameters
user_id
required
string
query Parameters
moduleConfigId
string or null
Default: null
Request Body schema: application/json
Array
type
required
string
moduleConfigId
string or null
Default: null
deploymentId
required
string
version
integer
Default: 0
deviceName
required
string
isAggregated
boolean
Default: false
startDateTime
string <date-time>
endDateTime
string or null <date-time>
Default: null
correlationStartDateTime
string or null <date-time>
Default: null
object or null
Default: null
source
string or null
Default: null
required
Array of objects (QuestionnaireAnswer)
object or null
Default: null
isForManager
boolean or null
Default: null
questionnaireId
required
string
questionnaireName
required
string
Array of objects or null (QuestionnaireAnswer)
Default: null
signOffDateTime
string or null <date-time>
Default: null
status
string or null
Default: null
Enum: "SUBMITTED" "DRAFT" "SIGNED" null
revision
integer or null
Default: null

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "ids": null,
  • "moduleResultId": null,
  • "errors": null
}

Create ODI

post
URL: /api/extensions/v1/user/{user_id}/module-result/ODI
path Parameters
user_id
required
string
query Parameters
moduleConfigId
string or null
Default: null
Request Body schema: application/json
Array
type
required
string
moduleConfigId
string or null
Default: null
deploymentId
required
string
version
integer
Default: 0
deviceName
required
string
isAggregated
boolean
Default: false
startDateTime
string <date-time>
endDateTime
string or null <date-time>
Default: null
correlationStartDateTime
string or null <date-time>
Default: null
object or null
Default: null
source
string or null
Default: null
required
Array of objects (QuestionnaireAnswer)
object or null
Default: null
isForManager
boolean or null
Default: null
questionnaireId
required
string
questionnaireName
required
string
Array of objects or null (QuestionnaireAnswer)
Default: null
signOffDateTime
string or null <date-time>
Default: null
status
string or null
Default: null
Enum: "SUBMITTED" "DRAFT" "SIGNED" null
revision
integer or null
Default: null

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "ids": null,
  • "moduleResultId": null,
  • "errors": null
}

Create SRS

post
URL: /api/extensions/v1/user/{user_id}/module-result/SRS
path Parameters
user_id
required
string
query Parameters
moduleConfigId
string or null
Default: null
Request Body schema: application/json
Array
type
required
string
moduleConfigId
string or null
Default: null
deploymentId
required
string
version
integer
Default: 0
deviceName
required
string
isAggregated
boolean
Default: false
startDateTime
string <date-time>
endDateTime
string or null <date-time>
Default: null
correlationStartDateTime
string or null <date-time>
Default: null
object or null
Default: null
source
string or null
Default: null
required
Array of objects (QuestionnaireAnswer)
object or null
Default: null
isForManager
boolean or null
Default: null
questionnaireId
required
string
questionnaireName
required
string
Array of objects or null (QuestionnaireAnswer)
Default: null
signOffDateTime
string or null <date-time>
Default: null
status
string or null
Default: null
Enum: "SUBMITTED" "DRAFT" "SIGNED" null
revision
integer or null
Default: null

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "ids": null,
  • "moduleResultId": null,
  • "errors": null
}

Create CAT

post
URL: /api/extensions/v1/user/{user_id}/module-result/CAT
path Parameters
user_id
required
string
query Parameters
moduleConfigId
string or null
Default: null
Request Body schema: application/json
Array
type
required
string
moduleConfigId
string or null
Default: null
deploymentId
required
string
version
integer
Default: 0
deviceName
required
string
isAggregated
boolean
Default: false
startDateTime
string <date-time>
endDateTime
string or null <date-time>
Default: null
correlationStartDateTime
string or null <date-time>
Default: null
object or null
Default: null
source
string or null
Default: null
required
Array of objects (QuestionnaireAnswer)
object or null
Default: null
isForManager
boolean or null
Default: null
questionnaireId
required
string
questionnaireName
required
string
Array of objects or null (QuestionnaireAnswer)
Default: null
signOffDateTime
string or null <date-time>
Default: null
status
string or null
Default: null
Enum: "SUBMITTED" "DRAFT" "SIGNED" null
revision
integer or null
Default: null

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "ids": null,
  • "moduleResultId": null,
  • "errors": null
}

Create WHQ

post
URL: /api/extensions/v1/user/{user_id}/module-result/WHQ
path Parameters
user_id
required
string
query Parameters
moduleConfigId
string or null
Default: null
Request Body schema: application/json
Array
type
required
string
moduleConfigId
string or null
Default: null
deploymentId
required
string
version
integer
Default: 0
deviceName
required
string
isAggregated
boolean
Default: false
startDateTime
string <date-time>
endDateTime
string or null <date-time>
Default: null
correlationStartDateTime
string or null <date-time>
Default: null
object or null
Default: null
source
string or null
Default: null
required
Array of objects (QuestionnaireAnswer)
object or null
Default: null
isForManager
boolean or null
Default: null
questionnaireId
required
string
questionnaireName
required
string
Array of objects or null (QuestionnaireAnswer)
Default: null
signOffDateTime
string or null <date-time>
Default: null
status
string or null
Default: null
Enum: "SUBMITTED" "DRAFT" "SIGNED" null
revision
integer or null
Default: null

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "ids": null,
  • "moduleResultId": null,
  • "errors": null
}

Create ECG

post
URL: /api/extensions/v1/user/{user_id}/module-result/ECG
path Parameters
user_id
required
string
query Parameters
moduleConfigId
string or null
Default: null
Request Body schema: application/json
Array
type
required
string
moduleConfigId
string or null
Default: null
deploymentId
required
string
version
integer
Default: 0
deviceName
required
string
isAggregated
boolean
Default: false
startDateTime
string <date-time>
endDateTime
string or null <date-time>
Default: null
correlationStartDateTime
string or null <date-time>
Default: null
object or null
Default: null
source
string or null
Default: null
averageHeartRate
required
integer
classification
required
any
Enum: 1 2 3 4 6 8 9 10 11 12 13 14 15 16 17 18
leadType
required
any
Enum: 1 6
object or null
Default: null
object or null
Default: null

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "ids": null,
  • "moduleResultId": null,
  • "errors": null
}

Create BMI

post
URL: /api/extensions/v1/user/{user_id}/module-result/BMI
path Parameters
user_id
required
string
query Parameters
moduleConfigId
string or null
Default: null
Request Body schema: application/json
Array
type
required
string
moduleConfigId
string or null
Default: null
deploymentId
required
string
version
integer
Default: 0
deviceName
required
string
isAggregated
boolean
Default: false
startDateTime
string <date-time>
endDateTime
string or null <date-time>
Default: null
correlationStartDateTime
string or null <date-time>
Default: null
object or null
Default: null
source
string or null
Default: null
value
required
number
valueUnit
string
Default: "kg"
originalValue
number or null
Default: null
originalUnit
string or null
Default: null

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "ids": null,
  • "moduleResultId": null,
  • "errors": null
}

Create KCCQ

post
URL: /api/extensions/v1/user/{user_id}/module-result/KCCQ
path Parameters
user_id
required
string
query Parameters
moduleConfigId
string or null
Default: null
Request Body schema: application/json
Array
type
required
string
moduleConfigId
string or null
Default: null
deploymentId
required
string
version
integer
Default: 0
deviceName
required
string
isAggregated
boolean
Default: false
startDateTime
string <date-time>
endDateTime
string or null <date-time>
Default: null
correlationStartDateTime
string or null <date-time>
Default: null
object or null
Default: null
source
string or null
Default: null
required
Array of objects (QuestionnaireAnswer)
object or null
Default: null
isForManager
boolean or null
Default: null
questionnaireId
required
string
questionnaireName
required
string
Array of objects or null (QuestionnaireAnswer)
Default: null
signOffDateTime
string or null <date-time>
Default: null
status
string or null
Default: null
Enum: "SUBMITTED" "DRAFT" "SIGNED" null
revision
integer or null
Default: null

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "ids": null,
  • "moduleResultId": null,
  • "errors": null
}

Create KOOS

post
URL: /api/extensions/v1/user/{user_id}/module-result/KOOS
path Parameters
user_id
required
string
query Parameters
moduleConfigId
string or null
Default: null
Request Body schema: application/json
Array
type
required
string
moduleConfigId
string or null
Default: null
deploymentId
required
string
version
integer
Default: 0
deviceName
required
string
isAggregated
boolean
Default: false
startDateTime
string <date-time>
endDateTime
string or null <date-time>
Default: null
correlationStartDateTime
string or null <date-time>
Default: null
object or null
Default: null
source
string or null
Default: null
required
Array of objects (QuestionnaireAnswer)
object or null
Default: null
isForManager
boolean or null
Default: null
questionnaireId
required
string
questionnaireName
required
string
Array of objects or null (QuestionnaireAnswer)
Default: null
signOffDateTime
string or null <date-time>
Default: null
status
string or null
Default: null
Enum: "SUBMITTED" "DRAFT" "SIGNED" null
revision
integer or null
Default: null

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "ids": null,
  • "moduleResultId": null,
  • "errors": null
}

Create OACS

post
URL: /api/extensions/v1/user/{user_id}/module-result/OACS
path Parameters
user_id
required
string
query Parameters
moduleConfigId
string or null
Default: null
Request Body schema: application/json
Array
type
required
string
moduleConfigId
string or null
Default: null
deploymentId
required
string
version
integer
Default: 0
deviceName
required
string
isAggregated
boolean
Default: false
startDateTime
string <date-time>
endDateTime
string or null <date-time>
Default: null
correlationStartDateTime
string or null <date-time>
Default: null
object or null
Default: null
source
string or null
Default: null
required
Array of objects (QuestionnaireAnswer)
object or null
Default: null
isForManager
boolean or null
Default: null
questionnaireId
required
string
questionnaireName
required
string
Array of objects or null (QuestionnaireAnswer)
Default: null
signOffDateTime
string or null <date-time>
Default: null
status
string or null
Default: null
Enum: "SUBMITTED" "DRAFT" "SIGNED" null
revision
integer or null
Default: null

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "ids": null,
  • "moduleResultId": null,
  • "errors": null
}

Create OARS

post
URL: /api/extensions/v1/user/{user_id}/module-result/OARS
path Parameters
user_id
required
string
query Parameters
moduleConfigId
string or null
Default: null
Request Body schema: application/json
Array
type
required
string
moduleConfigId
string or null
Default: null
deploymentId
required
string
version
integer
Default: 0
deviceName
required
string
isAggregated
boolean
Default: false
startDateTime
string <date-time>
endDateTime
string or null <date-time>
Default: null
correlationStartDateTime
string or null <date-time>
Default: null
object or null
Default: null
source
string or null
Default: null
required
Array of objects (QuestionnaireAnswer)
object or null
Default: null
isForManager
boolean or null
Default: null
questionnaireId
required
string
questionnaireName
required
string
Array of objects or null (QuestionnaireAnswer)
Default: null
signOffDateTime
string or null <date-time>
Default: null
status
string or null
Default: null
Enum: "SUBMITTED" "DRAFT" "SIGNED" null
revision
integer or null
Default: null

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "ids": null,
  • "moduleResultId": null,
  • "errors": null
}

Create SF36

post
URL: /api/extensions/v1/user/{user_id}/module-result/SF36
path Parameters
user_id
required
string
query Parameters
moduleConfigId
string or null
Default: null
Request Body schema: application/json
Array
type
required
string
moduleConfigId
string or null
Default: null
deploymentId
required
string
version
integer
Default: 0
deviceName
required
string
isAggregated
boolean
Default: false
startDateTime
string <date-time>
endDateTime
string or null <date-time>
Default: null
correlationStartDateTime
string or null <date-time>
Default: null
object or null
Default: null
source
string or null
Default: null
required
Array of objects (QuestionnaireAnswer)
object or null
Default: null
isForManager
boolean or null
Default: null
questionnaireId
required
string
questionnaireName
required
string
Array of objects or null (QuestionnaireAnswer)
Default: null
signOffDateTime
string or null <date-time>
Default: null
status
string or null
Default: null
Enum: "SUBMITTED" "DRAFT" "SIGNED" null
revision
integer or null
Default: null

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "ids": null,
  • "moduleResultId": null,
  • "errors": null
}

Create Step

post
URL: /api/extensions/v1/user/{user_id}/module-result/Step
path Parameters
user_id
required
string
query Parameters
moduleConfigId
string or null
Default: null
Request Body schema: application/json
Array
type
required
string
moduleConfigId
string or null
Default: null
deploymentId
required
string
version
integer
Default: 0
deviceName
required
string
isAggregated
boolean
Default: false
startDateTime
string <date-time>
endDateTime
string or null <date-time>
Default: null
correlationStartDateTime
string or null <date-time>
Default: null
object or null
Default: null
source
string or null
Default: null
value
required
integer
Array of objects or null (MultipleHourValuesData)
Default: null
object or null
Default: null
dataType
string or null
Default: null
Enum: "MULTIPLE_VALUE" null

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "ids": null,
  • "moduleResultId": null,
  • "errors": null
}

Create Photo

post
URL: /api/extensions/v1/user/{user_id}/module-result/Photo
path Parameters
user_id
required
string
query Parameters
moduleConfigId
string or null
Default: null
Request Body schema: application/json
Array
type
required
string
moduleConfigId
string or null
Default: null
deploymentId
required
string
version
integer
Default: 0
deviceName
required
string
isAggregated
boolean
Default: false
startDateTime
string <date-time>
endDateTime
string or null <date-time>
Default: null
correlationStartDateTime
string or null <date-time>
Default: null
object or null
Default: null
source
string or null
Default: null
required
object (S3Object)
object or null
Default: null
note
string or null
Default: null

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "ids": null,
  • "moduleResultId": null,
  • "errors": null
}

Create Sleep

post
URL: /api/extensions/v1/user/{user_id}/module-result/Sleep
path Parameters
user_id
required
string
query Parameters
moduleConfigId
string or null
Default: null
Request Body schema: application/json
Array
type
required
string
moduleConfigId
string or null
Default: null
deploymentId
required
string
version
integer
Default: 0
deviceName
required
string
isAggregated
boolean
Default: false
startDateTime
string <date-time>
endDateTime
string or null <date-time>
Default: null
correlationStartDateTime
string or null <date-time>
Default: null
object or null
Default: null
source
string or null
Default: null
awake
integer or null
Default: null
awakeCount
integer or null
Default: null
sleep
integer or null
Default: null
outOfBed
integer or null
Default: null
lightSleep
integer or null
Default: null
deepSleep
integer or null
Default: null
remSleep
integer or null
Default: null
duration
required
integer
Array of objects (SleepSummaryObject)
dateOfSleep
required
string
uwake
required
integer

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "ids": null,
  • "moduleResultId": null,
  • "errors": null
}

Create VR_12

post
URL: /api/extensions/v1/user/{user_id}/module-result/VR_12
path Parameters
user_id
required
string
query Parameters
moduleConfigId
string or null
Default: null
Request Body schema: application/json
Array
type
required
string
moduleConfigId
string or null
Default: null
deploymentId
required
string
version
integer
Default: 0
deviceName
required
string
isAggregated
boolean
Default: false
startDateTime
string <date-time>
endDateTime
string or null <date-time>
Default: null
correlationStartDateTime
string or null <date-time>
Default: null
object or null
Default: null
source
string or null
Default: null
required
Array of objects (QuestionnaireAnswer)
object or null
Default: null
isForManager
boolean or null
Default: null
questionnaireId
required
string
questionnaireName
required
string
Array of objects or null (QuestionnaireAnswer)
Default: null
signOffDateTime
string or null <date-time>
Default: null
status
string or null
Default: null
Enum: "SUBMITTED" "DRAFT" "SIGNED" null
revision
integer or null
Default: null

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "ids": null,
  • "moduleResultId": null,
  • "errors": null
}

Create EQ5D5L

post
URL: /api/extensions/v1/user/{user_id}/module-result/EQ5D5L
path Parameters
user_id
required
string
query Parameters
moduleConfigId
string or null
Default: null
Request Body schema: application/json
Array
type
required
string
moduleConfigId
string or null
Default: null
deploymentId
required
string
version
integer
Default: 0
deviceName
required
string
isAggregated
boolean
Default: false
startDateTime
string <date-time>
endDateTime
string or null <date-time>
Default: null
correlationStartDateTime
string or null <date-time>
Default: null
object or null
Default: null
source
string or null
Default: null
required
Array of objects (QuestionnaireAnswer)
object or null
Default: null
isForManager
boolean or null
Default: null
questionnaireId
required
string
questionnaireName
required
string
Array of objects or null (QuestionnaireAnswer)
Default: null
signOffDateTime
string or null <date-time>
Default: null
status
string or null
Default: null
Enum: "SUBMITTED" "DRAFT" "SIGNED" null
revision
integer or null
Default: null

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "ids": null,
  • "moduleResultId": null,
  • "errors": null
}

Create FJSHip

post
URL: /api/extensions/v1/user/{user_id}/module-result/FJSHip
path Parameters
user_id
required
string
query Parameters
moduleConfigId
string or null
Default: null
Request Body schema: application/json
Array
type
required
string
moduleConfigId
string or null
Default: null
deploymentId
required
string
version
integer
Default: 0
deviceName
required
string
isAggregated
boolean
Default: false
startDateTime
string <date-time>
endDateTime
string or null <date-time>
Default: null
correlationStartDateTime
string or null <date-time>
Default: null
object or null
Default: null
source
string or null
Default: null
required
Array of objects (QuestionnaireAnswer)
object or null
Default: null
isForManager
boolean or null
Default: null
questionnaireId
required
string
questionnaireName
required
string
Array of objects or null (QuestionnaireAnswer)
Default: null
signOffDateTime
string or null <date-time>
Default: null
status
string or null
Default: null
Enum: "SUBMITTED" "DRAFT" "SIGNED" null
revision
integer or null
Default: null

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "ids": null,
  • "moduleResultId": null,
  • "errors": null
}

Create Weight

post
URL: /api/extensions/v1/user/{user_id}/module-result/Weight
path Parameters
user_id
required
string
query Parameters
moduleConfigId
string or null
Default: null
Request Body schema: application/json
Array
type
required
string
moduleConfigId
string or null
Default: null
deploymentId
required
string
version
integer
Default: 0
deviceName
required
string
isAggregated
boolean
Default: false
startDateTime
string <date-time>
endDateTime
string or null <date-time>
Default: null
correlationStartDateTime
string or null <date-time>
Default: null
object or null
Default: null
source
string or null
Default: null
value
required
number
valueUnit
string
Default: "kg"
originalValue
number or null
Default: null
originalUnit
string or null
Default: null

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "ids": null,
  • "moduleResultId": null,
  • "errors": null
}

Create MG_ADL

post
URL: /api/extensions/v1/user/{user_id}/module-result/MG_ADL
path Parameters
user_id
required
string
query Parameters
moduleConfigId
string or null
Default: null
Request Body schema: application/json
Array
type
required
string
moduleConfigId
string or null
Default: null
deploymentId
required
string
version
integer
Default: 0
deviceName
required
string
isAggregated
boolean
Default: false
startDateTime
string <date-time>
endDateTime
string or null <date-time>
Default: null
correlationStartDateTime
string or null <date-time>
Default: null
object or null
Default: null
source
string or null
Default: null
required
Array of objects (QuestionnaireAnswer)
object or null
Default: null
isForManager
boolean or null
Default: null
questionnaireId
required
string
questionnaireName
required
string
Array of objects or null (QuestionnaireAnswer)
Default: null
signOffDateTime
string or null <date-time>
Default: null
status
string or null
Default: null
Enum: "SUBMITTED" "DRAFT" "SIGNED" null
revision
integer or null
Default: null

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "ids": null,
  • "moduleResultId": null,
  • "errors": null
}

Create Ptosis

post
URL: /api/extensions/v1/user/{user_id}/module-result/Ptosis
path Parameters
user_id
required
string
query Parameters
moduleConfigId
string or null
Default: null
Request Body schema: application/json
Array
type
required
string
moduleConfigId
string or null
Default: null
deploymentId
required
string
version
integer
Default: 0
deviceName
required
string
isAggregated
boolean
Default: false
startDateTime
string <date-time>
endDateTime
string or null <date-time>
Default: null
correlationStartDateTime
string or null <date-time>
Default: null
object or null
Default: null
source
string or null
Default: null
required
object (S3Object)
isPrompted
boolean
Default: false

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
null

Create FJSKnee

post
URL: /api/extensions/v1/user/{user_id}/module-result/FJSKnee
path Parameters
user_id
required
string
query Parameters
moduleConfigId
string or null
Default: null
Request Body schema: application/json
Array
type
required
string
moduleConfigId
string or null
Default: null
deploymentId
required
string
version
integer
Default: 0
deviceName
required
string
isAggregated
boolean
Default: false
startDateTime
string <date-time>
endDateTime
string or null <date-time>
Default: null
correlationStartDateTime
string or null <date-time>
Default: null
object or null
Default: null
source
string or null
Default: null
required
Array of objects (QuestionnaireAnswer)
object or null
Default: null
isForManager
boolean or null
Default: null
questionnaireId
required
string
questionnaireName
required
string
Array of objects or null (QuestionnaireAnswer)
Default: null
signOffDateTime
string or null <date-time>
Default: null
status
string or null
Default: null
Enum: "SUBMITTED" "DRAFT" "SIGNED" null
revision
integer or null
Default: null

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "ids": null,
  • "moduleResultId": null,
  • "errors": null
}

Create Journal

post
URL: /api/extensions/v1/user/{user_id}/module-result/Journal
path Parameters
user_id
required
string
query Parameters
moduleConfigId
string or null
Default: null
Request Body schema: application/json
Array
type
required
string
moduleConfigId
string or null
Default: null
deploymentId
required
string
version
integer
Default: 0
deviceName
required
string
isAggregated
boolean
Default: false
startDateTime
string <date-time>
endDateTime
string or null <date-time>
Default: null
correlationStartDateTime
string or null <date-time>
Default: null
object or null
Default: null
source
string or null
Default: null
value
required
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "ids": null,
  • "moduleResultId": null,
  • "errors": null
}

Create NORFOLK

post
URL: /api/extensions/v1/user/{user_id}/module-result/NORFOLK
path Parameters
user_id
required
string
query Parameters
moduleConfigId
string or null
Default: null
Request Body schema: application/json
Array
type
required
string
moduleConfigId
string or null
Default: null
deploymentId
required
string
version
integer
Default: 0
deviceName
required
string
isAggregated
boolean
Default: false
startDateTime
string <date-time>
endDateTime
string or null <date-time>
Default: null
correlationStartDateTime
string or null <date-time>
Default: null
object or null
Default: null
source
string or null
Default: null
required
Array of objects (QuestionnaireAnswer)
object or null
Default: null
isForManager
boolean or null
Default: null
questionnaireId
required
string
questionnaireName
required
string
Array of objects or null (QuestionnaireAnswer)
Default: null
signOffDateTime
string or null <date-time>
Default: null
status
string or null
Default: null
Enum: "SUBMITTED" "DRAFT" "SIGNED" null
revision
integer or null
Default: null

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "ids": null,
  • "moduleResultId": null,
  • "errors": null
}

Create Symptom

post
URL: /api/extensions/v1/user/{user_id}/module-result/Symptom
path Parameters
user_id
required
string
query Parameters
moduleConfigId
string or null
Default: null
Request Body schema: application/json
Array
type
required
string
moduleConfigId
string or null
Default: null
deploymentId
required
string
version
integer
Default: 0
deviceName
required
string
isAggregated
boolean
Default: false
startDateTime
string <date-time>
endDateTime
string or null <date-time>
Default: null
correlationStartDateTime
string or null <date-time>
Default: null
object or null
Default: null
source
string or null
Default: null
Array of objects or null (ComplexSymptomValue)
Default: null
followUpQuestionIds
Array of strings or null
Default: null

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "ids": null,
  • "moduleResultId": null,
  • "errors": null
}

Create PeakFlow

post
URL: /api/extensions/v1/user/{user_id}/module-result/PeakFlow
path Parameters
user_id
required
string
query Parameters
moduleConfigId
string or null
Default: null
Request Body schema: application/json
Array
type
required
string
moduleConfigId
string or null
Default: null
deploymentId
required
string
version
integer
Default: 0
deviceName
required
string
isAggregated
boolean
Default: false
startDateTime
string <date-time>
endDateTime
string or null <date-time>
Default: null
correlationStartDateTime
string or null <date-time>
Default: null
object or null
Default: null
source
string or null
Default: null
value
required
integer
valuePercent
number or null
Default: null
valueUnit
string
Default: "L/min"

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "ids": null,
  • "moduleResultId": null,
  • "errors": null
}

Create DashScore

post
URL: /api/extensions/v1/user/{user_id}/module-result/DashScore
path Parameters
user_id
required
string
query Parameters
moduleConfigId
string or null
Default: null
Request Body schema: application/json
Array
type
required
string
moduleConfigId
string or null
Default: null
deploymentId
required
string
version
integer
Default: 0
deviceName
required
string
isAggregated
boolean
Default: false
startDateTime
string <date-time>
endDateTime
string or null <date-time>
Default: null
correlationStartDateTime
string or null <date-time>
Default: null
object or null
Default: null
source
string or null
Default: null
required
Array of objects (QuestionnaireAnswer)
object or null
Default: null
isForManager
boolean or null
Default: null
questionnaireId
required
string
questionnaireName
required
string
Array of objects or null (QuestionnaireAnswer)
Default: null
signOffDateTime
string or null <date-time>
Default: null
status
string or null
Default: null
Enum: "SUBMITTED" "DRAFT" "SIGNED" null
revision
integer or null
Default: null

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "ids": null,
  • "moduleResultId": null,
  • "errors": null
}

Create HeartRate

post
URL: /api/extensions/v1/user/{user_id}/module-result/HeartRate
path Parameters
user_id
required
string
query Parameters
moduleConfigId
string or null
Default: null
Request Body schema: application/json
One of
Array
type
required
string
moduleConfigId
string or null
Default: null
deploymentId
required
string
version
integer
Default: 0
deviceName
required
string
isAggregated
boolean
Default: false
startDateTime
string <date-time>
endDateTime
string or null <date-time>
Default: null
correlationStartDateTime
string or null <date-time>
Default: null
object or null
Default: null
source
string or null
Default: null
value
required
integer
heartRateType
string or null
Default: null
Enum: "UNSPECIFIED" "RESTING" "HIGH_FREQ" null
classification
string or null
Default: null
variabilityAVNN
integer or null
Default: null
variabilitySDNN
integer or null
Default: null
variabilityRMSSD
integer or null
Default: null
variabilityPNN50
number or null
Default: null
variabilityprcLF
number or null
Default: null
confidence
integer or null
Default: null
goodIBI
integer or null
Default: null
object or null
Default: null
valueUnit
string
Default: "bpm"
object or null
Default: null

Responses

Request samples

Content type
application/json
Example
CreateHeartRate
CreateHeartRate
CreateFitbitHRV
[ ]

Response samples

Content type
application/json
{
  • "ids": null,
  • "moduleResultId": null,
  • "errors": null
}

Create SymptomV2

post
URL: /api/extensions/v1/user/{user_id}/module-result/SymptomV2
path Parameters
user_id
required
string
query Parameters
moduleConfigId
string or null
Default: null
Request Body schema: application/json
Any of
Array
type
required
string
moduleConfigId
string or null
Default: null
deploymentId
required
string
version
integer
Default: 0
deviceName
required
string
isAggregated
boolean
Default: false
startDateTime
string <date-time>
endDateTime
string or null <date-time>
Default: null
correlationStartDateTime
string or null <date-time>
Default: null
object or null
Default: null
source
string or null
Default: null
Array of objects or null (ComplexSymptomValue)
Default: null
followUpQuestionIds
Array of strings or null
Default: null

Responses

Request samples

Content type
application/json
Example
CreateSymptom
CreateSymptom
CreateQuestionnaire
[ ]

Response samples

Content type
application/json
{
  • "ids": null,
  • "moduleResultId": null,
  • "errors": null
}

Create AirQuality

post
URL: /api/extensions/v1/user/{user_id}/module-result/AirQuality
path Parameters
user_id
required
string
query Parameters
moduleConfigId
string or null
Default: null
Request Body schema: application/json
Array
type
required
string
moduleConfigId
string or null
Default: null
deploymentId
required
string
version
integer
Default: 0
deviceName
required
string
isAggregated
boolean
Default: false
startDateTime
string <date-time>
endDateTime
string or null <date-time>
Default: null
correlationStartDateTime
string or null <date-time>
Default: null
object or null
Default: null
source
string or null
Default: null
value
required
integer
latitude
required
number
longitude
required
number

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "ids": null,
  • "moduleResultId": null,
  • "errors": null
}

Create ArmFatigue

post
URL: /api/extensions/v1/user/{user_id}/module-result/ArmFatigue
path Parameters
user_id
required
string
query Parameters
moduleConfigId
string or null
Default: null
Request Body schema: application/json
Array
type
required
string
moduleConfigId
string or null
Default: null
deploymentId
required
string
version
integer
Default: 0
deviceName
required
string
isAggregated
boolean
Default: false
startDateTime
string <date-time>
endDateTime
string or null <date-time>
Default: null
correlationStartDateTime
string or null <date-time>
Default: null
object or null
Default: null
source
string or null
Default: null
arm
required
any
Enum: "LEFT" "RIGHT"
required
object (S3Object)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
null

Create Temperature

post
URL: /api/extensions/v1/user/{user_id}/module-result/Temperature
path Parameters
user_id
required
string
query Parameters
moduleConfigId
string or null
Default: null
Request Body schema: application/json
Array
type
required
string
moduleConfigId
string or null
Default: null
deploymentId
required
string
version
integer
Default: 0
deviceName
required
string
isAggregated
boolean
Default: false
startDateTime
string <date-time>
endDateTime
string or null <date-time>
Default: null
correlationStartDateTime
string or null <date-time>
Default: null
object or null
Default: null
source
string or null
Default: null
value
required
number
valueUnit
string
Default: "oC"
originalValue
number or null
Default: null
originalUnit
string or null
Default: null

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "ids": null,
  • "moduleResultId": null,
  • "errors": null
}

Create BloodGlucose

post
URL: /api/extensions/v1/user/{user_id}/module-result/BloodGlucose
path Parameters
user_id
required
string
query Parameters
moduleConfigId
string or null
Default: null
Request Body schema: application/json
Array
type
required
string
moduleConfigId
string or null
Default: null
deploymentId
required
string
version
integer
Default: 0
deviceName
required
string
isAggregated
boolean
Default: false
startDateTime
string <date-time>
endDateTime
string or null <date-time>
Default: null
correlationStartDateTime
string or null <date-time>
Default: null
object or null
Default: null
source
string or null
Default: null
value
required
number
valueUnit
string
Default: "mmol/L"
originalValue
number or null
Default: null
originalUnit
string or null
Default: null

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "ids": null,
  • "moduleResultId": null,
  • "errors": null
}

Create DailyCheckIn

post
URL: /api/extensions/v1/user/{user_id}/module-result/DailyCheckIn
path Parameters
user_id
required
string
query Parameters
moduleConfigId
string or null
Default: null
Request Body schema: application/json
Array
type
required
string
moduleConfigId
string or null
Default: null
deploymentId
required
string
version
integer
Default: 0
deviceName
required
string
isAggregated
boolean
Default: false
startDateTime
string <date-time>
endDateTime
string or null <date-time>
Default: null
correlationStartDateTime
string or null <date-time>
Default: null
object or null
Default: null
source
string or null
Default: null
required
Array of objects (QuestionnaireAnswer)
object or null
Default: null
isForManager
boolean or null
Default: null
questionnaireId
required
string
questionnaireName
required
string
Array of objects or null (QuestionnaireAnswer)
Default: null
signOffDateTime
string or null <date-time>
Default: null
status
string or null
Default: null
Enum: "SUBMITTED" "DRAFT" "SIGNED" null
revision
integer or null
Default: null

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "ids": null,
  • "moduleResultId": null,
  • "errors": null
}

Create BloodPressure

post
URL: /api/extensions/v1/user/{user_id}/module-result/BloodPressure
path Parameters
user_id
required
string
query Parameters
moduleConfigId
string or null
Default: null
Request Body schema: application/json
Array
type
required
string
moduleConfigId
string or null
Default: null
deploymentId
required
string
version
integer
Default: 0
deviceName
required
string
isAggregated
boolean
Default: false
startDateTime
string <date-time>
endDateTime
string or null <date-time>
Default: null
correlationStartDateTime
string or null <date-time>
Default: null
object or null
Default: null
source
string or null
Default: null
diastolicValue
required
integer
systolicValue
required
integer
diastolicValueUnit
string
Default: "mmHg"
systolicValueUnit
string
Default: "mmHg"

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "ids": null,
  • "moduleResultId": null,
  • "errors": null
}

Create LysholmTegner

post
URL: /api/extensions/v1/user/{user_id}/module-result/LysholmTegner
path Parameters
user_id
required
string
query Parameters
moduleConfigId
string or null
Default: null
Request Body schema: application/json
Array
type
required
string
moduleConfigId
string or null
Default: null
deploymentId
required
string
version
integer
Default: 0
deviceName
required
string
isAggregated
boolean
Default: false
startDateTime
string <date-time>
endDateTime
string or null <date-time>
Default: null
correlationStartDateTime
string or null <date-time>
Default: null
object or null
Default: null
source
string or null
Default: null
required
Array of objects (QuestionnaireAnswer)
object or null
Default: null
isForManager
boolean or null
Default: null
questionnaireId
required
string
questionnaireName
required
string
Array of objects or null (QuestionnaireAnswer)
Default: null
signOffDateTime
string or null <date-time>
Default: null
status
string or null
Default: null
Enum: "SUBMITTED" "DRAFT" "SIGNED" null
revision
integer or null
Default: null

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "ids": null,
  • "moduleResultId": null,
  • "errors": null
}

Create Questionnaire

post
URL: /api/extensions/v1/user/{user_id}/module-result/Questionnaire
path Parameters
user_id
required
string
query Parameters
moduleConfigId
string or null
Default: null
Request Body schema: application/json
Array
type
required
string
moduleConfigId
string or null
Default: null
deploymentId
required
string
version
integer
Default: 0
deviceName
required
string
isAggregated
boolean
Default: false
startDateTime
string <date-time>
endDateTime
string or null <date-time>
Default: null
correlationStartDateTime
string or null <date-time>
Default: null
object or null
Default: null
source
string or null
Default: null
required
Array of objects (QuestionnaireAnswer)
object or null
Default: null
isForManager
boolean or null
Default: null
questionnaireId
required
string
questionnaireName
required
string
Array of objects or null (QuestionnaireAnswer)
Default: null
signOffDateTime
string or null <date-time>
Default: null
status
string or null
Default: null
Enum: "SUBMITTED" "DRAFT" "SIGNED" null
revision
integer or null
Default: null

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "ids": null,
  • "moduleResultId": null,
  • "errors": null
}

Create Breathlessness

post
URL: /api/extensions/v1/user/{user_id}/module-result/Breathlessness
path Parameters
user_id
required
string
query Parameters
moduleConfigId
string or null
Default: null
Request Body schema: application/json
Array
type
required
string
moduleConfigId
string or null
Default: null
deploymentId
required
string
version
integer
Default: 0
deviceName
required
string
isAggregated
boolean
Default: false
startDateTime
string <date-time>
endDateTime
string or null <date-time>
Default: null
correlationStartDateTime
string or null <date-time>
Default: null
object or null
Default: null
source
string or null
Default: null
required
Array of objects (QuestionnaireAnswer)
object or null
Default: null
isForManager
boolean or null
Default: null
questionnaireId
required
string
questionnaireName
required
string
Array of objects or null (QuestionnaireAnswer)
Default: null
signOffDateTime
string or null <date-time>
Default: null
status
string or null
Default: null
Enum: "SUBMITTED" "DRAFT" "SIGNED" null
revision
integer or null
Default: null

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "ids": null,
  • "moduleResultId": null,
  • "errors": null
}

Create KneeHealthIKDC

post
URL: /api/extensions/v1/user/{user_id}/module-result/KneeHealthIKDC
path Parameters
user_id
required
string
query Parameters
moduleConfigId
string or null
Default: null
Request Body schema: application/json
Array
type
required
string
moduleConfigId
string or null
Default: null
deploymentId
required
string
version
integer
Default: 0
deviceName
required
string
isAggregated
boolean
Default: false
startDateTime
string <date-time>
endDateTime
string or null <date-time>
Default: null
correlationStartDateTime
string or null <date-time>
Default: null
object or null
Default: null
source
string or null
Default: null
required
Array of objects (QuestionnaireAnswer)
object or null
Default: null
isForManager
boolean or null
Default: null
questionnaireId
required
string
questionnaireName
required
string
Array of objects or null (QuestionnaireAnswer)
Default: null
signOffDateTime
string or null <date-time>
Default: null
status
string or null
Default: null
Enum: "SUBMITTED" "DRAFT" "SIGNED" null
revision
integer or null
Default: null

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "ids": null,
  • "moduleResultId": null,
  • "errors": null
}

Create OxfordHipScore

post
URL: /api/extensions/v1/user/{user_id}/module-result/OxfordHipScore
path Parameters
user_id
required
string
query Parameters
moduleConfigId
string or null
Default: null
Request Body schema: application/json
Array
type
required
string
moduleConfigId
string or null
Default: null
deploymentId
required
string
version
integer
Default: 0
deviceName
required
string
isAggregated
boolean
Default: false
startDateTime
string <date-time>
endDateTime
string or null <date-time>
Default: null
correlationStartDateTime
string or null <date-time>
Default: null
object or null
Default: null
source
string or null
Default: null
hipAffected
required
any
Enum: 0 1 2
required
Array of objects (HipData)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "ids": null,
  • "moduleResultId": null,
  • "errors": null
}

Create SpatialSpaniOS

post
URL: /api/extensions/v1/user/{user_id}/module-result/SpatialSpaniOS
path Parameters
user_id
required
string
query Parameters
moduleConfigId
string or null
Default: null
Request Body schema: application/json
Array
type
required
string
moduleConfigId
string or null
Default: null
deploymentId
required
string
version
integer
Default: 0
deviceName
required
string
isAggregated
boolean
Default: false
startDateTime
string <date-time>
endDateTime
string or null <date-time>
Default: null
correlationStartDateTime
string or null <date-time>
Default: null
object or null
Default: null
source
string or null
Default: null
value
required
integer

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "ids": null,
  • "moduleResultId": null,
  • "errors": null
}

Create SurgeryDetails

post
URL: /api/extensions/v1/user/{user_id}/module-result/SurgeryDetails
path Parameters
user_id
required
string
query Parameters
moduleConfigId
string or null
Default: null
Request Body schema: application/json
Array
type
required
string
moduleConfigId
string or null
Default: null
deploymentId
required
string
version
integer
Default: 0
deviceName
required
string
isAggregated
boolean
Default: false
startDateTime
string <date-time>
endDateTime
string or null <date-time>
Default: null
correlationStartDateTime
string or null <date-time>
Default: null
object or null
Default: null
source
string or null
Default: null
required
Array of objects (QuestionnaireAnswer)
object or null
Default: null
isForManager
boolean or null
Default: null
questionnaireId
required
string
questionnaireName
required
string
Array of objects or null (QuestionnaireAnswer)
Default: null
signOffDateTime
string or null <date-time>
Default: null
status
string or null
Default: null
Enum: "SUBMITTED" "DRAFT" "SIGNED" null
revision
integer or null
Default: null

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "ids": null,
  • "moduleResultId": null,
  • "errors": null
}

Create OxfordKneeScore

post
URL: /api/extensions/v1/user/{user_id}/module-result/OxfordKneeScore
path Parameters
user_id
required
string
query Parameters
moduleConfigId
string or null
Default: null
Request Body schema: application/json
Array
type
required
string
moduleConfigId
string or null
Default: null
deploymentId
required
string
version
integer
Default: 0
deviceName
required
string
isAggregated
boolean
Default: false
startDateTime
string <date-time>
endDateTime
string or null <date-time>
Default: null
correlationStartDateTime
string or null <date-time>
Default: null
object or null
Default: null
source
string or null
Default: null
legAffected
required
any
Enum: 0 1 2
required
Array of objects (LegData)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "ids": null,
  • "moduleResultId": null,
  • "errors": null
}

Create RespiratoryRate

post
URL: /api/extensions/v1/user/{user_id}/module-result/RespiratoryRate
path Parameters
user_id
required
string
query Parameters
moduleConfigId
string or null
Default: null
Request Body schema: application/json
Array
type
required
string
moduleConfigId
string or null
Default: null
deploymentId
required
string
version
integer
Default: 0
deviceName
required
string
isAggregated
boolean
Default: false
startDateTime
string <date-time>
endDateTime
string or null <date-time>
Default: null
correlationStartDateTime
string or null <date-time>
Default: null
object or null
Default: null
source
string or null
Default: null
value
required
integer
valueUnit
string
Default: "rpm"
originalValue
number or null
Default: null

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "ids": null,
  • "moduleResultId": null,
  • "errors": null
}

Create SelfRatedHealth

post
URL: /api/extensions/v1/user/{user_id}/module-result/SelfRatedHealth
path Parameters
user_id
required
string
query Parameters
moduleConfigId
string or null
Default: null
Request Body schema: application/json
Array
type
required
string
moduleConfigId
string or null
Default: null
deploymentId
required
string
version
integer
Default: 0
deviceName
required
string
isAggregated
boolean
Default: false
startDateTime
string <date-time>
endDateTime
string or null <date-time>
Default: null
correlationStartDateTime
string or null <date-time>
Default: null
object or null
Default: null
source
string or null
Default: null
required
Array of objects (QuestionnaireAnswer)
object or null
Default: null
isForManager
boolean or null
Default: null
questionnaireId
required
string
questionnaireName
required
string
Array of objects or null (QuestionnaireAnswer)
Default: null
signOffDateTime
string or null <date-time>
Default: null
status
string or null
Default: null
Enum: "SUBMITTED" "DRAFT" "SIGNED" null
revision
integer or null
Default: null

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "ids": null,
  • "moduleResultId": null,
  • "errors": null
}

Create OxygenSaturation

post
URL: /api/extensions/v1/user/{user_id}/module-result/OxygenSaturation
path Parameters
user_id
required
string
query Parameters
moduleConfigId
string or null
Default: null
Request Body schema: application/json
Array
type
required
string
moduleConfigId
string or null
Default: null
deploymentId
required
string
version
integer
Default: 0
deviceName
required
string
isAggregated
boolean
Default: false
startDateTime
string <date-time>
endDateTime
string or null <date-time>
Default: null
correlationStartDateTime
string or null <date-time>
Default: null
object or null
Default: null
source
string or null
Default: null
value
required
number
valueUnit
string
Default: "%"
originalValue
number or null
Default: null
object or null
Default: null

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "ids": null,
  • "moduleResultId": null,
  • "errors": null
}

Create RestingHeartRate

post
URL: /api/extensions/v1/user/{user_id}/module-result/RestingHeartRate
path Parameters
user_id
required
string
query Parameters
moduleConfigId
string or null
Default: null
Request Body schema: application/json
Array
type
required
string
moduleConfigId
string or null
Default: null
deploymentId
required
string
version
integer
Default: 0
deviceName
required
string
isAggregated
boolean
Default: false
startDateTime
string <date-time>
endDateTime
string or null <date-time>
Default: null
correlationStartDateTime
string or null <date-time>
Default: null
object or null
Default: null
source
string or null
Default: null
value
required
integer
heartRateType
string or null
Default: null
Enum: "UNSPECIFIED" "RESTING" "HIGH_FREQ" null
classification
string or null
Default: null
variabilityAVNN
integer or null
Default: null
variabilitySDNN
integer or null
Default: null
variabilityRMSSD
integer or null
Default: null
variabilityPNN50
number or null
Default: null
variabilityprcLF
number or null
Default: null
confidence
integer or null
Default: null
goodIBI
integer or null
Default: null
object or null
Default: null
valueUnit
string
Default: "bpm"
object or null
Default: null

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "ids": null,
  • "moduleResultId": null,
  • "errors": null
}

Create VoiceAssessments

post
URL: /api/extensions/v1/user/{user_id}/module-result/VoiceAssessments
path Parameters
user_id
required
string
query Parameters
moduleConfigId
string or null
Default: null
Request Body schema: application/json
Any of
Array
type
required
string
moduleConfigId
string or null
Default: null
deploymentId
required
string
version
integer
Default: 0
deviceName
required
string
isAggregated
boolean
Default: false
startDateTime
string <date-time>
endDateTime
string or null <date-time>
Default: null
correlationStartDateTime
string or null <date-time>
Default: null
object or null
Default: null
source
string or null
Default: null
countingRecordingID
required
string
aaahhhInitialRecordingID
required
string
aaahhhFatiguedRecordingID
required
string

Responses

Request samples

Content type
application/json
Example
CreateDysphonia
CreateDysphonia
CreateDysarthria
[ ]

Response samples

Content type
application/json
null

Create MedicationTracker

post
URL: /api/extensions/v1/user/{user_id}/module-result/MedicationTracker
path Parameters
user_id
required
string
query Parameters
moduleConfigId
string or null
Default: null
Request Body schema: application/json
Array
type
required
string
moduleConfigId
string or null
Default: null
deploymentId
required
string
version
integer
Default: 0
deviceName
required
string
isAggregated
boolean
Default: false
startDateTime
string <date-time>
endDateTime
string or null <date-time>
Default: null
correlationStartDateTime
string or null <date-time>
Default: null
object or null
Default: null
source
string or null
Default: null
required
Array of objects (QuestionnaireAnswer)
object or null
Default: null
isForManager
boolean or null
Default: null
questionnaireId
required
string
questionnaireName
required
string
Array of objects or null (QuestionnaireAnswer)
Default: null
signOffDateTime
string or null <date-time>
Default: null
status
string or null
Default: null
Enum: "SUBMITTED" "DRAFT" "SIGNED" null
revision
integer or null
Default: null

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "ids": null,
  • "moduleResultId": null,
  • "errors": null
}

Create AsthmaControlTest

post
URL: /api/extensions/v1/user/{user_id}/module-result/AsthmaControlTest
path Parameters
user_id
required
string
query Parameters
moduleConfigId
string or null
Default: null
Request Body schema: application/json
Array
type
required
string
moduleConfigId
string or null
Default: null
deploymentId
required
string
version
integer
Default: 0
deviceName
required
string
isAggregated
boolean
Default: false
startDateTime
string <date-time>
endDateTime
string or null <date-time>
Default: null
correlationStartDateTime
string or null <date-time>
Default: null
object or null
Default: null
source
string or null
Default: null
required
Array of objects (QuestionnaireAnswer)
object or null
Default: null
isForManager
boolean or null
Default: null
questionnaireId
required
string
questionnaireName
required
string
Array of objects or null (QuestionnaireAnswer)
Default: null
signOffDateTime
string or null <date-time>
Default: null
status
string or null
Default: null
Enum: "SUBMITTED" "DRAFT" "SIGNED" null
revision
integer or null
Default: null

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "ids": null,
  • "moduleResultId": null,
  • "errors": null
}

Create OxfordShoulderScore

post
URL: /api/extensions/v1/user/{user_id}/module-result/OxfordShoulderScore
path Parameters
user_id
required
string
query Parameters
moduleConfigId
string or null
Default: null
Request Body schema: application/json
Array
type
required
string
moduleConfigId
string or null
Default: null
deploymentId
required
string
version
integer
Default: 0
deviceName
required
string
isAggregated
boolean
Default: false
startDateTime
string <date-time>
endDateTime
string or null <date-time>
Default: null
correlationStartDateTime
string or null <date-time>
Default: null
object or null
Default: null
source
string or null
Default: null
shoulderAffected
required
any
Enum: 0 1 2
required
Array of objects (ShoulderData)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "ids": null,
  • "moduleResultId": null,
  • "errors": null
}

Create PerceivedStressScale

post
URL: /api/extensions/v1/user/{user_id}/module-result/PerceivedStressScale
path Parameters
user_id
required
string
query Parameters
moduleConfigId
string or null
Default: null
Request Body schema: application/json
Array
type
required
string
moduleConfigId
string or null
Default: null
deploymentId
required
string
version
integer
Default: 0
deviceName
required
string
isAggregated
boolean
Default: false
startDateTime
string <date-time>
endDateTime
string or null <date-time>
Default: null
correlationStartDateTime
string or null <date-time>
Default: null
object or null
Default: null
source
string or null
Default: null
required
Array of objects (QuestionnaireAnswer)
object or null
Default: null
isForManager
boolean or null
Default: null
questionnaireId
required
string
questionnaireName
required
string
Array of objects or null (QuestionnaireAnswer)
Default: null
signOffDateTime
string or null <date-time>
Default: null
status
string or null
Default: null
Enum: "SUBMITTED" "DRAFT" "SIGNED" null
revision
integer or null
Default: null

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "ids": null,
  • "moduleResultId": null,
  • "errors": null
}

Create DiabetesDistressScore

post
URL: /api/extensions/v1/user/{user_id}/module-result/DiabetesDistressScore
path Parameters
user_id
required
string
query Parameters
moduleConfigId
string or null
Default: null
Request Body schema: application/json
Array
type
required
string
moduleConfigId
string or null
Default: null
deploymentId
required
string
version
integer
Default: 0
deviceName
required
string
isAggregated
boolean
Default: false
startDateTime
string <date-time>
endDateTime
string or null <date-time>
Default: null
correlationStartDateTime
string or null <date-time>
Default: null
object or null
Default: null
source
string or null
Default: null
required
Array of objects (QuestionnaireAnswer)
object or null
Default: null
isForManager
boolean or null
Default: null
questionnaireId
required
string
questionnaireName
required
string
Array of objects or null (QuestionnaireAnswer)
Default: null
signOffDateTime
string or null <date-time>
Default: null
status
string or null
Default: null
Enum: "SUBMITTED" "DRAFT" "SIGNED" null
revision
integer or null
Default: null

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "ids": null,
  • "moduleResultId": null,
  • "errors": null
}

Create GeneralAnxietyDisorder

post
URL: /api/extensions/v1/user/{user_id}/module-result/GeneralAnxietyDisorder
path Parameters
user_id
required
string
query Parameters
moduleConfigId
string or null
Default: null
Request Body schema: application/json
Array
type
required
string
moduleConfigId
string or null
Default: null
deploymentId
required
string
version
integer
Default: 0
deviceName
required
string
isAggregated
boolean
Default: false
startDateTime
string <date-time>
endDateTime
string or null <date-time>
Default: null
correlationStartDateTime
string or null <date-time>
Default: null
object or null
Default: null
source
string or null
Default: null
required
Array of objects (QuestionnaireAnswer)
object or null
Default: null
isForManager
boolean or null
Default: null
questionnaireId
required
string
questionnaireName
required
string
Array of objects or null (QuestionnaireAnswer)
Default: null
signOffDateTime
string or null <date-time>
Default: null
status
string or null
Default: null
Enum: "SUBMITTED" "DRAFT" "SIGNED" null
revision
integer or null
Default: null

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "ids": null,
  • "moduleResultId": null,
  • "errors": null
}

Create HighFrequencyHeartRate

post
URL: /api/extensions/v1/user/{user_id}/module-result/HighFrequencyHeartRate
path Parameters
user_id
required
string
query Parameters
moduleConfigId
string or null
Default: null
Request Body schema: application/json
Array
type
required
string
moduleConfigId
string or null
Default: null
deploymentId
required
string
version
integer
Default: 0
deviceName
required
string
isAggregated
boolean
Default: false
startDateTime
string <date-time>
endDateTime
string or null <date-time>
Default: null
correlationStartDateTime
string or null <date-time>
Default: null
object or null
Default: null
source
string or null
Default: null
value
required
integer
heartRateType
string or null
Default: null
Enum: "UNSPECIFIED" "RESTING" "HIGH_FREQ" null
classification
string or null
Default: null
variabilityAVNN
integer or null
Default: null
variabilitySDNN
integer or null
Default: null
variabilityRMSSD
integer or null
Default: null
variabilityPNN50
number or null
Default: null
variabilityprcLF
number or null
Default: null
confidence
integer or null
Default: null
goodIBI
integer or null
Default: null
object or null
Default: null
valueUnit
string
Default: "bpm"
object or null
Default: null
Array of objects or null (MultipleValuesData)
Default: null
dataType
string or null
Default: null
Enum: "MULTIPLE_VALUE" "PPG_VALUE" "SINGLE_VALUE" null

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "ids": null,
  • "moduleResultId": null,
  • "errors": null
}

Retrieve_Module_By_Event_Log

Retrieve ODI by event log

get
URL: /api/extensions/v1/user/{user_id}/primitive/ODI/event-log/{event_log_id}
path Parameters
user_id
required
string
event_log_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "value": 0
}

Retrieve NDI by event log

get
URL: /api/extensions/v1/user/{user_id}/primitive/NDI/event-log/{event_log_id}
path Parameters
user_id
required
string
event_log_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "value": 0
}

Retrieve WHQ by event log

get
URL: /api/extensions/v1/user/{user_id}/primitive/WHQ/event-log/{event_log_id}
path Parameters
user_id
required
string
event_log_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "value": 0
}

Retrieve BMI by event log

get
URL: /api/extensions/v1/user/{user_id}/primitive/BMI/event-log/{event_log_id}
path Parameters
user_id
required
string
event_log_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "value": 0,
  • "valueUnit": "kg/m2",
  • "originalValue": null,
  • "originalUnit": null
}

Retrieve CAT by event log

get
URL: /api/extensions/v1/user/{user_id}/primitive/CAT/event-log/{event_log_id}
path Parameters
user_id
required
string
event_log_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "value": 0
}

Retrieve AHQ by event log

get
URL: /api/extensions/v1/user/{user_id}/primitive/AHQ/event-log/{event_log_id}
path Parameters
user_id
required
string
event_log_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "value": 0
}

Retrieve SRS by event log

get
URL: /api/extensions/v1/user/{user_id}/primitive/SRS/event-log/{event_log_id}
path Parameters
user_id
required
string
event_log_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "function": 0,
  • "pain": 0,
  • "selfImage": 0,
  • "mentalHealth": 0,
  • "satisfactionWithManagement": 0,
  • "subTotal": 0,
  • "total": 0,
  • "value": 0
}

Retrieve ECG by event log

get
URL: /api/extensions/v1/user/{user_id}/primitive/ECG/event-log/{event_log_id}
path Parameters
user_id
required
string
event_log_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "averageHeartRate": 0,
  • "classification": 1,
  • "leadType": 1,
  • "pdf": null,
  • "dataPoints": null
}

Retrieve SF36 by event log

get
URL: /api/extensions/v1/user/{user_id}/primitive/SF36/event-log/{event_log_id}
path Parameters
user_id
required
string
event_log_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "physicalFunctioningScore": null,
  • "limitationsPhysicalHealthScore": null,
  • "limitationsEmotionalProblemsScore": null,
  • "energyFatigueScore": null,
  • "emotionalWellBeingScore": null,
  • "socialFunctioningScore": null,
  • "painScore": null,
  • "generalHealthScore": null
}

Retrieve KCCQ by event log

get
URL: /api/extensions/v1/user/{user_id}/primitive/KCCQ/event-log/{event_log_id}
path Parameters
user_id
required
string
event_log_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "physicalLimitation": 0,
  • "symptomStability": 0,
  • "symptomFrequency": 0,
  • "symptomBurden": 0,
  • "totalSymptomScore": 0,
  • "selfEfficacy": 0,
  • "qualityOfLife": 0,
  • "socialLimitation": 0,
  • "overallSummaryScore": 0,
  • "clinicalSummaryScore": 0
}

Retrieve KOOS by event log

get
URL: /api/extensions/v1/user/{user_id}/primitive/KOOS/event-log/{event_log_id}
path Parameters
user_id
required
string
event_log_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "adlScore": 0,
  • "qualityOfLifeScore": 0,
  • "painScore": 0,
  • "symptomsScore": 0,
  • "sportRecreationScore": 0
}

Retrieve IKDC by event log

get
URL: /api/extensions/v1/user/{user_id}/primitive/IKDC/event-log/{event_log_id}
path Parameters
user_id
required
string
event_log_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "symptoms": null,
  • "sportsActivity": null,
  • "kneeFunction": null,
  • "value": null
}

Retrieve OARS by event log

get
URL: /api/extensions/v1/user/{user_id}/primitive/OARS/event-log/{event_log_id}
path Parameters
user_id
required
string
event_log_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "painScore": 0,
  • "sleepScore": 0,
  • "nauseaScore": 0,
  • "mobilityScore": 0,
  • "oarsScore": 0
}

Retrieve Step by event log

get
URL: /api/extensions/v1/user/{user_id}/primitive/Step/event-log/{event_log_id}
path Parameters
user_id
required
string
event_log_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "value": 0,
  • "weeklyTotal": null,
  • "multipleValues": null,
  • "rawDataObject": null,
  • "dataType": "MULTIPLE_VALUE"
}

Retrieve OACS by event log

get
URL: /api/extensions/v1/user/{user_id}/primitive/OACS/event-log/{event_log_id}
path Parameters
user_id
required
string
event_log_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "oacsScore": 0
}

Retrieve Sleep by event log

get
URL: /api/extensions/v1/user/{user_id}/primitive/Sleep/event-log/{event_log_id}
path Parameters
user_id
required
string
event_log_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "awake": null,
  • "awakeCount": null,
  • "sleep": null,
  • "outOfBed": null,
  • "lightSleep": null,
  • "deepSleep": null,
  • "remSleep": null,
  • "duration": 0,
  • "summary": [
    ],
  • "dateOfSleep": "string",
  • "uwake": 0
}

Retrieve WOMAC by event log

get
URL: /api/extensions/v1/user/{user_id}/primitive/WOMAC/event-log/{event_log_id}
path Parameters
user_id
required
string
event_log_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "painScore": 0,
  • "symptomsScore": 0,
  • "adlScore": 0,
  • "totalScore": 0
}

Retrieve VR_12 by event log

get
URL: /api/extensions/v1/user/{user_id}/primitive/VR_12/event-log/{event_log_id}
path Parameters
user_id
required
string
event_log_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "physicalScore": 0,
  • "mentalScore": 0
}

Retrieve Photo by event log

get
URL: /api/extensions/v1/user/{user_id}/primitive/Photo/event-log/{event_log_id}
path Parameters
user_id
required
string
event_log_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "s3Object": {
    },
  • "s3Thumbnail": null,
  • "note": null
}

Retrieve Tegner by event log

get
URL: /api/extensions/v1/user/{user_id}/primitive/Tegner/event-log/{event_log_id}
path Parameters
user_id
required
string
event_log_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "activityLevelBefore": 0,
  • "activityLevelCurrent": 0
}

Retrieve MG_ADL by event log

get
URL: /api/extensions/v1/user/{user_id}/primitive/MG_ADL/event-log/{event_log_id}
path Parameters
user_id
required
string
event_log_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "value": 0,
  • "ocularDysfunction": 0,
  • "respiratoryDysfunction": 0,
  • "extremityDysfunction": 0,
  • "oropharyngealDysfunction": 0
}

Retrieve EQ5D5L by event log

get
URL: /api/extensions/v1/user/{user_id}/primitive/EQ5D5L/event-log/{event_log_id}
path Parameters
user_id
required
string
event_log_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "indexValue": null,
  • "healthState": null,
  • "mobility": null,
  • "selfCare": null,
  • "usualActivities": null,
  • "pain": null,
  • "anxiety": null,
  • "eqVas": null
}

Retrieve Weight by event log

get
URL: /api/extensions/v1/user/{user_id}/primitive/Weight/event-log/{event_log_id}
path Parameters
user_id
required
string
event_log_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "value": 0,
  • "valueUnit": "kg",
  • "originalValue": null,
  • "originalUnit": null
}

Retrieve HScore by event log

get
URL: /api/extensions/v1/user/{user_id}/primitive/HScore/event-log/{event_log_id}
path Parameters
user_id
required
string
event_log_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "value": 0,
  • "topValue": 0,
  • "bottomValue": 0,
  • "status": "HIGH",
  • "keyAreasItems": null
}

Retrieve Ptosis by event log

get
URL: /api/extensions/v1/user/{user_id}/primitive/Ptosis/event-log/{event_log_id}
path Parameters
user_id
required
string
event_log_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "recording": {
    },
  • "severityLeft": null,
  • "severityRight": null,
  • "timeLeft": null,
  • "timeRight": null,
  • "isPrompted": false
}

Retrieve Height by event log

get
URL: /api/extensions/v1/user/{user_id}/primitive/Height/event-log/{event_log_id}
path Parameters
user_id
required
string
event_log_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "value": 0,
  • "valueUnit": "cm"
}

Retrieve NORFOLK by event log

get
URL: /api/extensions/v1/user/{user_id}/primitive/NORFOLK/event-log/{event_log_id}
path Parameters
user_id
required
string
event_log_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "totalQolScore": 0,
  • "physicalFunctionLargeFiber": 0,
  • "activitiesOfDailyLiving": 0,
  • "symptoms": 0,
  • "smallFiber": 0,
  • "automic": 0
}

Retrieve Symptom by event log

get
URL: /api/extensions/v1/user/{user_id}/primitive/Symptom/event-log/{event_log_id}
path Parameters
user_id
required
string
event_log_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "value": null,
  • "complexValues": null,
  • "followUpQuestionIds": null
}

Retrieve Lysholm by event log

get
URL: /api/extensions/v1/user/{user_id}/primitive/Lysholm/event-log/{event_log_id}
path Parameters
user_id
required
string
event_log_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "limp": 0,
  • "caneOrCrutches": 0,
  • "lockingSensation": 0,
  • "givingWaySensation": 0,
  • "pain": 0,
  • "swelling": 0,
  • "climbingStairs": 0,
  • "squatting": 0,
  • "lysholm": 0
}

Retrieve Journal by event log

get
URL: /api/extensions/v1/user/{user_id}/primitive/Journal/event-log/{event_log_id}
path Parameters
user_id
required
string
event_log_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "value": "string"
}

Retrieve PeakFlow by event log

get
URL: /api/extensions/v1/user/{user_id}/primitive/PeakFlow/event-log/{event_log_id}
path Parameters
user_id
required
string
event_log_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "value": 0,
  • "valuePercent": null,
  • "valueUnit": "L/min"
}

Retrieve FitbitHRV by event log

get
URL: /api/extensions/v1/user/{user_id}/primitive/FitbitHRV/event-log/{event_log_id}
path Parameters
user_id
required
string
event_log_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "rmssd": null,
  • "coverage": null,
  • "hf": null,
  • "lf": null
}

Retrieve Dysphonia by event log

get
URL: /api/extensions/v1/user/{user_id}/primitive/Dysphonia/event-log/{event_log_id}
path Parameters
user_id
required
string
event_log_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "countingRecordingID": "string",
  • "initialProbability": null,
  • "fatiguedProbability": null,
  • "probability": null,
  • "confidence": null,
  • "aaahhhInitialRecordingID": "string",
  • "aaahhhFatiguedRecordingID": "string"
}

Retrieve DashScore by event log

get
URL: /api/extensions/v1/user/{user_id}/primitive/DashScore/event-log/{event_log_id}
path Parameters
user_id
required
string
event_log_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "quickDashQuestions": {
    },
  • "workQuestions": null,
  • "sportArtQuestions": null,
  • "doWork": null,
  • "doSportArt": null,
  • "workName": null,
  • "sportArtName": null,
  • "quickDashScore": null,
  • "workScore": null,
  • "sportArtScore": null
}

Retrieve HeartRate by event log

get
URL: /api/extensions/v1/user/{user_id}/primitive/HeartRate/event-log/{event_log_id}
path Parameters
user_id
required
string
event_log_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "value": 0,
  • "heartRateType": "UNSPECIFIED",
  • "classification": null,
  • "variabilityAVNN": null,
  • "variabilitySDNN": null,
  • "variabilityRMSSD": null,
  • "variabilityPNN50": null,
  • "variabilityprcLF": null,
  • "confidence": null,
  • "goodIBI": null,
  • "rawDataObject": null,
  • "valueUnit": "bpm",
  • "metadata": null
}

Retrieve Dysarthria by event log

get
URL: /api/extensions/v1/user/{user_id}/primitive/Dysarthria/event-log/{event_log_id}
path Parameters
user_id
required
string
event_log_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "countingRecordingID": "string",
  • "initialProbability": null,
  • "fatiguedProbability": null,
  • "probability": null,
  • "confidence": null,
  • "buttercupInitialRecordingID": "string",
  • "buttercupFatiguedRecordingID": "string"
}

Retrieve RevereTest by event log

get
URL: /api/extensions/v1/user/{user_id}/primitive/RevereTest/event-log/{event_log_id}
path Parameters
user_id
required
string
event_log_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": null,
  • "startDateTime": null,
  • "endDateTime": null,
  • "results": null,
  • "status": "STARTED",
  • "moduleId": "string",
  • "deploymentId": "string"
}

Retrieve ArmFatigue by event log

get
URL: /api/extensions/v1/user/{user_id}/primitive/ArmFatigue/event-log/{event_log_id}
path Parameters
user_id
required
string
event_log_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "arm": "LEFT",
  • "angle": null,
  • "classification": null,
  • "output": null,
  • "recording": {
    },
  • "time": null
}

Retrieve ECGAliveCor by event log

get
URL: /api/extensions/v1/user/{user_id}/primitive/ECGAliveCor/event-log/{event_log_id}
path Parameters
user_id
required
string
event_log_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "s3Object": {
    },
  • "kardiaEcgRecordId": "string"
}

Retrieve Temperature by event log

get
URL: /api/extensions/v1/user/{user_id}/primitive/Temperature/event-log/{event_log_id}
path Parameters
user_id
required
string
event_log_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "value": 0,
  • "valueUnit": "oC",
  • "originalValue": null,
  • "originalUnit": null
}

Retrieve HealthStatus by event log

get
URL: /api/extensions/v1/user/{user_id}/primitive/HealthStatus/event-log/{event_log_id}
path Parameters
user_id
required
string
event_log_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "skipped": null,
  • "newOrWorseSymptoms": 0,
  • "healthProblemsOrDisabilityList": null,
  • "metadata": {
    }
}

Retrieve ECGHealthKit by event log

get
URL: /api/extensions/v1/user/{user_id}/primitive/ECGHealthKit/event-log/{event_log_id}
path Parameters
user_id
required
string
event_log_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "value": 1,
  • "ecgReading": {
    },
  • "generatedPDF": null
}

Retrieve BloodGlucose by event log

get
URL: /api/extensions/v1/user/{user_id}/primitive/BloodGlucose/event-log/{event_log_id}
path Parameters
user_id
required
string
event_log_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "value": 0,
  • "valueUnit": "mmol/L",
  • "originalValue": null,
  • "originalUnit": null
}

Retrieve ReactionTime by event log

get
URL: /api/extensions/v1/user/{user_id}/primitive/ReactionTime/event-log/{event_log_id}
path Parameters
user_id
required
string
event_log_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "value": 0
}

Retrieve CVDRiskScore by event log

get
URL: /api/extensions/v1/user/{user_id}/primitive/CVDRiskScore/event-log/{event_log_id}
path Parameters
user_id
required
string
event_log_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "age": 0,
  • "sex": "FEMALE",
  • "alcoholIntake": "DAILY",
  • "sleepDuration": 0,
  • "smokingStatus": true,
  • "walkingPace": "SLOW_PACE",
  • "overallHealth": "EXCELLENT",
  • "existingConditions": [
    ],
  • "existingSymptoms": [
    ],
  • "currentMedications": [
    ],
  • "familyHeartDisease": [
    ],
  • "heartRate": 0,
  • "waistCircumference": 0,
  • "hipCircumference": 0,
  • "waistToHipRatio": null,
  • "riskFactors": null,
  • "riskTrajectory": null,
  • "originalValue": null,
  • "roundedValue": null
}

Retrieve OtherVaccine by event log

get
URL: /api/extensions/v1/user/{user_id}/primitive/OtherVaccine/event-log/{event_log_id}
path Parameters
user_id
required
string
event_log_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "skipped": null,
  • "hasFluVaccine": true,
  • "fluVaccineDate": null,
  • "hasOtherVaccine": true,
  • "vaccineCategory": null,
  • "vaccineList": null,
  • "metadata": {
    }
}

Retrieve NumericMemory by event log

get
URL: /api/extensions/v1/user/{user_id}/primitive/NumericMemory/event-log/{event_log_id}
path Parameters
user_id
required
string
event_log_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "value": 0
}

Retrieve SensorCapture by event log

get
URL: /api/extensions/v1/user/{user_id}/primitive/SensorCapture/event-log/{event_log_id}
path Parameters
user_id
required
string
event_log_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "s3Object": {
    },
  • "sanityCheck": null,
  • "sanityCheckMessage": null,
  • "measurementLocation": "LEFT_FRONT_TROUSERS_POCKET",
  • "sensorDataTypes": null,
  • "value": null
}

Retrieve AdditionalQoL by event log

get
URL: /api/extensions/v1/user/{user_id}/primitive/AdditionalQoL/event-log/{event_log_id}
path Parameters
user_id
required
string
event_log_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "skipped": null,
  • "viewFamily": 0,
  • "contactProfessionals": 0,
  • "contributeActivities": 0,
  • "metadata": {
    }
}

Retrieve PulseOximetry by event log

get
URL: /api/extensions/v1/user/{user_id}/primitive/PulseOximetry/event-log/{event_log_id}
path Parameters
user_id
required
string
event_log_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "value": 0
}

Retrieve BloodPressure by event log

get
URL: /api/extensions/v1/user/{user_id}/primitive/BloodPressure/event-log/{event_log_id}
path Parameters
user_id
required
string
event_log_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "diastolicValue": 0,
  • "systolicValue": 0,
  • "diastolicValueUnit": "mmHg",
  • "systolicValueUnit": "mmHg"
}

Retrieve Questionnaire by event log

get
URL: /api/extensions/v1/user/{user_id}/primitive/Questionnaire/event-log/{event_log_id}
path Parameters
user_id
required
string
event_log_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "answers": [
    ],
  • "appResult": null,
  • "isForManager": null,
  • "questionnaireId": "string",
  • "questionnaireName": "string",
  • "value": null,
  • "skipped": null,
  • "updateDateTime": null,
  • "signOffDateTime": null,
  • "status": "SUBMITTED",
  • "revision": null
}

Retrieve WaistToHeight by event log

get
URL: /api/extensions/v1/user/{user_id}/primitive/WaistToHeight/event-log/{event_log_id}
path Parameters
user_id
required
string
event_log_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "height": 0,
  • "waist": null,
  • "value": null
}

Retrieve MedicalHistory by event log

get
URL: /api/extensions/v1/user/{user_id}/primitive/MedicalHistory/event-log/{event_log_id}
path Parameters
user_id
required
string
event_log_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "skipped": null,
  • "cancerType": null,
  • "medicalDiagnosis": [
    ],
  • "medicalConditions": null,
  • "takingImmunoSuppressants": 0,
  • "immunoSuppressantMedicationList": null,
  • "isCovidInfectedInPast": true,
  • "covidInfectedDate": null,
  • "isCovidToldByDoctor": true,
  • "covidToldByDoctorDate": null,
  • "takenCovidTest": 0,
  • "covidTestResult": "NONE_POSITIVE",
  • "covidTestDate": null,
  • "covidTestMethod": "NOSE_THROAT_SWAB",
  • "covidTestOther": null,
  • "covidSymptoms": null,
  • "otherCovidSymptoms": null,
  • "covidSymptomAction": null,
  • "metadata": {
    },
  • "hadCovidSymptoms": null,
  • "hadOtherCovidSymptoms": null,
  • "isDiagnosedWithCancer": true
}

Retrieve InfantFollowUp by event log

get
URL: /api/extensions/v1/user/{user_id}/primitive/InfantFollowUp/event-log/{event_log_id}
path Parameters
user_id
required
string
event_log_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "skipped": null,
  • "isCovPregLiveBirth": true,
  • "isMoreThan1ChildCovVac": null,
  • "countCovPreg": null,
  • "children": null,
  • "metadata": {
    }
}

Retrieve SleepQuestions by event log

get
URL: /api/extensions/v1/user/{user_id}/primitive/SleepQuestions/event-log/{event_log_id}
path Parameters
user_id
required
string
event_log_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "sleepQualityScore": 1,
  • "tiredScore": "LESS_THAN_NORMAL",
  • "hoursSleep": 0,
  • "minutesSleep": 0
}

Retrieve OxfordHipScore by event log

get
URL: /api/extensions/v1/user/{user_id}/primitive/OxfordHipScore/event-log/{event_log_id}
path Parameters
user_id
required
string
event_log_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "hipAffected": 0,
  • "hipsData": [
    ],
  • "rightHipScore": null,
  • "leftHipScore": null
}

Retrieve SmokeQuestions by event log

get
URL: /api/extensions/v1/user/{user_id}/primitive/SmokeQuestions/event-log/{event_log_id}
path Parameters
user_id
required
string
event_log_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "smokeStatus": "YES_AND_I_STILL_DO",
  • "smokerType": "REGULAR_SMOKER",
  • "smokingPeriod": "LESS_THAN_A_YEAR",
  • "numberOfCigarettesPerDay": null,
  • "numberOfCigarettesPerMonth": null,
  • "vapeStatus": "YES_AND_I_STILL_DO",
  • "vapePeriodic": "RARELY"
}

Retrieve SpatialSpaniOS by event log

get
URL: /api/extensions/v1/user/{user_id}/primitive/SpatialSpaniOS/event-log/{event_log_id}
path Parameters
user_id
required
string
event_log_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "value": 0
}

Retrieve SelfHealthRate by event log

get
URL: /api/extensions/v1/user/{user_id}/primitive/SelfHealthRate/event-log/{event_log_id}
path Parameters
user_id
required
string
event_log_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "value": 1
}

Retrieve OxfordKneeScore by event log

get
URL: /api/extensions/v1/user/{user_id}/primitive/OxfordKneeScore/event-log/{event_log_id}
path Parameters
user_id
required
string
event_log_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "legAffected": 0,
  • "legsData": [
    ],
  • "rightKneeScore": null,
  • "leftKneeScore": null
}

Retrieve PregnancyStatus by event log

get
URL: /api/extensions/v1/user/{user_id}/primitive/PregnancyStatus/event-log/{event_log_id}
path Parameters
user_id
required
string
event_log_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "skipped": null,
  • "menstrualPeriod": true,
  • "lastMenstrualPeriodDate": null,
  • "pregnancyStatus": "YES",
  • "isExpectedDueDateAvailable": null,
  • "expectedDueDate": null,
  • "pregnancyMoreThan1": "YES",
  • "babyCount": null,
  • "hasMedicalFertilityProcedure": null,
  • "medicalFertilityProcedureAnswer": null,
  • "hasOtherMedicalFertilityProcedure": null,
  • "otherMedicalFertilityProcedureAnswer": null,
  • "pregnantBefore": "YES",
  • "pregnancyTimes": null,
  • "pastPregnancyLiveBirth": null,
  • "pastPregnancyStillBorn": null,
  • "pastPregnancyMiscarriage": null,
  • "pastPregnancyEctopic": null,
  • "pastPregnancyElectiveTermination": null,
  • "hasMedicalProfessionalVisit": null,
  • "highRiskCondition": "YES",
  • "highRiskConditionAnswers": null,
  • "familyHistoryDefects": "YES",
  • "familyHistoryDefectsAnswers": null,
  • "hasPrenatalScreening": null,
  • "prenatalScreeningAnswer": null,
  • "hasOtherPrenatalScreening": null,
  • "otherPrenatalScreening": null,
  • "hasOtherScreeningProblem": null,
  • "otherScreeningProblem": null,
  • "metadata": {
    }
}

Retrieve BodyComposition by event log

get
URL: /api/extensions/v1/user/{user_id}/primitive/BodyComposition/event-log/{event_log_id}
path Parameters
user_id
required
string
event_log_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "bmiDevice": null,
  • "restingMetabolism": null,
  • "visceralFatLevel": null,
  • "visceralFatLevelClassification": null,
  • "bodyFatLevel": null,
  • "bodyFatPercentage": null,
  • "skeletalMuscleLevel": null,
  • "skeletalMuscleLevelPercentage": null
}

Retrieve RespiratoryRate by event log

get
URL: /api/extensions/v1/user/{user_id}/primitive/RespiratoryRate/event-log/{event_log_id}
path Parameters
user_id
required
string
event_log_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "value": 0,
  • "valueUnit": "rpm",
  • "originalValue": null
}

Retrieve PregnancyUpdate by event log

get
URL: /api/extensions/v1/user/{user_id}/primitive/PregnancyUpdate/event-log/{event_log_id}
path Parameters
user_id
required
string
event_log_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "skipped": null,
  • "hasMenstrualPeriod": true,
  • "lastMenstrualPeriodDateDay1": null,
  • "becamePregnant": null,
  • "isPregnancyCurrent": null,
  • "isExpectedDueDateAvailable": null,
  • "expectedDueDate": null,
  • "pregnancyMoreThan1": "YES",
  • "babyCount": null,
  • "pastPregnancyMoreThan1": "YES",
  • "pastBabyCount": null,
  • "pregnancyResult": null,
  • "hasOtherPregnancyOutcome": null,
  • "otherPregnancyResult": null,
  • "pastPregnancyWeeks": null,
  • "hasPastPregnancy": "YES",
  • "pregnancyTimes": null,
  • "pastPregnancyLifeBirth": null,
  • "pastPregnancyStillBorn": null,
  • "pastPregnancyEctopic": null,
  • "pastPregnancyMiscarriage": null,
  • "pastPregnancyElectiveTermination": null,
  • "hasVisitMedicalProfessional": null,
  • "highRiskCondition": "YES",
  • "highRiskConditionAnswers": null,
  • "familyHistoryDefects": "YES",
  • "familyHistoryDefectsAnswers": null,
  • "hasPrenatalScreening": null,
  • "prenatalScreeningAnswers": null,
  • "hasOtherPrenatalScreening": null,
  • "otherPrenatalScreening": null,
  • "hasScreeningProblem": null,
  • "screeningProblemText": null,
  • "metadata": {
    }
}

Retrieve AirQualityIndex by event log

get
URL: /api/extensions/v1/user/{user_id}/primitive/AirQualityIndex/event-log/{event_log_id}
path Parameters
user_id
required
string
event_log_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "value": 0,
  • "latitude": 0,
  • "longitude": 0
}

Retrieve PostVaccination by event log

get
URL: /api/extensions/v1/user/{user_id}/primitive/PostVaccination/event-log/{event_log_id}
path Parameters
user_id
required
string
event_log_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "skipped": null,
  • "secondCOVIDVaccinationDose": "2019-08-24",
  • "isSecondDoseAZ": true,
  • "secondDoseBrand": "MODERNA",
  • "batchNumberVaccine": null,
  • "isBatchNumberValid": null,
  • "isSamePlaceVaccine2As1": true,
  • "vaccinationPlace": "PRIMARY_HEALTH_PROVIDER",
  • "vaccinationPlaceOther": null,
  • "vaccinationPlaceLocation": null,
  • "metadata": {
    }
}

Retrieve BodyMeasurement by event log

get
URL: /api/extensions/v1/user/{user_id}/primitive/BodyMeasurement/event-log/{event_log_id}
path Parameters
user_id
required
string
event_log_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "visceralFat": null,
  • "totalBodyFat": null,
  • "waistCircumference": null,
  • "waistCircumferenceUnit": "cm",
  • "hipCircumference": null,
  • "hipCircumferenceUnit": "cm",
  • "waistToHipRatio": null
}

Retrieve Covid19RiskScore by event log

get
URL: /api/extensions/v1/user/{user_id}/primitive/Covid19RiskScore/event-log/{event_log_id}
path Parameters
user_id
required
string
event_log_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "value": null,
  • "status": "LOW"
}

Retrieve OxygenSaturation by event log

get
URL: /api/extensions/v1/user/{user_id}/primitive/OxygenSaturation/event-log/{event_log_id}
path Parameters
user_id
required
string
event_log_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "value": 0,
  • "valueUnit": "%",
  • "originalValue": null,
  • "oxygenSupplement": null
}

Retrieve FeverAndPainDrugs by event log

get
URL: /api/extensions/v1/user/{user_id}/primitive/FeverAndPainDrugs/event-log/{event_log_id}
path Parameters
user_id
required
string
event_log_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "skipped": null,
  • "hasAntiFeverPainDrugs": true,
  • "medStartedBeforeAfter": "BEFORE",
  • "daysBeforeVacMedication": null,
  • "daysAfterVacMedication": null,
  • "isUnderMedication": null,
  • "daysCountMedication": null,
  • "metadata": {
    }
}

Retrieve AsthmaControlTest by event log

get
URL: /api/extensions/v1/user/{user_id}/primitive/AsthmaControlTest/event-log/{event_log_id}
path Parameters
user_id
required
string
event_log_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "value": 0
}

Retrieve AwarenessTraining by event log

get
URL: /api/extensions/v1/user/{user_id}/primitive/AwarenessTraining/event-log/{event_log_id}
path Parameters
user_id
required
string
event_log_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "certificateNumber": null,
  • "totalHealthScore": null,
  • "status": null
}

Retrieve PregnancyFollowUp by event log

get
URL: /api/extensions/v1/user/{user_id}/primitive/PregnancyFollowUp/event-log/{event_log_id}
path Parameters
user_id
required
string
event_log_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "skipped": null,
  • "pregnantMedications": true,
  • "prescriptionMedications": null,
  • "overCounterPregnantMedications": true,
  • "overCounterMedications": null,
  • "babyCount": 0,
  • "currentBabyCount": null,
  • "babyInfo": [
    ],
  • "metadata": {
    }
}

Retrieve HighFrequencyStep by event log

get
URL: /api/extensions/v1/user/{user_id}/primitive/HighFrequencyStep/event-log/{event_log_id}
path Parameters
user_id
required
string
event_log_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "stepsObject": {
    }
}

Retrieve PROMISGlobalHealth by event log

get
URL: /api/extensions/v1/user/{user_id}/primitive/PROMISGlobalHealth/event-log/{event_log_id}
path Parameters
user_id
required
string
event_log_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "skipped": null,
  • "global01": 1,
  • "global02": 1,
  • "global03": 1,
  • "global04": 1,
  • "global05": 1,
  • "global06": 1,
  • "global07rc": 0,
  • "global08r": 1,
  • "global09r": 1,
  • "global10r": 1,
  • "mentalHealthValue": null,
  • "mentalHealthResult": null,
  • "physicalHealthValue": null,
  • "physicalHealthResult": null,
  • "metadata": {
    }
}

Retrieve VaccinationDetails by event log

get
URL: /api/extensions/v1/user/{user_id}/primitive/VaccinationDetails/event-log/{event_log_id}
path Parameters
user_id
required
string
event_log_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "skipped": null,
  • "vaccinatedPlace": 0,
  • "vaccinationLocation": null,
  • "vaccinationCity": "string",
  • "batchNumber": "string",
  • "isBatchNumberValid": null,
  • "isSecondDoseVacc": 0,
  • "secondVacScheduleDate": null,
  • "isSeasonFluVac": true,
  • "seasonFluVacDate": null,
  • "isOtherSpecifiedVacc": true,
  • "otherSpecifiedVacc": null,
  • "otherVaccCategory": null,
  • "isAllergicReactionVacc": 0,
  • "allergicReactionVacc": null,
  • "allergicReaction": null,
  • "metadata": null
}

Retrieve AlcoholConsumption by event log

get
URL: /api/extensions/v1/user/{user_id}/primitive/AlcoholConsumption/event-log/{event_log_id}
path Parameters
user_id
required
string
event_log_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "drinkAlcohol": true,
  • "sections": [
    ]
}

Retrieve OxfordShoulderScore by event log

get
URL: /api/extensions/v1/user/{user_id}/primitive/OxfordShoulderScore/event-log/{event_log_id}
path Parameters
user_id
required
string
event_log_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "shoulderAffected": 0,
  • "shouldersData": [
    ],
  • "rightShoulderScore": null,
  • "leftShoulderScore": null
}

Retrieve Covid19DailyCheckIn by event log

get
URL: /api/extensions/v1/user/{user_id}/primitive/Covid19DailyCheckIn/event-log/{event_log_id}
path Parameters
user_id
required
string
event_log_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "contactType": "I_LIVE_WITH_SUCH_PERSON"
}

Retrieve BreastFeedingStatus by event log

get
URL: /api/extensions/v1/user/{user_id}/primitive/BreastFeedingStatus/event-log/{event_log_id}
path Parameters
user_id
required
string
event_log_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "skipped": null,
  • "isBreastFeedingCurrently": true,
  • "numberOfWeeksAtChildBirth": null,
  • "hadComplicationsAtBirth": null,
  • "complicationList": null,
  • "hasHighRiskConditions": null,
  • "highRiskConditions": null,
  • "familyHistoryOfDefects": "YES",
  • "familyHistoryOfDefectsList": null,
  • "numBreastFeedingBabies": 0,
  • "breastFeedingBabyDetails": null,
  • "metadata": {
    }
}

Retrieve BreastFeedingUpdate by event log

get
URL: /api/extensions/v1/user/{user_id}/primitive/BreastFeedingUpdate/event-log/{event_log_id}
path Parameters
user_id
required
string
event_log_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "skipped": null,
  • "isBreastFeedingNow": true,
  • "stopDate": null,
  • "newOrWorseSymptoms": [
    ],
  • "numBreastFeedingBabies": 0,
  • "breastFeedingBabyDetails": null,
  • "metadata": {
    }
}

Retrieve RestingBreathingRate by event log

get
URL: /api/extensions/v1/user/{user_id}/primitive/RestingBreathingRate/event-log/{event_log_id}
path Parameters
user_id
required
string
event_log_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "value": 0
}

Retrieve PerceivedStressScale by event log

get
URL: /api/extensions/v1/user/{user_id}/primitive/PerceivedStressScale/event-log/{event_log_id}
path Parameters
user_id
required
string
event_log_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "value": 0
}

Retrieve DiabetesDistressScore by event log

get
URL: /api/extensions/v1/user/{user_id}/primitive/DiabetesDistressScore/event-log/{event_log_id}
path Parameters
user_id
required
string
event_log_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "totalDDS": 0,
  • "emotionalBurden": null,
  • "physicianDistress": null,
  • "regimenDistress": null,
  • "interpersonalDistress": null
}

Retrieve BackgroundInformation by event log

get
URL: /api/extensions/v1/user/{user_id}/primitive/BackgroundInformation/event-log/{event_log_id}
path Parameters
user_id
required
string
event_log_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "skipped": null,
  • "age": 0,
  • "sexAtBirth": 0,
  • "genderIdentity": 0,
  • "genderOther": null,
  • "residenceCountry": "string",
  • "birthCountry": "string",
  • "weight": 0,
  • "height": 0,
  • "employment": 0,
  • "otherEmployment": null,
  • "isHealthcareWorker": null,
  • "smokingStatus": 0,
  • "smokingStopped": "YEAR_OR_LESS",
  • "metadata": {
    }
}

Retrieve HighFrequencyHeartRate by event log

get
URL: /api/extensions/v1/user/{user_id}/primitive/HighFrequencyHeartRate/event-log/{event_log_id}
path Parameters
user_id
required
string
event_log_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "value": 0,
  • "heartRateType": "UNSPECIFIED",
  • "classification": null,
  • "variabilityAVNN": null,
  • "variabilitySDNN": null,
  • "variabilityRMSSD": null,
  • "variabilityPNN50": null,
  • "variabilityprcLF": null,
  • "confidence": null,
  • "goodIBI": null,
  • "rawDataObject": null,
  • "valueUnit": "bpm",
  • "metadata": null,
  • "multipleValues": null,
  • "dataType": "MULTIPLE_VALUE"
}

Retrieve AZGroupKeyActionTrigger by event log

get
URL: /api/extensions/v1/user/{user_id}/primitive/AZGroupKeyActionTrigger/event-log/{event_log_id}
path Parameters
user_id
required
string
event_log_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "skipped": null,
  • "firstVaccineDate": "2019-08-24",
  • "groupCategory": 0,
  • "metadata": {
    }
}

Retrieve AZScreeningQuestionnaire by event log

get
URL: /api/extensions/v1/user/{user_id}/primitive/AZScreeningQuestionnaire/event-log/{event_log_id}
path Parameters
user_id
required
string
event_log_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "skipped": null,
  • "hasReceivedCOVIDVacInPast4Weeks": true,
  • "isAZVaccineFirstDose": true,
  • "is18YearsOldDuringVaccination": true,
  • "metadata": {
    }
}

Retrieve Covid19RiskScoreCoreQuestions by event log

get
URL: /api/extensions/v1/user/{user_id}/primitive/Covid19RiskScoreCoreQuestions/event-log/{event_log_id}
path Parameters
user_id
required
string
event_log_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "bloodType": "O_POSITIVE",
  • "preExistingConditions": [
    ],
  • "currentSymptoms": [
    ],
  • "score": null,
  • "status": "LOW"
}

Retrieve AZFurtherPregnancyKeyActionTrigger by event log

get
URL: /api/extensions/v1/user/{user_id}/primitive/AZFurtherPregnancyKeyActionTrigger/event-log/{event_log_id}
path Parameters
user_id
required
string
event_log_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "skipped": null,
  • "currentGroupCategory": 0,
  • "metadata": {
    }
}

Retrieve_Module_Result

Retrieve primitive ODI

get
URL: /api/extensions/v1/user/{user_id}/primitive/ODI/{module_result_id}
path Parameters
user_id
required
string
module_result_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "value": 0
}

Retrieve primitive NDI

get
URL: /api/extensions/v1/user/{user_id}/primitive/NDI/{module_result_id}
path Parameters
user_id
required
string
module_result_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "value": 0
}

Retrieve primitive WHQ

get
URL: /api/extensions/v1/user/{user_id}/primitive/WHQ/{module_result_id}
path Parameters
user_id
required
string
module_result_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "value": 0
}

Retrieve primitive BMI

get
URL: /api/extensions/v1/user/{user_id}/primitive/BMI/{module_result_id}
path Parameters
user_id
required
string
module_result_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "value": 0,
  • "valueUnit": "kg/m2",
  • "originalValue": null,
  • "originalUnit": null
}

Retrieve primitive CAT

get
URL: /api/extensions/v1/user/{user_id}/primitive/CAT/{module_result_id}
path Parameters
user_id
required
string
module_result_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "value": 0
}

Retrieve primitive AHQ

get
URL: /api/extensions/v1/user/{user_id}/primitive/AHQ/{module_result_id}
path Parameters
user_id
required
string
module_result_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "value": 0
}

Retrieve primitive SRS

get
URL: /api/extensions/v1/user/{user_id}/primitive/SRS/{module_result_id}
path Parameters
user_id
required
string
module_result_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "function": 0,
  • "pain": 0,
  • "selfImage": 0,
  • "mentalHealth": 0,
  • "satisfactionWithManagement": 0,
  • "subTotal": 0,
  • "total": 0,
  • "value": 0
}

Retrieve primitive ECG

get
URL: /api/extensions/v1/user/{user_id}/primitive/ECG/{module_result_id}
path Parameters
user_id
required
string
module_result_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "averageHeartRate": 0,
  • "classification": 1,
  • "leadType": 1,
  • "pdf": null,
  • "dataPoints": null
}

Retrieve primitive SF36

get
URL: /api/extensions/v1/user/{user_id}/primitive/SF36/{module_result_id}
path Parameters
user_id
required
string
module_result_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "physicalFunctioningScore": null,
  • "limitationsPhysicalHealthScore": null,
  • "limitationsEmotionalProblemsScore": null,
  • "energyFatigueScore": null,
  • "emotionalWellBeingScore": null,
  • "socialFunctioningScore": null,
  • "painScore": null,
  • "generalHealthScore": null
}

Retrieve primitive KCCQ

get
URL: /api/extensions/v1/user/{user_id}/primitive/KCCQ/{module_result_id}
path Parameters
user_id
required
string
module_result_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "physicalLimitation": 0,
  • "symptomStability": 0,
  • "symptomFrequency": 0,
  • "symptomBurden": 0,
  • "totalSymptomScore": 0,
  • "selfEfficacy": 0,
  • "qualityOfLife": 0,
  • "socialLimitation": 0,
  • "overallSummaryScore": 0,
  • "clinicalSummaryScore": 0
}

Retrieve primitive KOOS

get
URL: /api/extensions/v1/user/{user_id}/primitive/KOOS/{module_result_id}
path Parameters
user_id
required
string
module_result_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "adlScore": 0,
  • "qualityOfLifeScore": 0,
  • "painScore": 0,
  • "symptomsScore": 0,
  • "sportRecreationScore": 0
}

Retrieve primitive IKDC

get
URL: /api/extensions/v1/user/{user_id}/primitive/IKDC/{module_result_id}
path Parameters
user_id
required
string
module_result_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "symptoms": null,
  • "sportsActivity": null,
  • "kneeFunction": null,
  • "value": null
}

Retrieve primitive OARS

get
URL: /api/extensions/v1/user/{user_id}/primitive/OARS/{module_result_id}
path Parameters
user_id
required
string
module_result_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "painScore": 0,
  • "sleepScore": 0,
  • "nauseaScore": 0,
  • "mobilityScore": 0,
  • "oarsScore": 0
}

Retrieve primitive Step

get
URL: /api/extensions/v1/user/{user_id}/primitive/Step/{module_result_id}
path Parameters
user_id
required
string
module_result_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "value": 0,
  • "weeklyTotal": null,
  • "multipleValues": null,
  • "rawDataObject": null,
  • "dataType": "MULTIPLE_VALUE"
}

Retrieve primitive OACS

get
URL: /api/extensions/v1/user/{user_id}/primitive/OACS/{module_result_id}
path Parameters
user_id
required
string
module_result_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "oacsScore": 0
}

Retrieve primitive Sleep

get
URL: /api/extensions/v1/user/{user_id}/primitive/Sleep/{module_result_id}
path Parameters
user_id
required
string
module_result_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "awake": null,
  • "awakeCount": null,
  • "sleep": null,
  • "outOfBed": null,
  • "lightSleep": null,
  • "deepSleep": null,
  • "remSleep": null,
  • "duration": 0,
  • "summary": [
    ],
  • "dateOfSleep": "string",
  • "uwake": 0
}

Retrieve primitive WOMAC

get
URL: /api/extensions/v1/user/{user_id}/primitive/WOMAC/{module_result_id}
path Parameters
user_id
required
string
module_result_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "painScore": 0,
  • "symptomsScore": 0,
  • "adlScore": 0,
  • "totalScore": 0
}

Retrieve primitive VR_12

get
URL: /api/extensions/v1/user/{user_id}/primitive/VR_12/{module_result_id}
path Parameters
user_id
required
string
module_result_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "physicalScore": 0,
  • "mentalScore": 0
}

Retrieve primitive Photo

get
URL: /api/extensions/v1/user/{user_id}/primitive/Photo/{module_result_id}
path Parameters
user_id
required
string
module_result_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "s3Object": {
    },
  • "s3Thumbnail": null,
  • "note": null
}

Retrieve primitive Tegner

get
URL: /api/extensions/v1/user/{user_id}/primitive/Tegner/{module_result_id}
path Parameters
user_id
required
string
module_result_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "activityLevelBefore": 0,
  • "activityLevelCurrent": 0
}

Retrieve primitive MG_ADL

get
URL: /api/extensions/v1/user/{user_id}/primitive/MG_ADL/{module_result_id}
path Parameters
user_id
required
string
module_result_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "value": 0,
  • "ocularDysfunction": 0,
  • "respiratoryDysfunction": 0,
  • "extremityDysfunction": 0,
  • "oropharyngealDysfunction": 0
}

Retrieve primitive EQ5D5L

get
URL: /api/extensions/v1/user/{user_id}/primitive/EQ5D5L/{module_result_id}
path Parameters
user_id
required
string
module_result_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "indexValue": null,
  • "healthState": null,
  • "mobility": null,
  • "selfCare": null,
  • "usualActivities": null,
  • "pain": null,
  • "anxiety": null,
  • "eqVas": null
}

Retrieve primitive Weight

get
URL: /api/extensions/v1/user/{user_id}/primitive/Weight/{module_result_id}
path Parameters
user_id
required
string
module_result_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "value": 0,
  • "valueUnit": "kg",
  • "originalValue": null,
  • "originalUnit": null
}

Retrieve primitive HScore

get
URL: /api/extensions/v1/user/{user_id}/primitive/HScore/{module_result_id}
path Parameters
user_id
required
string
module_result_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "value": 0,
  • "topValue": 0,
  • "bottomValue": 0,
  • "status": "HIGH",
  • "keyAreasItems": null
}

Retrieve primitive Ptosis

get
URL: /api/extensions/v1/user/{user_id}/primitive/Ptosis/{module_result_id}
path Parameters
user_id
required
string
module_result_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "recording": {
    },
  • "severityLeft": null,
  • "severityRight": null,
  • "timeLeft": null,
  • "timeRight": null,
  • "isPrompted": false
}

Retrieve primitive Height

get
URL: /api/extensions/v1/user/{user_id}/primitive/Height/{module_result_id}
path Parameters
user_id
required
string
module_result_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "value": 0,
  • "valueUnit": "cm"
}

Retrieve primitive NORFOLK

get
URL: /api/extensions/v1/user/{user_id}/primitive/NORFOLK/{module_result_id}
path Parameters
user_id
required
string
module_result_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "totalQolScore": 0,
  • "physicalFunctionLargeFiber": 0,
  • "activitiesOfDailyLiving": 0,
  • "symptoms": 0,
  • "smallFiber": 0,
  • "automic": 0
}

Retrieve primitive Symptom

get
URL: /api/extensions/v1/user/{user_id}/primitive/Symptom/{module_result_id}
path Parameters
user_id
required
string
module_result_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "value": null,
  • "complexValues": null,
  • "followUpQuestionIds": null
}

Retrieve primitive Lysholm

get
URL: /api/extensions/v1/user/{user_id}/primitive/Lysholm/{module_result_id}
path Parameters
user_id
required
string
module_result_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "limp": 0,
  • "caneOrCrutches": 0,
  • "lockingSensation": 0,
  • "givingWaySensation": 0,
  • "pain": 0,
  • "swelling": 0,
  • "climbingStairs": 0,
  • "squatting": 0,
  • "lysholm": 0
}

Retrieve primitive Journal

get
URL: /api/extensions/v1/user/{user_id}/primitive/Journal/{module_result_id}
path Parameters
user_id
required
string
module_result_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "value": "string"
}

Retrieve primitive PeakFlow

get
URL: /api/extensions/v1/user/{user_id}/primitive/PeakFlow/{module_result_id}
path Parameters
user_id
required
string
module_result_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "value": 0,
  • "valuePercent": null,
  • "valueUnit": "L/min"
}

Retrieve primitive FitbitHRV

get
URL: /api/extensions/v1/user/{user_id}/primitive/FitbitHRV/{module_result_id}
path Parameters
user_id
required
string
module_result_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "rmssd": null,
  • "coverage": null,
  • "hf": null,
  • "lf": null
}

Retrieve primitive Dysphonia

get
URL: /api/extensions/v1/user/{user_id}/primitive/Dysphonia/{module_result_id}
path Parameters
user_id
required
string
module_result_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "countingRecordingID": "string",
  • "initialProbability": null,
  • "fatiguedProbability": null,
  • "probability": null,
  • "confidence": null,
  • "aaahhhInitialRecordingID": "string",
  • "aaahhhFatiguedRecordingID": "string"
}

Retrieve primitive DashScore

get
URL: /api/extensions/v1/user/{user_id}/primitive/DashScore/{module_result_id}
path Parameters
user_id
required
string
module_result_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "quickDashQuestions": {
    },
  • "workQuestions": null,
  • "sportArtQuestions": null,
  • "doWork": null,
  • "doSportArt": null,
  • "workName": null,
  • "sportArtName": null,
  • "quickDashScore": null,
  • "workScore": null,
  • "sportArtScore": null
}

Retrieve primitive HeartRate

get
URL: /api/extensions/v1/user/{user_id}/primitive/HeartRate/{module_result_id}
path Parameters
user_id
required
string
module_result_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "value": 0,
  • "heartRateType": "UNSPECIFIED",
  • "classification": null,
  • "variabilityAVNN": null,
  • "variabilitySDNN": null,
  • "variabilityRMSSD": null,
  • "variabilityPNN50": null,
  • "variabilityprcLF": null,
  • "confidence": null,
  • "goodIBI": null,
  • "rawDataObject": null,
  • "valueUnit": "bpm",
  • "metadata": null
}

Retrieve primitive Dysarthria

get
URL: /api/extensions/v1/user/{user_id}/primitive/Dysarthria/{module_result_id}
path Parameters
user_id
required
string
module_result_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "countingRecordingID": "string",
  • "initialProbability": null,
  • "fatiguedProbability": null,
  • "probability": null,
  • "confidence": null,
  • "buttercupInitialRecordingID": "string",
  • "buttercupFatiguedRecordingID": "string"
}

Retrieve primitive RevereTest

get
URL: /api/extensions/v1/user/{user_id}/primitive/RevereTest/{module_result_id}
path Parameters
user_id
required
string
module_result_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": null,
  • "startDateTime": null,
  • "endDateTime": null,
  • "results": null,
  • "status": "STARTED",
  • "moduleId": "string",
  • "deploymentId": "string"
}

Retrieve primitive ArmFatigue

get
URL: /api/extensions/v1/user/{user_id}/primitive/ArmFatigue/{module_result_id}
path Parameters
user_id
required
string
module_result_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "arm": "LEFT",
  • "angle": null,
  • "classification": null,
  • "output": null,
  • "recording": {
    },
  • "time": null
}

Retrieve primitive ECGAliveCor

get
URL: /api/extensions/v1/user/{user_id}/primitive/ECGAliveCor/{module_result_id}
path Parameters
user_id
required
string
module_result_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "s3Object": {
    },
  • "kardiaEcgRecordId": "string"
}

Retrieve primitive Temperature

get
URL: /api/extensions/v1/user/{user_id}/primitive/Temperature/{module_result_id}
path Parameters
user_id
required
string
module_result_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "value": 0,
  • "valueUnit": "oC",
  • "originalValue": null,
  • "originalUnit": null
}

Retrieve primitive HealthStatus

get
URL: /api/extensions/v1/user/{user_id}/primitive/HealthStatus/{module_result_id}
path Parameters
user_id
required
string
module_result_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "skipped": null,
  • "newOrWorseSymptoms": 0,
  • "healthProblemsOrDisabilityList": null,
  • "metadata": {
    }
}

Retrieve primitive ECGHealthKit

get
URL: /api/extensions/v1/user/{user_id}/primitive/ECGHealthKit/{module_result_id}
path Parameters
user_id
required
string
module_result_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "value": 1,
  • "ecgReading": {
    },
  • "generatedPDF": null
}

Retrieve primitive BloodGlucose

get
URL: /api/extensions/v1/user/{user_id}/primitive/BloodGlucose/{module_result_id}
path Parameters
user_id
required
string
module_result_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "value": 0,
  • "valueUnit": "mmol/L",
  • "originalValue": null,
  • "originalUnit": null
}

Retrieve primitive ReactionTime

get
URL: /api/extensions/v1/user/{user_id}/primitive/ReactionTime/{module_result_id}
path Parameters
user_id
required
string
module_result_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "value": 0
}

Retrieve primitive CVDRiskScore

get
URL: /api/extensions/v1/user/{user_id}/primitive/CVDRiskScore/{module_result_id}
path Parameters
user_id
required
string
module_result_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "age": 0,
  • "sex": "FEMALE",
  • "alcoholIntake": "DAILY",
  • "sleepDuration": 0,
  • "smokingStatus": true,
  • "walkingPace": "SLOW_PACE",
  • "overallHealth": "EXCELLENT",
  • "existingConditions": [
    ],
  • "existingSymptoms": [
    ],
  • "currentMedications": [
    ],
  • "familyHeartDisease": [
    ],
  • "heartRate": 0,
  • "waistCircumference": 0,
  • "hipCircumference": 0,
  • "waistToHipRatio": null,
  • "riskFactors": null,
  • "riskTrajectory": null,
  • "originalValue": null,
  • "roundedValue": null
}

Retrieve primitive OtherVaccine

get
URL: /api/extensions/v1/user/{user_id}/primitive/OtherVaccine/{module_result_id}
path Parameters
user_id
required
string
module_result_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "skipped": null,
  • "hasFluVaccine": true,
  • "fluVaccineDate": null,
  • "hasOtherVaccine": true,
  • "vaccineCategory": null,
  • "vaccineList": null,
  • "metadata": {
    }
}

Retrieve primitive NumericMemory

get
URL: /api/extensions/v1/user/{user_id}/primitive/NumericMemory/{module_result_id}
path Parameters
user_id
required
string
module_result_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "value": 0
}

Retrieve primitive SensorCapture

get
URL: /api/extensions/v1/user/{user_id}/primitive/SensorCapture/{module_result_id}
path Parameters
user_id
required
string
module_result_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "s3Object": {
    },
  • "sanityCheck": null,
  • "sanityCheckMessage": null,
  • "measurementLocation": "LEFT_FRONT_TROUSERS_POCKET",
  • "sensorDataTypes": null,
  • "value": null
}

Retrieve primitive AdditionalQoL

get
URL: /api/extensions/v1/user/{user_id}/primitive/AdditionalQoL/{module_result_id}
path Parameters
user_id
required
string
module_result_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "skipped": null,
  • "viewFamily": 0,
  • "contactProfessionals": 0,
  • "contributeActivities": 0,
  • "metadata": {
    }
}

Retrieve primitive PulseOximetry

get
URL: /api/extensions/v1/user/{user_id}/primitive/PulseOximetry/{module_result_id}
path Parameters
user_id
required
string
module_result_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "value": 0
}

Retrieve primitive BloodPressure

get
URL: /api/extensions/v1/user/{user_id}/primitive/BloodPressure/{module_result_id}
path Parameters
user_id
required
string
module_result_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "diastolicValue": 0,
  • "systolicValue": 0,
  • "diastolicValueUnit": "mmHg",
  • "systolicValueUnit": "mmHg"
}

Retrieve primitive Questionnaire

get
URL: /api/extensions/v1/user/{user_id}/primitive/Questionnaire/{module_result_id}
path Parameters
user_id
required
string
module_result_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "answers": [
    ],
  • "appResult": null,
  • "isForManager": null,
  • "questionnaireId": "string",
  • "questionnaireName": "string",
  • "value": null,
  • "skipped": null,
  • "updateDateTime": null,
  • "signOffDateTime": null,
  • "status": "SUBMITTED",
  • "revision": null
}

Retrieve primitive WaistToHeight

get
URL: /api/extensions/v1/user/{user_id}/primitive/WaistToHeight/{module_result_id}
path Parameters
user_id
required
string
module_result_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "height": 0,
  • "waist": null,
  • "value": null
}

Retrieve primitive MedicalHistory

get
URL: /api/extensions/v1/user/{user_id}/primitive/MedicalHistory/{module_result_id}
path Parameters
user_id
required
string
module_result_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "skipped": null,
  • "cancerType": null,
  • "medicalDiagnosis": [
    ],
  • "medicalConditions": null,
  • "takingImmunoSuppressants": 0,
  • "immunoSuppressantMedicationList": null,
  • "isCovidInfectedInPast": true,
  • "covidInfectedDate": null,
  • "isCovidToldByDoctor": true,
  • "covidToldByDoctorDate": null,
  • "takenCovidTest": 0,
  • "covidTestResult": "NONE_POSITIVE",
  • "covidTestDate": null,
  • "covidTestMethod": "NOSE_THROAT_SWAB",
  • "covidTestOther": null,
  • "covidSymptoms": null,
  • "otherCovidSymptoms": null,
  • "covidSymptomAction": null,
  • "metadata": {
    },
  • "hadCovidSymptoms": null,
  • "hadOtherCovidSymptoms": null,
  • "isDiagnosedWithCancer": true
}

Retrieve primitive InfantFollowUp

get
URL: /api/extensions/v1/user/{user_id}/primitive/InfantFollowUp/{module_result_id}
path Parameters
user_id
required
string
module_result_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "skipped": null,
  • "isCovPregLiveBirth": true,
  • "isMoreThan1ChildCovVac": null,
  • "countCovPreg": null,
  • "children": null,
  • "metadata": {
    }
}

Retrieve primitive SleepQuestions

get
URL: /api/extensions/v1/user/{user_id}/primitive/SleepQuestions/{module_result_id}
path Parameters
user_id
required
string
module_result_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "sleepQualityScore": 1,
  • "tiredScore": "LESS_THAN_NORMAL",
  • "hoursSleep": 0,
  • "minutesSleep": 0
}

Retrieve primitive OxfordHipScore

get
URL: /api/extensions/v1/user/{user_id}/primitive/OxfordHipScore/{module_result_id}
path Parameters
user_id
required
string
module_result_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "hipAffected": 0,
  • "hipsData": [
    ],
  • "rightHipScore": null,
  • "leftHipScore": null
}

Retrieve primitive SmokeQuestions

get
URL: /api/extensions/v1/user/{user_id}/primitive/SmokeQuestions/{module_result_id}
path Parameters
user_id
required
string
module_result_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "smokeStatus": "YES_AND_I_STILL_DO",
  • "smokerType": "REGULAR_SMOKER",
  • "smokingPeriod": "LESS_THAN_A_YEAR",
  • "numberOfCigarettesPerDay": null,
  • "numberOfCigarettesPerMonth": null,
  • "vapeStatus": "YES_AND_I_STILL_DO",
  • "vapePeriodic": "RARELY"
}

Retrieve primitive SpatialSpaniOS

get
URL: /api/extensions/v1/user/{user_id}/primitive/SpatialSpaniOS/{module_result_id}
path Parameters
user_id
required
string
module_result_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "value": 0
}

Retrieve primitive SelfHealthRate

get
URL: /api/extensions/v1/user/{user_id}/primitive/SelfHealthRate/{module_result_id}
path Parameters
user_id
required
string
module_result_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "value": 1
}

Retrieve primitive OxfordKneeScore

get
URL: /api/extensions/v1/user/{user_id}/primitive/OxfordKneeScore/{module_result_id}
path Parameters
user_id
required
string
module_result_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "legAffected": 0,
  • "legsData": [
    ],
  • "rightKneeScore": null,
  • "leftKneeScore": null
}

Retrieve primitive PregnancyStatus

get
URL: /api/extensions/v1/user/{user_id}/primitive/PregnancyStatus/{module_result_id}
path Parameters
user_id
required
string
module_result_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "skipped": null,
  • "menstrualPeriod": true,
  • "lastMenstrualPeriodDate": null,
  • "pregnancyStatus": "YES",
  • "isExpectedDueDateAvailable": null,
  • "expectedDueDate": null,
  • "pregnancyMoreThan1": "YES",
  • "babyCount": null,
  • "hasMedicalFertilityProcedure": null,
  • "medicalFertilityProcedureAnswer": null,
  • "hasOtherMedicalFertilityProcedure": null,
  • "otherMedicalFertilityProcedureAnswer": null,
  • "pregnantBefore": "YES",
  • "pregnancyTimes": null,
  • "pastPregnancyLiveBirth": null,
  • "pastPregnancyStillBorn": null,
  • "pastPregnancyMiscarriage": null,
  • "pastPregnancyEctopic": null,
  • "pastPregnancyElectiveTermination": null,
  • "hasMedicalProfessionalVisit": null,
  • "highRiskCondition": "YES",
  • "highRiskConditionAnswers": null,
  • "familyHistoryDefects": "YES",
  • "familyHistoryDefectsAnswers": null,
  • "hasPrenatalScreening": null,
  • "prenatalScreeningAnswer": null,
  • "hasOtherPrenatalScreening": null,
  • "otherPrenatalScreening": null,
  • "hasOtherScreeningProblem": null,
  • "otherScreeningProblem": null,
  • "metadata": {
    }
}

Retrieve primitive BodyComposition

get
URL: /api/extensions/v1/user/{user_id}/primitive/BodyComposition/{module_result_id}
path Parameters
user_id
required
string
module_result_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "bmiDevice": null,
  • "restingMetabolism": null,
  • "visceralFatLevel": null,
  • "visceralFatLevelClassification": null,
  • "bodyFatLevel": null,
  • "bodyFatPercentage": null,
  • "skeletalMuscleLevel": null,
  • "skeletalMuscleLevelPercentage": null
}

Retrieve primitive RespiratoryRate

get
URL: /api/extensions/v1/user/{user_id}/primitive/RespiratoryRate/{module_result_id}
path Parameters
user_id
required
string
module_result_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "value": 0,
  • "valueUnit": "rpm",
  • "originalValue": null
}

Retrieve primitive PregnancyUpdate

get
URL: /api/extensions/v1/user/{user_id}/primitive/PregnancyUpdate/{module_result_id}
path Parameters
user_id
required
string
module_result_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "skipped": null,
  • "hasMenstrualPeriod": true,
  • "lastMenstrualPeriodDateDay1": null,
  • "becamePregnant": null,
  • "isPregnancyCurrent": null,
  • "isExpectedDueDateAvailable": null,
  • "expectedDueDate": null,
  • "pregnancyMoreThan1": "YES",
  • "babyCount": null,
  • "pastPregnancyMoreThan1": "YES",
  • "pastBabyCount": null,
  • "pregnancyResult": null,
  • "hasOtherPregnancyOutcome": null,
  • "otherPregnancyResult": null,
  • "pastPregnancyWeeks": null,
  • "hasPastPregnancy": "YES",
  • "pregnancyTimes": null,
  • "pastPregnancyLifeBirth": null,
  • "pastPregnancyStillBorn": null,
  • "pastPregnancyEctopic": null,
  • "pastPregnancyMiscarriage": null,
  • "pastPregnancyElectiveTermination": null,
  • "hasVisitMedicalProfessional": null,
  • "highRiskCondition": "YES",
  • "highRiskConditionAnswers": null,
  • "familyHistoryDefects": "YES",
  • "familyHistoryDefectsAnswers": null,
  • "hasPrenatalScreening": null,
  • "prenatalScreeningAnswers": null,
  • "hasOtherPrenatalScreening": null,
  • "otherPrenatalScreening": null,
  • "hasScreeningProblem": null,
  • "screeningProblemText": null,
  • "metadata": {
    }
}

Retrieve primitive AirQualityIndex

get
URL: /api/extensions/v1/user/{user_id}/primitive/AirQualityIndex/{module_result_id}
path Parameters
user_id
required
string
module_result_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "value": 0,
  • "latitude": 0,
  • "longitude": 0
}

Retrieve primitive PostVaccination

get
URL: /api/extensions/v1/user/{user_id}/primitive/PostVaccination/{module_result_id}
path Parameters
user_id
required
string
module_result_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "skipped": null,
  • "secondCOVIDVaccinationDose": "2019-08-24",
  • "isSecondDoseAZ": true,
  • "secondDoseBrand": "MODERNA",
  • "batchNumberVaccine": null,
  • "isBatchNumberValid": null,
  • "isSamePlaceVaccine2As1": true,
  • "vaccinationPlace": "PRIMARY_HEALTH_PROVIDER",
  • "vaccinationPlaceOther": null,
  • "vaccinationPlaceLocation": null,
  • "metadata": {
    }
}

Retrieve primitive BodyMeasurement

get
URL: /api/extensions/v1/user/{user_id}/primitive/BodyMeasurement/{module_result_id}
path Parameters
user_id
required
string
module_result_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "visceralFat": null,
  • "totalBodyFat": null,
  • "waistCircumference": null,
  • "waistCircumferenceUnit": "cm",
  • "hipCircumference": null,
  • "hipCircumferenceUnit": "cm",
  • "waistToHipRatio": null
}

Retrieve primitive Covid19RiskScore

get
URL: /api/extensions/v1/user/{user_id}/primitive/Covid19RiskScore/{module_result_id}
path Parameters
user_id
required
string
module_result_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "value": null,
  • "status": "LOW"
}

Retrieve primitive OxygenSaturation

get
URL: /api/extensions/v1/user/{user_id}/primitive/OxygenSaturation/{module_result_id}
path Parameters
user_id
required
string
module_result_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "value": 0,
  • "valueUnit": "%",
  • "originalValue": null,
  • "oxygenSupplement": null
}

Retrieve primitive FeverAndPainDrugs

get
URL: /api/extensions/v1/user/{user_id}/primitive/FeverAndPainDrugs/{module_result_id}
path Parameters
user_id
required
string
module_result_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "skipped": null,
  • "hasAntiFeverPainDrugs": true,
  • "medStartedBeforeAfter": "BEFORE",
  • "daysBeforeVacMedication": null,
  • "daysAfterVacMedication": null,
  • "isUnderMedication": null,
  • "daysCountMedication": null,
  • "metadata": {
    }
}

Retrieve primitive AsthmaControlTest

get
URL: /api/extensions/v1/user/{user_id}/primitive/AsthmaControlTest/{module_result_id}
path Parameters
user_id
required
string
module_result_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "value": 0
}

Retrieve primitive AwarenessTraining

get
URL: /api/extensions/v1/user/{user_id}/primitive/AwarenessTraining/{module_result_id}
path Parameters
user_id
required
string
module_result_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "certificateNumber": null,
  • "totalHealthScore": null,
  • "status": null
}

Retrieve primitive PregnancyFollowUp

get
URL: /api/extensions/v1/user/{user_id}/primitive/PregnancyFollowUp/{module_result_id}
path Parameters
user_id
required
string
module_result_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "skipped": null,
  • "pregnantMedications": true,
  • "prescriptionMedications": null,
  • "overCounterPregnantMedications": true,
  • "overCounterMedications": null,
  • "babyCount": 0,
  • "currentBabyCount": null,
  • "babyInfo": [
    ],
  • "metadata": {
    }
}

Retrieve primitive HighFrequencyStep

get
URL: /api/extensions/v1/user/{user_id}/primitive/HighFrequencyStep/{module_result_id}
path Parameters
user_id
required
string
module_result_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "stepsObject": {
    }
}

Retrieve primitive PROMISGlobalHealth

get
URL: /api/extensions/v1/user/{user_id}/primitive/PROMISGlobalHealth/{module_result_id}
path Parameters
user_id
required
string
module_result_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "skipped": null,
  • "global01": 1,
  • "global02": 1,
  • "global03": 1,
  • "global04": 1,
  • "global05": 1,
  • "global06": 1,
  • "global07rc": 0,
  • "global08r": 1,
  • "global09r": 1,
  • "global10r": 1,
  • "mentalHealthValue": null,
  • "mentalHealthResult": null,
  • "physicalHealthValue": null,
  • "physicalHealthResult": null,
  • "metadata": {
    }
}

Retrieve primitive VaccinationDetails

get
URL: /api/extensions/v1/user/{user_id}/primitive/VaccinationDetails/{module_result_id}
path Parameters
user_id
required
string
module_result_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "skipped": null,
  • "vaccinatedPlace": 0,
  • "vaccinationLocation": null,
  • "vaccinationCity": "string",
  • "batchNumber": "string",
  • "isBatchNumberValid": null,
  • "isSecondDoseVacc": 0,
  • "secondVacScheduleDate": null,
  • "isSeasonFluVac": true,
  • "seasonFluVacDate": null,
  • "isOtherSpecifiedVacc": true,
  • "otherSpecifiedVacc": null,
  • "otherVaccCategory": null,
  • "isAllergicReactionVacc": 0,
  • "allergicReactionVacc": null,
  • "allergicReaction": null,
  • "metadata": null
}

Retrieve primitive AlcoholConsumption

get
URL: /api/extensions/v1/user/{user_id}/primitive/AlcoholConsumption/{module_result_id}
path Parameters
user_id
required
string
module_result_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "drinkAlcohol": true,
  • "sections": [
    ]
}

Retrieve primitive OxfordShoulderScore

get
URL: /api/extensions/v1/user/{user_id}/primitive/OxfordShoulderScore/{module_result_id}
path Parameters
user_id
required
string
module_result_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "shoulderAffected": 0,
  • "shouldersData": [
    ],
  • "rightShoulderScore": null,
  • "leftShoulderScore": null
}

Retrieve primitive Covid19DailyCheckIn

get
URL: /api/extensions/v1/user/{user_id}/primitive/Covid19DailyCheckIn/{module_result_id}
path Parameters
user_id
required
string
module_result_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "contactType": "I_LIVE_WITH_SUCH_PERSON"
}

Retrieve primitive BreastFeedingStatus

get
URL: /api/extensions/v1/user/{user_id}/primitive/BreastFeedingStatus/{module_result_id}
path Parameters
user_id
required
string
module_result_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "skipped": null,
  • "isBreastFeedingCurrently": true,
  • "numberOfWeeksAtChildBirth": null,
  • "hadComplicationsAtBirth": null,
  • "complicationList": null,
  • "hasHighRiskConditions": null,
  • "highRiskConditions": null,
  • "familyHistoryOfDefects": "YES",
  • "familyHistoryOfDefectsList": null,
  • "numBreastFeedingBabies": 0,
  • "breastFeedingBabyDetails": null,
  • "metadata": {
    }
}

Retrieve primitive BreastFeedingUpdate

get
URL: /api/extensions/v1/user/{user_id}/primitive/BreastFeedingUpdate/{module_result_id}
path Parameters
user_id
required
string
module_result_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "skipped": null,
  • "isBreastFeedingNow": true,
  • "stopDate": null,
  • "newOrWorseSymptoms": [
    ],
  • "numBreastFeedingBabies": 0,
  • "breastFeedingBabyDetails": null,
  • "metadata": {
    }
}

Retrieve primitive RestingBreathingRate

get
URL: /api/extensions/v1/user/{user_id}/primitive/RestingBreathingRate/{module_result_id}
path Parameters
user_id
required
string
module_result_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "value": 0
}

Retrieve primitive PerceivedStressScale

get
URL: /api/extensions/v1/user/{user_id}/primitive/PerceivedStressScale/{module_result_id}
path Parameters
user_id
required
string
module_result_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "value": 0
}

Retrieve primitive DiabetesDistressScore

get
URL: /api/extensions/v1/user/{user_id}/primitive/DiabetesDistressScore/{module_result_id}
path Parameters
user_id
required
string
module_result_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "totalDDS": 0,
  • "emotionalBurden": null,
  • "physicianDistress": null,
  • "regimenDistress": null,
  • "interpersonalDistress": null
}

Retrieve primitive BackgroundInformation

get
URL: /api/extensions/v1/user/{user_id}/primitive/BackgroundInformation/{module_result_id}
path Parameters
user_id
required
string
module_result_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "skipped": null,
  • "age": 0,
  • "sexAtBirth": 0,
  • "genderIdentity": 0,
  • "genderOther": null,
  • "residenceCountry": "string",
  • "birthCountry": "string",
  • "weight": 0,
  • "height": 0,
  • "employment": 0,
  • "otherEmployment": null,
  • "isHealthcareWorker": null,
  • "smokingStatus": 0,
  • "smokingStopped": "YEAR_OR_LESS",
  • "metadata": {
    }
}

Retrieve primitive HighFrequencyHeartRate

get
URL: /api/extensions/v1/user/{user_id}/primitive/HighFrequencyHeartRate/{module_result_id}
path Parameters
user_id
required
string
module_result_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "value": 0,
  • "heartRateType": "UNSPECIFIED",
  • "classification": null,
  • "variabilityAVNN": null,
  • "variabilitySDNN": null,
  • "variabilityRMSSD": null,
  • "variabilityPNN50": null,
  • "variabilityprcLF": null,
  • "confidence": null,
  • "goodIBI": null,
  • "rawDataObject": null,
  • "valueUnit": "bpm",
  • "metadata": null,
  • "multipleValues": null,
  • "dataType": "MULTIPLE_VALUE"
}

Retrieve primitive AZGroupKeyActionTrigger

get
URL: /api/extensions/v1/user/{user_id}/primitive/AZGroupKeyActionTrigger/{module_result_id}
path Parameters
user_id
required
string
module_result_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "skipped": null,
  • "firstVaccineDate": "2019-08-24",
  • "groupCategory": 0,
  • "metadata": {
    }
}

Retrieve primitive AZScreeningQuestionnaire

get
URL: /api/extensions/v1/user/{user_id}/primitive/AZScreeningQuestionnaire/{module_result_id}
path Parameters
user_id
required
string
module_result_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "skipped": null,
  • "hasReceivedCOVIDVacInPast4Weeks": true,
  • "isAZVaccineFirstDose": true,
  • "is18YearsOldDuringVaccination": true,
  • "metadata": {
    }
}

Retrieve primitive Covid19RiskScoreCoreQuestions

get
URL: /api/extensions/v1/user/{user_id}/primitive/Covid19RiskScoreCoreQuestions/{module_result_id}
path Parameters
user_id
required
string
module_result_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "bloodType": "O_POSITIVE",
  • "preExistingConditions": [
    ],
  • "currentSymptoms": [
    ],
  • "score": null,
  • "status": "LOW"
}

Retrieve primitive AZFurtherPregnancyKeyActionTrigger

get
URL: /api/extensions/v1/user/{user_id}/primitive/AZFurtherPregnancyKeyActionTrigger/{module_result_id}
path Parameters
user_id
required
string
module_result_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "userId": "string",
  • "moduleId": "string",
  • "moduleConfigId": null,
  • "moduleResultId": null,
  • "deploymentId": "string",
  • "version": 0,
  • "deviceName": "string",
  • "isAggregated": false,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": null,
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "submitterId": null,
  • "correlationStartDateTime": null,
  • "client": null,
  • "server": null,
  • "ragThreshold": null,
  • "flags": null,
  • "eventLogId": null,
  • "device": null,
  • "source": null,
  • "isAverage": null,
  • "noteId": null,
  • "feedback": null,
  • "skipped": null,
  • "currentGroupCategory": 0,
  • "metadata": {
    }
}

Retrieve_Module_Results

Retrieve AHQ results

post
URL: /api/extensions/v1/user/{user_id}/module-result/AHQ/search
path Parameters
user_id
required
string
Request Body schema: application/json
skip
integer or null
Default: null
limit
integer
Default: 10000
direction
string or null
Default: null
Enum: "ASC" "DESC" null
fromDateTime
string or null <date-time>
Default: null
toDateTime
string or null <date-time>
Default: null
object or null
Default: null
status
string or null
Default: null
useCreateDateTime
boolean
Default: false
moduleConfigId
string or null
Default: null
excludedFields
Array of strings or null
Default: null
normalQuestionnaires
boolean or null
Default: null
excludeModuleIds
Array of strings or null
Default: null
unseenOnly
boolean or null
Default: null
average
boolean or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "skip": null,
  • "limit": 10000,
  • "direction": "ASC",
  • "fromDateTime": null,
  • "toDateTime": null,
  • "filters": null,
  • "status": null,
  • "useCreateDateTime": false,
  • "moduleConfigId": null,
  • "excludedFields": null,
  • "normalQuestionnaires": null,
  • "excludeModuleIds": null,
  • "unseenOnly": null,
  • "average": null
}

Response samples

Content type
application/json
{
  • "AHQ": [
    ],
  • "Questionnaire": [
    ]
}

Retrieve NDI results

post
URL: /api/extensions/v1/user/{user_id}/module-result/NDI/search
path Parameters
user_id
required
string
Request Body schema: application/json
skip
integer or null
Default: null
limit
integer
Default: 10000
direction
string or null
Default: null
Enum: "ASC" "DESC" null
fromDateTime
string or null <date-time>
Default: null
toDateTime
string or null <date-time>
Default: null
object or null
Default: null
status
string or null
Default: null
useCreateDateTime
boolean
Default: false
moduleConfigId
string or null
Default: null
excludedFields
Array of strings or null
Default: null
normalQuestionnaires
boolean or null
Default: null
excludeModuleIds
Array of strings or null
Default: null
unseenOnly
boolean or null
Default: null
average
boolean or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "skip": null,
  • "limit": 10000,
  • "direction": "ASC",
  • "fromDateTime": null,
  • "toDateTime": null,
  • "filters": null,
  • "status": null,
  • "useCreateDateTime": false,
  • "moduleConfigId": null,
  • "excludedFields": null,
  • "normalQuestionnaires": null,
  • "excludeModuleIds": null,
  • "unseenOnly": null,
  • "average": null
}

Response samples

Content type
application/json
{
  • "NDI": [
    ],
  • "Questionnaire": [
    ]
}

Retrieve ODI results

post
URL: /api/extensions/v1/user/{user_id}/module-result/ODI/search
path Parameters
user_id
required
string
Request Body schema: application/json
skip
integer or null
Default: null
limit
integer
Default: 10000
direction
string or null
Default: null
Enum: "ASC" "DESC" null
fromDateTime
string or null <date-time>
Default: null
toDateTime
string or null <date-time>
Default: null
object or null
Default: null
status
string or null
Default: null
useCreateDateTime
boolean
Default: false
moduleConfigId
string or null
Default: null
excludedFields
Array of strings or null
Default: null
normalQuestionnaires
boolean or null
Default: null
excludeModuleIds
Array of strings or null
Default: null
unseenOnly
boolean or null
Default: null
average
boolean or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "skip": null,
  • "limit": 10000,
  • "direction": "ASC",
  • "fromDateTime": null,
  • "toDateTime": null,
  • "filters": null,
  • "status": null,
  • "useCreateDateTime": false,
  • "moduleConfigId": null,
  • "excludedFields": null,
  • "normalQuestionnaires": null,
  • "excludeModuleIds": null,
  • "unseenOnly": null,
  • "average": null
}

Response samples

Content type
application/json
{
  • "ODI": [
    ],
  • "Questionnaire": [
    ]
}

Retrieve SRS results

post
URL: /api/extensions/v1/user/{user_id}/module-result/SRS/search
path Parameters
user_id
required
string
Request Body schema: application/json
skip
integer or null
Default: null
limit
integer
Default: 10000
direction
string or null
Default: null
Enum: "ASC" "DESC" null
fromDateTime
string or null <date-time>
Default: null
toDateTime
string or null <date-time>
Default: null
object or null
Default: null
status
string or null
Default: null
useCreateDateTime
boolean
Default: false
moduleConfigId
string or null
Default: null
excludedFields
Array of strings or null
Default: null
normalQuestionnaires
boolean or null
Default: null
excludeModuleIds
Array of strings or null
Default: null
unseenOnly
boolean or null
Default: null
average
boolean or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "skip": null,
  • "limit": 10000,
  • "direction": "ASC",
  • "fromDateTime": null,
  • "toDateTime": null,
  • "filters": null,
  • "status": null,
  • "useCreateDateTime": false,
  • "moduleConfigId": null,
  • "excludedFields": null,
  • "normalQuestionnaires": null,
  • "excludeModuleIds": null,
  • "unseenOnly": null,
  • "average": null
}

Response samples

Content type
application/json
{
  • "Questionnaire": [
    ],
  • "SRS": [
    ]
}

Retrieve CAT results

post
URL: /api/extensions/v1/user/{user_id}/module-result/CAT/search
path Parameters
user_id
required
string
Request Body schema: application/json
skip
integer or null
Default: null
limit
integer
Default: 10000
direction
string or null
Default: null
Enum: "ASC" "DESC" null
fromDateTime
string or null <date-time>
Default: null
toDateTime
string or null <date-time>
Default: null
object or null
Default: null
status
string or null
Default: null
useCreateDateTime
boolean
Default: false
moduleConfigId
string or null
Default: null
excludedFields
Array of strings or null
Default: null
normalQuestionnaires
boolean or null
Default: null
excludeModuleIds
Array of strings or null
Default: null
unseenOnly
boolean or null
Default: null
average
boolean or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "skip": null,
  • "limit": 10000,
  • "direction": "ASC",
  • "fromDateTime": null,
  • "toDateTime": null,
  • "filters": null,
  • "status": null,
  • "useCreateDateTime": false,
  • "moduleConfigId": null,
  • "excludedFields": null,
  • "normalQuestionnaires": null,
  • "excludeModuleIds": null,
  • "unseenOnly": null,
  • "average": null
}

Response samples

Content type
application/json
{
  • "CAT": [
    ],
  • "Questionnaire": [
    ]
}

Retrieve WHQ results

post
URL: /api/extensions/v1/user/{user_id}/module-result/WHQ/search
path Parameters
user_id
required
string
Request Body schema: application/json
skip
integer or null
Default: null
limit
integer
Default: 10000
direction
string or null
Default: null
Enum: "ASC" "DESC" null
fromDateTime
string or null <date-time>
Default: null
toDateTime
string or null <date-time>
Default: null
object or null
Default: null
status
string or null
Default: null
useCreateDateTime
boolean
Default: false
moduleConfigId
string or null
Default: null
excludedFields
Array of strings or null
Default: null
normalQuestionnaires
boolean or null
Default: null
excludeModuleIds
Array of strings or null
Default: null
unseenOnly
boolean or null
Default: null
average
boolean or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "skip": null,
  • "limit": 10000,
  • "direction": "ASC",
  • "fromDateTime": null,
  • "toDateTime": null,
  • "filters": null,
  • "status": null,
  • "useCreateDateTime": false,
  • "moduleConfigId": null,
  • "excludedFields": null,
  • "normalQuestionnaires": null,
  • "excludeModuleIds": null,
  • "unseenOnly": null,
  • "average": null
}

Response samples

Content type
application/json
{
  • "WHQ": [
    ],
  • "Questionnaire": [
    ]
}

Retrieve ECG results

post
URL: /api/extensions/v1/user/{user_id}/module-result/ECG/search
path Parameters
user_id
required
string
Request Body schema: application/json
skip
integer or null
Default: null
limit
integer
Default: 10000
direction
string or null
Default: null
Enum: "ASC" "DESC" null
fromDateTime
string or null <date-time>
Default: null
toDateTime
string or null <date-time>
Default: null
object or null
Default: null
status
string or null
Default: null
useCreateDateTime
boolean
Default: false
moduleConfigId
string or null
Default: null
excludedFields
Array of strings or null
Default: null
normalQuestionnaires
boolean or null
Default: null
excludeModuleIds
Array of strings or null
Default: null
unseenOnly
boolean or null
Default: null
average
boolean or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "skip": null,
  • "limit": 10000,
  • "direction": "ASC",
  • "fromDateTime": null,
  • "toDateTime": null,
  • "filters": null,
  • "status": null,
  • "useCreateDateTime": false,
  • "moduleConfigId": null,
  • "excludedFields": null,
  • "normalQuestionnaires": null,
  • "excludeModuleIds": null,
  • "unseenOnly": null,
  • "average": null
}

Response samples

Content type
application/json
{
  • "ECG": [
    ]
}

Retrieve BMI results

post
URL: /api/extensions/v1/user/{user_id}/module-result/BMI/search
path Parameters
user_id
required
string
Request Body schema: application/json
skip
integer or null
Default: null
limit
integer
Default: 10000
direction
string or null
Default: null
Enum: "ASC" "DESC" null
fromDateTime
string or null <date-time>
Default: null
toDateTime
string or null <date-time>
Default: null
object or null
Default: null
status
string or null
Default: null
useCreateDateTime
boolean
Default: false
moduleConfigId
string or null
Default: null
excludedFields
Array of strings or null
Default: null
normalQuestionnaires
boolean or null
Default: null
excludeModuleIds
Array of strings or null
Default: null
unseenOnly
boolean or null
Default: null
average
boolean or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "skip": null,
  • "limit": 10000,
  • "direction": "ASC",
  • "fromDateTime": null,
  • "toDateTime": null,
  • "filters": null,
  • "status": null,
  • "useCreateDateTime": false,
  • "moduleConfigId": null,
  • "excludedFields": null,
  • "normalQuestionnaires": null,
  • "excludeModuleIds": null,
  • "unseenOnly": null,
  • "average": null
}

Response samples

Content type
application/json
{
  • "BMI": [
    ],
  • "Weight": [
    ],
  • "BodyComposition": [
    ]
}

Retrieve KCCQ results

post
URL: /api/extensions/v1/user/{user_id}/module-result/KCCQ/search
path Parameters
user_id
required
string
Request Body schema: application/json
skip
integer or null
Default: null
limit
integer
Default: 10000
direction
string or null
Default: null
Enum: "ASC" "DESC" null
fromDateTime
string or null <date-time>
Default: null
toDateTime
string or null <date-time>
Default: null
object or null
Default: null
status
string or null
Default: null
useCreateDateTime
boolean
Default: false
moduleConfigId
string or null
Default: null
excludedFields
Array of strings or null
Default: null
normalQuestionnaires
boolean or null
Default: null
excludeModuleIds
Array of strings or null
Default: null
unseenOnly
boolean or null
Default: null
average
boolean or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "skip": null,
  • "limit": 10000,
  • "direction": "ASC",
  • "fromDateTime": null,
  • "toDateTime": null,
  • "filters": null,
  • "status": null,
  • "useCreateDateTime": false,
  • "moduleConfigId": null,
  • "excludedFields": null,
  • "normalQuestionnaires": null,
  • "excludeModuleIds": null,
  • "unseenOnly": null,
  • "average": null
}

Response samples

Content type
application/json
{
  • "KCCQ": [
    ],
  • "Questionnaire": [
    ]
}

Retrieve KOOS results

post
URL: /api/extensions/v1/user/{user_id}/module-result/KOOS/search
path Parameters
user_id
required
string
Request Body schema: application/json
skip
integer or null
Default: null
limit
integer
Default: 10000
direction
string or null
Default: null
Enum: "ASC" "DESC" null
fromDateTime
string or null <date-time>
Default: null
toDateTime
string or null <date-time>
Default: null
object or null
Default: null
status
string or null
Default: null
useCreateDateTime
boolean
Default: false
moduleConfigId
string or null
Default: null
excludedFields
Array of strings or null
Default: null
normalQuestionnaires
boolean or null
Default: null
excludeModuleIds
Array of strings or null
Default: null
unseenOnly
boolean or null
Default: null
average
boolean or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "skip": null,
  • "limit": 10000,
  • "direction": "ASC",
  • "fromDateTime": null,
  • "toDateTime": null,
  • "filters": null,
  • "status": null,
  • "useCreateDateTime": false,
  • "moduleConfigId": null,
  • "excludedFields": null,
  • "normalQuestionnaires": null,
  • "excludeModuleIds": null,
  • "unseenOnly": null,
  • "average": null
}

Response samples

Content type
application/json
{
  • "Questionnaire": [
    ],
  • "KOOS": [
    ],
  • "WOMAC": [
    ]
}

Retrieve OACS results

post
URL: /api/extensions/v1/user/{user_id}/module-result/OACS/search
path Parameters
user_id
required
string
Request Body schema: application/json
skip
integer or null
Default: null
limit
integer
Default: 10000
direction
string or null
Default: null
Enum: "ASC" "DESC" null
fromDateTime
string or null <date-time>
Default: null
toDateTime
string or null <date-time>
Default: null
object or null
Default: null
status
string or null
Default: null
useCreateDateTime
boolean
Default: false
moduleConfigId
string or null
Default: null
excludedFields
Array of strings or null
Default: null
normalQuestionnaires
boolean or null
Default: null
excludeModuleIds
Array of strings or null
Default: null
unseenOnly
boolean or null
Default: null
average
boolean or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "skip": null,
  • "limit": 10000,
  • "direction": "ASC",
  • "fromDateTime": null,
  • "toDateTime": null,
  • "filters": null,
  • "status": null,
  • "useCreateDateTime": false,
  • "moduleConfigId": null,
  • "excludedFields": null,
  • "normalQuestionnaires": null,
  • "excludeModuleIds": null,
  • "unseenOnly": null,
  • "average": null
}

Response samples

Content type
application/json
{
  • "Questionnaire": [
    ],
  • "OACS": [
    ]
}

Retrieve OARS results

post
URL: /api/extensions/v1/user/{user_id}/module-result/OARS/search
path Parameters
user_id
required
string
Request Body schema: application/json
skip
integer or null
Default: null
limit
integer
Default: 10000
direction
string or null
Default: null
Enum: "ASC" "DESC" null
fromDateTime
string or null <date-time>
Default: null
toDateTime
string or null <date-time>
Default: null
object or null
Default: null
status
string or null
Default: null
useCreateDateTime
boolean
Default: false
moduleConfigId
string or null
Default: null
excludedFields
Array of strings or null
Default: null
normalQuestionnaires
boolean or null
Default: null
excludeModuleIds
Array of strings or null
Default: null
unseenOnly
boolean or null
Default: null
average
boolean or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "skip": null,
  • "limit": 10000,
  • "direction": "ASC",
  • "fromDateTime": null,
  • "toDateTime": null,
  • "filters": null,
  • "status": null,
  • "useCreateDateTime": false,
  • "moduleConfigId": null,
  • "excludedFields": null,
  • "normalQuestionnaires": null,
  • "excludeModuleIds": null,
  • "unseenOnly": null,
  • "average": null
}

Response samples

Content type
application/json
{
  • "Questionnaire": [
    ],
  • "OARS": [
    ]
}

Retrieve SF36 results

post
URL: /api/extensions/v1/user/{user_id}/module-result/SF36/search
path Parameters
user_id
required
string
Request Body schema: application/json
skip
integer or null
Default: null
limit
integer
Default: 10000
direction
string or null
Default: null
Enum: "ASC" "DESC" null
fromDateTime
string or null <date-time>
Default: null
toDateTime
string or null <date-time>
Default: null
object or null
Default: null
status
string or null
Default: null
useCreateDateTime
boolean
Default: false
moduleConfigId
string or null
Default: null
excludedFields
Array of strings or null
Default: null
normalQuestionnaires
boolean or null
Default: null
excludeModuleIds
Array of strings or null
Default: null
unseenOnly
boolean or null
Default: null
average
boolean or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "skip": null,
  • "limit": 10000,
  • "direction": "ASC",
  • "fromDateTime": null,
  • "toDateTime": null,
  • "filters": null,
  • "status": null,
  • "useCreateDateTime": false,
  • "moduleConfigId": null,
  • "excludedFields": null,
  • "normalQuestionnaires": null,
  • "excludeModuleIds": null,
  • "unseenOnly": null,
  • "average": null
}

Response samples

Content type
application/json
{
  • "SF36": [
    ],
  • "Questionnaire": [
    ]
}

Retrieve Step results

post
URL: /api/extensions/v1/user/{user_id}/module-result/Step/search
path Parameters
user_id
required
string
Request Body schema: application/json
skip
integer or null
Default: null
limit
integer
Default: 10000
direction
string or null
Default: null
Enum: "ASC" "DESC" null
fromDateTime
string or null <date-time>
Default: null
toDateTime
string or null <date-time>
Default: null
object or null
Default: null
status
string or null
Default: null
useCreateDateTime
boolean
Default: false
moduleConfigId
string or null
Default: null
excludedFields
Array of strings or null
Default: null
normalQuestionnaires
boolean or null
Default: null
excludeModuleIds
Array of strings or null
Default: null
unseenOnly
boolean or null
Default: null
average
boolean or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "skip": null,
  • "limit": 10000,
  • "direction": "ASC",
  • "fromDateTime": null,
  • "toDateTime": null,
  • "filters": null,
  • "status": null,
  • "useCreateDateTime": false,
  • "moduleConfigId": null,
  • "excludedFields": null,
  • "normalQuestionnaires": null,
  • "excludeModuleIds": null,
  • "unseenOnly": null,
  • "average": null
}

Response samples

Content type
application/json
{
  • "Step": [
    ]
}

Retrieve Photo results

post
URL: /api/extensions/v1/user/{user_id}/module-result/Photo/search
path Parameters
user_id
required
string
Request Body schema: application/json
skip
integer or null
Default: null
limit
integer
Default: 10000
direction
string or null
Default: null
Enum: "ASC" "DESC" null
fromDateTime
string or null <date-time>
Default: null
toDateTime
string or null <date-time>
Default: null
object or null
Default: null
status
string or null
Default: null
useCreateDateTime
boolean
Default: false
moduleConfigId
string or null
Default: null
excludedFields
Array of strings or null
Default: null
normalQuestionnaires
boolean or null
Default: null
excludeModuleIds
Array of strings or null
Default: null
unseenOnly
boolean or null
Default: null
average
boolean or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "skip": null,
  • "limit": 10000,
  • "direction": "ASC",
  • "fromDateTime": null,
  • "toDateTime": null,
  • "filters": null,
  • "status": null,
  • "useCreateDateTime": false,
  • "moduleConfigId": null,
  • "excludedFields": null,
  • "normalQuestionnaires": null,
  • "excludeModuleIds": null,
  • "unseenOnly": null,
  • "average": null
}

Response samples

Content type
application/json
{
  • "Photo": [
    ]
}

Retrieve Sleep results

post
URL: /api/extensions/v1/user/{user_id}/module-result/Sleep/search
path Parameters
user_id
required
string
Request Body schema: application/json
skip
integer or null
Default: null
limit
integer
Default: 10000
direction
string or null
Default: null
Enum: "ASC" "DESC" null
fromDateTime
string or null <date-time>
Default: null
toDateTime
string or null <date-time>
Default: null
object or null
Default: null
status
string or null
Default: null
useCreateDateTime
boolean
Default: false
moduleConfigId
string or null
Default: null
excludedFields
Array of strings or null
Default: null
normalQuestionnaires
boolean or null
Default: null
excludeModuleIds
Array of strings or null
Default: null
unseenOnly
boolean or null
Default: null
average
boolean or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "skip": null,
  • "limit": 10000,
  • "direction": "ASC",
  • "fromDateTime": null,
  • "toDateTime": null,
  • "filters": null,
  • "status": null,
  • "useCreateDateTime": false,
  • "moduleConfigId": null,
  • "excludedFields": null,
  • "normalQuestionnaires": null,
  • "excludeModuleIds": null,
  • "unseenOnly": null,
  • "average": null
}

Response samples

Content type
application/json
{
  • "Sleep": [
    ]
}

Retrieve VR_12 results

post
URL: /api/extensions/v1/user/{user_id}/module-result/VR_12/search
path Parameters
user_id
required
string
Request Body schema: application/json
skip
integer or null
Default: null
limit
integer
Default: 10000
direction
string or null
Default: null
Enum: "ASC" "DESC" null
fromDateTime
string or null <date-time>
Default: null
toDateTime
string or null <date-time>
Default: null
object or null
Default: null
status
string or null
Default: null
useCreateDateTime
boolean
Default: false
moduleConfigId
string or null
Default: null
excludedFields
Array of strings or null
Default: null
normalQuestionnaires
boolean or null
Default: null
excludeModuleIds
Array of strings or null
Default: null
unseenOnly
boolean or null
Default: null
average
boolean or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "skip": null,
  • "limit": 10000,
  • "direction": "ASC",
  • "fromDateTime": null,
  • "toDateTime": null,
  • "filters": null,
  • "status": null,
  • "useCreateDateTime": false,
  • "moduleConfigId": null,
  • "excludedFields": null,
  • "normalQuestionnaires": null,
  • "excludeModuleIds": null,
  • "unseenOnly": null,
  • "average": null
}

Response samples

Content type
application/json
{
  • "VR_12": [
    ],
  • "Questionnaire": [
    ]
}

Retrieve EQ5D5L results

post
URL: /api/extensions/v1/user/{user_id}/module-result/EQ5D5L/search
path Parameters
user_id
required
string
Request Body schema: application/json
skip
integer or null
Default: null
limit
integer
Default: 10000
direction
string or null
Default: null
Enum: "ASC" "DESC" null
fromDateTime
string or null <date-time>
Default: null
toDateTime
string or null <date-time>
Default: null
object or null
Default: null
status
string or null
Default: null
useCreateDateTime
boolean
Default: false
moduleConfigId
string or null
Default: null
excludedFields
Array of strings or null
Default: null
normalQuestionnaires
boolean or null
Default: null
excludeModuleIds
Array of strings or null
Default: null
unseenOnly
boolean or null
Default: null
average
boolean or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "skip": null,
  • "limit": 10000,
  • "direction": "ASC",
  • "fromDateTime": null,
  • "toDateTime": null,
  • "filters": null,
  • "status": null,
  • "useCreateDateTime": false,
  • "moduleConfigId": null,
  • "excludedFields": null,
  • "normalQuestionnaires": null,
  • "excludeModuleIds": null,
  • "unseenOnly": null,
  • "average": null
}

Response samples

Content type
application/json
{
  • "EQ5D5L": [
    ],
  • "Questionnaire": [
    ]
}

Retrieve FJSHip results

post
URL: /api/extensions/v1/user/{user_id}/module-result/FJSHip/search
path Parameters
user_id
required
string
Request Body schema: application/json
skip
integer or null
Default: null
limit
integer
Default: 10000
direction
string or null
Default: null
Enum: "ASC" "DESC" null
fromDateTime
string or null <date-time>
Default: null
toDateTime
string or null <date-time>
Default: null
object or null
Default: null
status
string or null
Default: null
useCreateDateTime
boolean
Default: false
moduleConfigId
string or null
Default: null
excludedFields
Array of strings or null
Default: null
normalQuestionnaires
boolean or null
Default: null
excludeModuleIds
Array of strings or null
Default: null
unseenOnly
boolean or null
Default: null
average
boolean or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "skip": null,
  • "limit": 10000,
  • "direction": "ASC",
  • "fromDateTime": null,
  • "toDateTime": null,
  • "filters": null,
  • "status": null,
  • "useCreateDateTime": false,
  • "moduleConfigId": null,
  • "excludedFields": null,
  • "normalQuestionnaires": null,
  • "excludeModuleIds": null,
  • "unseenOnly": null,
  • "average": null
}

Response samples

Content type
application/json
{
  • "Questionnaire": [
    ]
}

Retrieve Height results

post
URL: /api/extensions/v1/user/{user_id}/module-result/Height/search
path Parameters
user_id
required
string
Request Body schema: application/json
skip
integer or null
Default: null
limit
integer
Default: 10000
direction
string or null
Default: null
Enum: "ASC" "DESC" null
fromDateTime
string or null <date-time>
Default: null
toDateTime
string or null <date-time>
Default: null
object or null
Default: null
status
string or null
Default: null
useCreateDateTime
boolean
Default: false
moduleConfigId
string or null
Default: null
excludedFields
Array of strings or null
Default: null
normalQuestionnaires
boolean or null
Default: null
excludeModuleIds
Array of strings or null
Default: null
unseenOnly
boolean or null
Default: null
average
boolean or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "skip": null,
  • "limit": 10000,
  • "direction": "ASC",
  • "fromDateTime": null,
  • "toDateTime": null,
  • "filters": null,
  • "status": null,
  • "useCreateDateTime": false,
  • "moduleConfigId": null,
  • "excludedFields": null,
  • "normalQuestionnaires": null,
  • "excludeModuleIds": null,
  • "unseenOnly": null,
  • "average": null
}

Response samples

Content type
application/json
{
  • "Height": [
    ]
}

Retrieve Weight results

post
URL: /api/extensions/v1/user/{user_id}/module-result/Weight/search
path Parameters
user_id
required
string
Request Body schema: application/json
skip
integer or null
Default: null
limit
integer
Default: 10000
direction
string or null
Default: null
Enum: "ASC" "DESC" null
fromDateTime
string or null <date-time>
Default: null
toDateTime
string or null <date-time>
Default: null
object or null
Default: null
status
string or null
Default: null
useCreateDateTime
boolean
Default: false
moduleConfigId
string or null
Default: null
excludedFields
Array of strings or null
Default: null
normalQuestionnaires
boolean or null
Default: null
excludeModuleIds
Array of strings or null
Default: null
unseenOnly
boolean or null
Default: null
average
boolean or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "skip": null,
  • "limit": 10000,
  • "direction": "ASC",
  • "fromDateTime": null,
  • "toDateTime": null,
  • "filters": null,
  • "status": null,
  • "useCreateDateTime": false,
  • "moduleConfigId": null,
  • "excludedFields": null,
  • "normalQuestionnaires": null,
  • "excludeModuleIds": null,
  • "unseenOnly": null,
  • "average": null
}

Response samples

Content type
application/json
{
  • "Weight": [
    ]
}

Retrieve MG_ADL results

post
URL: /api/extensions/v1/user/{user_id}/module-result/MG_ADL/search
path Parameters
user_id
required
string
Request Body schema: application/json
skip
integer or null
Default: null
limit
integer
Default: 10000
direction
string or null
Default: null
Enum: "ASC" "DESC" null
fromDateTime
string or null <date-time>
Default: null
toDateTime
string or null <date-time>
Default: null
object or null
Default: null
status
string or null
Default: null
useCreateDateTime
boolean
Default: false
moduleConfigId
string or null
Default: null
excludedFields
Array of strings or null
Default: null
normalQuestionnaires
boolean or null
Default: null
excludeModuleIds
Array of strings or null
Default: null
unseenOnly
boolean or null
Default: null
average
boolean or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "skip": null,
  • "limit": 10000,
  • "direction": "ASC",
  • "fromDateTime": null,
  • "toDateTime": null,
  • "filters": null,
  • "status": null,
  • "useCreateDateTime": false,
  • "moduleConfigId": null,
  • "excludedFields": null,
  • "normalQuestionnaires": null,
  • "excludeModuleIds": null,
  • "unseenOnly": null,
  • "average": null
}

Response samples

Content type
application/json
{
  • "MG_ADL": [
    ],
  • "Questionnaire": [
    ]
}

Retrieve Ptosis results

post
URL: /api/extensions/v1/user/{user_id}/module-result/Ptosis/search
path Parameters
user_id
required
string
Request Body schema: application/json
skip
integer or null
Default: null
limit
integer
Default: 10000
direction
string or null
Default: null
Enum: "ASC" "DESC" null
fromDateTime
string or null <date-time>
Default: null
toDateTime
string or null <date-time>
Default: null
object or null
Default: null
status
string or null
Default: null
useCreateDateTime
boolean
Default: false
moduleConfigId
string or null
Default: null
excludedFields
Array of strings or null
Default: null
normalQuestionnaires
boolean or null
Default: null
excludeModuleIds
Array of strings or null
Default: null
unseenOnly
boolean or null
Default: null
average
boolean or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "skip": null,
  • "limit": 10000,
  • "direction": "ASC",
  • "fromDateTime": null,
  • "toDateTime": null,
  • "filters": null,
  • "status": null,
  • "useCreateDateTime": false,
  • "moduleConfigId": null,
  • "excludedFields": null,
  • "normalQuestionnaires": null,
  • "excludeModuleIds": null,
  • "unseenOnly": null,
  • "average": null
}

Response samples

Content type
application/json
{
  • "Ptosis": [
    ]
}

Retrieve FJSKnee results

post
URL: /api/extensions/v1/user/{user_id}/module-result/FJSKnee/search
path Parameters
user_id
required
string
Request Body schema: application/json
skip
integer or null
Default: null
limit
integer
Default: 10000
direction
string or null
Default: null
Enum: "ASC" "DESC" null
fromDateTime
string or null <date-time>
Default: null
toDateTime
string or null <date-time>
Default: null
object or null
Default: null
status
string or null
Default: null
useCreateDateTime
boolean
Default: false
moduleConfigId
string or null
Default: null
excludedFields
Array of strings or null
Default: null
normalQuestionnaires
boolean or null
Default: null
excludeModuleIds
Array of strings or null
Default: null
unseenOnly
boolean or null
Default: null
average
boolean or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "skip": null,
  • "limit": 10000,
  • "direction": "ASC",
  • "fromDateTime": null,
  • "toDateTime": null,
  • "filters": null,
  • "status": null,
  • "useCreateDateTime": false,
  • "moduleConfigId": null,
  • "excludedFields": null,
  • "normalQuestionnaires": null,
  • "excludeModuleIds": null,
  • "unseenOnly": null,
  • "average": null
}

Response samples

Content type
application/json
{
  • "Questionnaire": [
    ]
}

Retrieve Journal results

post
URL: /api/extensions/v1/user/{user_id}/module-result/Journal/search
path Parameters
user_id
required
string
Request Body schema: application/json
skip
integer or null
Default: null
limit
integer
Default: 10000
direction
string or null
Default: null
Enum: "ASC" "DESC" null
fromDateTime
string or null <date-time>
Default: null
toDateTime
string or null <date-time>
Default: null
object or null
Default: null
status
string or null
Default: null
useCreateDateTime
boolean
Default: false
moduleConfigId
string or null
Default: null
excludedFields
Array of strings or null
Default: null
normalQuestionnaires
boolean or null
Default: null
excludeModuleIds
Array of strings or null
Default: null
unseenOnly
boolean or null
Default: null
average
boolean or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "skip": null,
  • "limit": 10000,
  • "direction": "ASC",
  • "fromDateTime": null,
  • "toDateTime": null,
  • "filters": null,
  • "status": null,
  • "useCreateDateTime": false,
  • "moduleConfigId": null,
  • "excludedFields": null,
  • "normalQuestionnaires": null,
  • "excludeModuleIds": null,
  • "unseenOnly": null,
  • "average": null
}

Response samples

Content type
application/json
{
  • "Journal": [
    ]
}

Retrieve NORFOLK results

post
URL: /api/extensions/v1/user/{user_id}/module-result/NORFOLK/search
path Parameters
user_id
required
string
Request Body schema: application/json
skip
integer or null
Default: null
limit
integer
Default: 10000
direction
string or null
Default: null
Enum: "ASC" "DESC" null
fromDateTime
string or null <date-time>
Default: null
toDateTime
string or null <date-time>
Default: null
object or null
Default: null
status
string or null
Default: null
useCreateDateTime
boolean
Default: false
moduleConfigId
string or null
Default: null
excludedFields
Array of strings or null
Default: null
normalQuestionnaires
boolean or null
Default: null
excludeModuleIds
Array of strings or null
Default: null
unseenOnly
boolean or null
Default: null
average
boolean or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "skip": null,
  • "limit": 10000,
  • "direction": "ASC",
  • "fromDateTime": null,
  • "toDateTime": null,
  • "filters": null,
  • "status": null,
  • "useCreateDateTime": false,
  • "moduleConfigId": null,
  • "excludedFields": null,
  • "normalQuestionnaires": null,
  • "excludeModuleIds": null,
  • "unseenOnly": null,
  • "average": null
}

Response samples

Content type
application/json
{
  • "Questionnaire": [
    ],
  • "NORFOLK": [
    ]
}

Retrieve Symptom results

post
URL: /api/extensions/v1/user/{user_id}/module-result/Symptom/search
path Parameters
user_id
required
string
Request Body schema: application/json
skip
integer or null
Default: null
limit
integer
Default: 10000
direction
string or null
Default: null
Enum: "ASC" "DESC" null
fromDateTime
string or null <date-time>
Default: null
toDateTime
string or null <date-time>
Default: null
object or null
Default: null
status
string or null
Default: null
useCreateDateTime
boolean
Default: false
moduleConfigId
string or null
Default: null
excludedFields
Array of strings or null
Default: null
normalQuestionnaires
boolean or null
Default: null
excludeModuleIds
Array of strings or null
Default: null
unseenOnly
boolean or null
Default: null
average
boolean or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "skip": null,
  • "limit": 10000,
  • "direction": "ASC",
  • "fromDateTime": null,
  • "toDateTime": null,
  • "filters": null,
  • "status": null,
  • "useCreateDateTime": false,
  • "moduleConfigId": null,
  • "excludedFields": null,
  • "normalQuestionnaires": null,
  • "excludeModuleIds": null,
  • "unseenOnly": null,
  • "average": null
}

Response samples

Content type
application/json
{
  • "Symptom": [
    ]
}

Retrieve PeakFlow results

post
URL: /api/extensions/v1/user/{user_id}/module-result/PeakFlow/search
path Parameters
user_id
required
string
Request Body schema: application/json
skip
integer or null
Default: null
limit
integer
Default: 10000
direction
string or null
Default: null
Enum: "ASC" "DESC" null
fromDateTime
string or null <date-time>
Default: null
toDateTime
string or null <date-time>
Default: null
object or null
Default: null
status
string or null
Default: null
useCreateDateTime
boolean
Default: false
moduleConfigId
string or null
Default: null
excludedFields
Array of strings or null
Default: null
normalQuestionnaires
boolean or null
Default: null
excludeModuleIds
Array of strings or null
Default: null
unseenOnly
boolean or null
Default: null
average
boolean or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "skip": null,
  • "limit": 10000,
  • "direction": "ASC",
  • "fromDateTime": null,
  • "toDateTime": null,
  • "filters": null,
  • "status": null,
  • "useCreateDateTime": false,
  • "moduleConfigId": null,
  • "excludedFields": null,
  • "normalQuestionnaires": null,
  • "excludeModuleIds": null,
  • "unseenOnly": null,
  • "average": null
}

Response samples

Content type
application/json
{
  • "PeakFlow": [
    ]
}

Retrieve Breathing results

post
URL: /api/extensions/v1/user/{user_id}/module-result/Breathing/search
path Parameters
user_id
required
string
Request Body schema: application/json
skip
integer or null
Default: null
limit
integer
Default: 10000
direction
string or null
Default: null
Enum: "ASC" "DESC" null
fromDateTime
string or null <date-time>
Default: null
toDateTime
string or null <date-time>
Default: null
object or null
Default: null
status
string or null
Default: null
useCreateDateTime
boolean
Default: false
moduleConfigId
string or null
Default: null
excludedFields
Array of strings or null
Default: null
normalQuestionnaires
boolean or null
Default: null
excludeModuleIds
Array of strings or null
Default: null
unseenOnly
boolean or null
Default: null
average
boolean or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "skip": null,
  • "limit": 10000,
  • "direction": "ASC",
  • "fromDateTime": null,
  • "toDateTime": null,
  • "filters": null,
  • "status": null,
  • "useCreateDateTime": false,
  • "moduleConfigId": null,
  • "excludedFields": null,
  • "normalQuestionnaires": null,
  • "excludeModuleIds": null,
  • "unseenOnly": null,
  • "average": null
}

Response samples

Content type
application/json
{
  • "SensorCapture": [
    ]
}

Retrieve DashScore results

post
URL: /api/extensions/v1/user/{user_id}/module-result/DashScore/search
path Parameters
user_id
required
string
Request Body schema: application/json
skip
integer or null
Default: null
limit
integer
Default: 10000
direction
string or null
Default: null
Enum: "ASC" "DESC" null
fromDateTime
string or null <date-time>
Default: null
toDateTime
string or null <date-time>
Default: null
object or null
Default: null
status
string or null
Default: null
useCreateDateTime
boolean
Default: false
moduleConfigId
string or null
Default: null
excludedFields
Array of strings or null
Default: null
normalQuestionnaires
boolean or null
Default: null
excludeModuleIds
Array of strings or null
Default: null
unseenOnly
boolean or null
Default: null
average
boolean or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "skip": null,
  • "limit": 10000,
  • "direction": "ASC",
  • "fromDateTime": null,
  • "toDateTime": null,
  • "filters": null,
  • "status": null,
  • "useCreateDateTime": false,
  • "moduleConfigId": null,
  • "excludedFields": null,
  • "normalQuestionnaires": null,
  • "excludeModuleIds": null,
  • "unseenOnly": null,
  • "average": null
}

Response samples

Content type
application/json
{
  • "DashScore": [
    ],
  • "Questionnaire": [
    ]
}

Retrieve HeartRate results

post
URL: /api/extensions/v1/user/{user_id}/module-result/HeartRate/search
path Parameters
user_id
required
string
Request Body schema: application/json
skip
integer or null
Default: null
limit
integer
Default: 10000
direction
string or null
Default: null
Enum: "ASC" "DESC" null
fromDateTime
string or null <date-time>
Default: null
toDateTime
string or null <date-time>
Default: null
object or null
Default: null
status
string or null
Default: null
useCreateDateTime
boolean
Default: false
moduleConfigId
string or null
Default: null
excludedFields
Array of strings or null
Default: null
normalQuestionnaires
boolean or null
Default: null
excludeModuleIds
Array of strings or null
Default: null
unseenOnly
boolean or null
Default: null
average
boolean or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "skip": null,
  • "limit": 10000,
  • "direction": "ASC",
  • "fromDateTime": null,
  • "toDateTime": null,
  • "filters": null,
  • "status": null,
  • "useCreateDateTime": false,
  • "moduleConfigId": null,
  • "excludedFields": null,
  • "normalQuestionnaires": null,
  • "excludeModuleIds": null,
  • "unseenOnly": null,
  • "average": null
}

Response samples

Content type
application/json
{
  • "HeartRate": [
    ],
  • "FitbitHRV": [
    ]
}

Retrieve SymptomV2 results

post
URL: /api/extensions/v1/user/{user_id}/module-result/SymptomV2/search
path Parameters
user_id
required
string
Request Body schema: application/json
skip
integer or null
Default: null
limit
integer
Default: 10000
direction
string or null
Default: null
Enum: "ASC" "DESC" null
fromDateTime
string or null <date-time>
Default: null
toDateTime
string or null <date-time>
Default: null
object or null
Default: null
status
string or null
Default: null
useCreateDateTime
boolean
Default: false
moduleConfigId
string or null
Default: null
excludedFields
Array of strings or null
Default: null
normalQuestionnaires
boolean or null
Default: null
excludeModuleIds
Array of strings or null
Default: null
unseenOnly
boolean or null
Default: null
average
boolean or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "skip": null,
  • "limit": 10000,
  • "direction": "ASC",
  • "fromDateTime": null,
  • "toDateTime": null,
  • "filters": null,
  • "status": null,
  • "useCreateDateTime": false,
  • "moduleConfigId": null,
  • "excludedFields": null,
  • "normalQuestionnaires": null,
  • "excludeModuleIds": null,
  • "unseenOnly": null,
  • "average": null
}

Response samples

Content type
application/json
{
  • "Symptom": [
    ],
  • "Questionnaire": [
    ]
}

Retrieve AirQuality results

post
URL: /api/extensions/v1/user/{user_id}/module-result/AirQuality/search
path Parameters
user_id
required
string
Request Body schema: application/json
skip
integer or null
Default: null
limit
integer
Default: 10000
direction
string or null
Default: null
Enum: "ASC" "DESC" null
fromDateTime
string or null <date-time>
Default: null
toDateTime
string or null <date-time>
Default: null
object or null
Default: null
status
string or null
Default: null
useCreateDateTime
boolean
Default: false
moduleConfigId
string or null
Default: null
excludedFields
Array of strings or null
Default: null
normalQuestionnaires
boolean or null
Default: null
excludeModuleIds
Array of strings or null
Default: null
unseenOnly
boolean or null
Default: null
average
boolean or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "skip": null,
  • "limit": 10000,
  • "direction": "ASC",
  • "fromDateTime": null,
  • "toDateTime": null,
  • "filters": null,
  • "status": null,
  • "useCreateDateTime": false,
  • "moduleConfigId": null,
  • "excludedFields": null,
  • "normalQuestionnaires": null,
  • "excludeModuleIds": null,
  • "unseenOnly": null,
  • "average": null
}

Response samples

Content type
application/json
{
  • "AirQualityIndex": [
    ]
}

Retrieve RevereTest results

post
URL: /api/extensions/v1/user/{user_id}/module-result/RevereTest/search
path Parameters
user_id
required
string
Request Body schema: application/json
skip
integer or null
Default: null
limit
integer
Default: 10000
direction
string or null
Default: null
Enum: "ASC" "DESC" null
fromDateTime
string or null <date-time>
Default: null
toDateTime
string or null <date-time>
Default: null
object or null
Default: null
status
string or null
Default: null
useCreateDateTime
boolean
Default: false
moduleConfigId
string or null
Default: null
excludedFields
Array of strings or null
Default: null
normalQuestionnaires
boolean or null
Default: null
excludeModuleIds
Array of strings or null
Default: null
unseenOnly
boolean or null
Default: null
average
boolean or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "skip": null,
  • "limit": 10000,
  • "direction": "ASC",
  • "fromDateTime": null,
  • "toDateTime": null,
  • "filters": null,
  • "status": null,
  • "useCreateDateTime": false,
  • "moduleConfigId": null,
  • "excludedFields": null,
  • "normalQuestionnaires": null,
  • "excludeModuleIds": null,
  • "unseenOnly": null,
  • "average": null
}

Response samples

Content type
application/json
{
  • "RevereTest": [
    ]
}

Retrieve ArmFatigue results

post
URL: /api/extensions/v1/user/{user_id}/module-result/ArmFatigue/search
path Parameters
user_id
required
string
Request Body schema: application/json
skip
integer or null
Default: null
limit
integer
Default: 10000
direction
string or null
Default: null
Enum: "ASC" "DESC" null
fromDateTime
string or null <date-time>
Default: null
toDateTime
string or null <date-time>
Default: null
object or null
Default: null
status
string or null
Default: null
useCreateDateTime
boolean
Default: false
moduleConfigId
string or null
Default: null
excludedFields
Array of strings or null
Default: null
normalQuestionnaires
boolean or null
Default: null
excludeModuleIds
Array of strings or null
Default: null
unseenOnly
boolean or null
Default: null
average
boolean or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "skip": null,
  • "limit": 10000,
  • "direction": "ASC",
  • "fromDateTime": null,
  • "toDateTime": null,
  • "filters": null,
  • "status": null,
  • "useCreateDateTime": false,
  • "moduleConfigId": null,
  • "excludedFields": null,
  • "normalQuestionnaires": null,
  • "excludeModuleIds": null,
  • "unseenOnly": null,
  • "average": null
}

Response samples

Content type
application/json
{
  • "ArmFatigue": [
    ]
}

Retrieve ECGAliveCor results

post
URL: /api/extensions/v1/user/{user_id}/module-result/ECGAliveCor/search
path Parameters
user_id
required
string
Request Body schema: application/json
skip
integer or null
Default: null
limit
integer
Default: 10000
direction
string or null
Default: null
Enum: "ASC" "DESC" null
fromDateTime
string or null <date-time>
Default: null
toDateTime
string or null <date-time>
Default: null
object or null
Default: null
status
string or null
Default: null
useCreateDateTime
boolean
Default: false
moduleConfigId
string or null
Default: null
excludedFields
Array of strings or null
Default: null
normalQuestionnaires
boolean or null
Default: null
excludeModuleIds
Array of strings or null
Default: null
unseenOnly
boolean or null
Default: null
average
boolean or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "skip": null,
  • "limit": 10000,
  • "direction": "ASC",
  • "fromDateTime": null,
  • "toDateTime": null,
  • "filters": null,
  • "status": null,
  • "useCreateDateTime": false,
  • "moduleConfigId": null,
  • "excludedFields": null,
  • "normalQuestionnaires": null,
  • "excludeModuleIds": null,
  • "unseenOnly": null,
  • "average": null
}

Response samples

Content type
application/json
{
  • "ECGAliveCor": [
    ]
}

Retrieve HealthScore results

post
URL: /api/extensions/v1/user/{user_id}/module-result/HealthScore/search
path Parameters
user_id
required
string
Request Body schema: application/json
skip
integer or null
Default: null
limit
integer
Default: 10000
direction
string or null
Default: null
Enum: "ASC" "DESC" null
fromDateTime
string or null <date-time>
Default: null
toDateTime
string or null <date-time>
Default: null
object or null
Default: null
status
string or null
Default: null
useCreateDateTime
boolean
Default: false
moduleConfigId
string or null
Default: null
excludedFields
Array of strings or null
Default: null
normalQuestionnaires
boolean or null
Default: null
excludeModuleIds
Array of strings or null
Default: null
unseenOnly
boolean or null
Default: null
average
boolean or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "skip": null,
  • "limit": 10000,
  • "direction": "ASC",
  • "fromDateTime": null,
  • "toDateTime": null,
  • "filters": null,
  • "status": null,
  • "useCreateDateTime": false,
  • "moduleConfigId": null,
  • "excludedFields": null,
  • "normalQuestionnaires": null,
  • "excludeModuleIds": null,
  • "unseenOnly": null,
  • "average": null
}

Response samples

Content type
application/json
{
  • "BodyMeasurement": [
    ],
  • "SelfHealthRate": [
    ],
  • "WaistToHeight": [
    ],
  • "Weight": [
    ],
  • "HeartRate": [
    ],
  • "SleepQuestions": [
    ],
  • "SmokeQuestions": [
    ],
  • "ReactionTime": [
    ],
  • "AlcoholConsumption": [
    ],
  • "NumericMemory": [
    ],
  • "HScore": [
    ]
}

Retrieve Temperature results

post
URL: /api/extensions/v1/user/{user_id}/module-result/Temperature/search
path Parameters
user_id
required
string
Request Body schema: application/json
skip
integer or null
Default: null
limit
integer
Default: 10000
direction
string or null
Default: null
Enum: "ASC" "DESC" null
fromDateTime
string or null <date-time>
Default: null
toDateTime
string or null <date-time>
Default: null
object or null
Default: null
status
string or null
Default: null
useCreateDateTime
boolean
Default: false
moduleConfigId
string or null
Default: null
excludedFields
Array of strings or null
Default: null
normalQuestionnaires
boolean or null
Default: null
excludeModuleIds
Array of strings or null
Default: null
unseenOnly
boolean or null
Default: null
average
boolean or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "skip": null,
  • "limit": 10000,
  • "direction": "ASC",
  • "fromDateTime": null,
  • "toDateTime": null,
  • "filters": null,
  • "status": null,
  • "useCreateDateTime": false,
  • "moduleConfigId": null,
  • "excludedFields": null,
  • "normalQuestionnaires": null,
  • "excludeModuleIds": null,
  • "unseenOnly": null,
  • "average": null
}

Response samples

Content type
application/json
{
  • "Temperature": [
    ]
}

Retrieve Medications results

post
URL: /api/extensions/v1/user/{user_id}/module-result/Medications/search
path Parameters
user_id
required
string
Request Body schema: application/json
skip
integer or null
Default: null
limit
integer
Default: 10000
direction
string or null
Default: null
Enum: "ASC" "DESC" null
fromDateTime
string or null <date-time>
Default: null
toDateTime
string or null <date-time>
Default: null
object or null
Default: null
status
string or null
Default: null
useCreateDateTime
boolean
Default: false
moduleConfigId
string or null
Default: null
excludedFields
Array of strings or null
Default: null
normalQuestionnaires
boolean or null
Default: null
excludeModuleIds
Array of strings or null
Default: null
unseenOnly
boolean or null
Default: null
average
boolean or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "skip": null,
  • "limit": 10000,
  • "direction": "ASC",
  • "fromDateTime": null,
  • "toDateTime": null,
  • "filters": null,
  • "status": null,
  • "useCreateDateTime": false,
  • "moduleConfigId": null,
  • "excludedFields": null,
  • "normalQuestionnaires": null,
  • "excludeModuleIds": null,
  • "unseenOnly": null,
  • "average": null
}

Response samples

Content type
application/json
{ }

Retrieve BloodGlucose results

post
URL: /api/extensions/v1/user/{user_id}/module-result/BloodGlucose/search
path Parameters
user_id
required
string
Request Body schema: application/json
skip
integer or null
Default: null
limit
integer
Default: 10000
direction
string or null
Default: null
Enum: "ASC" "DESC" null
fromDateTime
string or null <date-time>
Default: null
toDateTime
string or null <date-time>
Default: null
object or null
Default: null
status
string or null
Default: null
useCreateDateTime
boolean
Default: false
moduleConfigId
string or null
Default: null
excludedFields
Array of strings or null
Default: null
normalQuestionnaires
boolean or null
Default: null
excludeModuleIds
Array of strings or null
Default: null
unseenOnly
boolean or null
Default: null
average
boolean or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "skip": null,
  • "limit": 10000,
  • "direction": "ASC",
  • "fromDateTime": null,
  • "toDateTime": null,
  • "filters": null,
  • "status": null,
  • "useCreateDateTime": false,
  • "moduleConfigId": null,
  • "excludedFields": null,
  • "normalQuestionnaires": null,
  • "excludeModuleIds": null,
  • "unseenOnly": null,
  • "average": null
}

Response samples

Content type
application/json
{
  • "BloodGlucose": [
    ]
}

Retrieve CVDRiskScore results

post
URL: /api/extensions/v1/user/{user_id}/module-result/CVDRiskScore/search
path Parameters
user_id
required
string
Request Body schema: application/json
skip
integer or null
Default: null
limit
integer
Default: 10000
direction
string or null
Default: null
Enum: "ASC" "DESC" null
fromDateTime
string or null <date-time>
Default: null
toDateTime
string or null <date-time>
Default: null
object or null
Default: null
status
string or null
Default: null
useCreateDateTime
boolean
Default: false
moduleConfigId
string or null
Default: null
excludedFields
Array of strings or null
Default: null
normalQuestionnaires
boolean or null
Default: null
excludeModuleIds
Array of strings or null
Default: null
unseenOnly
boolean or null
Default: null
average
boolean or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "skip": null,
  • "limit": 10000,
  • "direction": "ASC",
  • "fromDateTime": null,
  • "toDateTime": null,
  • "filters": null,
  • "status": null,
  • "useCreateDateTime": false,
  • "moduleConfigId": null,
  • "excludedFields": null,
  • "normalQuestionnaires": null,
  • "excludeModuleIds": null,
  • "unseenOnly": null,
  • "average": null
}

Response samples

Content type
application/json
{
  • "Questionnaire": [
    ],
  • "CVDRiskScore": [
    ],
  • "HeartRate": [
    ],
  • "BodyMeasurement": [
    ]
}

Retrieve DailyCheckIn results

post
URL: /api/extensions/v1/user/{user_id}/module-result/DailyCheckIn/search
path Parameters
user_id
required
string
Request Body schema: application/json
skip
integer or null
Default: null
limit
integer
Default: 10000
direction
string or null
Default: null
Enum: "ASC" "DESC" null
fromDateTime
string or null <date-time>
Default: null
toDateTime
string or null <date-time>
Default: null
object or null
Default: null
status
string or null
Default: null
useCreateDateTime
boolean
Default: false
moduleConfigId
string or null
Default: null
excludedFields
Array of strings or null
Default: null
normalQuestionnaires
boolean or null
Default: null
excludeModuleIds
Array of strings or null
Default: null
unseenOnly
boolean or null
Default: null
average
boolean or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "skip": null,
  • "limit": 10000,
  • "direction": "ASC",
  • "fromDateTime": null,
  • "toDateTime": null,
  • "filters": null,
  • "status": null,
  • "useCreateDateTime": false,
  • "moduleConfigId": null,
  • "excludedFields": null,
  • "normalQuestionnaires": null,
  • "excludeModuleIds": null,
  • "unseenOnly": null,
  • "average": null
}

Response samples

Content type
application/json
{
  • "Questionnaire": [
    ]
}

Retrieve ECGHealthKit results

post
URL: /api/extensions/v1/user/{user_id}/module-result/ECGHealthKit/search
path Parameters
user_id
required
string
Request Body schema: application/json
skip
integer or null
Default: null
limit
integer
Default: 10000
direction
string or null
Default: null
Enum: "ASC" "DESC" null
fromDateTime
string or null <date-time>
Default: null
toDateTime
string or null <date-time>
Default: null
object or null
Default: null
status
string or null
Default: null
useCreateDateTime
boolean
Default: false
moduleConfigId
string or null
Default: null
excludedFields
Array of strings or null
Default: null
normalQuestionnaires
boolean or null
Default: null
excludeModuleIds
Array of strings or null
Default: null
unseenOnly
boolean or null
Default: null
average
boolean or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "skip": null,
  • "limit": 10000,
  • "direction": "ASC",
  • "fromDateTime": null,
  • "toDateTime": null,
  • "filters": null,
  • "status": null,
  • "useCreateDateTime": false,
  • "moduleConfigId": null,
  • "excludedFields": null,
  • "normalQuestionnaires": null,
  • "excludeModuleIds": null,
  • "unseenOnly": null,
  • "average": null
}

Response samples

Content type
application/json
{
  • "ECGHealthKit": [
    ]
}

Retrieve HealthStatus results

post
URL: /api/extensions/v1/user/{user_id}/module-result/HealthStatus/search
path Parameters
user_id
required
string
Request Body schema: application/json
skip
integer or null
Default: null
limit
integer
Default: 10000
direction
string or null
Default: null
Enum: "ASC" "DESC" null
fromDateTime
string or null <date-time>
Default: null
toDateTime
string or null <date-time>
Default: null
object or null
Default: null
status
string or null
Default: null
useCreateDateTime
boolean
Default: false
moduleConfigId
string or null
Default: null
excludedFields
Array of strings or null
Default: null
normalQuestionnaires
boolean or null
Default: null
excludeModuleIds
Array of strings or null
Default: null
unseenOnly
boolean or null
Default: null
average
boolean or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "skip": null,
  • "limit": 10000,
  • "direction": "ASC",
  • "fromDateTime": null,
  • "toDateTime": null,
  • "filters": null,
  • "status": null,
  • "useCreateDateTime": false,
  • "moduleConfigId": null,
  • "excludedFields": null,
  • "normalQuestionnaires": null,
  • "excludeModuleIds": null,
  • "unseenOnly": null,
  • "average": null
}

Response samples

Content type
application/json
{
  • "HealthStatus": [
    ]
}

Retrieve HeightZScore results

post
URL: /api/extensions/v1/user/{user_id}/module-result/HeightZScore/search
path Parameters
user_id
required
string
Request Body schema: application/json
skip
integer or null
Default: null
limit
integer
Default: 10000
direction
string or null
Default: null
Enum: "ASC" "DESC" null
fromDateTime
string or null <date-time>
Default: null
toDateTime
string or null <date-time>
Default: null
object or null
Default: null
status
string or null
Default: null
useCreateDateTime
boolean
Default: false
moduleConfigId
string or null
Default: null
excludedFields
Array of strings or null
Default: null
normalQuestionnaires
boolean or null
Default: null
excludeModuleIds
Array of strings or null
Default: null
unseenOnly
boolean or null
Default: null
average
boolean or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "skip": null,
  • "limit": 10000,
  • "direction": "ASC",
  • "fromDateTime": null,
  • "toDateTime": null,
  • "filters": null,
  • "status": null,
  • "useCreateDateTime": false,
  • "moduleConfigId": null,
  • "excludedFields": null,
  • "normalQuestionnaires": null,
  • "excludeModuleIds": null,
  • "unseenOnly": null,
  • "average": null
}

Response samples

Content type
application/json
{
  • "Height": [
    ]
}

Retrieve OtherVaccine results

post
URL: /api/extensions/v1/user/{user_id}/module-result/OtherVaccine/search
path Parameters
user_id
required
string
Request Body schema: application/json
skip
integer or null
Default: null
limit
integer
Default: 10000
direction
string or null
Default: null
Enum: "ASC" "DESC" null
fromDateTime
string or null <date-time>
Default: null
toDateTime
string or null <date-time>
Default: null
object or null
Default: null
status
string or null
Default: null
useCreateDateTime
boolean
Default: false
moduleConfigId
string or null
Default: null
excludedFields
Array of strings or null
Default: null
normalQuestionnaires
boolean or null
Default: null
excludeModuleIds
Array of strings or null
Default: null
unseenOnly
boolean or null
Default: null
average
boolean or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "skip": null,
  • "limit": 10000,
  • "direction": "ASC",
  • "fromDateTime": null,
  • "toDateTime": null,
  • "filters": null,
  • "status": null,
  • "useCreateDateTime": false,
  • "moduleConfigId": null,
  • "excludedFields": null,
  • "normalQuestionnaires": null,
  • "excludeModuleIds": null,
  • "unseenOnly": null,
  • "average": null
}

Response samples

Content type
application/json
{
  • "OtherVaccine": [
    ]
}

Retrieve AdditionalQoL results

post
URL: /api/extensions/v1/user/{user_id}/module-result/AdditionalQoL/search
path Parameters
user_id
required
string
Request Body schema: application/json
skip
integer or null
Default: null
limit
integer
Default: 10000
direction
string or null
Default: null
Enum: "ASC" "DESC" null
fromDateTime
string or null <date-time>
Default: null
toDateTime
string or null <date-time>
Default: null
object or null
Default: null
status
string or null
Default: null
useCreateDateTime
boolean
Default: false
moduleConfigId
string or null
Default: null
excludedFields
Array of strings or null
Default: null
normalQuestionnaires
boolean or null
Default: null
excludeModuleIds
Array of strings or null
Default: null
unseenOnly
boolean or null
Default: null
average
boolean or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "skip": null,
  • "limit": 10000,
  • "direction": "ASC",
  • "fromDateTime": null,
  • "toDateTime": null,
  • "filters": null,
  • "status": null,
  • "useCreateDateTime": false,
  • "moduleConfigId": null,
  • "excludedFields": null,
  • "normalQuestionnaires": null,
  • "excludeModuleIds": null,
  • "unseenOnly": null,
  • "average": null
}

Response samples

Content type
application/json
{
  • "AdditionalQoL": [
    ]
}

Retrieve BloodPressure results

post
URL: /api/extensions/v1/user/{user_id}/module-result/BloodPressure/search
path Parameters
user_id
required
string
Request Body schema: application/json
skip
integer or null
Default: null
limit
integer
Default: 10000
direction
string or null
Default: null
Enum: "ASC" "DESC" null
fromDateTime
string or null <date-time>
Default: null
toDateTime
string or null <date-time>
Default: null
object or null
Default: null
status
string or null
Default: null
useCreateDateTime
boolean
Default: false
moduleConfigId
string or null
Default: null
excludedFields
Array of strings or null
Default: null
normalQuestionnaires
boolean or null
Default: null
excludeModuleIds
Array of strings or null
Default: null
unseenOnly
boolean or null
Default: null
average
boolean or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "skip": null,
  • "limit": 10000,
  • "direction": "ASC",
  • "fromDateTime": null,
  • "toDateTime": null,
  • "filters": null,
  • "status": null,
  • "useCreateDateTime": false,
  • "moduleConfigId": null,
  • "excludedFields": null,
  • "normalQuestionnaires": null,
  • "excludeModuleIds": null,
  • "unseenOnly": null,
  • "average": null
}

Response samples

Content type
application/json
{
  • "BloodPressure": [
    ]
}

Retrieve LysholmTegner results

post
URL: /api/extensions/v1/user/{user_id}/module-result/LysholmTegner/search
path Parameters
user_id
required
string
Request Body schema: application/json
skip
integer or null
Default: null
limit
integer
Default: 10000
direction
string or null
Default: null
Enum: "ASC" "DESC" null
fromDateTime
string or null <date-time>
Default: null
toDateTime
string or null <date-time>
Default: null
object or null
Default: null
status
string or null
Default: null
useCreateDateTime
boolean
Default: false
moduleConfigId
string or null
Default: null
excludedFields
Array of strings or null
Default: null
normalQuestionnaires
boolean or null
Default: null
excludeModuleIds
Array of strings or null
Default: null
unseenOnly
boolean or null
Default: null
average
boolean or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "skip": null,
  • "limit": 10000,
  • "direction": "ASC",
  • "fromDateTime": null,
  • "toDateTime": null,
  • "filters": null,
  • "status": null,
  • "useCreateDateTime": false,
  • "moduleConfigId": null,
  • "excludedFields": null,
  • "normalQuestionnaires": null,
  • "excludeModuleIds": null,
  • "unseenOnly": null,
  • "average": null
}

Response samples

Content type
application/json
{
  • "Questionnaire": [
    ],
  • "Lysholm": [
    ],
  • "Tegner": [
    ]
}

Retrieve PulseOximetry results

post
URL: /api/extensions/v1/user/{user_id}/module-result/PulseOximetry/search
path Parameters
user_id
required
string
Request Body schema: application/json
skip
integer or null
Default: null
limit
integer
Default: 10000
direction
string or null
Default: null
Enum: "ASC" "DESC" null
fromDateTime
string or null <date-time>
Default: null
toDateTime
string or null <date-time>
Default: null
object or null
Default: null
status
string or null
Default: null
useCreateDateTime
boolean
Default: false
moduleConfigId
string or null
Default: null
excludedFields
Array of strings or null
Default: null
normalQuestionnaires
boolean or null
Default: null
excludeModuleIds
Array of strings or null
Default: null
unseenOnly
boolean or null
Default: null
average
boolean or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "skip": null,
  • "limit": 10000,
  • "direction": "ASC",
  • "fromDateTime": null,
  • "toDateTime": null,
  • "filters": null,
  • "status": null,
  • "useCreateDateTime": false,
  • "moduleConfigId": null,
  • "excludedFields": null,
  • "normalQuestionnaires": null,
  • "excludeModuleIds": null,
  • "unseenOnly": null,
  • "average": null
}

Response samples

Content type
application/json
{
  • "PulseOximetry": [
    ]
}

Retrieve Questionnaire results

post
URL: /api/extensions/v1/user/{user_id}/module-result/Questionnaire/search
path Parameters
user_id
required
string
Request Body schema: application/json
skip
integer or null
Default: null
limit
integer
Default: 10000
direction
string or null
Default: null
Enum: "ASC" "DESC" null
fromDateTime
string or null <date-time>
Default: null
toDateTime
string or null <date-time>
Default: null
object or null
Default: null
status
string or null
Default: null
useCreateDateTime
boolean
Default: false
moduleConfigId
string or null
Default: null
excludedFields
Array of strings or null
Default: null
normalQuestionnaires
boolean or null
Default: null
excludeModuleIds
Array of strings or null
Default: null
unseenOnly
boolean or null
Default: null
average
boolean or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "skip": null,
  • "limit": 10000,
  • "direction": "ASC",
  • "fromDateTime": null,
  • "toDateTime": null,
  • "filters": null,
  • "status": null,
  • "useCreateDateTime": false,
  • "moduleConfigId": null,
  • "excludedFields": null,
  • "normalQuestionnaires": null,
  • "excludeModuleIds": null,
  • "unseenOnly": null,
  • "average": null
}

Response samples

Content type
application/json
{
  • "Questionnaire": [
    ]
}

Retrieve WaistToHeight results

post
URL: /api/extensions/v1/user/{user_id}/module-result/WaistToHeight/search
path Parameters
user_id
required
string
Request Body schema: application/json
skip
integer or null
Default: null
limit
integer
Default: 10000
direction
string or null
Default: null
Enum: "ASC" "DESC" null
fromDateTime
string or null <date-time>
Default: null
toDateTime
string or null <date-time>
Default: null
object or null
Default: null
status
string or null
Default: null
useCreateDateTime
boolean
Default: false
moduleConfigId
string or null
Default: null
excludedFields
Array of strings or null
Default: null
normalQuestionnaires
boolean or null
Default: null
excludeModuleIds
Array of strings or null
Default: null
unseenOnly
boolean or null
Default: null
average
boolean or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "skip": null,
  • "limit": 10000,
  • "direction": "ASC",
  • "fromDateTime": null,
  • "toDateTime": null,
  • "filters": null,
  • "status": null,
  • "useCreateDateTime": false,
  • "moduleConfigId": null,
  • "excludedFields": null,
  • "normalQuestionnaires": null,
  • "excludeModuleIds": null,
  • "unseenOnly": null,
  • "average": null
}

Response samples

Content type
application/json
{
  • "WaistToHeight": [
    ]
}

Retrieve MedicationsV2 results

post
URL: /api/extensions/v1/user/{user_id}/module-result/MedicationsV2/search
path Parameters
user_id
required
string
Request Body schema: application/json
skip
integer or null
Default: null
limit
integer
Default: 10000
direction
string or null
Default: null
Enum: "ASC" "DESC" null
fromDateTime
string or null <date-time>
Default: null
toDateTime
string or null <date-time>
Default: null
object or null
Default: null
status
string or null
Default: null
useCreateDateTime
boolean
Default: false
moduleConfigId
string or null
Default: null
excludedFields
Array of strings or null
Default: null
normalQuestionnaires
boolean or null
Default: null
excludeModuleIds
Array of strings or null
Default: null
unseenOnly
boolean or null
Default: null
average
boolean or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "skip": null,
  • "limit": 10000,
  • "direction": "ASC",
  • "fromDateTime": null,
  • "toDateTime": null,
  • "filters": null,
  • "status": null,
  • "useCreateDateTime": false,
  • "moduleConfigId": null,
  • "excludedFields": null,
  • "normalQuestionnaires": null,
  • "excludeModuleIds": null,
  • "unseenOnly": null,
  • "average": null
}

Response samples

Content type
application/json
{ }

Retrieve Breathlessness results

post
URL: /api/extensions/v1/user/{user_id}/module-result/Breathlessness/search
path Parameters
user_id
required
string
Request Body schema: application/json
skip
integer or null
Default: null
limit
integer
Default: 10000
direction
string or null
Default: null
Enum: "ASC" "DESC" null
fromDateTime
string or null <date-time>
Default: null
toDateTime
string or null <date-time>
Default: null
object or null
Default: null
status
string or null
Default: null
useCreateDateTime
boolean
Default: false
moduleConfigId
string or null
Default: null
excludedFields
Array of strings or null
Default: null
normalQuestionnaires
boolean or null
Default: null
excludeModuleIds
Array of strings or null
Default: null
unseenOnly
boolean or null
Default: null
average
boolean or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "skip": null,
  • "limit": 10000,
  • "direction": "ASC",
  • "fromDateTime": null,
  • "toDateTime": null,
  • "filters": null,
  • "status": null,
  • "useCreateDateTime": false,
  • "moduleConfigId": null,
  • "excludedFields": null,
  • "normalQuestionnaires": null,
  • "excludeModuleIds": null,
  • "unseenOnly": null,
  • "average": null
}

Response samples

Content type
application/json
{
  • "Questionnaire": [
    ]
}

Retrieve KneeHealthIKDC results

post
URL: /api/extensions/v1/user/{user_id}/module-result/KneeHealthIKDC/search
path Parameters
user_id
required
string
Request Body schema: application/json
skip
integer or null
Default: null
limit
integer
Default: 10000
direction
string or null
Default: null
Enum: "ASC" "DESC" null
fromDateTime
string or null <date-time>
Default: null
toDateTime
string or null <date-time>
Default: null
object or null
Default: null
status
string or null
Default: null
useCreateDateTime
boolean
Default: false
moduleConfigId
string or null
Default: null
excludedFields
Array of strings or null
Default: null
normalQuestionnaires
boolean or null
Default: null
excludeModuleIds
Array of strings or null
Default: null
unseenOnly
boolean or null
Default: null
average
boolean or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "skip": null,
  • "limit": 10000,
  • "direction": "ASC",
  • "fromDateTime": null,
  • "toDateTime": null,
  • "filters": null,
  • "status": null,
  • "useCreateDateTime": false,
  • "moduleConfigId": null,
  • "excludedFields": null,
  • "normalQuestionnaires": null,
  • "excludeModuleIds": null,
  • "unseenOnly": null,
  • "average": null
}

Response samples

Content type
application/json
{
  • "IKDC": [
    ],
  • "Questionnaire": [
    ]
}

Retrieve InfantFollowUp results

post
URL: /api/extensions/v1/user/{user_id}/module-result/InfantFollowUp/search
path Parameters
user_id
required
string
Request Body schema: application/json
skip
integer or null
Default: null
limit
integer
Default: 10000
direction
string or null
Default: null
Enum: "ASC" "DESC" null
fromDateTime
string or null <date-time>
Default: null
toDateTime
string or null <date-time>
Default: null
object or null
Default: null
status
string or null
Default: null
useCreateDateTime
boolean
Default: false
moduleConfigId
string or null
Default: null
excludedFields
Array of strings or null
Default: null
normalQuestionnaires
boolean or null
Default: null
excludeModuleIds
Array of strings or null
Default: null
unseenOnly
boolean or null
Default: null
average
boolean or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "skip": null,
  • "limit": 10000,
  • "direction": "ASC",
  • "fromDateTime": null,
  • "toDateTime": null,
  • "filters": null,
  • "status": null,
  • "useCreateDateTime": false,
  • "moduleConfigId": null,
  • "excludedFields": null,
  • "normalQuestionnaires": null,
  • "excludeModuleIds": null,
  • "unseenOnly": null,
  • "average": null
}

Response samples

Content type
application/json
{
  • "InfantFollowUp": [
    ]
}

Retrieve MedicalHistory results

post
URL: /api/extensions/v1/user/{user_id}/module-result/MedicalHistory/search
path Parameters
user_id
required
string
Request Body schema: application/json
skip
integer or null
Default: null
limit
integer
Default: 10000
direction
string or null
Default: null
Enum: "ASC" "DESC" null
fromDateTime
string or null <date-time>
Default: null
toDateTime
string or null <date-time>
Default: null
object or null
Default: null
status
string or null
Default: null
useCreateDateTime
boolean
Default: false
moduleConfigId
string or null
Default: null
excludedFields
Array of strings or null
Default: null
normalQuestionnaires
boolean or null
Default: null
excludeModuleIds
Array of strings or null
Default: null
unseenOnly
boolean or null
Default: null
average
boolean or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "skip": null,
  • "limit": 10000,
  • "direction": "ASC",
  • "fromDateTime": null,
  • "toDateTime": null,
  • "filters": null,
  • "status": null,
  • "useCreateDateTime": false,
  • "moduleConfigId": null,
  • "excludedFields": null,
  • "normalQuestionnaires": null,
  • "excludeModuleIds": null,
  • "unseenOnly": null,
  • "average": null
}

Response samples

Content type
application/json
{
  • "MedicalHistory": [
    ]
}

Retrieve OxfordHipScore results

post
URL: /api/extensions/v1/user/{user_id}/module-result/OxfordHipScore/search
path Parameters
user_id
required
string
Request Body schema: application/json
skip
integer or null
Default: null
limit
integer
Default: 10000
direction
string or null
Default: null
Enum: "ASC" "DESC" null
fromDateTime
string or null <date-time>
Default: null
toDateTime
string or null <date-time>
Default: null
object or null
Default: null
status
string or null
Default: null
useCreateDateTime
boolean
Default: false
moduleConfigId
string or null
Default: null
excludedFields
Array of strings or null
Default: null
normalQuestionnaires
boolean or null
Default: null
excludeModuleIds
Array of strings or null
Default: null
unseenOnly
boolean or null
Default: null
average
boolean or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "skip": null,
  • "limit": 10000,
  • "direction": "ASC",
  • "fromDateTime": null,
  • "toDateTime": null,
  • "filters": null,
  • "status": null,
  • "useCreateDateTime": false,
  • "moduleConfigId": null,
  • "excludedFields": null,
  • "normalQuestionnaires": null,
  • "excludeModuleIds": null,
  • "unseenOnly": null,
  • "average": null
}

Response samples

Content type
application/json
{
  • "OxfordHipScore": [
    ]
}

Retrieve SpatialSpaniOS results

post
URL: /api/extensions/v1/user/{user_id}/module-result/SpatialSpaniOS/search
path Parameters
user_id
required
string
Request Body schema: application/json
skip
integer or null
Default: null
limit
integer
Default: 10000
direction
string or null
Default: null
Enum: "ASC" "DESC" null
fromDateTime
string or null <date-time>
Default: null
toDateTime
string or null <date-time>
Default: null
object or null
Default: null
status
string or null
Default: null
useCreateDateTime
boolean
Default: false
moduleConfigId
string or null
Default: null
excludedFields
Array of strings or null
Default: null
normalQuestionnaires
boolean or null
Default: null
excludeModuleIds
Array of strings or null
Default: null
unseenOnly
boolean or null
Default: null
average
boolean or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "skip": null,
  • "limit": 10000,
  • "direction": "ASC",
  • "fromDateTime": null,
  • "toDateTime": null,
  • "filters": null,
  • "status": null,
  • "useCreateDateTime": false,
  • "moduleConfigId": null,
  • "excludedFields": null,
  • "normalQuestionnaires": null,
  • "excludeModuleIds": null,
  • "unseenOnly": null,
  • "average": null
}

Response samples

Content type
application/json
{
  • "SpatialSpaniOS": [
    ]
}

Retrieve SurgeryDetails results

post
URL: /api/extensions/v1/user/{user_id}/module-result/SurgeryDetails/search
path Parameters
user_id
required
string
Request Body schema: application/json
skip
integer or null
Default: null
limit
integer
Default: 10000
direction
string or null
Default: null
Enum: "ASC" "DESC" null
fromDateTime
string or null <date-time>
Default: null
toDateTime
string or null <date-time>
Default: null
object or null
Default: null
status
string or null
Default: null
useCreateDateTime
boolean
Default: false
moduleConfigId
string or null
Default: null
excludedFields
Array of strings or null
Default: null
normalQuestionnaires
boolean or null
Default: null
excludeModuleIds
Array of strings or null
Default: null
unseenOnly
boolean or null
Default: null
average
boolean or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "skip": null,
  • "limit": 10000,
  • "direction": "ASC",
  • "fromDateTime": null,
  • "toDateTime": null,
  • "filters": null,
  • "status": null,
  • "useCreateDateTime": false,
  • "moduleConfigId": null,
  • "excludedFields": null,
  • "normalQuestionnaires": null,
  • "excludeModuleIds": null,
  • "unseenOnly": null,
  • "average": null
}

Response samples

Content type
application/json
{
  • "Questionnaire": [
    ]
}

Retrieve BodyMeasurement results

post
URL: /api/extensions/v1/user/{user_id}/module-result/BodyMeasurement/search
path Parameters
user_id
required
string
Request Body schema: application/json
skip
integer or null
Default: null
limit
integer
Default: 10000
direction
string or null
Default: null
Enum: "ASC" "DESC" null
fromDateTime
string or null <date-time>
Default: null
toDateTime
string or null <date-time>
Default: null
object or null
Default: null
status
string or null
Default: null
useCreateDateTime
boolean
Default: false
moduleConfigId
string or null
Default: null
excludedFields
Array of strings or null
Default: null
normalQuestionnaires
boolean or null
Default: null
excludeModuleIds
Array of strings or null
Default: null
unseenOnly
boolean or null
Default: null
average
boolean or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "skip": null,
  • "limit": 10000,
  • "direction": "ASC",
  • "fromDateTime": null,
  • "toDateTime": null,
  • "filters": null,
  • "status": null,
  • "useCreateDateTime": false,
  • "moduleConfigId": null,
  • "excludedFields": null,
  • "normalQuestionnaires": null,
  • "excludeModuleIds": null,
  • "unseenOnly": null,
  • "average": null
}

Response samples

Content type
application/json
{
  • "Questionnaire": [
    ],
  • "BodyMeasurement": [
    ]
}

Retrieve OxfordKneeScore results

post
URL: /api/extensions/v1/user/{user_id}/module-result/OxfordKneeScore/search
path Parameters
user_id
required
string
Request Body schema: application/json
skip
integer or null
Default: null
limit
integer
Default: 10000
direction
string or null
Default: null
Enum: "ASC" "DESC" null
fromDateTime
string or null <date-time>
Default: null
toDateTime
string or null <date-time>
Default: null
object or null
Default: null
status
string or null
Default: null
useCreateDateTime
boolean
Default: false
moduleConfigId
string or null
Default: null
excludedFields
Array of strings or null
Default: null
normalQuestionnaires
boolean or null
Default: null
excludeModuleIds
Array of strings or null
Default: null
unseenOnly
boolean or null
Default: null
average
boolean or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "skip": null,
  • "limit": 10000,
  • "direction": "ASC",
  • "fromDateTime": null,
  • "toDateTime": null,
  • "filters": null,
  • "status": null,
  • "useCreateDateTime": false,
  • "moduleConfigId": null,
  • "excludedFields": null,
  • "normalQuestionnaires": null,
  • "excludeModuleIds": null,
  • "unseenOnly": null,
  • "average": null
}

Response samples

Content type
application/json
{
  • "OxfordKneeScore": [
    ]
}

Retrieve PostVaccination results

post
URL: /api/extensions/v1/user/{user_id}/module-result/PostVaccination/search
path Parameters
user_id
required
string
Request Body schema: application/json
skip
integer or null
Default: null
limit
integer
Default: 10000
direction
string or null
Default: null
Enum: "ASC" "DESC" null
fromDateTime
string or null <date-time>
Default: null
toDateTime
string or null <date-time>
Default: null
object or null
Default: null
status
string or null
Default: null
useCreateDateTime
boolean
Default: false
moduleConfigId
string or null
Default: null
excludedFields
Array of strings or null
Default: null
normalQuestionnaires
boolean or null
Default: null
excludeModuleIds
Array of strings or null
Default: null
unseenOnly
boolean or null
Default: null
average
boolean or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "skip": null,
  • "limit": 10000,
  • "direction": "ASC",
  • "fromDateTime": null,
  • "toDateTime": null,
  • "filters": null,
  • "status": null,
  • "useCreateDateTime": false,
  • "moduleConfigId": null,
  • "excludedFields": null,
  • "normalQuestionnaires": null,
  • "excludeModuleIds": null,
  • "unseenOnly": null,
  • "average": null
}

Response samples

Content type
application/json
{
  • "PostVaccination": [
    ]
}

Retrieve PregnancyStatus results

post
URL: /api/extensions/v1/user/{user_id}/module-result/PregnancyStatus/search
path Parameters
user_id
required
string
Request Body schema: application/json
skip
integer or null
Default: null
limit
integer
Default: 10000
direction
string or null
Default: null
Enum: "ASC" "DESC" null
fromDateTime
string or null <date-time>
Default: null
toDateTime
string or null <date-time>
Default: null
object or null
Default: null
status
string or null
Default: null
useCreateDateTime
boolean
Default: false
moduleConfigId
string or null
Default: null
excludedFields
Array of strings or null
Default: null
normalQuestionnaires
boolean or null
Default: null
excludeModuleIds
Array of strings or null
Default: null
unseenOnly
boolean or null
Default: null
average
boolean or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "skip": null,
  • "limit": 10000,
  • "direction": "ASC",
  • "fromDateTime": null,
  • "toDateTime": null,
  • "filters": null,
  • "status": null,
  • "useCreateDateTime": false,
  • "moduleConfigId": null,
  • "excludedFields": null,
  • "normalQuestionnaires": null,
  • "excludeModuleIds": null,
  • "unseenOnly": null,
  • "average": null
}

Response samples

Content type
application/json
{
  • "PregnancyStatus": [
    ]
}

Retrieve PregnancyUpdate results

post
URL: /api/extensions/v1/user/{user_id}/module-result/PregnancyUpdate/search
path Parameters
user_id
required
string
Request Body schema: application/json
skip
integer or null
Default: null
limit
integer
Default: 10000
direction
string or null
Default: null
Enum: "ASC" "DESC" null
fromDateTime
string or null <date-time>
Default: null
toDateTime
string or null <date-time>
Default: null
object or null
Default: null
status
string or null
Default: null
useCreateDateTime
boolean
Default: false
moduleConfigId
string or null
Default: null
excludedFields
Array of strings or null
Default: null
normalQuestionnaires
boolean or null
Default: null
excludeModuleIds
Array of strings or null
Default: null
unseenOnly
boolean or null
Default: null
average
boolean or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "skip": null,
  • "limit": 10000,
  • "direction": "ASC",
  • "fromDateTime": null,
  • "toDateTime": null,
  • "filters": null,
  • "status": null,
  • "useCreateDateTime": false,
  • "moduleConfigId": null,
  • "excludedFields": null,
  • "normalQuestionnaires": null,
  • "excludeModuleIds": null,
  • "unseenOnly": null,
  • "average": null
}

Response samples

Content type
application/json
{
  • "PregnancyUpdate": [
    ]
}

Retrieve RespiratoryRate results

post
URL: /api/extensions/v1/user/{user_id}/module-result/RespiratoryRate/search
path Parameters
user_id
required
string
Request Body schema: application/json
skip
integer or null
Default: null
limit
integer
Default: 10000
direction
string or null
Default: null
Enum: "ASC" "DESC" null
fromDateTime
string or null <date-time>
Default: null
toDateTime
string or null <date-time>
Default: null
object or null
Default: null
status
string or null
Default: null
useCreateDateTime
boolean
Default: false
moduleConfigId
string or null
Default: null
excludedFields
Array of strings or null
Default: null
normalQuestionnaires
boolean or null
Default: null
excludeModuleIds
Array of strings or null
Default: null
unseenOnly
boolean or null
Default: null
average
boolean or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "skip": null,
  • "limit": 10000,
  • "direction": "ASC",
  • "fromDateTime": null,
  • "toDateTime": null,
  • "filters": null,
  • "status": null,
  • "useCreateDateTime": false,
  • "moduleConfigId": null,
  • "excludedFields": null,
  • "normalQuestionnaires": null,
  • "excludeModuleIds": null,
  • "unseenOnly": null,
  • "average": null
}

Response samples

Content type
application/json
{
  • "RespiratoryRate": [
    ]
}

Retrieve SelfRatedHealth results

post
URL: /api/extensions/v1/user/{user_id}/module-result/SelfRatedHealth/search
path Parameters
user_id
required
string
Request Body schema: application/json
skip
integer or null
Default: null
limit
integer
Default: 10000
direction
string or null
Default: null
Enum: "ASC" "DESC" null
fromDateTime
string or null <date-time>
Default: null
toDateTime
string or null <date-time>
Default: null
object or null
Default: null
status
string or null
Default: null
useCreateDateTime
boolean
Default: false
moduleConfigId
string or null
Default: null
excludedFields
Array of strings or null
Default: null
normalQuestionnaires
boolean or null
Default: null
excludeModuleIds
Array of strings or null
Default: null
unseenOnly
boolean or null
Default: null
average
boolean or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "skip": null,
  • "limit": 10000,
  • "direction": "ASC",
  • "fromDateTime": null,
  • "toDateTime": null,
  • "filters": null,
  • "status": null,
  • "useCreateDateTime": false,
  • "moduleConfigId": null,
  • "excludedFields": null,
  • "normalQuestionnaires": null,
  • "excludeModuleIds": null,
  • "unseenOnly": null,
  • "average": null
}

Response samples

Content type
application/json
{
  • "Questionnaire": [
    ]
}

Retrieve Covid19RiskScore results

post
URL: /api/extensions/v1/user/{user_id}/module-result/Covid19RiskScore/search
path Parameters
user_id
required
string
Request Body schema: application/json
skip
integer or null
Default: null
limit
integer
Default: 10000
direction
string or null
Default: null
Enum: "ASC" "DESC" null
fromDateTime
string or null <date-time>
Default: null
toDateTime
string or null <date-time>
Default: null
object or null
Default: null
status
string or null
Default: null
useCreateDateTime
boolean
Default: false
moduleConfigId
string or null
Default: null
excludedFields
Array of strings or null
Default: null
normalQuestionnaires
boolean or null
Default: null
excludeModuleIds
Array of strings or null
Default: null
unseenOnly
boolean or null
Default: null
average
boolean or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "skip": null,
  • "limit": 10000,
  • "direction": "ASC",
  • "fromDateTime": null,
  • "toDateTime": null,
  • "filters": null,
  • "status": null,
  • "useCreateDateTime": false,
  • "moduleConfigId": null,
  • "excludedFields": null,
  • "normalQuestionnaires": null,
  • "excludeModuleIds": null,
  • "unseenOnly": null,
  • "average": null
}

Response samples

Content type
application/json
{
  • "Covid19RiskScoreCoreQuestions": [
    ],
  • "Weight": [
    ],
  • "SmokeQuestions": [
    ],
  • "Temperature": [
    ],
  • "HeartRate": [
    ],
  • "RestingBreathingRate": [
    ],
  • "OxygenSaturation": [
    ],
  • "Covid19RiskScore": [
    ]
}

Retrieve OxygenSaturation results

post
URL: /api/extensions/v1/user/{user_id}/module-result/OxygenSaturation/search
path Parameters
user_id
required
string
Request Body schema: application/json
skip
integer or null
Default: null
limit
integer
Default: 10000
direction
string or null
Default: null
Enum: "ASC" "DESC" null
fromDateTime
string or null <date-time>
Default: null
toDateTime
string or null <date-time>
Default: null
object or null
Default: null
status
string or null
Default: null
useCreateDateTime
boolean
Default: false
moduleConfigId
string or null
Default: null
excludedFields
Array of strings or null
Default: null
normalQuestionnaires
boolean or null
Default: null
excludeModuleIds
Array of strings or null
Default: null
unseenOnly
boolean or null
Default: null
average
boolean or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "skip": null,
  • "limit": 10000,
  • "direction": "ASC",
  • "fromDateTime": null,
  • "toDateTime": null,
  • "filters": null,
  • "status": null,
  • "useCreateDateTime": false,
  • "moduleConfigId": null,
  • "excludedFields": null,
  • "normalQuestionnaires": null,
  • "excludeModuleIds": null,
  • "unseenOnly": null,
  • "average": null
}

Response samples

Content type
application/json
{
  • "OxygenSaturation": [
    ]
}

Retrieve RestingHeartRate results

post
URL: /api/extensions/v1/user/{user_id}/module-result/RestingHeartRate/search
path Parameters
user_id
required
string
Request Body schema: application/json
skip
integer or null
Default: null
limit
integer
Default: 10000
direction
string or null
Default: null
Enum: "ASC" "DESC" null
fromDateTime
string or null <date-time>
Default: null
toDateTime
string or null <date-time>
Default: null
object or null
Default: null
status
string or null
Default: null
useCreateDateTime
boolean
Default: false
moduleConfigId
string or null
Default: null
excludedFields
Array of strings or null
Default: null
normalQuestionnaires
boolean or null
Default: null
excludeModuleIds
Array of strings or null
Default: null
unseenOnly
boolean or null
Default: null
average
boolean or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "skip": null,
  • "limit": 10000,
  • "direction": "ASC",
  • "fromDateTime": null,
  • "toDateTime": null,
  • "filters": null,
  • "status": null,
  • "useCreateDateTime": false,
  • "moduleConfigId": null,
  • "excludedFields": null,
  • "normalQuestionnaires": null,
  • "excludeModuleIds": null,
  • "unseenOnly": null,
  • "average": null
}

Response samples

Content type
application/json
{
  • "HeartRate": [
    ]
}

Retrieve VoiceAssessments results

post
URL: /api/extensions/v1/user/{user_id}/module-result/VoiceAssessments/search
path Parameters
user_id
required
string
Request Body schema: application/json
skip
integer or null
Default: null
limit
integer
Default: 10000
direction
string or null
Default: null
Enum: "ASC" "DESC" null
fromDateTime
string or null <date-time>
Default: null
toDateTime
string or null <date-time>
Default: null
object or null
Default: null
status
string or null
Default: null
useCreateDateTime
boolean
Default: false
moduleConfigId
string or null
Default: null
excludedFields
Array of strings or null
Default: null
normalQuestionnaires
boolean or null
Default: null
excludeModuleIds
Array of strings or null
Default: null
unseenOnly
boolean or null
Default: null
average
boolean or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "skip": null,
  • "limit": 10000,
  • "direction": "ASC",
  • "fromDateTime": null,
  • "toDateTime": null,
  • "filters": null,
  • "status": null,
  • "useCreateDateTime": false,
  • "moduleConfigId": null,
  • "excludedFields": null,
  • "normalQuestionnaires": null,
  • "excludeModuleIds": null,
  • "unseenOnly": null,
  • "average": null
}

Response samples

Content type
application/json
{
  • "Dysphonia": [
    ],
  • "Dysarthria": [
    ]
}

Retrieve AwarenessTraining results

post
URL: /api/extensions/v1/user/{user_id}/module-result/AwarenessTraining/search
path Parameters
user_id
required
string
Request Body schema: application/json
skip
integer or null
Default: null
limit
integer
Default: 10000
direction
string or null
Default: null
Enum: "ASC" "DESC" null
fromDateTime
string or null <date-time>
Default: null
toDateTime
string or null <date-time>
Default: null
object or null
Default: null
status
string or null
Default: null
useCreateDateTime
boolean
Default: false
moduleConfigId
string or null
Default: null
excludedFields
Array of strings or null
Default: null
normalQuestionnaires
boolean or null
Default: null
excludeModuleIds
Array of strings or null
Default: null
unseenOnly
boolean or null
Default: null
average
boolean or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "skip": null,
  • "limit": 10000,
  • "direction": "ASC",
  • "fromDateTime": null,
  • "toDateTime": null,
  • "filters": null,
  • "status": null,
  • "useCreateDateTime": false,
  • "moduleConfigId": null,
  • "excludedFields": null,
  • "normalQuestionnaires": null,
  • "excludeModuleIds": null,
  • "unseenOnly": null,
  • "average": null
}

Response samples

Content type
application/json
{
  • "AwarenessTraining": [
    ]
}

Retrieve FeverAndPainDrugs results

post
URL: /api/extensions/v1/user/{user_id}/module-result/FeverAndPainDrugs/search
path Parameters
user_id
required
string
Request Body schema: application/json
skip
integer or null
Default: null
limit
integer
Default: 10000
direction
string or null
Default: null
Enum: "ASC" "DESC" null
fromDateTime
string or null <date-time>
Default: null
toDateTime
string or null <date-time>
Default: null
object or null
Default: null
status
string or null
Default: null
useCreateDateTime
boolean
Default: false
moduleConfigId
string or null
Default: null
excludedFields
Array of strings or null
Default: null
normalQuestionnaires
boolean or null
Default: null
excludeModuleIds
Array of strings or null
Default: null
unseenOnly
boolean or null
Default: null
average
boolean or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "skip": null,
  • "limit": 10000,
  • "direction": "ASC",
  • "fromDateTime": null,
  • "toDateTime": null,
  • "filters": null,
  • "status": null,
  • "useCreateDateTime": false,
  • "moduleConfigId": null,
  • "excludedFields": null,
  • "normalQuestionnaires": null,
  • "excludeModuleIds": null,
  • "unseenOnly": null,
  • "average": null
}

Response samples

Content type
application/json
{
  • "FeverAndPainDrugs": [
    ]
}

Retrieve HighFrequencyStep results

post
URL: /api/extensions/v1/user/{user_id}/module-result/HighFrequencyStep/search
path Parameters
user_id
required
string
Request Body schema: application/json
skip
integer or null
Default: null
limit
integer
Default: 10000
direction
string or null
Default: null
Enum: "ASC" "DESC" null
fromDateTime
string or null <date-time>
Default: null
toDateTime
string or null <date-time>
Default: null
object or null
Default: null
status
string or null
Default: null
useCreateDateTime
boolean
Default: false
moduleConfigId
string or null
Default: null
excludedFields
Array of strings or null
Default: null
normalQuestionnaires
boolean or null
Default: null
excludeModuleIds
Array of strings or null
Default: null
unseenOnly
boolean or null
Default: null
average
boolean or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "skip": null,
  • "limit": 10000,
  • "direction": "ASC",
  • "fromDateTime": null,
  • "toDateTime": null,
  • "filters": null,
  • "status": null,
  • "useCreateDateTime": false,
  • "moduleConfigId": null,
  • "excludedFields": null,
  • "normalQuestionnaires": null,
  • "excludeModuleIds": null,
  • "unseenOnly": null,
  • "average": null
}

Response samples

Content type
application/json
{
  • "HighFrequencyStep": [
    ]
}

Retrieve MedicationTracker results

post
URL: /api/extensions/v1/user/{user_id}/module-result/MedicationTracker/search
path Parameters
user_id
required
string
Request Body schema: application/json
skip
integer or null
Default: null
limit
integer
Default: 10000
direction
string or null
Default: null
Enum: "ASC" "DESC" null
fromDateTime
string or null <date-time>
Default: null
toDateTime
string or null <date-time>
Default: null
object or null
Default: null
status
string or null
Default: null
useCreateDateTime
boolean
Default: false
moduleConfigId
string or null
Default: null
excludedFields
Array of strings or null
Default: null
normalQuestionnaires
boolean or null
Default: null
excludeModuleIds
Array of strings or null
Default: null
unseenOnly
boolean or null
Default: null
average
boolean or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "skip": null,
  • "limit": 10000,
  • "direction": "ASC",
  • "fromDateTime": null,
  • "toDateTime": null,
  • "filters": null,
  • "status": null,
  • "useCreateDateTime": false,
  • "moduleConfigId": null,
  • "excludedFields": null,
  • "normalQuestionnaires": null,
  • "excludeModuleIds": null,
  • "unseenOnly": null,
  • "average": null
}

Response samples

Content type
application/json
{
  • "Questionnaire": [
    ]
}

Retrieve PregnancyFollowUp results

post
URL: /api/extensions/v1/user/{user_id}/module-result/PregnancyFollowUp/search
path Parameters
user_id
required
string
Request Body schema: application/json
skip
integer or null
Default: null
limit
integer
Default: 10000
direction
string or null
Default: null
Enum: "ASC" "DESC" null
fromDateTime
string or null <date-time>
Default: null
toDateTime
string or null <date-time>
Default: null
object or null
Default: null
status
string or null
Default: null
useCreateDateTime
boolean
Default: false
moduleConfigId
string or null
Default: null
excludedFields
Array of strings or null
Default: null
normalQuestionnaires
boolean or null
Default: null
excludeModuleIds
Array of strings or null
Default: null
unseenOnly
boolean or null
Default: null
average
boolean or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "skip": null,
  • "limit": 10000,
  • "direction": "ASC",
  • "fromDateTime": null,
  • "toDateTime": null,
  • "filters": null,
  • "status": null,
  • "useCreateDateTime": false,
  • "moduleConfigId": null,
  • "excludedFields": null,
  • "normalQuestionnaires": null,
  • "excludeModuleIds": null,
  • "unseenOnly": null,
  • "average": null
}

Response samples

Content type
application/json
{
  • "PregnancyFollowUp": [
    ]
}

Retrieve AsthmaControlTest results

post
URL: /api/extensions/v1/user/{user_id}/module-result/AsthmaControlTest/search
path Parameters
user_id
required
string
Request Body schema: application/json
skip
integer or null
Default: null
limit
integer
Default: 10000
direction
string or null
Default: null
Enum: "ASC" "DESC" null
fromDateTime
string or null <date-time>
Default: null
toDateTime
string or null <date-time>
Default: null
object or null
Default: null
status
string or null
Default: null
useCreateDateTime
boolean
Default: false
moduleConfigId
string or null
Default: null
excludedFields
Array of strings or null
Default: null
normalQuestionnaires
boolean or null
Default: null
excludeModuleIds
Array of strings or null
Default: null
unseenOnly
boolean or null
Default: null
average
boolean or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "skip": null,
  • "limit": 10000,
  • "direction": "ASC",
  • "fromDateTime": null,
  • "toDateTime": null,
  • "filters": null,
  • "status": null,
  • "useCreateDateTime": false,
  • "moduleConfigId": null,
  • "excludedFields": null,
  • "normalQuestionnaires": null,
  • "excludeModuleIds": null,
  • "unseenOnly": null,
  • "average": null
}

Response samples

Content type
application/json
{
  • "AsthmaControlTest": [
    ],
  • "Questionnaire": [
    ]
}

Retrieve PROMISGlobalHealth results

post
URL: /api/extensions/v1/user/{user_id}/module-result/PROMISGlobalHealth/search
path Parameters
user_id
required
string
Request Body schema: application/json
skip
integer or null
Default: null
limit
integer
Default: 10000
direction
string or null
Default: null
Enum: "ASC" "DESC" null
fromDateTime
string or null <date-time>
Default: null
toDateTime
string or null <date-time>
Default: null
object or null
Default: null
status
string or null
Default: null
useCreateDateTime
boolean
Default: false
moduleConfigId
string or null
Default: null
excludedFields
Array of strings or null
Default: null
normalQuestionnaires
boolean or null
Default: null
excludeModuleIds
Array of strings or null
Default: null
unseenOnly
boolean or null
Default: null
average
boolean or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "skip": null,
  • "limit": 10000,
  • "direction": "ASC",
  • "fromDateTime": null,
  • "toDateTime": null,
  • "filters": null,
  • "status": null,
  • "useCreateDateTime": false,
  • "moduleConfigId": null,
  • "excludedFields": null,
  • "normalQuestionnaires": null,
  • "excludeModuleIds": null,
  • "unseenOnly": null,
  • "average": null
}

Response samples

Content type
application/json
{
  • "PROMISGlobalHealth": [
    ]
}

Retrieve VaccinationDetails results

post
URL: /api/extensions/v1/user/{user_id}/module-result/VaccinationDetails/search
path Parameters
user_id
required
string
Request Body schema: application/json
skip
integer or null
Default: null
limit
integer
Default: 10000
direction
string or null
Default: null
Enum: "ASC" "DESC" null
fromDateTime
string or null <date-time>
Default: null
toDateTime
string or null <date-time>
Default: null
object or null
Default: null
status
string or null
Default: null
useCreateDateTime
boolean
Default: false
moduleConfigId
string or null
Default: null
excludedFields
Array of strings or null
Default: null
normalQuestionnaires
boolean or null
Default: null
excludeModuleIds
Array of strings or null
Default: null
unseenOnly
boolean or null
Default: null
average
boolean or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "skip": null,
  • "limit": 10000,
  • "direction": "ASC",
  • "fromDateTime": null,
  • "toDateTime": null,
  • "filters": null,
  • "status": null,
  • "useCreateDateTime": false,
  • "moduleConfigId": null,
  • "excludedFields": null,
  • "normalQuestionnaires": null,
  • "excludeModuleIds": null,
  • "unseenOnly": null,
  • "average": null
}

Response samples

Content type
application/json
{
  • "VaccinationDetails": [
    ]
}

Retrieve BreastFeedingStatus results

post
URL: /api/extensions/v1/user/{user_id}/module-result/BreastFeedingStatus/search
path Parameters
user_id
required
string
Request Body schema: application/json
skip
integer or null
Default: null
limit
integer
Default: 10000
direction
string or null
Default: null
Enum: "ASC" "DESC" null
fromDateTime
string or null <date-time>
Default: null
toDateTime
string or null <date-time>
Default: null
object or null
Default: null
status
string or null
Default: null
useCreateDateTime
boolean
Default: false
moduleConfigId
string or null
Default: null
excludedFields
Array of strings or null
Default: null
normalQuestionnaires
boolean or null
Default: null
excludeModuleIds
Array of strings or null
Default: null
unseenOnly
boolean or null
Default: null
average
boolean or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "skip": null,
  • "limit": 10000,
  • "direction": "ASC",
  • "fromDateTime": null,
  • "toDateTime": null,
  • "filters": null,
  • "status": null,
  • "useCreateDateTime": false,
  • "moduleConfigId": null,
  • "excludedFields": null,
  • "normalQuestionnaires": null,
  • "excludeModuleIds": null,
  • "unseenOnly": null,
  • "average": null
}

Response samples

Content type
application/json
{
  • "BreastFeedingStatus": [
    ]
}

Retrieve BreastFeedingUpdate results

post
URL: /api/extensions/v1/user/{user_id}/module-result/BreastFeedingUpdate/search
path Parameters
user_id
required
string
Request Body schema: application/json
skip
integer or null
Default: null
limit
integer
Default: 10000
direction
string or null
Default: null
Enum: "ASC" "DESC" null
fromDateTime
string or null <date-time>
Default: null
toDateTime
string or null <date-time>
Default: null
object or null
Default: null
status
string or null
Default: null
useCreateDateTime
boolean
Default: false
moduleConfigId
string or null
Default: null
excludedFields
Array of strings or null
Default: null
normalQuestionnaires
boolean or null
Default: null
excludeModuleIds
Array of strings or null
Default: null
unseenOnly
boolean or null
Default: null
average
boolean or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "skip": null,
  • "limit": 10000,
  • "direction": "ASC",
  • "fromDateTime": null,
  • "toDateTime": null,
  • "filters": null,
  • "status": null,
  • "useCreateDateTime": false,
  • "moduleConfigId": null,
  • "excludedFields": null,
  • "normalQuestionnaires": null,
  • "excludeModuleIds": null,
  • "unseenOnly": null,
  • "average": null
}

Response samples

Content type
application/json
{
  • "BreastFeedingUpdate": [
    ]
}

Retrieve Covid19DailyCheckIn results

post
URL: /api/extensions/v1/user/{user_id}/module-result/Covid19DailyCheckIn/search
path Parameters
user_id
required
string
Request Body schema: application/json
skip
integer or null
Default: null
limit
integer
Default: 10000
direction
string or null
Default: null
Enum: "ASC" "DESC" null
fromDateTime
string or null <date-time>
Default: null
toDateTime
string or null <date-time>
Default: null
object or null
Default: null
status
string or null
Default: null
useCreateDateTime
boolean
Default: false
moduleConfigId
string or null
Default: null
excludedFields
Array of strings or null
Default: null
normalQuestionnaires
boolean or null
Default: null
excludeModuleIds
Array of strings or null
Default: null
unseenOnly
boolean or null
Default: null
average
boolean or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "skip": null,
  • "limit": 10000,
  • "direction": "ASC",
  • "fromDateTime": null,
  • "toDateTime": null,
  • "filters": null,
  • "status": null,
  • "useCreateDateTime": false,
  • "moduleConfigId": null,
  • "excludedFields": null,
  • "normalQuestionnaires": null,
  • "excludeModuleIds": null,
  • "unseenOnly": null,
  • "average": null
}

Response samples

Content type
application/json
{
  • "Covid19DailyCheckIn": [
    ]
}

Retrieve OxfordShoulderScore results

post
URL: /api/extensions/v1/user/{user_id}/module-result/OxfordShoulderScore/search
path Parameters
user_id
required
string
Request Body schema: application/json
skip
integer or null
Default: null
limit
integer
Default: 10000
direction
string or null
Default: null
Enum: "ASC" "DESC" null
fromDateTime
string or null <date-time>
Default: null
toDateTime
string or null <date-time>
Default: null
object or null
Default: null
status
string or null
Default: null
useCreateDateTime
boolean
Default: false
moduleConfigId
string or null
Default: null
excludedFields
Array of strings or null
Default: null
normalQuestionnaires
boolean or null
Default: null
excludeModuleIds
Array of strings or null
Default: null
unseenOnly
boolean or null
Default: null
average
boolean or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "skip": null,
  • "limit": 10000,
  • "direction": "ASC",
  • "fromDateTime": null,
  • "toDateTime": null,
  • "filters": null,
  • "status": null,
  • "useCreateDateTime": false,
  • "moduleConfigId": null,
  • "excludedFields": null,
  • "normalQuestionnaires": null,
  • "excludeModuleIds": null,
  • "unseenOnly": null,
  • "average": null
}

Response samples

Content type
application/json
{
  • "OxfordShoulderScore": [
    ]
}

Retrieve RestingBreathingRate results

post
URL: /api/extensions/v1/user/{user_id}/module-result/RestingBreathingRate/search
path Parameters
user_id
required
string
Request Body schema: application/json
skip
integer or null
Default: null
limit
integer
Default: 10000
direction
string or null
Default: null
Enum: "ASC" "DESC" null
fromDateTime
string or null <date-time>
Default: null
toDateTime
string or null <date-time>
Default: null
object or null
Default: null
status
string or null
Default: null
useCreateDateTime
boolean
Default: false
moduleConfigId
string or null
Default: null
excludedFields
Array of strings or null
Default: null
normalQuestionnaires
boolean or null
Default: null
excludeModuleIds
Array of strings or null
Default: null
unseenOnly
boolean or null
Default: null
average
boolean or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "skip": null,
  • "limit": 10000,
  • "direction": "ASC",
  • "fromDateTime": null,
  • "toDateTime": null,
  • "filters": null,
  • "status": null,
  • "useCreateDateTime": false,
  • "moduleConfigId": null,
  • "excludedFields": null,
  • "normalQuestionnaires": null,
  • "excludeModuleIds": null,
  • "unseenOnly": null,
  • "average": null
}

Response samples

Content type
application/json
{
  • "RestingBreathingRate": [
    ]
}

Retrieve PerceivedStressScale results

post
URL: /api/extensions/v1/user/{user_id}/module-result/PerceivedStressScale/search
path Parameters
user_id
required
string
Request Body schema: application/json
skip
integer or null
Default: null
limit
integer
Default: 10000
direction
string or null
Default: null
Enum: "ASC" "DESC" null
fromDateTime
string or null <date-time>
Default: null
toDateTime
string or null <date-time>
Default: null
object or null
Default: null
status
string or null
Default: null
useCreateDateTime
boolean
Default: false
moduleConfigId
string or null
Default: null
excludedFields
Array of strings or null
Default: null
normalQuestionnaires
boolean or null
Default: null
excludeModuleIds
Array of strings or null
Default: null
unseenOnly
boolean or null
Default: null
average
boolean or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "skip": null,
  • "limit": 10000,
  • "direction": "ASC",
  • "fromDateTime": null,
  • "toDateTime": null,
  • "filters": null,
  • "status": null,
  • "useCreateDateTime": false,
  • "moduleConfigId": null,
  • "excludedFields": null,
  • "normalQuestionnaires": null,
  • "excludeModuleIds": null,
  • "unseenOnly": null,
  • "average": null
}

Response samples

Content type
application/json
{
  • "PerceivedStressScale": [
    ],
  • "Questionnaire": [
    ]
}

Retrieve BackgroundInformation results

post
URL: /api/extensions/v1/user/{user_id}/module-result/BackgroundInformation/search
path Parameters
user_id
required
string
Request Body schema: application/json
skip
integer or null
Default: null
limit
integer
Default: 10000
direction
string or null
Default: null
Enum: "ASC" "DESC" null
fromDateTime
string or null <date-time>
Default: null
toDateTime
string or null <date-time>
Default: null
object or null
Default: null
status
string or null
Default: null
useCreateDateTime
boolean
Default: false
moduleConfigId
string or null
Default: null
excludedFields
Array of strings or null
Default: null
normalQuestionnaires
boolean or null
Default: null
excludeModuleIds
Array of strings or null
Default: null
unseenOnly
boolean or null
Default: null
average
boolean or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "skip": null,
  • "limit": 10000,
  • "direction": "ASC",
  • "fromDateTime": null,
  • "toDateTime": null,
  • "filters": null,
  • "status": null,
  • "useCreateDateTime": false,
  • "moduleConfigId": null,
  • "excludedFields": null,
  • "normalQuestionnaires": null,
  • "excludeModuleIds": null,
  • "unseenOnly": null,
  • "average": null
}

Response samples

Content type
application/json
{
  • "BackgroundInformation": [
    ]
}

Retrieve DiabetesDistressScore results

post
URL: /api/extensions/v1/user/{user_id}/module-result/DiabetesDistressScore/search
path Parameters
user_id
required
string
Request Body schema: application/json
skip
integer or null
Default: null
limit
integer
Default: 10000
direction
string or null
Default: null
Enum: "ASC" "DESC" null
fromDateTime
string or null <date-time>
Default: null
toDateTime
string or null <date-time>
Default: null
object or null
Default: null
status
string or null
Default: null
useCreateDateTime
boolean
Default: false
moduleConfigId
string or null
Default: null
excludedFields
Array of strings or null
Default: null
normalQuestionnaires
boolean or null
Default: null
excludeModuleIds
Array of strings or null
Default: null
unseenOnly
boolean or null
Default: null
average
boolean or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "skip": null,
  • "limit": 10000,
  • "direction": "ASC",
  • "fromDateTime": null,
  • "toDateTime": null,
  • "filters": null,
  • "status": null,
  • "useCreateDateTime": false,
  • "moduleConfigId": null,
  • "excludedFields": null,
  • "normalQuestionnaires": null,
  • "excludeModuleIds": null,
  • "unseenOnly": null,
  • "average": null
}

Response samples

Content type
application/json
{
  • "DiabetesDistressScore": [
    ],
  • "Questionnaire": [
    ]
}

Retrieve GeneralAnxietyDisorder results

post
URL: /api/extensions/v1/user/{user_id}/module-result/GeneralAnxietyDisorder/search
path Parameters
user_id
required
string
Request Body schema: application/json
skip
integer or null
Default: null
limit
integer
Default: 10000
direction
string or null
Default: null
Enum: "ASC" "DESC" null
fromDateTime
string or null <date-time>
Default: null
toDateTime
string or null <date-time>
Default: null
object or null
Default: null
status
string or null
Default: null
useCreateDateTime
boolean
Default: false
moduleConfigId
string or null
Default: null
excludedFields
Array of strings or null
Default: null
normalQuestionnaires
boolean or null
Default: null
excludeModuleIds
Array of strings or null
Default: null
unseenOnly
boolean or null
Default: null
average
boolean or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "skip": null,
  • "limit": 10000,
  • "direction": "ASC",
  • "fromDateTime": null,
  • "toDateTime": null,
  • "filters": null,
  • "status": null,
  • "useCreateDateTime": false,
  • "moduleConfigId": null,
  • "excludedFields": null,
  • "normalQuestionnaires": null,
  • "excludeModuleIds": null,
  • "unseenOnly": null,
  • "average": null
}

Response samples

Content type
application/json
{
  • "Questionnaire": [
    ]
}

Retrieve HighFrequencyHeartRate results

post
URL: /api/extensions/v1/user/{user_id}/module-result/HighFrequencyHeartRate/search
path Parameters
user_id
required
string
Request Body schema: application/json
skip
integer or null
Default: null
limit
integer
Default: 10000
direction
string or null
Default: null
Enum: "ASC" "DESC" null
fromDateTime
string or null <date-time>
Default: null
toDateTime
string or null <date-time>
Default: null
object or null
Default: null
status
string or null
Default: null
useCreateDateTime
boolean
Default: false
moduleConfigId
string or null
Default: null
excludedFields
Array of strings or null
Default: null
normalQuestionnaires
boolean or null
Default: null
excludeModuleIds
Array of strings or null
Default: null
unseenOnly
boolean or null
Default: null
average
boolean or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "skip": null,
  • "limit": 10000,
  • "direction": "ASC",
  • "fromDateTime": null,
  • "toDateTime": null,
  • "filters": null,
  • "status": null,
  • "useCreateDateTime": false,
  • "moduleConfigId": null,
  • "excludedFields": null,
  • "normalQuestionnaires": null,
  • "excludeModuleIds": null,
  • "unseenOnly": null,
  • "average": null
}

Response samples

Content type
application/json
{
  • "HighFrequencyHeartRate": [
    ]
}

Retrieve AZGroupKeyActionTrigger results

post
URL: /api/extensions/v1/user/{user_id}/module-result/AZGroupKeyActionTrigger/search
path Parameters
user_id
required
string
Request Body schema: application/json
skip
integer or null
Default: null
limit
integer
Default: 10000
direction
string or null
Default: null
Enum: "ASC" "DESC" null
fromDateTime
string or null <date-time>
Default: null
toDateTime
string or null <date-time>
Default: null
object or null
Default: null
status
string or null
Default: null
useCreateDateTime
boolean
Default: false
moduleConfigId
string or null
Default: null
excludedFields
Array of strings or null
Default: null
normalQuestionnaires
boolean or null
Default: null
excludeModuleIds
Array of strings or null
Default: null
unseenOnly
boolean or null
Default: null
average
boolean or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "skip": null,
  • "limit": 10000,
  • "direction": "ASC",
  • "fromDateTime": null,
  • "toDateTime": null,
  • "filters": null,
  • "status": null,
  • "useCreateDateTime": false,
  • "moduleConfigId": null,
  • "excludedFields": null,
  • "normalQuestionnaires": null,
  • "excludeModuleIds": null,
  • "unseenOnly": null,
  • "average": null
}

Response samples

Content type
application/json
{
  • "AZGroupKeyActionTrigger": [
    ]
}

Retrieve AZScreeningQuestionnaire results

post
URL: /api/extensions/v1/user/{user_id}/module-result/AZScreeningQuestionnaire/search
path Parameters
user_id
required
string
Request Body schema: application/json
skip
integer or null
Default: null
limit
integer
Default: 10000
direction
string or null
Default: null
Enum: "ASC" "DESC" null
fromDateTime
string or null <date-time>
Default: null
toDateTime
string or null <date-time>
Default: null
object or null
Default: null
status
string or null
Default: null
useCreateDateTime
boolean
Default: false
moduleConfigId
string or null
Default: null
excludedFields
Array of strings or null
Default: null
normalQuestionnaires
boolean or null
Default: null
excludeModuleIds
Array of strings or null
Default: null
unseenOnly
boolean or null
Default: null
average
boolean or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "skip": null,
  • "limit": 10000,
  • "direction": "ASC",
  • "fromDateTime": null,
  • "toDateTime": null,
  • "filters": null,
  • "status": null,
  • "useCreateDateTime": false,
  • "moduleConfigId": null,
  • "excludedFields": null,
  • "normalQuestionnaires": null,
  • "excludeModuleIds": null,
  • "unseenOnly": null,
  • "average": null
}

Response samples

Content type
application/json
{
  • "AZScreeningQuestionnaire": [
    ]
}

Retrieve AZFurtherPregnancyKeyActionTrigger results

post
URL: /api/extensions/v1/user/{user_id}/module-result/AZFurtherPregnancyKeyActionTrigger/search
path Parameters
user_id
required
string
Request Body schema: application/json
skip
integer or null
Default: null
limit
integer
Default: 10000
direction
string or null
Default: null
Enum: "ASC" "DESC" null
fromDateTime
string or null <date-time>
Default: null
toDateTime
string or null <date-time>
Default: null
object or null
Default: null
status
string or null
Default: null
useCreateDateTime
boolean
Default: false
moduleConfigId
string or null
Default: null
excludedFields
Array of strings or null
Default: null
normalQuestionnaires
boolean or null
Default: null
excludeModuleIds
Array of strings or null
Default: null
unseenOnly
boolean or null
Default: null
average
boolean or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "skip": null,
  • "limit": 10000,
  • "direction": "ASC",
  • "fromDateTime": null,
  • "toDateTime": null,
  • "filters": null,
  • "status": null,
  • "useCreateDateTime": false,
  • "moduleConfigId": null,
  • "excludedFields": null,
  • "normalQuestionnaires": null,
  • "excludeModuleIds": null,
  • "unseenOnly": null,
  • "average": null
}

Response samples

Content type
application/json
{
  • "AZFurtherPregnancyKeyActionTrigger": [
    ]
}

Search_Module_Results

Search module results

post
URL: /api/extensions/v1/user/{user_id}/module-result/search
path Parameters
user_id
required
string
Request Body schema: application/json
skip
integer or null
Default: null
limit
integer
Default: 10000
direction
string or null
Default: null
Enum: "ASC" "DESC" null
fromDateTime
string or null <date-time>
Default: null
toDateTime
string or null <date-time>
Default: null
object or null
Default: null
status
string or null
Default: null
useCreateDateTime
boolean
Default: false
modules
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "skip": null,
  • "limit": 10000,
  • "direction": "ASC",
  • "fromDateTime": null,
  • "toDateTime": null,
  • "filters": null,
  • "status": null,
  • "useCreateDateTime": false,
  • "modules": [
    ]
}

Response samples

Content type
application/json
{
  • "Tegner": [
    ],
  • "FitbitHRV": [
    ],
  • "Sleep": [
    ],
  • "ODI": [
    ],
  • "AZFurtherPregnancyKeyActionTrigger": [
    ],
  • "NDI": [
    ],
  • "PROMISGlobalHealth": [
    ],
  • "OxfordKneeScore": [
    ],
  • "MG_ADL": [
    ],
  • "SF36": [
    ],
  • "FeverAndPainDrugs": [
    ],
  • "NORFOLK": [
    ],
  • "Dysarthria": [
    ],
  • "HealthStatus": [
    ],
  • "AZScreeningQuestionnaire": [
    ],
  • "VaccinationDetails": [
    ],
  • "Symptom": [
    ],
  • "MedicalHistory": [
    ],
  • "AlcoholConsumption": [
    ],
  • "WHQ": [
    ],
  • "PregnancyStatus": [
    ],
  • "InfantFollowUp": [
    ],
  • "NumericMemory": [
    ],
  • "EQ5D5L": [
    ],
  • "PeakFlow": [
    ],
  • "AsthmaControlTest": [
    ],
  • "BodyComposition": [
    ],
  • "Lysholm": [
    ],
  • "SensorCapture": [
    ],
  • "KCCQ": [
    ],
  • "ECGHealthKit": [
    ],
  • "OxfordShoulderScore": [
    ],
  • "AdditionalQoL": [
    ],
  • "KOOS": [
    ],
  • "RestingBreathingRate": [
    ],
  • "SleepQuestions": [
    ],
  • "Dysphonia": [
    ],
  • "Covid19DailyCheckIn": [
    ],
  • "PerceivedStressScale": [
    ],
  • "WOMAC": [
    ],
  • "RevereTest": [
    ],
  • "BloodGlucose": [
    ],
  • "RespiratoryRate": [
    ],
  • "IKDC": [
    ],
  • "DashScore": [
    ],
  • "OxfordHipScore": [
    ],
  • "Covid19RiskScore": [
    ],
  • "ReactionTime": [
    ],
  • "BreastFeedingStatus": [
    ],
  • "VR_12": [
    ],
  • "OARS": [
    ],
  • "OxygenSaturation": [
    ],
  • "Step": [
    ],
  • "PregnancyUpdate": [
    ],
  • "SmokeQuestions": [
    ],
  • "ArmFatigue": [
    ],
  • "AwarenessTraining": [
    ],
  • "AirQualityIndex": [
    ],
  • "BMI": [
    ],
  • "PregnancyFollowUp": [
    ],
  • "Weight": [
    ],
  • "OACS": [
    ],
  • "HScore": [
    ],
  • "ECGAliveCor": [
    ],
  • "Temperature": [
    ],
  • "DiabetesDistressScore": [
    ],
  • "Covid19RiskScoreCoreQuestions": [
    ],
  • "SpatialSpaniOS": [
    ],
  • "PostVaccination": [
    ],
  • "BodyMeasurement": [
    ],
  • "CVDRiskScore": [
    ],
  • "Ptosis": [
    ],
  • "CAT": [
    ],
  • "AHQ": [
    ],
  • "BackgroundInformation": [
    ],
  • "HighFrequencyStep": [
    ],
  • "BreastFeedingUpdate": [
    ],
  • "PulseOximetry": [
    ],
  • "OtherVaccine": [
    ],
  • "HighFrequencyHeartRate": [
    ],
  • "Height": [
    ],
  • "BloodPressure": [
    ],
  • "Photo": [
    ],
  • "Questionnaire": [
    ],
  • "SRS": [
    ],
  • "SelfHealthRate": [
    ],
  • "Journal": [
    ],
  • "ECG": [
    ],
  • "HeartRate": [
    ],
  • "WaistToHeight": [
    ],
  • "AZGroupKeyActionTrigger": [
    ]
}

Auth

Outlines the workflow for user authentication within the system. It defines processes such as user sign-up, sign-in, password management, token generation, and access control.

Check auth attributes

post
URL: /api/auth/v1/check-auth-attributes

Responsible for verifying specific user attributes.

Request Body schema: application/json
authToken
string or null
Default: null
tokenType
any
Default: 0
Enum: 0 1 2
email
string or null
Default: null
phoneNumber
string or null
Default: null
clientId
required
string
projectId
required
string

Responses

Request samples

Content type
application/json
{
  • "authToken": null,
  • "tokenType": 0,
  • "email": null,
  • "phoneNumber": null,
  • "clientId": "string",
  • "projectId": "string"
}

Response samples

Content type
application/json
{
  • "phoneNumber": null,
  • "email": null,
  • "passwordSet": null,
  • "emailVerified": null,
  • "phoneNumberVerified": null,
  • "eligibleForMFA": null,
  • "mfaEnabled": null,
  • "shortenedCode": null,
  • "contactEmail": null,
  • "ssoEnabled": null
}

Deployment_Route

Create Deployment

post
URL: /api/extensions/v1/deployment
Request Body schema: application/json
termAndConditionUrl
string or null
Default: null
privacyPolicyUrl
string or null
Default: null
eulaUrl
string or null
Default: null
object or null
Default: null
object or null
Default: null
object or null
Default: null
object or null
Default: null
Array of objects or null (Role)
Default: null
object or null
Default: null
id
string or null
Default: null
draftId
string or null
Default: null
name
string or null
Default: null
description
string or null
Default: null
status
string or null
Default: null
Enum: "DRAFT" "DEPLOYED" "ARCHIVED" null
color
string or null
Default: null
object or null
Default: null
iconFileId
string or null
Default: null
templateThumbnailFileId
string or null
Default: null
descriptionUrl
string or null
Default: null
isSaMD
boolean or null
Default: null
updateDateTime
string or null <date-time>
Default: null
createDateTime
string or null <date-time>
Default: null
Array of objects or null (ModuleConfig)
Default: null
Array of objects or null (OnboardingModuleConfig)
Default: null
object or null
Default: null
object or null
Default: null
object or null
Default: null
Array of objects or null (KeyActionConfig)
Default: null
keyActionsEnabled
boolean or null
Default: null
object or null
Default: null
object or null
Default: null
object or null
Default: null
object or null
Default: null
contactUsURL
string or null
Default: null
version
integer
Default: 0
object or null
Default: null
language
string
Default: "en"
duration
string or null
Default: null
object or null
Default: null
mfaRequired
boolean or null
Default: null
code
string or null
Default: null
enrollmentCounter
integer or null
Default: null
object or null
Default: null
object or null
Default: null
object or null
Default: null
country
string or null
Default: null
object or null
Default: null
Array of objects or null (Label)
Default: null
tags
Array of strings or null
Default: null
object or null
Default: null
Array of objects or null (IntegrationDevice)
Default: null
object or null
Default: null
object or null
Default: null
object or null
Default: null
_localizableFields
Array of strings
Default: ["builder","componentConfigs","consent","econsent","extraCustomFields","features","keyActions","learn","moduleConfigs","profile"]

Responses

Request samples

Content type
application/json
{
  • "termAndConditionUrl": null,
  • "privacyPolicyUrl": null,
  • "eulaUrl": null,
  • "privacyPolicyObject": null,
  • "termAndConditionObject": null,
  • "eulaObject": null,
  • "authorisedRep": null,
  • "roles": null,
  • "sso": null,
  • "id": null,
  • "draftId": null,
  • "name": null,
  • "description": null,
  • "status": "DRAFT",
  • "color": null,
  • "icon": null,
  • "iconFileId": null,
  • "templateThumbnailFileId": null,
  • "descriptionUrl": null,
  • "isSaMD": null,
  • "updateDateTime": null,
  • "createDateTime": null,
  • "moduleConfigs": null,
  • "onboardingConfigs": null,
  • "learn": null,
  • "consent": null,
  • "econsent": null,
  • "keyActions": null,
  • "keyActionsEnabled": null,
  • "profile": null,
  • "features": null,
  • "extraCustomFields": null,
  • "surgeryDetails": null,
  • "contactUsURL": null,
  • "version": 0,
  • "integration": null,
  • "language": "en",
  • "duration": null,
  • "security": null,
  • "mfaRequired": null,
  • "code": null,
  • "enrollmentCounter": null,
  • "staticEventConfig": null,
  • "stats": null,
  • "localizations": null,
  • "country": null,
  • "dashboardConfiguration": null,
  • "labels": null,
  • "tags": null,
  • "location": null,
  • "integrationDevices": null,
  • "componentConfigs": null,
  • "defaultUnits": null,
  • "builder": null,
  • "_localizableFields": [
    ]
}

Response samples

Content type
application/json
{
  • "id": null
}

Create Full Deployment

post
URL: /api/extensions/v1/deployment/full
Request Body schema: application/json
termAndConditionUrl
string or null
Default: null
privacyPolicyUrl
string or null
Default: null
eulaUrl
string or null
Default: null
object or null
Default: null
object or null
Default: null
object or null
Default: null
object or null
Default: null
Array of objects or null (Role)
Default: null
object or null
Default: null
id
string or null
Default: null
draftId
string or null
Default: null
name
string or null
Default: null
description
string or null
Default: null
status
string or null
Default: null
Enum: "DRAFT" "DEPLOYED" "ARCHIVED" null
color
string or null
Default: null
object or null
Default: null
iconFileId
string or null
Default: null
templateThumbnailFileId
string or null
Default: null
descriptionUrl
string or null
Default: null
isSaMD
boolean or null
Default: null
updateDateTime
string or null <date-time>
Default: null
createDateTime
string or null <date-time>
Default: null
Array of objects or null (CreateModuleConfigRequestObject)
Default: null
Array of objects or null (CreateFullOnboardingConfigRequestObject)
Default: null
object or null
Default: null
object or null
Default: null
object or null
Default: null
Array of objects or null (CreateFullKeyActionConfigRequestObject)
Default: null
keyActionsEnabled
boolean or null
Default: null
object or null
Default: null
object or null
Default: null
object or null
Default: null
object or null
Default: null
contactUsURL
string or null
Default: null
version
integer
Default: 0
object or null
Default: null
language
string
Default: "en"
duration
string or null
Default: null
object or null
Default: null
mfaRequired
boolean or null
Default: null
code
string or null
Default: null
enrollmentCounter
integer or null
Default: null
object or null
Default: null
object or null
Default: null
object or null
Default: null
country
string or null
Default: null
object or null
Default: null
Array of objects or null (Label)
Default: null
tags
Array of strings or null
Default: null
object or null
Default: null
Array of objects or null (IntegrationDevice)
Default: null
object or null
Default: null
object or null
Default: null
object or null
Default: null
_localizableFields
Array of strings
Default: ["builder","componentConfigs","consent","econsent","extraCustomFields","features","keyActions","learn","moduleConfigs","profile"]

Responses

Request samples

Content type
application/json
{
  • "termAndConditionUrl": null,
  • "privacyPolicyUrl": null,
  • "eulaUrl": null,
  • "privacyPolicyObject": null,
  • "termAndConditionObject": null,
  • "eulaObject": null,
  • "authorisedRep": null,
  • "roles": null,
  • "sso": null,
  • "id": null,
  • "draftId": null,
  • "name": null,
  • "description": null,
  • "status": "DRAFT",
  • "color": null,
  • "icon": null,
  • "iconFileId": null,
  • "templateThumbnailFileId": null,
  • "descriptionUrl": null,
  • "isSaMD": null,
  • "updateDateTime": null,
  • "createDateTime": null,
  • "moduleConfigs": null,
  • "onboardingConfigs": null,
  • "learn": null,
  • "consent": null,
  • "econsent": null,
  • "keyActions": null,
  • "keyActionsEnabled": null,
  • "profile": null,
  • "features": null,
  • "extraCustomFields": null,
  • "surgeryDetails": null,
  • "contactUsURL": null,
  • "version": 0,
  • "integration": null,
  • "language": "en",
  • "duration": null,
  • "security": null,
  • "mfaRequired": null,
  • "code": null,
  • "enrollmentCounter": null,
  • "staticEventConfig": null,
  • "stats": null,
  • "localizations": null,
  • "country": null,
  • "dashboardConfiguration": null,
  • "labels": null,
  • "tags": null,
  • "location": null,
  • "integrationDevices": null,
  • "componentConfigs": null,
  • "defaultUnits": null,
  • "builder": null,
  • "_localizableFields": [
    ]
}

Response samples

Content type
application/json
{
  • "id": null
}

Retrieve Deployments

post
URL: /api/extensions/v1/deployment/search
Request Body schema: application/json
skip
integer or null
Default: null
limit
integer or null
Default: null
searchCriteria
string or null
Default: null
search
string or null
Default: null
Array of objects or null (SortField)
Default: null
status
Array of strings or null
Default: null
Enum: "DRAFT" "DEPLOYED" "ARCHIVED"

Responses

Request samples

Content type
application/json
{
  • "skip": null,
  • "limit": null,
  • "searchCriteria": null,
  • "search": null,
  • "sort": null,
  • "status": null
}

Response samples

Content type
application/json
{
  • "items": null,
  • "total": null,
  • "limit": null,
  • "skip": null
}

Retrieve Modules

get
URL: /api/extensions/v1/deployment/modules

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve Deployment

get
URL: /api/extensions/v1/deployment/{deployment_id}
path Parameters
deployment_id
required
string

Responses

Response samples

Content type
application/json
{
  • "termAndConditionUrl": null,
  • "privacyPolicyUrl": null,
  • "eulaUrl": null,
  • "privacyPolicyObject": null,
  • "termAndConditionObject": null,
  • "eulaObject": null,
  • "authorisedRep": null,
  • "roles": null,
  • "sso": null,
  • "id": null,
  • "draftId": null,
  • "name": null,
  • "description": null,
  • "status": "DRAFT",
  • "color": null,
  • "icon": null,
  • "iconFileId": null,
  • "templateThumbnailFileId": null,
  • "descriptionUrl": null,
  • "isSaMD": null,
  • "updateDateTime": null,
  • "createDateTime": null,
  • "moduleConfigs": null,
  • "onboardingConfigs": null,
  • "learn": null,
  • "consent": null,
  • "econsent": null,
  • "keyActions": null,
  • "keyActionsEnabled": null,
  • "profile": null,
  • "features": null,
  • "extraCustomFields": null,
  • "surgeryDetails": null,
  • "contactUsURL": null,
  • "version": 0,
  • "integration": null,
  • "language": "en",
  • "duration": null,
  • "security": null,
  • "mfaRequired": null,
  • "code": null,
  • "enrollmentCounter": null,
  • "staticEventConfig": null,
  • "stats": null,
  • "localizations": null,
  • "country": null,
  • "dashboardConfiguration": null,
  • "labels": null,
  • "tags": null,
  • "location": null,
  • "integrationDevices": null,
  • "componentConfigs": null,
  • "defaultUnits": null,
  • "builder": null,
  • "_localizableFields": [
    ],
  • "originalId": null,
  • "orgInfo": null
}

Retrieve Latest Consent

get
URL: /api/extensions/v1/deployment/{deployment_id}/consent
path Parameters
deployment_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "enabled": "ENABLED",
  • "review": null,
  • "revision": null,
  • "additionalConsentQuestions": null,
  • "signature": null,
  • "sections": null,
  • "instituteName": null,
  • "instituteFullName": null,
  • "instituteTextDetails": null,
  • "admissionText": null,
  • "createDateTime": null,
  • "_localizableFields": [
    ]
}

Create Module Config

post
URL: /api/extensions/v1/deployment/{deployment_id}/module-config
path Parameters
deployment_id
required
string
Request Body schema: application/json
id
string or null
Default: null
updateDateTime
string or null <date-time>
Default: null
createDateTime
string or null <date-time>
Default: null
moduleId
required
string
moduleName
string or null
Default: null
shortModuleName
string or null
Default: null
status
string or null
Default: null
Enum: "ENABLED" "DISABLED" null
order
integer
Default: 0
object or null
Default: null
about
string or null
Default: null
object or null
Default: null
object (ModuleSchedule)
Array of objects or null (RagThreshold)
Default: null
learnArticleIds
Array of strings or null
Default: null
version
integer
Default: 0
object or null
Default: null
object or null
Default: null
localizationPrefix
string or null
Default: null
object or null
Default: null
goalEnabled
boolean or null
Default: null
object or null
Default: null
Array of objects or null (FeedbackTexts)
Default: null
_localizableFields
Array of strings
Default: ["about","footnote","notificationData"]

Responses

Request samples

Content type
application/json
{
  • "id": null,
  • "updateDateTime": null,
  • "createDateTime": null,
  • "moduleId": "string",
  • "moduleName": null,
  • "shortModuleName": null,
  • "status": "ENABLED",
  • "order": 0,
  • "configBody": null,
  • "about": null,
  • "footnote": null,
  • "schedule": {
    },
  • "ragThresholds": null,
  • "learnArticleIds": null,
  • "version": 0,
  • "staticEvent": null,
  • "notificationData": null,
  • "localizationPrefix": null,
  • "goal": null,
  • "goalEnabled": null,
  • "feedback": null,
  • "feedbackTexts": null,
  • "_localizableFields": [
    ]
}

Response samples

Content type
application/json
{
  • "id": null
}

Update Module Config

put
URL: /api/extensions/v1/deployment/{deployment_id}/module-config
path Parameters
deployment_id
required
string
Request Body schema: application/json
id
string or null
Default: null
updateDateTime
string or null <date-time>
Default: null
createDateTime
string or null <date-time>
Default: null
moduleId
required
string
moduleName
string or null
Default: null
shortModuleName
string or null
Default: null
status
string or null
Default: null
Enum: "ENABLED" "DISABLED" null
order
integer
Default: 0
object or null
Default: null
about
string or null
Default: null
object or null
Default: null
object (ModuleSchedule)
Array of objects or null (RagThreshold)
Default: null
learnArticleIds
Array of strings or null
Default: null
version
integer
Default: 0
object or null
Default: null
object or null
Default: null
localizationPrefix
string or null
Default: null
object or null
Default: null
goalEnabled
boolean or null
Default: null
object or null
Default: null
Array of objects or null (FeedbackTexts)
Default: null
_localizableFields
Array of strings
Default: ["about","footnote","notificationData"]

Responses

Request samples

Content type
application/json
{
  • "id": null,
  • "updateDateTime": null,
  • "createDateTime": null,
  • "moduleId": "string",
  • "moduleName": null,
  • "shortModuleName": null,
  • "status": "ENABLED",
  • "order": 0,
  • "configBody": null,
  • "about": null,
  • "footnote": null,
  • "schedule": {
    },
  • "ragThresholds": null,
  • "learnArticleIds": null,
  • "version": 0,
  • "staticEvent": null,
  • "notificationData": null,
  • "localizationPrefix": null,
  • "goal": null,
  • "goalEnabled": null,
  • "feedback": null,
  • "feedbackTexts": null,
  • "_localizableFields": [
    ]
}

Response samples

Content type
application/json
{
  • "id": null
}

Retrieve Deployment By Version Number

get
URL: /api/extensions/v1/deployment/{deployment_id}/version/{version_number}
path Parameters
deployment_id
required
string
version_number
required
string

Responses

Response samples

Content type
application/json
{
  • "termAndConditionUrl": null,
  • "privacyPolicyUrl": null,
  • "eulaUrl": null,
  • "privacyPolicyObject": null,
  • "termAndConditionObject": null,
  • "eulaObject": null,
  • "authorisedRep": null,
  • "roles": null,
  • "sso": null,
  • "id": null,
  • "draftId": null,
  • "name": null,
  • "description": null,
  • "status": "DRAFT",
  • "color": null,
  • "icon": null,
  • "iconFileId": null,
  • "templateThumbnailFileId": null,
  • "descriptionUrl": null,
  • "isSaMD": null,
  • "updateDateTime": null,
  • "createDateTime": null,
  • "moduleConfigs": null,
  • "onboardingConfigs": null,
  • "learn": null,
  • "consent": null,
  • "econsent": null,
  • "keyActions": null,
  • "keyActionsEnabled": null,
  • "profile": null,
  • "features": null,
  • "extraCustomFields": null,
  • "surgeryDetails": null,
  • "contactUsURL": null,
  • "version": 0,
  • "integration": null,
  • "language": "en",
  • "duration": null,
  • "security": null,
  • "mfaRequired": null,
  • "code": null,
  • "enrollmentCounter": null,
  • "staticEventConfig": null,
  • "stats": null,
  • "localizations": null,
  • "country": null,
  • "dashboardConfiguration": null,
  • "labels": null,
  • "tags": null,
  • "location": null,
  • "integrationDevices": null,
  • "componentConfigs": null,
  • "defaultUnits": null,
  • "builder": null,
  • "_localizableFields": [
    ]
}
Authorization
Authorization type:
  • Hawk