Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Note

This page represents work by ?Kevin Peters for ?Summer Of Code 2008 and may have been replaced by work elsewhere.

Table of Contents
outlinetrue
indent20px
stylenone
printablefalse

Overview

The Logic Web Service is a module for OpenMRS that allows web access to Logic Service functions.

...

Access can be limited by IP address via a settings (formerly global property 1.8 and below). By default, only the computer on which the Logic Web Service module is installed can access it.

...

http://demo.openmrs.org/openmrs/moduleServlet/logicws/api/getFilters

Panel
Code Block

: <?xml version="1.0" encoding="utf-8"?>
: <filterList>
:     <filter name="FILTER_1" id="1" />
:     <filter name="FILTER_2" id="2" />
:     <filter name="FILTER_N" id="42" />
: </filterList>

...

http://demo.openmrs.org/openmrs/moduleServlet/logicws/api/getTokenTags

Panel
Code Block

: <?xml version="1.0" encoding="utf-8"?>
: <tokenTagList>
:     <tag>TAG_1</tag>
:     <tag>TAG_2</tag>
:     <tag>TAG_N</tag>
: </tokenTagList>

...

http://demo.openmrs.org/openmrs/moduleServlet/logicws/api/getTokens?tag=TAG

Panel
Code Block

: <?xml version="1.0" encoding="utf-8"?>
: <tokenList>
:     <token name="TOKEN_1" type="TEXT" />
:     <token name="TOKEN_2" type="BOOLEAN" />
:     <token name="TOKEN_3" type="DATETIME" />
:     <token name="TOKEN_N" type="NUMERIC" scale="3" precision="5" />
: </tokenList>
:
: <!--
:
: Scale is an optional attribute that describes the maximum number
:     of digits to the right of the decimal point.
:
: Precision is an optional attribute that describes the maximum
:     number of decimal digits.
:
: -->

...

The "splits" are those attributes that allow the user to get back more data regarding the token besides the token value (observation date, observation location, etc.). The data style is one of three data style choices: mostrecent, stacked, and flat.

Panel
Code Block

: <?xml version="1.0" encoding="utf-8"?>
: <dataset>
:     <columns>
:         <column token="PATIENT_ID"/>
:         <column token="WEIGHT"/>
:         <column token="CD4 COUNT"/>
:     </columns>
:     <rows>
:         <row>
:             <value>1</value>
:             <value>180</value>
:             <value>209</value>
:         </row>
:         <row>
:             <value>2</value>
:             <value>200</value>
:             <value>198</value>
:         </row>
:     </rows>
: </dataset>
: 

...

To get involved in working on the Logic Web Service, see the Reporting Framework Integration Project /wiki/spaces/AR/pages/18513958.