Versions Compared

Key

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

...

  • What types of messages are currently supported by the hl7query module
  • How may  users extend on the hl7query module
  • an introduction to the hl7query segments currently used in the module
  • A technical overview of how the module is built
  • Installation and configuration of the module
  • Extending / configuring the module as per the users requirements

What types of messages are currently supported by the hl7query module?

...

This means that the first release of the module contains only hl7 templates that support only the generation of ORUR01 message segments. However, developers are free to write up their own custom hl7 message templates, which can be added to the module. Custom templates can be used to export OpenMRS data in any form of hl7 message.Adding a new template

How may users extend on the hl7query module?

Users may extend upon the default version of the hl7query module by adding custom hl7 templates of their own. This may be done via the 'Add A TemplateManage Templates' page.

However, this requires a strong knowledge of groovyscript.

Adding a new template can be done as follows -

1) Creating a new template from scratch

2) Editing an existing template

If a user wishes to edit an existing template, simply click on an existing template, edit it, and save as new.

To create a new template navigate to the 'Manage Templates' page, and add the new template

Understanding the 'Manage templates' Page

Following is an explanation of what each segment of the 'Manage templates' Page represents. Image Added
Template name : The name by whih the template will be identified. Examples : Generic PV1, FullPV1 or AMPATHPV1

Entity : The hl7 segment which the template represents. Examples : PV1, MSH, OBR

Language : The language the templaate is written in. Currently, this may be only Groovyscript

Template : The actual Groovyscript code.

A Groovyscript template may also refer to another existing template by name.

Note: If the new template represents an combined hl7 message type (ORUR01, ADT etc.), and the use wishes to export data in that particular message type, then he / she must also edit the 'Template' global property to point to the given template. 

Initially, the hl7query module will support the export of data only as ORUR01 messages.

...