HL7
The Administration|HL7 screen enables HL7 support to be configured.
This includes:
- Services - the HL7 services that OpenVPMS connects to
- Connectors - these determine how OpenVPMS connects to the services
Connectors
The Connectors screen supports viewing and editing HL7 connectors.
Connectors may be:
- Senders - used to send HL7 messages from OpenVPMS to an external system
- Receivers - used to receive HL7 messages from an external system
The buttons are as follows:
| New | create a new Connector |
| Edit | edit the selected Connector |
| Delete | delete the selected Connector - a confirmation window will appear |
| Messages | displays HL7 messages sent or received via the selected Connector |
| Stop | stops messaging for a Sender. Messages will be queued until the Sender is started. |
| Start | starts messaging for a Sender |
HL7 MLLP Receiver
This is the create/edit/view screen for HL7 MLLP Receivers. These are responsible for receiving HL7 messages using the MLLP protocol over TCP/IP, from external applications.
The fields are as follows:
| Id | the receiver identifier |
| Name | the receiver name |
| Active | uncheck this box to deactivate the receiver. Deactivating the receiver prevents HL7 messages being received. |
| Port | The TCP/IP port to listen on |
| Sending Application | Uniquely identifies the sending application among all other applications within the network. |
| Sending Facility | Identifies the sending application facility. |
| Receiving Application | Uniquely identifies the receiving application among all other applications within the network. |
| Receiving Facility | Identifies the receiving application facility. |
| Include Milliseconds | If checked, timestamp fields in acknowlegements will include milliseconds. |
| Include Time Zone | If checked, timestamp fields in acknowlegements will include the time zone. |
HL7 MLLP Sender
This is the create/edit/view screen for HL7 MLLP Senders. These are responsible for sending HL7 messages using the MLLP protocol over TCP/IP, to external applications.
The fields are as follows:
| Id | the sender identifier |
| Name | the sender name |
| Active | uncheck this box to deactivate the sender. Deactivating the sender prevents HL7 messages being sent. |
| Host | The host to connect to |
| Port | The port to connect to |
| Sending Application | Uniquely identifies the sending application among all other applications within the network. |
| Sending Facility | Identifies the sending application facility. |
| Receiving Application | Uniquely identifies the receiving application among all other applications within the network. |
| Receiving Facility | Identifies the receiving application facility. |
| Response Timeout | The maximum time to wait for responses, in seconds. |
| Retry Interval | The time to wait after an error occurs, before resubmitting a message. |
| Include Milliseconds | If checked, timestamp fields will include milliseconds. |
| Include Time Zone | If checked, timestamp fields will include the time zone. |
Messages
The Messages window displays HL7 messages sent or received via a HL7 Connector.
The buttons are as follows:
| Find | Find all messages matching the criteria. Also press this to refresh the display. |
| OK | closes the window |
| Resubmit |
resubmits a message to an external application. Only applies to:
|
Services
The Services screen supports viewing and editing HL7 services.
The buttons are as follows:
| New | create a new service |
| Edit | edit the selected service |
| Delete | delete the selected service - a confirmation window will appear |
Patient Event Service
A Patient Event Service is an HL7 service that notifies an external application of patient events using HL7 messages.
The fields are as follows:
| Id | the service identifier |
| Name | the service name |
| Description | the service description |
| Active | uncheck this box to deactivate the service. Deactivating the service prevents HL7 messages being sent. |
| Connector | the HL7 connector used to send messages to the external application |
| Location | the practice location that this service will send messages for |
HL7 Messages
For a list of messages and their triggers, see the HL7 Patient Administration Messages.
Pharmacy
This is the create/edit/view screen for HL7 Pharmacy services.
These are responsible for:
- submitting orders for Medication and Merchandise products to an external pharmacy, during invoicing
- generating Pharmacy Orders and Returns when the pharmacy dispenses products.
The fields are as follows:
| Id | the Pharmacy identifier |
| Name | the Pharmacy name |
| Description | the Pharmacy description |
| Active | uncheck this box to deactivate the Pharmacy. Deactivating the Pharmacy prevents orders being placed and dispense messages received. |
| Order Connector | the connector used to submit orders to the Pharmacy. |
| Dispense Connector | the connector used to receive dispense messages from the Pharmacy. |
| Location | specifies the Practice Location that this Pharmacy is used for. |
| User | specifies the user that Customer Orders and Returns will be created with. |
HL7 Messages
For the messages supported by a Pharmacy see:
Pharmacy Group
A Pharmacy Group is used to group multiple HL7 Pharmacy services in multi-location practices. A Medication or Merchandise product uses the Pharmacy Group.
When invoicing a product linked to a Pharmacy Group, the current practice location determines which Pharmacy is selected to order the product.
