Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 9 Next »

Overview

The aim of this project is to allow users to export OpenMRS data (encounters) as hl7 objects. It is built using Groovy templates, and can be extended / configured by users as per their wishes.

This document will cover the following information -

  • 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?

The default version of the hl7query module supports only the export of ORUR01 messages.

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 Template' page.

However, this requires a strong knowledge of groovyscript.'

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

  1. Users will be able to request to download either a single encounter or multiple encounters as a single ORUR01 message
    • Something like /openmrs/hl7query/orur01?patient=uuidofpatient&encounter=uuidofencounter
  2. The ORUR01 message will contain the elements MSH, PV1, PID, OBR and OBX
  3. The PV1 and PID segments (and then the OBR/OBX) will repeat for each extra encounter included
  4. The hl7 message will be exported as a pipe delimited object
  5. The admin can define the exact elements, layout and flow of each different message type by creating groovy templates
    • Groovy template is xml based
    • The xml refers to exact fields in hl7
    • HAPI is used to parse the xml into hl7

Documentation / How-To

Downloads

http://modules.openmrs.org/modules/view.jsp?module=hl7query

Source code: https://github.com/OpenMRS/openmrs-module-hl7query

Screenshots

Release Notes

  • 1.0 (initial release)
    • TBD

About

This module was developed by Suranga K for Jembi (and during this sprint)

  • No labels