Articles in this section

"PainChek Assessment" Assessment object

  • Updated

The basic assessment details are recorded inside the "Assessment" assessment object. It records information such as the time of the assessment and the pain level observed.

Note

Note that this basic "Assessment" object is part of the broader full "Assessment" data object - see Managing PainChek Assessments

Key Assessment Fields

Field

Type

Comment

date

Date Time

The time the assessment was created.

Date in ISO 8601 format. Note that this time includes a timezone indicator and that must be taken into account when displaying the date to a user.

mode

Mandatory String

The assessment mode - one of:

"painchek" - An full PainChek assessment has been performed (applies to this page)

"nrs" - An NRS assessment has been performed (see Managing NRS Assessments )

pain_score

Mandatory Integer

Sum of "score" items (for a "painchek" mode assessment only)

pain_level

Mandatory String

The level corresponding to the pain_score - one of:

  • none

  • mild

  • moderate

  • severe

is_editable

Mandatory Boolean

Indicates if the record can be edited. It should always be false.

timing

Mandatory String

The conditions under which the assessment was performed - one of:

  • movement - assessment was performed on a person during (or immediately after) activity/movement

  • rest - assessment was performed on a person when they were stationary

Note

The field indicated above with "Mandatory*" may contain nulls. This applies to old records only (i.e. those created prior to the introduction of the V2 data format) - any new records will have the field populated.

A sample "Assessment" assessment object is shown below:

"assessment": {
     "date": "2018-03-20T22:41:07.530228Z",
     "mode": "painchek",
     "pain_score": 15,
     "pain_level": "moderate",
     "is_editable": false,
     "timing": null
        }

Related articles