Resident survival guide checklist: Difference between revisions

Jump to navigation Jump to search
 
(43 intermediate revisions by 4 users not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{Resident survival guide project}}
[[Image:Main_help_page_small.PNG|100px|link=Help]][[Image:Projects.PNG|100px|link=Projects]][[Image:Editor's_Tools.PNG|100px|link=Help Menu]]
{{CMG}}; {{AE}} {{Rim}}; {{VR}}
{{CMG}}; {{AE}} {{Rim}}; {{VR}}


==Overview==
==Overview==
The following items in this checklist describe in details the resident survival guide pages.  All those items should be present for a page to be complete and ready for quality check.
The following items in this checklist describe in detail the resident survival guide pages.  All these items should be present for a page to be complete and ready for quality check.


==Checklist==
==Checklist==
* Each page contains the following titles:
===General Structure===
** Definition
* In general, each page contains the following titles in order:
** Overview
** Classification (if needed for the management)
** Causes
** Causes
** Management
** FIRE
** Complete Diagnostic Approach
** Treatment
** Do's
** Do's
** Dont's
** Dont's
** References
** References


====Definition====
* The treatment for some diseases is extensive or it can be subdivided into sections.  In this case, appropriate headings are used to organize the treatment. Click '''[[STEMI resident survival guide|here]]''' for an example.
* The definition is preferably one sentence, short and straight to the point.
* If more than one definition should be provided:
** The tile of the section is changed into definitions
** The definitions are presented in a form of table. Click [[Choledocholithiasis resident survival guide|here]] for an example.
** If the topic contains diagnostic criteria as part of its definition, the diagnostic criteria are provided in the definition section.


====Causes====
===Floating Navigation Bar===
* A navigation bar is present on every resident survival guide page.  Click '''[[Template:Resident_survival_guide|here]]''' for a template.
* For an example of a page with a floating navigation bar, check [[STEMI resident survival guide]].
* The navigation bar should contain the following items: overview, classification (if applicable), causes, FIRE, complete diagnostic approach, treatment, do's and don'ts.  However, the content of the navigation bar is flexible.
** If you have added an additional title or subtitle on your page make sure to add it in the navigation bar.
** If the therapy is divided into several sections, modify the content of the navigation bar to fit the order of the titles of the resident survival page. Click '''[[STEMI resident survival guide|here]]''' for an example.
 
===Overview===
* The overview section is a short and straight to the point statement that summarizes the disease and its management in few sentences, particularly the immediate management.
* The overview section should include the disease name in the first sentence.
* To see an example of an overview section on the resident survival guide, click '''[[Cardiac tamponade resident survival guide|here]]'''.
 
===Classification===
* The classification section should be included only when the classification of the disease is needed for the management plan.
* This section provides either a table or a list of subheadings of categories with content that the disease can be classified under.
* To see an example of a classification section on the resident survival guide, click '''[[Atrial fibrillation resident survival guide|here]]'''.
 
===Causes===
* The causes section contains two subheadings:
* The causes section contains two subheadings:
** Life Threatening Causes
** Life Threatening Causes
** Common Causes
** Common Causes
* Under life threatening causes, the following definition of life threatening is provided: Life-threatening causes include conditions which may result in death or permanent disability within 24 hours if left untreated.
* Under life threatening causes, the following definition of life threatening is provided: Life-threatening causes include conditions which may result in death or permanent disability within 24 hours if left untreated.
** If the disease itself is life threatening, the following sentence is written: Life-threatening causes include conditions which may result in death or permanent disability within 24 hours if left untreated. <nowiki>[[Name of the disease]]</nowiki> is by itself life threatening and should be treated as such irrespective of the causes.
** If the disease itself is life threatening, the following sentence is written: <nowiki>[[Name of the disease]]</nowiki> is life threatening and should be treated as such irrespective of the underlying cause.
* Under common causes, only the '''common''' causes are provided, without including rare etiologies.
* Under common causes, only the '''common''' causes are provided, without including rare etiologies.
* The causes are listed in  alphabetical order.
* The causes are listed in  alphabetical order.
* The causes are all hyperlinked.
* The causes are all hyperlinked.


====Management====
===FIRE===
* The management section contains the algorithm(s).
* This section begins with the following sentence: A Focused Initial Rapid Evaluation (FIRE) should be performed to identify patients in need of immediate intervention.
* A list of abbreviated terms is provided '''above''' the algorithm as follows:
<nowiki><span style="font-size:85%">'''Abbreviations:''' '''BUN''': Blood urea nitrogen; '''CAD''': Coronary artery disease; '''CBC''': Complete blood count; '''EKG''': Electrocardiogram; '''Hb''': Hemoglobin; '''ICU''': Intensive care unit; '''INR''': International normalized ratio; '''IV''': Intravenous; '''GI''': Gastrointestinal; '''NPO''': Nil per os; '''NSAIDs''': Non steroid anti-inflammatory drugs</span></nowiki>
 
And it will appear this way:<br>
<span style="font-size:85%">'''Abbreviations:''' '''BUN''': Blood urea nitrogen; '''CAD''': Coronary artery disease; '''CBC''': Complete blood count; '''EKG''': Electrocardiogram; '''Hb''': Hemoglobin; '''ICU''': Intensive care unit; '''INR''': International normalized ratio; '''IV''': Intravenous; '''GI''': Gastrointestinal; '''NPO''': Nil per os; '''NSAIDs''': Non steroid anti-inflammatory drugs</span>
 
* The algorithm for FIRE contains at least the following:
**Identify cardinal findings that increase the pretest probability of [insert name of disease here]
** Rule out life-threatening diagnoses
 
* The boxes that require immediate attention and management are colored in red/salmon (background: #FA8072).  Boxes are colored in white when they don't require immediate management.
* When boxes are in red/salmon, the font color is white (color: #F8F8FF).  In order to make sure that the hyperlinks are also shown as white and not blue, the following code is used: <nowiki>[[word to be hyperlinked|<span style="color:white;">word to be hyoperlinked</span>]]</nowiki>
 
===Complete Diagnostic Approach===
* The complete diagnostic approach section contains the diagnostic algorithm(s).
* If the diagnostic approach is very big and the algorithm is complicated, the algorithm is divided into more than one.
* If more than one algorithm is provided, a subtitle is given for each.
* When more than one algorithm are provided, separate them with <nowiki><br></nowiki>.
* The algorithm for diagnosis contains at least the following
**Characterize the symptoms
**Obtain a detailed history
**Examine the patient
**Order labs
**Order imaging studies
**Consider alternative diagnoses
 
===Treatment===
* The treatment section contains the therapeutic algorithm(s).
* The number of algorithms depends on each topic.
* The number of algorithms depends on each topic.
** If the management is very big and the algorithm is complicated, the algorithm is divided into more than one.
* If the therapeutic approach is very big and the algorithm is complicated, the algorithm is divided into more than one.
* If more than one algorithm is provided, a subtitle is given for each.  The suggested subtitles are:
* If more than one algorithm is provided, a subtitle is given for each.
** Diagnostic approach
* When more than one algorithm are provided, they are separated with <nowiki><br></nowiki>.
** Therapeutic approach
* Details about the dosage, route, and frequency of the medications are provided.
** Initial management
* Major contraindications for the medications are provided in red.  Click '''[[STEMI resident survival guide|here]]''' for an example.
** Additional management
* Action verbs are used before medications or treatment, for example: "Administer aspirin" instead of aspirin.
** Prevention
* Check-boxes “❑” are placed in front of every action.
* If additional information, such as details about scores, details about grading, images or any necessary information have to be provided, do not include it in the management section.  Instead create a new heading for it after management.
* Urgent or Immediately are added when an action should be taken as soon as possible.
* When more than one algorithms are provided, separate them with <nowiki><br></nowiki>.
* When the algorithm contains a big management plan already developed on another resident survival page, the management should not be replicated but rather redirected to the other resident survival guide page.  


=====Description of each algorithm=====
===Description of The Algorithm===
* Before starting the algorithm, the following sentence is written and the main reference(s) of the algorithm are cited:<br>
* Before starting the algorithm, the following sentence is written and the main reference(s) of the algorithm are cited:<br>
Shown below is an algorithm depicting [...] based on [...].(references)
Shown below is an algorithm depicting [...] based on [...].(references)
* Abbreviations should be avoided, example: hour and not hr, minute and not min.
** If abbreviations are used, provide a list of abbreviated terms '''above''' the algorithm as follows:
<nowiki><span style="font-size:85%">'''Abbreviations:''' '''BUN''': Blood urea nitrogen; '''CAD''': Coronary artery disease; '''CBC''': Complete blood count; '''EKG''': Electrocardiogram; '''Hb''': Hemoglobin; '''ICU''': Intensive care unit; '''INR''': International normalized ratio; '''IV''': Intravenous; '''GI''': Gastrointestinal; '''NPO''': Nil per os; '''NSAIDs''': Non steroid anti-inflammatory drugs</span></nowiki>
And it will appear this way:<br>
<span style="font-size:85%">'''Abbreviations:''' '''BUN''': Blood urea nitrogen; '''CAD''': Coronary artery disease; '''CBC''': Complete blood count; '''EKG''': Electrocardiogram; '''Hb''': Hemoglobin; '''ICU''': Intensive care unit; '''INR''': International normalized ratio; '''IV''': Intravenous; '''GI''': Gastrointestinal; '''NPO''': Nil per os; '''NSAIDs''': Non steroid anti-inflammatory drugs</span>
Click '''[[STEMI resident survival guide|here]]''' for an example.


* The algorithm should be drawn on a paper then replicated on WikiDoc in a way that the algorithm is minimally spaced.
* The algorithm should be drawn on a paper then replicated on WikiDoc in a way that the algorithm is minimally spaced.
* The algorithm and content are aligned to the left, and the size of each box is adjusted using the following formula:
* The algorithm and content are aligned to the left, and the size of each box is adjusted using the following formula:
** <nowiki><div style="float: left; text-align: left; height: 20em; width: 20em; padding:1em;"> [content of the box] </div> </nowiki>
** <nowiki><div style="float: left; text-align: left; width: 25em; padding:1em;"> [content of the box] </div> </nowiki>
* The algorithm should contain the following:
* The algorithm should contain the following:
** Characterize the symptoms:
** Characterize the symptoms:
** Obtain a detailed history:
** Obtain a detailed history:
** Examine the patient:
** Examine the patient:
** Order labs and test:
** Order labs:
** Order imaging studies:
**Consider alternative diagnoses:


* Action verbs are used before medications or treatment, for example: "Administer aspirin" instead of aspirin
* Action verbs are used before medications or treatment, for example: "Administer aspirin" instead of aspirin
* Check-boxes ❑ are placed in front of every action.
* Check-boxes ❑ are placed in front of every action.
* '''Urgent''' or '''Immediately''' are added when an action should be taken as soon as possible.
* '''Urgent''' or '''Immediately''' are added when an action should be taken as soon as possible.
* When a medication is to be administered, the dose and mode of administration are included.


* Abbreviations should be avoided, example: hour and not hr, minute and not min.
* When the algorithm contains a big management plan already developed on another resident survival page, the management should not be replicated but rather redirected to the other reisdent survival guide page.
** If abbreviations are used, provide a list of abbreviated terms below the algorithm as follows:
<nowiki><span style="font-size:85%">'''BUN''': Blood urea nitrogen; '''CAD''': Coronary artery disease; '''CBC''': Complete blood count; '''EKG''': Electrocardiogram; '''Hb''': Hemoglobin; '''ICU''': Intensive care unit; '''INR''': International normalized ratio; '''IV''': Intravenous; '''GI''': Gastrointestinal; '''NPO''': Nil per os; '''NSAIDs''': Non steroid anti-inflammatory drugs</span></nowiki>


And it will appear this way:<br>
===Do's===
<span style="font-size:85%">'''BUN''': Blood urea nitrogen; '''CAD''': Coronary artery disease; '''CBC''': Complete blood count; '''EKG''': Electrocardiogram; '''Hb''': Hemoglobin; '''ICU''': Intensive care unit; '''INR''': International normalized ratio; '''IV''': Intravenous; '''GI''': Gastrointestinal; '''NPO''': Nil per os; '''NSAIDs''': Non steroid anti-inflammatory drugs</span>
 
To see an example, click [[Upper gastrointestinal bleeding resident survival guide|here]].
 
* When the algorithm contains a big management plan already developed on another resident survival page, the management should not be replicated but rather redirected.
For example:<br>
You write: Click <no wiki>[[Pulmonary embolism resident survival guide|here]]</nowiki> for the management of pulmonary embolism.
It shows as: Click [[Pulmonary embolism resident survival guide|here]] for the management of pulmonary embolism.
 
====Do's====
* Extra information and details about the management are provided in this section.
* Extra information and details about the management are provided in this section.
* Each sentence is written as an order, for example:
* Each sentence is written as an order, for example:
** Order an EKG. (correct)
** Order an EKG. (correct)
** An EKG should be ordered. (incorrect)
** An EKG should be ordered. (incorrect)
* Write the important do’s within the algorithms.


====Dont's====
===Dont's===
* Extra information and details about what should be avoided in the management are provided in this section.
* Extra information and details about what should be avoided in the management are provided in this section.
* Each sentence is written as an order, for example:
* Each sentence is written as an order, for example:
** Do not administer beta blockers. (correct)
** Do not administer beta blockers. (correct)
** Beta blockers should not be administered. (incorrect)
** Beta blockers should not be administered. (incorrect)
===References===
* Make sure to use the latest guidelines and recommendations as references.
* Make sure that the links of the references are working.


===General Notes===
===General Notes===
* Provide synonyms and keywords on the top of each page.
* When more that one associate editors are included, separate the names by a a semicolon followed by a space.
* Expand buttons should be avoided as much as possible.
* Expand buttons should be avoided as much as possible.
* Hyperlinks through <nowiki> [[ ]] </nowiki> are used to link key words to their pages.
* Hyperlinks through <nowiki> [[ ]] </nowiki> are used to link key words to their pages.
* The page is reviewed for typographical errors and capitalization.
* The page should be reviewed for typographical errors and capitalization.
* Add '''categories''' for each section. Make sure that <nowiki>[[category:Resident survival guide]]</nowiki> is present among others, for example: <nowiki>[[Category:Cardiology]]</nowiki>.
* Make sure that a siren is present on all the pages of each of the resident survival guide's topics.
* Contributors who are not native English speakers and require help in writing should add the Category:Grammar to their pages.
 
===Example of Pages===
For examples of high quality pages, please check:
* [[STEMI resident survival guide]]
* [[Bradycardia resident survival guide]]
* [[Cardiac tamponade resident survival guide]]

Latest revision as of 14:56, 17 April 2015

Resident Survival Guide
Introduction
Team
Guide
Page Template
Examine the Patient Template
Navigation Bar Template
Checklist
Topics

Editor-In-Chief: C. Michael Gibson, M.S., M.D. [1]; Associate Editor(s)-in-Chief: Rim Halaby, M.D. [2]; Vendhan Ramanujam M.B.B.S [3]

Overview

The following items in this checklist describe in detail the resident survival guide pages. All these items should be present for a page to be complete and ready for quality check.

Checklist

General Structure

  • In general, each page contains the following titles in order:
    • Overview
    • Classification (if needed for the management)
    • Causes
    • FIRE
    • Complete Diagnostic Approach
    • Treatment
    • Do's
    • Dont's
    • References
  • The treatment for some diseases is extensive or it can be subdivided into sections. In this case, appropriate headings are used to organize the treatment. Click here for an example.

Floating Navigation Bar

  • A navigation bar is present on every resident survival guide page. Click here for a template.
  • For an example of a page with a floating navigation bar, check STEMI resident survival guide.
  • The navigation bar should contain the following items: overview, classification (if applicable), causes, FIRE, complete diagnostic approach, treatment, do's and don'ts. However, the content of the navigation bar is flexible.
    • If you have added an additional title or subtitle on your page make sure to add it in the navigation bar.
    • If the therapy is divided into several sections, modify the content of the navigation bar to fit the order of the titles of the resident survival page. Click here for an example.

Overview

  • The overview section is a short and straight to the point statement that summarizes the disease and its management in few sentences, particularly the immediate management.
  • The overview section should include the disease name in the first sentence.
  • To see an example of an overview section on the resident survival guide, click here.

Classification

  • The classification section should be included only when the classification of the disease is needed for the management plan.
  • This section provides either a table or a list of subheadings of categories with content that the disease can be classified under.
  • To see an example of a classification section on the resident survival guide, click here.

Causes

  • The causes section contains two subheadings:
    • Life Threatening Causes
    • Common Causes
  • Under life threatening causes, the following definition of life threatening is provided: Life-threatening causes include conditions which may result in death or permanent disability within 24 hours if left untreated.
    • If the disease itself is life threatening, the following sentence is written: [[Name of the disease]] is life threatening and should be treated as such irrespective of the underlying cause.
  • Under common causes, only the common causes are provided, without including rare etiologies.
  • The causes are listed in alphabetical order.
  • The causes are all hyperlinked.

FIRE

  • This section begins with the following sentence: A Focused Initial Rapid Evaluation (FIRE) should be performed to identify patients in need of immediate intervention.
  • A list of abbreviated terms is provided above the algorithm as follows:

<span style="font-size:85%">'''Abbreviations:''' '''BUN''': Blood urea nitrogen; '''CAD''': Coronary artery disease; '''CBC''': Complete blood count; '''EKG''': Electrocardiogram; '''Hb''': Hemoglobin; '''ICU''': Intensive care unit; '''INR''': International normalized ratio; '''IV''': Intravenous; '''GI''': Gastrointestinal; '''NPO''': Nil per os; '''NSAIDs''': Non steroid anti-inflammatory drugs</span>

And it will appear this way:
Abbreviations: BUN: Blood urea nitrogen; CAD: Coronary artery disease; CBC: Complete blood count; EKG: Electrocardiogram; Hb: Hemoglobin; ICU: Intensive care unit; INR: International normalized ratio; IV: Intravenous; GI: Gastrointestinal; NPO: Nil per os; NSAIDs: Non steroid anti-inflammatory drugs

  • The algorithm for FIRE contains at least the following:
    • Identify cardinal findings that increase the pretest probability of [insert name of disease here]
    • Rule out life-threatening diagnoses
  • The boxes that require immediate attention and management are colored in red/salmon (background: #FA8072). Boxes are colored in white when they don't require immediate management.
  • When boxes are in red/salmon, the font color is white (color: #F8F8FF). In order to make sure that the hyperlinks are also shown as white and not blue, the following code is used: [[word to be hyperlinked|<span style="color:white;">word to be hyoperlinked</span>]]

Complete Diagnostic Approach

  • The complete diagnostic approach section contains the diagnostic algorithm(s).
  • If the diagnostic approach is very big and the algorithm is complicated, the algorithm is divided into more than one.
  • If more than one algorithm is provided, a subtitle is given for each.
  • When more than one algorithm are provided, separate them with <br>.
  • The algorithm for diagnosis contains at least the following
    • Characterize the symptoms
    • Obtain a detailed history
    • Examine the patient
    • Order labs
    • Order imaging studies
    • Consider alternative diagnoses

Treatment

  • The treatment section contains the therapeutic algorithm(s).
  • The number of algorithms depends on each topic.
  • If the therapeutic approach is very big and the algorithm is complicated, the algorithm is divided into more than one.
  • If more than one algorithm is provided, a subtitle is given for each.
  • When more than one algorithm are provided, they are separated with <br>.
  • Details about the dosage, route, and frequency of the medications are provided.
  • Major contraindications for the medications are provided in red. Click here for an example.
  • Action verbs are used before medications or treatment, for example: "Administer aspirin" instead of aspirin.
  • Check-boxes “❑” are placed in front of every action.
  • Urgent or Immediately are added when an action should be taken as soon as possible.
  • When the algorithm contains a big management plan already developed on another resident survival page, the management should not be replicated but rather redirected to the other resident survival guide page.

Description of The Algorithm

  • Before starting the algorithm, the following sentence is written and the main reference(s) of the algorithm are cited:

Shown below is an algorithm depicting [...] based on [...].(references)

  • Abbreviations should be avoided, example: hour and not hr, minute and not min.
    • If abbreviations are used, provide a list of abbreviated terms above the algorithm as follows:

<span style="font-size:85%">'''Abbreviations:''' '''BUN''': Blood urea nitrogen; '''CAD''': Coronary artery disease; '''CBC''': Complete blood count; '''EKG''': Electrocardiogram; '''Hb''': Hemoglobin; '''ICU''': Intensive care unit; '''INR''': International normalized ratio; '''IV''': Intravenous; '''GI''': Gastrointestinal; '''NPO''': Nil per os; '''NSAIDs''': Non steroid anti-inflammatory drugs</span>

And it will appear this way:
Abbreviations: BUN: Blood urea nitrogen; CAD: Coronary artery disease; CBC: Complete blood count; EKG: Electrocardiogram; Hb: Hemoglobin; ICU: Intensive care unit; INR: International normalized ratio; IV: Intravenous; GI: Gastrointestinal; NPO: Nil per os; NSAIDs: Non steroid anti-inflammatory drugs

Click here for an example.


  • The algorithm should be drawn on a paper then replicated on WikiDoc in a way that the algorithm is minimally spaced.
  • The algorithm and content are aligned to the left, and the size of each box is adjusted using the following formula:
    • <div style="float: left; text-align: left; width: 25em; padding:1em;"> [content of the box] </div>
  • The algorithm should contain the following:
    • Characterize the symptoms:
    • Obtain a detailed history:
    • Examine the patient:
    • Order labs:
    • Order imaging studies:
    • Consider alternative diagnoses:
  • Action verbs are used before medications or treatment, for example: "Administer aspirin" instead of aspirin
  • Check-boxes ❑ are placed in front of every action.
  • Urgent or Immediately are added when an action should be taken as soon as possible.
  • When a medication is to be administered, the dose and mode of administration are included.
  • When the algorithm contains a big management plan already developed on another resident survival page, the management should not be replicated but rather redirected to the other reisdent survival guide page.

Do's

  • Extra information and details about the management are provided in this section.
  • Each sentence is written as an order, for example:
    • Order an EKG. (correct)
    • An EKG should be ordered. (incorrect)
  • Write the important do’s within the algorithms.

Dont's

  • Extra information and details about what should be avoided in the management are provided in this section.
  • Each sentence is written as an order, for example:
    • Do not administer beta blockers. (correct)
    • Beta blockers should not be administered. (incorrect)

References

  • Make sure to use the latest guidelines and recommendations as references.
  • Make sure that the links of the references are working.

General Notes

  • When more that one associate editors are included, separate the names by a a semicolon followed by a space.
  • Expand buttons should be avoided as much as possible.
  • Hyperlinks through [[ ]] are used to link key words to their pages.
  • The page should be reviewed for typographical errors and capitalization.
  • Add categories for each section. Make sure that [[category:Resident survival guide]] is present among others, for example: [[Category:Cardiology]].
  • Make sure that a siren is present on all the pages of each of the resident survival guide's topics.
  • Contributors who are not native English speakers and require help in writing should add the Category:Grammar to their pages.

Example of Pages

For examples of high quality pages, please check: