Skip to content

Commit deb3a23

Browse files
marmouremarmoure
authored
Merge branch 'cityEHR:main' into develop
2 parents 516e94c + 6148f04 commit deb3a23

48 files changed

Lines changed: 2758 additions & 673 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎cityehr-documentation-common/src/main/xslt/create-topic-html.xslt‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -97,15 +97,15 @@
9797
</xsl:template>
9898

9999
<xsl:template match="simpletable" mode="body">
100-
<table style="border-collapse: collapse" >
100+
<table style="border-collapse: collapse; width: 85%;">
101101
<xsl:apply-templates select="node()" mode="body"/>
102102
</table>
103103
</xsl:template>
104104

105105
<xsl:template match="sthead" mode="body">
106-
<th>
106+
<tr>
107107
<xsl:apply-templates select="node()" mode="table-head"/>
108-
</th>
108+
</tr>
109109
</xsl:template>
110110

111111
<xsl:template match="strow" mode="body">
@@ -115,11 +115,11 @@
115115
</xsl:template>
116116

117117
<xsl:template match="stentry" mode="table-head">
118-
<td style="padding: 4px; border: 1px solid black;">
118+
<th style="padding: 4px; border: 1px solid black; background-color: #f2f2f2;">
119119
<b>
120120
<xsl:apply-templates select="node()" mode="body"/>
121121
</b>
122-
</td>
122+
</th>
123123
</xsl:template>
124124

125125
<xsl:template match="stentry" mode="table-row">

‎cityehr-documentation-common/src/main/xslt/create-topic-pdf.xslt‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,11 +88,30 @@
8888
<xsl:for-each select="strow[1]/stentry">
8989
<fo:table-column/>
9090
</xsl:for-each>
91+
<xsl:if test="sthead">
92+
<fo:table-header>
93+
<xsl:apply-templates select="sthead" mode="body"/>
94+
</fo:table-header>
95+
</xsl:if>
9196
<fo:table-body>
9297
<xsl:apply-templates select="strow" mode="body"/>
9398
</fo:table-body>
9499
</fo:table>
95100
</xsl:template>
101+
102+
<xsl:template match="sthead" mode="body">
103+
<fo:table-row>
104+
<xsl:apply-templates select="stentry" mode="table-head"/>
105+
</fo:table-row>
106+
</xsl:template>
107+
108+
<xsl:template match="stentry" mode="table-head">
109+
<fo:table-cell border="1pt solid black" padding="4pt" background-color="#eeeeee">
110+
<fo:block font-weight="bold">
111+
<xsl:apply-templates select="node()" mode="body"/>
112+
</fo:block>
113+
</fo:table-cell>
114+
</xsl:template>
96115

97116
<xsl:template match="strow" mode="body">
98117
<fo:table-row>

‎cityehr-documentation-website/src/main/website/index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<html xmlns:cc="http://creativecommons.org/ns#" xmlns:dct="http://purl.org/dc/terms/">
33
<head>
44
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5-
<title>Modelling Guide</title>
5+
<title>cityEHR Documentation</title>
66
<meta xmlns:com="http://cityehr/common" name="author" content="John Chelsom">
77
<meta xmlns:com="http://cityehr/common" name="author" content="Stephanie Cabrera">
88
<meta xmlns:com="http://cityehr/common" name="author" content="Catriona Hopper">

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

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!DOCTYPE topic PUBLIC "-//OASIS//DTD LIGHTWEIGHT DITA Topic//EN" "topic.dtd">
3+
<topic id="cluster">
4+
<title>Cluster</title>
5+
<shortdesc></shortdesc>
6+
<body>
7+
<p>Clusters are used to group Elements together and are for layout purposes only. Clusters do not convey any clinical context.</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 Cluster.</p></stentry>
16+
</strow>
17+
<strow>
18+
<stentry><p>DisplayName</p></stentry>
19+
<stentry><p>Label (title) used when selecting the Cluster</p></stentry>
20+
</strow>
21+
<strow>
22+
<stentry><p>Hint</p></stentry>
23+
<stentry><p>Description displayed when the user hovers over the Cluster</p></stentry>
24+
</strow>
25+
<strow>
26+
<stentry><p>Sequence</p></stentry>
27+
<stentry><p>Determines the layout of Elements and Clusters in the Cluster. By default the Sequence of nested Clusters is toggled at each level.</p>
28+
<ul>
29+
<li><p>Ranked - sequentially, one after the other, laid out vertically</p></li>
30+
<li><p>Unranked - concurrently, in parallel, laid out horizontally</p></li>
31+
</ul></stentry>
32+
</strow>
33+
<strow>
34+
<stentry><p>Conditions</p></stentry>
35+
<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 Cluster is in-scope, if the Condition evaluates to <b>false</b> then the Cluster is out-of-scope.</p>
36+
<p>Any out-of-scope Cluster 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>
37+
</strow>
38+
<strow>
39+
<stentry><p>Content</p></stentry>
40+
<stentry><p>Set of Clusters and Elements contained in the Cluster. Selected from a dropdown menu.</p></stentry>
41+
</strow>
42+
</simpletable>
43+
</body>
44+
</topic>

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

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!DOCTYPE topic PUBLIC "-//OASIS//DTD LIGHTWEIGHT DITA Topic//EN" "topic.dtd">
3+
<topic id="codepoint">
4+
<title>CodePoint</title>
5+
<shortdesc></shortdesc>
6+
<body>
7+
<p>CodePoints are assigned to Entries in a Composition, either statically or dynamically. Any Composition may have an associated CodePointSet composition which holds all the CodePoints assigned to the Entries in the Composition. The CodePointSet is generated by iterating through the Entries of the Composition and finding any associated CodePoints that have been defined. There may be more than one CodePoint assigned to any individual Entry.</p>
8+
<p>CodePoints are associated with the Entry specified as the Context property. If the CodePoint has Conditions then these are used to determine the dynamic association of the CodePoint with the Entry; if there are no Conditions then the CodePoint is statically assigned.</p>
9+
<p>The CodePointSet is created when the Composition is first committed to the patient record and can be updated by viewing the Event in the record. This means that the CodePointSet is stored as data (dynamic) in the patient record. The CodePointSet may be applied to its associated Composition when the composition is exported from cityEHR; each code is then added as cda:code element to the associated cda:entry.</p>
10+
<p>CodePoints can also be used in Cohort Searches.</p>
11+
<simpletable>
12+
<sthead>
13+
<stentry><p>Property</p></stentry>
14+
<stentry><p>Description</p></stentry>
15+
</sthead>
16+
<strow>
17+
<stentry><p>Identifier</p></stentry>
18+
<stentry><p>Unique identifier for the ISO-13606 Element</p></stentry>
19+
</strow>
20+
<strow>
21+
<stentry><p>DisplayName</p></stentry>
22+
<stentry><p>Label (title) used when selecting the Element</p></stentry>
23+
</strow>
24+
<strow>
25+
<stentry><p>Hint</p></stentry>
26+
<stentry><p>Description displayed when the user hovers over the Element</p></stentry>
27+
</strow>
28+
<strow>
29+
<stentry><p>Code</p></stentry>
30+
<stentry><p>The value of the clinical code assigned to the CodePoint</p></stentry>
31+
</strow>
32+
<strow>
33+
<stentry><p>CodeSystem</p></stentry>
34+
<stentry><p>The coding system of the Code assigned to the CodePoint. Selected from one of values defined on the Properties sheet:</p>
35+
<ul><li><p>SNOMED</p></li>
36+
<li><p>ICD-10 (can be changed to ICD 11)</p></li>
37+
<li><p>LOINC</p></li>
38+
<li><p>Additional coding systems can be added to this list</p></li>
39+
</ul></stentry>
40+
</strow>
41+
<strow>
42+
<stentry><p>Context</p></stentry>
43+
<stentry><p>The Entry with which the CodePoint is associated. Since Entry is the lowest context at which actionable clinical information is defined CodePoints can only be assigned at this level. If, for example, CodePoints could be assigned to Elements then the clinical meaning of the Element can change depending on the context of the Entry in which the Element is used, which may render the CodePoint invalid</p></stentry>
44+
</strow>
45+
<strow>
46+
<stentry><p>Conditions</p></stentry>
47+
<stentry><p>Conditions evaluated in the context of the Entry to which the CodePoint is assigned. If the Conditions evaluate to true then the CodePoint is assigned, if they evaluate to <b>false</b> then it is not assigned.</p></stentry>
48+
</strow>
49+
</simpletable>
50+
</body>
51+
</topic>

‎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/configuration-sheet.dita‎

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!DOCTYPE topic PUBLIC "-//OASIS//DTD LIGHTWEIGHT DITA Topic//EN" "topic.dtd">
3+
<topic id="configuration-sheet">
4+
<title>Configuration Sheet</title>
5+
<shortdesc></shortdesc>
6+
<body>
7+
<p><image href="images/commonModel-config-zoomed-gridlines.png" format="image/png">
8+
<alt>cityEHR Configuration Sheet</alt></image></p>
9+
<p><b>Configuration Parameters Definitions</b></p>
10+
<simpletable id="configuration-parameters">
11+
<sthead>
12+
<stentry><p>Parameter</p></stentry>
13+
<stentry><p>Description</p></stentry>
14+
</sthead>
15+
<strow>
16+
<stentry><p>ApplicationId</p></stentry>
17+
<stentry><p>The identifier for the cityEHR application that is driven by this model. The file can only be loaded for the application with this identifier. <i>Required</i></p></stentry>
18+
</strow>
19+
<strow>
20+
<stentry><p>ModelOwner</p></stentry>
21+
<stentry><p>Name of the model owner – copyright is asserted in the ontology</p></stentry>
22+
</strow>
23+
<strow>
24+
<stentry><p>SpecialtyId</p></stentry>
25+
<stentry><p>The identifier for the specialty (folder) for this model. <i>Required</i></p></stentry>
26+
</strow>
27+
<strow>
28+
<stentry><p>SpecialtyDisplayName</p></stentry>
29+
<stentry><p>The display name (title) for the specialty</p></stentry>
30+
</strow>
31+
<strow>
32+
<stentry><p>LanguageCode</p></stentry>
33+
<stentry><p>The pair of ISO 639-1 language code and ISO 3166-1 Alpha-2 country code. For example en-gb (which is the default).</p></stentry>
34+
</strow>
35+
</simpletable>
36+
<p></p>
37+
<simpletable id="configuration-field-types">
38+
<sthead>
39+
<stentry><p>Field type</p></stentry>
40+
<stentry><p>Colour</p></stentry>
41+
<stentry><p>Description</p></stentry>
42+
</sthead>
43+
<strow>
44+
<stentry><p>Reference</p></stentry>
45+
<stentry><p>#FFFFCC</p></stentry>
46+
<stentry><p>A reference to an ISO 13606 component, selected in a drop-down menu</p></stentry>
47+
</strow>
48+
<strow>
49+
<stentry><p>DisplayName</p></stentry>
50+
<stentry><p>#CCCCFF</p></stentry>
51+
<stentry><p>The display name (title) of an ISO 13606 component or data value.</p></stentry>
52+
</strow>
53+
<strow>
54+
<stentry><p>Value</p></stentry>
55+
<stentry><p>#E6E6FF</p></stentry>
56+
<stentry><p>A (categorical) value of the Data for an ISO 13606 Element</p></stentry>
57+
</strow>
58+
<strow>
59+
<stentry><p>Identifier</p></stentry>
60+
<stentry><p>#CCFFFF</p></stentry>
61+
<stentry><p>The identifier for an ISO 13606 component. Must be unique on each sheet (i.e. for each component type). A-z, A-Z, 0-9,, -, _, . (dot) only.</p></stentry>
62+
</strow>
63+
<strow>
64+
<stentry><p>Literal</p></stentry>
65+
<stentry><p>#D3FFD5</p></stentry>
66+
<stentry><p>The string literal for a data property, including calculations.</p></stentry>
67+
</strow>
68+
<strow>
69+
<stentry><p>Property</p></stentry>
70+
<stentry><p>#FFFF99</p></stentry>
71+
<stentry><p>The value of an object property, selected in a drop-down menu</p></stentry>
72+
</strow>
73+
</simpletable>
74+
</body>
75+
</topic>

0 commit comments

Comments
 (0)