You can use the PainChek API to view NRS assessment records.
|
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 |
|
|
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 patient |
|
|
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. |
|
|
device |
JSON Object |
The details of the device the assessment was performed on. |
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 NRS assessments by passing the mode field:
curl https://ua.ap.painchek.com/api/assessments/?mode=nrs
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": "nrs",
"pain_score": 5,
"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"
}
]
}
Note that the NRS assessment format is effectively a sub-set of a full PainChek assessment (see Managing PainChek Assessments for more details on the PainChek assessment format).