PHC-Hub 4.17.3 Administrator
User Guide
|
|
|
Follow the steps below to configure ONC HUB connectivity:
A KeyStore and a TrustStore for TLS client authentication are required before configuring the remote registry. However, STC cannot create these files since they contain a secret identity key that should never leave their servers.
Use the following reference to assist in creating the KeyStore and TrustStore: https://docs.oracle.com/cd/E19509-01/820-3503/ggfgo/index.html
States must also contact the Hub technical resources so that the Hub starts trusting their new identity key. The current contacts are:
In IWeb, create a new organization to allow partners to send updates to and query the system (Organization (IRMS) > Search/Add > Search > Add) with the following settings:
| Field | Setting |
| Name | Enter a name that identifies the state/trading partner. STC recommends you use: ONCHUB-StateName. This naming convention groups your interstate exchange in your organization list. |
| Automatic ownership blocked | Select this option to prevent updates from this organization from taking ownership of patients from the primary care provider's organization/facility. |
| Require Manual Deduplication for Intra-Organization (IRMS) Merges | Clear this option to allow other states to send messages to the registry without being forced into manual deduplication. |
You must create the following users:
In IWeb, create the users (Administration > Search/Add User > Search > Add) with the following settings:
| Field | Setting |
| Name | Name one user after the trading partner. Name the second user after yourself. For example, ONCHUB-Statename. |
| Access Level | Set to No Login. |
| Organization (IRMS) | Set to the organization you created in the previous section. |
| Permissions | Select Upload HL7 Access. |
In IWeb, create a new remote registry (Patient > Remote Registry) with the following settings:
| Field | Setting |
| Title | Enter a name that identifies the state. For example, ONC-Statename. |
| Application Type | Select CDC Standard. |
| Updating User | Select the user you created in the previous step that is named after yourself. |
| Transport Type | Select ONC Hub. |
| WSDL URL | Enter the URL provided by the ONC HUB. |
| User ID | Enter the ID the state/trading partner wants you to use. |
| Password | Enter the password that the state/trading partner wants you to use. |
| Keystore Filepath | Enter the location of keystore.jks on the production app server. |
| Keystore Password | Enter the password for keystore.jks. |
| Truststore Filepath | Enter the location of truststore.jks on the production app server. |
| Truststore password | Enter the password for truststore.jks. |
| Destination | Enter the destination code the Hub wants you to use to send messages to the state/trading partner. |
| Partner State code | Enter the 2-digit code used to internally designate the partner state/trading partner. |
| HL7 Version | Select 2.5.1. |
| Outgoing Query Type | Select XVQ. |
| Visible | Select this option. |
| Enabled | Select this option. |
In IWeb, configure the HL7 settings (Settings > HL7 Uploads) for this exchange with the following values. These accounts are the authorized accounts for sending and receiving messages to the ONC HUB.
| Section | Field | Setting |
| Update settings | Deduplicate | Select Immediately. |
| Update settings | Update Current Patients | Select this option. |
| Update settings | Insert patient as historical (non-owned) | Select this option. |
| Update settings | Insert vaccination as historical | Select this option. |
| Update settings | Update registry inventory | Do not select this option. |
| Update settings | Insert if sent (Primary facility, Administered-at location, Primary physicians, Vaccinators) | Do not select any of the insert options. |
| Query Settings (VXQ Only) | Return all normally private demographic fields from the master patient record | Select this option. |
| Record Export Options for Queries and Updates | Send vaccinations as historical | Select this option. |
Add an import profile to be used by PHC-Hub to facilitate the transfer.
| NOTE: If the user creates more than one profile (NOT RECOMMENDED), they need to use User Link to disable all but the profile they want to use. |
Log in to PHC-Hub under the Exchange Partner Organization (IRMS) you created for the ONC Hub and create the profile with the following settings:
| Section | Field | Setting |
| Edit Import Profile | Name | Enter a name that describes the State/Trading Partner. |
| Edit Import Profile | Enabled | Select this option. |
| Edit Import Profile | HL7 Version | Select 2.5.1. |
| Update Settings > General | Import Data | Select Patient and Vaccine. |
| Update Settings > General | Deduplicate After Import | Select this option. |
| Update Settings > Vaccinations | Force Vaccinations Historical | Select this option. |
| Update Settings > Vaccinations | Update Registry Inventory | Select this option. |
| Update Settings > Patient | Update Current Patients | Select this option. |
| Update Settings > Patient | Insert patient as historical (non-owned) | Select this option. |
| Query Settings | Return all normally private demographic fields from the master patient record | Select this option. |
| Query Settings | Exclude > Vaccinations with no CPT code, Vaccinations with no CVX code, Vaccinations last updated by the querying HL7 user's account, Vaccinations outside query range and not new patient | Do not select any of the Exclude options. |
| Issue Resolution | All | Set issue resolution options as appropriate for the account. |
In PHC-Hub, set Application Settings (Main > App Settings) for the Exchange Partner Organization (IRMS) for the ONC Hub with the following settings:
| Field | Setting |
| Registry Base URL | Enter the registry's base URL. |
| PHC-Hub External Base URL | Enter PHC-Hub's external base URL. |