integration:hl7_integration

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision		 Previous revision
integration:hl7_integration [2024/10/17 14:39] – [Which one?] Gary Willettsintegration:hl7_integration [2025/05/07 04:10] (current) – [Configuration] Gary Willetts
Line 1: Line 1:
 {{indexmenu_n>70}} {{indexmenu_n>70}}
-====== 23.08. HL7 and Tamanu integration ======+====== 23.08. HL7 and Tamanu/Patis Plus integration ======
 mSupply supports HL7 integration with HL7 compliant APIs. Currently, this is limited to retrieving information from HL7 Servers, mSupply does not send patient data. mSupply supports HL7 integration with HL7 compliant APIs. Currently, this is limited to retrieving information from HL7 Servers, mSupply does not send patient data.
  
 When using mSupply Synchronisation systems, this must be configured on the central server. Data retrieved from the integration is stored on the mSupply Central Server and distributed via sync to remote sites. Data is also available via [[dispensing:prescription_entry#selecting_the_patient|remote patient search]].  When using mSupply Synchronisation systems, this must be configured on the central server. Data retrieved from the integration is stored on the mSupply Central Server and distributed via sync to remote sites. Data is also available via [[dispensing:prescription_entry#selecting_the_patient|remote patient search]]. 
  
-[[https://www.beyondessential.com.au/products/tamanu/|Tamanu]] is the primary use case for this integration at the moment, and the only product we actively test the integration with. If you require integrating with other HL7 servers, please contact us!+[[https://www.beyondessential.com.au/products/tamanu/|Tamanu]] and Patis Plus are the primary use cases for this integration at the moment, and the only products we actively test the integration with. If you require integrating with other HL7 servers, please contact us!
  
 ===== Configuration ===== ===== Configuration =====
-Navigate to //Preferences > HL7 Integration//+Choose //File > Preferences// from the menus and click on the //HL7 Integration// tab on the left hand side. This window opens:
  
-{{ :integration:pasted:20230509-084035.png?650 |}}+{{ :integration:pasted:20250507-040023.png?650 }}
  
-To turn on HL7 configuration start by ticking the option "Use HL7 integration". Then select either "Use HL7 patient feed" or "Use HL7 patient search"; these are explained below.+To turn on HL7 configuration start by ticking the option **Use HL7 integration**. Then select either **Use HL7 patient feed** or **Use HL7 patient search**; these are explained below.
  
 Then enter: Then enter:
  
-  * URL: The URL of the HL7 compliant server you wish to connect to. +  * **URL**: The URL of the HL7 compliant server you wish to connect to. 
-  * Host name: The name of the service that you are integrating with. e.g. "Demoland Tamanu Server" +  * **Host name**: The name of the service that you are integrating with. e.g. "Demoland Tamanu Server" 
-  * Email: The username being used for the integration authentication. May be an email or any other text value. +  * **Email**: The username being used for the integration authentication. May be an email or any other text value. 
-  * Password: A strong password provided for integration authentication.+  * **Password**: A strong password provided for integration authentication. 
 +  * **Limit**: The maximum number of patient records to fetch for each API request. 
 +  * **Suffix path**: The extra part to add to the **URL** above to reach the endpoint for pulling patient information into mSupply. 
 +  * **Last updated**: Read only field showing when the last successful data pull was made. 
 +  * **Medication dispense**: Check this checkbox if you want to send dispensed data (i.e. prescriptions) to Patis Plus. 
 +  * **URL**: Enter the URL of the Patis Plus or other prescription consuming software here. 
 +  * **Send emails to this email address**: Enter the email address you want errors encountered when sending prescriptions sent to. 
 +  * **Start date**: the date to start sending prescriptions to the software in the **URL** field. 
 +  * **Manual push data** button: Click this to send the prescription informaiton immediately rather than waiting for the automatic scheduler to do it.
  
 All these should be provided by the organisation hosting the HL7 server that you wish to integrate with. All these should be provided by the organisation hosting the HL7 server that you wish to integrate with.
  
-**Press "Test connection" to validate the details you've entered and save them.**+Press the **Test connection** button to validate the details you've entered and save them.
  
 ==== Patient Feed ==== ==== Patient Feed ====
  
 This is the default and recommended option to use if available. The patient feed will regularly request all recent changes to patients and their related documents available on the HL7 Server. Supported records will seamlessly be integrated into the mSupply Central Server database. This is the default and recommended option to use if available. The patient feed will regularly request all recent changes to patients and their related documents available on the HL7 Server. Supported records will seamlessly be integrated into the mSupply Central Server database.
- 
 ==== Patient Search ==== ==== Patient Search ====
  
 The patient search option allows remote searches done from mSupply remote sites to additionally search the integrated HL7 server seamlessly, and return both mSupply and HL7 results in the mSupply user interface. The patient search option allows remote searches done from mSupply remote sites to additionally search the integrated HL7 server seamlessly, and return both mSupply and HL7 results in the mSupply user interface.
  
-==== Which one? ====+<WRAP info center round 90%> 
 +Note that if there is an error communicating with the HL7 server during the in the patient search or feed function then an email is automatically sent to mSupply support so that they are aware. 
 +</WRAP>
  
 +==== Which one? ====
 Patient feed is the recommended option as it solves multiple drawbacks of Patient search: Patient feed is the recommended option as it solves multiple drawbacks of Patient search:
  
   * Patient search is only available when using "remote patient search" on remote mSupply sites. This means it does not work on non-sync systems, and on sync systems the option does not serve any dispensaries that are active on the central server. As Patient feed gets all updates of all patients from the HL7 server and saves them in the mSupply database, they are available in all contexts.   * Patient search is only available when using "remote patient search" on remote mSupply sites. This means it does not work on non-sync systems, and on sync systems the option does not serve any dispensaries that are active on the central server. As Patient feed gets all updates of all patients from the HL7 server and saves them in the mSupply database, they are available in all contexts.
   * Patient search does not retrieve updates of patients from the HL7 server, only the state of the patient when first searched and added via the integration. Patient feed gets all future updates for all patients from the HL7 integration.   * Patient search does not retrieve updates of patients from the HL7 server, only the state of the patient when first searched and added via the integration. Patient feed gets all future updates for all patients from the HL7 integration.
 +
 +
 +==== Medication dispense ====
 +If this is turned on then all finalised prescriptions are sent every hour to the prescription consuming software at the address given in the **URL** field.
  
 \\ \\
  • Last modified: 2024/10/17 14:39
  • by Gary Willetts