How to approach each page
Our main goal is to create concise, citation-heavy pages that are useful quick references at the point of care. As you are writing each page, imagine what information and resources you would like to access to during a clinic visit — this is the content that should be the main focus of the page. Citations are important because they give readers the ability to explore deeper from this quick reference page if they wish to.
- Page content: Fill out or review the content of the page.
- Make sure that the page elements adhere to the style guide below.
- Make sure the headings are an appropriate hierarchy (that is, top-level headings should be H1, headings below that should be H2, etc)
- Make sure all links actually work.
- Citations: Make sure that key statements and recommendations have citations to the relevant trial. Please follow the citation style described below.
- Dot phrases: Make sure that the relevant dot phrases for this page are still accurately named with accurate description. Please see the dot phrase section below for full details.
- Make sure that all the dot phrases for this particular page provide unique and high yield information that is relevant to this topic.
- If you notice dot phrases with duplicative or low-quality information, please remove the dot phrases or contact the dot phrase owner to update the dot phrase contents.
- Images: Make sure that all images have a caption and cite a source with a working link. Please make sure that the images follow the style guide below.
- Try not to take screenshots of tables and flowcharts. Instead, try to recreate the table or flowchart so that the text becomes searchable.
- Tables: Please make sure all tables follow the style guide below. Specifically, tables should have a header row and cells should be left aligned.
- Flowchart: Please make sure that all flowcharts follow the style guide below. Importantly, please make sure the display mode for all flowcharts is
Previewso that the flowchart code is hidden on the published page. - Resources sidebar: Please make sure all of the resources listed in the right hand sidebar have working links. Consider using web bookmarks and other rich media blocks in the resources sidebar instead of plain hyperlinks to allow for embedding and rich previews.
Page elements
Page title
- Should be in title case
- Include common abbreviations in the title to improve search
Examples
“Opioid Use Disorder (OUD)”
Headings
- Headings should be in sentence case
Examples
“Diagnosis and management”
Callouts and clinical pearls
- Add a callout to insert in a clinical pearl or a cautionary statement
- Try to customize the corresponding emoji to match the sentiment of your message.
- If you want to have multiple lines within a callout, you can press
SHIFT + ENTERto insert a new line without leaving the callout.
Examples
This is a clinical pearl
This is the second line in this callout that was added using
SHIFT + ENTER.This is a cautionary statement
Citing sources
- All statements should be backed up by a link to the primary literature. Links should be to corresponding PubMed page.
- Use parentheses not square brackets
- Can include landmark trial names (eg, AFFIRM, etc.). Include a comma to separate the trial from the journal and year
- If citing multiple sources, separate with a semicolon
Examples
(JAMA 2023; AFFIRM, NEJM 2002)
Calculators
- Prefer MDCalc or direct to source website
- Examples where you might link directly to the source website are FRAX or Seattle Heart Failure Model
Dot phrases
- When creating a dot phrase in the dot phrase database, please ALL CAPS for the dot phrase name and do NOT lead with a
.at the beginning of the dot phrase name. - Verify that the dot phrase is active in Epic and please make sure to look at the “Editors” column and put one of the editors as the dot phrase owner. This helps people who have been NOT manually added to the dot phrase know which user to look up to grant themselves access.
- Make sure to open up the dot phrase to review its contents to see if anything needs updating or correcting. If you do discover something needs correcting, please directly edit the dot phrase if you have editing permissions. if you do NOT have editing permissions, please contact one of the editors to let them know about the changes that need to be made.
- Please make sure that the short description on this website is an accurate reflection of the dot phrase contents.
- We are NOT duplicating the contents of the dot phrase here on this website to enhance maintainability. Because of this, it is doubly important to make sure that the short descriptions are an accurate reflection of the dot phrase contents.
- Please preferentially add Osler and EBMC dot phrases. If you know someone who has an excellent personal dot phrase, you may also add this dot phrase to this repository and include them as the dot phrase owner.
Images
- Include caption with link directly to the source at the end
- Click top right of image to add caption. Image and caption should be left-aligned.
Examples
Tables
- Consider adding a header row to all your tables
- Consider left aligning text within cells of the table
- After editing the table, please click the
←→button to automatically resize the table to the page width
Examples
Diagnostic Criteria | Additional Notes |
HbA1c > 6.5% | POC HbA1c is NOT sufficient for initial diagnosis
Should be used with caution in HIV+, hemoglobinopathies, pregnancy, hemodialysis |
Hyperglycemic sx + random plasma glucose ≥ 200 mg/dL | 1 abnormal test is sufficient |
Fasting plasma glucose ≥126 mg/dL | Fasting is defined as no caloric intake for at least 8h |
2hr plasma glucose ≥ 200 mg/dL after 75g oral glucose load |
Flowcharts
- If you want to create a flowchart, please ask your editor about how to use the built-in Mermaid functionality to do this.
- You can also follow this tutorial on how to start using Mermaid to create flowcharts in Notion.
You can switch the display mode to
Split to see your changes in real time, but make sure to switch back to Preview after editing so that you hide the code and only show the flowchart on the actual published page!