Add ecg module information

content/en/docs/IV/modules/ecg/_index.md

@@ -0,0 +1,23 @@
+---
+title: "ECG"
+linkTitle: "ECG"
+date: 2023-10-02
+weight: 60
+description: >
+  The ECG module provides waveform data, and lookup tables which can be used to link subjects to other MIMIC-IV modules via `subject_id`. A `study_id` allows for linking within the ECG module while `note_id` allows linking to the cardiologist note in the MIMIC-IV-Note module.   
+---
+
+The MIMIC-IV-ECG module contains approximately 800,000 diagnostic electrocardiograms across nearly 160,000 unique patients. 
+
+There are three lookup tables in this module:
+- A records file, `record-list.csv`, provides a mapping between the study (`study_id`), the path to the diagnostic ECG waveform (`path`), and the patient (`subject_id`).
+- A machine measurements file, `machine_measurements.csv`, provides the information generated from the ECG machine including global (across all 12 leads) summary measurements (RR interval, QRS onset, etc.), the machine generated report, as well as machine and cart information. It also provides a study (`study_id`) and patient (`subject_id`) identifier.
+- A note linking file, `waveform_note_links.csv`, provides a `note_id` for each waveform that has an available free-text cardiologist note in the MIMIC-IV-Note module. It also provides a study (`study_id`) and patient (`subject_id`) identifier.
+
+Additional details for each lookup table are provided in the pages below.
+
+{{% pageinfo %}}
+Please note that the free-text cardiologist notes for the ECG module will be publicly released in the MIMIC-IV-Note module at a later date.
+{{% /pageinfo %}}
+
+**For additional information about this project please see the MIMIC-IV-ECG project on physionet.org.**

content/en/docs/IV/modules/ecg/machine_measurements.md

@@ -0,0 +1,84 @@
+---
+title: "Machine Measurement"
+linktitle: "machine_measurements"
+date: 2023-10-02
+weight: 20
+description: >
+  A table with ECG machine information and output measurements / reports.
+---
+
+This table provides information about the machine used to collect a diagnostic ECG along with the output from that machine - summary measurements (RR interval, QRS onset, etc) and machine generated reports.
+Each diagnostic ECG study has a waveform file (in WFDB format) and is assigned a unique `study_id`.
+This table contains a variety of columns which provide machine and measurement / report information. The `study_id` can be used to link to the record list (with the path to waveform), and cardiologist note.
+
+# Important considerations
+
+- Diagnostic ECGs are available for patients from the MIMIC-IV Clinical Database. These ECGs were collected between 2008 - 2019 but have been date shifted (for de-identification) per the convention across MIMIC.
+- For a given subject, all available diagnostic ECGs (inpatient and outpatient) were pulled. Therefore, a large number of the waveforms will overlap with visits in the Clinical Database but some will not.
+
+# Table columns
+This information is also available in the `machine_measurements_data_dictionary.csv` in the MIMIC-IV-ECG project on [physionet.org](https://physionet.org/).
+
+## `subject_id`
+
+`subject_id` is a unique identifier which specifies an individual patient. Any rows associated with a single `subject_id` pertain to the same individual.
+
+## `study_id`
+
+A unique identifier for the diagnostic ECG study.  
+
+## `cart_id`
+
+An identifier specific to the ECG cart used to collect the diagnostic ECG waveform.
+
+## `ecg_time`
+
+The time that the diagnostic ECG was collected.
+
+## `report_#`	
+
+A text based cardiology report generated by the ECG machine. A variable number of report #'s are expected and can be separated by blank rows.
+
+## `bandwidth`
+
+The bandwidth of the ECG machine
+
+## `filtering`	
+
+An indicator for the filter setting
+
+## `rr_interval`	
+
+Time between successive R-waves (msec)
+
+## `p_onset`	
+
+Time at the onset of the P-wave (msec)
+
+## `p_end`	
+
+Time at the end of the P-wave (msec)
+
+## `qrs_onset`	
+
+Time at the beginning of the QRS complex (msec)
+
+## `qrs_end`	
+
+Time at the end of the QRS complex (msec)
+
+## `t_end`	
+
+Time at the end of the T-wave (msec)
+
+## `p_axis`	
+
+The electrical axis of the P-wave (degrees)
+
+## `qrs_axis`	
+
+The electrical axis of the QRS complex (degrees)
+
+## `t_axis`	
+
+The electrical axis of the T-wave (degrees)

content/en/docs/IV/modules/ecg/record_list.md

@@ -0,0 +1,39 @@
+---
+title: "ECG Record Table"
+linktitle: "record_list"
+date: 2023-10-02
+weight: 10
+description: >
+  The table which lists all available records in this module.
+---
+
+This table lists all records in the MIMIC-IV-ECG module.
+Each diagnostic ECG study has a waveform file (in WFDB format) and is assigned a unique `study_id`.
+This table contains the path (`path`) to the waveform file. The `study_id` can be used to link to the machine measurement and note information in the other lookup tables.
+
+# Important considerations
+
+- Diagnostic ECGs are available for patients from the MIMIC-IV Clinical Database. These ECGs were collected between 2008 - 2019 but have been date shifted (for de-identification) per the convention across MIMIC.
+- For a given subject, all available diagnostic ECGs (inpatient and outpatient) were pulled. Therefore, a large number of the waveforms will overlap with visits in the Clinical Database but some will not.
+
+# Table columns
+
+## `subject_id`
+
+`subject_id` is a unique identifier which specifies an individual patient. Any rows associated with a single `subject_id` pertain to the same individual.
+
+## `study_id`
+
+A unique identifier for the diagnostic ECG study.  
+
+## `file_name`
+
+The name of the `.hea` and `.dat` WFDB files for a given study. 
+
+## `ecg_time`
+
+The time that the diagnostic ECG was collected.
+
+## `path`
+
+The path to the waveform file.

content/en/docs/IV/modules/ecg/waveform_note_links.md

@@ -0,0 +1,44 @@
+---
+title: "Waveform Note Links Table"
+linktitle: "waveform_note_links"
+date: 2023-10-02
+weight: 30
+description: >
+  A table which provides links between waveforms and available cardiologist notes.
+---
+
+{{% pageinfo %}}
+Please note that the free-text cardiologist notes for the ECG module will be publicly released in the MIMIC-IV-Note module at a later date.
+{{% /pageinfo %}}
+
+This table provides links to the cardiologist's note, when available, for a given diagnostic ECG waveform.
+Each diagnostic ECG study has a waveform file (in WFDB format) and is assigned a unique `study_id`. Not all waveforms get read by a cardiologist.  This is the primary reason that there are fewer notes than waveforms.
+This table provides the link between the path to a given waveform (`waveform_path`) and the note identifer (`note_id`). The `study_id` can be used to link to the record list and machine measurement information in the other lookup tables.
+
+# Table columns
+
+## `subject_id`
+
+`subject_id` is a unique identifier which specifies an individual patient. Any rows associated with a single `subject_id` pertain to the same individual.
+
+## `study_id`
+
+A unique identifier for the diagnostic ECG study.  
+
+## `waveform_path`
+
+The path to the diagnostic ECG waveform. 
+
+## `note_id`
+
+The unique identifier for the note that is associated with a given ECG study. This identifier can be used to link to the free-text cardiologist ECG note in the MIMIC-IV-Note module.
+
+## `note_seq`
+
+A monotonically increasing integer which chronologically sorts the notes. That is, notes can be ordered sequentially by note_seq.
+
+## `charttime`
+The time at which the note was charted - this is usually the most relevant time for interpreting the content of the note, but it is not necessarily when the note was fully written.
+
+
+