PHC Hub User Guide (v. March 2018)

Create or Edit an Import Profile

You must create one or more import profiles to import data to PHC Hub. Import profiles can be exported as XML files. This allows the settings to be saved externally and then transferred to a new system. For example, when moving an interface from test to production.

Create a New Import Profile

To create a new import profile, click the Import Profiles > Create New Profile menu link. The New Import Profile page opens. Enter information in the fields and click Create. The available fields on this page are as follows:

Next, set the profile settings. The available profile setting fields are as follows:

After configuring the above settings, use the Update Settings section to define General, Patient, and Vaccination settings, then click Save.

Next steps include:

• Use the Issue Resolution section to define how to handle issues
• Use the HL7 General Settings section to define HL7 messages
• Use the HL7 Observation Settings section to define ORU information
• Use the Query Settings section to define how to structure queries

Edit an Import Profile

To edit an existing import profile, click the Import Profiles > Select Import Profile menu link. Locate and click on the import profile in the list on the Available Profiles pop-up window that opens. On the Import Profile page that opens, verify the name of the import profile at the top of the page, then click Edit. Make the necessary changes and click Save. (See the section above for information about the fields and options available on the page.)

Export Profile as XML

To export a profile in an XML file, first click the Import Profiles > Select Import Profile menu link, locate the import profile in the list on the Available Profiles pop-up window, and select it. On the Import Profile page that opens, verify the name of the import profile at the top of the page, then click the Export Profile as XML button. The XML file automatically downloads.

Return Responses

The return responses value determines if an acknowledgement (ACK) is returned from the HL7 message. For example:

• If the field value is Always, an ACK is always sent
• If the field value is Never, an ACK is never sent
• If the field value is Only on errors, an ACK is only sent if it is a negative ACK, meaning an ACK reporting an error.
• If the field value is Defined by message, the value in MSH-16 for each submitted message is used to determine if an ACK is required. The expected values in MSH-16 are:
  • If MSH-16 is AL, an ACK is always sent
  • If MSH-16 is NE, an ACK is never sent
  • If MSH-16 is ER, an ACK is only sent if it is a negative ACK
  • If MSH-16 is blank, it defaults to AL, and an ACK is always sent

Possible RSP Messages

A response to a QBP query returns one of three types of response profiles:

1. A patient's immunization history
   • Z32 Exactly one high confidence match found
2. A list of patients
   • Z31 At least one lower confidence match is found
3. A response that describes issues with the submitted query:
   • Z33 No match found
   • Z33 More than the maximum number allowed is found
   • Z33 Message is not well formed and has fatal errors

HL7 2.5.1 calls for each of the response profiles to have separate implementations of the message segments. PHC Hub returns the same segment specifications regardless of the response profiles.

Z31 Responses

A query that does not result in a unique identification, but found potential candidate patients, returns a Z31 response. The goal of this response is to return a complete list of candidate patients in response to a request for a person's record. The initiator of the original QBP message can then review the returned patient list and inform/support a re-re-query by the initiator, based on selection of a member of the list.

An example response of this type is as follows:

MSH MSA [ERR] QAK QPD [{PID[PD1][{NK1}]}]

Z32 Responses

A response that unique identifies one candidate is a Z32 response. The goal of this response is to return a complete immunization history in response to a request for a person's record. This supports transferring a person's immunization records from one information system to another. The response is very similar to a VXU message in content.

An example response of this type is as follows:

MSH MSA [ERR] QAK QPD {PID[PD1][{NK1}][PV1][IN1][{[ORC]RXA[RXR][{OBX[{NTE}]}]}]}

Z33 Responses

The goal of this profile is to return an acknowledgement message. It indicates that either:

• The message could be parsed, but there was an error processing the message
• No candidates were found. No demographic or immunization history is returned

Z33 - No Patient Found

A query that results in no matches found returns a Z33 ACK. An example response of this type is as follows:

MSH MSA [ERR] QAK QPD

Note that MSA-3 could potentially return No patients found in local and remote registry if the local registry and any other remote registries currently configured have no patient records in them.

Z33 - Too Many Patients Found

A query that results in too many candidates returns a Z33 ACK. An example response of this type is as follows:

MSH MSA [ERR] QAK QPD

The system considers too many candidates to be The value in RCP-2, the maximum allowable results as defined in the Import Profile, or 20, whichever is lowest.

Z33 - Error

A query that results in an error returns a Z33 ACK. This ACK details the issue that occurred with a human-readable response to assist with correcting the query. Responses can be from HL7-specific errors, application level errors, user-configured options, and registry-specific errors. An example of this type of response is as follows:

MSH MSA [ERR] QAK QPD

Related topics:

• Create or Edit an Export Profile
• Assign an Import Profile to a User
• Upload a Batch File