Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Initial federated COVID-rich ICU database documentation. #209

Open
wants to merge 25 commits into
base: main
Choose a base branch
from

Conversation

danamouk
Copy link
Contributor

@danamouk danamouk commented Sep 22, 2023

This pulls request provides initial documentation to the tables and standard terminologies included as part of MIMIC-Fed, a large, freely available federated COVID-rich ICU database comprising deidentified health-related data from Beth Israel Deaconess Medical Center (BIDMC) and Northwestern Memorial HealthCare (NMHC).

The following tables are included as part of the hospital and icu modules in version 0.1.0 of the federated database:

  • Hosp Module: Admissions, Patients, Labevents, D_labitems, Diagnoses_icd, D_icd_diagnosis, Prescriptions, Emar.
  • ICU Module: ICU_stays, D_items , Chartevents (vital signs), Procedure events.

@danamouk danamouk changed the title Initial Federated COVID-rich ICU database documentation. Initial federated COVID-rich ICU database documentation. Sep 22, 2023
@bemoody
Copy link

bemoody commented Sep 27, 2023

MIMIC-Fed is a large, freely available federated COVID-rich ICU database

I'm not sure that "freely available" is a good description and would take those words out.

In any event this database isn't yet available at all. Please add the following at the top of the page (maybe it should be added to each sub-page too?)

{{% pageinfo %}}
MIMIC-Fed is not yet released and its structure is subject to change.
{{% /pageinfo %}}

It is not clear to me what the long-term relationship will be between this data and "MIMIC-IV" as we know it. I think it would be unfortunate to have two sets of documentation (that both have to be maintained and that would confuse visitors). At the same time we don't want to give the impression that the new COVID stuff is already integrated in MIMIC-IV.

In terms of the website structure, I'd suggest one of two things:

  • Inside the MIMIC-IV top-level section, add a subsection (at the end, after Tutorials) labelled Federated (Beta).

  • Add a new top-level section (at the end, after MIMIC-II) labelled Federated (Beta).

As this database isn't released (nor is it a replacement for MIMIC-IV), it shouldn't be given "top billing" above MIMIC-IV, and at the same time the hope is that eventually this will be part of MIMIC-IV (it's clearly not separate from MIMIC-IV in the way that MIMIC-III is.)

@tompollard how would you feel about these options?

Additionally, someone suggested that "Federated" might not be a good term since it has a specific technical meaning when talking about databases. Perhaps "Multi-center" could be used instead?

@danamouk
Copy link
Contributor Author

thanks @bemoody for the suggestions. I have updated the changes detailed in the commits.

@danamouk
Copy link
Contributor Author

@tompollard let us know if the changes look ok and we can deploy the changes on the website.

@danamouk
Copy link
Contributor Author

danamouk commented Oct 4, 2023

After discussions with @rgmark, @bemoody, @tompollard and @alistairewj, I have restructured the mimic-northwestern multi-center database to the main docs page, and replaced mentions of "federated" with "multi-center" to avoid confusion with another technical term under the term "federated learning".

This is a version that tries to address most of the points raised, though I think the website could be reviewed for any further suggestions either on formatting or naming etc.

Copy link
Member

@alistairewj alistairewj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

some comments here and there

content/en/docs/multi-center/modules/hosp/admissions.md Outdated Show resolved Hide resolved
content/en/docs/multi-center/_index.md Outdated Show resolved Hide resolved
content/en/docs/multi-center/modules/hosp/admissions.md Outdated Show resolved Hide resolved
`icd_code` is the International Coding Definitions (ICD) code.

### `icd_version`
There are two versions for this coding system: version 9 (ICD-9) and version 10 (ICD-10). These can be differentiated using the `icd_version` column. [ICD-9](https://www.cms.gov/Medicare/Coding/ICD9ProviderDiagnosticCodes/codes) and [ICD-10](https://www.cms.gov/Medicare/Coding/ICD10/2019-ICD-10-CM.html) diagnosis codes are acquired from Centers for Medicare & Medicaid Services (CMS).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

all of the data for this subset should be ICD-10 - can't imagine NW using ICD-9 in 2020 onward - perhaps make it clear the description of ICD-9 is just for informational purposes?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes, added a clarifying statement to indicate ICD 9 codes are just for informational purposes, after mandate of ICD10 in 2015 based on CMS.


We provide a list of common COVID-19 tests and measurements in the database, as defined by LOINC terminology, below:

- SARS-CoV-2 (COVID-19) [Presence] in Specimen by Organism specific culture
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

would be useful to add itemid and the LOINC for these examples

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

updated!

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hmm I don't see it? something wrong with my viewer or did the commit not go through?

Copy link
Contributor Author

@danamouk danamouk Oct 19, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it is actually part of commit 2f8806e.

content/en/docs/multi-center/modules/hosp/labevents.md Outdated Show resolved Hide resolved
content/en/docs/multi-center/modules/hosp/patients.md Outdated Show resolved Hide resolved
content/en/docs/multi-center/modules/hosp/prescriptions.md Outdated Show resolved Hide resolved
content/en/docs/multi-center/modules/icu/chartevents.md Outdated Show resolved Hide resolved
content/en/docs/multi-center/modules/icu/d_items.md Outdated Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants