Skip to main content

Creating Electronic Case Report Forms (eCRFs)

This guide walks you through designing and publishing a new Electronic Case Report Form (eCRF) in Frappe and viewing it in the clinical study application.

Target Audience

RoleAccess Level
AdministratorFull access to Frappe and CRF design

Prerequisites

  • Access to your Frappe instance
  • Administrator credentials
  • Access to the clinical study application

Step 1: Login to Frappe

  1. Navigate to {your-frappe-host}/login
  2. Enter your credentials

Frappe Login - Enter email and password


Step 2: Navigate to DocType List

Go to the DocType list in the Healthcare module:

{your-frappe-host}/app/doctype?module=Healthcare

DocType List - Healthcare module view


Step 3: Create a New CRF Form

  1. Click Add DocType
  2. Name your form with the prefix CRF_FORM_
    • Example: CRF_FORM_MICRONUTRIENTS_ANTIOXIDANTS

Add DocType - Create new CRF form with naming prefix

Naming Convention

Always prefix your CRF forms with CRF_FORM_ to ensure they are recognized by the application.


Step 4: Design Required Fields

4.1 Natural Key Field (Required)

This must be the first field in your form:

PropertyValue
LabelDescriptive name (e.g., "Micronutrients Study Id")
TypeSelect
Namenaming_series
Naming SeriesShort identifier (e.g., MAIHIV-.####)

Natural Key Field - Configure naming series

note

The naming series should be a short form of your form name followed by .#### for auto-numbering.

4.2 Relationship Fields (Required)

Add these three required fields:

FieldLink To
StudyStudy DocType
Study EventStudy Event DocType
SubjectSubject DocType

Relationship Fields - Study, Study Event, and Subject links

important

Position the Study and Subject fields next to each other as they are both read-only display fields.


Step 5: Add Form-Specific Fields

Add the data collection fields for your study.

Checkbox Field Example

PropertyValue
LabelHas the patient received initiation counselling?
TypeCheck
Namehas_patient_received_initiation_counselling

Checkbox Field - Boolean data capture

Field Naming

Use slugified form of the label for the field name.

Date Field Example

PropertyValue
LabelInitiation counselling session 1 Date
TypeDate
Nameini_coun_session_1_date

Date Field - Date picker configuration

Select Field Example

PropertyValue
LabelInitiation counselling session 1 Type
TypeSelect
Nameini_coun_session_1_type
OptionsOne option per line

Select Field - Dropdown configuration

Select Options - Define dropdown values


Step 6: Save Your Form

Click Save to publish the form.

Save Form - Publish the CRF


Step 7: Add CRF to a Study

  1. Navigate to Studies in the clinical application
  2. Select the target study
  3. Go to the CRFs tab
  4. Click Add CRFs
  5. Select your newly created form
  6. Click Add

Add CRF to Study - Select and attach CRF form


Step 8: View CRF in Action

note

CRF forms are accessed through the participant/subject interface.

  1. Navigate to Subjects tab in your study
  2. Select a subject
  3. Your CRF form appears in the left navigation
  4. Click on the form name
  5. Click Add First CRF Entry to begin data capture

CRF in Action - Subject view with CRF form ready for data entry


Quick Reference

RequirementDetails
Form prefixCRF_FORM_
Required fieldsnaming_series, Study, Study Event, Subject
Access pointSubject/Participant view

Troubleshooting

IssueSolution
Form not in CRF listVerify form name starts with CRF_FORM_
Form not appearingEnsure all required fields are present
Data not savingRefresh the application and retry