Articles in this section

"NRS 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 NRS 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 (see Managing PainChek Assessments )

"nrs" - An NRS assessment has been performed (applies to this page)

pain_score

Mandatory Integer

Score reported by the user (from 0 to 10)

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

body_location

Optional String

Location of the pain reported by the user.

Will be null if the user did not record a body location.

Note

This block of data is essentially the same as the corresponding block used for PainChek assessments - see "PainChek Assessment" Assessment object

A sample "Assessment" assessment object is shown below:

"assessment": {
   "date": "2021-03-20T22:41:07.530228Z",
   "mode": "nrs",
   "pain_score": 5,
   "pain_level": "moderate",
   "is_editable": false,
   "timing": "movement",
   "body_location": "neck and shoulders"
  }

Related articles