HL7 Result Specifications
This document assumes the user has a working knowledge of HL7 standards. Below you will find the specifications for the Result HL7 file as it relates to OfficeEMR.
Segment | Field | Value | Notes |
---|---|---|---|
MSH | 2 | Sending Facility | |
MSH | 5 | Client Account ID | |
MSH | 6 | Header Date | |
MSH | 9 | Message Control ID | |
MSH | 10 | Processing ID | |
MSH | 12 | Version ID | 2.3 or 2.4 - Can not accept 2.5.1 |
OBR | 2 | Order Number | |
OBR | 4 | Order Info | OrderID^OrderDescription |
OBR | 7 | Collection Date | |
OBR | 13 | Specimen Collection | |
OBR | 14 | Specimen Date | |
OBR | 15 | Specimen Source | |
OBR | 16 | Ordering Provider | |
OBR | 21 | Order Site | |
OBR | 22 | Order Date | |
OBR | 25 | Order Status | |
OBX | 3 | Result Information | |
OBX | 5 | Result Value | |
OBX | 6 | Result UOM | |
OBX | 7 | Result Range | |
OBX | 8 | Result Flag | |
OBX | 11 | Result Status | |
OBX | 14 | Result Date | |
OBX | 15 | Lab Information | See Article |
ORC | 2 | Manifest ID | |
PID | 2 | Patient Internal ID | |
PID | 3 | Patient External ID | |
PID | 5 | Patient Name | |
PID | 7 | Patient Date of Birth | |
PID | 8 | Patient Gender | |
PID | 11 | Patient Address | |
PID | 13 | Patient Phone | |
PID | 19 | Patient SSN | |
PV1 | 3 | Service Location | |
PV1 | 7 | Service Provider | NPI^Last^First |
HL7 Result - Special Circumstances
Embedded URL
In the event that a URL needs to be provided in a result so that a user can be linked out to an external site, the below rules are applied.
- Links should be located in a NTE record
- We ALWAYS convert from http:// to https://
Example:
NTE|25|L|Executive summary. CHEST 2012; 141 (2) (Suppl): 7S-47S||||
NTE|26|L|Available at:||||
NTE|27|L|http://journal.publications.chestnet.org/data/Journals/CHEST/23443/1412S3.pdf|||| NTE|28|L|||||
Embedded PDF
In the event that a PDF needs to be provided in a result, the data should be sent in the following fashion:
- PDF should be located in an OBX record
- Segment type (OBX.2) should be ED
- Data should be base-64 encoded
Example:
OBX|3|ST|106^Ethyl Sulfate (ETS)||Detected|ng/mL|500 - 50000|A|||C|||20181002115354000||||||||||
OBX|4|ED|RPDF^Attachment||MTL^PDF^PDF^Base64^JVBERi0xLjQKJdP0zOEKMSAwIG9iago8PAovQ3JlY…..
HL7 Appointment Message Specifications
This document assumes the user has a working knowledge of HL7 standards. Below you will find the specifications for the SIU file as it relates to OfficeEMR.
If you need exports for any of the items such as locations, providers, appointment types, etc. Contact your Interface specialist and they can provide a file with the ID's and Descriptions. Otherwise, see the notes column for guidance on what to expect in the file.
Segment | Field | Value | Notes |
---|---|---|---|
MSH | 2 | Encoding Characters | Sent as ^~\& |
MSH | 3 | Sending Application | Sent as 'iSalus' |
MSH | 4 | Sending Facility | Database_Name (C####) |
MSH | 5 | Receiving Application | Interface Vendor Software Name and/or Company Name |
MSH | 6 | Receiving Facility | Interface Vendor Company Name |
MSH | 7 | Date/Time of Message | Format: YYYYMMDDHHMMSS |
MSH | 9.1 | Message Type | Format: SIU Subfield Delimiter: ^ |
MSH | 9.2 | Trigger Event | S12 = New Appointment Booking |
MSH | 10 | Message Control ID | GUID value |
MSH | 11 | Processing ID | P |
MSH | 12 | Version ID | 2.3 or 2.4 - Can not accept 2.5.1 |
SCH | 1 | Placer Appointment ID | iSalus Appointment ID |
SCH | 2 | Filler Appointment ID | iSalus Appointment ID |
SCH | 5.1 | Schedule ID | iSalus Resource ID |
SCH | 5.2 | Schedule Text | iSalus Resource Text |
SCH | 5.3 | Coding System | Sent as 'L' |
'SCH | 6.1 | Event Reason ID | iSalus Appointment Status ID |
SCH | 6.2 | Event Reason Text | iSalus Appointment Status Name |
SCH | 6.3 | Coding System | Sent as 'L' |
SCH | 7.2 | Appointment Reason Name | iSalus Chief Complaint |
SCH | 7.3 | Coding System | Sent as 'L' |
SCH | 8.1 | Appointment Type ID | iSalus Appointment ID |
SCH | 8.2 | Appointment Type Name | iSalus Appointment Description |
SCH | 8.3 | Coding System | Sent as 'L' |
SCH | 9 | Appointment Duration | Duration in minutes, integer |
SCH | 10.2 | Appointment Units | Always 'Min' |
SCH | 10.3 | Coding System | Sent as 'L' |
SCH | 11.4 | Start Date/Time | Format: YYYYMMDDHHMMSS |
SCH | 11.5 | End Date/Time | Format: YYYYMMDDHHMMSS |
SCH | 25.1 | Filler Status | iSalus Appointment Status Name |
PID | 1 | Set ID | Incrementer, always 1 |
PID | 2.1 | External Patient ID | Usually Set to iSalus Chart ID |
PID | 3.1 | Internal Patient ID | iSalus Chart ID |
PID | 4.1 | Alternate Patient ID | iSalus Chart ID (Ability to Use Old ID 1 2 or 3) |
PID | 5.1 | Family Name | Patient Last Name |
PID | 5.2 | Given Name | Patient First Name |
PID | 5.3 | Middle Name | Patient Middle Name |
PID | 7 | Date of Birth | Format: YYYYMMDD |
PID | 8 | Sex | Mapped Values |
PID | 9 | Alias | Patient Nick Name |
PID | 10 | Race | Mapped Values |
PID | 11.1 | Street Address | Address - Address 1 |
PID | 11.2 | Other Designation | Address - Address 2 |
PID | 11.3 | City | Address - City |
PID | 11.4 | State | State Code ie. IN, OH, NY |
PID | 11.5 | Zip | Patient Zip |
PID | 12 | Country | USA, CAN or Blank |
PID | 13 | Home Phone | Format: ########## |
PID | 14 | Work Phone | Format: ########## |
PID | 15 | Language | Mapping Table (Custom) |
PID | 16 | Marital Status | Mapping Values |
PID | 18 | Patient Account Number | iSalus Chart Number (Billing & EMR are the same) |
PID | 19 | SSN | Social Security Number |
PID | 29 | Death Date and Time | RHC Date, Format: YYYYMMDD |
PV1 | 1 | Set ID | Incrementer, always 1 |
PV1 | 3.1 | Point of Care | Appointment Location ID |
PV1 | 3.2 | Room | Appointment Location Name |
PV1 | 7.1 | Attending Doctor ID | Resource Provider - NPI |
PV1 | 7.2 | Attending Family Name | Resource Provider - Last Name |
PV1 | 7.3 | Attending Given Name | Resource Provider - First Name |
PV1 | 8.1 | Referring Doctor ID | Referring Doctor - NPI |
PV1 | 8.2 | Referring Family Name | Referring Doctor - Last Name |
PV1 | 8.3 | Referring Given Name | Referring Doctor - First Name |
PV1 | 19.1 | Visit Number ID | iSalus Appointment ID |
AIG | 1 | Set ID | Incrementer, Always 1 |
AIG | 3.1 | Resource ID | iSalus Resource ID |
AIG | 3.2 | Resource Name | Resource Name |
AIG | 3.3 | Coding System | Sent as 'L' |
AIL | 1 | Set ID | Incrementer, Always 1 |
AIL | 3.1 | Location ID | iSalus Location ID |
AIL | 3.2 | Location Name | Location Name |
AIL | 3.3 | Coding System | Sent as 'L' |
AIP | 1 | Set ID | Incrementer, Always 1 |
AIP | 3.1 | Provider ID | Resource Provider NPI |
AIP | 3.2 | Provider Family Name | Resource Provider Last Name |
AIP | 3.3 | Provider Given Name | Resource Provider First Name |
The default mapping for the 'Relationship' field for guarantors on the patient insurance setup is as follows. The HL7 value is what will be supplied in the HL7 file for any given interface. Please note - in some circumstances, the HL7 Value may be changed to accommodate unique interface needs.
iSalus Value | Description | HL7 Value |
---|---|---|
13 | Cadaver Donor | 13 |
03 | Child - Financial Resp. | 03 |
04 | Child - No Financial Resp. | 04 |
17 | Dep. of a Minor | 17 |
23 | Emancipated Minor | 23 |
08 | Employee | 08 |
22 | Father | 22 |
06 | Foster Child | 06 |
13 | Grandchild | 13 |
19 | Grandparent | 19 |
10 | Handicapped Dept. | 10 |
15 | Injured Plaintiff | 15 |
24 | Life Partner | 24 |
21 | Mother | 21 |
14 | Nephew or Niece | 14 |
11 | Organ Donor | 11 |
25 | Other Relationship | 25 |
18 | Parent | 18 |
01 | Self | 01 |
20 | Significant Other | 20 |
16 | Sponsored Dep. | 16 |
02 | Spouse | 02 |
05 | Step Child | 05 |
09 | Unknown | 09 |
07 | Ward | 07 |
The default mapping for the 'Relationship' field for Responsible Parties on the Patient setup screen s as follows. The HL7 value is what will be supplied in the HL7 file for any given interface. Please note - in some circumstances, the HL7 Value may be changed to accommodate unique interface needs.
iSalus Value | Description | HL7 Value |
---|---|---|
03 | Brother | 03 |
10 | Daughter | 10 |
02 | Father | 02 |
06 | Grandfather - Maternal | 06 |
08 | GrandFather - Paternal | 08 |
05 | Grandmother - Maternal | 05 |
07 | Grandmother - Paternal | 07 |
18 | Guardian | 18 |
16 | Husband | 16 |
01 | Mother | 01 |
13 | Other | 13 |
14 | Relative(s) | 14 |
11 | Self | 11 |
04 | Sister | 04 |
09 | Son | 09 |
17 | Spouse | 17 |
12 | Unspecified Blood Relative | 12 |
15 | Wife | 15 |
Language Mappings for PID-15
Below describes the mappings for the patient language. The HL7 will contain the numeric ID shown below for each language.
1 | Arabic |
2 | Bengali |
3 | English |
4 | French |
5 | German |
6 | Hindi |
7 | Japanese |
8 | Chinese |
9 | Portuguese |
10 | Russian |
11 | Spanish; Castilian |
12 | Tagalog |
13 | Italian |
14 | Other |
100 | Afar |
101 | Abkhazian |
102 | Afrikaans |
103 | Akan |
104 | Albanian |
105 | Amharic |
106 | Aragonese |
107 | Armenian |
108 | Assamese |
109 | Avaric |
110 | Avestan |
111 | Aymara |
112 | Azerbaijani |
113 | Bashkir |
114 | Bambara |
115 | Basque |
116 | Belarusian |
117 | Bihari languages |
118 | Bislama |
119 | Bosnian |
120 | Breton |
121 | Bulgarian |
122 | Burmese |
123 | Catalan; Valencian |
124 | Chamorro |
125 | Chechen |
126 | Church Slavic; Old Slavonic; Church Slavonic; Old Bulgarian; Old Church Slavonic |
127 | Chuvash |
128 | Cornish |
129 | Corsican |
130 | Cree |
131 | Czech |
132 | Danish |
133 | Divehi; Dhivehi; Maldivian |
134 | Dutch; Flemish |
135 | Dzongkha |
136 | Esperanto |
137 | Estonian |
138 | Ewe |
139 | Faroese |
140 | Fijian |
141 | Finnish |
142 | Western Frisian |
143 | Fulah |
144 | Georgian |
145 | Gaelic; Scottish Gaelic |
146 | Irish |
147 | Galician |
148 | Manx |
149 | Greek, Modern |
150 | Guarani |
151 | Gujarati |
152 | Haitian; Haitian Creole |
153 | Hausa |
154 | Hebrew |
155 | Herero |
156 | Hiri Motu |
157 | Croatian |
158 | Hungarian |
159 | Igbo |
160 | Icelandic |
161 | Ido |
162 | Sichuan Yi; Nuosu |
163 | Inuktitut |
164 | Interlingue; Occidental |
165 | Interlingua (International Auxiliary Language Association) |
166 | Indonesian |
167 | Inupiaq |
168 | Javanese |
169 | Kalaallisut; Greenlandic |
170 | Kannada |
171 | Kashmiri |
172 | Kanuri |
173 | Kazakh |
174 | Central Khmer |
175 | Kikuyu; Gikuyu |
176 | Kinyarwanda |
177 | Kirghiz; Kyrgyz |
178 | Komi |
179 | Kongo |
180 | Korean |
181 | Kuanyama; Kwanyama |
182 | Kurdish |
183 | Lao |
184 | Latin |
185 | Latvian |
186 | Limburgan; Limburger; Limburgish |
187 | Lingala |
188 | Lithuanian |
189 | Luxembourgish; Letzeburgesch |
190 | Luba-Katanga |
191 | Ganda |
192 | Macedonian |
193 | Marshallese |
194 | Malayalam |
195 | Maori |
196 | Marathi |
197 | Malay |
198 | Malagasy |
199 | Maltese |
200 | Mongolian |
201 | Nauru |
202 | Navajo; Navaho |
203 | Ndebele, South; South Ndebele |
204 | Ndebele, North; North Ndebele |
205 | Ndonga |
206 | Nepali |
207 | Norwegian Nynorsk; Nynorsk, Norwegian |
208 | Bokmål, Norwegian; Norwegian Bokmål |
209 | Norwegian |
210 | Chichewa; Chewa; Nyanja |
211 | Occitan (post 1500) |
212 | Ojibwa |
213 | Oriya |
214 | Oromo |
215 | Ossetian; Ossetic |
216 | Panjabi; Punjabi |
217 | Persian |
218 | Pali |
219 | Polish |
220 | Pushto; Pashto |
221 | Quechua |
222 | Romansh |
223 | Romanian |
224 | Rundi |
225 | Sango |
226 | Sanskrit |
227 | Sinhala; Sinhalese |
228 | Slovak |
229 | Slovenian |
230 | Northern Sami |
231 | Samoan |
232 | Shona |
233 | Sindhi |
234 | Somali |
235 | Sotho, Southern |
236 | Sardinian |
237 | Serbian |
238 | Swati |
239 | Sundanese |
240 | Swahili |
241 | Swedish |
242 | Tahitian |
243 | Tamil |
244 | Tatar |
245 | Telugu |
246 | Tajik |
247 | Thai |
248 | Tibetan |
249 | Tigrinya |
250 | Tonga (Tonga Islands) |
251 | Tswana |
252 | Tsonga |
253 | Turkmen |
254 | Turkish |
255 | Twi |
256 | Uighur; Uyghur |
257 | Ukrainian |
258 | Urdu |
259 | Uzbek |
260 | Venda |
261 | Vietnamese |
262 | Volapük |
263 | Welsh |
264 | Walloon |
265 | Wolof |
266 | Xhosa |
267 | Yiddish |
268 | Yoruba |
269 | Zhuang; Chuang |
270 | Zulu |
999 | Declined to Specify |
This article describes the required positions for Performing Lab Information to be visible in the lab column within the Results as well as the Printed Report. These values will need to be sent within the ORU.HL7 file by the performing lab.
INTERNAL: This will require a change to the TPS 1 Type mapping
OBX.15 Mappings
Segment | Description | Displayed Format |
---|---|---|
OBX.15.1 | Lab ID varchar(5) | UI: {OBX.15.1} Print: {OBX.15.1}+': ' |
OBX.15.2 | Facility Name | UI: Name: {OBX.15.2} Print: {OBX.15.2} + ' ' |
OBX.15.3 | Facility Address | UI: Address: {OBX.15.3} Print: {OBX.15.3}+ ' ' |
OBX.15.4 | Miscellaneous/Other ID | UI: Not Displayed Print: {OBX.15.4}+ ' ' |
OBX.15.5 | City | UI: City-State: {OBX.15.5} Print: {OBX.15.5} |
OBX.15.6 | State | UI: , {OBX.15.6} Print: {OBX.15.6} |
OBX.15.7 | Zip | UI: {OBX.15.7} Print: {OBX.15.7} |
OBX.15.8 | Director | UI: Director: {OBX.15.8} Print: {OBX.15.8} |
OBX.15.9 | Phone | UI: Phone: {OBX.15.9} Print: ph: {OBX.15.9} |
UI Screenshot
Printed Requisition
MessageLabID^LabName^Street Address^OtherID(Internal Lab ID/CLEA)^City^State^Zip^Director^PHONE#
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 |
MSH.3 Specifications | Document Types and Subtypes
Document Types
Encode ID | ShortDescription | Notes |
---|---|---|
1 | ADT_EVENT | Reports of admission, discharges and tranfers |
2 | CARDIOLOGY | EKG, Echo's, etc. |
3 | GI | GI reports |
4 | LAB_MICRO | Lab and Microbiology together |
5 | LAB_ONLY | Lab only (no micro) |
6 | MICRO_ONLY | Micro only (no lab) |
7 | OTHER | Reports not otherwise classified |
8 | PATHOLOGY | Pathology Reports |
9 | RADIOLOGY | Radiology Reports |
10 | TRANSCRIPTION | Transcription Reports |
11 | UNKNOWN | Report type is not known |
12 | VARIOUS | Various different reports merged together |
13 | Lab | Lab (Unknown Type) |
99 | Error | Unable to process HL7 file |
Document Subtypes
Encode ID | ShortDescription |
---|---|
1 | Report |
2 | Discrete |
99 | Error |
Health Exchange OBR.4 Specifications
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.
Encode ID | ShortDescription | LongDescription |
---|---|---|
0 | ** | Discrete Data |
1 | AR | Autopsy Report |
2 | AS | Admission Summary |
3 | BB | Blood Bank |
4 | CC | Cardio Diagnostics |
5 | CL | Clinic Letter |
6 | CN | Consult |
7 | CO | Clinic Note |
8 | CR | Correction |
9 | CS | Clinic Summary |
10 | DH | Discharge Instructions |
11 | DI | Diagnostic Imaging |
12 | DN | Diagnostic Neurology |
13 | DR | Diagnostic Report Other |
14 | DS | Discharge Summary |
15 | ED | ER Discharge Summary |
16 | EK | EKG Report |
17 | EN | Endoscopy Report |
18 | ER | Emergency Report |
19 | FE | Filed in Error |
20 | GC | General Correspondences |
21 | HP | History and Physical Exam |
22 | LD | Labor and Delivery Report |
23 | LR | Lab Report |
24 | MR | Microbiology Report |
25 | OP | Operative Report |
26 | OT | Occupational Therapy |
27 | PA | Pathology Report |
28 | PE | Phone Encounter |
29 | PF | Pulmonary Function |
30 | PN | Procedure Note |
31 | PR | Progress Note |
32 | PX | Psychiatric Note |
33 | RA | Radiology |
34 | RR | Rehab Report |
35 | SL | Sleep Study |
36 | TH | Physical Therapy |
37 | TN | Transcribed Note |
38 | TS | Transfer Summary |
39 | ZA | Admission, Discharge, Transfer Event Notification Report |
40 | ZZ | Other |
99 | .. | Invalid HL7 file |