Articles in this section

Managing PainChek Assessments

  • Updated

You can use the PainChek API to view PainChek assessment records.

Key Assessment Fields

Field
Type
Comment
More Details
patient Mandatory UUID The UUID of the patient this assessment belongs to  
patient_first_name Mandatory String The first name of the patient  
patient_last_name Mandatory String The last name of the patient  
patient_external_id Optional String The external identifier of the patient  Using External Ids
user Mandatory UUID The UUID of the user that recorded the assessment  
user_first_name Mandatory String The first name of the user  
user_last_name Mandatory String The last name of the user  
user_external_id Optional String The external identifier of the user Using External Ids
user_position
 Optional String

The position or job role assigned to the user.

  
user_source Mandatory String Indicates if the user belongs to the same license as the patient (in which case source will be "internal") or to another license (source will be "external").  
json_version Mandatory String The data format version ("v2" is the current version)  
assessment JSON Object The basic assessment details such as the date and pain score. "Assessment" Assesment object
device JSON Object The details of the device the assessment was performed on. "Device" Assessment Object
face JSON Object The assessment details for the face domain.  "Face Domain" Assessment Object
voice JSON Object The assessment details for the voice domain. "Voice Domain" Assessment Object
movement JSON Object The assessment details for the movement domain. "Movement Domain" Assessment Object
behaviour JSON Object The assessment details for the behaviour domain "Behaviour Domain" Assessment Object
activity JSON Object The assessment details for the activity domain. "Activity Domain" Assessment Object
body JSON Object The assessment details for the body domain. "Body Domain" Assessment Object


To list all Assessments in your PainChek instance (in the User Acceptance Environment), issue the following command:

curl https://ua.ap.painchek.com/api/assessments/

You can limit the assessments to just PainChek assessments by passing the mode field:

curl https://ua.ap.painchek.com/api/assessments/?mode=painchek

Sample return data:

{
 "count": 1114,
 "next": "https://ua.ap.painchek.com/api/assessments/?page=4&page_size=1",
 "previous": "https://ua.ap.painchek.com/api/assessments/?page=2&page_size=1",
 "results": [
   {
    "uuid": "b505c2c1-552c-4590-a8f5-ebc440c80583",
    "patient": "9c2fa320-f080-4f2f-bc30-d5f2234c675e",
    "patient_first_name": "Fred",
    "patient_last_name": "Smith",
    "patient_external_id": "1098", 
    "user": "c5fff8fd-e022-4ba4-a35d-ddee6b9fa276",
    "user_first_name": "Mary",
    "user_last_name": "Smith",
    "user_external_id": null,
    "user_source": "internal",
    "json_version": "v2",
    "created_at": "2018-03-20T22:40:56.836000Z",
    "modified_at": "2018-03-20T22:40:59.906000Z",
    "deleted_at": null,
    "update_stamp": 1347, 
      "assessment": {
        "date": "2018-03-20T22:41:07.530228Z",
        "mode": "painchek",
        "pain_score": 15,
        "pain_level": "moderate",
        "is_editable": false,
        "timing": "rest"
         },
       "device": {
         "manufacturer": "apple",
         "model": "iphone11,2",
         "os_type": "ios",
         "os_version": "14.0",
         "app_version": "2.17(294)"
         "device_id": "1F4325EE-94F2-47B0-97A3-E8BCF123DAEC"
         },
      "face": {
        "score": 9,
        "comment": null,
        "mode": "video",
        "initial_mode": null,
        "camera": null,
        "capture_seconds": null,
        "frames": null,
        "frame_errors": null,
        "descriptors": {
         "brow_lowering": true,
         "cheek_raising": true,
         "tightening_eyelids": true,
         "wrinkling_nose": true,
         "raising_upper_lip": true,
         "pulling_corner_lip": true,
         "mouth_stretch": true,
         "parting_lips": true,
         "closing_eyes": true
         }
        },
       "voice": {
        "score": 1,
        "comment": null,
        "voice_recording": null,
        "descriptors": {
         "noisy_sounds": false,
         "requesting_help": false,
         "groaning": false,
         "moaning": false,
         "crying": false,
         "screaming": false,
         "loudtalk": false,
         "howling": false,
         "sighing": true
         }
        },
       "movement": {
        "score": 1,
        "comment": null,
        "descriptors": {
         "altered_random_movement": false,
         "restlessness": false,
         "freezing": false,
         "guarding_touching": false,
         "moving_away": false,
         "abnormal_movement": false,
         "pacing_wandering": true
        }
       },
       "behaviour": {
        "score": 1,
        "comment": null,
        "descriptors": {
         "introvert": false,
         "verbally_offensive": false,
         "aggressive": false,
         "fear_or_dislike": false,
         "inappropriate_behaviour": false,
         "confused": false,
         "distressed": true
       }
      },
      "activity": {
       "score": 1,
       "comment": null,
       "descriptors": {
        "resisting_care": false,
        "prolonged_resting": false,
        "altered_sleep": true,
        "altered_routine": false
       }
      },
     "body": {
      "score": 2,
      "comment": null,
      "descriptors": {
       "profuse_sweating": true,
       "pale_flushed": false,
       "feverish_cold": false,
       "rapid_breathing": false,
       "painful_injuries": false,
       "painful_conditions": true
}
}
}
]
}

Creating an Assessment

(warning) This is currently an unsupported action and should not be attempted

Updating an Assessment

(warning) This is currently an unsupported action and should not be attempted

Related articles