[Deprecated] Patient Manager - User Manual
Warning: This documentation is out-dated, newest version of the documentation is available at https://gazelle.ihe.net/gazelle-documentation
Click here to access the Patient Manager tool
- Introduction
- What is this simulator able to do?
- How to add your system as a receiver
- How to do HL7 validation
- How to create a patient & share it with the Order Manager tool
- Log in to get more features
Introduction
The Patient Manager tool is developed in conformance with the IHE Technical Framework. This tool is also conformant with the French national extension for the PAM profile. This simulator is expected to act as an initiator or as a responder depending on the emulated actors.
As an initiator, this simulator is aimed to send messages to a responder. Consequently, if your system (named SUT or System Under Test) is ready to listen to an HL7 initiator and reachable from the Internet, you will be able to receive messages from the simulator.
The table below gathers the supported transactions and SUT actors.
Simulated actor | Transaction | Option | Affinity Domain | System Under Test |
---|---|---|---|---|
Patient Demographic Supplier |
ITI-30 |
Merge |
IHE |
Patient Demographic Consumer |
Patient Demographic Supplier |
ITI-30 |
Link/Unlink |
IHE |
Patient Demographic Consumer |
Patient Demographic Supplier |
ITI-47 |
Continuation Pointer Pediatric demographics |
IHE |
Patient Demographic Consumer |
Patient Demographic Consumer |
ITI-30 |
Merge |
IHE |
Patient Demographic Supplier |
Patient Demographic Consumer |
ITI-30 |
Link/Unlink |
IHE |
Patient Demographic Supplier |
Patient Demographic Consumer | ITI-21 | Pediatric demographics | IHE | Patient Demographic Supplier |
Patient Demographic Consumer | ITI-22 | Pediatric demographics | IHE | Patient Demographic Supplier |
Patient Demographic Consumer | ITI-47 | Continuation pointer Pediatric demographics |
IHE | Patient Demographic Supplier |
Patient Encounter Supplier |
ITI-31 |
Basic subset |
IHE |
Patient Encounter Consumer |
Patient Encounter Consumer |
ITI-31 |
Basic subset |
IHE |
Patient Encounter Supplier |
Patient Encounter Supplier | ITI-31 | Inpatient/Outpatient encounter management | IHE | Patient Encounter Consumer |
Patient Encounter Consumer | ITI-31 | Inpatient/Outpatient encounter management | IHE | Patient Encounter Supplier |
Patient Encounter Consumer | ITI-31 FR | All | IHE-FR | Patient Encounter Supplier |
Patient Identity Source | ITI-30 / ITI-8 / ITI-44 | IHE | Patient Identifier Cross-reference manager | |
Patient Identity Cross-Reference Consumer | ITI-10 / ITI-9 / ITI-46 / ITI-45 | PIX Update Notification | IHE | Patient Identifier Cross-reference manager |
Patient Identity Cross-Reference Manager | ITI-8 / ITI-30 /ITI-44 | IHE | Patient Identity Source | |
Patient Identifier Cross-Reference Manager | ITI-10 / ITI-9 / ITI-46 / ITI-45 | IHE | Patient Identitfier Cross-Reference Consumer | |
ADT | RAD-1 / RAD-12 | IHE | ADT Client (MPI, OF/DSS, OP ...) |
What is this simulator able to do?
This simulator has been developed with the purpose of helping developers of IHE systems to test their systems with another IHE compliant system for pre-Connectathon testing or during off-connectathon periods. We try to manage most of the cases, that means that, step by step, we planned to offer you all the events defined in the Technical Framework. We also plan to implement national extensions if requested by the different organizations.
For more details regarding an actor in particular, follow one of the links below:
- PAM Patient Demographic Supplier
- PAM Patient Demographic Consumer
- PAM Patient Encounter Supplier
- PAM Patient Encounter Consumer
- PDQ Patient Demographic Consumer
- PDQ Patient Demographic Supplier
- PIX Patient Identity Source
- PIX Patient Identifier Consumer
- PIX Patient Identifier Cross-Reference Manager
- PDQv3 Patient Demographic Consumer
- PDQv3 Patient Demographic Supplier
- SWF ADT
- PIXV3 Patient Identity Source
- PIXV3 Patient Identifier Cross-Reference Manager
- PIXV3 Patient Identifier Cross-Reference Consumer
- PAM Automation
How to add your system as a receiver
The Patient Manager has been designed to send HL7V2/HL7V3 messages to your system under test (eg if you are testing PAM/PDC, PIX Manager, Order Placer, Order Filler, or others).
In order to send messages to your system under test, the Patient Manager tool needs the configuration (IP address/listening port, endpoint, receiving facility/application and no on) of your receiving system. This configuration has to be stored in the database of the application, so that you can re-use this configuration without creating it each time you need to perform a test. The procedure is different depending on the version of HL7 your system is implementing.
In both cases, if you are logged in when creating the configuration, you will be set as the owner of the configuration. If you do not want other testers to send messages to your SUT you can uncheck the box "Do you want this configuration to be public?" and you will be the only one to be able to select your system in the drop-down list (if logged in !).
HL7V2 Systems Under Test
Go to "System Configurations-->HL7 Responders" and hit the "Create a Configuration" button. You can also copy or Edit an existing configuration.
In both cases, the simulator needs to know:
- A name for your configuration (displayed in the drop-down list menus)
- The actor played by your system under test
- The receiving facility/application
- The IP address
- The port the system is listening on
- The charset expected by your SUT
If you are logged in when creating the configuration, you will be set as the owner of the configuration. If you do not want other testers to send messages to your SUT you can uncheck the box "Do you want this configuration to be public?" and you will be the only one to be able to select your system in the drop-down list (if logged in !).
If your system implements several actors, you are expected to create a configuration for each of them.
HL7V3 Systems Under Test
Go to "System Configurations-->HL7V3 Responders" and hit the "Create a Configuration" button. You can also copy or Edit an existing configuration.
In both cases, the simulator needs to know:
- A name for your configuration
- The name of the tested system
- Its endpoint location
- Its device id root OID
- Its organization OID
- The list of transactions which are supported by your system
If the same endpoint is used by several actor, you only need to register your system once with the supported transaction correctly set.
How to do HL7 validation
The simulator communicates with our HL7 validator which performs validation of HL7V2.x messages (based on HL7 message profiles developed by the Gazelle team and the NIST) and validation of HL7V3 messages (model-based engine developed by Gazelle team). For each received and sent messages, you can ask the simulator to validate the messages. Below is the meaning of the different icons you can meet in the Test Report section of each page or under the HL7 messages menu (gathers all the messages received and sent by the simulator).
Open the pop-up containing the received and sent messages beside their validation results. The validation service is automatically called each time you hit this button. Consequently, the validation result you see is always the one matching the newest version of the message profile. |
|
The message has not been validated yet. Hitting this button leads to the same action as the previous icon (magnifying glass). |
|
The message has been successfully validated. Hitting this button leads to the same action as the previous ones. |
|
The message has been validated but the message contains errors. |
|
Open a pop-up containing the list of SUT which can received this message. Enables the user to send again a specific message. Be aware that the simulator can only be asked to replay a message sent by it (not received from another SUT) |
How to create a patient & share it with the Order Manager tool
Patients created within the Patient Manager can be sent to an external SUT. These patients can also be used with the Order Manager tool, so that a patient in the Patient Manager database can be used by the Order Manager to create HL7 orders and DICOM Modality Worlist.
Here's how:
- Create a new patient in the Patient Manager (eg in the "ADT" or "PAM-->Patient Demographics Supplier" menu)
- Then, select menu "All patients"
- Use the filters and column headings on that page to find your patient.
- In the "Action" column for that patient, select the icon to 'Create a worklist or order for an existing patient'. This button will launch the Order Manager application, and you can proceed to create an Order or Worklist.
Logging in to get more features
The login link ("cas login") is located in the top right corner of the page.
Note that, like the other applications from Gazelle testing platform, PatientManager is linked to our CAS service. That means that, if you have an account created in the European instance of Gazelle Test Management, you can use it, if you do not have one, you can create one now by filling the form here. Note that if you only have an account for the North Americal instance of Gazelle, it will not work with the PaatientManager; you will need to create a new account.
Once you are logged in, you are set as the "creator" of all the patients you create or modify and then (still logged in) you can choose to see only those patients. Another important feature is that you can decide to be the only one to be allowed to send messages to the SUT you have configure in the application (see next section).