config.json

{
  "name": "Epic Participant Updater",
  "namespace": "Vanderbilt\\EpicParticipantUpdater",
  "description": "Fetch data from EPIC XML file.",
  "authors": [
    {
      "name": "Francesco Delacqua",
      "email": "francesco.delacqua@vumc.org",
      "institution": "Vanderbilt University Medical Center"
    }
  ],
  "framework-version": 4,
  "enable-every-page-hooks-on-system-pages": true,
  "permissions": [
    "redcap_module_system_enable",
    "redcap_module_system_disable",
    "redcap_module_project_enable",
    "redcap_data_entry_form",
    "redcap_save_record",
    "redcap_survey_complete"
  ],
  "links": {
    "control-center": [
      {
        "name": "Epic Participant Updater",
        "icon": "report",
        "url": "index.php"
      }
    ]
  },
  "no-auth-pages": [
    "api"
  ],
  "system-settings": [
    {
      "key": "api_token",
      "name": "API token (needed for protected methods)",
      "type": "text",
      "required": true
    },
    {
      "key": "epic-upload-url",
      "name": "URL endpoint for uploading participant data to Epic",
      "type": "text",
      "required": true
    }
  ],
  "project-settings": [
    {
      "key": "descriptive-text-studies",
      "name": "Watched study ID.",
      "type": "descriptive"
    },
    {
      "key": "study-id",
      "name": "Study ID",
      "type": "text",
      "required": true
    },
    {
      "key": "descriptive-text-alt-id",
      "name": "Participant ID.",
      "type": "descriptive"
    },
    {
        "key": "use-alternate-id",
        "name": "Use field other than Record ID as Participant ID in Epic?",
        "type": "checkbox",
        "super-users-only": true
    },
    {
        "key": "alternate-id-field",
        "name": "Alternate ID Field",
        "required": false,
        "type": "field-list",
        "branchingLogic": {
            "field": "use-alternate-id",
            "value": "1"
        },
        "super-users-only": true
    },
    {
        "key": "descriptive-text-mapping",
        "name": "Set the mapping fields.",
        "type": "descriptive"
    },
    {
      "key": "mrn-mapping-field",
      "name": "MRN",
      "required": true,
      "type": "field-list"
    },
    {
      "key": "status-mapping-field",
      "name": "Status",
      "required": true,
      "type": "field-list"
    },
    {
      "key": "date-start-mapping-field",
      "name": "Study start date",
      "required": false,
      "type": "field-list"
    },
    {
      "key": "date-end-mapping-field",
      "name": "Study end date",
      "required": false,
      "type": "field-list"
    },
    {
      "key": "study-id-mapping-field",
      "name": "Study ID",
      "required": false,
      "type": "field-list"
    },
    {
      "key": "fn-mapping-field",
      "name": "Given Name Field",
      "required": false,
      "type": "field-list"
    },
    {
      "key": "ln-mapping-field",
      "name": "Family Name Field",
      "required": false,
      "type": "field-list"
    },
    {
      "key": "dob-mapping-field",
      "name": "Date of Birth Field",
      "required": false,
      "type": "field-list"
    },
    {
      "key": "event-id",
      "name": "Fields event",
      "required": true,
      "type": "event-list"
    },
    {
      "key": "descriptive-status-list",
      "name": "Enter a list of status (one per line) that will trigger an action. Leave blank for any field. Some valid statuses are 'Interested', 'On Study', 'Pre-Screening'.",
      "type": "descriptive"
    },
    {
      "key": "status-list",
      "name": "Status List",
      "required": false,
      "type": "textarea",
      "repeatable": false
    },
    {
      "key": "run_hook",
      "name": "Call REDCap's save record hook on data import from Epic",
      "type": "radio",
      "choices": [
        {"value":"yes", "name":"Yes"},
        {"value":"no", "name": "No"}
      ]
    },
    {
        "key": "run_on_record_save",
        "name": "Run status update on record save instead of survey submission?",
        "type": "checkbox",
        "super-users-only": true
    },
    {
      "key": "descriptive-pushing-status-values",
      "name": "The setting below allows users to automate sending data to remote webhooks based on specific criteria. Users can define a <i>form</i>, <i>field</i>, and <i>value</i>; when the <i>field</i>'s value matches the specified <i>value</i>, a predefined <i>status</i> is sent to the webhook. If the criteria are not met, no data is sent.<br><br>Important Note: If you configure multiple settings for the same <i>form</i> but different <i>fields</i>, be aware that if both criteria are true simultaneously, the software will send data for each matching condition. This can potentially create race conditions and lead to multiple, rapid data transmissions. Please consider this when setting up your configurations to avoid unintended behavior.",
      "type": "descriptive"
    },
    {
      "key": "pipe-pairing",
      "name": "Field and Value Pairs for Pushing Status Values",
      "type": "sub_settings",
      "repeatable": true,
      "sub_settings": [
        {
          "key": "push-form",
          "name": "Survey Form That Updates Status Upon Completion",
          "required": false,
          "type": "form-list",
          "repeatable": false
        },
        {
          "key": "push-field",
          "name": "Field required to have a value to trigger status update to Epic (leave blank to trigger on any save of survey form)",
          "required": false,
          "type": "field-list"
        },
        {
          "key": "push-value",
          "name": "Value required in the field above to trigger status update to Epic (leave blank to trigger on any value)",
          "required": false,
          "type": "text"
        },
        {
          "key": "push-status",
          "name": "Status Value to Push to Epic",
          "required": false,
          "type": "text"
        }
      ]
    }
  ],
  "log-file": "log.txt"
}