Skip directly to searchSkip directly to the site navigationSkip directly to the page's main content

IBIS-Q System Documentation - Query Module Example

MODULE FILE

The module file is used to create the query-builder page. It contains three types of information:
  1. The sections (steps) and selections that are used to build a query.
  2. The overview text and help buttons to assist the user.
  3. The PARAMETERS and CONFIGURATIONS that give instructions on how the page should be displayed (which steps, selections, dimensions, function file, configuration file, etc. should be used).
More information about this type of file is given in Creating a Query Module.

Syntax

File Name: Module.xml
<QUERY_MODULE>
    <NAME>File name</NAME>
    <TITLE>Title</TITLE>
    <DESCRIPTION>Description</DESCRIPTION>
    <VERSION>Date</VERSION>
	<KEYWORDS>list</KEYWORDS>
	<ORG_UNIT_NAME></ORG_UNIT_NAME>
    <PARAMETERS>
      <PARAMETER><NAME>parameter</NAME><VALUE>value</VALUE></PARAMETER>
    </PARAMETERS>
	<QUERY_CONFIGURATION_SELECTION>
	  <LOCAL_URL>query/selection/module/ModuleSelection.html</LOCAL_URL>
      <TITLE>Module</TITLE>
	</QUERY_CONFIGURATION_SELECTION>
    <CONFIGURATIONS>
      <CONFIGURATION>
        (Configuration tags)
      </CONFIGURATION>
        ...
    </CONFIGURATIONS>
    <CRITERIA>
      <OVERVIEW>
        <SECTION>
          <TITLE>Title</TITLE>
          <TEXT>Text</TEXT>
        </SECTION>
        ...
      </OVERVIEW>
      <SECTIONS>
        <SECTION>
          (Section tags)
        <SECTION>
        ...
      </SECTIONS>
    </CRITERIA>
    <DIMENSIONS>
      <DIMENSION>
		<NAME>Name</NAME>
		<TITLE>Title</TITLE>
		<VALUES>
		  <VALUE>Value<TITLE>Title</TITLE></VALUE>
		  ...
		</VALUES>
      </DIMENSION>
      ...
    </DIMENSIONS>
</QUERY_MODULE>
 

Example

File name: MortCntyICD10.xml (excerpt)
Links: Configurations tag, Criteria tag, Dimensions tag
1	<QUERY_MODULE xmlns:ibis="http://www.ibisph.org">

2	  <ibis:doc>
3	    <name>query/module//</name>
4	    <summary>Query Module definition</summary>
5	    <description/>
6	    <author>Shandra Burnett</author>
7	    <company>Utah Department of Health</company>
8	    <versions>
9	      <version>
10	        <number>2.0.1</number>
11	        <date>Oct 16, 2007</date>
12	        <who>Shandra</who>
13	        <description>add GeoRes section</description>
14	      </version>
15			. . .
16	    </versions>
17	  </ibis:doc>
  
18	  <NAME>MortCntyICD10</NAME>
19	  <TITLE>Mortality ICD-10 Query Module for Utah Counties   
	  and Local Health Districts</TITLE>
20	  <DESCRIPTION>Mortality ICD-10, 1999 to present, by County  
	  and Local Health District</DESCRIPTION>
21	  <VERSION>December 1, 2005</VERSION>
22	  <KEYWORDS>mortality, leading causes of death, age at death, 
	  ICD-10</KEYWORDS>
23	  <ORG_UNIT_NAME>CHD_OVRS</ORG_UNIT_NAME>
24	  <PARAMETERS>
25	    <PARAMETER>
26	      <NAME>config</NAME>
27	      <VALUE>/srv/ibis-q/modules/mort/Mort.cfg</VALUE>
28	    </PARAMETER>
29	    <PARAMETER>
30	      <NAME>sas</NAME>
31	      <VALUE>0</VALUE>
32	    </PARAMETER>
33	    <PARAMETER>
34	      <NAME>test</NAME>
35	      <VALUE>0</VALUE>
36	    </PARAMETER>
37	  </PARAMETERS>

38	  <QUERY_CONFIGURATION_SELECTION>
39	    <LOCAL_URL>query/selection/mort/MortSelection.html</LOCAL_URL>
40	    <TITLE>Mortality</TITLE>
41	  </QUERY_CONFIGURATION_SELECTION>
42	  <CONFIGURATIONS>
	    ...
43	    <CONFIGURATION>
44	      <MEASURES>
45	        <MEASURE>
46	          <NAME>Rate</NAME>
47	          <TITLE>Crude Rates, Deaths Per 100,000 Population</TITLE>
48	          <DESCRIPTION>Mortality Crude Rates</DESCRIPTION>
49	          <NUMERATOR>
50	            <TITLE>Number of Deaths</TITLE>
51	          </NUMERATOR>
52	          <DENOMINATOR>
53	            <TITLE>Number in the Population</TITLE>
54	            <DESCRIPTION>Number of Persons in the 
	            Population</DESCRIPTION>
55	          </DENOMINATOR>
56	          <LOWER_CONFIDENCE_LIMIT>
57	            <TITLE>95% CI LL</TITLE>
58	            <DESCRIPTION>95% Confidence Interval 
	            Lower Limit</DESCRIPTION>
59	          </LOWER_CONFIDENCE_LIMIT>
60	          <UPPER_CONFIDENCE_LIMIT>
61	            <TITLE>95%CI UL</TITLE>
62	            <DESCRIPTION>95% Confidence Interval 
	            Upper Limit</DESCRIPTION>
63	          </UPPER_CONFIDENCE_LIMIT>
64	        </MEASURE>
65	      </MEASURES>
66	      <NAME>CrudeRate</NAME>
67	      <TITLE>Crude Rates, Deaths Per 100,000 Population</TITLE>
68	      <DESCRIPTION>Mortality Crude Rates</DESCRIPTION>
69	      <PARAMETERS>
70	        <PARAMETER>
71	          <NAME>func</NAME>
72	          <VALUE>CrudeRate.def</VALUE>
73	        </PARAMETER>
74	      </PARAMETERS>
75	      <CRITERIA>
76	        <EXCLUSIONS>
77	          <SECTION_NAMES>
78	            <SECTION_NAME>Top10</SECTION_NAME>
79	            <SECTION_NAME>GeoMap</SECTION_NAME>
80	          </SECTION_NAMES>
81	          <DIMENSION_NAMES>
82	            <DIMENSION_NAME>ICDNCHS50Top10</DIMENSION_NAME>
83	          </DIMENSION_NAMES>
84	        </EXCLUSIONS>
85	      </CRITERIA>
86	      <DATA_SOURCES>
<!--standard way to include data source-->
87	        <DATA_SOURCE name="Death">
88	          <NAME>Death</NAME>
89	          <TEXT>Utah Death Certificate Database, Office of Vital  
	          Records and Statistics, Utah Department of Health</TEXT>
90	          <SORT_ORDER>4</SORT_ORDER>
91	        </DATA_SOURCE>
<!--standard way to xinclude data source used in more than 1 place-->
92	        <ibis:include href="data_source/GOPB.xml"/>
93	      </DATA_SOURCES>
94	      <DATA_NOTES>
<!--standard way to xinclude data note, may have 0 or many-->
95	        <ibis:include href="data_note/ICD.xml"/>
<!--Include data note information here, such as:  
    definitions for parameters used in the data (ICD codes,  
    race categories, small areas), why parameters are used,  
    question text for surveys, etc.-->
96	      </DATA_NOTES>
97	      <DATA_ISSUES>
<!--standard way to include data issue, may have 0 or many-->
98	        <ibis:include href="data_issue/Mort.xml"/>
<!--Include data issue information here, such as:  
    validity of data, how data are collected and updated,  
    completeness of data, things to consider when interpreting 
    this data, etc.-->
99	      </DATA_ISSUES>
100	    </CONFIGURATION>
	    ...
101	  </CONFIGURATIONS>
102	  <CRITERIA>
103	    <OVERVIEWS>
<!--standard way to include overview-->
104	      <OVERVIEW>
105	        <TITLE>Overview</TITLE>
106	        <TEXT>The mortality data in this IBIS-Q query module have   
	        been derived from death certificates in participation with    
	        the National Vital Statistics System, and are maintained and   
	        provided by the Utah Department of Health, Office of Vital  
	        Records.  They include virtually all deaths of Utah residents,  
	        regardless of where the death occurred. The causes of death  
	        were coded using International Classification of Diseases 
	        (ICD) codes.</TEXT>
107	      </OVERVIEW>
<!--standard way to xinclude overview used in more than 1 place-->
108	      <ibis:include href="overview/GettingStarted.xml"/>
109	    </OVERVIEWS>
110	    <SECTIONS>
<!--standard way to include a section (step)-->
111	      <SECTION>
112	        <NAME>YearNew</NAME>
113	        <TITLE>Select year</TITLE>
<!--Used to specify defaults for this step-->
114	        <SELECTED_DIMENSIONS>
115	          <SELECTED_DIMENSION>
116	            <NAME>YearProxy</NAME>
117	            <VALUES><VALUE>Year99-Pres</VALUE></VALUES>
118	          </SELECTED_DIMENSION>
119	          <SELECTED_DIMENSION>
120	            <NAME>Year99-Pres</NAME>
121	            <VALUES><VALUE>2006</VALUE></VALUES>
122	          </SELECTED_DIMENSION>
123	        </SELECTED_DIMENSIONS>
124	        <SELECTIONS>
125	          <NAME>YearProxy</NAME>
126	          <TITLE>What year grouping do you want to select? 
	          Default is single years, most recent year.</TITLE>
127	          <DESCRIPTION>Filter by year group</DESCRIPTION>
<!--For selection type, <SINGLE/> = radio buttons, <MULTIPLE/> = checkboxes, 
other options include <LIST> and <TEXT_INPUT>. See examples below.-->
128	          <SELECTION_TYPE>
129	            <SINGLE/>
130	          </SELECTION_TYPE>
131	          <SELECTION>
132	            <TITLE>Single years</TITLE>
133	            <VALUE>Year99-Pres</VALUE>
134	            <ibis:include href="../help/Year.xml"/>
135	            <SELECTIONS>
<!--optional way to add an all type selection to the dimension-->
136	              <SELECTION><TITLE>All years</TITLE></SELECTION>
<!--refers to dimension listed in dimension tag below-->
137	              <DIMENSION_NAME>Year99-Pres</DIMENSION_NAME>
<!--Selection type LIST example. SINGLE can also be used.-->
138	              <SELECTION_TYPE>
139	                <LIST>
140	                  <SIZE>5</SIZE>
141	                  <MULTIPLE/>
142	                </LIST>
143	              </SELECTION_TYPE>
144	            </SELECTIONS>
145	          </SELECTION>
146	          <SELECTION>
147	            <TITLE>3-year groups</TITLE>
148	            <VALUE>YearGrp3_99-Pres</VALUE>
149	            <SELECTIONS>
150	              <SELECTION><TITLE>All year groups</TITLE></SELECTION>
151	              <DIMENSION_NAME>YearGrp3_99-Pres</DIMENSION_NAME>
152	              <SELECTION_TYPE>
153	                <LIST>
154	                  <SIZE>4</SIZE>
155	                  <MULTIPLE/>
156	                </LIST>
157	              </SELECTION_TYPE>
158	            </SELECTIONS>
159	          </SELECTION>
160	          <SELECTION>
161	            <TITLE>5-year groups</TITLE>
162	            <VALUE>YearGrp5_99-Pres</VALUE>
163	            <SELECTIONS>
164	              <SELECTION><TITLE>All year groups</TITLE></SELECTION>
165	              <DIMENSION_NAME>YearGrp5_99-Pres</DIMENSION_NAME>
166	             <SELECTION_TYPE>
167	                <LIST>
168	                  <SIZE>3</SIZE>
169	                  <MULTIPLE/>
170	                </LIST>
171	              </SELECTION_TYPE>
172	            </SELECTIONS>
173	          </SELECTION>
174	          <SELECTION>
175	            <VALUE>Year9</VALUE>
176	            <TITLE>Enter custom year group(s) </TITLE>
177	            <SELECTIONS>
178	              <DIMENSION_NAME>Year9</DIMENSION_NAME>
179	              <SELECTION_TYPE>
180	                <TEXT_INPUT>
181	                  <MAX_LENGTH>35</MAX_LENGTH>
182	                </TEXT_INPUT>
183	              </SELECTION_TYPE>
184	            </SELECTIONS>
185	          </SELECTION>
186	        </SELECTIONS>
187	      </SECTION>
<!--standard way to include a section -->
188	      <SECTION>
189	        <NAME>Top10</NAME>
190	        <TITLE>Select cause of death</TITLE>
191	          <SELECTIONS>
192	            <DESCRIPTION>Filter by Leading Causes of Death</DESCRIPTION>
193	            <SELECTION_TYPE>
194	              <SINGLE/>
195	            </SELECTION_TYPE>
196	            <SELECTION>
197	              <TITLE>Leading causes of death are generated   
	              from NCHS 50 leading causes</TITLE>
<!--selections element xincluded, can xinclude any code-->
198	              <ibis:include href="selections/ICDNCHS50Top10.xml"/>
199	            </SELECTION>
200	          </SELECTIONS>
201	      </SECTION>
202	      <ibis:include href="section/CauseDeath.xml"/>
203	      <ibis:include href="section/_range/AgeGrp.xml"/>
204	      <ibis:include href="section/Sex.xml"/>
205	      <ibis:include href="section/GeoMap.xml"/>
206	      <ibis:include href="section/GeoRes.xml"/>
207	      <ibis:include href="section/Geo.xml"/>
208	    </SECTIONS>
209	  </CRITERIA>
210	  <DIMENSIONS>
<!--Proxy dimension code only uses NAME and TITLE tags-->
211	    <ibis:include href="dimension/YearProxy.xml"/>
<!--standard way to include a dimension-->
212	    <DIMENSION>
213	      <NAME>Year99-Pres</NAME>
214	      <TITLE>Single Years</TITLE>
215	      <DESCRIPTION>List of years 1999 through present</DESCRIPTION>
<!--If a proxy variable is used for this dimension, it must be 
referenced here-->
216	      <PROXY_DIMENSION_NAME>YearProxy</PROXY_DIMENSION_NAME>
217	      <VALUES>
218	        <VALUE>1999</VALUE>
219	        <VALUE>2000</VALUE>
220	        <VALUE>2001</VALUE>
221	        <VALUE>2002</VALUE>
222	        <VALUE>2003</VALUE>
223	        <VALUE>2004</VALUE>
224	        <VALUE>2005</VALUE>
225	        <VALUE>2006</VALUE>
226	        <VALUE>.<TITLE>Total</TITLE><NOT_ASSOCIATED_FLAG/></VALUE>
227	      </VALUES>
228	    </DIMENSION>
<!--standard way to xinclude a dimension-->
229	    <ibis:include href="dimension/YearGrp3_99-Pres.xml"/>
230	    <ibis:include href="dimension/YearGrp5_99-Pres.xml"/>
231	    <ibis:include href="dimension/Year9.xml"/>
232	    <ibis:include href="dimension/ICDNCHS50Top10.xml"/>
233	    <ibis:include href="dimension/CauseDeathProxy.xml"/>
234	    <ibis:include href="dimension/ICDNCHS50.xml"/>
235	    <ibis:include href="dimension/ICDNCHS113.xml"/>
236	    <ibis:include href="dimension/CauseDeath9.xml"/>
237	    <ibis:include href="dimension/AgeGrpProxy.xml"/>
238	    <ibis:include href="dimension/_range/AgeGrp11.xml"/>
239	    <ibis:include href="dimension/_range/AgeGrp4.xml"/>
240	    <ibis:include href="dimension/_range/AgeGrp7.xml"/>
241	    <ibis:include href="dimension/_range/AgeGrp8.xml"/>
242	    <ibis:include href="dimension/_range/AgeGrp18.xml"/>
243	    <ibis:include href="dimension/AgeGrp9.xml"/>
244	    <ibis:include href="dimension/Sex.xml"/>
245	    <ibis:include href="dimension/GeoProxy.xml"/>
246	    <ibis:include href="dimension/GeoCnty.xml"/>
247	    <ibis:include href="dimension/GeoLHD.xml"/>
248	    <ibis:include href="dimension/GeoRes.xml"/>
249	  </DIMENSIONS>
250	</QUERY_MODULE>
The information provided was retrieved on: Sat, 29 February 2020 2:01:22.

Content updated: Wed, 26 Mar 2008 17:17:17 MDT