How to Upload Notes
The first step in a new data extraction project is to upload the records data from which you'd like to extract variables.
Data Format
Brim uses a "Comma-separated values file" or CSV format to input this data. You can find a sample Data CSV file here.
The data CSV has one document per row, and should be formatted as described below. Note that the field name must be in the CSV header.
Each row must have a unique pair of NOTE_ID and PERSON_ID fields in order to be successfully imported.
| Field Name | Field description | Notes |
| NOTE_ID | Alphanumeric identifier of the Note | The combination of NOTE_ID and PERSON_ID must be unique for each row. |
| PERSON_ID | Alphanumeric identifier for the Patient | The combination of NOTE_ID and PERSON_ID must be unique for each row. |
| NOTE_DATETIME | Timestamp when a note was written. Format must be: "YYYY-MM-DD HH:MM:SS" |
|
| NOTE_TEXT | The text of the note. | |
| NOTE_TITLE | The title of the note. | It is helpful if the notes have meaningful titles that contain the note type eg "Pathology Report", "ED Intake" |
Example:
NOTE_ID,PERSON_ID,NOTE_DATETIME,NOTE_TEXT,NOTE_TITLE
1, 12345, 2023-01-01 12:00:00, "Example note text.", "Example Note Title"
Important Notes:
Escape quotation marks with double quotation marks (i.e., " becomes "").
How to upload data
- Access Project Setup on your Project Dashboard.
- Click on the first section, which should be named "Project Setup".
- Preparing a CSV
- Click on the "Upload CSV" option.
- You can click on "Example Format" to see the required fields in the CSV. This section also includes some formatting notes, and a link to a Sample CSV file.
- The file should have a row for each note, including a unique identifier for the note, a unique identifier for the patient (often an MRN), and the note's date, title, and text.
- Select File
- Click "Choose File", and then choose the CSV file you want to upload from your desktop.
- Upload File
- Click on the "Upload" button to upload the selected file.
- Depending on the size of the file, this might take a few seconds, a few minutes, or longer for very long files. You'll see the status in the table change to "Complete" when the data is ready.
- Preview Data
- After the upload is complete, you can preview the data to ensure it was uploaded correctly by clicking "Preview Data"