Difference between revisions of "Report template guidelines"

Revision as of 18:26, 28 May 2009

Except for report headings, users are able to enter "free" (unstructured, narrative) text anywhere in a report. Any field for structured data can be filled with plain text.

    Lungs:  [Normal.]

Single-choice items are separated by vertical bars ("pipes") within square brackets. An asterisk indicates the default value.

    Hydronephrosis: [None* | Mild | Moderate | Severe]

    Indications: [chronic chest pain; atypical angina; pre-valve replacement]

    Contrast dose: [# mL]

Pre-defined data types are specified within angle brackets. These data types might include specific types of data or values that might flow into the reporting system from acquistion devices.

    Date: [<date>]
    Head Circumference: [<ultrasound:hc>]

    {If left or co-dominant: LPDA and LPL branches should be addressed.}

@@ Line 6: / Line 6: @@
 == Template overview ==
-* '''Text fields''' are enclosed by square brackets
+* '''Text fields''' are enclosed by square brackets.  A default value may be shown.
-      Lungs:  [Normal. ]
+      Lungs:  [Normal.]
-* Vertical bars ("pipes") indicate [normal* | dilated]  — pick one
+* '''Single-choice items''' are separated by vertical bars ("pipes") within square brackets.  An asterisk indicates the default value.
-[chronic chest pain; atypical angina; pre-valve replacement]  — multiple choices
+     Hydronephrosis: [None* | Mild | Moderate | Severe]
-[# mL]  – numeric value with units
-{If left or co-dominant: LPDA and LPL branches should be addressed.} – comment
+* '''Multiple-choice items''' are indicated by semicolons within square brackets.
-[<date>] -- pre-defined data type
+     Indications: [chronic chest pain; atypical angina; pre-valve replacement]
+* '''Numeric values''' are indicated by the "#" sign.  Units may be indicated.
+     Contrast dose: [# mL]
+* '''Pre-defined data types''' are specified within angle brackets.  These data types might include specific types of data or values that might flow into the reporting system from acquistion devices.
+     Date: [<date>]
+     Head Circumference: [<ultrasound:hc>]
+* '''Comments''' are indicated by curly braces.
+     {If left or co-dominant: LPDA and LPL branches should be addressed.}