Skip to main content

Dynamic Data Pull (DDP) - Custom

The Dynamic Data Pull (DDP) is a special feature for importing data into REDCap from an external source system. It provides an adjudication process whereby REDCap users can approve all incoming data from the source system before it is officially saved in their REDCap project.

Before the DDP can be used by REDCap users, it must first be set up and enabled on this page. The DDP operates by communicating with two web services (with an optional third web service) via HTTP/HTTPS, by which REDCap will make requests to those web services, and the services will respond back with an appropriate response for the specific action made by REDCap. The technical specifications of these web services are described in the PDF that is available for download below. Also below is a link to a page that describes how to use the DDP once it has been set up and enabled, in which the link to the page can sent to end-users who are interested in using the DDP.

Enable Dynamic Data Pull (DDP)
Once DDP is enabled for the system, it can then be enabled for a given project by an Administrator on the project's Project Setup page (in the 'optional modules and customizations' section).
NOTE: If either the 'metadata web service' or 'data web service' are not defined below or if the services are not set up correctly, then the DDP will not function. It is recommended that both of those mandatory services be created and set up prior to enabling DDP.
Custom name for the external source system
This will be the name of the source system as it is displayed for the user. If left blank, it will simply say 'source system' in its place.

e.g., Epic, Cerner, EMR, EDW
URL for Metadata Web Service
A valid web address (URL) that is reachable by the REDCap web server.
* must provide value

REDCap will make requests to this web address when users are mapping fields from the source system. This web service provides a list of all fields (and their attributes) that are available from the source system.
* See the technical documentation PDF for details on this web service
URL for Data Web Service
A valid web address (URL) that is reachable by the REDCap web server.
* must provide value

REDCap will make requests to this web address when pulling data from the source system for an individual record. When REDCap calls this web service, in which REDCap will provide details on the data requested, the web service will return the data available for the record in the specified format prescribed in the technical documentation PDF above.
* See the technical documentation PDF for details on this web service
URL for User Access Web Service (optional)
A valid web address (URL) that is reachable by the REDCap web server.

REDCap will make requests to this web address when validating if the current user has proper authorization for adjudicating data and/or accessing data from the source system. This web service will only be called once per project per session. If the user is determined by the service not to have access, then they will be given an error message if they attempt to adjudicate any data from the source system. Note: This service is only optional for extra security.
* See the technical documentation PDF for details on this web service
Custom text specific to your institution to display to users
This text will be displayed at the top of DDP's informational popup window. Your text should describe your institution's process and/or procedures that are required in order for DDP to be enabled for a project or user. It may include a link to a survey or request form for collecting requests from users who wish to use DDP.
Expand 
HTML may be used in order to adjust the style of the text or to display links, images, etc.
If left blank, then it will display the following text to the user:
"To utilize the Dynamic Data Pull (DDP) for a REDCap project, please contact your REDCap administrator regarding the process entailed and procedures required in order to have the DDP enabled for the project and also for an individual to be given authorization to use the DDP."
Display information about DDP on Project Setup page in a project?
If 'No' is selected, then DDP will not be advertised to users on the Project Setup page, and all information about DDP will never be displayed anywhere in a project. Setting it to 'No' is preferable if you wish to make DDP known to only a limited number of users without advertising it to all users.
Allow normal users to grant DDP user privileges to other users in a project?
NOTE: If the 'User Access Web Service' is not defined above, then it is HIGHLY recommended that this option be set to 'No' for security purposes if the data from the source system is considered sensitive or confidential in nature.
Setting it to 'No' will allow only Administrators to grant users DDP privileges on the User Rights page in a project. Typically, 'Yes' will be selected if you are utilizing the User Access Web Service, which will automatically restrict users from accessing data from the external source system from within REDCap if the web service notes that they should not have access.
Time interval that REDCap will check the source system for new data for individual records Every hours (min: 1, max: 999)
Records in DDP-enabled projects will be checked for new data from the external source system at this regular interval of time, in which the exact time of the data fetch is determined from the time of the last data fetch for a given record. This automatic data fetching will be performed by a cron job running in the background.
Time of inactivity after which REDCap will stop checking for new data from the source system
(for projects and individual records)
days (min: 1, max: 100)
If a DDP-enabled project has not had any logged activity in this amount of time, then no records in the project will be automatically checked in the source system at the regular interval above. Also, if a specific record within an active DDP-enabled project has not had its data modified in this amount of time, then it will not be automatically checked in the source system at the regular interval above.
Convert source system timestamps from GMT to local server time?
If the source system has temporal data with dates/datetimes of service that are being output in Greenwich Mean Time (GMT), setting this to 'Yes' will automatically correct all associated timestamps so that they appear in local time in the adjudication popup.
Note: You should only set this to 'Yes' if you can absolutely verify that the timestamps associated with incoming data values are in GMT time instead of in local time. Also, if this is turned on after some data is pulled into a project from the external system, it will not retroactively fix any of their timestamps but will instead only have an effect on new data imported after the fact.