PHC-Hub logo  PHC-Hub 4.17.3 Administrator User Guide

IWeb HL7 Crosswalk

The HL7 Crosswalk details the mapping of HL7 messages and IWeb fields.

2.3.1 Crosswalk

Demographics

Field Name Corresponding HL7 Field Special Notes
First Name PID-5.2  
Middle Name PID-5.3  
Last Name PID-5.1  
Suffix PID-5.4  
Birth Date PID-7  
Birth File # PID-3.1* The value of HL7 field PID-3.5 determines which IWeb field is populated from PID-3.1.
Sex PID-8  
Mother Maiden Name PID-6  
Race Derived from PID-10 These IWeb fields are automatically mapped from their equivalent value in HL7.
Ethnicity Derived from PID-22 These IWeb fields are automatically mapped from their equivalent value in HL7.
Language PID-15.1  
SSN PID-3.1* The value of HL7 field PID-3.5 determines which IWeb field is populated from PID-3.1.
Medicaid # PID-3.1* The value of HL7 field PID-3.5 determines which IWeb field is populated from PID-3.1.
Multiple Birth (first drop-down) PID-25  
Inactive Derived from PID-29 This IWeb field is marked if the HL7 message includes a date and time of death.
VFC Status PV1-20 Included for backwards compatibility.
Block Recall Derived from PD1-11.1  
Address1 PID-11.1  
Address2 PID-11.2  
City PID-11.3  
State PID-11.4  
Postal Code PID-11.5  
Country Derived from PID-11.6  
County/Parish Derived from PID-11.5 The country code in IWeb is automatically mapped to its proper PHIN value set ("County") based on the patient's postal code as listed in the HL7 message.
Phone PID-13.1 Area code and phone number.
Email PID-13.4  
Guardian 1 First NK1-2.2+ These IWeb fields are only populated from HL7 when the value of NK1-3.1 is a guardian-type code (FTH, GRD, MTH, or PAR).
Guardian 1 Middle NK1-2.3+ These IWeb fields are only populated from HL7 when the value of NK1-3.1 is a guardian-type code (FTH, GRD, MTH, or PAR).
Guardian 1 Last NK1-2.1+ These IWeb fields are only populated from HL7 when the value of NK1-3.1 is a guardian-type code (FTH, GRD, MTH, or PAR).
Guardian 1 SSN NK1-33.1+ These IWeb fields are only populated from HL7 when the value of NK1-3.1 is a guardian-type code (FTH, GRD, MTH, or PAR).
Guardian Work Phone NK1-6.6 and NK1-6.7 Area code and phone number.
(Alias) First Name PID-9.2  
(Alias) Last Name PID-9.2  
NAIC Code IN1-2.1  
Physician PD1-4.1  
Facility PD1-3.3 Used if recognized.
Birth Facility PID-23  
Date of Death PID-29  
Birth Country PID-11.4♦ The IWeb fields are only populated from HL7 when the value of PID-11.7 is BDL.
Birth State PID-11.7♦ The IWeb fields are only populated from HL7 when the value of PID-11.7 is BDL.

+ These form fields are populated from the specified HL7 fields only when NK1-3.1 is one of the following codes: FTH, GRD, MTH, PAR.

♦ These form fields are populated from the specified HL7 fields only when PID-11.7 is valued as BDL (birth delivery location).

* These fields are populated from the PID-3.1 HL7 field based on the value of PID-3.5:

PID-3.5 Value Form field populated
BR Birth File #
MA Medicaid #
SS SSN

Vaccination

Field Name Corresponding HL7 Field Special Notes
Vaccine Derived from RXA 5.1 or RXA-5.4 This IWeb field is automatically mapped from its equivalent value in HL7, using either the CVX or CPT code in RXA-5.
Date Administered RXA-3  
Historical RXA-9.1  
Manufacturer RXA-17.1  
Lot Number RXA-15  
Vaccinator RXA-10.1  
Anatomical Site RXA-2.1  
Anatomical Route RXA-1.2  
Volume (CC) RXA-6  
VFC Status OBX-5 Only when OBX-3.1 is valued as 64994-7.
Ordering Provider ORC-12  
Comments NTE-3  

Contraindication

Field Name Corresponding HL7 Field Special Notes
Facility where documented RXA-11 (if recognized) This IWeb field only populates from the HL7 message if the Facility ID listed in RXA-11 is recognized by the system.
Date Documented OBX-14  
Vaccine OBX-5 For contraindications, the type of vaccine, contraindication description, and permanent status are all determined by a single HL7 contraindication concept code which is sent in OBX-5.
Contraindication OBX-5 For contraindications, the type of vaccine, contraindication description, and permanent status are all determined by a single HL7 contraindication concept code which is sent in OBX-5.
Permanent OBX-5  

2.5.1 Crosswalk

Demographics

Field Name Corresponding HL7 Field Special Notes
First Name PID-5.2  
Middle Name PID-5.3  
Last Name PID-5.1  
Suffix PID-5.4  
Birth Date PID-7  
Birth File # PID-3.1* The value of HL7 field PID-3.5 determines which IWeb field is populated from PID-3.1.
Sex PID-8  
Mother Maiden Name PID-6  
Race Derived from PID-22 These IWeb fields are automatically mapped from their equivalent value in HL7.
Ethnicity Derived from PID-22 These IWeb fields are automatically mapped from their equivalent value in HL7.
Language PID-15.1  
SSN PID-3.1* The value of HL7 field PID-3.5 determines which IWeb field is populated from PID-3.1.
Medicaid # PID-3.1* The value of HL7 field PID-3.5 determines which IWeb field is populated from PID-3.1.
Multiple Birth (first drop-down) PID-25  
Inactive Derived from PID-29 This IWeb field is marked if the HL7 message includes a date and time of death.
VFC Status PV1-20 Included for backwards compatibility.
Block Recall Derived from PD1-11.1  
Address1 PID-11.1  
Address2 PID-11.2  
City PID-11.3  
State PID-11.4  
Postal Code PID-11.5  
Country Derived from PID-11.6  
County/Parish Derived from PID-11.5 The country code in IWeb is automatically mapped to its proper PHIN value set ("County") based on the patient's postal code as listed in the HL7 message.
Phone PID-13.6 and PID-13.7 Area code and phone number.
Email PID-13.4  
Guardian 1 First NK1-2.2+ These IWeb fields are only populated from HL7 when the value of NK1-3.1 is a guardian-type code (FTH, GRD, MTH, or PAR).
Guardian 1 Middle NK1-2.3+ These IWeb fields are only populated from HL7 when the value of NK1-3.1 is a guardian-type code (FTH, GRD, MTH, or PAR).
Guardian 1 Last NK1-2.1+ These IWeb fields are only populated from HL7 when the value of NK1-3.1 is a guardian-type code (FTH, GRD, MTH, or PAR).
Guardian 1 SSN NK1-33.1+ These IWeb fields are only populated from HL7 when the value of NK1-3.1 is a guardian-type code (FTH, GRD, MTH, or PAR).
Guardian Work Phone NK1-6.6 and NK1-6.7 Area code and phone number.
(Alias) First Name PID-9.2  
(Alias) Last Name PID-9.1  
NAIC Code IN1-2.1  
Physician PD1-4.1  
Facility PD1-3.3 Used if recognized.
Birth Facility PID-23  
Date of Death PID-29  
Birth Country PID-11.4♦ The IWeb fields are only populated from HL7 when the value of PID-11.7 is BDL.
Birth State PID-11.7♦ The IWeb fields are only populated from HL7 when the value of PID-11.7 is BDL.

* These fields are populated from the PID-3.1 HL7 field based on the value of PID-3.5.

+ These form fields are populated from the specified HL7 fields only when NK1-3.1 is one of the following codes: FTH, GRD, MTH, PAR

♦ These form fields are populated from the specified HL7 fields only when PID-11.7 is valued as BDL (birth delivery location).

Vaccination

Field Name Corresponding HL7 Field Special Notes
Vaccine Derived from RXA 5.1 or RXA-5.4 This IWeb field is automatically mapped from its equivalent value in HL7, using either the CVX or CPT code in RXA-5.
Date Administered RXA-3  
Historical RXA-9.1  
Manufacturer RXA-17.1  
Lot Number RXA-15  
Vaccinator RXA-10.1  
Anatomical Site RXA-2.1  
Anatomical Route RXA-1.2  
Volume (CC) RXA-6  
VFC Status OBX-5 Only when OBX-3.1 is valued as 64994-7.
Ordering Provider ORC-12  

Contraindication

Field Name Corresponding HL7 Field Special Notes
Facility where documented RXA-11 (if recognized) This IWeb field only populates from the HL7 message if the Facility ID listed in RXA-11 is recognized by the system.
Date Documented OBX-14  
Vaccine Derived from RXA-5.1 or RXA-5.4 For contraindications, the type of vaccine, contraindication description, and permanent status are all determined by a single HL7 contraindication concept code which is sent in OBX-5.
Contraindication OBX-5 For contraindications, the type of vaccine, contraindication description, and permanent status are all determined by a single HL7 contraindication concept code which is sent in OBX-5.