forked from cityEHR/cityehr-documentation
-
Notifications
You must be signed in to change notification settings - Fork 4
Expand file tree
/
Copy pathclinical-correspondence.dita
More file actions
110 lines (110 loc) · 6.17 KB
/
Copy pathclinical-correspondence.dita
File metadata and controls
110 lines (110 loc) · 6.17 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE topic PUBLIC "-//OASIS//DTD LIGHTWEIGHT DITA Topic//EN" "topic.dtd">
<topic id="clinical-correspondence">
<title>Clinical Correspondence</title>
<body>
<section id="Creating-a-Letter-Template">
<title>Creating a Letter Template</title>
<p>Letter templates are word processor documents (either LibreOffice or MS Office) which
contain fields that reference Sections, Entries or Element components in the clinical
information model. The template can then be associated with a Letter composition that
contains those components, which are then extracted from the composition and used to
instantiate the fields in the template.</p>
<p>The letter templates are created outside of cityEHR as any regular document using
LibreOffice Write or MS Word. An example of a template is shown below.</p>
<p/>
<p>
<image href="images/letter-template.png" format="image/png">
<alt> Letter Template for Patient Advice using LibreOffice Writer</alt>
</image>
</p>
<p>A Letter Template can contain any text and graphics, together with the fields which
reference content in the patient record. The text for those fields is then pulled into the template from the Letter in cityEHR with which the template is associated.</p>
<p/>
<simpletable>
<strow>
<stentry>
<p>#ISO-13606:Section:sectionId</p>
</stentry>
<stentry>
<p>The values of all Elements for all Entries in the specified Section</p>
</stentry>
</strow>
<strow>
<stentry>
<p>#ISO-13606:Entry:entryId</p>
</stentry>
<stentry>
<p>The values of all Elements in the specified Entry</p>
</stentry>
</strow>
<strow>
<stentry>
<p>#ISO-13606:Entry:entryId/#ISO-13606:Element:elementId</p>
</stentry>
<stentry>
<p>The value of the specified Element</p>
</stentry>
</strow>
</simpletable>
<p/>
<p>Note that the components with the referenced identifiers must be present in the Letter with which the template is associated – if not, then the referenced field will be blank. When developing templates you can find the identifiers to use by accessing a Letter in cityEHR running in debugging mode. Click the check box to Show Ids and the identifiers for each component will be displayed.</p>
<p>
<image href="images/letters-ids-view.png" format="image/png">
<alt>Show Ids When Running cityEHR in Debugging Mode</alt>
</image>
</p>
</section>
<section id="Importing-and-Associating-a-Template">
<title>Importing and Associating a Template</title>
<ol>
<li>
<p>Letter Templates can be imported from the Administration page by selecting the option for 'Manage Letters' then 'Manage Letter Templates' within the cityEHR Administration page.</p>
</li>
<li>
<p>This page lists all currently loaded templates and you can add a new one by pressing the + button in the top right menu and then browsing to the file location of the word processor document you wish to import.</p>
</li>
<li>
<p>Pressing the red X button next to any existing template in the list allows you to change (re-import) the associated word processor file.</p>
<p>
<image href="images/admin-manage-letter-temps.png" format="image/png">
<alt>Letter templates</alt>
</image>
</p>
</li>
<li>
<p>Once your chosen template is loaded you can associate it with one or more Compositions in the clinical information model by selecting 'Manage Letters' then 'Associate Templates' within the cityEHR Administration page.</p>
<p>
<image href="images/admin-assoc-temps.png" format="image/png">
<alt>Associating letter templates with compositions</alt>
</image>
</p>
</li>
</ol>
</section>
<section id="Using-a-Template-with-a-Letter">
<title>Using a Template with a Letter</title>
<p>After your letter template has been uploaded into cityEHR, you can now navigate back to the patient you would like to complete a letter for.</p>
<ol>
<li>
<p>Once you have completed your desired letter within cityEHR, select your desired print template from the drop-down 'Word Processor Template' list</p>
<p><b>Note: </b>The templates associated with a Letter are available to select after editing has begun.</p>
<p>
<image href="images/letters-patient-advice.png" format="image/png">
<alt>Patient advice letter template</alt>
</image>
</p>
</li>
<li>
<p>Click the word processor button on the right of the drop-down list and open the newly download file.</p>
<p><b>Note: </b>The name of the downloaded file is set to <i>'PatientId-letterName-date.odt'</i></p>
</li>
</ol>
<p>
<image href="images/screenshot-edit-template.png" format="image/png">
<alt>Screenshot of Letter template being edited</alt>
</image>
</p>
</section>
</body>
</topic>