Difference between revisions of "Using the Sample NationNotes Form"

From OpenEMR Project Wiki
(→‎Write a NationNotes Note: finagling the pics)
 
(24 intermediate revisions by 2 users not shown)
Line 47: Line 47:
6. Apply formatting, special characters etc as desired using toolbar icons
6. Apply formatting, special characters etc as desired using toolbar icons


7. Click "Save" button at top left to transfer the content of the editor to the corresponding NN field on the LBV form.
7. Click "Save" button at top left of editor to transfer the content of the editor to the corresponding NN field on the LBV form.
 
[[File:Nn-11-txfertoNN.png|center]]




* The LBV form is then used in the normal fashion.
* The LBV form is then used in the normal fashion.
* To change the contents of a saved NN field, evoke the WYSIWYG editor by clicking inside the NN field.
* To change the contents of a NN field on the LBV, click inside the field and the editor will appear with the field contents in it.


== Toolbar icons ==
== WYSIWYG Editor Toolbar icons ==


[[File:Nn-tb-00-toolbar.png]]
[[File:Nn-tb-00-toolbar.png|center]]


''' Editing Tools'''
''' Editing Tools'''


These tools perform the indicated functions in the customary manner.
These tools perform the indicated functions in the customary manner.


[[File:Nn-tb-01.png]]
[[File:Nn-tb-01.png]]
Print, Spell Check/ SCAYT (Spell Check As You Type; needs one-time config).
:Print, Spell Check, SCAYT (Spell Check As You Type; needs one-time config).




[[File:Nn-tb-02.png]]
[[File:Nn-tb-02.png]]
Undo, Redo
:Undo, Redo
:Search, Replace
:Select All - equivalent to Ctrl+a; highlights all content in the note
::Eraser - removes all formatting from any highlighted materials
 


Search, Replace
[[File:Nn-tb-05.png]]
:"Image" - intended to insert an image file, the code behind this tool is problematic; use the workaround described below.
:Table - inserts a table with the ability to set the basic parameters
:Horizontal line - inserts horizontal line
:Insert special character - shows table of most of the usual alphanumeric, computer and Western European special characters
:Page break - advance to next page, when printing.


Select All - equivalent to Ctrl+a; highlights all content in the note


Eraser - removes all formatting from any highlighted materials
'''Formatting Tools'''


These tools perform the indicated functions in the customary manner: highlight the text to be affected then click the icon.


[[File:Nn-tb-05.png]]
[[File:Nn-tb-06.png]]
"Image" - intended to insert an image file, the code behind this tool is problematic; use the workaround described below.
:Bold, Italic, Underline, Strikethrough
:Sub/ Superscripts
:Numbered/ Bulleted list
:Increase/ decrease indent, block quote


Table - inserts a table with the ability to set the basic parameters


Horizontal line - inserts horizontal line
[[File:Nn-tb-07.png]]
:Alignment, styles, format, font, size


Insert special character - shows table of most of the usual alphanumeric, computer and Western European special characters
== Program A Special Character Button ==


Page break - advance to next page, when printing.


1. Open WYSIWYG editor


2. Click button "Add Buttons" at bottom of left blue area to invoke "Add Custom Button" panel
[[File:Nn-tb-00-AddBtn.png|center]]


'''Formatting Tools'''


These tools perform the indicated functions in the customary manner: highlight the text to be affected then click the icon.


[[File:Nn-tb-06.png]]


Bold, Italic, Underline, Strikethrough


Sub/ Superscripts
3. Enter html code in "Values" column


Numbered/ Bulleted list
4. Enter text to show inside button, in "Display Name" column


Increase/ decrease indent, block quote
5. Enter display order in Order column


[[File:Nn-tb-07.png]]
[[File:Nn-tb-08-enterSpecChar.png|center]]
Alignment, styles, format, font, size






== Program A Special Character Button ==


[sshot nn-tb-08]


1. Open WYSIWYG editor
[[File:Nn-tb-00-AddBtn.png]]


2. Click button "Add Buttons" to invoke "Add Custom Button" panel
[[File:Nn-tb-08-enterSpecChar.png]]
3. Enter html code ot


[[File:Nn-tb-09-specKeyBtns.png]]
[[File:Nn-tb-09-specKeyBtns.png|right]]
:* New buttons will be lined up along the top of the WYSIWYG editor between the "Space" button and the "Enter Key" icon
:* New buttons will be lined up along the top of the WYSIWYG editor between the "Space" button and the "Enter Key" icon


:* Their order is determined by the Order value in the Add Custom Button dialog, numbered from 0 (zero).
:* Their display order is determined by the Order value in the Add Custom Button dialog, numbered from 0 (zero).


:* This function provides the same characters as the "Special Characters" toolbar button.
:* This function provides the same characters as the "Special Characters" toolbar button.
Line 127: Line 132:
:* Buttons remain in the editor for use in any OpenEMR NationNote field.
:* Buttons remain in the editor for use in any OpenEMR NationNote field.


:* Accepts html codes for special characters, or plain text.
:* Accepts html codes for special characters, or 10 characters of plain text.


:* "Value" = html code or text
:* html code is ascii code with &# added to front.  Doesn't handle Extended ASCII


::html = ascii code with &# added to front.  Doesn't handle Extended ASCII
== Embed Image in NationNote ==


::plain text is limited to 10 chars.
* Use this workaround instead of the function accessed from the WYSIWYG editor toolbar.


::* link to the code snippet to extend the str$ len
An image may be embedded into a NationNote in two ways: either copied from a file on the client computer theat OpenEMR is installed on, or copied from the patient's Documents collection in OpenEMR.


* "Display Name" = label text in the custom button.


[sshot nn-tb-09]
'''A. Copied from Client computer.'''
 
 
 
== Embed Image in NationNote ==
 
* The embedded image function accessed from the toolbar icon does not perform as advertized.  Use this workaround.


1. Obtain a graphic and upload it to OpenEMR client computer
1. Obtain a graphic and upload it to OpenEMR client computer
Line 158: Line 156:


4. Copy/paste image from graphics editor directly into the WYSIWYG editor.
4. Copy/paste image from graphics editor directly into the WYSIWYG editor.
'''B. Copied from Pt's Documents'''
1. Upload a suitably cropped and resized graphic to the patient's Documents
:* The 'Categories' mentioned on the Documents upload screen are not the same as NationNotes Categories.  Do not use that control in this operation.
2. Left click on the picture's link to open it in Documents viewer.
[[File:Nn-23.png-cpImg.png|center]]
3. Right click on the picture and with the browser's context menu, copy and paste into NN editor. Use Ctrl + v if paste function not available.
[[File:Nn-24-pasteToEd.png|center]]
* See [https://sourceforge.net/p/openemr/discussion/202504/thread/9da58771/#ab62 this Forums post] regarding .pdf files.




Line 163: Line 183:
== Share a NationNote Template ==
== Share a NationNote Template ==


* Templates can only be shared '''from''' Available Categories '''to''' the user who is logged in, not from the logged in user to  
* Templates can only be shared '''from''' "Available Categories" '''to''' the user who is logged in, not from the logged in user to  
another user.
another user.


Line 180: Line 200:
6. Click on each of the Available Categories to see the Components each one contains.
6. Click on each of the Available Categories to see the Components each one contains.


[sshot nn-13-availCats]
[[File:Nn-13-AvailCats.png|right]]
 
 
 
 
 
 
 




Line 188: Line 215:
8. Click "Save" button.
8. Click "Save" button.


[sshot nn-14]
[[File:Nn-14-ShareTemps.png|left]]
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 




Line 196: Line 240:
10. Reopen editor, select Category and see shared Templates
10. Reopen editor, select Category and see shared Templates


[sshot nn-15]
[[File:Nn-15-SharedCats.png|center]]
 
 


== Delete a NationNotes field ==
== Delete a NationNotes field ==


A NationNotes field may be removed from a LBV form simply by changing its data type in the Edit Layout screen.  This simply produces a different object on the LBV form, with the same label and parameters (except for size values) as the former NN field.
A NationNotes field may be easily removed from a LBV form by changing its data type in the Edit Layout screen.  This simply produces a different object on the LBV form, with the same label and parameters (except for size values) as the former NN field.  If the data type of the field is changed back to NationNotes then it may be reassigned to its former List (Context).


If the data type of the field is changed back to NationNotes then it may be reassigned to its former List (Context).
To utterly delete a NN field, its component parts must be removed from their database location.  All Categories and Components that have been configured for all NationNotes Contexts are stored in the database table "customlists".  They may be permenently deleted by removing them from that table.  This is '''PERMANENT''' and irreversable so be sure you know it's what you want to do.


All Categories and Components that have been configured for all NationNotes Contexts are stored in the database table
"customlists".  They may be permenently deleted by removing them from that table.  This is '''PERMANENT''' and irreversable so be
sure you know it's what you want to do.


1. On Left Navigation Menu: Administration/ Other/ Database
1. On Left Navigation Menu: Administration/ Other/ Database
Line 216: Line 255:
3. In right hand window displaying the table, click tab "Browse"
3. In right hand window displaying the table, click tab "Browse"


[sshot]
[[File:Nn-16-customlists.png|center]]


:* Column, "cl_list_item_long" displays the user defined names of the list items.
 
:* Column, "cl_list_type" which explains the type of objects contained in the table.
 
:* Column, "cl_list_item_long" (right hand column in graphic below) displays the user defined names of the NN component items.
:* Column, "cl_list_type" (3d from right hand column in graphic below) which explains the type number of the objects contained in the table.
::2 = Context  
::2 = Context  
::3 = Template (aka Category)
::3 = Template (aka Category)
::4 = Sentence  (aka Component)
::4 = Sentence  (aka Component)
::6 = CustomButton
::6 = CustomButton
[sshot nn-17]
 
[[File:Nn-17-selDel.png]]


4. Click in left column checkboxes to select the desired list item(s) to delete
4. Click in left column checkboxes to select the desired list item(s) to delete


5. At bottom of table, click red X in line, "With all Selected:"
5. At bottom of table, click red X in line, "With all Selected:"
[sshot nn-18]
 
[[File:Nn-18-DelSel.png|right]]
 
 
 
 
 
 
 


6. Click button "Yes" or "NO" when panel appears containing list items selected for deletion, asking "Do you really want to",
6. Click button "Yes" or "NO" when panel appears containing list items selected for deletion, asking "Do you really want to",
[sshot nn-19]
 
[[File:Nn-19-YesDel.png]]
 
 
 
:Back to Part 1, [[Sample_NationNotes_Form|Sample NationNotes Form]]
:Back to Part 2, [[Building_the_Sample_NationNotes_Form|Building the Sample NationNotes Form]]
 
 
 
 
[[Category:User Guide]][[Category:User Guide 4.1.0]][[Category:User Guide 4.1.1]][[Category:User Guide 4.1.2]][[Category:Forms]]

Latest revision as of 16:07, 19 September 2014

Part 3, Using the Sample NationNotes LBV Form

  • All custom configurations of the WYSIWYG editor (adding Components, Buttons, Personalizing the editor) may be done at any time. However, the editor must be restarted before they take effect.

Write a NationNotes Note

1. Start an encounter with a patient

2. Select LBV Form "DetoxAdmit" from left Navigation Menu or "Layout Based" tab in encounter frame

3. Click in "Nsg Admit Note" NationNotes field

4. In the WYSIWYG editor, at top left dropdown list, Select Category, "Admit Interview"

  • The Components which have been configured for Nursing Notes are now available

5. Type note in editor

Optionally, click on individual Components to insert content to note
Optionally, click on Patient Details to add patient data to the note


Nn-10-NsgAdmit.png


Nn-10b-PtDetails.png












6. Apply formatting, special characters etc as desired using toolbar icons

7. Click "Save" button at top left of editor to transfer the content of the editor to the corresponding NN field on the LBV form.

Nn-11-txfertoNN.png


  • The LBV form is then used in the normal fashion.
  • To change the contents of a NN field on the LBV, click inside the field and the editor will appear with the field contents in it.

WYSIWYG Editor Toolbar icons

Nn-tb-00-toolbar.png

Editing Tools

These tools perform the indicated functions in the customary manner.


Nn-tb-01.png

Print, Spell Check, SCAYT (Spell Check As You Type; needs one-time config).


Nn-tb-02.png

Undo, Redo
Search, Replace
Select All - equivalent to Ctrl+a; highlights all content in the note
Eraser - removes all formatting from any highlighted materials


Nn-tb-05.png

"Image" - intended to insert an image file, the code behind this tool is problematic; use the workaround described below.
Table - inserts a table with the ability to set the basic parameters
Horizontal line - inserts horizontal line
Insert special character - shows table of most of the usual alphanumeric, computer and Western European special characters
Page break - advance to next page, when printing.


Formatting Tools

These tools perform the indicated functions in the customary manner: highlight the text to be affected then click the icon.

Nn-tb-06.png

Bold, Italic, Underline, Strikethrough
Sub/ Superscripts
Numbered/ Bulleted list
Increase/ decrease indent, block quote


Nn-tb-07.png

Alignment, styles, format, font, size

Program A Special Character Button

1. Open WYSIWYG editor

2. Click button "Add Buttons" at bottom of left blue area to invoke "Add Custom Button" panel

Nn-tb-00-AddBtn.png



3. Enter html code in "Values" column

4. Enter text to show inside button, in "Display Name" column

5. Enter display order in Order column

Nn-tb-08-enterSpecChar.png




Nn-tb-09-specKeyBtns.png
  • New buttons will be lined up along the top of the WYSIWYG editor between the "Space" button and the "Enter Key" icon
  • Their display order is determined by the Order value in the Add Custom Button dialog, numbered from 0 (zero).
  • This function provides the same characters as the "Special Characters" toolbar button.
  • Buttons remain in the editor for use in any OpenEMR NationNote field.
  • Accepts html codes for special characters, or 10 characters of plain text.
  • html code is ascii code with &# added to front. Doesn't handle Extended ASCII

Embed Image in NationNote

  • Use this workaround instead of the function accessed from the WYSIWYG editor toolbar.

An image may be embedded into a NationNote in two ways: either copied from a file on the client computer theat OpenEMR is installed on, or copied from the patient's Documents collection in OpenEMR.


A. Copied from Client computer.

1. Obtain a graphic and upload it to OpenEMR client computer

2. Open the picture with any graphics application capable of copy/ paste operation

  • For MS Windows, Paint is suitable
  • For Linux (Ubuntu/ Mint etc), Pinta or the Gimp

3. Edit/ resize picture if desired

4. Copy/paste image from graphics editor directly into the WYSIWYG editor.


B. Copied from Pt's Documents

1. Upload a suitably cropped and resized graphic to the patient's Documents

  • The 'Categories' mentioned on the Documents upload screen are not the same as NationNotes Categories. Do not use that control in this operation.


2. Left click on the picture's link to open it in Documents viewer.

Nn-23.png-cpImg.png


3. Right click on the picture and with the browser's context menu, copy and paste into NN editor. Use Ctrl + v if paste function not available.

Nn-24-pasteToEd.png




Share a NationNote Template

  • Templates can only be shared from "Available Categories" to the user who is logged in, not from the logged in user to

another user.


1. Log into OpenEMR

2. Open new encounter with any patient

3. Open a LBV form that has a NationNotes field in it

4. Click in the NN field to activate the WYSIWYG Editor

5. Click "Personalize" button to open an unnamed panel which has two Category text areas in its lower portion.

6. Click on each of the Available Categories to see the Components each one contains.

Nn-13-AvailCats.png






7. With the desired Category selected, click the ">>" button to share it with the current user.

8. Click "Save" button.

Nn-14-ShareTemps.png











9. Click black X to close the panel

10. Reopen editor, select Category and see shared Templates

Nn-15-SharedCats.png

Delete a NationNotes field

A NationNotes field may be easily removed from a LBV form by changing its data type in the Edit Layout screen. This simply produces a different object on the LBV form, with the same label and parameters (except for size values) as the former NN field. If the data type of the field is changed back to NationNotes then it may be reassigned to its former List (Context).

To utterly delete a NN field, its component parts must be removed from their database location. All Categories and Components that have been configured for all NationNotes Contexts are stored in the database table "customlists". They may be permenently deleted by removing them from that table. This is PERMANENT and irreversable so be sure you know it's what you want to do.


1. On Left Navigation Menu: Administration/ Other/ Database

2. In table list in left database window click link on table named "customlists"

3. In right hand window displaying the table, click tab "Browse"

Nn-16-customlists.png


  • Column, "cl_list_item_long" (right hand column in graphic below) displays the user defined names of the NN component items.
  • Column, "cl_list_type" (3d from right hand column in graphic below) which explains the type number of the objects contained in the table.
2 = Context
3 = Template (aka Category)
4 = Sentence (aka Component)
6 = CustomButton

Nn-17-selDel.png

4. Click in left column checkboxes to select the desired list item(s) to delete

5. At bottom of table, click red X in line, "With all Selected:"

Nn-18-DelSel.png





6. Click button "Yes" or "NO" when panel appears containing list items selected for deletion, asking "Do you really want to",

Nn-19-YesDel.png


Back to Part 1, Sample NationNotes Form
Back to Part 2, Building the Sample NationNotes Form