HDR Version 7 HL7 Version 3 Messaging Conformance Specification

Appendix C: HTB Version 5 Compatibility

HTB Version 5  included HL7 V3 messaging artifacts covering several domains, inbound and outbound message processing services, and conformance documentation describing the messaging artifacts.
HDR Version 7  carries forward version 4 and version 5 artifacts for some domains (set 1 in figure) and introduces newer versions of the artifacts from version 4 and 5 for the remaining domains (set 2 in figure). These changes are done to be in close alignment with HL7. This release also introduces a new message domain that was not addressed in version 5. (set 3 in figure)

Distribution of domains between HTB Version 4, Version5 and HDR Version 7.

Though the structure of the artifacts in set 1 in the above figure are retained as is from Version 4 & 5, they have been upgraded using the RIM repository 2.14.1.01. The schemas for artifacts are generated using the HL7 Schema generator 3.04. So the structure of the artifacts in schema are a lot different from what they looked like in version 5.

It is recommended that customers  use HDR Version 7 artifacts for the all the domains listed in set 1 and 2 of the figure.  This is not an absolute requirement since version 6 messaging services are capable of processing all version 4 and 5 artifacts. However, the architecture of the HDR repository and message processing services has undergone considerable change since the version 5 release. As a result of this change, there are differences in the way version 4 & 5 message instances are validated and processed in this release, compared to version 5.

In addition, a few of the version 4 and 5 artifacts that have been brought forward in this release have undergone few structural changes to correct errors and accommodate new HDR features and to be more in alignment with the HL7 standards. The purpose of this section is to describe these differences and the impact of an upgrade on systems that have implemented HL7 V3 messaging on version 5.

Differences in Processing

Changes in Data types

Few attributes in version 5 message types used datatypes that were different from what was being supported in version 6. The cases are listed below:

Participation.signatureCode

The datatype supported for Participation.signatureCode is CE. However, the message type contains CS datatype for this attribute. The attribute is also tied to the concept list CL_PRTCPN_SIGNATURE_CODE. To process this attribute, users must ensure that the concept that is used for this attribute is present in the above concept list. In case it is not present, the concept must be added to the concept list before using it in the version 5 message instance.

PatientEncounter.admissionReferralSourceCode

This attribute is used in Encounter event message types and is tied to the concept list CL_ENC_ADMISSION_REFERRAL_SOURCE_CODE. This concept list is currently empty as HL7 has not included any concepts in this domain. Users must ensure that the concept that is used for this attribute is present in the above concept list. In case it is not present, the concept must be added to the concept list before using it in the version 5 message instance.

Top