Ascend HL7 Interface Specification - hosinc.com

1 1 | P a g e Ascend HL7 Interface Specification Documentation Version: 3/8/2013 Mediware Information Systems 11711 West 79th Street Lenexa, KS 66214 Voice: (877) 351-3300 Email: This document describes the standard specifications for the Ascend Interface Engine as of the version date above. Contact Mediware for any information regarding Interface support for new messages, features, etc. that may have been added to the interfaces, but not yet documented in these specifications. Contents Ascend HL7 Interface Specification .. 1 General Specifications .. 8 Standard (Preferred) Interface Specifications.

2 8 Standard Incoming or Outgoing Message Types .. 8 Sending and Receiving Systems; Inbound and Outbound Messages .. 10 HL7 Messages .. 10 HL7 Segments .. 10 Fields .. 10 Field Components and Subcomponents .. 11 Data Types .. 11 Field Requirements .. 13 Receiver Processing Rules .. 13 HL7 Messages Supported by Our Standard Interfaces .. 14 Admission Messages .. 14 ADT-A01 Admit a patient .. 14 ADT-A02 Transfer a Patient .. 15 ADT-A03 Discharge/End Visit .. 15 ADT-A04 Register an Outpatient/ER Patient .. 16 ADT-A05 Pre-admit a Patient .. 16 ADT-A06 Change an Outpatient to an Inpatient .. 17 ADT - A07 Change an Inpatient to an 17 ADT - A08 Update Patient Information.

3 17 ADT-A11 Cancel Admission .. 17 ADT A13 Cancel Discharge .. 17 2 | P a g e ADT-A17 Swap Patients .. 18 ADT-A21 Patient Goes on a Leave of Absence .. 18 ADT-A22 Patient Returns From a Leave of Absence .. 18 ADT-A31 Update Person .. 19 ADT A44 Move Account Information - Patient Account Number .. 19 ADT-A60 Update Adverse Reaction Information .. 20 Lab Messages .. 21 Order Messages .. 22 RDE - Pharmacy Encoded Order messages (Perfected) .. 22 ORM - Pharmacy Prescription Order messages (Non-perfected) .. 22 Formulary Messages .. 23 MFN - Master file notification message .. 23 Financial Messages.

4 24 DFT - Detailed Financial Transaction message .. 24 File Based Batch HL7 Charge File .. 24 Charge-On-Administration Messages .. 25 RAS Charge On Administration message .. 25 Pocket-Maintenance Messages .. 26 ZPM Pocket Maintenance message .. 26 HL7 Message Segment Detail .. 27 Segment ID .. 27 Segments Used for All Messages .. 28 MSH - Message Header 28 Field separator .. 28 Encoding characters .. 28 Sending application .. 28 Sending facility .. 28 Receiving application .. 29 Receiving facility .. 29 Date/time of message .. 29 Message type .. 29 Message control ID .. 30 Processing ID.

5 30 Version ID .. 30 MSA - message acknowledgment segment .. 30 Acknowledgment code .. 30 3 | P a g e Message control ID .. 30 Text message .. 30 Admissions Message Segments .. 31 EVN - event type segment .. 31 Event type code .. 31 Recorded date/time .. 31 PID - patient identification segment .. 31 Patient ID (Internal ID) .. 32 Patient name .. 32 Date/Time of birth .. 32 Patient address .. 32 Phone number - home .. 33 Patient account number .. 33 NK1 - patient next-of-kin segment .. 33 PV1 - patient visit segment .. 34 Patient Class (dynamic field) .. 35 Assigned patient location (dynamic field).

6 35 Attending doctor (dynamic field) .. 36 Admitting doctor (dynamic field) .. 36 Patient type (dynamic field) .. 36 Hospital Service (dynamic field) .. 36 Servicing Facility .. 36 PV2 - patient visit 2 segment .. 36 IN1 - Insurance information segment .. 37 AL1 - patient allergy information segment .. 39 Allergy Type .. 39 Allergy description .. 39 Allergy Reaction .. 39 Identification Date .. 39 OBX - observation segment (ADT) .. 39 Value Type .. 40 Observation Identifier .. 40 Identifier Text Coding system .. 40 Observation Value .. 40 Units .. 40 OBX - observation segment (Labs) .. 41 4 | P a g e Observation Value.

7 41 Abnormal Flags .. 41 OBR - Observation Request segment .. 41 NTE notes and comments segment .. 42 DG1 - diagnosis segment .. 42 Diagnosis coding method .. 43 Diagnosis 43 Diagnosis description .. 43 Diagnosis/DRG type .. 43 MRG - merge information .. 43 Prior Patient ID - Internal .. 43 IAM patient adverse information .. 44 Allergen Code/Description .. 44 Allergy Reaction Code .. 44 Allergy Action Code .. 44 Statused at Date/Time .. 44 Pharmacy Order Segments .. 46 ORC - common order segment .. 46 Order Control .. 46 Placer order number .. 47 Filler order 47 Timing/Quantity.

8 47 Transaction Date/Time .. 47 Entered By .. 47 Verified By .. 47 ORC - common order segment (Lab Messages) .. 47 RXE - pharmacy encoded segment .. 48 Quantity/Timing .. 49 Quantity .. 49 Interval .. 49 Duration .. 50 Start Date/Time .. 50 End Date/Time .. 51 Priority .. 51 Condition .. 51 Text Description .. 51 5 | P a g e Secondary Timing or Conjunction Component .. 51 Order Sequencing .. 51 Give code/drug ID .. 51 Give amount minimum .. 51 Give amount maximum .. 52 Give Units .. 52 Provider's administration instructions .. 52 Pharmacist verifier ID .. 52 Prescription Number/Rx Number.

9 52 Pharmacy Special Dispensing Instructions .. 52 Give rate amount .. 52 Give rate units .. 52 RXO - pharmacy prescription segment .. 53 RXR - pharmacy route segment .. 54 Route .. 54 RXC - pharmacy component segment .. 54 Component type .. 55 Component code .. 55 Component amount .. 55 Component units .. 55 Component strength .. 55 Component strength unit .. 55 Z - custom segment .. 56 Master File Maintenance Segments .. 57 MFI - master file identification segment .. 57 Master file identifier .. 57 Master Files Application ID .. 57 File-level event code .. 57 Response Level Code .. 57 MFE - master file entry segment.

10 57 Record-level event code .. 58 Effective Date/Time .. 58 Primary Key Value .. 58 ZFM - drug formulary maintenance 58 Generic Name .. 60 Brand Name .. 60 6 | P a g e Hospital/Pharmacy drug code .. 60 Route code .. 60 Strength .. 60 Strength units .. 60 Volume .. 60 Volume units .. 61 NDC number .. 61 Dosage .. 61 Dosage units .. 61 Dosage form .. 61 Package Size .. 61 AHFS number .. 61 Default SIG .. 61 Default comment .. 61 Default label 61 Default IV rate .. 61 Default expiration days .. 62 Default Expiration 62 Bar code ID .. 62 DEA/Schedule code .. 62 AWP cost .. 62 Acquisition cost.