susom/redcap-em-imagemap-fork

Name: redcap-em-imagemap-fork

Owner: Stanford School of Medicine

Description: Painmap REDCap external module

Forked from: ctsit/imagemap

Created: 2018-01-24 21:14:45.0

Updated: 2018-02-03 17:49:11.0

Pushed: 2018-02-03 17:58:01.0

Homepage:

Size: 509

Language: HTML

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

REDCap module: Image Map

This REDCap module improves the survey participants experience by providing an easy way to indicate painful body parts as well as levels of pain. Such improvement is achieved by allowing the user to select the image representing the user's current pain level or by clicking predetermined regions in a diagram of the human body.

Prerequisites

• REDCap >= 8.0.0 (for versions < 8.0.0, REDCap Modules is required).

Easy Installation

• Obtain this module from the Consortium REDCap Repo from the control center.

Manual Installation

• Clone this repo into <redcap-root>/modules/imagemap_v0.0.
• Go to Control Center > External Modules and enable Pain Map.
• To activate this module for a particular project, go to the project home page, click on the External Modules link, and then enable Pain Map for that project.

Features included

This module defines a new action tag: @IMAGEMAP. The possible values for this tag are PAINMAP_MALE (representation of a generic male body), PAINMAP_FEMALE (representation of a female body), and SMILE_SCALE (six faces diagram); they correspond to the following images:

PAINMAP_MALE

PAINMAP_FEMALE

SMILE_SCALE

Usage

To display one of the images above in a survey or data entry form, add a new field of type Text Box and include one of the following options in the Action Tags / Field Annotation (optional) field:

@IMAGEMAP=PAINMAP_MALE 
@IMAGEMAP=PAINMAP_FEMALE
@IMAGEMAP=SMILE_SCALE

Each body part selected is associated with a key, for example the “Ankle (front-left)” of the female body diagram is linked to the key “f34”. To find a particular key for a body part, please refer to the html files (map files) located in the folder maps. After selecting multiple body parts, the field containing the action tag @IMAGEMAP will have as value a string of comma-separated keys, e.g. “f36,f17,f18,f21”. Similarly, if using the faces diagram, the field containing the action tag (i.e. @IMAGEMAP=SMILE_SCALE) will have the value corresponding to the face clicked, which ranges from 1 to 7.

Acknowledgements

The original body was devised by Drs. Ming-Chih J Kao and Professor Sean Mackey at Stanford University as part of CHOIR. The imagemap plugin/hook was written at Stanford by Andrew Martin and converted to an external module in collaboration with the great folks at CTS-IT - University of Florida.

Use of the 'bodymap' images requires that the CHOIR attribution remains in tact.