SOAPware DocumentationSOAPware InterfaceSOAPware Interface SOAPwareXchange HL7SOAPwareXchangeHL7 Pathology Interface Specifications

SOAPwareXchangeHL7 Pathology Interface Specifications

SOAPwareXchangeHL7 is the interface module allowing HL7-compliant interfaces between the SOAPware® charting product and other HL7-compliant systems.

This lesson describes the specific manner in which HL7 is implemented in SOAPwareXchangeHL7, and how the various standard fields will be used.

SOAPwareXchangeHL7 accepts HL7-compliant messages from other systems, and uses them to create formatted reports in a chart section of the appropriate SOAPware® chart. If the patient described in the PID (patient identifier) section of the HL7 message cannot be matched, it will be added to a queue for the SOAPware user to handle. SOAPwareXchangeHL7 uses the matching algorithm below to determine if a patient already exists in SOAPware®

Patient Matching Process

An incoming record will be considered to be a match to a SOAPware® patient if:

External ID is found in patient map, AND

Birthdate matches, OR

Last name matches

OR

Social Security numbers match, AND

Birthdate matches, AND

Last name matches, AND

First name matches

OR

First name and Last name matches, AND

Birthdate matches, AND

Sex matches

So a match can be made on:

First Name AND Last Name AND Birthdate

AND

Sex OR Social Security Number

Results-Only Interface

At this time all HL7 interfaces implemented with SOAPwareXchangeHL7 will be results-only. Bi-directional interfaces are being evaluated for future implementation. Because of this, SOAPwareXchangeHL7 only processes results messages (ORU).

A standard ORU message would follow this format:

MSH

PID

{ORC

[NTE]}

{OBR

[NTE]}

{OBX

[NTE]}

Communications

Matters of communication are between the lab and the site. SOAPware®, Inc does not provide communication services.

SOAPwareXchangeHL7 supports file-based or TCP-based interfaces. A file based interface will consist of the interfacing system, or system user, depositing HL7 messages in a specified location on the SOAPwareXchangeHL7 machine. SOAPwareXchangeHL7 will then retrieve and parse these messages. When the messages have been parsed, SOAPwareXchangeHL7 will remove them.

A TCP based interface will require a TCP connection between SOAPwareXchangeHL7 and the sending system.SOAPwareXchangeHL7 will listen for incoming messages, and parse them as they arrive.SOAPwareXchangeHL7 will always return an ACK messages for TCP messages received.

 

File-based

File based communication is the preferred communication method and allows for easiest troubleshooting for SOAPware Support. All incoming lab messages should be deposited to the same directory.This directory must be reserved for the sole purpose of incoming messages; no other file types or information should be stored there.SOAPwareXchangeHL7 will remove each file after processing.

 

TCP

Current versions of SOAPwareXchangeHL7 are only capable of monitoring a single port.If multiple labs are interfaces to the same site, one lab may use the TCP connection.The other labs must use a file-based method, depositing result files into the same directory.

The TCP connection should not be closed after each send, as this will require the SOAPwareXchangeHL7 user to reset the connection from their end.

The XchangeHL7 will automatically send an ACK after each report is received. This cannot be controlled or altered via the XchangeHL7 GUI.

While we realize the value of TCP connections and offer these, we do not have the resources to troubleshoot them, and will recommend a file-based solution if problems turn up with the connection. If a sending facility/application has issues with connecting to a specific port on a clients local network, SOAPware staff will recommend contacting the clients IT personnel for further troubleshooting.

 

SOAPware, Inc. does offer connectivity services when none are available through the Lab company for an additional setup and subscription fee. Speak with the SOAPware Sales Team if these services are needed.

Segment Descriptions and Legend

Segment Descriptions and Legend

BOLDED fields are required.

Each PID segment requires a unique MSH segment.

The MSH (Message Header) Segment

The MSH (Message Header) Segment

SOAPwareXchangeHL7 requires the MSH segment to be the first in the file. We do not accept FHS, BHS, or any other information before the MSH segment.

A separate MSH segment is required for each PID segment in the file.

The Sending Application value in MSH-3 is used by SOAPwareXchangeHL7 to determine the source of the message and the section in SOAPware the report will be translated. This value should remain consistent for any interfaces using the same delivery application/company.

The generic and preferred value to be used when sending pathology reports should be "PATH".

Messages parsed through this interface will be filed in the Pathology section of the patient chart.

The PID (Patient Identifier) Segment  

The PID (Patient Identifier) Segment  

The PatientID in PID-3 will be entered into a matching table. This ID can be anything, as long as it is unique and consistent per patient. First Name, Last Name, Birthdate, Sex, and Social Security Number are all used for the patient matching algorithm. Omitting any of this information may cause the record to be queued for manual assignment. Demographic information included in the PID segment will not be used to update the demographics in the patient chart.

Certain elements from the PID segment and other segments will form a report header at the top of each pathology report. This inlcludes; First and Last name, ordering date, ordering provider, and others general information.

While SSN is marked as a required field, this may not be the case if a match can be based on all other data items in the patient matching algorithm.

The ORC (Common Order) Segment  

The ORC (Common Order) Segment  

The Accession Number in ORC-3 or OBR-3 is used for report matching purposes. When a message comes in with an accession number that already exists in SOAPware®, the existing report will be updated or replaced, depending on the result status of the existing report. Result status from the ORC segment will be displayed as the report status.

Ordering Provider information will be read from either ORC-12, or OBR-16.A physician ID of some sort is required in one of those fields.Last Name will be used as well, if included.

The OBR (Observation Request) Segment*  

The OBR (Observation Request) Segment*  

*At least one OBR must be included under each ORC segment.

The Accession Number will be read from OBR-3 if it is not present in ORC-3.

Every OBR-4^2 under the same ORC will be combined to form the title of the report in SOAPware®. Each ORC segment will trigger a new report.If any OBR-4^2 is not populated, it will defer to OBR-3 to generate the report title.

OBR-7 will appear in the report as the Report Date. An ordering physician ID will be expected in OBR-16 if it was not present in ORC-12.

The SOAPwareXchangeHL7 will currently only accept and process results for Ordering Providers, and will not process CC providers from OBR-28.

The OBX (Observation) Segment*  

The OBX (Observation) Segment*  

*At least one OBX must be included under each OBR segment.

For any report type, only OBX-5 will be displayed.

 

 

Escape Characters in the Default Pathology Interface

Escape Characters in the Default Pathology Interface

The NTE (Notes and Comments) Segment  

The NTE (Notes and Comments) Segment  

 

 

 

Sample message

Below is a sample pathology result message and how it displays in SOAPware.

MSH|^~\&|PATH|COCRX|SOAPWARE|ArroyoOaksMedAssoc|201101041037||ORU^R01|RXLABRES.1.3218|P|2.4|||AL

PID|1||X999999999||FAKE^FAKE||19591213|F||||||||||X99999999999

PV1|1|I|G.2SURG^G.2110^A||||ARROYO123^TESTDOC^NOVO||||||||||ARROYO123^TESTDOC^NOVO|IN||||||||||||||||||||||||||201012281600|201012311700

OBR|||RX:S-5990-10|SU^SURGICAL SPECIMEN^L|||201012290906|||||||201012290858||ARROYO123^TESTDOC^NOVO|||||||||F

OBX|10|TX|Blank||--------------------------------------------------------------------------------------------||||||F

OBX|11|TX|Blank|| ||||||F

OBX|12|TX|Blank||SPEC #: RX:S-9999-99       RECD: 99/99/99-9999     STATUS:  SOUT           REQ #: 99999999||||||F

OBX|13|TX|Blank||                           COLL: 99/99/99-         SUBM DR: Oates,Randall              ||||||F

OBX|14|TX|Blank|| ||||||F

OBX|15|TX|Blank||ENTERED:  99/99/99-9999    SP TYPE: SURGICAL       OTHR DR: CHART                         ||||||F

OBX|16|TX|Blank||                                                            Daya,Anil||||||F

OBX|17|TX|Blank||                                                            Liberman,Orlin||||||F

OBX|18|TX|Blank||                                                            PATH FILE||||||F

OBX|19|TX|Blank||ORDERED:  G/M III (99999), G/M IV (99999)/9, G/M V (99999)/9, G/M VI (99999),     ||||||F

OBX|20|TX|Blank||          GRS OR (99999), FROZEN (99999), P99 IP 99999/9||||||F

OBX|21|TX|Blank|| ||||||F

OBX|22|TX|Blank||CODES: T99999 - APPENDIX||||||F

OBX|23|TX|Blank||       T99999 - UTERUS||||||F

OBX|24|TX|Blank||       T99999 D999999 - MYOMETRIUM, NOS ENDOMETRIOSIS O||||||F

OBX|25|TX|Blank||       T99999 D999999 - OVARY ENDOMETRIOSIS||||||F

OBX|26|TX|Blank||       T99999 M99999 - OVARY NEOPLASM, UNCER||||||F

OBX|27|TX|Blank||       T99999 M99999 - OVARY MUCINOUS ADENOC||||||F

OBX|28|TX|Blank||       T99999 M99999 - OVARY ADENOFIBROMA, N||||||F

OBX|29|TX|Blank||       T99999 P999999 - OVARY EXCISION, NOS||||||F

OBX|30|TX|Blank||       T99999 P999999 - OVARY CONSULTATION, N||||||F

OBX|31|TX|Blank||       T99999 - RIGHT FALLOPIAN||||||F

OBX|32|TX|Blank||       TD9999 - ABDOMEN||||||F

OBX|33|TX|Blank||       TD9999 M99999 - PERITONEUM, NOS SECRETORY ENDOM||||||F

OBX|34|TX|Blank||       TD9999 P999999 - PERITONEUM, NOS EXCISION, NOS||||||F

OBX|35|TX|Blank||       TD9999 - OMENTUM||||||F

OBX|36|TX|Blank||       TD9999 P999999 - OMENTUM EXCISION, NOS||||||F

OBX|37|TX|Blank|| ||||||F

OBX|38|TX|Blank||Copies To:||||||F

OBX|39|TX|Blank||   CHART||||||F

OBX|40|TX|Blank|| ||||||F

OBX|41|TX|Blank||   Daya,Anil||||||F

OBX|42|TX|Blank||   9999 Westlake Blvd., #999||||||F

OBX|43|TX|Blank||   Westlake Village, CA 99999||||||F

OBX|44|TX|Blank||   (999)999-9999||||||F

OBX|45|TX|Blank|| ||||||F

OBX|46|TX|Blank||   Eisenkop,Scott M||||||F

OBX|47|TX|Blank||   9999 Van Nuys Blvd. Ste. 999||||||F

OBX|48|TX|Blank||   Sherman Oaks, CA 99999||||||F

OBX|49|TX|Blank||   (999)999-9999||||||F

OBX|50|TX|Blank|| ||||||F

OBX|51|TX|Blank||   Liberman,Orlin||||||F

OBX|52|TX|Blank||   99999 Village Ctr Rd #999||||||F

OBX|53|TX|Blank||   Westlake Vlg, CA 99999||||||F

OBX|54|TX|Blank||   (999)999-9999||||||F

OBX|55|TX|Blank|| ||||||F

OBX|56|TX|Blank||   PATH FILE||||||F

OBX|57|TX|Blank|| ||||||F

OBX|58|TX|Blank|| ||||||F

OBX|59|TX|Blank|| ||||||F