This article describes the specifications for the expectations for the custom Z-segments included within the HL7 ORU file. There is assumed knowledge about HL7 interfaces & connectivity, the purpose of this document is to provide specifications for the Z4A - Facility & Z4D - Provider segments.
Unlike the common segment used for this value (PV1 or PV2), these custom segments are specific to the intended recipient within the practice receiving the Health Exchange document.
Specification
Z4A Facility / Place of Service
The facility in which the services were performed is listed within this segment. This segment may repeat to indicate multiple POSs. The system will store each facility described in the Z4A segments. These segments should be located just before the last segments for Z4D.
//Sample
Z4A|GSMH|Grey, Meridith E||Grey-Sloan Memorial Hospital~123 W. Anywhere Street~Seattle, WA 98101|
//Spec
Z4A|FacilityID|POSProviderLast, POSProviderFirst POSMiddle||FacilityName~Address1+2~City, ST Zip|
Z4D Provider / Recipient
The custom provider segments are expected at the very end of the Hl7 file, each segment will be accepted and processed into the client database using the externally defined Health Exchange Provider ID (HEProviderID). Multiple providers within the client database may be the recipient of a document. Each provider will need to be listed in their own Z4D segment.
//Sample
Z4D|1|111^Grey^Meridith^E^^^^INHIE|Grey, Meridith E|
//Spec
Z4D|SegmentCounter|HEProviderID^HEPLast^HEPFirst^HEPMiddle^^^^HEVendor|HEPLast, HEPFirst, HEPMiddle|
| Specification Description | Z-Seg Location(s) | Expected Data | Data Type |
|---|---|---|---|
| FacilityID | Z4A-1 | External Facility ID | any |
| POSProviderLast | Z4A.2.1 | Performing Provider Last Name | string |
| POSProviderFirst | Z4A.2.2 | Performing Provider First Name | string |
| POSProviderMiddle | Z4A.2.3 | Performing Provider Middle Name | string |
| FacilityName | Z4A.4.1(1) + ~ | Service Location Name | any |
| Address1+2 | Z4A.4.1(2) + ~ | Service Location Address 1 & 2 | any |
| City, ST Zip | Z4A.4.1(3) | Service Location City, ST, Zip | {string}, {string} {integer} |
Z4A.4.1 Service Location Address = Name~Address~City,ST Zip | |||
| HEProviderID | Z4D.2.1 | External Health Exchange Provider ID | integer |
| HEPLast | Z4D.2.2 | Health Exchange Provider Last Name | string |
| HEPFirst | Z4D.2.3 | Health Exchange Provider First Name | string |
| HEPMiddle | Z4D.2.4 | Health Exchange Provider Middle Name | string |
| HEVendor | Z4D.2.8 | External Health Exchange Vendor ID | any |
MSH.3 Segment / Header
//Sample MSH|^~\&|Epic^LAB_MICRO^Report| //Spec MSH|^~\&|SendingFacility^DocumentTypeShortDescription^DocumentSubTypeShortDescription|
| Specification Description | MSH Location(s) | Expected Data | Data Type |
|---|---|---|---|
| SendingFacility | MSH.3.1 | Sending Facility Name | string |
| DocumentTypeShortDescription | MSH.3.2 | string | |
| DocumentSubTypeShortDescription | MSH.3.3 | See Article | string |
OBR.4 Segment (ONLY IN CASES WHERE MSH.3.3 IS 'DISCRETE')
In the case where MSH3.3 is 'Discrete,' the specifications below will need to be placed in the OBR.4 segment. The ShortDescription (OBR.4.1) will be processed and display the LongDescription (OBR.4.2) in OfficeEMR.
//Sample OBR||||PR^Procedure Report| //Spec OBR||||ShortDescription^LongDescription|
| Specification Description | OBR Location(s) | Expected Data | Data Type |
|---|---|---|---|
| ShortDescription | OBR.4.1 | See Article | string |
| LongDescription | OBR.4.2 | See Article | string |
