Skip to content

Commit 57635ad

Browse files
JennnRamirezJennnRamirez
committed
Initial content upload
1 parent f5edb2c commit 57635ad

6 files changed

Lines changed: 270 additions & 0 deletions

File tree

‎cityehr-modelling-guide/src/main/lwdita/modelling-guide/composition.dita‎

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!DOCTYPE topic PUBLIC "-//OASIS//DTD LIGHTWEIGHT DITA Topic//EN" "topic.dtd">
3+
<topic id="composition">
4+
<title>Composition</title>
5+
<shortdesc></shortdesc>
6+
<body>
7+
<p>The ISO-13606 Composition has sub-categories in cityEHR as follows:</p>
8+
<ol><li><p>Message</p></li>
9+
<li><p>Form</p></li>
10+
<li><p>Letter</p></li>
11+
<li><p>Pathway</p></li>
12+
<li><p>Order</p></li>
13+
<li><p>Prescription</p></li>
14+
<li><p>Booking</p></li></ol>
15+
<p>These represent the different ways the Compositions are handled in cityEHR, but generally have the same properties.</p>
16+
<simpletable>
17+
<sthead>
18+
<stentry><p>Property</p></stentry>
19+
<stentry><p>Where Used</p></stentry>
20+
<stentry><p>Description</p></stentry>
21+
</sthead>
22+
<strow>
23+
<stentry><p>Identifier</p></stentry>
24+
<stentry><p>All compositions</p></stentry>
25+
<stentry><p>Unique identifier for the ISO-13606 Composition.</p></stentry>
26+
</strow>
27+
<strow>
28+
<stentry><p>DisplayName</p></stentry>
29+
<stentry><p>All compositions</p></stentry>
30+
<stentry><p>Label used when selecting the Composition</p></stentry>
31+
</strow>
32+
<strow>
33+
<stentry><p>Hint</p></stentry>
34+
<stentry><p>All compositions</p></stentry>
35+
<stentry><p>Description displayed when the user hovers over the Composition selection</p></stentry>
36+
</strow>
37+
<strow>
38+
<stentry><p>Rank</p></stentry>
39+
<stentry><p>All compositions except Message</p></stentry>
40+
<stentry><p>Defines the sort order for the list of Compositions shown for selection. The highest rank appears at the top of the list. Rank of 0 means it is not displayed for selection</p></stentry>
41+
</strow>
42+
<strow>
43+
<stentry><p>Axis</p></stentry>
44+
<stentry><p>Letter</p><p>Form</p></stentry>
45+
<stentry><p>For alignment of Entry and Element on a Composition</p>
46+
<ul>
47+
<li><p>Composition - the same alignment is used for the whole Composition</p></li>
48+
<li><p>Section - the best alignment is used for each Section</p></li>
49+
<li><p>Entry - the best alignment is used for each Entry</p></li>
50+
</ul></stentry>
51+
</strow>
52+
<strow>
53+
<stentry><p>Content</p></stentry>
54+
<stentry><p>All compositions</p></stentry>
55+
<stentry><p>List of Sections contained in the Composition. Only Sections with SectionContext corresponding to the type of Composition are available to select as Content. The SectionContext specified for a Section is one of:</p>
56+
<ul>
57+
<li><p>Composition - Message, Form or Letter</p></li>
58+
<li><p>Pathway</p></li>
59+
<li><p>Order</p></li>
60+
<li><p>Prescription</p></li>
61+
<li><p>Booking</p></li>
62+
</ul>
63+
<p>If on a Composition sheet there are no Sections available for selection as Content, or the expected Sections are absent, then the most likely cause is that the SectionContext is not correctly specified for the Section on the Section sheet</p></stentry>
64+
</strow>
65+
</simpletable>
66+
</body>
67+
</topic>

‎cityehr-modelling-guide/src/main/lwdita/modelling-guide/folder.dita‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!DOCTYPE topic PUBLIC "-//OASIS//DTD LIGHTWEIGHT DITA Topic//EN" "topic.dtd">
3+
<topic id="folder">
4+
<title>Folder</title>
5+
<shortdesc></shortdesc>
6+
<body>
7+
<p>A Folder defines a context of care, such as a clinical specialty or service. The Compositions relevant to that context of care are specified as the content of the Folder.</p>
8+
<simpletable>
9+
<sthead>
10+
<stentry><p>Property</p></stentry>
11+
<stentry><p>Description</p></stentry>
12+
</sthead>
13+
<strow>
14+
<stentry><p>Identifier</p></stentry>
15+
<stentry><p>Unique identifier for the ISO-13606 Folder.</p></stentry>
16+
</strow>
17+
<strow>
18+
<stentry><p>DisplayName</p></stentry>
19+
<stentry><p>Label used when selecting the Folder</p></stentry>
20+
</strow>
21+
<strow>
22+
<stentry><p>Hint</p></stentry>
23+
<stentry><p>Description displayed when the user hovers over the Folder selection</p></stentry>
24+
</strow>
25+
<strow>
26+
<stentry><p>Rank</p></stentry>
27+
<stentry><p>Defines the sort order for the list of Folders shown for selection. The highest rank appears at the top of the list. Rank of 0 means it is not displayed for selection</p></stentry>
28+
</strow>
29+
<strow>
30+
<stentry><p>Conditions</p></stentry>
31+
<stentry><p>Evaluated to determine whether the Folder is in scope, or not.</p></stentry>
32+
</strow>
33+
<strow>
34+
<stentry><p>Content</p></stentry>
35+
<stentry><p>Selected identifiers of the Compositions this folder – View, Message, Form, Letter, Pathway, Order, Prescription or Booking</p></stentry>
36+
</strow>
37+
</simpletable>
38+
</body>
39+
</topic>

‎cityehr-modelling-guide/src/main/lwdita/modelling-guide/modelling-guide.ditamap‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,4 +16,9 @@
1616
<topicref href="properties-defining-structure-health-record.dita"/>
1717
<topicref href="object-properties.dita"/>
1818
<topicref href="data-properties-expressions.dita"/>
19+
<topicref href="other-data-properties.dita"/>
20+
<topicref href="folder.dita"/>
21+
<topicref href="view.dita"/>
22+
<topicref href="composition.dita"/>
23+
<topicref href="section.dita"/>
1924
</map>

‎cityehr-modelling-guide/src/main/lwdita/modelling-guide/other-data-properties.dita‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!DOCTYPE topic PUBLIC "-//OASIS//DTD LIGHTWEIGHT DITA Topic//EN" "topic.dtd">
3+
<topic id="other-data-properties">
4+
<title>Other Data Properties</title>
5+
<shortdesc></shortdesc>
6+
<body>
7+
<simpletable>
8+
<sthead>
9+
<stentry><p>Property</p></stentry>
10+
<stentry><p>Where Used</p></stentry>
11+
<stentry><p>Description</p></stentry>
12+
</sthead>
13+
<strow>
14+
<stentry><p>Hint</p></stentry>
15+
<stentry><p>Folder</p><p>View</p><p>Composition</p><p>Section</p><p>Entry</p><p>Cluster</p><p>Element</p><p>Unit</p><p>CodePoint</p></stentry>
16+
<stentry><p>Text that is displayed when the user hovers over the component in the user interface.</p></stentry>
17+
</strow>
18+
<strow>
19+
<stentry><p>Alert</p></stentry>
20+
<stentry><p>Section</p><p>Entry</p></stentry>
21+
<stentry><p>Text displayed in a distinctive style with the component. Can be used as a dynamic alert by setting Conditions on the Section or Entry.</p></stentry>
22+
</strow>
23+
<strow>
24+
<stentry><p>Rank</p></stentry>
25+
<stentry><p>Folder</p><p>View</p><p>Composition (except Message)</p></stentry>
26+
<stentry><p>A string used to sort Folders, Views and Compositions when they are listed for user selection. Sorted in ascending string order.</p><p>Default value is 1.</p><p>Messages are not selectable by users and so do not have a Rank.</p></stentry>
27+
</strow>
28+
<strow>
29+
<stentry><p>Precision</p></stentry>
30+
<stentry><p>Element</p></stentry>
31+
<stentry><p>The precision (length) of the data value. Used to set the size of the input field in the user interface.</p></stentry>
32+
</strow>
33+
</simpletable>
34+
</body>
35+
</topic>

‎cityehr-modelling-guide/src/main/lwdita/modelling-guide/section.dita‎

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!DOCTYPE topic PUBLIC "-//OASIS//DTD LIGHTWEIGHT DITA Topic//EN" "topic.dtd">
3+
<topic id="section">
4+
<title>Section</title>
5+
<shortdesc></shortdesc>
6+
<body>
7+
<p>For every Section it is important to specify the SectionContext since this defines the type of Composition in which the Section may be used; if no SectionContext is specified then the Section will not be available for selection in any drop-down menus on the Composition sheets.</p>
8+
<p>If on a Composition sheet there are no Sections available for selection as Content, or the expected Sections are absent, then the most likely cause is that the SectionContext is not correctly specified for the Section.</p>
9+
<simpletable>
10+
<sthead>
11+
<stentry><p>Property</p></stentry>
12+
<stentry><p>Description</p></stentry>
13+
</sthead>
14+
<strow>
15+
<stentry><p>Identifier</p></stentry>
16+
<stentry><p>Unique identifier for the ISO-13606 Section.</p></stentry>
17+
</strow>
18+
<strow>
19+
<stentry><p>DisplayName</p></stentry>
20+
<stentry><p>Label used when selecting the Section</p></stentry>
21+
</strow>
22+
<strow>
23+
<stentry><p>Hint</p></stentry>
24+
<stentry><p>Description displayed when the user hovers over the Section selection</p></stentry>
25+
</strow>
26+
<strow>
27+
<stentry><p>Alert</p></stentry>
28+
<stentry><p>Text displayed in a distinctive style with the Section. Can be used as a dynamic alert by setting Conditions on the Section.</p></stentry>
29+
</strow>
30+
<strow>
31+
<stentry><p>SectionContext</p></stentry>
32+
<stentry><p>The context in which the Section is used;</p>
33+
<ul>
34+
<li><p>Composition - Message, Form or Letter</p></li>
35+
<li><p>Pathway</p></li>
36+
<li><p>Order</p></li>
37+
<li><p>Prescription</p></li>
38+
<li><p>Booking</p></li>
39+
</ul></stentry>
40+
</strow>
41+
<strow>
42+
<stentry><p>Sequence</p></stentry>
43+
<stentry><p>Determines the layout of Sections or Entries contained in the Section for Compositions. In addition, for Pathway compositions the Sequence determines whether the contained activities (Acts) are to be performed in sequence or in parallel.</p>
44+
<ul><li><p>Ranked - sequentially, one after the other, laid out vertically</p></li>
45+
<li><p>Unranked - concurrently, in parallel, laid out horizontally</p></li>
46+
</ul></stentry>
47+
</strow>
48+
<strow>
49+
<stentry><p>Rendition</p></stentry>
50+
<stentry><p>The way in which the Section is rendered on screen for user interaction</p>
51+
<ul><li><p>Form - regular interaction using form-based controls (default)</p></li>
52+
<li><p>ImageMap - graphical interaction using an image map (which must be loaded through the Administration page)</p></li>
53+
<li><p>Image - displayed as a static image (which must be loaded through the Administration page)</p></li>
54+
<li><p>Denoted - form-based with each Element preceded by a bullet point icon</p></li>
55+
<li><p>Enumerated - form-based with each Element preceded by a number</p></li>
56+
<li><p>Standalone - displayed in a pop-out (not yet supported) and printed on a new page</p></li>
57+
<li><p>Chart - displayed as a chart generated from historic values of each Element</p></li>
58+
<li><p>Highlighted - form-based, emphasized</p></li>
59+
<li><p>Hidden - not displayed to the user, but recorded in the record when the Composition is committed</p></li>
60+
</ul></stentry>
61+
</strow>
62+
<strow>
63+
<stentry><p>Pre-conditions</p></stentry>
64+
<stentry><p>Result of the expression is cast to xs:boolean</p><p>These pre-conditions are evaluated once, when the Composition is loaded; any out-of- scope Section is removed from the Composition before any user interaction begins.</p></stentry>
65+
</strow>
66+
<strow>
67+
<stentry><p>Conditions</p></stentry>
68+
<stentry><p>The Condition is evaluated continuously as the containing Composition is edited by the user. If the Condition evaluates to <b>true</b> then the Section is in-scope, if the Condition evaluates to <b>false</b> then the Section is out-of-scope.</p>
69+
<p>Any out-of-scope Section has its visibility set to <b>false</b>, is hidden from the user, does not get used in other calculations and is removed from the Composition before it is committed to the patient record.</p></stentry>
70+
</strow>
71+
<strow>
72+
<stentry><p>EvaluationContext</p></stentry>
73+
<stentry><p>Conditions used to constrain the Compositions in the record from which default values for any Elements in the Section are calculated when the Composition is loaded.</p></stentry>
74+
</strow>
75+
<strow>
76+
<stentry><p>Content</p></stentry>
77+
<stentry><p>Selected identifiers of the content of the Section – can be other Sections (i.e. sub- sections) or Entries. The available selection is determined by the SectionContext – only sections of the same SectionContext, or Entries of the EntryType associated with the SectionContext can be selected as content.</p></stentry>
78+
</strow>
79+
</simpletable>
80+
</body>
81+
</topic>

‎cityehr-modelling-guide/src/main/lwdita/modelling-guide/view.dita‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!DOCTYPE topic PUBLIC "-//OASIS//DTD LIGHTWEIGHT DITA Topic//EN" "topic.dtd">
3+
<topic id="view">
4+
<title>View</title>
5+
<shortdesc></shortdesc>
6+
<body>
7+
<p>Views are available on the Summary tab of the patient record. There are three types of view: Folder, Composition or Report.</p>
8+
<p>Views are created by query to the longitudinal record of events for the patient.</p>
9+
<simpletable>
10+
<sthead>
11+
<stentry><p>Property</p></stentry>
12+
<stentry><p>Description</p></stentry>
13+
</sthead>
14+
<strow>
15+
<stentry><p>Identifier</p></stentry>
16+
<stentry><p>Unique identifier for the ISO-13606 View.</p></stentry>
17+
</strow>
18+
<strow>
19+
<stentry><p>DisplayName</p></stentry>
20+
<stentry><p>Label used when selecting the View</p></stentry>
21+
</strow>
22+
<strow>
23+
<stentry><p>Hint</p></stentry>
24+
<stentry><p>Description displayed when the user hovers over the View selection</p></stentry>
25+
</strow>
26+
<strow>
27+
<stentry><p>Rank</p></stentry>
28+
<stentry><p>Defines the sort order for the list of Views shown for selection. The highest rank appears at the top of the list. Rank of 0 means it is not displayed for selection</p></stentry>
29+
</strow>
30+
<strow>
31+
<stentry><p>ViewType</p></stentry>
32+
<stentry><ul><li><p>Folder - the view retrieves all the Composition(s) listed in the Content</p></li>
33+
<li><p>Composition - the view retrieves the Data value for every Element in the Composition listed in the Content</p></li>
34+
<li><p>Report - the view generates a report by filling out the InitialValue (usually the calculated Default value) of each Element in the Composition listed in the Content</p></li>
35+
</ul></stentry>
36+
</strow>
37+
<strow>
38+
<stentry><p>Content</p></stentry>
39+
<stentry><p>Set of Compositions for the View, selected from a drop-down menu.</p></stentry>
40+
</strow>
41+
</simpletable>
42+
</body>
43+
</topic>

0 commit comments

Comments
 (0)