You can use the PainChek API to view and manage PainChek comments (these are notes recorded for a patient).
Key Comment fields
Field |
Type |
Comment |
---|---|---|
patient |
Mandatory UUID |
The UUID of the patient this comment belongs to |
device_id |
Mandatory UUID |
The UUID of the device that the comment was recorded on |
user |
Mandatory UUID |
The UUID of the user that recorded the comment |
content |
Mandatory String |
The comment |
Listing Comments
To list all Users in your PainChek instance (in the User Acceptance Environment), issue the following command:
curl https: //ua.ap.painchek.com/api/comments/ |
Sample return data:
Creating a Comment
To create a comment, issue the following command (which shows the minimum fields that need to be supplied ):
curl \ -H "Content-Type: application/json" \ -X POST https: //ua.ap.painchek.com/api/comments/ -d @- << EOF { "patient" : "aed4e174-b96f-4f21-bd4f-c26097a8e22e" , "content" : "Adding a comment" } EOF |
This is no need to supply the mandatory user field as the credentials used to access the API will determine the user.
The return is the full comment record:
Updating a Comment
This is currently an unsupported action and should not be attempted