IWeb logo  IWeb 5.17.5 User Guide

Remote Registry

The Remote Registry feature allows authorized users to query other immunization registries for existing vaccination records for an existing patient.

NOTE: This feature is not available for Facility Client or Facility View users.  

The state-to-state user agreement system depends on both states (the home-state and the out-of-state) that are using the IWeb registry or a registry with similar capabilities. The home-state is the registry that requests access to a patient record in another state; the out-of-state is the registry providing access to a requesting provider/user.

The home-state registry administrator obtains a login account and the out-of-state agreement from the out-of-state's registry administrator. The home-state registry administrator then enters this information into the home-state registry. The home-state system (IWeb, for example), is then responsible for assuring that only logged-in users who have agreed to the out-of-state registry's user agreement are allowed to query the out-of-stage registry.

The out-of-state registry cannot block a specific user from querying the out-of-state registry. However, every query is logged in the out-of-state registry with the home-state registry username. In cases of misuse, out-of-state registry users may contact the home-state registry staff and request that a specific user be denied query access. In extreme cases, the out-of-state registry staff can disable the entire home-state registry account.

Before the Remote Registry feature can be used, a patient search must be conducted and the patient information either selected or added.

Create a New Connection

Perform a patient search on the patient whose records you want to match and merge vaccination records. Click Patient > Remote Registry from the menu. One of two pages open:

On the Remote Registry Connections page, select the remote connection from the drop-down list. If no connections appear in the list, click New to create a new one. The Remote Registry Connections page opens. Enter the information for at least the required fields (in red text) and click Save. The fields and their descriptions are as follows:

Field Description

Title

Enter the name of the new remote registry connection.

Application Type

Select the type of application for which this account is associated from the drop-down list. This setting changes the format of messages sent and how the messages are interpreted when received by this account. Examples:

  • CDC Standard - Messages only include fields explicitly defined by CDC standard documentation. For non-IWeb applications, select this type.

  • McKesson DFT - Messages are formatted to the newer standard.

  • MISYS DFT - Messages are formatted to the older standard.

  • QS-Insight - The same as the CDC Standard.

  • STC-IWeb - Includes support for IWeb-specific fields and data.

  • STC-CDR

NOTE: Typical, STC-IWeb should be selected. This accepts messages following the CDC standard, but also allows for custom features and variations in the implementation.

Organization (IRMS)

Unless you have a specific reason to do so, do not select an Organization (IRMS). It is used to indicate which Organization (IRMS) in this IWeb application represents the remote registry.

Updating User

Unless you have a specific reason for doing so, do not select an updating user. It is used to indicate which user the remote registry uses to send updates to.

Application ID

Enter the unique application ID of the remote system. This, in combination with the Facility ID, must be unique within this IWeb instance. The application ID is found in the MSH header.

Facility ID

Enter the unique Facility ID of the remote system. This, in combination with the application ID, must be unique within this IWeb instance. The Facility ID is found in the MSH header.

Transport Type

Select the transport type from the drop-down list. The selected transport type determines which fields require values.

HTTPS URL

Enter the HTTPS URL, which is the URL of the other system as supplied by the remote administrator. Click the Test button to open a new window and display the connection test results. If the URL is from an IWeb system, the HL7 real-time interface is displayed.

User ID

Enter the user ID as supplied by the remote registry administrator.

Password

Enter the password as supplied by the remote registry administrator.

PHIN-MS ROUTE INFO

When the transaction type is PHIN-MS, this field is required. Enter the Public Health Information System (PHIN-MS) route information for the receiver. Example: https://phinmsstg.cdc.gov/phinms/receivefile. Consult the PHIN-MS documentation to determine the value for this field.

PHIN-MS SERVICE

When the transaction type is PHIN-MS, this field is required. Enter the Public Health Information System (PHIN-MS) service information for the receiver. The service and action determine the message type. Example: Defaultservice.

PHIN-MS ACTION

When the transaction type is PHIN-MS, this field is required. Enter the Public Health Information System (PHIN-MS) action information for the receiver. The service and action determine the message type. Example: Defaultaction.

HL7 Version

Select the HL7 version from the drop-down list.

Outgoing Query Type

Select the outgoing query type:

  • VXQ - Query for vaccination records, which includes patient demographic data, used by a registry to query another registry for a patient's vaccination record.

  • QBP - Query by Parameter (QBP) to request immunization history to another system.

The HL7 version must be 2.5.1 when using QBP; VXQ cannot be used with version 2.5.1.

Remote ID Type

Enter the remote ID type, which designates the remote system's ID for a patient. This is normally SR.

Local ID Type

Enter the local ID type, which is used to designate the registry's ID for a patient. When querying, IWeb acts as a non-registry and designates its IDs as medical record numbers (MRs) and expects the connecting system to designate its ID as the state registry ID (SR).

Send Vaccination Deletes

Some systems do not recognize vaccination deletes, but instead treat them as vaccinations updates/adds. Only select this option if you are sure that the receiving system understands vaccination deletes. IWeb understands vaccination deletes.

Visible

Select this option to make this connection visible to all users.

Enabled

Select this option to make this connection usable. Regular users can only see and use a connection when both the Visible and Enabled options are selected. Administrators can see and use a connection even when it is not visible to other users.

Sending Application (MSH-3)

Enter the ID for the software application that is sending the message. The sending application is expected in the MSH-3.2, but if blank, it is read from MSH-3. For IWeb applications, the sending application is IWeb.

  • Namespace (Comp. 1)

  • Universal ID (Comp. 2)

  • Universal ID (Comp. 3)

Sending Facility (MSH-4)

Enter the sending facility ID, which is the facility that is sending the data. IWeb reads this from MSH-4.2, but if empty, it reads it from MSH-4. For IWeb applications, the sending facility is the name of the registry (i.e., CHIRP). The sending facility is logged as the "user" in the HL7 import logs.

  • Namespace (Comp. 1)

  • Universal ID (Comp. 2)

  • Universal ID (Comp. 3)

Receiving Application (MSH-5)

Optionally enter the name or ID of the application that the message has been constructed for and should be sent to. IWeb assumes that this is a value determined by the application vendor and is similar across the same application. The name or ID is used for routing the message to its appropriate end-point, but in point-to-point environments, it may only be used for logging.

IWeb reads the application name from the Universal ID if sent, or from the Namespace ID.

This field is important when routing messages, but IWeb does not route messages. IWeb is a final destination for messages, so it accepts any message without regard to the receiving application indicated on the message.

Receiving Facility (MSH-6)

Optionally enter the name of the application that the message is being sent to. This field is important when routing messages, but IWeb does not route messages. IWeb is a final destination for messages, so it accepts any message without regard to the receiving facility indicated on the message.

Query the Registry

To query the registry, select the Show HL7 option on the Remote Registry Connections page and click Query. The matching process begins.

If an exact match is found, no vaccination records appear.

If similar matches are found, the records appear on the Remote Registry Connections page. Review and compare the records, trying to locate the record that best matches the patient. Once the best record is located, click the Get Vaccination Record (#1) button to view all of the vaccinations. The patient's vaccination information appears. In the Vaccinations section, any vaccines that are not selected will not be merged, while vaccinations that are selected will be merged. Click Merge Vaccinations to merge the selected vaccinations and display the patient's Vaccination View/Add window.