Incoming Results From Lab Instruments - Stainer Status Updates Interface Reference Guide (AIK 80)
Incoming Results From Lab Instruments - Stainer Status Updates Interface Reference Guide (AIK 80)
Additional Documentation
Outgoing Orders to Lab Instruments - Slide Orders Interface
For information on sending orders to your stainer, or other slide instruments, refer to the Outgoing Orders to Lab
Instruments - Slide Orders Interface Reference Guide (AIK 79).
Message Specifications
OUL^R21 Unsolicited Laboratory Observation Message
Message Format for Event Type R21
Segment Description
Setup
Communication Methods
Epic recommends using the Incoming TCP/IP Using Database Servers communication method.
Other supported communication methods include:
• Incoming TCP/IP Using Interconnect
• HL7v2 File Listener Using Interconnect
• Flat File Conversion Using Database Server
Profile Variables
• STAIN_STATUS_TBL [6866]
Errors
• INVALID STAIN STATUS [30105]
EpicUUID: 57C9C77A-6F0B-4423-807A-D59F3DF1B526
• STAIN STATUS TABLE NOT FOUND [30106]
Format Example - Stain Start Status Update
MSH|^~\&|VENDOR|APLab|LIS||201301011355||OUL^R21||P|2.4|
PID|||MRN1234||LastName^FirstName^MiddleInitial||19800101|M|
ORC|SC||VendorSlideID||CM|E||||||||||||^MethodID|||||||STAINING
OBR|1||VendorSlideID|SlideProtocol^StatusUpdate|||20090313142100||||||||||||12345^2|
12345^1|12345^A|
Profile Variables
• IGN_CONT_POINTER [1442]
MSA - Message Acknowledgment
Element Name Type Usage Notes
1 - Acknowledgment ID Required Indicates successful/not successful processing of message
Code
Format: Code
Original Mode Values:
• AA - Application Accept
• AE - Application Error
• AR - Application Reject
Enhanced Mode Values:
• CA - Commit Accept
EpicUUID: 57C9C77A-6F0B-4423-807A-D59F3DF1B526
Element Name Type Usage Notes
• CE - Commit Error
• CR - Commit Reject
2 - Message Control ST Required Message control ID of the message sent by the original sending system
ID
Format: Text
3 - Text Message ST Optional Optional field that can contain an error message
Format: Text
PID-2 - Patient ID
This field is only used for backwards compatibility.
Database Location
• PATIENT ID (I EPT .1)
PID-3 - Patient Identifier List
Format: <Patient ID>^^^<assigning authority>^<ID Type>
The patient identifier list can contain values for the national identifier formatted as follows. The assigning
authority and ID Type for the national identifier are set in NAT_ID_ASSIGNING_AUTHORITY (1062) and
NAT_IDENTIFIER_ID_TYPE (1163) respectively.
<National identifier>^^^<Assigning Authority>^<ID Type>
To avoid unintentionally filing data to the incorrect patient, this interface requires patient validation to be
configured. If you don't configure patient validation, this interface fails to start. For more information about
patient validation including instructions on how to turn on the feature, refer to the Patient Validation and
Duplicate Prevention and Requisition Grouper Validation topics.
Patient lookup fails if an ID Type of "DL" is the only ID and ID type received in PID-3 because "DL" is reserved
EpicUUID: 57C9C77A-6F0B-4423-807A-D59F3DF1B526
for driver's license numbers, and this interface doesn't support filing driver's license.
Profile Variables
• PAT_LOOKUP [3]
• HL7_PAT_ID [378]
• DEFAULT_ID_TYPE [776]
• REQUIRE_RQG_VALIDATION [5087]
• REQUISITION_LOOKUP [25942]
• CLINLAB_EPT_RQG_LOOKUP [35942]
• NAT_ID_ASSIGNING_AUTHORITY [1062]
• NAT_IDENTIFIER_ID_TYPE [1163]
Errors
• PATIENT ID NOT FOUND [530]
• EPT OR RQG RECORD DOES NOT MATCH RECORD ON SPECIMEN [2891]
• RQG NOT FOUND [3926]
• MULTIPLE PATIENTS IDENTIFIED [6135]
• MULTIPLE RECORDS FOUND DURING LOOKUP [25007]
Build
• Identity ID Types (IIT records)
Database Location
• SOCIAL SECURITY NUMBER (I EPT 160)
PID-4 - Alternate Patient ID
Database Location
• EXTERNAL GROUP ID (I EPT 7196)
PID-5 - Patient Name
The patient's name can be used to help validate that the message is for the correct patient.
Profile Variables
• PAT_NAME_TYPE_TBL [2802]
• NAME_ACADEMIC_TBL [2182]
• NAME_SUFFIX_TBL [652]
• NAME_TITLE_TBL [3404]
• USE_LEGAL_NAME_AS_VALIDATION_DISPLAY_NAME [5931]
Errors
• TABLE MAPPING ERROR FOR NAME TITLE [7674]
• NAME SUFFIX COULD NOT BE MAPPED [775]
• ACADEMIC NAME COULD NOT BE MAPPED [776]
Database Location
• PATIENT NAME (I EPT .2)
• TITLE (I EPT 121)
• SUFFIX (I EPT 122)
• ACADEMIC (I EPT 124)
PID-6 - Mother's Maiden Name
Profile Variables
• ESC_CHK [436]
Database Location
• MOTHER'S MAIDEN NAME (I EPT 360)
EpicUUID: 57C9C77A-6F0B-4423-807A-D59F3DF1B526
PID-7 - Date/Time of Birth
Only date of birth is supported. Used only for validation purposes.
Only date of birth is supported.
Database Location
• DATE OF BIRTH (I EPT 110)
PID-8 - Sex
Errors
• INCOMING TABLE VALUE COULD NOT BE MAPPED [40000]
Database Location
• LEGAL SEX (I EPT 130)
PID-10 - Race
This field can only be used for Identity Duplicate Checking.
Profile Variables
• RACE_TABLE [326]
• RACE_ITEM [1254]
Errors
• INCOMING TABLE VALUE COULD NOT BE MAPPED [40000]
Database Location
• ETHNIC GROUP (I EPT 135)
• PATIENT RACE (I EPT 145)
PID-11 - Patient Address
Permanent Address
• Street
• Dwelling Number
• City
• State
• ZIP/Postal code
• Country County
Confidential Address
• Street
• Dwelling Number
• City
• State
• ZIP/Postal code
• Country
• Start Date
• End Date
Temporary Address
• Street
EpicUUID: 57C9C77A-6F0B-4423-807A-D59F3DF1B526
• Dwelling Number
• City
• State
• ZIP/Postal code
• Country
• Start Date
• End Date
Format:
<Street 1>^<Street 2/House Number>^<City>^<State>^<ZIP code>^<Country>^<Address
Type>^^<County>^^^^<Start Date>^<End Date>
This field can repeat, with permanent, confidential, and temporary addresses sent in separate repetitions. The
different addresses are denoted by a flag in the <Address Type> piece of the field (piece 7)
ZIP/postal code is required to be in the U.S. or Canadian format unless the interface is configured to receive
international formats.
Profile Variables
• INTER_ZIP [558]
• COUNTRY_TABLE [602]
• STATE_TABLE [735]
• COUNTY_TABLE [3031]
• ADDRESS_TYPE_TBL [2776]
Errors
• ADDRESS TYPE COULD NOT BE MAPPED [748]
Database Location
• ADDRESS (I EPT 50)
• CITY (I EPT 60)
• STATE (I EPT 70)
• COUNTY OF RESIDENCE (I EPT 75)
• COUNTRY (I EPT 78)
• ZIP CODE (I EPT 80)
• HOUSE NUMBER (I EPT 82)
• ADDRESS START DATE (I EPT 84)
• CONFIDENTIAL ADDRESS (I EPT 550)
• CONFIDENTIAL CITY (I EPT 555)
• CONFIDENTIAL STATE (I EPT 560)
• CONFIDENTIAL ZIP CODE (I EPT 575)
• CONFIDENTIAL COUNTRY (I EPT 570)
• CONFIDENTIAL HOUSE NUMBER (I EPT 571)
• CONFIDENTIAL START DATE (I EPT 600)
• PATIENT TEMPORARY ADDRESS (I EPT 5430)
• PATIENT TEMPORARY CITY (I EPT 5431)
• PATIENT TEMPORARY STATE (I EPT 5432)
• PATIENT TEMPORARY ZIP (I EPT 5434)
• PATIENT TEMPORARY COUNTRY (I EPT 5433)
• PATIENT TEMPORARY HOUSE NUMBER (I EPT 5442)
• PATIENT TEMPORARY ADDRESS START DATE (I EPT 5437)
EpicUUID: 57C9C77A-6F0B-4423-807A-D59F3DF1B526
• PATIENT TEMPORARY ADDRESS END DATE (I EPT 5438)
PID-12 - County Code
This field is for backwards compatibility only.
Profile Variables
• COUNTY_TABLE [3031]
Errors
• TABLE MAPPING ERROR FOR COUNTY [7455]
PID-13 - Phone Number – Home
Four formats are accepted. If the equipment type is not specified it defaults to the home phone.
Format: [nnn](nnn)nnn-nnnn^<Telecommunication use code>^<Telecommunication equipment type>^<E-
mail address>^<Country code>^<Area/city code>^<Local number>^<Extension>^<Any text>^<Extension
prefix>^<Speed dial code>^<Unformatted telephone number>
E-mail addresses as well as confidential and temporary contact numbers are not supported.
Profile Variables
• PHONE_CODE_TBL [9252]
• COMM_EQUIP_TYPE_TBL [10278]
Errors
• INVALID PHONE NUMBER [210]
• INVALID EMAIL ADDRESS [215]
• INVALID PHONE NUMBER: PATIENT PHONE [224]
• PHONE CODE COULD NOT BE MAPPED [774]
Database Location
• OTHER COMMUNICATION DEVICES (I EPT 94)
• PHONE 1 (I EPT 90)
• OTHER COMMUNICATION NUMBERS (I EPT 98)
PID-14 - Phone Number – Work
(nnn)nnn-nnnnx<extension>
or
^^^^^<City/area code>^<Number>^<Extension>
or
#<text>
Three formats are accepted.
[nnn](nnn)nnn-nnnn^^^^^^^<Extension>
^^^^<Country code>^<City/area code>^<Number>^<Extension>
#<text>
Errors
• INVALID PHONE NUMBER [210]
• INVALID PHONE NUMBER: PATIENT PHONE [224]
Database Location
• OTHER COMMUNICATION DEVICES (I EPT 94)
• OTHER COMMUNICATION NUMBERS (I EPT 98)
• WORK PHONE (I EPT 5170)
EpicUUID: 57C9C77A-6F0B-4423-807A-D59F3DF1B526
PID-15 - Primary Language
Formats:
• <Language>
• <Language>^^^^^^^^
This field can only be used for Identity Duplicate Checking.
The first component is used. All others are ignored.
Profile Variables
• LANGUAGE_TABLE [2562]
Errors
• PATIENT LANGUAGE COULD NOT BE MAPPED [2099]
• TABLE MAPPING ERROR FOR LANGUAGE [7675]
Database Location
• LANGUAGE (I EPT 155)
• LANGUAGE-SPOKEN (MR) (I EPT 146)
PID-16 - Marital Status
Profile Variables
• MARITAL_TABLE [327]
Errors
• TABLE MAPPING ERROR FOR MARITAL STATUS [7456]
Database Location
• MARITAL STATUS (I EPT 140)
PID-17 - Religion
Profile Variables
• RELIGION_TABLE [2561]
Errors
• TABLE MAPPING ERROR FOR RELIGION [7457]
Database Location
• RELIGION (I EPT 150)
PID-18 - Patient Visit Number
Configurable; Can be used to locate the visit to which the message should be associated.
Profile Variables
• ENCOUNTER_KEY [61]
• ACCOUNT_ID_LOOKUP [2481]
• ACCOUNT_ID_TYPE_DEFAULT [2484]
• ACCOUNT_ITEM [868]
Database Location
• SOCIAL SECURITY NUMBER (I EPT 160)
• CONTACT SERIAL NUMBER (I EPT 8)
• BILLING NUMBER (I EPT 17)
• VISIT HOSPITAL ACCOUNT (I EPT 2500)
PID-19 - SSN Number – Patient
Used for validation. Numeric with or without dashes.
National identifier can also be received in PID-3.
EpicUUID: 57C9C77A-6F0B-4423-807A-D59F3DF1B526
Profile Variables
• NAT_ID_BYPASS_FORMATTING [666]
Errors
• INVALID NATIONAL IDENTIFIER FORMAT [91524]
Database Location
• SOCIAL SECURITY NUMBER (I EPT 160)
PID-22 - Ethnic Group
This field is only used for R30 messages.
This field can only be used for Identity Duplicate Checking.
Profile Variables
• ETHNIC_GROUP_TABLE [1252]
• ETHNIC_GROUP_LOCATION [2728]
Errors
• INCOMING TABLE VALUE COULD NOT BE MAPPED [40000]
Database Location
• ETHNIC GROUP (I EPT 135)
• ETHNIC BACKGROUND (I EPT 134)
ORC - Order Common
Segment-Level Summary
Most of the information on the optional ORC segment is ignored by the Incoming Lab Instrument Results
Interface to Clinical Lab. Note that most of the information sent in this segment is also duplicated in the OBR
segment.
Profile Variables
• IGN_CONT_POINTER [1442]
PID - Patient Identification
Segment-Level Summary
If patient information is not received in the PID segment, patient lookup can be skipped using
INSTRUMENT_IGNORE_PID (9520).
In this case, the interface files the result to the visit and patient found using the visit identifier in the message.
Note that if the PID segment is ignored, patient information in PID cannot be compared against the patient
EpicUUID: 57C9C77A-6F0B-4423-807A-D59F3DF1B526
found in the database using the visit identifier. Because of this, Epic recommends receiving patient information
in messages to ensure that the patient information and the visit identifier identify the same patient.
This interface is not allowed to create patients if a patient cannot be found by either the patient identifier or
visit identifier.
Profile Variables
• INSTRUMENT_IGNORE_PID [9520]
PID-2 - Patient ID
This field is only used for backwards compatibility.
Database Location
• PATIENT ID (I EPT .1)
PID-3 - Patient Identifier List
Format: <Patient ID>^^^<assigning authority>^<ID Type>
The patient identifier list can contain values for the national identifier formatted as follows. The assigning
authority and ID Type for the national identifier are set in NAT_ID_ASSIGNING_AUTHORITY (1062) and
NAT_IDENTIFIER_ID_TYPE (1163) respectively.
<National identifier>^^^<Assigning Authority>^<ID Type>
To avoid unintentionally filing data to the incorrect patient, this interface requires patient validation to be
configured. If you don't configure patient validation, this interface fails to start. For more information about
patient validation including instructions on how to turn on the feature, refer to the Patient Validation and
Duplicate Prevention and Requisition Grouper Validation topics.
Patient lookup fails if an ID Type of "DL" is the only ID and ID type received in PID-3 because "DL" is reserved
for driver's license numbers, and this interface doesn't support filing driver's license.
Profile Variables
• PAT_LOOKUP [3]
• HL7_PAT_ID [378]
• DEFAULT_ID_TYPE [776]
• REQUIRE_RQG_VALIDATION [5087]
• REQUISITION_LOOKUP [25942]
• CLINLAB_EPT_RQG_LOOKUP [35942]
• NAT_ID_ASSIGNING_AUTHORITY [1062]
• NAT_IDENTIFIER_ID_TYPE [1163]
Errors
• PATIENT ID NOT FOUND [530]
• EPT OR RQG RECORD DOES NOT MATCH RECORD ON SPECIMEN [2891]
• RQG NOT FOUND [3926]
• MULTIPLE PATIENTS IDENTIFIED [6135]
• MULTIPLE RECORDS FOUND DURING LOOKUP [25007]
Build
EpicUUID: 57C9C77A-6F0B-4423-807A-D59F3DF1B526
• Identity ID Types (IIT records)
Database Location
• SOCIAL SECURITY NUMBER (I EPT 160)
PID-4 - Alternate Patient ID
Database Location
• EXTERNAL GROUP ID (I EPT 7196)
PID-5 - Patient Name
The patient's name can be used to help validate that the message is for the correct patient.
Profile Variables
• PAT_NAME_TYPE_TBL [2802]
• NAME_ACADEMIC_TBL [2182]
• NAME_SUFFIX_TBL [652]
• NAME_TITLE_TBL [3404]
• USE_LEGAL_NAME_AS_VALIDATION_DISPLAY_NAME [5931]
Errors
• TABLE MAPPING ERROR FOR NAME TITLE [7674]
• NAME SUFFIX COULD NOT BE MAPPED [775]
• ACADEMIC NAME COULD NOT BE MAPPED [776]
Database Location
• PATIENT NAME (I EPT .2)
• TITLE (I EPT 121)
• SUFFIX (I EPT 122)
• ACADEMIC (I EPT 124)
PID-6 - Mother's Maiden Name
Profile Variables
• ESC_CHK [436]
Database Location
• MOTHER'S MAIDEN NAME (I EPT 360)
PID-7 - Date/Time of Birth
Only date of birth is supported. Used only for validation purposes.
Only date of birth is supported.
Database Location
• DATE OF BIRTH (I EPT 110)
PID-8 - Sex
Errors
• INCOMING TABLE VALUE COULD NOT BE MAPPED [40000]
Database Location
• LEGAL SEX (I EPT 130)
PID-10 - Race
This field can only be used for Identity Duplicate Checking.
Profile Variables
• RACE_TABLE [326]
• RACE_ITEM [1254]
EpicUUID: 57C9C77A-6F0B-4423-807A-D59F3DF1B526
Errors
• INCOMING TABLE VALUE COULD NOT BE MAPPED [40000]
Database Location
• ETHNIC GROUP (I EPT 135)
• PATIENT RACE (I EPT 145)
PID-11 - Patient Address
Permanent Address
• Street
• Dwelling Number
• City
• State
• ZIP/Postal code
• Country County
Confidential Address
• Street
• Dwelling Number
• City
• State
• ZIP/Postal code
• Country
• Start Date
• End Date
Temporary Address
• Street
• Dwelling Number
• City
• State
• ZIP/Postal code
• Country
• Start Date
• End Date
Format:
<Street 1>^<Street 2/House Number>^<City>^<State>^<ZIP code>^<Country>^<Address
Type>^^<County>^^^^<Start Date>^<End Date>
This field can repeat, with permanent, confidential, and temporary addresses sent in separate repetitions. The
different addresses are denoted by a flag in the <Address Type> piece of the field (piece 7)
ZIP/postal code is required to be in the U.S. or Canadian format unless the interface is configured to receive
international formats.
EpicUUID: 57C9C77A-6F0B-4423-807A-D59F3DF1B526
Profile Variables
• INTER_ZIP [558]
• COUNTRY_TABLE [602]
• STATE_TABLE [735]
• COUNTY_TABLE [3031]
• ADDRESS_TYPE_TBL [2776]
Errors
• ADDRESS TYPE COULD NOT BE MAPPED [748]
Database Location
• ADDRESS (I EPT 50)
• CITY (I EPT 60)
• STATE (I EPT 70)
• COUNTY OF RESIDENCE (I EPT 75)
• COUNTRY (I EPT 78)
• ZIP CODE (I EPT 80)
• HOUSE NUMBER (I EPT 82)
• ADDRESS START DATE (I EPT 84)
• CONFIDENTIAL ADDRESS (I EPT 550)
• CONFIDENTIAL CITY (I EPT 555)
• CONFIDENTIAL STATE (I EPT 560)
• CONFIDENTIAL ZIP CODE (I EPT 575)
• CONFIDENTIAL COUNTRY (I EPT 570)
• CONFIDENTIAL HOUSE NUMBER (I EPT 571)
• CONFIDENTIAL START DATE (I EPT 600)
• PATIENT TEMPORARY ADDRESS (I EPT 5430)
• PATIENT TEMPORARY CITY (I EPT 5431)
• PATIENT TEMPORARY STATE (I EPT 5432)
• PATIENT TEMPORARY ZIP (I EPT 5434)
• PATIENT TEMPORARY COUNTRY (I EPT 5433)
• PATIENT TEMPORARY HOUSE NUMBER (I EPT 5442)
• PATIENT TEMPORARY ADDRESS START DATE (I EPT 5437)
• PATIENT TEMPORARY ADDRESS END DATE (I EPT 5438)
PID-12 - County Code
This field is for backwards compatibility only.
Profile Variables
• COUNTY_TABLE [3031]
Errors
• TABLE MAPPING ERROR FOR COUNTY [7455]
PID-13 - Phone Number – Home
Four formats are accepted. If the equipment type is not specified it defaults to the home phone.
Format: [nnn](nnn)nnn-nnnn^<Telecommunication use code>^<Telecommunication equipment type>^<E-
mail address>^<Country code>^<Area/city code>^<Local number>^<Extension>^<Any text>^<Extension
prefix>^<Speed dial code>^<Unformatted telephone number>
E-mail addresses as well as confidential and temporary contact numbers are not supported.
Profile Variables
• PHONE_CODE_TBL [9252]
EpicUUID: 57C9C77A-6F0B-4423-807A-D59F3DF1B526
• COMM_EQUIP_TYPE_TBL [10278]
Errors
• INVALID PHONE NUMBER [210]
• INVALID EMAIL ADDRESS [215]
• INVALID PHONE NUMBER: PATIENT PHONE [224]
• PHONE CODE COULD NOT BE MAPPED [774]
Database Location
• OTHER COMMUNICATION DEVICES (I EPT 94)
• PHONE 1 (I EPT 90)
• OTHER COMMUNICATION NUMBERS (I EPT 98)
PID-14 - Phone Number – Work
(nnn)nnn-nnnnx<extension>
or
^^^^^<City/area code>^<Number>^<Extension>
or
#<text>
Three formats are accepted.
[nnn](nnn)nnn-nnnn^^^^^^^<Extension>
^^^^<Country code>^<City/area code>^<Number>^<Extension>
#<text>
Errors
• INVALID PHONE NUMBER [210]
• INVALID PHONE NUMBER: PATIENT PHONE [224]
Database Location
• OTHER COMMUNICATION DEVICES (I EPT 94)
• OTHER COMMUNICATION NUMBERS (I EPT 98)
• WORK PHONE (I EPT 5170)
PID-15 - Primary Language
Formats:
• <Language>
• <Language>^^^^^^^^
This field can only be used for Identity Duplicate Checking.
The first component is used. All others are ignored.
Profile Variables
• LANGUAGE_TABLE [2562]
Errors
• PATIENT LANGUAGE COULD NOT BE MAPPED [2099]
• TABLE MAPPING ERROR FOR LANGUAGE [7675]
Database Location
• LANGUAGE (I EPT 155)
• LANGUAGE-SPOKEN (MR) (I EPT 146)
PID-16 - Marital Status
Profile Variables
EpicUUID: 57C9C77A-6F0B-4423-807A-D59F3DF1B526
• MARITAL_TABLE [327]
Errors
• TABLE MAPPING ERROR FOR MARITAL STATUS [7456]
Database Location
• MARITAL STATUS (I EPT 140)
PID-17 - Religion
Profile Variables
• RELIGION_TABLE [2561]
Errors
• TABLE MAPPING ERROR FOR RELIGION [7457]
Database Location
• RELIGION (I EPT 150)
PID-18 - Patient Visit Number
Configurable; Can be used to locate the visit to which the message should be associated.
Profile Variables
• ENCOUNTER_KEY [61]
• ACCOUNT_ID_LOOKUP [2481]
• ACCOUNT_ID_TYPE_DEFAULT [2484]
• ACCOUNT_ITEM [868]
Database Location
• SOCIAL SECURITY NUMBER (I EPT 160)
• CONTACT SERIAL NUMBER (I EPT 8)
• BILLING NUMBER (I EPT 17)
• VISIT HOSPITAL ACCOUNT (I EPT 2500)
PID-19 - SSN Number – Patient
Used for validation. Numeric with or without dashes.
National identifier can also be received in PID-3.
Profile Variables
• NAT_ID_BYPASS_FORMATTING [666]
Errors
• INVALID NATIONAL IDENTIFIER FORMAT [91524]
Database Location
• SOCIAL SECURITY NUMBER (I EPT 160)
PID-22 - Ethnic Group
This field is only used for R30 messages.
This field can only be used for Identity Duplicate Checking.
Profile Variables
• ETHNIC_GROUP_TABLE [1252]
• ETHNIC_GROUP_LOCATION [2728]
Errors
• INCOMING TABLE VALUE COULD NOT BE MAPPED [40000]
Database Location
EpicUUID: 57C9C77A-6F0B-4423-807A-D59F3DF1B526